Improved logging mechanism

diff --git a/src/kernel/debug.h b/src/kernel/debug.h
new file mode 100644 (file)
index 0000000..ae4d31a
--- /dev/null
+++ b/src/kernel/debug.h
@@ -0,0 +1,16 @@
+#ifndef _SWIFT_DEBUG_H
+#define _SWIFT_DEBUG_H
+
+#define log_error(...) printk(KERN_ERR "SWIF-ERROR : " __VA_ARGS__)
+
+#if 1
+
+#define log_debug(...) printk(KERN_DEBUG "SWIF-DEBUG : " __VA_ARGS__)
+
+#else
+
+#define log_debug(...)
+
+#endif
+
+#endif

diff --git a/src/kernel/swift.c b/src/kernel/swift.c
index e32d657..5ac64ed 100644 (file)
--- a/src/kernel/swift.c
+++ b/src/kernel/swift.c
@@ -5,6 +5,7 @@
 #include <net/route.h>
 
 #include "swift.h"
+#include "debug.h"
 
 MODULE_DESCRIPTION("Swift Transport Protocol");
 MODULE_AUTHOR("Adrian Bondrescu/Cornel Mercan");
@@ -72,7 +73,7 @@ static int swift_release(struct socket *sock)
 
        skb_queue_purge(&sk->sk_receive_queue);
 
-       printk(KERN_DEBUG "swift_release sock=%p\n", sk);
+       log_debug("swift_release sock=%p\n", sk);
        sock_put(sk);
 
        return 0;
@@ -87,7 +88,7 @@ static int swift_bind(struct socket *sock, struct sockaddr *addr, int addr_len)
 
        err = -EINVAL;
        if (addr_len < sizeof(struct sockaddr_swift)) {
-               printk(KERN_ERR "Invalid size for sockaddr\n");
+               log_error("Invalid size for sockaddr\n");
                goto out;
        }
 
@@ -95,7 +96,7 @@ static int swift_bind(struct socket *sock, struct sockaddr *addr, int addr_len)
 
        err = -EINVAL;
        if (swift_addr->sin_family != AF_INET) {
-               printk(KERN_ERR "Invalid family for sockaddr\n");
+               log_error("Invalid family for sockaddr\n");
                goto out;
        }
 
@@ -103,13 +104,13 @@ static int swift_bind(struct socket *sock, struct sockaddr *addr, int addr_len)
 
        err = -EINVAL;
        if (port == 0 || port >= MAX_SWIFT_PORT) {
-               printk(KERN_ERR "Invalid value for sockaddr port (%u)\n", port);
+               log_error("Invalid value for sockaddr port (%u)\n", port);
                goto out;
        }
        
        err = -EADDRINUSE;
        if (swift_lookup(port) != NULL) {
-               printk(KERN_ERR "Port %u already in use\n", port);
+               log_error("Port %u already in use\n", port);
                goto out;
        }
 
@@ -118,7 +119,7 @@ static int swift_bind(struct socket *sock, struct sockaddr *addr, int addr_len)
 
        swift_hash(port, ssk);
 
-       printk(KERN_DEBUG "Socket %p bound to port %u\n", ssk, port);
+       log_debug("Socket %p bound to port %u\n", ssk, port);
        
        return 0;
 
