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;
112 static int syslog_level = 0;
114 static pstring format_bufr = { '\0' };
115 static size_t format_pos = 0;
118 /* -------------------------------------------------------------------------- **
123 /* ************************************************************************** **
124 * catch a sigusr2 - decrease the debug log level.
125 * ************************************************************************** **
127 void sig_usr2( int sig )
133 DEBUG( 0, ( "Got SIGUSR2; set debug level to %d.\n", DEBUGLEVEL ) );
135 #if !defined(HAVE_SIGACTION)
136 CatchSignal( SIGUSR2, SIGNAL_CAST sig_usr2 );
143 /* ************************************************************************** **
144 * catch a sigusr1 - increase the debug log level.
145 * ************************************************************************** **
147 void sig_usr1( int sig )
152 if( DEBUGLEVEL > 10 )
155 DEBUG( 0, ( "Got SIGUSR1; set debug level to %d.\n", DEBUGLEVEL ) );
157 #if !defined(HAVE_SIGACTION)
158 CatchSignal( SIGUSR1, SIGNAL_CAST sig_usr1 );
165 /* ************************************************************************** **
166 * get ready for syslog stuff
167 * ************************************************************************** **
169 void setup_logging( char *pname, BOOL interactive )
173 stdout_logging = True;
179 char *p = strrchr( pname,'/' );
184 openlog( pname, LOG_PID, SYSLOG_FACILITY );
185 #else /* for old systems that have no facility codes. */
186 openlog( pname, LOG_PID );
190 } /* setup_logging */
192 /* ************************************************************************** **
193 * reopen the log files
194 * ************************************************************************** **
196 void reopen_logs( void )
202 pstrcpy( fname, debugf );
203 if( lp_loaded() && (*lp_logfile()) )
204 pstrcpy( fname, lp_logfile() );
206 if( !strcsequal( fname, debugf ) || !dbf || !file_exist( debugf, NULL ) )
208 mode_t oldumask = umask( 022 );
210 pstrcpy( debugf, fname );
214 dbf = sys_fopen( debugf, "a" );
216 dbf = sys_fopen( debugf, "w" );
217 /* Fix from klausr@ITAP.Physik.Uni-Stuttgart.De
218 * to fix problem where smbd's that generate less
219 * than 100 messages keep growing the log.
221 force_check_log_size();
224 (void)umask( oldumask );
237 /* ************************************************************************** **
238 * Force a check of the log size.
239 * ************************************************************************** **
241 void force_check_log_size( void )
244 } /* force_check_log_size */
246 /* ************************************************************************** **
247 * Check to see if the log has grown to be too big.
248 * ************************************************************************** **
250 static void check_log_size( void )
255 if( debug_count++ < 100 || geteuid() != 0 )
258 maxlog = lp_max_log_size() * 1024;
259 if( !dbf || maxlog <= 0 )
262 if( sys_fstat( fileno( dbf ), &st ) == 0 && st.st_size > maxlog )
267 if( dbf && get_file_size( debugf ) > maxlog )
273 slprintf( name, sizeof(name)-1, "%s.old", debugf );
274 (void)rename( debugf, name );
279 * Here's where we need to panic if dbf == NULL..
282 dbf = sys_fopen( "/dev/console", "w" );
284 DEBUG(0,("check_log_size: open of debug file %s failed - using console.\n",
288 * We cannot continue without a debug file handle.
294 } /* check_log_size */
296 /* ************************************************************************** **
297 * Write an debug message on the debugfile.
298 * This is called by dbghdr() and format_debug_text().
299 * ************************************************************************** **
302 int Debug1( char *format_str, ... )
311 int old_errno = errno;
316 va_start( ap, format_str );
319 format_str = va_arg( ap, char * );
321 (void)vfprintf( dbf, format_str, ap );
328 if( !lp_syslog_only() )
333 mode_t oldumask = umask( 022 );
336 dbf = sys_fopen( debugf, "a" );
338 dbf = sys_fopen( debugf, "w" );
339 (void)umask( oldumask );
353 if( syslog_level < lp_syslog() )
355 /* map debug levels to syslog() priorities
356 * note that not all DEBUG(0, ...) calls are
359 static int priority_map[] = {
368 if( syslog_level >= ( sizeof(priority_map) / sizeof(priority_map[0]) )
370 priority = LOG_DEBUG;
372 priority = priority_map[syslog_level];
375 va_start( ap, format_str );
378 format_str = va_arg( ap, char * );
380 vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
384 syslog( priority, "%s", msgbuf );
391 if( !lp_syslog_only() )
395 va_start( ap, format_str );
398 format_str = va_arg( ap, char * );
400 (void)vfprintf( dbf, format_str, ap );
411 /* ************************************************************************** **
412 * Print the buffer content via Debug1(), then reset the buffer.
417 * ************************************************************************** **
419 static void bufr_print( void )
421 format_bufr[format_pos] = '\0';
422 (void)Debug1( "%s", format_bufr );
426 /* ************************************************************************** **
427 * Format the debug message text.
429 * Input: msg - Text to be added to the "current" debug message text.
433 * Notes: The purpose of this is two-fold. First, each call to syslog()
434 * (used by Debug1(), see above) generates a new line of syslog
435 * output. This is fixed by storing the partial lines until the
436 * newline character is encountered. Second, printing the debug
437 * message lines when a newline is encountered allows us to add
438 * spaces, thus indenting the body of the message and making it
441 * ************************************************************************** **
443 static void format_debug_text( char *msg )
446 BOOL timestamp = (!stdout_logging && (lp_timestamp_logs() ||
449 for( i = 0; msg[i]; i++ )
451 /* Indent two spaces at each new line. */
452 if(timestamp && 0 == format_pos)
454 format_bufr[0] = format_bufr[1] = ' ';
458 /* If there's room, copy the character to the format buffer. */
459 if( format_pos < FORMAT_BUFR_MAX )
460 format_bufr[format_pos++] = msg[i];
462 /* If a newline is encountered, print & restart. */
466 /* If the buffer is full dump it out, reset it, and put out a line
467 * continuation indicator.
469 if( format_pos >= FORMAT_BUFR_MAX )
472 (void)Debug1( " +>\n" );
476 /* Just to be safe... */
477 format_bufr[format_pos] = '\0';
478 } /* format_debug_text */
480 /* ************************************************************************** **
481 * Flush debug output, including the format buffer content.
486 * ************************************************************************** **
488 void dbgflush( void )
494 /* ************************************************************************** **
495 * Print a Debug Header.
497 * Input: level - Debug level of the message (not the system-wide debug
499 * file - Pointer to a string containing the name of the file
500 * from which this function was called, or an empty string
501 * if the __FILE__ macro is not implemented.
502 * func - Pointer to a string containing the name of the function
503 * from which this function was called, or an empty string
504 * if the __FUNCTION__ macro is not implemented.
505 * line - line number of the call to dbghdr, assuming __LINE__
508 * Output: Always True. This makes it easy to fudge a call to dbghdr()
509 * in a macro, since the function can be called as part of a test.
510 * Eg: ( (level <= DEBUGLEVEL) && (dbghdr(level,"",line)) )
512 * Notes: This function takes care of setting syslog_level.
514 * ************************************************************************** **
517 BOOL dbghdr( int level, char *file, char *func, int line )
519 /* Ensure we don't lose any real errno value. */
520 int old_errno = errno;
523 /* This is a fudge. If there is stuff sitting in the format_bufr, then
524 * the *right* thing to do is to call
525 * format_debug_text( "\n" );
526 * to write the remainder, and then proceed with the new header.
527 * Unfortunately, there are several places in the code at which
528 * the DEBUG() macro is used to build partial lines. That in mind,
529 * we'll work under the assumption that an incomplete line indicates
530 * that a new header is *not* desired.
536 /* Set syslog_level. */
537 syslog_level = level;
540 /* Don't print a header if we're logging to stdout. */
544 /* Print the header if timestamps are turned on. If parameters are
545 * not yet loaded, then default to timestamps on.
547 if( lp_timestamp_logs() || !(lp_loaded()) ) {
548 char header_str[200];
550 header_str[0] = '\0';
553 slprintf(header_str,sizeof(header_str)-1,", pid=%u",(unsigned int)getpid());
555 if( lp_debug_uid()) {
556 size_t hs_len = strlen(header_str);
557 slprintf(header_str + hs_len,
558 sizeof(header_str) - 1 - hs_len,
559 ", effective(%u, %u), real(%u, %u)",
560 (unsigned int)geteuid(), (unsigned int)getegid(),
561 (unsigned int)getuid(), (unsigned int)getgid());
564 /* Print it all out at once to prevent split syslog output. */
565 (void)Debug1( "[%s, %d%s] %s:%s(%d)\n",
566 timestring(lp_debug_hires_timestamp()), level,
567 header_str, file, func, line );
574 /* ************************************************************************** **
575 * Add text to the body of the "current" debug message via the format buffer.
577 * Input: format_str - Format string, as used in printf(), et. al.
578 * ... - Variable argument list.
580 * ..or.. va_alist - Old style variable parameter list starting point.
582 * Output: Always True. See dbghdr() for more info, though this is not
583 * likely to be used in the same way.
585 * ************************************************************************** **
588 BOOL dbgtext( char *format_str, ... )
593 va_start( ap, format_str );
594 vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
597 format_debug_text( msgbuf );
603 BOOL dbgtext( va_alist )
611 format_str = va_arg( ap, char * );
612 vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
615 format_debug_text( msgbuf );
622 /* ************************************************************************** */