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 used to check if the user specified a
89 logfile on the command line
91 BOOL override_logfile;
95 * This is to allow assignment to DEBUGLEVEL before the debug
96 * system has been initialised.
98 static int debug_all_class_hack = 1;
99 static BOOL debug_all_class_isset_hack = True;
101 static int debug_num_classes = 0;
102 int *DEBUGLEVEL_CLASS = &debug_all_class_hack;
103 BOOL *DEBUGLEVEL_CLASS_ISSET = &debug_all_class_isset_hack;
105 /* DEBUGLEVEL is #defined to *debug_level */
106 int DEBUGLEVEL = &debug_all_class_hack;
109 /* -------------------------------------------------------------------------- **
110 * Internal variables.
112 * stdout_logging - Default False, if set to True then dbf will be set to
113 * stdout and debug output will go to dbf only, and not
114 * to syslog. Set in setup_logging() and read in Debug1().
116 * debug_count - Number of debug messages that have been output.
117 * Used to check log size.
119 * syslog_level - Internal copy of the message debug level. Written by
120 * dbghdr() and read by Debug1().
122 * format_bufr - Used to format debug messages. The dbgtext() function
123 * prints debug messages to a string, and then passes the
124 * string to format_debug_text(), which uses format_bufr
125 * to build the formatted output.
127 * format_pos - Marks the first free byte of the format_bufr.
130 * log_overflow - When this variable is True, never attempt to check the
131 * size of the log. This is a hack, so that we can write
132 * a message using DEBUG, from open_logs() when we
133 * are unable to open a new log file for some reason.
136 static BOOL stdout_logging = False;
137 static int debug_count = 0;
139 static int syslog_level = 0;
141 static pstring format_bufr = { '\0' };
142 static size_t format_pos = 0;
143 static BOOL log_overflow = False;
146 * Define all the debug class selection names here. Names *MUST NOT* contain
147 * white space. There must be one name for each DBGC_<class name>, and they
148 * must be in the table in the order of DBGC_<class name>..
150 static const char *default_classname_table[] = {
151 "all", /* DBGC_ALL; index refs traditional DEBUGLEVEL */
152 "tdb", /* DBGC_TDB */
153 "printdrivers", /* DBGC_PRINTDRIVERS */
154 "lanman", /* DBGC_LANMAN */
155 "smb", /* DBGC_SMB */
156 "rpc_parse", /* DBGC_RPC_PARSE */
157 "rpc_srv", /* DBGC_RPC_SRV */
158 "rpc_cli", /* DBGC_RPC_CLI */
159 "passdb", /* DBGC_PASSDB */
160 "sam", /* DBGC_SAM */
161 "auth", /* DBGC_AUTH */
162 "winbind", /* DBGC_WINBIND */
163 "vfs", /* DBGC_VFS */
164 "idmap", /* DBGC_IDMAP */
165 "quota", /* DBGC_QUOTA */
166 "acls", /* DBGC_ACLS */
170 static char **classname_table = NULL;
173 /* -------------------------------------------------------------------------- **
178 /****************************************************************************
179 utility lists registered debug class names's
180 ****************************************************************************/
182 #define MAX_CLASS_NAME_SIZE 1024
184 static char *debug_list_class_names_and_levels(void)
192 if (DEBUGLEVEL_CLASS == &debug_all_class_hack)
195 list = calloc(debug_num_classes + 1, sizeof(char *));
199 /* prepare strings */
200 for (i = 0, dim = 0; i < debug_num_classes; i++) {
201 int l = asprintf(&list[i],
204 DEBUGLEVEL_CLASS_ISSET[i]?DEBUGLEVEL_CLASS[i]:DEBUGLEVEL);
205 if (l < 0 || l > MAX_CLASS_NAME_SIZE) {
212 /* create single string list - add space for newline */
213 b = buf = malloc(dim+1);
218 for (i = 0; i < debug_num_classes; i++) {
219 int l = strlen(list[i]);
220 strncpy(b, list[i], l);
223 b[-1] = '\n'; /* replace last space with newline */
224 b[0] = '\0'; /* null terminate string */
227 /* free strings list */
228 for (i = 0; i < debug_num_classes; i++)
229 if (list[i]) free(list[i]);
241 /****************************************************************************
242 Utility access to debug class names's.
243 ****************************************************************************/
245 const char *debug_classname_from_index(int ndx)
247 if (ndx < 0 || ndx >= debug_num_classes)
250 return classname_table[ndx];
253 /****************************************************************************
254 Utility to translate names to debug class index's (internal version).
255 ****************************************************************************/
257 static int debug_lookup_classname_int(const char* classname)
261 if (!classname) return -1;
263 for (i=0; i < debug_num_classes; i++) {
264 if (strcmp(classname, classname_table[i])==0)
270 /****************************************************************************
271 Add a new debug class to the system.
272 ****************************************************************************/
274 int debug_add_class(const char *classname)
282 /* check the init has yet been called */
285 ndx = debug_lookup_classname_int(classname);
288 ndx = debug_num_classes;
290 new_ptr = DEBUGLEVEL_CLASS;
291 if (DEBUGLEVEL_CLASS == &debug_all_class_hack) {
292 /* Initial loading... */
295 new_ptr = Realloc(new_ptr, sizeof(int) * (debug_num_classes + 1));
298 DEBUGLEVEL_CLASS = new_ptr;
299 DEBUGLEVEL_CLASS[ndx] = 0;
301 /* debug_level is the pointer used for the DEBUGLEVEL-thingy */
303 /* Transfer the initial level from debug_all_class_hack */
304 DEBUGLEVEL_CLASS[ndx] = DEBUGLEVEL;
306 debug_level = DEBUGLEVEL_CLASS;
308 new_ptr = DEBUGLEVEL_CLASS_ISSET;
309 if (new_ptr == &debug_all_class_isset_hack) {
312 new_ptr = Realloc(new_ptr, sizeof(BOOL) * (debug_num_classes + 1));
315 DEBUGLEVEL_CLASS_ISSET = new_ptr;
316 DEBUGLEVEL_CLASS_ISSET[ndx] = False;
318 new_ptr = Realloc(classname_table,
319 sizeof(char *) * (debug_num_classes + 1));
322 classname_table = new_ptr;
324 classname_table[ndx] = strdup(classname);
325 if (! classname_table[ndx])
333 /****************************************************************************
334 Utility to translate names to debug class index's (public version).
335 ****************************************************************************/
337 int debug_lookup_classname(const char *classname)
341 if (!classname || !*classname)
344 ndx = debug_lookup_classname_int(classname);
349 if (debug_warn_unknown_class) {
350 DEBUG(0, ("debug_lookup_classname(%s): Unknown class\n",
353 if (debug_auto_add_unknown_class) {
354 return debug_add_class(classname);
359 /****************************************************************************
360 Dump the current registered debug levels.
361 ****************************************************************************/
363 static void debug_dump_status(int level)
367 DEBUG(level, ("INFO: Current debug levels:\n"));
368 for (q = 0; q < debug_num_classes; q++) {
369 DEBUGADD(level, (" %s: %s/%d\n",
371 (DEBUGLEVEL_CLASS_ISSET[q]
373 DEBUGLEVEL_CLASS[q]));
377 /****************************************************************************
378 parse the debug levels from smbcontrol. Example debug level parameter:
380 ****************************************************************************/
382 static BOOL debug_parse_params(char **params)
391 /* Allow DBGC_ALL to be specified w/o requiring its class name e.g."10"
392 * v.s. "all:10", this is the traditional way to set DEBUGLEVEL
394 if (isdigit((int)params[0][0])) {
395 DEBUGLEVEL_CLASS[DBGC_ALL] = atoi(params[0]);
396 DEBUGLEVEL_CLASS_ISSET[DBGC_ALL] = True;
397 i = 1; /* start processing at the next params */
399 i = 0; /* DBGC_ALL not specified OR class name was included */
402 /* Fill in new debug class levels */
403 for (; i < debug_num_classes && params[i]; i++) {
404 if ((class_name=strtok(params[i],":")) &&
405 (class_level=strtok(NULL, "\0")) &&
406 ((ndx = debug_lookup_classname(class_name)) != -1)) {
407 DEBUGLEVEL_CLASS[ndx] = atoi(class_level);
408 DEBUGLEVEL_CLASS_ISSET[ndx] = True;
410 DEBUG(0,("debug_parse_params: unrecognized debug class name or format [%s]\n", params[i]));
418 /****************************************************************************
419 Parse the debug levels from smb.conf. Example debug level string:
420 3 tdb:5 printdrivers:7
421 Note: the 1st param has no "name:" preceeding it.
422 ****************************************************************************/
424 BOOL debug_parse_levels(const char *params_str)
431 if (AllowDebugChange == False)
434 params = str_list_make(params_str, NULL);
436 if (debug_parse_params(params)) {
437 debug_dump_status(5);
438 str_list_free(¶ms);
441 str_list_free(¶ms);
446 /****************************************************************************
447 Receive a "set debug level" message.
448 ****************************************************************************/
450 static void debug_message(int msg_type, pid_t src, void *buf, size_t len)
452 const char *params_str = buf;
454 /* Check, it's a proper string! */
455 if (params_str[len-1] != '\0') {
456 DEBUG(1, ("Invalid debug message from pid %u to pid %u\n",
457 (unsigned int)src, (unsigned int)getpid()));
461 DEBUG(3, ("INFO: Remote set of debug to `%s' (pid %u from pid %u)\n",
462 params_str, (unsigned int)getpid(), (unsigned int)src));
464 debug_parse_levels(params_str);
467 /****************************************************************************
468 Send a "set debug level" message.
469 ****************************************************************************/
471 void debug_message_send(pid_t pid, const char *params_str)
475 message_send_pid(pid, MSG_DEBUG, params_str, strlen(params_str) + 1,
479 /****************************************************************************
480 Return current debug level.
481 ****************************************************************************/
483 static void debuglevel_message(int msg_type, pid_t src, void *buf, size_t len)
485 char *message = debug_list_class_names_and_levels();
487 DEBUG(1,("INFO: Received REQ_DEBUGLEVEL message from PID %u\n",(unsigned int)src));
488 message_send_pid(src, MSG_DEBUGLEVEL, message, strlen(message) + 1, True);
493 /****************************************************************************
494 Init debugging (one time stuff)
495 ****************************************************************************/
497 void debug_init(void)
499 static BOOL initialised = False;
507 message_register(MSG_DEBUG, debug_message);
508 message_register(MSG_REQ_DEBUGLEVEL, debuglevel_message);
510 for(p = default_classname_table; *p; p++) {
515 /***************************************************************************
516 Get ready for syslog stuff
517 **************************************************************************/
519 void setup_logging(const char *pname, BOOL interactive)
523 /* reset to allow multiple setup calls, going from interactive to
525 stdout_logging = False;
528 (void) x_fclose(dbf);
534 stdout_logging = True;
536 x_setbuf( x_stdout, NULL );
540 const char *p = strrchr_m( pname,'/' );
544 openlog( pname, LOG_PID, SYSLOG_FACILITY );
546 /* for old systems that have no facility codes. */
547 openlog( pname, LOG_PID );
553 /**************************************************************************
555 note that we now do this unconditionally
556 We attempt to open the new debug fp before closing the old. This means
557 if we run out of fd's we just keep using the old fd rather than aborting.
558 Fix from dgibson@linuxcare.com.
559 **************************************************************************/
561 BOOL reopen_logs( void )
565 XFILE *new_dbf = NULL;
566 XFILE *old_dbf = NULL;
572 oldumask = umask( 022 );
574 pstrcpy(fname, debugf );
580 logfname = lp_logfile();
582 pstrcpy(fname, logfname);
585 pstrcpy( debugf, fname );
586 new_dbf = x_fopen( debugf, O_WRONLY|O_APPEND|O_CREAT, 0644);
590 DEBUG(0, ("Unable to open new log file %s: %s\n", debugf, strerror(errno)));
591 log_overflow = False;
596 x_setbuf(new_dbf, NULL);
600 (void) x_fclose(old_dbf);
603 /* Fix from klausr@ITAP.Physik.Uni-Stuttgart.De
604 * to fix problem where smbd's that generate less
605 * than 100 messages keep growing the log.
607 force_check_log_size();
608 (void)umask(oldumask);
610 /* Take over stderr to catch ouput into logs */
611 if (dbf && sys_dup2(x_fileno(dbf), 2) == -1) {
612 close_low_fds(True); /* Close stderr too, if dup2 can't point it
619 /**************************************************************************
620 Force a check of the log size.
621 ***************************************************************************/
623 void force_check_log_size( void )
628 /***************************************************************************
629 Check to see if there is any need to check if the logfile has grown too big.
630 **************************************************************************/
632 BOOL need_to_check_log_size( void )
636 if( debug_count < 100 )
639 maxlog = lp_max_log_size() * 1024;
640 if( !dbf || maxlog <= 0 ) {
647 /**************************************************************************
648 Check to see if the log has grown to be too big.
649 **************************************************************************/
651 void check_log_size( void )
657 * We need to be root to check/change log-file, skip this and let the main
658 * loop check do a new check as root.
664 if(log_overflow || !need_to_check_log_size() )
667 maxlog = lp_max_log_size() * 1024;
669 if( sys_fstat( x_fileno( dbf ), &st ) == 0 && st.st_size > maxlog ) {
671 if( dbf && get_file_size( debugf ) > maxlog ) {
674 slprintf( name, sizeof(name)-1, "%s.old", debugf );
675 (void)rename( debugf, name );
677 if (!reopen_logs()) {
678 /* We failed to reopen a log - continue using the old name. */
679 (void)rename(name, debugf);
685 * Here's where we need to panic if dbf == NULL..
689 /* This code should only be reached in very strange
690 * circumstances. If we merely fail to open the new log we
691 * should stick with the old one. ergo this should only be
692 * reached when opening the logs for the first time: at
693 * startup or when the log level is increased from zero.
696 dbf = x_fopen( "/dev/console", O_WRONLY, 0);
698 DEBUG(0,("check_log_size: open of debug file %s failed - using console.\n",
702 * We cannot continue without a debug file handle.
710 /*************************************************************************
711 Write an debug message on the debugfile.
712 This is called by dbghdr() and format_debug_text().
713 ************************************************************************/
715 int Debug1( const char *format_str, ... )
718 int old_errno = errno;
722 if( stdout_logging ) {
723 va_start( ap, format_str );
725 (void)x_vfprintf( dbf, format_str, ap );
731 /* prevent recursion by checking if reopen_logs() has temporaily
732 set the debugf string to "" */
733 if( debugf[0] == '\0')
737 if( !lp_syslog_only() )
741 mode_t oldumask = umask( 022 );
743 dbf = x_fopen( debugf, O_WRONLY|O_APPEND|O_CREAT, 0644 );
744 (void)umask( oldumask );
746 x_setbuf( dbf, NULL );
755 if( syslog_level < lp_syslog() ) {
756 /* map debug levels to syslog() priorities
757 * note that not all DEBUG(0, ...) calls are
758 * necessarily errors */
759 static int priority_map[] = {
768 if( syslog_level >= ( sizeof(priority_map) / sizeof(priority_map[0]) ) || syslog_level < 0)
769 priority = LOG_DEBUG;
771 priority = priority_map[syslog_level];
773 va_start( ap, format_str );
774 vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
778 syslog( priority, "%s", msgbuf );
785 if( !lp_syslog_only() )
788 va_start( ap, format_str );
790 (void)x_vfprintf( dbf, format_str, ap );
793 (void)x_fflush( dbf );
802 /**************************************************************************
803 Print the buffer content via Debug1(), then reset the buffer.
806 ****************************************************************************/
808 static void bufr_print( void )
810 format_bufr[format_pos] = '\0';
811 (void)Debug1( "%s", format_bufr );
815 /***************************************************************************
816 Format the debug message text.
818 Input: msg - Text to be added to the "current" debug message text.
822 Notes: The purpose of this is two-fold. First, each call to syslog()
823 (used by Debug1(), see above) generates a new line of syslog
824 output. This is fixed by storing the partial lines until the
825 newline character is encountered. Second, printing the debug
826 message lines when a newline is encountered allows us to add
827 spaces, thus indenting the body of the message and making it
829 **************************************************************************/
831 static void format_debug_text( const char *msg )
834 BOOL timestamp = (!stdout_logging && (lp_timestamp_logs() || !(lp_loaded())));
836 for( i = 0; msg[i]; i++ ) {
837 /* Indent two spaces at each new line. */
838 if(timestamp && 0 == format_pos) {
839 format_bufr[0] = format_bufr[1] = ' ';
843 /* If there's room, copy the character to the format buffer. */
844 if( format_pos < FORMAT_BUFR_MAX )
845 format_bufr[format_pos++] = msg[i];
847 /* If a newline is encountered, print & restart. */
851 /* If the buffer is full dump it out, reset it, and put out a line
852 * continuation indicator.
854 if( format_pos >= FORMAT_BUFR_MAX ) {
856 (void)Debug1( " +>\n" );
860 /* Just to be safe... */
861 format_bufr[format_pos] = '\0';
864 /***************************************************************************
865 Flush debug output, including the format buffer content.
869 ***************************************************************************/
871 void dbgflush( void )
875 (void)x_fflush( dbf );
878 /***************************************************************************
879 Print a Debug Header.
881 Input: level - Debug level of the message (not the system-wide debug
883 file - Pointer to a string containing the name of the file
884 from which this function was called, or an empty string
885 if the __FILE__ macro is not implemented.
886 func - Pointer to a string containing the name of the function
887 from which this function was called, or an empty string
888 if the __FUNCTION__ macro is not implemented.
889 line - line number of the call to dbghdr, assuming __LINE__
892 Output: Always True. This makes it easy to fudge a call to dbghdr()
893 in a macro, since the function can be called as part of a test.
894 Eg: ( (level <= DEBUGLEVEL) && (dbghdr(level,"",line)) )
896 Notes: This function takes care of setting syslog_level.
898 ****************************************************************************/
900 BOOL dbghdr( int level, const char *file, const char *func, int line )
902 /* Ensure we don't lose any real errno value. */
903 int old_errno = errno;
906 /* This is a fudge. If there is stuff sitting in the format_bufr, then
907 * the *right* thing to do is to call
908 * format_debug_text( "\n" );
909 * to write the remainder, and then proceed with the new header.
910 * Unfortunately, there are several places in the code at which
911 * the DEBUG() macro is used to build partial lines. That in mind,
912 * we'll work under the assumption that an incomplete line indicates
913 * that a new header is *not* desired.
919 /* Set syslog_level. */
920 syslog_level = level;
923 /* Don't print a header if we're logging to stdout. */
927 /* Print the header if timestamps are turned on. If parameters are
928 * not yet loaded, then default to timestamps on.
930 if( lp_timestamp_logs() || !(lp_loaded()) ) {
931 char header_str[200];
933 header_str[0] = '\0';
936 slprintf(header_str,sizeof(header_str)-1,", pid=%u",(unsigned int)sys_getpid());
938 if( lp_debug_uid()) {
939 size_t hs_len = strlen(header_str);
940 slprintf(header_str + hs_len,
941 sizeof(header_str) - 1 - hs_len,
942 ", effective(%u, %u), real(%u, %u)",
943 (unsigned int)geteuid(), (unsigned int)getegid(),
944 (unsigned int)getuid(), (unsigned int)getgid());
947 /* Print it all out at once to prevent split syslog output. */
948 (void)Debug1( "[%s, %d%s] %s:%s(%d)\n",
949 timestring(lp_debug_hires_timestamp()), level,
950 header_str, file, func, line );
957 /***************************************************************************
958 Add text to the body of the "current" debug message via the format buffer.
960 Input: format_str - Format string, as used in printf(), et. al.
961 ... - Variable argument list.
963 ..or.. va_alist - Old style variable parameter list starting point.
965 Output: Always True. See dbghdr() for more info, though this is not
966 likely to be used in the same way.
968 ***************************************************************************/
970 BOOL dbgtext( const char *format_str, ... )
975 va_start( ap, format_str );
976 vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
979 format_debug_text( msgbuf );