2 Unix SMB/Netbios implementation.
4 Samba utility functions
5 Copyright (C) Andrew Tridgell 1992-1998
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.
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.
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.
24 /* -------------------------------------------------------------------------- **
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.
32 #define FORMAT_BUFR_MAX ( sizeof( format_bufr ) - 1 )
34 /* -------------------------------------------------------------------------- **
35 * This module implements Samba's debugging utility.
37 * The syntax of a debugging log file is represented as:
39 * <debugfile> :== { <debugmsg> }
41 * <debugmsg> :== <debughdr> '\n' <debugtext>
43 * <debughdr> :== '[' TIME ',' LEVEL ']' [ [FILENAME ':'] [FUNCTION '()'] ]
45 * <debugtext> :== { <debugline> }
47 * <debugline> :== TEXT '\n'
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.
55 * Basically, what that all means is:
57 * - A debugging log file is made up of debug messages.
59 * - Each debug message is made up of a header and text. The header is
60 * separated from the text by a newline.
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.
67 * - The message text is made up of zero or more lines, each terminated by
71 /* -------------------------------------------------------------------------- **
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
78 * DEBUGLEVEL - System-wide debug message limit. Messages with message-
79 * levels higher than DEBUGLEVEL will not be processed.
84 BOOL append_log = False;
88 /* -------------------------------------------------------------------------- **
91 * stdout_logging - Default False, if set to True then dbf will be set to
92 * stdout and debug output will go to dbf only, and not
93 * to syslog. Set in setup_logging() and read in Debug1().
95 * debug_count - Number of debug messages that have been output.
96 * Used to check log size.
98 * syslog_level - Internal copy of the message debug level. Written by
99 * dbghdr() and read by Debug1().
101 * format_bufr - Used to format debug messages. The dbgtext() function
102 * prints debug messages to a string, and then passes the
103 * string to format_debug_text(), which uses format_bufr
104 * to build the formatted output.
106 * format_pos - Marks the first free byte of the format_bufr.
109 static BOOL stdout_logging = False;
110 static int debug_count = 0;
111 static int syslog_level = 0;
112 static pstring format_bufr = { '\0' };
113 static int format_pos = 0;
116 /* -------------------------------------------------------------------------- **
121 /* ************************************************************************** **
122 * catch a sigusr2 - decrease the debug log level.
123 * ************************************************************************** **
125 void sig_usr2( int sig )
127 BlockSignals( True, SIGUSR2 );
133 DEBUG( 0, ( "Got SIGUSR2; set debug level to %d.\n", DEBUGLEVEL ) );
135 BlockSignals( False, SIGUSR2 );
136 CatchSignal( SIGUSR2, SIGNAL_CAST sig_usr2 );
142 /* ************************************************************************** **
143 * catch a sigusr1 - increase the debug log level.
144 * ************************************************************************** **
146 void sig_usr1( int sig )
148 BlockSignals( True, SIGUSR1 );
152 if( DEBUGLEVEL > 10 )
155 DEBUG( 0, ( "Got SIGUSR1; set debug level to %d.\n", DEBUGLEVEL ) );
157 BlockSignals( False, SIGUSR1 );
158 CatchSignal( SIGUSR1, SIGNAL_CAST sig_usr1 );
164 /* ************************************************************************** **
165 * get ready for syslog stuff
166 * ************************************************************************** **
168 void setup_logging( char *pname, BOOL interactive )
172 stdout_logging = True;
178 char *p = strrchr( pname,'/' );
183 openlog( pname, LOG_PID, SYSLOG_FACILITY );
184 #else /* for old systems that have no facility codes. */
185 openlog( pname, LOG_PID );
189 } /* setup_logging */
191 /* ************************************************************************** **
192 * reopen the log files
193 * ************************************************************************** **
195 void reopen_logs( void )
201 pstrcpy( fname, debugf );
202 if( lp_loaded() && (*lp_logfile()) )
203 pstrcpy( fname, lp_logfile() );
205 if( !strcsequal( fname, debugf ) || !dbf || !file_exist( debugf, NULL ) )
207 mode_t oldumask = umask( 022 );
209 pstrcpy( debugf, fname );
213 dbf = fopen( debugf, "a" );
215 dbf = fopen( debugf, "w" );
216 /* Fix from klausr@ITAP.Physik.Uni-Stuttgart.De
217 * to fix problem where smbd's that generate less
218 * than 100 messages keep growing the log.
220 force_check_log_size();
223 (void)umask( oldumask );
236 /* ************************************************************************** **
237 * Force a check of the log size.
238 * ************************************************************************** **
240 void force_check_log_size( void )
243 } /* force_check_log_size */
245 /* ************************************************************************** **
246 * Check to see if the log has grown to be too big.
247 * ************************************************************************** **
249 static void check_log_size( void )
254 if( debug_count++ < 100 || getuid() != 0 )
257 maxlog = lp_max_log_size() * 1024;
258 if( !dbf || maxlog <= 0 )
261 if( sys_fstat( fileno( dbf ), &st ) == 0 && st.st_size > maxlog )
266 if( dbf && file_size( debugf ) > maxlog )
272 slprintf( name, sizeof(name)-1, "%s.old", debugf );
273 (void)rename( debugf, name );
278 } /* check_log_size */
280 /* ************************************************************************** **
281 * Write an debug message on the debugfile.
282 * This is called by dbghdr() and format_debug_text().
283 * ************************************************************************** **
286 int Debug1( char *format_str, ... )
295 int old_errno = errno;
300 va_start( ap, format_str );
303 format_str = va_arg( ap, char * );
305 (void)vfprintf( dbf, format_str, ap );
312 if( !lp_syslog_only() )
317 mode_t oldumask = umask( 022 );
320 dbf = fopen( debugf, "a" );
322 dbf = fopen( debugf, "w" );
323 (void)umask( oldumask );
337 if( syslog_level < lp_syslog() )
339 /* map debug levels to syslog() priorities
340 * note that not all DEBUG(0, ...) calls are
343 static int priority_map[] = {
352 if( syslog_level >= ( sizeof(priority_map) / sizeof(priority_map[0]) )
354 priority = LOG_DEBUG;
356 priority = priority_map[syslog_level];
359 va_start( ap, format_str );
362 format_str = va_arg( ap, char * );
364 vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
368 syslog( priority, "%s", msgbuf );
373 if( !lp_syslog_only() )
377 va_start( ap, format_str );
380 format_str = va_arg( ap, char * );
382 (void)vfprintf( dbf, format_str, ap );
395 /* ************************************************************************** **
396 * Print the buffer content via Debug1(), then reset the buffer.
401 * ************************************************************************** **
403 static void bufr_print( void )
405 format_bufr[format_pos] = '\0';
406 (void)Debug1( "%s", format_bufr );
410 /* ************************************************************************** **
411 * Format the debug message text.
413 * Input: msg - Text to be added to the "current" debug message text.
417 * Notes: The purpose of this is two-fold. First, each call to syslog()
418 * (used by Debug1(), see above) generates a new line of syslog
419 * output. This is fixed by storing the partial lines until the
420 * newline character is encountered. Second, printing the debug
421 * message lines when a newline is encountered allows us to add
422 * spaces, thus indenting the body of the message and making it
425 * ************************************************************************** **
427 static void format_debug_text( char *msg )
430 BOOL timestamp = (!stdout_logging && (lp_timestamp_logs() ||
433 for( i = 0; msg[i]; i++ )
435 /* Indent two spaces at each new line. */
436 if(timestamp && 0 == format_pos)
438 format_bufr[0] = format_bufr[1] = ' ';
442 /* If there's room, copy the character to the format buffer. */
443 if( format_pos < FORMAT_BUFR_MAX )
444 format_bufr[format_pos++] = msg[i];
446 /* If a newline is encountered, print & restart. */
450 /* If the buffer is full dump it out, reset it, and put out a line
451 * continuation indicator.
453 if( format_pos >= FORMAT_BUFR_MAX )
456 (void)Debug1( " +>\n" );
460 /* Just to be safe... */
461 format_bufr[format_pos] = '\0';
462 } /* format_debug_text */
464 /* ************************************************************************** **
465 * Flush debug output, including the format buffer content.
470 * ************************************************************************** **
472 void dbgflush( void )
478 /* ************************************************************************** **
479 * Print a Debug Header.
481 * Input: level - Debug level of the message (not the system-wide debug
483 * file - Pointer to a string containing the name of the file
484 * from which this function was called, or an empty string
485 * if the __FILE__ macro is not implemented.
486 * func - Pointer to a string containing the name of the function
487 * from which this function was called, or an empty string
488 * if the __FUNCTION__ macro is not implemented.
489 * line - line number of the call to dbghdr, assuming __LINE__
492 * Output: Always True. This makes it easy to fudge a call to dbghdr()
493 * in a macro, since the function can be called as part of a test.
494 * Eg: ( (level <= DEBUGLEVEL) && (dbghdr(level,"",line)) )
496 * Notes: This function takes care of setting syslog_level.
498 * ************************************************************************** **
500 BOOL dbghdr( int level, char *file, char *func, int line )
504 /* This is a fudge. If there is stuff sitting in the format_bufr, then
505 * the *right* thing to do is to call
506 * format_debug_text( "\n" );
507 * to write the remainder, and then proceed with the new header.
508 * Unfortunately, there are several places in the code at which
509 * the DEBUG() macro is used to build partial lines. That in mind,
510 * we'll work under the assumption that an incomplete line indicates
511 * that a new header is *not* desired.
516 /* Set syslog_level. */
517 syslog_level = level;
519 /* Don't print a header if we're logging to stdout. */
523 /* Print the header if timestamps are turned on. If parameters are
524 * not yet loaded, then default to timestamps on.
526 if( lp_timestamp_logs() || !(lp_loaded()) )
528 /* Print it all out at once to prevent split syslog output. */
529 (void)Debug1( "[%s, %d] %s:%s(%d)\n",
530 timestring(), level, file, func, line );
536 /* ************************************************************************** **
537 * Add text to the body of the "current" debug message via the format buffer.
539 * Input: format_str - Format string, as used in printf(), et. al.
540 * ... - Variable argument list.
542 * ..or.. va_alist - Old style variable parameter list starting point.
544 * Output: Always True. See dbghdr() for more info, though this is not
545 * likely to be used in the same way.
547 * ************************************************************************** **
550 BOOL dbgtext( char *format_str, ... )
555 va_start( ap, format_str );
556 vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
559 format_debug_text( msgbuf );
565 BOOL dbgtext( va_alist )
573 format_str = va_arg( ap, char * );
574 vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
577 format_debug_text( msgbuf );
584 /* ************************************************************************** */