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;
86 int DEBUGLEVEL_CLASS[DBGC_LAST];
87 int DEBUGLEVEL = DEBUGLEVEL_CLASS;
90 /* -------------------------------------------------------------------------- **
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().
97 * debug_count - Number of debug messages that have been output.
98 * Used to check log size.
100 * syslog_level - Internal copy of the message debug level. Written by
101 * dbghdr() and read by Debug1().
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.
108 * format_pos - Marks the first free byte of the format_bufr.
111 * log_overflow - When this variable is True, never attempt to check the
112 * size of the log. This is a hack, so that we can write
113 * a message using DEBUG, from open_logs() when we
114 * are unable to open a new log file for some reason.
117 static BOOL stdout_logging = False;
118 static int debug_count = 0;
120 static int syslog_level = 0;
122 static pstring format_bufr = { '\0' };
123 static size_t format_pos = 0;
124 static BOOL log_overflow = False;
127 * Define all the debug class selection names here. Names *MUST NOT* contain
128 * white space. There must be one name for each DBGC_<class name>, and they
129 * must be in the table in the order of DBGC_<class name>..
131 char *classname_table[] = {
132 "all", /* DBGC_ALL; index references traditional DEBUGLEVEL */
133 "tdb", /* DBGC_TDB */
134 "printdrivers", /* DBGC_PRINTDRIVERS */
135 "lanman", /* DBGC_LANMAN */
139 /* -------------------------------------------------------------------------- **
143 /****************************************************************************
144 utility access to debug class names's
145 ****************************************************************************/
146 char* debug_classname_from_index(int ndx)
148 return classname_table[ndx];
151 /****************************************************************************
152 utility to translate names to debug class index's
153 ****************************************************************************/
154 int debug_lookup_classname(char* classname)
158 if (!classname) return -1;
160 for (i=0; i<DBGC_LAST; i++) {
161 if (strcmp(classname, classname_table[i])==0)
167 /****************************************************************************
168 parse the debug levels from smbcontrol. Example debug level parameter:
170 ****************************************************************************/
171 BOOL debug_parse_params(char **params, int *debuglevel_class)
177 /* Set the new debug level array to the current DEBUGLEVEL array */
178 memcpy(debuglevel_class, DEBUGLEVEL_CLASS, sizeof(DEBUGLEVEL_CLASS));
180 /* Allow DBGC_ALL to be specifies w/o requiring its class name e.g."10"
181 * v.s. "all:10", this is the traditional way to set DEBUGLEVEL
183 if (isdigit((int)params[0][0])) {
184 debuglevel_class[DBGC_ALL] = atoi(params[0]);
185 i = 1; /* start processing at the next params */
188 i = 0; /* DBGC_ALL not specified OR calss name was included */
190 /* Fill in new debug class levels */
191 for (; i < DBGC_LAST && params[i]; i++) {
192 if ((class_name=strtok(params[i],":")) &&
193 (class_level=strtok(NULL, "\0")) &&
194 ((ndx = debug_lookup_classname(class_name)) != -1)) {
195 debuglevel_class[ndx] = atoi(class_level);
197 DEBUG(0,("debug_parse_params: unrecognized debug class name or format [%s]\n", params[i]));
205 /****************************************************************************
206 parse the debug levels from smb.conf. Example debug level string:
207 3 tdb:5 printdrivers:7
208 Note: the 1st param has no "name:" preceeding it.
209 ****************************************************************************/
210 BOOL debug_parse_levels(char *params_str)
213 char *params[DBGC_LAST];
214 int debuglevel_class[DBGC_LAST];
217 ZERO_ARRAY(debuglevel_class);
219 if ((params[0]=strtok(params_str," ,"))) {
220 for (i=1; i<DBGC_LAST;i++) {
221 if ((params[i]=strtok(NULL," ,"))==NULL)
228 if (debug_parse_params(params, debuglevel_class)) {
229 debug_message(0, getpid(), (void*)debuglevel_class, sizeof(debuglevel_class));
235 /****************************************************************************
236 receive a "set debug level" message
237 ****************************************************************************/
238 void debug_message(int msg_type, pid_t src, void *buf, size_t len)
242 /* Set the new DEBUGLEVEL_CLASS array from the pased array */
243 memcpy(DEBUGLEVEL_CLASS, buf, sizeof(DEBUGLEVEL_CLASS));
245 DEBUG(1,("INFO: Debug class %s level = %d (pid %u from pid %u)\n",
246 classname_table[DBGC_ALL],
247 DEBUGLEVEL_CLASS[DBGC_ALL], (unsigned int)getpid(), (unsigned int)src));
249 for (i=1; i<DBGC_LAST; i++) {
250 if (DEBUGLEVEL_CLASS[i])
251 DEBUGADD(1,("INFO: Debug class %s level = %d\n",
252 classname_table[i], DEBUGLEVEL_CLASS[i]));
257 /****************************************************************************
258 send a "set debug level" message
259 ****************************************************************************/
260 void debug_message_send(pid_t pid, int level)
262 message_send_pid(pid, MSG_DEBUG, &level, sizeof(int), False);
266 /* ************************************************************************** **
267 * get ready for syslog stuff
268 * ************************************************************************** **
270 void setup_logging(char *pname, BOOL interactive)
272 message_register(MSG_DEBUG, debug_message);
274 /* reset to allow multiple setup calls, going from interactive to
276 stdout_logging = False;
280 stdout_logging = True;
285 char *p = strrchr( pname,'/' );
289 openlog( pname, LOG_PID, SYSLOG_FACILITY );
290 #else /* for old systems that have no facility codes. */
291 openlog( pname, LOG_PID );
295 } /* setup_logging */
297 /* ************************************************************************** **
298 * reopen the log files
299 * note that we now do this unconditionally
300 * We attempt to open the new debug fp before closing the old. This means
301 * if we run out of fd's we just keep using the old fd rather than aborting.
302 * Fix from dgibson@linuxcare.com.
303 * ************************************************************************** **
306 BOOL reopen_logs( void )
310 FILE *new_dbf = NULL;
313 if (DEBUGLEVEL_CLASS[ DBGC_ALL ] <= 0) {
321 oldumask = umask( 022 );
323 pstrcpy(fname, debugf );
324 if (lp_loaded() && (*lp_logfile()))
325 pstrcpy(fname, lp_logfile());
327 pstrcpy( debugf, fname );
329 new_dbf = sys_fopen( debugf, "a" );
331 new_dbf = sys_fopen( debugf, "w" );
335 DEBUG(0, ("Unable to open new log file %s: %s\n", debugf, strerror(errno)));
336 log_overflow = False;
340 setbuf(new_dbf, NULL);
346 /* Fix from klausr@ITAP.Physik.Uni-Stuttgart.De
347 * to fix problem where smbd's that generate less
348 * than 100 messages keep growing the log.
350 force_check_log_size();
351 (void)umask(oldumask);
356 /* ************************************************************************** **
357 * Force a check of the log size.
358 * ************************************************************************** **
360 void force_check_log_size( void )
365 /***************************************************************************
366 Check to see if there is any need to check if the logfile has grown too big.
367 **************************************************************************/
369 BOOL need_to_check_log_size( void )
373 if( debug_count++ < 100 )
376 maxlog = lp_max_log_size() * 1024;
377 if( !dbf || maxlog <= 0 ) {
384 /* ************************************************************************** **
385 * Check to see if the log has grown to be too big.
386 * ************************************************************************** **
389 void check_log_size( void )
395 * We need to be root to check/change log-file, skip this and let the main
396 * loop check do a new check as root.
402 if(log_overflow || !need_to_check_log_size() )
405 maxlog = lp_max_log_size() * 1024;
407 if( sys_fstat( fileno( dbf ), &st ) == 0 && st.st_size > maxlog ) {
409 if( dbf && get_file_size( debugf ) > maxlog ) {
412 slprintf( name, sizeof(name)-1, "%s.old", debugf );
413 (void)rename( debugf, name );
415 if (!reopen_logs()) {
416 /* We failed to reopen a log - continue using the old name. */
417 (void)rename(name, debugf);
423 * Here's where we need to panic if dbf == NULL..
427 /* This code should only be reached in very strange
428 circumstances. If we merely fail to open the new log we
429 should stick with the old one. ergo this should only be
430 reached when opening the logs for the first time: at
431 startup or when the log level is increased from zero.
434 dbf = sys_fopen( "/dev/console", "w" );
436 DEBUG(0,("check_log_size: open of debug file %s failed - using console.\n",
440 * We cannot continue without a debug file handle.
446 } /* check_log_size */
448 /* ************************************************************************** **
449 * Write an debug message on the debugfile.
450 * This is called by dbghdr() and format_debug_text().
451 * ************************************************************************** **
454 int Debug1( char *format_str, ... )
463 int old_errno = errno;
468 va_start( ap, format_str );
471 format_str = va_arg( ap, char * );
474 (void)vfprintf( dbf, format_str, ap );
481 if( !lp_syslog_only() )
486 mode_t oldumask = umask( 022 );
489 dbf = sys_fopen( debugf, "a" );
491 dbf = sys_fopen( debugf, "w" );
492 (void)umask( oldumask );
506 if( syslog_level < lp_syslog() )
508 /* map debug levels to syslog() priorities
509 * note that not all DEBUG(0, ...) calls are
512 static int priority_map[] = {
521 if( syslog_level >= ( sizeof(priority_map) / sizeof(priority_map[0]) )
523 priority = LOG_DEBUG;
525 priority = priority_map[syslog_level];
528 va_start( ap, format_str );
531 format_str = va_arg( ap, char * );
533 vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
537 syslog( priority, "%s", msgbuf );
544 if( !lp_syslog_only() )
548 va_start( ap, format_str );
551 format_str = va_arg( ap, char * );
554 (void)vfprintf( dbf, format_str, ap );
566 /* ************************************************************************** **
567 * Print the buffer content via Debug1(), then reset the buffer.
572 * ************************************************************************** **
574 static void bufr_print( void )
576 format_bufr[format_pos] = '\0';
577 (void)Debug1( "%s", format_bufr );
581 /* ************************************************************************** **
582 * Format the debug message text.
584 * Input: msg - Text to be added to the "current" debug message text.
588 * Notes: The purpose of this is two-fold. First, each call to syslog()
589 * (used by Debug1(), see above) generates a new line of syslog
590 * output. This is fixed by storing the partial lines until the
591 * newline character is encountered. Second, printing the debug
592 * message lines when a newline is encountered allows us to add
593 * spaces, thus indenting the body of the message and making it
596 * ************************************************************************** **
598 static void format_debug_text( char *msg )
601 BOOL timestamp = (!stdout_logging && (lp_timestamp_logs() ||
604 for( i = 0; msg[i]; i++ )
606 /* Indent two spaces at each new line. */
607 if(timestamp && 0 == format_pos)
609 format_bufr[0] = format_bufr[1] = ' ';
613 /* If there's room, copy the character to the format buffer. */
614 if( format_pos < FORMAT_BUFR_MAX )
615 format_bufr[format_pos++] = msg[i];
617 /* If a newline is encountered, print & restart. */
621 /* If the buffer is full dump it out, reset it, and put out a line
622 * continuation indicator.
624 if( format_pos >= FORMAT_BUFR_MAX )
627 (void)Debug1( " +>\n" );
631 /* Just to be safe... */
632 format_bufr[format_pos] = '\0';
633 } /* format_debug_text */
635 /* ************************************************************************** **
636 * Flush debug output, including the format buffer content.
641 * ************************************************************************** **
643 void dbgflush( void )
650 /* ************************************************************************** **
651 * Print a Debug Header.
653 * Input: level - Debug level of the message (not the system-wide debug
655 * file - Pointer to a string containing the name of the file
656 * from which this function was called, or an empty string
657 * if the __FILE__ macro is not implemented.
658 * func - Pointer to a string containing the name of the function
659 * from which this function was called, or an empty string
660 * if the __FUNCTION__ macro is not implemented.
661 * line - line number of the call to dbghdr, assuming __LINE__
664 * Output: Always True. This makes it easy to fudge a call to dbghdr()
665 * in a macro, since the function can be called as part of a test.
666 * Eg: ( (level <= DEBUGLEVEL) && (dbghdr(level,"",line)) )
668 * Notes: This function takes care of setting syslog_level.
670 * ************************************************************************** **
673 BOOL dbghdr( int level, char *file, char *func, int line )
675 /* Ensure we don't lose any real errno value. */
676 int old_errno = errno;
679 /* This is a fudge. If there is stuff sitting in the format_bufr, then
680 * the *right* thing to do is to call
681 * format_debug_text( "\n" );
682 * to write the remainder, and then proceed with the new header.
683 * Unfortunately, there are several places in the code at which
684 * the DEBUG() macro is used to build partial lines. That in mind,
685 * we'll work under the assumption that an incomplete line indicates
686 * that a new header is *not* desired.
692 /* Set syslog_level. */
693 syslog_level = level;
696 /* Don't print a header if we're logging to stdout. */
700 /* Print the header if timestamps are turned on. If parameters are
701 * not yet loaded, then default to timestamps on.
703 if( lp_timestamp_logs() || !(lp_loaded()) ) {
704 char header_str[200];
706 header_str[0] = '\0';
709 slprintf(header_str,sizeof(header_str)-1,", pid=%u",(unsigned int)sys_getpid());
711 if( lp_debug_uid()) {
712 size_t hs_len = strlen(header_str);
713 slprintf(header_str + hs_len,
714 sizeof(header_str) - 1 - hs_len,
715 ", effective(%u, %u), real(%u, %u)",
716 (unsigned int)geteuid(), (unsigned int)getegid(),
717 (unsigned int)getuid(), (unsigned int)getgid());
720 /* Print it all out at once to prevent split syslog output. */
721 (void)Debug1( "[%s, %d%s] %s:%s(%d)\n",
722 timestring(lp_debug_hires_timestamp()), level,
723 header_str, file, func, line );
730 /* ************************************************************************** **
731 * Add text to the body of the "current" debug message via the format buffer.
733 * Input: format_str - Format string, as used in printf(), et. al.
734 * ... - Variable argument list.
736 * ..or.. va_alist - Old style variable parameter list starting point.
738 * Output: Always True. See dbghdr() for more info, though this is not
739 * likely to be used in the same way.
741 * ************************************************************************** **
744 BOOL dbgtext( char *format_str, ... )
749 va_start( ap, format_str );
750 vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
753 format_debug_text( msgbuf );
759 BOOL dbgtext( va_alist )
767 format_str = va_arg( ap, char * );
768 vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
771 format_debug_text( msgbuf );
778 /* ************************************************************************** */