Refactoring the debugging output.

levels of debug output:
 0 - ERROR: Only for errors.
 1 - TRACE: Start of each packets and if found protocol.
 2 - DEBUG: Start of searching each protocol and excluding protocols.
 3 - DEBUG_EXTRA: For all other messages.

Added field ndpi_struct->debug_logging for enable debug output of each protocols.

Simple macros for debugging output are added:
NDPI_LOG_ERR(), NDPI_LOG_INFO(), NDPI_LOG_DBG(), NDPI_LOG_DBG2(),
NDPI_EXCLUDE_PROTO()

1 files changed, 42 insertions, 43 deletions

diff --git a/src/lib/protocols/rtp.c b/src/lib/protocols/rtp.c
index 80848f5ba..3acf71b61 100644
--- a/src/lib/protocols/rtp.c
+++ b/src/lib/protocols/rtp.c
@@ -22,10 +22,14 @@
  *
  */
 
+#include "ndpi_protocol_ids.h"
+
+#ifdef NDPI_PROTOCOL_RTP
+
+#define NDPI_CURRENT_PROTO NDPI_PROTOCOL_RTP
 
 #include "ndpi_api.h"
 
-#ifdef NDPI_PROTOCOL_RTP
 
 /* http://www.myskypelab.com/2014/05/microsoft-lync-wireshark-plugin.html */
 
@@ -73,6 +77,7 @@ static void ndpi_rtp_search(struct ndpi_detection_module_struct *ndpi_struct,
 			    struct ndpi_flow_struct *flow,
 			    const u_int8_t * payload, const u_int16_t payload_len)
 {
+  NDPI_LOG_DBG(ndpi_struct, "search RTP\n");
   if (payload_len < 2)
     return;
   //struct ndpi_packet_struct *packet = &flow->packet;
@@ -89,24 +94,25 @@ static void ndpi_rtp_search(struct ndpi_detection_module_struct *ndpi_struct,
 	 )
 	 && (*ssid != 0)
      ) {
-    NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "Found RTP.\n");
+    NDPI_LOG_INFO(ndpi_struct, "Found RTP\n");
     ndpi_set_detected_protocol(ndpi_struct, flow, NDPI_PROTOCOL_RTP, NDPI_PROTOCOL_UNKNOWN);
     return;
   } else if((payload_len >= 12)
 	    && (((payload[0] & 0xFF) == 0x80) || ((payload[0] & 0xFF) == 0xA0)) /* RTP magic byte[1] */	    
 	    && (payloadType = isValidMSRTPType(payload[1] & 0xFF))) {
     if(payloadType == 1 /* RTP */) {
-      NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "Found Skype for Business (former MS Lync)\n");
+      NDPI_LOG_INFO(ndpi_struct, "Found Skype for Business (former MS Lync)\n");
       ndpi_set_detected_protocol(ndpi_struct, flow, NDPI_PROTOCOL_SKYPE, NDPI_PROTOCOL_UNKNOWN);
+      return;
     } else /* RTCP */ {
-      NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "Found MS RTCP\n");
+      NDPI_LOG_INFO(ndpi_struct, "Found MS RTCP\n");
       ndpi_set_detected_protocol(ndpi_struct, flow, NDPI_PROTOCOL_RTCP, NDPI_PROTOCOL_UNKNOWN);
+      return;
     }
   }  
 
   /* No luck this time */
-  NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "exclude rtp.\n");
-  NDPI_ADD_PROTOCOL_TO_BITMASK(flow->excluded_protocol_bitmask, NDPI_PROTOCOL_RTP);
+  NDPI_EXCLUDE_PROTO(ndpi_struct, flow);
 }
 
 void ndpi_search_rtp(struct ndpi_detection_module_struct *ndpi_struct, struct ndpi_flow_struct *flow)
@@ -155,7 +161,7 @@ void init_seq(struct ndpi_detection_module_struct *ndpi_struct, struct ndpi_flow
 	      u_int8_t direction, u_int16_t seq, u_int8_t include_current_packet)
 {
   flow->rtp_seqnum[direction] = seq;
-  NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "rtp_seqnum[%u] = %u\n", direction, seq);
+  NDPI_LOG_DBG(ndpi_struct, "rtp_seqnum[%u] = %u\n", direction, seq);
 }
 
 /* returns difference between old and new highest sequence number */
