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 /* -------------------------------------------------------------------------- **
25 * This module implements Samba's debugging utility.
27 * The syntax of a debugging log file is represented as:
29 * <debugfile> :== { <debugmsg> }
31 * <debugmsg> :== <debughdr> '\n' <debugtext>
33 * <debughdr> :== '[' TIME ',' LEVEL ']' [ [FILENAME ':'] [FUNCTION '()'] ]
35 * <debugtext> :== { <debugline> }
37 * <debugline> :== TEXT '\n'
39 * TEXT is a string of characters excluding the newline character.
40 * LEVEL is the DEBUG level of the message (an integer in the range 0..10).
41 * TIME is a timestamp.
42 * FILENAME is the name of the file from which the debug message was generated.
43 * FUNCTION is the function from which the debug message was generated.
45 * Basically, what that all means is:
47 * - A debugging log file is made up of debug messages.
49 * - Each debug message is made up of a header and text. The header is
50 * separated from the text by a newline.
52 * - The header begins with the timestamp and debug level of the message
53 * enclosed in brackets. The filename and function from which the
54 * message was generated may follow. The filename is terminated by a
55 * colon, and the function name is terminated by parenthesis.
57 * - The message text is made up of zero or more lines, each terminated by
61 /* -------------------------------------------------------------------------- **
64 * dbf - Global debug file handle.
65 * debugf - Debug file name.
66 * append_log - If True, then the output file will be opened in append
68 * DEBUGLEVEL - System-wide debug message limit. Messages with message-
69 * levels higher than DEBUGLEVEL will not be processed.
74 BOOL append_log
= False
;
78 /* -------------------------------------------------------------------------- **
81 * stdout_logging - Default False, if set to True then dbf will be set to
82 * stdout and debug output will go to dbf only, and not
83 * to syslog. Set in setup_logging() and read in Debug1().
85 * debug_count - Number of debug messages that have been output.
86 * Used to check log size.
88 * syslog_level - Internal copy of the message debug level. Written by
89 * dbghdr() and read by Debug1().
91 * format_bufr - Used to format debug messages. The dbgtext() function
92 * prints debug messages to a string, and then passes the
93 * string to format_debug_text(), which uses format_bufr
94 * to build the formatted output.
96 * format_pos - Marks the first free byte of the format_bufr.
99 static BOOL stdout_logging
= False
;
100 static int debug_count
= 0;
101 static int syslog_level
= 0;
102 static pstring format_bufr
= { '\0' };
103 static int format_pos
= 0;
106 /* -------------------------------------------------------------------------- **
111 /* ************************************************************************** **
112 * catch a sigusr2 - decrease the debug log level.
113 * ************************************************************************** **
117 BlockSignals( True
, SIGUSR2
);
123 DEBUG( 0, ( "Got SIGUSR2; set debug level to %d.\n", DEBUGLEVEL
) );
125 BlockSignals( False
, SIGUSR2
);
126 CatchSignal( SIGUSR2
, SIGNAL_CAST sig_usr2
);
133 /* ************************************************************************** **
134 * catch a sigusr1 - increase the debug log level.
135 * ************************************************************************** **
139 BlockSignals( True
, SIGUSR1
);
143 if( DEBUGLEVEL
> 10 )
146 DEBUG( 0, ( "Got SIGUSR1; set debug level to %d.\n", DEBUGLEVEL
) );
148 BlockSignals( False
, SIGUSR1
);
149 CatchSignal( SIGUSR1
, SIGNAL_CAST sig_usr1
);
156 /* ************************************************************************** **
157 * get ready for syslog stuff
158 * ************************************************************************** **
160 void setup_logging( char *pname
, BOOL interactive
)
164 stdout_logging
= True
;
170 char *p
= strrchr( pname
,'/' );
175 openlog( pname
, LOG_PID
, SYSLOG_FACILITY
);
176 #else /* for old systems that have no facility codes. */
177 openlog( pname
, LOG_PID
);
181 } /* setup_logging */
183 /* ************************************************************************** **
184 * reopen the log files
185 * ************************************************************************** **
187 void reopen_logs( void )
193 pstrcpy( fname
, debugf
);
194 if( lp_loaded() && (*lp_logfile()) )
195 pstrcpy( fname
, lp_logfile() );
197 if( !strcsequal( fname
, debugf
) || !dbf
|| !file_exist( debugf
, NULL
) )
199 int oldumask
= umask( 022 );
201 pstrcpy( debugf
, fname
);
205 dbf
= fopen( debugf
, "a" );
207 dbf
= fopen( debugf
, "w" );
208 /* Fix from klausr@ITAP.Physik.Uni-Stuttgart.De
209 * to fix problem where smbd's that generate less
210 * than 100 messages keep growing the log.
212 force_check_log_size();
215 (void)umask( oldumask
);
228 /* ************************************************************************** **
229 * Force a check of the log size.
230 * ************************************************************************** **
232 void force_check_log_size( void )
235 } /* force_check_log_size */
237 /* ************************************************************************** **
238 * Check to see if the log has grown to be too big.
239 * ************************************************************************** **
241 static void check_log_size( void )
246 if( debug_count
++ < 100 || getuid() != 0 )
249 maxlog
= lp_max_log_size() * 1024;
250 if( !dbf
|| maxlog
<= 0 )
253 if( fstat( fileno( dbf
), &st
) == 0 && st
.st_size
> maxlog
)
258 if( dbf
&& file_size( debugf
) > maxlog
)
264 slprintf( name
, sizeof(name
)-1, "%s.old", debugf
);
265 (void)rename( debugf
, name
);
270 } /* check_log_size */
272 /* ************************************************************************** **
273 * Write an debug message on the debugfile.
274 * This is called by dbghdr() and format_debug_text().
275 * ************************************************************************** **
278 int Debug1( char *format_str
, ... )
287 int old_errno
= errno
;
292 va_start( ap
, format_str
);
295 format_str
= va_arg( ap
, char * );
297 (void)vfprintf( dbf
, format_str
, ap
);
304 if( !lp_syslog_only() )
309 int oldumask
= umask( 022 );
312 dbf
= fopen( debugf
, "a" );
314 dbf
= fopen( debugf
, "w" );
315 (void)umask( oldumask
);
329 if( syslog_level
< lp_syslog() )
331 /* map debug levels to syslog() priorities
332 * note that not all DEBUG(0, ...) calls are
335 static int priority_map
[] = {
344 if( syslog_level
>= ( sizeof(priority_map
) / sizeof(priority_map
[0]) )
346 priority
= LOG_DEBUG
;
348 priority
= priority_map
[syslog_level
];
351 va_start( ap
, format_str
);
354 format_str
= va_arg( ap
, char * );
356 vslprintf( msgbuf
, sizeof(msgbuf
)-1, format_str
, ap
);
360 syslog( priority
, "%s", msgbuf
);
365 if( !lp_syslog_only() )
369 va_start( ap
, format_str
);
372 format_str
= va_arg( ap
, char * );
374 (void)vfprintf( dbf
, format_str
, ap
);
387 /* ************************************************************************** **
388 * Print the buffer content via Debug1(), then reset the buffer.
393 * ************************************************************************** **
395 static void bufr_print( void )
397 format_bufr
[format_pos
] = '\0';
398 (void)Debug1( "%s", format_bufr
);
402 /* ************************************************************************** **
403 * Format the debug message text.
405 * Input: msg - Text to be added to the "current" debug message text.
409 * Notes: The purpose of this is two-fold. First, each call to syslog()
410 * (used by Debug1(), see above) generates a new line of syslog
411 * output. This is fixed by storing the partial lines until the
412 * newline character is encountered. Second, printing the debug
413 * message lines when a newline is encountered allows us to add
414 * spaces, thus indenting the body of the message and making it
417 * ************************************************************************** **
419 static void format_debug_text( char *msg
)
421 int max
= sizeof( format_bufr
) - 1;
424 for( i
= 0; msg
[i
]; i
++ )
426 /* Indent two spaces at each new line. */
427 if( 0 == format_pos
)
429 format_bufr
[0] = format_bufr
[1] = ' ';
433 /* If there's room, copy the character to the format buffer. */
434 if( format_pos
< max
)
435 format_bufr
[format_pos
++] = msg
[i
];
437 /* If a newline is encountered, print & restart. */
442 /* Just to be safe... */
443 format_bufr
[format_pos
] = '\0';
444 } /* format_debug_text */
446 /* ************************************************************************** **
447 * Flush debug output, including the format buffer content.
452 * ************************************************************************** **
454 void dbgflush( void )
460 /* ************************************************************************** **
461 * Print a Debug Header.
463 * Input: level - Debug level of the message (not the system-wide debug
465 * file - Pointer to a string containing the name of the file
466 * from which this function was called, or an empty string
467 * if the __FILE__ macro is not implemented.
468 * func - Pointer to a string containing the name of the function
469 * from which this function was called, or an empty string
470 * if the __FUNCTION__ macro is not implemented.
471 * line - line number of the call to dbghdr, assuming __LINE__
474 * Output: Always True. This makes it easy to fudge a call to dbghdr()
475 * in a macro, since the function can be called as part of a test.
476 * Eg: ( (level <= DEBUGLEVEL) && (dbghdr(level,"",line)) )
478 * Notes: This function takes care of setting syslog_level.
480 * ************************************************************************** **
482 BOOL
dbghdr( int level
, char *file
, char *func
, int line
)
486 /* This is a fudge. If there is stuff sitting in the format_bufr, then
487 * the *right* thing to do is to call
488 * format_debug_text( "\n" );
489 * to write the remainder, and then proceed with the new header.
490 * Unfortunately, there are several places in the code at which
491 * the DEBUG() macro is used to build partial lines. That in mind,
492 * we'll work under the assumption that an incomplete line indicates
493 * that a new header is *not* desired.
498 /* Set syslog_level. */
499 syslog_level
= level
;
501 /* Don't print a header if we're logging to stdout. */
505 /* Print the header if timestamps are turned on. If parameters are
506 * not yet loaded, then default to timestamps on.
508 if( lp_timestamp_logs() || !(lp_loaded()) )
510 /* Print it all out at once to prevent split syslog output. */
511 (void)Debug1( "[%s, %d] %s:%s(%d)\n",
512 timestring(), level
, file
, func
, line
);
518 /* ************************************************************************** **
519 * Add text to the body of the "current" debug message via the format buffer.
521 * Input: format_str - Format string, as used in printf(), et. al.
522 * ... - Variable argument list.
524 * ..or.. va_alist - Old style variable parameter list starting point.
526 * Output: Always True. See dbghdr() for more info, though this is not
527 * likely to be used in the same way.
529 * ************************************************************************** **
532 BOOL
dbgtext( char *format_str
, ... )
537 va_start( ap
, format_str
);
538 vslprintf( msgbuf
, sizeof(msgbuf
)-1, format_str
, ap
);
541 format_debug_text( msgbuf
);
547 BOOL
dbgtext( va_alist
)
555 format_str
= va_arg( ap
, char * );
556 vslprintf( msgbuf
, sizeof(msgbuf
)-1, format_str
, ap
);
559 format_debug_text( msgbuf
);
566 /* ************************************************************************** */