3a90da2f3d2a9c41d027947277cf7100e671f8ac
[samba.git] / source / lib / debug.c
1 /*
2    Unix SMB/Netbios implementation.
3    Version 1.9.
4    Samba utility functions
5    Copyright (C) Andrew Tridgell 1992-1998
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program; if not, write to the Free Software
19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21
22 #include "includes.h"
23
24 /* -------------------------------------------------------------------------- **
25  * Defines...
26  *
27  *  FORMAT_BUFR_MAX - Index of the last byte of the format buffer;
28  *                    format_bufr[FORMAT_BUFR_MAX] should always be reserved
29  *                    for a terminating nul byte.
30  */
31
32 #define FORMAT_BUFR_MAX ( sizeof( format_bufr ) - 1 )
33
34 /* -------------------------------------------------------------------------- **
35  * This module implements Samba's debugging utility.
36  *
37  * The syntax of a debugging log file is represented as:
38  *
39  *  <debugfile> :== { <debugmsg> }
40  *
41  *  <debugmsg>  :== <debughdr> '\n' <debugtext>
42  *
43  *  <debughdr>  :== '[' TIME ',' LEVEL ']' [ [FILENAME ':'] [FUNCTION '()'] ]
44  *
45  *  <debugtext> :== { <debugline> }
46  *
47  *  <debugline> :== TEXT '\n'
48  *
49  * TEXT     is a string of characters excluding the newline character.
50  * LEVEL    is the DEBUG level of the message (an integer in the range 0..10).
51  * TIME     is a timestamp.
52  * FILENAME is the name of the file from which the debug message was generated.
53  * FUNCTION is the function from which the debug message was generated.
54  *
55  * Basically, what that all means is:
56  *
57  * - A debugging log file is made up of debug messages.
58  *
59  * - Each debug message is made up of a header and text.  The header is
60  *   separated from the text by a newline.
61  *
62  * - The header begins with the timestamp and debug level of the message
63  *   enclosed in brackets.  The filename and function from which the
64  *   message was generated may follow.  The filename is terminated by a
65  *   colon, and the function name is terminated by parenthesis.
66  *
67  * - The message text is made up of zero or more lines, each terminated by
68  *   a newline.
69  */
70
71 /* -------------------------------------------------------------------------- **
72  * External variables.
73  *
74  *  dbf           - Global debug file handle.
75  *  debugf        - Debug file name.
76  *  append_log    - If True, then the output file will be opened in append
77  *                  mode.
78  *  timestamp_log - 
79  *  DEBUGLEVEL    - System-wide debug message limit.  Messages with message-
80  *                  levels higher than DEBUGLEVEL will not be processed.
81  */
82
83 FILE   *dbf        = NULL;
84 pstring debugf     = "";
85 BOOL    append_log = False;
86 BOOL    timestamp_log = True;
87 int     DEBUGLEVEL = 1;
88
89
90 /* -------------------------------------------------------------------------- **
91  * Internal variables.
92  *
93  *  stdout_logging  - Default False, if set to True then dbf will be set to
94  *                    stdout and debug output will go to dbf only, and not
95  *                    to syslog.  Set in setup_logging() and read in Debug1().
96  *
97  *  debug_count     - Number of debug messages that have been output.
98  *                    Used to check log size.
99  *
100  *  syslog_level    - Internal copy of the message debug level.  Written by
101  *                    dbghdr() and read by Debug1().
102  *
103  *  format_bufr     - Used to format debug messages.  The dbgtext() function
104  *                    prints debug messages to a string, and then passes the
105  *                    string to format_debug_text(), which uses format_bufr
106  *                    to build the formatted output.
107  *
108  *  format_pos      - Marks the first free byte of the format_bufr.
109  */
110
111 static BOOL    stdout_logging = False;
112 static int     debug_count    = 0;
113 #ifdef WITH_SYSLOG
114 static int     syslog_level   = 0;
115 #endif
116 static pstring format_bufr    = { '\0' };
117 static int     format_pos     = 0;
118
119
120 /* -------------------------------------------------------------------------- **
121  * Functions...
122  */
123
124 /* ************************************************************************** **
125  * tells us if interactive logging was requested
126  * ************************************************************************** **
127  */
128
129 BOOL dbg_interactive(void)
130 {
131         return stdout_logging;
132 }
133
134 #if defined(SIGUSR2) && !defined(MEM_MAN)
135 /* ************************************************************************** **
136  * catch a sigusr2 - decrease the debug log level.
137  * ************************************************************************** **
138  */
139 void sig_usr2( int sig )
140   {
141   BlockSignals( True, SIGUSR2 );
142
143   DEBUGLEVEL--;
144   if( DEBUGLEVEL < 0 )
145     DEBUGLEVEL = 0;
146
147   DEBUG( 0, ( "Got SIGUSR2; set debug level to %d.\n", DEBUGLEVEL ) );
148
149   BlockSignals( False, SIGUSR2 );
150   CatchSignal( SIGUSR2, SIGNAL_CAST sig_usr2 );
151
152   } /* sig_usr2 */
153 #endif /* SIGUSR2 */
154
155 #if defined(SIGUSR1) && !defined(MEM_MAN)
156 /* ************************************************************************** **
157  * catch a sigusr1 - increase the debug log level. 
158  * ************************************************************************** **
159  */
160 void sig_usr1( int sig )
161   {
162   BlockSignals( True, SIGUSR1 );
163
164   DEBUGLEVEL++;
165
166   if( DEBUGLEVEL > 10 )
167     DEBUGLEVEL = 10;
168
169   DEBUG( 0, ( "Got SIGUSR1; set debug level to %d.\n", DEBUGLEVEL ) );
170
171   BlockSignals( False, SIGUSR1 );
172   CatchSignal( SIGUSR1, SIGNAL_CAST sig_usr1 );
173
174   } /* sig_usr1 */
175 #endif /* SIGUSR1 */
176
177
178 /* ************************************************************************** **
179  * get ready for syslog stuff
180  * ************************************************************************** **
181  */
182 void setup_logging( char *pname, BOOL interactive )
183   {
184   if( interactive )
185     {
186     stdout_logging = True;
187     dbf = stdout;
188     }
189 #ifdef WITH_SYSLOG
190   else
191     {
192     char *p = strrchr( pname,'/' );
193
194     if( p )
195       pname = p + 1;
196 #ifdef LOG_DAEMON
197     openlog( pname, LOG_PID, SYSLOG_FACILITY );
198 #else /* for old systems that have no facility codes. */
199     openlog( pname, LOG_PID );
200 #endif
201     }
202 #endif
203   } /* setup_logging */
204
205 /* ************************************************************************** **
206  * reopen the log files
207  * ************************************************************************** **
208  */
209 void reopen_logs( void )
210   {
211   pstring fname;
212   
213   if( DEBUGLEVEL > 0 )
214     {
215     pstrcpy( fname, debugf );
216     if( lp_loaded() && (*lp_logfile()) )
217       pstrcpy( fname, lp_logfile() );
218
219     if( !strcsequal( fname, debugf ) || !dbf || !file_exist( debugf, NULL ) )
220       {
221       mode_t oldumask = umask( 022 );
222
223       pstrcpy( debugf, fname );
224       if( dbf )
225         (void)fclose( dbf );
226       if( append_log )
227         dbf = sys_fopen( debugf, "a" );
228       else
229         dbf = sys_fopen( debugf, "w" );
230       /* Fix from klausr@ITAP.Physik.Uni-Stuttgart.De
231        * to fix problem where smbd's that generate less
232        * than 100 messages keep growing the log.
233        */
234       force_check_log_size();
235       if( dbf )
236         setbuf( dbf, NULL );
237       (void)umask( oldumask );
238       }
239     }
240   else
241     {
242     if( dbf )
243       {
244       (void)fclose( dbf );
245       dbf = NULL;
246       }
247     }
248   } /* reopen_logs */
249
250 /* ************************************************************************** **
251  * Force a check of the log size.
252  * ************************************************************************** **
253  */
254 void force_check_log_size( void )
255   {
256   debug_count = 100;
257   } /* force_check_log_size */
258
259 /* ************************************************************************** **
260  * Check to see if the log has grown to be too big.
261  * ************************************************************************** **
262  */
263 static void check_log_size( void )
264   {
265   int         maxlog;
266   SMB_STRUCT_STAT st;
267
268   if( debug_count++ < 100 || getuid() != 0 )
269     return;
270
271   maxlog = lp_max_log_size() * 1024;
272   if( !dbf || maxlog <= 0 )
273     return;
274
275   if( sys_fstat( fileno( dbf ), &st ) == 0 && st.st_size > maxlog )
276     {
277     (void)fclose( dbf );
278     dbf = NULL;
279     reopen_logs();
280     if( dbf && file_size( debugf ) > maxlog )
281       {
282       pstring name;
283
284       (void)fclose( dbf );
285       dbf = NULL;
286       slprintf( name, sizeof(name)-1, "%s.old", debugf );
287       (void)rename( debugf, name );
288       reopen_logs();
289       }
290     }
291   debug_count = 0;
292   } /* check_log_size */
293
294 /* ************************************************************************** **
295  * Write an debug message on the debugfile.
296  * This is called by dbghdr() and format_debug_text().
297  * ************************************************************************** **
298  */
299 #ifdef HAVE_STDARG_H
300  int Debug1( char *format_str, ... )
301 {
302 #else
303  int Debug1(va_alist)
304 va_dcl
305 {  
306   char *format_str;
307 #endif
308   va_list ap;  
309   int old_errno = errno;
310
311   if( stdout_logging )
312     {
313 #ifdef HAVE_STDARG_H
314     va_start( ap, format_str );
315 #else
316     va_start( ap );
317     format_str = va_arg( ap, char * );
318 #endif
319     (void)vfprintf( dbf, format_str, ap );
320     va_end( ap );
321     errno = old_errno;
322     return( 0 );
323     }
324   
325 #ifdef WITH_SYSLOG
326   if( !lp_syslog_only() )
327 #endif
328     {
329     if( !dbf )
330       {
331       mode_t oldumask = umask( 022 );
332
333       if( append_log )
334         dbf = sys_fopen( debugf, "a" );
335       else
336         dbf = sys_fopen( debugf, "w" );
337       (void)umask( oldumask );
338       if( dbf )
339         {
340         setbuf( dbf, NULL );
341         }
342       else
343         {
344         errno = old_errno;
345         return(0);
346         }
347       }
348     }
349
350 #ifdef WITH_SYSLOG
351   if( syslog_level < lp_syslog() )
352     {
353     /* map debug levels to syslog() priorities
354      * note that not all DEBUG(0, ...) calls are
355      * necessarily errors
356      */
357     static int priority_map[] = { 
358       LOG_ERR,     /* 0 */
359       LOG_WARNING, /* 1 */
360       LOG_NOTICE,  /* 2 */
361       LOG_INFO,    /* 3 */
362       };
363     int     priority;
364     pstring msgbuf;
365
366     if( syslog_level >= ( sizeof(priority_map) / sizeof(priority_map[0]) )
367      || syslog_level < 0)
368       priority = LOG_DEBUG;
369     else
370       priority = priority_map[syslog_level];
371       
372 #ifdef HAVE_STDARG_H
373     va_start( ap, format_str );
374 #else
375     va_start( ap );
376     format_str = va_arg( ap, char * );
377 #endif
378     vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
379     va_end( ap );
380       
381     msgbuf[255] = '\0';
382     syslog( priority, "%s", msgbuf );
383     }
384 #endif
385   
386 #ifdef WITH_SYSLOG
387   if( !lp_syslog_only() )
388 #endif
389     {
390 #ifdef HAVE_STDARG_H
391     va_start( ap, format_str );
392 #else
393     va_start( ap );
394     format_str = va_arg( ap, char * );
395 #endif
396     (void)vfprintf( dbf, format_str, ap );
397     va_end( ap );
398     (void)fflush( dbf );
399     }
400
401   check_log_size();
402
403   errno = old_errno;
404
405   return( 0 );
406   } /* Debug1 */
407
408
409 /* ************************************************************************** **
410  * Print the buffer content via Debug1(), then reset the buffer.
411  *
412  *  Input:  none
413  *  Output: none
414  *
415  * ************************************************************************** **
416  */
417 static void bufr_print( void )
418   {
419   format_bufr[format_pos] = '\0';
420   (void)Debug1( "%s", format_bufr );
421   format_pos = 0;
422   } /* bufr_print */
423
424 /* ************************************************************************** **
425  * Format the debug message text.
426  *
427  *  Input:  msg - Text to be added to the "current" debug message text.
428  *
429  *  Output: none.
430  *
431  *  Notes:  The purpose of this is two-fold.  First, each call to syslog()
432  *          (used by Debug1(), see above) generates a new line of syslog
433  *          output.  This is fixed by storing the partial lines until the
434  *          newline character is encountered.  Second, printing the debug
435  *          message lines when a newline is encountered allows us to add
436  *          spaces, thus indenting the body of the message and making it
437  *          more readable.
438  *
439  * ************************************************************************** **
440  */
441 static void format_debug_text( char *msg )
442   {
443   int i;
444   BOOL timestamp = (timestamp_log && !stdout_logging && (lp_timestamp_logs() || 
445                                         !(lp_loaded())));
446
447   for( i = 0; msg[i]; i++ )
448     {
449     /* Indent two spaces at each new line. */
450     if(timestamp && 0 == format_pos)
451       {
452       format_bufr[0] = format_bufr[1] = ' ';
453       format_pos = 2;
454       }
455
456     /* If there's room, copy the character to the format buffer. */
457     if( format_pos < FORMAT_BUFR_MAX )
458       format_bufr[format_pos++] = msg[i];
459
460     /* If a newline is encountered, print & restart. */
461     if( '\n' == msg[i] )
462       bufr_print();
463
464     /* If the buffer is full dump it out, reset it, and put out a line
465      * continuation indicator.
466      */
467     if( format_pos >= FORMAT_BUFR_MAX )
468       {
469       bufr_print();
470       (void)Debug1( " +>\n" );
471       }
472     }
473
474   /* Just to be safe... */
475   format_bufr[format_pos] = '\0';
476   } /* format_debug_text */
477
478 /* ************************************************************************** **
479  * Flush debug output, including the format buffer content.
480  *
481  *  Input:  none
482  *  Output: none
483  *
484  * ************************************************************************** **
485  */
486 void dbgflush( void )
487   {
488   bufr_print();
489   (void)fflush( dbf );
490   } /* dbgflush */
491
492 /* ************************************************************************** **
493  * Print a Debug Header.
494  *
495  *  Input:  level - Debug level of the message (not the system-wide debug
496  *                  level.
497  *          file  - Pointer to a string containing the name of the file
498  *                  from which this function was called, or an empty string
499  *                  if the __FILE__ macro is not implemented.
500  *          func  - Pointer to a string containing the name of the function
501  *                  from which this function was called, or an empty string
502  *                  if the __FUNCTION__ macro is not implemented.
503  *          line  - line number of the call to dbghdr, assuming __LINE__
504  *                  works.
505  *
506  *  Output: Always True.  This makes it easy to fudge a call to dbghdr()
507  *          in a macro, since the function can be called as part of a test.
508  *          Eg: ( (level <= DEBUGLEVEL) && (dbghdr(level,"",line)) )
509  *
510  *  Notes:  This function takes care of setting syslog_level.
511  *
512  * ************************************************************************** **
513  */
514 BOOL dbghdr( int level, char *file, char *func, int line )
515   {
516   if( format_pos )
517     {
518     /* This is a fudge.  If there is stuff sitting in the format_bufr, then
519      * the *right* thing to do is to call
520      *   format_debug_text( "\n" );
521      * to write the remainder, and then proceed with the new header.
522      * Unfortunately, there are several places in the code at which
523      * the DEBUG() macro is used to build partial lines.  That in mind,
524      * we'll work under the assumption that an incomplete line indicates
525      * that a new header is *not* desired.
526      */
527     return( True );
528     }
529
530 #ifdef WITH_SYSLOG
531   /* Set syslog_level. */
532   syslog_level = level;
533 #endif
534
535   /* Don't print a header if we're logging to stdout. */
536   if( stdout_logging )
537     return( True );
538
539   /* Print the header if timestamps are turned on.  If parameters are
540    * not yet loaded, then default to timestamps on.
541    */
542   if( timestamp_log && (lp_timestamp_logs() || !(lp_loaded()) ))
543     {
544     /* Print it all out at once to prevent split syslog output. */
545     (void)Debug1( "[%s, %d] %s:%s(%d)\n",
546                   timestring(), level, file, func, line );
547     }
548
549   return( True );
550   } /* dbghdr */
551
552 /* ************************************************************************** **
553  * Add text to the body of the "current" debug message via the format buffer.
554  *
555  *  Input:  format_str  - Format string, as used in printf(), et. al.
556  *          ...         - Variable argument list.
557  *
558  *  ..or..  va_alist    - Old style variable parameter list starting point.
559  *
560  *  Output: Always True.  See dbghdr() for more info, though this is not
561  *          likely to be used in the same way.
562  *
563  * ************************************************************************** **
564  */
565 #ifdef HAVE_STDARG_H
566  BOOL dbgtext( char *format_str, ... )
567   {
568   va_list ap;
569   pstring msgbuf;
570
571   va_start( ap, format_str ); 
572   vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
573   va_end( ap );
574
575   format_debug_text( msgbuf );
576
577   return( True );
578   } /* dbgtext */
579
580 #else
581  BOOL dbgtext( va_alist )
582  va_dcl
583   {
584   char *format_str;
585   va_list ap;
586   pstring msgbuf;
587
588   va_start( ap );
589   format_str = va_arg( ap, char * );
590   vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
591   va_end( ap );
592
593   format_debug_text( msgbuf );
594
595   return( True );
596   } /* dbgtext */
597
598 #endif
599
600 /* ************************************************************************** */