Debug: indent lookup operations

[exim.git] / src / src / debug.c

diff --git a/src/src/debug.c b/src/src/debug.c
index d26f14477fed8c6cbe13395374a3953368038b2c..eb62157def1dfc6a90d4830225bf2279cf0d288d 100644 (file)
--- a/src/src/debug.c
+++ b/src/src/debug.c
@@ -1,10 +1,8 @@
-/* $Cambridge: exim/src/src/debug.c,v 1.5 2006/02/07 11:19:00 ph10 Exp $ */
-

 /*************************************************
 *     Exim - an Internet mail transport agent    *
 *************************************************/
 
 /*************************************************
 *     Exim - an Internet mail transport agent    *
 *************************************************/
 

-/* Copyright (c) University of Cambridge 1995 - 2006 */
+/* Copyright (c) University of Cambridge 1995 - 2018 */

 /* See the file NOTICE for conditions of use and distribution. */
 
 
 /* See the file NOTICE for conditions of use and distribution. */
 
 


@@ -16,6 +14,26 @@ static int     debug_prefix_length = 0;
 
 
 
 
 
 

+const uschar * rc_names[] = {          /* Mostly for debug output */
+  [OK] =               US"OK",
+  [DEFER] =            US"DEFER",
+  [FAIL] =             US"FAIL",
+  [ERROR] =            US"ERROR",
+  [FAIL_FORCED] =      US"FAIL_FORCED",
+  [DECLINE] =          US"DECLINE",
+  [PASS] =             US"PASS",
+  [DISCARD] =          US"DISCARD",
+  [SKIP] =             US"SKIP",
+  [REROUTED] =         US"REROUTED",
+  [PANIC] =            US"PANIC",
+  [BAD64] =            US"BAD64",
+  [UNEXPECTED] =       US"UNEXPECTED",
+  [CANCELLED] =                US"CANCELLED",
+  [FAIL_SEND] =                US"FAIL_SEND",
+  [FAIL_DROP] =                US"FAIL_DROP"
+};
+
+

 /*************************************************
 *               Print tree                       *
 *************************************************/
 /*************************************************
 *               Print tree                       *
 *************************************************/


@@ -32,7 +50,7 @@ static uschar tree_printline[tree_printlinesize];
 
 Arguments:
   p          tree node
 
 Arguments:
   p          tree node

-  pos        amount of indenting & vertical bars to pring
+  pos        amount of indenting & vertical bars to print

   barswitch  if TRUE print | at the pos value
 
 Returns:     nothing
   barswitch  if TRUE print | at the pos value
 
 Returns:     nothing