@@ -173,11 +179,11 @@ u_int16_t update_seq(struct ndpi_detection_module_struct *ndpi_struct, struct nd
 
   if (delta < RTP_MAX_OUT_OF_ORDER) {	/* in order, with permissible gap */
     flow->rtp_seqnum[direction] = seq;
-    NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "rtp_seqnum[%u] = %u (increased by %u)\n",
+    NDPI_LOG_DBG(ndpi_struct, "rtp_seqnum[%u] = %u (increased by %u)\n",
 	     direction, seq, delta);
     return delta;
   } else {
-    NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "retransmission (dir %u, seqnum %u)\n",
+    NDPI_LOG_DBG(ndpi_struct, "retransmission (dir %u, seqnum %u)\n",
 	     direction, seq);
     return 0;
   }
@@ -192,55 +198,54 @@ static void ndpi_rtp_search(struct ndpi_detection_module_struct *ndpi_struct,
   u_int8_t stage;
   u_int16_t seqnum = ntohs(get_u_int16_t(payload, 2));
 
-  NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "search rtp.\n");
+  NDPI_LOG_DBG(ndpi_struct, "search rtp\n");
 
   if (payload_len == 4 && get_u_int32_t(packet->payload, 0) == 0 && flow->packet_counter < 8) {
-    NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "need next packet, maybe ClearSea out calls.\n");
+    NDPI_LOG_DBG(ndpi_struct, "need next packet, maybe ClearSea out calls\n");
     return;
   }
 
   if (payload_len == 5 && memcmp(payload, "hello", 5) == 0) {
-    NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG,
+    NDPI_LOG_DBG(ndpi_struct,
 	     "need next packet, initial hello packet of SIP out calls.\n");
     return;
   }
 
   if (payload_len == 1 && payload[0] == 0) {
-    NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG,
+    NDPI_LOG_DBG(ndpi_struct,
 	     "need next packet, payload_packet_len == 1 && payload[0] == 0.\n");
     return;
   }
 
   if (payload_len == 3 && memcmp(payload, "png", 3) == 0) {
     /* weird packet found in Ninja GlobalIP trace */
-    NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "skipping packet with len = 3 and png payload.\n");
+    NDPI_LOG_DBG(ndpi_struct, "skipping packet with len = 3 and png payload\n");
     return;
   }
 
   if (payload_len < 12) {
-    NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "minimal packet size for rtp packets: 12.\n");
+    NDPI_LOG_DBG(ndpi_struct, "minimal packet size for rtp packets: 12\n");
     goto exclude_rtp;
   }
 
   if (payload_len == 12 && get_u_int32_t(payload, 0) == 0 && get_u_int32_t(payload, 4) == 0 && get_u_int32_t(payload, 8) == 0) {
-    NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "skipping packet with len = 12 and only 0-bytes.\n");
+    NDPI_LOG_DBG(ndpi_struct, "skipping packet with len = 12 and only 0-bytes\n");
     return;
   }
 
   if ((payload[0] & 0xc0) == 0xc0 || (payload[0] & 0xc0) == 0x40 || (payload[0] & 0xc0) == 0x00) {
-    NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "version = 3 || 1 || 0, maybe first rtp packet.\n");
+    NDPI_LOG_DBG(ndpi_struct, "version = 3 || 1 || 0, maybe first rtp packet\n");
     return;
   }
 
   if ((payload[0] & 0xc0) != 0x80) {
-    NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct,
-	     NDPI_LOG_DEBUG, "rtp version must be 2, first two bits of a packets must be 10.\n");
+    NDPI_LOG_DBG(ndpi_struct, "rtp version must be 2, first two bits of a packets must be 10\n");
     goto exclude_rtp;
   }
 
   /* rtp_payload_type are the last seven bits of the second byte */
   if (flow->rtp_payload_type[packet->packet_direction] != (payload[1] & 0x7F)) {
-    NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "payload_type has changed, reset stages.\n");
+    NDPI_LOG_DBG(ndpi_struct, "payload_type has changed, reset stages\n");
     packet->packet_direction == 0 ? (flow->rtp_stage1 = 0) : (flow->rtp_stage2 = 0);
   }
   /* first bit of first byte is not part of payload_type */
