2 Unix SMB/CIFS implementation.
3 Samba utility functions
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Elrond 2002
6 Copyright (C) Simo Sorce 2002
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 /* -------------------------------------------------------------------------- **
28 * FORMAT_BUFR_MAX - Index of the last byte of the format buffer;
29 * format_bufr[FORMAT_BUFR_MAX] should always be reserved
30 * for a terminating null byte.
33 #define FORMAT_BUFR_MAX ( sizeof( format_bufr ) - 1 )
35 /* -------------------------------------------------------------------------- **
36 * This module implements Samba's debugging utility.
38 * The syntax of a debugging log file is represented as:
40 * <debugfile> :== { <debugmsg> }
42 * <debugmsg> :== <debughdr> '\n' <debugtext>
44 * <debughdr> :== '[' TIME ',' LEVEL ']' [ [FILENAME ':'] [FUNCTION '()'] ]
46 * <debugtext> :== { <debugline> }
48 * <debugline> :== TEXT '\n'
50 * TEXT is a string of characters excluding the newline character.
51 * LEVEL is the DEBUG level of the message (an integer in the range 0..10).
52 * TIME is a timestamp.
53 * FILENAME is the name of the file from which the debug message was generated.
54 * FUNCTION is the function from which the debug message was generated.
56 * Basically, what that all means is:
58 * - A debugging log file is made up of debug messages.
60 * - Each debug message is made up of a header and text. The header is
61 * separated from the text by a newline.
63 * - The header begins with the timestamp and debug level of the message
64 * enclosed in brackets. The filename and function from which the
65 * message was generated may follow. The filename is terminated by a
66 * colon, and the function name is terminated by parenthesis.
68 * - The message text is made up of zero or more lines, each terminated by
72 /* -------------------------------------------------------------------------- **
75 * dbf - Global debug file handle.
76 * debugf - Debug file name.
77 * DEBUGLEVEL - System-wide debug message limit. Messages with message-
78 * levels higher than DEBUGLEVEL will not be processed.
83 BOOL debug_warn_unknown_class = True;
84 BOOL debug_auto_add_unknown_class = True;
85 BOOL AllowDebugChange = True;
88 * This is to allow assignment to DEBUGLEVEL before the debug
89 * system has been initialised.
91 static int debug_all_class_hack = 1;
92 static BOOL debug_all_class_isset_hack = True;
94 static int debug_num_classes = 0;
95 int *DEBUGLEVEL_CLASS = &debug_all_class_hack;
96 BOOL *DEBUGLEVEL_CLASS_ISSET = &debug_all_class_isset_hack;
98 /* DEBUGLEVEL is #defined to *debug_level */
99 int DEBUGLEVEL = &debug_all_class_hack;
102 /* -------------------------------------------------------------------------- **
103 * Internal variables.
105 * stdout_logging - Default False, if set to True then dbf will be set to
106 * stdout and debug output will go to dbf only, and not
107 * to syslog. Set in setup_logging() and read in Debug1().
109 * debug_count - Number of debug messages that have been output.
110 * Used to check log size.
112 * syslog_level - Internal copy of the message debug level. Written by
113 * dbghdr() and read by Debug1().
115 * format_bufr - Used to format debug messages. The dbgtext() function
116 * prints debug messages to a string, and then passes the
117 * string to format_debug_text(), which uses format_bufr
118 * to build the formatted output.
120 * format_pos - Marks the first free byte of the format_bufr.
123 * log_overflow - When this variable is True, never attempt to check the
124 * size of the log. This is a hack, so that we can write
125 * a message using DEBUG, from open_logs() when we
126 * are unable to open a new log file for some reason.
129 static BOOL stdout_logging = False;
130 static int debug_count = 0;
132 static int syslog_level = 0;
134 static pstring format_bufr = { '\0' };
135 static size_t format_pos = 0;
136 static BOOL log_overflow = False;
139 * Define all the debug class selection names here. Names *MUST NOT* contain
140 * white space. There must be one name for each DBGC_<class name>, and they
141 * must be in the table in the order of DBGC_<class name>..
143 static const char *default_classname_table[] = {
144 "all", /* DBGC_ALL; index refs traditional DEBUGLEVEL */
145 "tdb", /* DBGC_TDB */
146 "printdrivers", /* DBGC_PRINTDRIVERS */
147 "lanman", /* DBGC_LANMAN */
148 "smb", /* DBGC_SMB */
149 "rpc_parse", /* DBGC_RPC_PARSE */
150 "rpc_srv", /* DBGC_RPC_SRV */
151 "rpc_cli", /* DBGC_RPC_CLI */
152 "passdb", /* DBGC_PASSDB */
153 "sam", /* DBGC_SAM */
154 "auth", /* DBGC_AUTH */
155 "winbind", /* DBGC_WINBIND */
156 "vfs", /* DBGC_VFS */
160 static char **classname_table = NULL;
163 /* -------------------------------------------------------------------------- **
168 /****************************************************************************
169 utility lists registered debug class names's
170 ****************************************************************************/
172 #define MAX_CLASS_NAME_SIZE 1024
174 static char *debug_list_class_names_and_levels(void)
182 if (DEBUGLEVEL_CLASS == &debug_all_class_hack)
185 list = calloc(debug_num_classes + 1, sizeof(char *));
189 /* prepare strings */
190 for (i = 0, dim = 0; i < debug_num_classes; i++) {
191 int l = asprintf(&list[i],
194 DEBUGLEVEL_CLASS_ISSET[i]?DEBUGLEVEL_CLASS[i]:DEBUGLEVEL);
195 if (l < 0 || l > MAX_CLASS_NAME_SIZE) {
202 /* create single string list */
203 b = buf = malloc(dim);
208 for (i = 0; i < debug_num_classes; i++) {
209 int l = strlen(list[i]);
210 strncpy(b, list[i], l);
216 /* free strings list */
217 for (i = 0; i < debug_num_classes; i++)
218 if (list[i]) free(list[i]);
230 /****************************************************************************
231 utility access to debug class names's
232 ****************************************************************************/
233 const char *debug_classname_from_index(int ndx)
235 if (ndx < 0 || ndx >= debug_num_classes)
238 return classname_table[ndx];
241 /****************************************************************************
242 utility to translate names to debug class index's (internal version)
243 ****************************************************************************/
244 static int debug_lookup_classname_int(const char* classname)
248 if (!classname) return -1;
250 for (i=0; i < debug_num_classes; i++) {
251 if (strcmp(classname, classname_table[i])==0)
257 /****************************************************************************
258 Add a new debug class to the system
259 ****************************************************************************/
260 int debug_add_class(const char *classname)
268 /* check the init has yet been called */
271 ndx = debug_lookup_classname_int(classname);
274 ndx = debug_num_classes;
276 new_ptr = DEBUGLEVEL_CLASS;
277 if (DEBUGLEVEL_CLASS == &debug_all_class_hack)
279 /* Initial loading... */
282 new_ptr = Realloc(new_ptr,
283 sizeof(int) * (debug_num_classes + 1));
286 DEBUGLEVEL_CLASS = new_ptr;
287 DEBUGLEVEL_CLASS[ndx] = 0;
289 /* debug_level is the pointer used for the DEBUGLEVEL-thingy */
292 /* Transfer the initial level from debug_all_class_hack */
293 DEBUGLEVEL_CLASS[ndx] = DEBUGLEVEL;
295 debug_level = DEBUGLEVEL_CLASS;
297 new_ptr = DEBUGLEVEL_CLASS_ISSET;
298 if (new_ptr == &debug_all_class_isset_hack)
302 new_ptr = Realloc(new_ptr,
303 sizeof(BOOL) * (debug_num_classes + 1));
306 DEBUGLEVEL_CLASS_ISSET = new_ptr;
307 DEBUGLEVEL_CLASS_ISSET[ndx] = False;
309 new_ptr = Realloc(classname_table,
310 sizeof(char *) * (debug_num_classes + 1));
313 classname_table = new_ptr;
315 classname_table[ndx] = strdup(classname);
316 if (! classname_table[ndx])
324 /****************************************************************************
325 utility to translate names to debug class index's (public version)
326 ****************************************************************************/
327 int debug_lookup_classname(const char *classname)
331 if (!classname || !*classname) return -1;
333 ndx = debug_lookup_classname_int(classname);
338 if (debug_warn_unknown_class)
340 DEBUG(0, ("debug_lookup_classname(%s): Unknown class\n",
343 if (debug_auto_add_unknown_class)
345 return debug_add_class(classname);
351 /****************************************************************************
352 dump the current registered debug levels
353 ****************************************************************************/
354 static void debug_dump_status(int level)
358 DEBUG(level, ("INFO: Current debug levels:\n"));
359 for (q = 0; q < debug_num_classes; q++)
361 DEBUGADD(level, (" %s: %s/%d\n",
363 (DEBUGLEVEL_CLASS_ISSET[q]
365 DEBUGLEVEL_CLASS[q]));
369 /****************************************************************************
370 parse the debug levels from smbcontrol. Example debug level parameter:
372 ****************************************************************************/
373 static BOOL debug_parse_params(char **params)
382 /* Allow DBGC_ALL to be specified w/o requiring its class name e.g."10"
383 * v.s. "all:10", this is the traditional way to set DEBUGLEVEL
385 if (isdigit((int)params[0][0])) {
386 DEBUGLEVEL_CLASS[DBGC_ALL] = atoi(params[0]);
387 DEBUGLEVEL_CLASS_ISSET[DBGC_ALL] = True;
388 i = 1; /* start processing at the next params */
391 i = 0; /* DBGC_ALL not specified OR class name was included */
393 /* Fill in new debug class levels */
394 for (; i < debug_num_classes && params[i]; i++) {
395 if ((class_name=strtok(params[i],":")) &&
396 (class_level=strtok(NULL, "\0")) &&
397 ((ndx = debug_lookup_classname(class_name)) != -1)) {
398 DEBUGLEVEL_CLASS[ndx] = atoi(class_level);
399 DEBUGLEVEL_CLASS_ISSET[ndx] = True;
401 DEBUG(0,("debug_parse_params: unrecognized debug class name or format [%s]\n", params[i]));
409 /****************************************************************************
410 parse the debug levels from smb.conf. Example debug level string:
411 3 tdb:5 printdrivers:7
412 Note: the 1st param has no "name:" preceeding it.
413 ****************************************************************************/
414 BOOL debug_parse_levels(const char *params_str)
421 if (AllowDebugChange == False)
424 params = str_list_make(params_str, NULL);
426 if (debug_parse_params(params))
428 debug_dump_status(5);
429 str_list_free(¶ms);
432 str_list_free(¶ms);
437 /****************************************************************************
438 receive a "set debug level" message
439 ****************************************************************************/
440 static void debug_message(int msg_type, pid_t src, void *buf, size_t len)
442 const char *params_str = buf;
444 /* Check, it's a proper string! */
445 if (params_str[len-1] != '\0')
447 DEBUG(1, ("Invalid debug message from pid %u to pid %u\n",
448 (unsigned int)src, (unsigned int)getpid()));
452 DEBUG(3, ("INFO: Remote set of debug to `%s' (pid %u from pid %u)\n",
453 params_str, (unsigned int)getpid(), (unsigned int)src));
455 debug_parse_levels(params_str);
459 /****************************************************************************
460 send a "set debug level" message
461 ****************************************************************************/
462 void debug_message_send(pid_t pid, const char *params_str)
466 message_send_pid(pid, MSG_DEBUG, params_str, strlen(params_str) + 1,
472 /****************************************************************************
473 Return current debug level.
474 ****************************************************************************/
476 static void debuglevel_message(int msg_type, pid_t src, void *buf, size_t len)
478 char *debug_level_classes;
479 DEBUG(1,("INFO: Received REQ_DEBUGLEVEL message from PID %u\n",(unsigned int)src));
481 if ((debug_level_classes = debug_list_class_names_and_levels())) {
482 /*{ debug_level_classes = "test:1000";*/
483 message_send_pid(src, MSG_DEBUGLEVEL, debug_level_classes, strlen(debug_level_classes) + 1, True);
484 SAFE_FREE(debug_level_classes);
486 DEBUG(0, ("debuglevel_message: error retrieving class levels!\n"));
491 /****************************************************************************
492 Init debugging (one time stuff)
493 ****************************************************************************/
494 void debug_init(void)
496 static BOOL initialised = False;
504 message_register(MSG_DEBUG, debug_message);
505 message_register(MSG_REQ_DEBUGLEVEL, debuglevel_message);
507 for(p = default_classname_table; *p; p++)
514 /* ************************************************************************** **
515 * get ready for syslog stuff
516 * ************************************************************************** **
518 void setup_logging(const char *pname, BOOL interactive)
522 /* reset to allow multiple setup calls, going from interactive to
524 stdout_logging = False;
528 stdout_logging = True;
530 x_setbuf( x_stdout, NULL );
534 const char *p = strrchr_m( pname,'/' );
538 openlog( pname, LOG_PID, SYSLOG_FACILITY );
540 /* for old systems that have no facility codes. */
541 openlog( pname, LOG_PID );
545 } /* setup_logging */
547 /* ************************************************************************** **
548 * reopen the log files
549 * note that we now do this unconditionally
550 * We attempt to open the new debug fp before closing the old. This means
551 * if we run out of fd's we just keep using the old fd rather than aborting.
552 * Fix from dgibson@linuxcare.com.
553 * ************************************************************************** **
556 BOOL reopen_logs( void )
560 XFILE *new_dbf = NULL;
561 XFILE *old_dbf = NULL;
567 oldumask = umask( 022 );
569 pstrcpy(fname, debugf );
574 logfname = lp_logfile();
576 pstrcpy(fname, logfname);
579 pstrcpy( debugf, fname );
580 new_dbf = x_fopen( debugf, O_WRONLY|O_APPEND|O_CREAT, 0644);
584 DEBUG(0, ("Unable to open new log file %s: %s\n", debugf, strerror(errno)));
585 log_overflow = False;
590 x_setbuf(new_dbf, NULL);
594 (void) x_fclose(old_dbf);
597 /* Fix from klausr@ITAP.Physik.Uni-Stuttgart.De
598 * to fix problem where smbd's that generate less
599 * than 100 messages keep growing the log.
601 force_check_log_size();
602 (void)umask(oldumask);
604 /* Take over stderr to catch ouput into logs */
605 if (dbf && sys_dup2(x_fileno(dbf), 2) == -1) {
606 close_low_fds(True); /* Close stderr too, if dup2 can't point it
613 /* ************************************************************************** **
614 * Force a check of the log size.
615 * ************************************************************************** **
617 void force_check_log_size( void )
622 /***************************************************************************
623 Check to see if there is any need to check if the logfile has grown too big.
624 **************************************************************************/
626 BOOL need_to_check_log_size( void )
630 if( debug_count++ < 100 )
633 maxlog = lp_max_log_size() * 1024;
634 if( !dbf || maxlog <= 0 ) {
641 /* ************************************************************************** **
642 * Check to see if the log has grown to be too big.
643 * ************************************************************************** **
646 void check_log_size( void )
652 * We need to be root to check/change log-file, skip this and let the main
653 * loop check do a new check as root.
659 if(log_overflow || !need_to_check_log_size() )
662 maxlog = lp_max_log_size() * 1024;
664 if( sys_fstat( x_fileno( dbf ), &st ) == 0 && st.st_size > maxlog ) {
666 if( dbf && get_file_size( debugf ) > maxlog ) {
669 slprintf( name, sizeof(name)-1, "%s.old", debugf );
670 (void)rename( debugf, name );
672 if (!reopen_logs()) {
673 /* We failed to reopen a log - continue using the old name. */
674 (void)rename(name, debugf);
680 * Here's where we need to panic if dbf == NULL..
684 /* This code should only be reached in very strange
685 * circumstances. If we merely fail to open the new log we
686 * should stick with the old one. ergo this should only be
687 * reached when opening the logs for the first time: at
688 * startup or when the log level is increased from zero.
691 dbf = x_fopen( "/dev/console", O_WRONLY, 0);
693 DEBUG(0,("check_log_size: open of debug file %s failed - using console.\n",
697 * We cannot continue without a debug file handle.
703 } /* check_log_size */
705 /* ************************************************************************** **
706 * Write an debug message on the debugfile.
707 * This is called by dbghdr() and format_debug_text().
708 * ************************************************************************** **
710 int Debug1( const char *format_str, ... )
713 int old_errno = errno;
717 va_start( ap, format_str );
719 (void)x_vfprintf( dbf, format_str, ap );
726 if( !lp_syslog_only() )
731 mode_t oldumask = umask( 022 );
733 dbf = x_fopen( debugf, O_WRONLY|O_APPEND|O_CREAT, 0644 );
734 (void)umask( oldumask );
737 x_setbuf( dbf, NULL );
748 if( syslog_level < lp_syslog() )
750 /* map debug levels to syslog() priorities
751 * note that not all DEBUG(0, ...) calls are
754 static int priority_map[] = {
763 if( syslog_level >= ( sizeof(priority_map) / sizeof(priority_map[0]) )
765 priority = LOG_DEBUG;
767 priority = priority_map[syslog_level];
769 va_start( ap, format_str );
770 vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
774 syslog( priority, "%s", msgbuf );
781 if( !lp_syslog_only() )
784 va_start( ap, format_str );
786 (void)x_vfprintf( dbf, format_str, ap );
789 (void)x_fflush( dbf );
798 /* ************************************************************************** **
799 * Print the buffer content via Debug1(), then reset the buffer.
804 * ************************************************************************** **
806 static void bufr_print( void )
808 format_bufr[format_pos] = '\0';
809 (void)Debug1( "%s", format_bufr );
813 /* ************************************************************************** **
814 * Format the debug message text.
816 * Input: msg - Text to be added to the "current" debug message text.
820 * Notes: The purpose of this is two-fold. First, each call to syslog()
821 * (used by Debug1(), see above) generates a new line of syslog
822 * output. This is fixed by storing the partial lines until the
823 * newline character is encountered. Second, printing the debug
824 * message lines when a newline is encountered allows us to add
825 * spaces, thus indenting the body of the message and making it
828 * ************************************************************************** **
830 static void format_debug_text( char *msg )
833 BOOL timestamp = (!stdout_logging && (lp_timestamp_logs() ||
836 for( i = 0; msg[i]; i++ )
838 /* Indent two spaces at each new line. */
839 if(timestamp && 0 == format_pos)
841 format_bufr[0] = format_bufr[1] = ' ';
845 /* If there's room, copy the character to the format buffer. */
846 if( format_pos < FORMAT_BUFR_MAX )
847 format_bufr[format_pos++] = msg[i];
849 /* If a newline is encountered, print & restart. */
853 /* If the buffer is full dump it out, reset it, and put out a line
854 * continuation indicator.
856 if( format_pos >= FORMAT_BUFR_MAX )
859 (void)Debug1( " +>\n" );
863 /* Just to be safe... */
864 format_bufr[format_pos] = '\0';
865 } /* format_debug_text */
867 /* ************************************************************************** **
868 * Flush debug output, including the format buffer content.
873 * ************************************************************************** **
875 void dbgflush( void )
879 (void)x_fflush( dbf );
882 /* ************************************************************************** **
883 * Print a Debug Header.
885 * Input: level - Debug level of the message (not the system-wide debug
887 * file - Pointer to a string containing the name of the file
888 * from which this function was called, or an empty string
889 * if the __FILE__ macro is not implemented.
890 * func - Pointer to a string containing the name of the function
891 * from which this function was called, or an empty string
892 * if the __FUNCTION__ macro is not implemented.
893 * line - line number of the call to dbghdr, assuming __LINE__
896 * Output: Always True. This makes it easy to fudge a call to dbghdr()
897 * in a macro, since the function can be called as part of a test.
898 * Eg: ( (level <= DEBUGLEVEL) && (dbghdr(level,"",line)) )
900 * Notes: This function takes care of setting syslog_level.
902 * ************************************************************************** **
905 BOOL dbghdr( int level, const char *file, const char *func, int line )
907 /* Ensure we don't lose any real errno value. */
908 int old_errno = errno;
911 /* This is a fudge. If there is stuff sitting in the format_bufr, then
912 * the *right* thing to do is to call
913 * format_debug_text( "\n" );
914 * to write the remainder, and then proceed with the new header.
915 * Unfortunately, there are several places in the code at which
916 * the DEBUG() macro is used to build partial lines. That in mind,
917 * we'll work under the assumption that an incomplete line indicates
918 * that a new header is *not* desired.
924 /* Set syslog_level. */
925 syslog_level = level;
928 /* Don't print a header if we're logging to stdout. */
932 /* Print the header if timestamps are turned on. If parameters are
933 * not yet loaded, then default to timestamps on.
935 if( lp_timestamp_logs() || !(lp_loaded()) ) {
936 char header_str[200];
938 header_str[0] = '\0';
941 slprintf(header_str,sizeof(header_str)-1,", pid=%u",(unsigned int)sys_getpid());
943 if( lp_debug_uid()) {
944 size_t hs_len = strlen(header_str);
945 slprintf(header_str + hs_len,
946 sizeof(header_str) - 1 - hs_len,
947 ", effective(%u, %u), real(%u, %u)",
948 (unsigned int)geteuid(), (unsigned int)getegid(),
949 (unsigned int)getuid(), (unsigned int)getgid());
952 /* Print it all out at once to prevent split syslog output. */
953 (void)Debug1( "[%s, %d%s] %s:%s(%d)\n",
954 timestring(lp_debug_hires_timestamp()), level,
955 header_str, file, func, line );
962 /* ************************************************************************** **
963 * Add text to the body of the "current" debug message via the format buffer.
965 * Input: format_str - Format string, as used in printf(), et. al.
966 * ... - Variable argument list.
968 * ..or.. va_alist - Old style variable parameter list starting point.
970 * Output: Always True. See dbghdr() for more info, though this is not
971 * likely to be used in the same way.
973 * ************************************************************************** **
975 BOOL dbgtext( const char *format_str, ... )
980 va_start( ap, format_str );
981 vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
984 format_debug_text( msgbuf );
990 /* ************************************************************************** */