@@ -133,18 +134,18 @@ static int swift_connect(struct socket *sock, struct sockaddr *addr, int addr_le
        struct inet_sock * isk;
        struct swift_sock * ssk;
 
-       printk(KERN_DEBUG "swift_connect\n");
+       log_debug("swift_connect\n");
 
        err = -EINVAL;
        if (sock == NULL) {
-               printk(KERN_ERR "Sock is NULL\n");
+               log_error("Sock is NULL\n");
                goto out;
        }
        sk = sock->sk;
 
        err = -EINVAL;
        if (sk == NULL) {
-               printk(KERN_ERR "Sock->sk is NULL\n");
+               log_error("Sock->sk is NULL\n");
                goto out;
        }
        
@@ -152,7 +153,7 @@ static int swift_connect(struct socket *sock, struct sockaddr *addr, int addr_le
        ssk = swift_sk(sk);
 
        if (ssk->src != 0) {
-               printk(KERN_ERR "ssk->src is not NULL\n");
+               log_error("ssk->src is not NULL\n");
                goto out;
        }
        
@@ -162,26 +163,26 @@ static int swift_connect(struct socket *sock, struct sockaddr *addr, int addr_le
                
                err = -EINVAL;
                if (addr_len < sizeof(*swift_addr) || swift_addr->sin_family != AF_INET) {
-                       printk(KERN_ERR "Invalid size or address family\n");
+                       log_error("Invalid size or address family\n");
                        goto out;
                }
                ssk->dst = ntohs(swift_addr->sin_port);
                if (ssk->dst == 0 || ssk->dst >= MAX_SWIFT_PORT) {
-                       printk(KERN_ERR "Invalid value for destination port(%u)\n", ssk->dst);
+                       log_error("Invalid value for destination port(%u)\n", ssk->dst);
                        goto out;
                }       
        
                isk->inet_daddr = swift_addr->sin_addr.s_addr;
-               printk(KERN_DEBUG "Received from user space destination port=%u and address=%u\n", ssk->dst, isk->inet_daddr);
+               log_debug("Received from user space destination port=%u and address=%u\n", ssk->dst, isk->inet_daddr);
        } else {
-               printk(KERN_ERR "Invalid swift_addr (NULL)\n");
+               log_error("Invalid swift_addr (NULL)\n");
                goto out;
        }
        
        err = -ENOMEM;
        ssk->src = get_next_free_port();
        if (ssk->src == 0) {
-               printk(KERN_ERR "No free ports\n");
+               log_error("No free ports\n");
                goto out;
        }
        
@@ -211,14 +212,14 @@ static int swift_sendmsg(struct kiocb *iocb, struct socket *sock, struct msghdr
        
        err = -EINVAL;
        if (sock == NULL) {
-               printk(KERN_ERR "Sock is NULL\n");
+               log_error("Sock is NULL\n");
                goto out;
        }
        sk = sock->sk;
 
        err = -EINVAL;
        if (sk == NULL) {
-               printk(KERN_ERR "Sock->sk is NULL\n");
+               log_error("Sock->sk is NULL\n");
                goto out;
        }
 
@@ -230,7 +231,7 @@ static int swift_sendmsg(struct kiocb *iocb, struct socket *sock, struct msghdr
                err = -ENOMEM;
                sport = get_next_free_port();
                if (sport == 0) {
-                       printk(KERN_ERR "No free ports\n");
+                       log_error("No free ports\n");
                        goto out;
                }
        }
@@ -240,59 +241,59 @@ static int swift_sendmsg(struct kiocb *iocb, struct socket *sock, struct msghdr
                
                err = -EINVAL;
                if (msg->msg_namelen < sizeof(*swift_addr) || swift_addr->sin_family != AF_INET) {
-                       printk(KERN_ERR "Invalid size or address family\n");
+                       log_error("Invalid size or address family\n");
                        goto out;
                }
                
                dport = ntohs(swift_addr->sin_port);
                if (dport == 0 || dport >= MAX_SWIFT_PORT) {
-                       printk(KERN_ERR "Invalid value for destination port(%u)\n", dport);
+                       log_error("Invalid value for destination port(%u)\n", dport);
                        goto out;
                }       
 
                daddr = swift_addr->sin_addr.s_addr;
-               printk(KERN_DEBUG "Received from user space destination port=%u and address=%u\n", dport, daddr);
+               log_debug("Received from user space destination port=%u and address=%u\n", dport, daddr);
        } else {
                err = -EDESTADDRREQ;
                if (!ssk->dst || !isk->inet_daddr) {
-                       printk(KERN_ERR "No destination port/address\n");
+                       log_error("No destination port/address\n");
                        goto out;
                }
                dport = ssk->dst;
                daddr = isk->inet_daddr;
 
-               printk(KERN_DEBUG "Got from socket destination port=%u and address=%u\n", dport, daddr);
+               log_debug("Got from socket destination port=%u and address=%u\n", dport, daddr);
                connected = 1;
        }
 
        totlen = len + sizeof(struct swifthdr) + sizeof(struct iphdr);
        skb = sock_alloc_send_skb(sk, totlen, msg->msg_flags & MSG_DONTWAIT, &err);
        if (!skb) {
-               printk(KERN_ERR "sock_alloc_send_skb failed\n");
+               log_error("sock_alloc_send_skb failed\n");
                goto out;
        }
-       printk(KERN_DEBUG "Allocated %u bytes for skb (payload size=%u)\n", totlen, len);
+       log_debug("Allocated %u bytes for skb (payload size=%u)\n", totlen, len);
 
        skb_reset_network_header(skb);
        skb_reserve(skb, sizeof(struct iphdr));
-       printk(KERN_DEBUG "Reseted network header\n");
+       log_debug("Reseted network header\n");
        skb_reset_transport_header(skb);
        skb_put(skb, sizeof(struct swifthdr));
-       printk(KERN_DEBUG "Reseted transport header\n");
+       log_debug("Reseted transport header\n");
 
        shdr = (struct swifthdr *) skb_transport_header(skb);
        shdr->dst = ntohs(dport);
        shdr->src = ntohs(sport);
        shdr->len = ntohs(len + sizeof(struct swifthdr));
 
-       printk(KERN_DEBUG "payload=%p\n", skb_put(skb, len));
+       log_debug("payload=%p\n", skb_put(skb, len));
 
        err = skb_copy_datagram_from_iovec(skb, sizeof(struct swifthdr), msg->msg_iov, 0, len);
        if (err) {
-               printk(KERN_ERR "skb_copy_datagram_from_iovec failed\n");
+               log_error("skb_copy_datagram_from_iovec failed\n");
                goto out_free;
        }
-       printk(KERN_DEBUG "Copied %u bytes into the skb\n", len);
+       log_debug("Copied %u bytes into the skb\n", len);
 
        if (connected)
                rt = (struct rtable *) __sk_dst_check(sk, 0);
@@ -304,7 +305,7 @@ static int swift_sendmsg(struct kiocb *iocb, struct socket *sock, struct msghdr
                                  };
                err = ip_route_output_flow(sock_net(sk), &rt, &fl, sk, 0);
                if (err) {
-                       printk(KERN_ERR "Route lookup failed\n");
+                       log_error("Route lookup failed\n");
                        goto out_free;
                }
                sk_dst_set(sk, dst_clone(&rt->dst));
@@ -312,9 +313,9 @@ static int swift_sendmsg(struct kiocb *iocb, struct socket *sock, struct msghdr
        
        err = ip_queue_xmit(skb);
        if (!err)
-               printk(KERN_DEBUG "Sent %u bytes on wire\n", len);
+               log_debug("Sent %u bytes on wire\n", len);
        else
-               printk(KERN_ERR "ip_queue_xmit failed\n");
+               log_error("ip_queue_xmit failed\n");
 
        return err;
 
@@ -334,11 +335,11 @@ static int swift_recvmsg(struct kiocb *iocb, struct socket *sock, struct msghdr
 
        skb = skb_recv_datagram(sk, flags, flags & MSG_DONTWAIT, &err);
        if (!skb) {
-               printk(KERN_ERR "skb_recv_datagram\n");
+               log_error("skb_recv_datagram\n");
                goto out;
        }
 
-       printk(KERN_DEBUG "Received skb %p\n", skb);
+       log_debug("Received skb %p\n", skb);
 
        swift_addr = (struct sockaddr_swift *) skb->cb;
        msg->msg_namelen = sizeof(struct sockaddr_swift);
@@ -351,7 +352,7 @@ static int swift_recvmsg(struct kiocb *iocb, struct socket *sock, struct msghdr
 
        err = skb_copy_datagram_iovec(skb, 0, msg->msg_iov, copied);
        if (err) {
-               printk(KERN_ERR "skb_copy_datagram_iovec\n");
+               log_error("skb_copy_datagram_iovec\n");
                goto out_free;
        }
 
@@ -379,7 +380,7 @@ static int swift_rcv(struct sk_buff *skb)
        int err;
 
        if (!pskb_may_pull(skb, sizeof(struct swifthdr))) {
-               printk(KERN_ERR "Insufficient space for header\n");
+               log_error("Insufficient space for header\n");
                goto drop;
        }
        
@@ -387,19 +388,19 @@ static int swift_rcv(struct sk_buff *skb)
        len = ntohs(shdr->len);
 
        if (skb->len < len) {
-               printk(KERN_ERR "Malformed packet (packet_len=%u, skb_len=%u)\n", len, skb->len);
+               log_error("Malformed packet (packet_len=%u, skb_len=%u)\n", len, skb->len);
                goto drop;
        }
 
        if (len < sizeof(struct swifthdr)) {
-               printk(KERN_ERR "Malformed packet (packet_len=%u sizeof(swifthdr)=%u\n", len, sizeof(struct swifthdr));
+               log_error("Malformed packet (packet_len=%u sizeof(swifthdr)=%u\n", len, sizeof(struct swifthdr));
                goto drop;
        }
        
        src = ntohs(shdr->src);
        dst = ntohs(shdr->dst);
        if (src == 0 || dst == 0 || src >= MAX_SWIFT_PORT || dst >= MAX_SWIFT_PORT) {
-               printk(KERN_ERR "Malformed packet (src=%u, dst=%u)\n", shdr->src, shdr->dst);
+               log_error("Malformed packet (src=%u, dst=%u)\n", shdr->src, shdr->dst);
                goto drop;
        }
 
@@ -408,11 +409,11 @@ static int swift_rcv(struct sk_buff *skb)
 
        pskb_trim(skb, len);
 
-       printk(KERN_DEBUG "Received %u bytes from from port=%u to port=%u\n", len - sizeof(struct swifthdr), src, dst);
+       log_debug("Received %u bytes from from port=%u to port=%u\n", len - sizeof(struct swifthdr), src, dst);
 
        ssk = swift_lookup(dst); 
        if (ssk == NULL) {
-               printk(KERN_ERR "Swift lookup failed for port %u\n", dst);
+               log_error("Swift lookup failed for port %u\n", dst);
                goto drop;
        }
 
@@ -423,11 +424,11 @@ static int swift_rcv(struct sk_buff *skb)
        swift_addr->sin_port = shdr->src;
        swift_addr->sin_addr.s_addr = ip_hdr(skb)->saddr;
 
-       printk(KERN_DEBUG "Setting sin_port=%u, sin_addr=%u\n", ntohs(shdr->src), swift_addr->sin_addr.s_addr);
+       log_debug("Setting sin_port=%u, sin_addr=%u\n", ntohs(shdr->src), swift_addr->sin_addr.s_addr);
 
        err = ip_queue_rcv_skb((struct sock *) &ssk->sock, skb);
        if (err) {
-               printk(KERN_ERR "ip_queu_rcv_skb\n");
+               log_error("ip_queu_rcv_skb\n");
                consume_skb(skb);
        }
        return NET_RX_SUCCESS;
@@ -484,18 +485,18 @@ static int __init swift_init(void)
 
        rc = proto_register(&swift_prot, 1);
        if (rc) {
-               printk(KERN_ERR "Error registering swift protocol\n");
+               log_error("Error registering swift protocol\n");
                goto out;
        }
 
        rc = inet_add_protocol(&swift_protocol, IPPROTO_SWIFT);
        if (rc) {
-               printk(KERN_ERR "Error adding swift protocol\n");
+               log_error("Error adding swift protocol\n");
                goto out_unregister;
        }
 
        inet_register_protosw(&swift_protosw);
-       printk(KERN_DEBUG "Swift entered\n");
+       log_debug("Swift entered\n");
 
        return 0;
 
@@ -514,7 +515,7 @@ static void __exit swift_exit(void)
 
        proto_unregister(&swift_prot);
 
-       printk(KERN_DEBUG "Swift exited\n");
+       log_debug("Swift exited\n");
 }
 
 module_init(swift_init);