@@ -41,12 +59,11 @@ Returns:     nothing
 static void
 tree_printsub(tree_node *p, int pos, int barswitch)
 {
 static void
 tree_printsub(tree_node *p, int pos, int barswitch)
 {

-int i;
-if (p->right != NULL) tree_printsub(p->right, pos+2, 1);
-for (i = 0; i <= pos-1; i++) debug_printf("%c", tree_printline[i]);
+if (p->right) tree_printsub(p->right, pos+2, 1);
+for (int i = 0; i <= pos-1; i++) debug_printf("%c", tree_printline[i]);

 debug_printf("-->%s [%d]\n", p->name, p->balance);
 tree_printline[pos] = barswitch? '|' : ' ';
 debug_printf("-->%s [%d]\n", p->name, p->balance);
 tree_printline[pos] = barswitch? '|' : ' ';

-if (p->left != NULL)
+if (p->left)

   {
   tree_printline[pos+2] = '|';
   tree_printsub(p->left, pos+2, 0);
   {
   tree_printline[pos+2] = '|';
   tree_printsub(p->left, pos+2, 0);


@@ -58,9 +75,8 @@ if (p->left != NULL)
 void
 debug_print_tree(tree_node *p)
 {
 void
 debug_print_tree(tree_node *p)
 {

-int i;
-for (i = 0; i < tree_printlinesize; i++) tree_printline[i] = ' ';
-if (p == NULL) debug_printf("Empty Tree\n"); else tree_printsub(p, 0, 0);
+for (int i = 0; i < tree_printlinesize; i++) tree_printline[i] = ' ';
+if (!p) debug_printf("Empty Tree\n"); else tree_printsub(p, 0, 0);

 debug_printf("---- End of tree ----\n");
 }
 
 debug_printf("---- End of tree ----\n");
 }
 


@@ -77,10 +93,10 @@ Returns:     nothing
 */
 
 void
 */
 
 void

-debug_print_argv(uschar **argv)
+debug_print_argv(const uschar ** argv)

 {
 debug_printf("exec");
 {
 debug_printf("exec");

-while (*argv != NULL) debug_printf(" %.256s", *argv++);
+while (*argv) debug_printf(" %.256s", *argv++);

 debug_printf("\n");
 }
 
 debug_printf("\n");
 }
 


@@ -100,11 +116,11 @@ Returns:     nothing
 void
 debug_print_string(uschar *debug_string)
 {
 void
 debug_print_string(uschar *debug_string)
 {

-if (debug_string == NULL) return;
+if (!debug_string) return;

 HDEBUG(D_any|D_v)
   {
   uschar *s = expand_string(debug_string);
 HDEBUG(D_any|D_v)
   {
   uschar *s = expand_string(debug_string);

-  if (s == NULL)
+  if (!s)

     debug_printf("failed to expand debug_output \"%s\": %s\n", debug_string,
       expand_string_message);
   else if (s[0] != 0)
     debug_printf("failed to expand debug_output \"%s\": %s\n", debug_string,
       expand_string_message);
   else if (s[0] != 0)


@@ -131,6 +147,17 @@ debug_printf("%s uid=%ld gid=%ld euid=%ld egid=%ld\n", s,
   (long int)getegid());
 }
 
   (long int)getegid());
 }
 

+/************************************************/
+
+/* Give a string for a return-code */
+
+const uschar *
+rc_to_string(int rc)
+{
+return rc < 0 || rc >= nelem(rc_names) ? US"?" : rc_names[rc];
+}
+
+

 
 
 
 
 
 


@@ -139,27 +166,41 @@ debug_printf("%s uid=%ld gid=%ld euid=%ld egid=%ld\n", s,
 *************************************************/
 
 /* There are two entries, one for use when being called directly from a
 *************************************************/
 
 /* There are two entries, one for use when being called directly from a

-function with a variable argument list.
+function with a variable argument list, one for prepending an indent.

 
 If debug_pid is nonzero, print the pid at the start of each line. This is for
 tidier output when running parallel remote deliveries with debugging turned on.
 Must do the whole thing with a single printf and flush, as otherwise output may
 get interleaved. Since some calls to debug_printf() don't end with newline,
 
 If debug_pid is nonzero, print the pid at the start of each line. This is for
 tidier output when running parallel remote deliveries with debugging turned on.
 Must do the whole thing with a single printf and flush, as otherwise output may
 get interleaved. Since some calls to debug_printf() don't end with newline,

-we save up the text until we do get the newline. */
+we save up the text until we do get the newline.
+Take care to not disturb errno. */
+
+
+/* Debug printf indented by ACL nest depth */
+void
+debug_printf_indent(const char * format, ...)
+{
+va_list ap;
+va_start(ap, format);
+debug_vprintf(acl_level + expand_level, format, ap);
+va_end(ap);
+}

 
 void
 
 void

-debug_printf(char *format, ...)
+debug_printf(const char *format, ...)

 {
 va_list ap;
 va_start(ap, format);
 {
 va_list ap;
 va_start(ap, format);

-debug_vprintf(format, ap);
+debug_vprintf(0, format, ap);

 va_end(ap);
 }
 
 void
 va_end(ap);
 }
 
 void

-debug_vprintf(char *format, va_list ap)
+debug_vprintf(int indent, const char *format, va_list ap)

 {
 {

-if (debug_file == NULL) return;
+int save_errno = errno;
+
+if (!debug_file) return;

 
 /* Various things can be inserted at the start of a line. Don't use the
 tod_stamp() function for the timestamp, because that will overwrite the
 
 /* Various things can be inserted at the start of a line. Don't use the
 tod_stamp() function for the timestamp, because that will overwrite the


@@ -170,18 +211,20 @@ if (debug_ptr == debug_buffer)
   {
   DEBUG(D_timestamp)
     {
   {
   DEBUG(D_timestamp)
     {

-    time_t now = time(NULL);
-    struct tm *t = timestamps_utc? gmtime(&now) : localtime(&now);
-    (void) sprintf(CS debug_ptr, "%02d:%02d:%02d ", t->tm_hour, t->tm_min,
-      t->tm_sec);
-    while(*debug_ptr != 0) debug_ptr++;
+    struct timeval now;
+    time_t tmp;
+    struct tm * t;
+
+    gettimeofday(&now, NULL);
+    tmp = now.tv_sec;
+    t = f.timestamps_utc ? gmtime(&tmp) : localtime(&tmp);
+    debug_ptr += sprintf(CS debug_ptr,
+      LOGGING(millisec) ? "%02d:%02d:%02d.%03d " : "%02d:%02d:%02d ",
+      t->tm_hour, t->tm_min, t->tm_sec, (int)(now.tv_usec/1000));

     }
 
   DEBUG(D_pid)
     }
 
   DEBUG(D_pid)

-    {
-    sprintf(CS debug_ptr, "%5d ", (int)getpid());
-    while(*debug_ptr != 0) debug_ptr++;
-    }
+    debug_ptr += sprintf(CS debug_ptr, "%5d ", (int)getpid());

 
   /* Set up prefix if outputting for host checking and not debugging */
 
 
   /* Set up prefix if outputting for host checking and not debugging */
 


@@ -194,22 +237,51 @@ if (debug_ptr == debug_buffer)
   debug_prefix_length = debug_ptr - debug_buffer;
   }
 
   debug_prefix_length = debug_ptr - debug_buffer;
   }
 

+if (indent > 0)
+  {
+  for (int i = indent >> 2; i > 0; i--)
+    DEBUG(D_noutf8)
+      {
+      Ustrcpy(debug_ptr, "   !");
+      debug_ptr += 4;  /* 3 spaces + shriek */
+      debug_prefix_length += 4;
+      }
+    else
+      {
+      Ustrcpy(debug_ptr, "   " UTF8_VERT_2DASH);
+      debug_ptr += 6;  /* 3 spaces + 3 UTF-8 octets */
+      debug_prefix_length += 6;
+      }
+
+  Ustrncpy(debug_ptr, "   ", indent &= 3);
+  debug_ptr += indent;
+  debug_prefix_length += indent;
+  }
+

 /* Use the checked formatting routine to ensure that the buffer
 does not overflow. Ensure there's space for a newline at the end. */
 
 /* Use the checked formatting routine to ensure that the buffer
 does not overflow. Ensure there's space for a newline at the end. */
 

-if (!string_vformat(debug_ptr,
-     sizeof(debug_buffer) - (debug_ptr - debug_buffer) - 1, format, ap))

   {
   {

-  uschar *s = US"**** debug string too long - truncated ****\n";
-  uschar *p = debug_buffer + Ustrlen(debug_buffer);
-  int maxlen = sizeof(debug_buffer) - Ustrlen(s) - 3;
-  if (p > debug_buffer + maxlen) p = debug_buffer + maxlen;
-  if (p > debug_buffer && p[-1] != '\n') *p++ = '\n';
-  Ustrcpy(p, s);
+  gstring gs = { .size = (int)sizeof(debug_buffer) - 1,
+               .ptr = debug_ptr - debug_buffer,
+               .s = debug_buffer };
+  if (!string_vformat(&gs, FALSE, format, ap))
+    {
+    uschar * s = US"**** debug string too long - truncated ****\n";
+    uschar * p = gs.s + gs.ptr;
+    int maxlen = gs.size - Ustrlen(s) - 2;
+    if (p > gs.s + maxlen) p = gs.s + maxlen;
+    if (p > gs.s && p[-1] != '\n') *p++ = '\n';
+    Ustrcpy(p, s);
+    while(*debug_ptr) debug_ptr++;
+    }
+  else
+    {
+    string_from_gstring(&gs);
+    debug_ptr = gs.s + gs.ptr;
+    }

   }
 
   }
 

-while(*debug_ptr != 0) debug_ptr++;
-

 /* Output the line if it is complete. If we added any prefix data and there
 are internal newlines, make sure the prefix is on the continuation lines,
 as long as there is room in the buffer. We want to do just a single fprintf()
 /* Output the line if it is complete. If we added any prefix data and there
 are internal newlines, make sure the prefix is on the continuation lines,
 as long as there is room in the buffer. We want to do just a single fprintf()


@@ -237,6 +309,7 @@ if (debug_ptr[-1] == '\n')
   debug_ptr = debug_buffer;
   debug_prefix_length = 0;
   }
   debug_ptr = debug_buffer;
   debug_prefix_length = 0;
   }

+errno = save_errno;

 }
 
 /* End of debug.c */
 }
 
 /* End of debug.c */