@@ -249,51 +254,48 @@ static void ndpi_rtp_search(struct ndpi_detection_module_struct *ndpi_struct,
   stage = (packet->packet_direction == 0 ? flow->rtp_stage1 : flow->rtp_stage2);
 
   if (stage > 0) {
-    NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct,
-	     NDPI_LOG_DEBUG, "stage = %u.\n", packet->packet_direction == 0 ? flow->rtp_stage1 : flow->rtp_stage2);
+    NDPI_LOG_DBG(ndpi_struct, "stage = %u\n", packet->packet_direction == 0 ? flow->rtp_stage1 : flow->rtp_stage2);
     if (flow->rtp_ssid[packet->packet_direction] != get_u_int32_t(payload, 8)) {
-      NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "ssid has changed, goto exclude rtp.\n");
+      NDPI_LOG_DBG(ndpi_struct, "ssid has changed, goto exclude rtp\n");
       goto exclude_rtp;
     }
 
     if (seqnum == flow->rtp_seqnum[packet->packet_direction]) {
-      NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "maybe \"retransmission\", need next packet.\n");
+      NDPI_LOG_DBG(ndpi_struct, "maybe \"retransmission\", need next packet\n");
       return;
     } else if ((u_int16_t) (seqnum - flow->rtp_seqnum[packet->packet_direction]) < RTP_MAX_OUT_OF_ORDER) {
-      NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG,
+      NDPI_LOG_DBG(ndpi_struct,
 	       "new packet has larger sequence number (within valid range)\n");
       update_seq(ndpi_struct, flow, packet->packet_direction, seqnum);
     } else if ((u_int16_t) (flow->rtp_seqnum[packet->packet_direction] - seqnum) < RTP_MAX_OUT_OF_ORDER) {
-      NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG,
+      NDPI_LOG_DBG(ndpi_struct,
 	       "new packet has smaller sequence number (within valid range)\n");
       init_seq(ndpi_struct, flow, packet->packet_direction, seqnum, 1);
     } else {
-      NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG,
+      NDPI_LOG_DBG(ndpi_struct,
 	       "sequence number diff is too big, goto exclude rtp.\n");
       goto exclude_rtp;
     }
   } else {
-    NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct,
-	     NDPI_LOG_DEBUG, "rtp_ssid[%u] = %u.\n", packet->packet_direction,
+    NDPI_LOG_DBG(ndpi_struct, "rtp_ssid[%u] = %u\n", packet->packet_direction,
 	     flow->rtp_ssid[packet->packet_direction]);
     flow->rtp_ssid[packet->packet_direction] = get_u_int32_t(payload, 8);
     if (flow->packet_counter < 3) {
-      NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "packet_counter < 3, need next packet.\n");
+      NDPI_LOG_DBG(ndpi_struct, "packet_counter < 3, need next packet\n");
     }
     init_seq(ndpi_struct, flow, packet->packet_direction, seqnum, 1);
   }
   if (seqnum <= 3) {
-    NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct,
-	     NDPI_LOG_DEBUG, "sequence_number = %u, too small, need next packet, return.\n", seqnum);
+    NDPI_LOG_DBG(ndpi_struct, "sequence_number = %u, too small, need next packet, return\n", seqnum);
     return;
   }
 
   if (stage == 3) {
-    NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "add connection I.\n");
+    NDPI_LOG_DBG(ndpi_struct, "add connection I\n");
     ndpi_int_rtp_add_connection(ndpi_struct, flow);
   } else {
     packet->packet_direction == 0 ? flow->rtp_stage1++ : flow->rtp_stage2++;
-    NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "stage[%u]++; need next packet.\n",
+    NDPI_LOG_DBG(ndpi_struct, "stage[%u]++; need next packet\n",
 	     packet->packet_direction);
   }
   return;
@@ -302,12 +304,11 @@ static void ndpi_rtp_search(struct ndpi_detection_module_struct *ndpi_struct,
 #ifdef NDPI_PROTOCOL_STUN
   if (packet->detected_protocol_stack[0] == NDPI_PROTOCOL_STUN
       || /* packet->real_protocol_read_only == NDPI_PROTOCOL_STUN */) {
-    NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "STUN: is detected, need next packet.\n");
+    NDPI_LOG_DBG(ndpi_struct, "STUN: is detected, need next packet\n");
     return;
   }
 #endif							/*  NDPI_PROTOCOL_STUN */
-  NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "exclude rtp.\n");
-  NDPI_ADD_PROTOCOL_TO_BITMASK(flow->excluded_protocol_bitmask, NDPI_PROTOCOL_RTP);
+  NDPI_EXCLUDE_PROTO(ndpi_struct, flow);
 }
 
 
@@ -325,7 +326,7 @@ void ndpi_search_rtp(struct ndpi_detection_module_struct *ndpi_struct, struct nd
 	packet->payload[0] == 0x90 && packet->payload[1] >= 0x01 && packet->payload[1] <= 0x07) {
       if (flow->packet_counter == 2)
 	flow->l4.tcp.rtp_special_packets_seen = 1;
-      NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG,
+      NDPI_LOG_DBG(ndpi_struct,
 	       "skipping STUN-like, special yahoo packets with payload[0] == 0x90.\n");
       return;
     }
@@ -366,14 +367,12 @@ void ndpi_search_rtp(struct ndpi_detection_module_struct *ndpi_struct, struct nd
     }
 
     if (NDPI_FLOW_PROTOCOL_EXCLUDED(ndpi_struct, flow, NDPI_PROTOCOL_STUN)) {
-      NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "exclude rtp.\n");
-      NDPI_ADD_PROTOCOL_TO_BITMASK(flow->excluded_protocol_bitmask, NDPI_PROTOCOL_RTP);
+      NDPI_EXCLUDE_PROTO(ndpi_struct, flow);
     } else {
-      NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "STUN not yet excluded, need next packet.\n");
+      NDPI_LOG_DBG(ndpi_struct, "STUN not yet excluded, need next packet\n");
     }
 #else
-    NDPI_LOG(NDPI_PROTOCOL_RTP, ndpi_struct, NDPI_LOG_DEBUG, "exclude rtp.\n");
-    NDPI_ADD_PROTOCOL_TO_BITMASK(flow->excluded_protocol_bitmask, NDPI_PROTOCOL_RTP);
+    NDPI_EXCLUDE_PROTO(ndpi_struct, flow);
 #endif
   }
 }