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;
85 int DEBUGLEVEL_CLASS[DBGC_LAST];
86 int DEBUGLEVEL = DEBUGLEVEL_CLASS;
89 /* -------------------------------------------------------------------------- **
92 * stdout_logging - Default False, if set to True then dbf will be set to
93 * stdout and debug output will go to dbf only, and not
94 * to syslog. Set in setup_logging() and read in Debug1().
96 * debug_count - Number of debug messages that have been output.
97 * Used to check log size.
99 * syslog_level - Internal copy of the message debug level. Written by
100 * dbghdr() and read by Debug1().
102 * format_bufr - Used to format debug messages. The dbgtext() function
103 * prints debug messages to a string, and then passes the
104 * string to format_debug_text(), which uses format_bufr
105 * to build the formatted output.
107 * format_pos - Marks the first free byte of the format_bufr.
110 static BOOL stdout_logging = False;
111 static int debug_count = 0;
113 static int syslog_level = 0;
115 static pstring format_bufr = { '\0' };
116 static size_t format_pos = 0;
119 * Define all the debug class selection names here. Names *MUST NOT* contain
120 * white space. There must be one name for each DBGC_<class name>, and they
121 * must be in the table in the order of DBGC_<class name>..
123 char *classname_table[] = {
124 "all", /* DBGC_ALL; index references traditional DEBUGLEVEL */
125 "tdb", /* DBGC_TDB */
126 "printdrivers", /* DBGC_PRINTDRIVERS */
127 "lanman", /* DBGC_LANMAN */
131 /* -------------------------------------------------------------------------- **
135 /****************************************************************************
136 utility access to debug class names's
137 ****************************************************************************/
138 char* debug_classname_from_index(int ndx)
140 return classname_table[ndx];
143 /****************************************************************************
144 utility to translate names to debug class index's
145 ****************************************************************************/
146 int debug_lookup_classname(char* classname)
150 if (!classname) return -1;
152 for (i=0; i<DBGC_LAST; i++) {
153 if (strcmp(classname, classname_table[i])==0)
159 /****************************************************************************
160 parse the debug levels from smbcontrol. Example debug level parameter:
162 ****************************************************************************/
163 BOOL debug_parse_params(char **params, int *debuglevel_class)
169 /* Set the new debug level array to the current DEBUGLEVEL array */
170 memcpy(debuglevel_class, DEBUGLEVEL_CLASS, sizeof(DEBUGLEVEL_CLASS));
172 /* Allow DBGC_ALL to be specifies w/o requiring its class name e.g."10"
173 * v.s. "all:10", this is the traditional way to set DEBUGLEVEL
175 if (isdigit(params[0][0])) {
176 debuglevel_class[DBGC_ALL] = atoi(params[0]);
177 i = 1; /* start processing at the next params */
180 i = 0; /* DBGC_ALL not specified OR calss name was included */
182 /* Fill in new debug class levels */
183 for (; i < DBGC_LAST && params[i]; i++) {
184 if ((class_name=strtok(params[i],":")) &&
185 (class_level=strtok(NULL, "\0")) &&
186 ((ndx = debug_lookup_classname(class_name)) != -1)) {
187 debuglevel_class[ndx] = atoi(class_level);
189 DEBUG(0,("debug_parse_params: unrecognized debug class name or format [%s]\n", params[i]));
197 /****************************************************************************
198 parse the debug levels from smb.conf. Example debug level string:
199 3 tdb:5 printdrivers:7
200 Note: the 1st param has no "name:" preceeding it.
201 ****************************************************************************/
202 BOOL debug_parse_levels(char *params_str)
205 char *params[DBGC_LAST];
206 int debuglevel_class[DBGC_LAST];
209 ZERO_ARRAY(debuglevel_class);
211 if ((params[0]=strtok(params_str," ,"))) {
212 for (i=1; i<DBGC_LAST;i++) {
213 if ((params[i]=strtok(NULL," ,"))==NULL)
220 if (debug_parse_params(params, debuglevel_class)) {
221 debug_message(0, getpid(), (void*)debuglevel_class, sizeof(debuglevel_class));
227 /****************************************************************************
228 receive a "set debug level" message
229 ****************************************************************************/
230 void debug_message(int msg_type, pid_t src, void *buf, size_t len)
234 /* Set the new DEBUGLEVEL_CLASS array from the pased array */
235 memcpy(DEBUGLEVEL_CLASS, buf, sizeof(DEBUGLEVEL_CLASS));
237 DEBUG(1,("INFO: Debug class %s level = %d (pid %d from pid %d)\n",
238 classname_table[DBGC_ALL],
239 DEBUGLEVEL_CLASS[DBGC_ALL], getpid(), (int)src));
241 for (i=1; i<DBGC_LAST; i++) {
242 if (DEBUGLEVEL_CLASS[i])
243 DEBUGADD(1,("INFO: Debug class %s level = %d\n",
244 classname_table[i], DEBUGLEVEL_CLASS[i]));
249 /****************************************************************************
250 send a "set debug level" message
251 ****************************************************************************/
252 void debug_message_send(pid_t pid, int level)
254 message_send_pid(pid, MSG_DEBUG, &level, sizeof(int), False);
258 /* ************************************************************************** **
259 * get ready for syslog stuff
260 * ************************************************************************** **
262 void setup_logging(char *pname, BOOL interactive)
264 message_register(MSG_DEBUG, debug_message);
267 stdout_logging = True;
272 char *p = strrchr( pname,'/' );
276 openlog( pname, LOG_PID, SYSLOG_FACILITY );
277 #else /* for old systems that have no facility codes. */
278 openlog( pname, LOG_PID );
282 } /* setup_logging */
284 /* ************************************************************************** **
285 * reopen the log files
286 * note that we now do this unconditionally
287 * ************************************************************************** **
289 void reopen_logs( void )
294 if (DEBUGLEVEL_CLASS[ DBGC_ALL ] <= 0) {
302 oldumask = umask( 022 );
304 pstrcpy(fname, debugf );
305 if (lp_loaded() && (*lp_logfile()))
306 pstrcpy(fname, lp_logfile());
308 pstrcpy( debugf, fname );
312 dbf = sys_fopen( debugf, "a" );
314 dbf = sys_fopen( debugf, "w" );
315 /* Fix from klausr@ITAP.Physik.Uni-Stuttgart.De
316 * to fix problem where smbd's that generate less
317 * than 100 messages keep growing the log.
319 force_check_log_size();
322 (void)umask(oldumask);
326 /* ************************************************************************** **
327 * Force a check of the log size.
328 * ************************************************************************** **
330 void force_check_log_size( void )
335 /***************************************************************************
336 Check to see if there is any need to check if the logfile has grown too big.
337 **************************************************************************/
339 BOOL need_to_check_log_size( void )
343 if( debug_count++ < 100 )
346 maxlog = lp_max_log_size() * 1024;
347 if( !dbf || maxlog <= 0 ) {
354 /* ************************************************************************** **
355 * Check to see if the log has grown to be too big.
356 * ************************************************************************** **
359 void check_log_size( void )
365 * We need to be root to check/change log-file, skip this and let the main
366 * loop check do a new check as root.
372 if( !need_to_check_log_size() )
375 maxlog = lp_max_log_size() * 1024;
377 if( sys_fstat( fileno( dbf ), &st ) == 0 && st.st_size > maxlog )
382 if( dbf && get_file_size( debugf ) > maxlog )
388 slprintf( name, sizeof(name)-1, "%s.old", debugf );
389 (void)rename( debugf, name );
394 * Here's where we need to panic if dbf == NULL..
397 dbf = sys_fopen( "/dev/console", "w" );
399 DEBUG(0,("check_log_size: open of debug file %s failed - using console.\n",
403 * We cannot continue without a debug file handle.
409 } /* check_log_size */
411 /* ************************************************************************** **
412 * Write an debug message on the debugfile.
413 * This is called by dbghdr() and format_debug_text().
414 * ************************************************************************** **
417 int Debug1( char *format_str, ... )
426 int old_errno = errno;
431 va_start( ap, format_str );
434 format_str = va_arg( ap, char * );
437 (void)vfprintf( dbf, format_str, ap );
444 if( !lp_syslog_only() )
449 mode_t oldumask = umask( 022 );
452 dbf = sys_fopen( debugf, "a" );
454 dbf = sys_fopen( debugf, "w" );
455 (void)umask( oldumask );
469 if( syslog_level < lp_syslog() )
471 /* map debug levels to syslog() priorities
472 * note that not all DEBUG(0, ...) calls are
475 static int priority_map[] = {
484 if( syslog_level >= ( sizeof(priority_map) / sizeof(priority_map[0]) )
486 priority = LOG_DEBUG;
488 priority = priority_map[syslog_level];
491 va_start( ap, format_str );
494 format_str = va_arg( ap, char * );
496 vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
500 syslog( priority, "%s", msgbuf );
507 if( !lp_syslog_only() )
511 va_start( ap, format_str );
514 format_str = va_arg( ap, char * );
517 (void)vfprintf( dbf, format_str, ap );
529 /* ************************************************************************** **
530 * Print the buffer content via Debug1(), then reset the buffer.
535 * ************************************************************************** **
537 static void bufr_print( void )
539 format_bufr[format_pos] = '\0';
540 (void)Debug1( "%s", format_bufr );
544 /* ************************************************************************** **
545 * Format the debug message text.
547 * Input: msg - Text to be added to the "current" debug message text.
551 * Notes: The purpose of this is two-fold. First, each call to syslog()
552 * (used by Debug1(), see above) generates a new line of syslog
553 * output. This is fixed by storing the partial lines until the
554 * newline character is encountered. Second, printing the debug
555 * message lines when a newline is encountered allows us to add
556 * spaces, thus indenting the body of the message and making it
559 * ************************************************************************** **
561 static void format_debug_text( char *msg )
564 BOOL timestamp = (!stdout_logging && (lp_timestamp_logs() ||
567 for( i = 0; msg[i]; i++ )
569 /* Indent two spaces at each new line. */
570 if(timestamp && 0 == format_pos)
572 format_bufr[0] = format_bufr[1] = ' ';
576 /* If there's room, copy the character to the format buffer. */
577 if( format_pos < FORMAT_BUFR_MAX )
578 format_bufr[format_pos++] = msg[i];
580 /* If a newline is encountered, print & restart. */
584 /* If the buffer is full dump it out, reset it, and put out a line
585 * continuation indicator.
587 if( format_pos >= FORMAT_BUFR_MAX )
590 (void)Debug1( " +>\n" );
594 /* Just to be safe... */
595 format_bufr[format_pos] = '\0';
596 } /* format_debug_text */
598 /* ************************************************************************** **
599 * Flush debug output, including the format buffer content.
604 * ************************************************************************** **
606 void dbgflush( void )
613 /* ************************************************************************** **
614 * Print a Debug Header.
616 * Input: level - Debug level of the message (not the system-wide debug
618 * file - Pointer to a string containing the name of the file
619 * from which this function was called, or an empty string
620 * if the __FILE__ macro is not implemented.
621 * func - Pointer to a string containing the name of the function
622 * from which this function was called, or an empty string
623 * if the __FUNCTION__ macro is not implemented.
624 * line - line number of the call to dbghdr, assuming __LINE__
627 * Output: Always True. This makes it easy to fudge a call to dbghdr()
628 * in a macro, since the function can be called as part of a test.
629 * Eg: ( (level <= DEBUGLEVEL) && (dbghdr(level,"",line)) )
631 * Notes: This function takes care of setting syslog_level.
633 * ************************************************************************** **
636 BOOL dbghdr( int level, char *file, char *func, int line )
638 /* Ensure we don't lose any real errno value. */
639 int old_errno = errno;
642 /* This is a fudge. If there is stuff sitting in the format_bufr, then
643 * the *right* thing to do is to call
644 * format_debug_text( "\n" );
645 * to write the remainder, and then proceed with the new header.
646 * Unfortunately, there are several places in the code at which
647 * the DEBUG() macro is used to build partial lines. That in mind,
648 * we'll work under the assumption that an incomplete line indicates
649 * that a new header is *not* desired.
655 /* Set syslog_level. */
656 syslog_level = level;
659 /* Don't print a header if we're logging to stdout. */
663 /* Print the header if timestamps are turned on. If parameters are
664 * not yet loaded, then default to timestamps on.
666 if( lp_timestamp_logs() || !(lp_loaded()) ) {
667 char header_str[200];
669 header_str[0] = '\0';
672 slprintf(header_str,sizeof(header_str)-1,", pid=%u",(unsigned int)sys_getpid());
674 if( lp_debug_uid()) {
675 size_t hs_len = strlen(header_str);
676 slprintf(header_str + hs_len,
677 sizeof(header_str) - 1 - hs_len,
678 ", effective(%u, %u), real(%u, %u)",
679 (unsigned int)geteuid(), (unsigned int)getegid(),
680 (unsigned int)getuid(), (unsigned int)getgid());
683 /* Print it all out at once to prevent split syslog output. */
684 (void)Debug1( "[%s, %d%s] %s:%s(%d)\n",
685 timestring(lp_debug_hires_timestamp()), level,
686 header_str, file, func, line );
693 /* ************************************************************************** **
694 * Add text to the body of the "current" debug message via the format buffer.
696 * Input: format_str - Format string, as used in printf(), et. al.
697 * ... - Variable argument list.
699 * ..or.. va_alist - Old style variable parameter list starting point.
701 * Output: Always True. See dbghdr() for more info, though this is not
702 * likely to be used in the same way.
704 * ************************************************************************** **
707 BOOL dbgtext( char *format_str, ... )
712 va_start( ap, format_str );
713 vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
716 format_debug_text( msgbuf );
722 BOOL dbgtext( va_alist )
730 format_str = va_arg( ap, char * );
731 vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
734 format_debug_text( msgbuf );
741 /* ************************************************************************** */