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 */
167 "locking", /* DBGC_LOCKING */
168 "msdfs", /* DBGC_MSDFS */
172 static char **classname_table
= NULL
;
175 /* -------------------------------------------------------------------------- **
180 /****************************************************************************
181 utility lists registered debug class names's
182 ****************************************************************************/
184 #define MAX_CLASS_NAME_SIZE 1024
186 static char *debug_list_class_names_and_levels(void)
194 if (DEBUGLEVEL_CLASS
== &debug_all_class_hack
)
197 list
= SMB_CALLOC_ARRAY(char *, debug_num_classes
+ 1);
201 /* prepare strings */
202 for (i
= 0, dim
= 0; i
< debug_num_classes
; i
++) {
203 int l
= asprintf(&list
[i
],
206 DEBUGLEVEL_CLASS_ISSET
[i
]?DEBUGLEVEL_CLASS
[i
]:DEBUGLEVEL
);
207 if (l
< 0 || l
> MAX_CLASS_NAME_SIZE
) {
214 /* create single string list - add space for newline */
215 b
= buf
= SMB_MALLOC(dim
+1);
220 for (i
= 0; i
< debug_num_classes
; i
++) {
221 int l
= strlen(list
[i
]);
222 strncpy(b
, list
[i
], l
);
225 b
[-1] = '\n'; /* replace last space with newline */
226 b
[0] = '\0'; /* null terminate string */
229 /* free strings list */
230 for (i
= 0; i
< debug_num_classes
; i
++)
231 if (list
[i
]) free(list
[i
]);
243 /****************************************************************************
244 Utility access to debug class names's.
245 ****************************************************************************/
247 const char *debug_classname_from_index(int ndx
)
249 if (ndx
< 0 || ndx
>= debug_num_classes
)
252 return classname_table
[ndx
];
255 /****************************************************************************
256 Utility to translate names to debug class index's (internal version).
257 ****************************************************************************/
259 static int debug_lookup_classname_int(const char* classname
)
263 if (!classname
) return -1;
265 for (i
=0; i
< debug_num_classes
; i
++) {
266 if (strcmp(classname
, classname_table
[i
])==0)
272 /****************************************************************************
273 Add a new debug class to the system.
274 ****************************************************************************/
276 int debug_add_class(const char *classname
)
284 /* check the init has yet been called */
287 ndx
= debug_lookup_classname_int(classname
);
290 ndx
= debug_num_classes
;
292 new_ptr
= DEBUGLEVEL_CLASS
;
293 if (DEBUGLEVEL_CLASS
== &debug_all_class_hack
) {
294 /* Initial loading... */
297 new_ptr
= SMB_REALLOC_ARRAY(new_ptr
, int, debug_num_classes
+ 1);
300 DEBUGLEVEL_CLASS
= new_ptr
;
301 DEBUGLEVEL_CLASS
[ndx
] = 0;
303 /* debug_level is the pointer used for the DEBUGLEVEL-thingy */
305 /* Transfer the initial level from debug_all_class_hack */
306 DEBUGLEVEL_CLASS
[ndx
] = DEBUGLEVEL
;
308 debug_level
= DEBUGLEVEL_CLASS
;
310 new_ptr
= DEBUGLEVEL_CLASS_ISSET
;
311 if (new_ptr
== &debug_all_class_isset_hack
) {
314 new_ptr
= SMB_REALLOC_ARRAY(new_ptr
, BOOL
, debug_num_classes
+ 1);
317 DEBUGLEVEL_CLASS_ISSET
= new_ptr
;
318 DEBUGLEVEL_CLASS_ISSET
[ndx
] = False
;
320 new_ptr
= SMB_REALLOC_ARRAY(classname_table
, char *, debug_num_classes
+ 1);
323 classname_table
= new_ptr
;
325 classname_table
[ndx
] = SMB_STRDUP(classname
);
326 if (! classname_table
[ndx
])
334 /****************************************************************************
335 Utility to translate names to debug class index's (public version).
336 ****************************************************************************/
338 int debug_lookup_classname(const char *classname
)
342 if (!classname
|| !*classname
)
345 ndx
= debug_lookup_classname_int(classname
);
350 if (debug_warn_unknown_class
) {
351 DEBUG(0, ("debug_lookup_classname(%s): Unknown class\n",
354 if (debug_auto_add_unknown_class
) {
355 return debug_add_class(classname
);
360 /****************************************************************************
361 Dump the current registered debug levels.
362 ****************************************************************************/
364 static void debug_dump_status(int level
)
368 DEBUG(level
, ("INFO: Current debug levels:\n"));
369 for (q
= 0; q
< debug_num_classes
; q
++) {
370 DEBUGADD(level
, (" %s: %s/%d\n",
372 (DEBUGLEVEL_CLASS_ISSET
[q
]
374 DEBUGLEVEL_CLASS
[q
]));
378 /****************************************************************************
379 parse the debug levels from smbcontrol. Example debug level parameter:
381 ****************************************************************************/
383 static BOOL
debug_parse_params(char **params
)
392 /* Allow DBGC_ALL to be specified w/o requiring its class name e.g."10"
393 * v.s. "all:10", this is the traditional way to set DEBUGLEVEL
395 if (isdigit((int)params
[0][0])) {
396 DEBUGLEVEL_CLASS
[DBGC_ALL
] = atoi(params
[0]);
397 DEBUGLEVEL_CLASS_ISSET
[DBGC_ALL
] = True
;
398 i
= 1; /* start processing at the next params */
400 i
= 0; /* DBGC_ALL not specified OR class name was included */
403 /* Fill in new debug class levels */
404 for (; i
< debug_num_classes
&& params
[i
]; i
++) {
405 if ((class_name
=strtok(params
[i
],":")) &&
406 (class_level
=strtok(NULL
, "\0")) &&
407 ((ndx
= debug_lookup_classname(class_name
)) != -1)) {
408 DEBUGLEVEL_CLASS
[ndx
] = atoi(class_level
);
409 DEBUGLEVEL_CLASS_ISSET
[ndx
] = True
;
411 DEBUG(0,("debug_parse_params: unrecognized debug class name or format [%s]\n", params
[i
]));
419 /****************************************************************************
420 Parse the debug levels from smb.conf. Example debug level string:
421 3 tdb:5 printdrivers:7
422 Note: the 1st param has no "name:" preceeding it.
423 ****************************************************************************/
425 BOOL
debug_parse_levels(const char *params_str
)
432 if (AllowDebugChange
== False
)
435 params
= str_list_make(params_str
, NULL
);
437 if (debug_parse_params(params
)) {
438 debug_dump_status(5);
439 str_list_free(¶ms
);
442 str_list_free(¶ms
);
447 /****************************************************************************
448 Receive a "set debug level" message.
449 ****************************************************************************/
451 static void debug_message(int msg_type
, struct process_id src
,
452 void *buf
, size_t len
)
454 const char *params_str
= buf
;
456 /* Check, it's a proper string! */
457 if (params_str
[len
-1] != '\0') {
458 DEBUG(1, ("Invalid debug message from pid %u to pid %u\n",
459 (unsigned int)procid_to_pid(&src
),
460 (unsigned int)getpid()));
464 DEBUG(3, ("INFO: Remote set of debug to `%s' (pid %u from pid %u)\n",
465 params_str
, (unsigned int)getpid(),
466 (unsigned int)procid_to_pid(&src
)));
468 debug_parse_levels(params_str
);
471 /****************************************************************************
472 Send a "set debug level" message.
473 ****************************************************************************/
475 void debug_message_send(pid_t pid
, const char *params_str
)
479 message_send_pid(pid_to_procid(pid
), MSG_DEBUG
,
480 params_str
, strlen(params_str
) + 1,
484 /****************************************************************************
485 Return current debug level.
486 ****************************************************************************/
488 static void debuglevel_message(int msg_type
, struct process_id src
,
489 void *buf
, size_t len
)
491 char *message
= debug_list_class_names_and_levels();
493 DEBUG(1,("INFO: Received REQ_DEBUGLEVEL message from PID %u\n",
494 (unsigned int)procid_to_pid(&src
)));
495 message_send_pid(src
, MSG_DEBUGLEVEL
, message
, strlen(message
) + 1, True
);
500 /****************************************************************************
501 Init debugging (one time stuff)
502 ****************************************************************************/
504 void debug_init(void)
506 static BOOL initialised
= False
;
514 message_register(MSG_DEBUG
, debug_message
);
515 message_register(MSG_REQ_DEBUGLEVEL
, debuglevel_message
);
517 for(p
= default_classname_table
; *p
; p
++) {
522 /***************************************************************************
523 Get ready for syslog stuff
524 **************************************************************************/
526 void setup_logging(const char *pname
, BOOL interactive
)
530 /* reset to allow multiple setup calls, going from interactive to
532 stdout_logging
= False
;
535 (void) x_fclose(dbf
);
541 stdout_logging
= True
;
543 x_setbuf( x_stdout
, NULL
);
547 const char *p
= strrchr_m( pname
,'/' );
551 openlog( pname
, LOG_PID
, SYSLOG_FACILITY
);
553 /* for old systems that have no facility codes. */
554 openlog( pname
, LOG_PID
);
560 /**************************************************************************
562 note that we now do this unconditionally
563 We attempt to open the new debug fp before closing the old. This means
564 if we run out of fd's we just keep using the old fd rather than aborting.
565 Fix from dgibson@linuxcare.com.
566 **************************************************************************/
568 BOOL
reopen_logs( void )
572 XFILE
*new_dbf
= NULL
;
573 XFILE
*old_dbf
= NULL
;
579 oldumask
= umask( 022 );
581 pstrcpy(fname
, debugf
);
587 logfname
= lp_logfile();
589 pstrcpy(fname
, logfname
);
592 pstrcpy( debugf
, fname
);
593 new_dbf
= x_fopen( debugf
, O_WRONLY
|O_APPEND
|O_CREAT
, 0644);
597 DEBUG(0, ("Unable to open new log file %s: %s\n", debugf
, strerror(errno
)));
598 log_overflow
= False
;
603 x_setbuf(new_dbf
, NULL
);
607 (void) x_fclose(old_dbf
);
610 /* Fix from klausr@ITAP.Physik.Uni-Stuttgart.De
611 * to fix problem where smbd's that generate less
612 * than 100 messages keep growing the log.
614 force_check_log_size();
615 (void)umask(oldumask
);
617 /* Take over stderr to catch ouput into logs */
618 if (dbf
&& sys_dup2(x_fileno(dbf
), 2) == -1) {
619 close_low_fds(True
); /* Close stderr too, if dup2 can't point it
626 /**************************************************************************
627 Force a check of the log size.
628 ***************************************************************************/
630 void force_check_log_size( void )
635 /***************************************************************************
636 Check to see if there is any need to check if the logfile has grown too big.
637 **************************************************************************/
639 BOOL
need_to_check_log_size( void )
643 if( debug_count
< 100 )
646 maxlog
= lp_max_log_size() * 1024;
647 if( !dbf
|| maxlog
<= 0 ) {
654 /**************************************************************************
655 Check to see if the log has grown to be too big.
656 **************************************************************************/
658 void check_log_size( void )
664 * We need to be root to check/change log-file, skip this and let the main
665 * loop check do a new check as root.
671 if(log_overflow
|| !need_to_check_log_size() )
674 maxlog
= lp_max_log_size() * 1024;
676 if( sys_fstat( x_fileno( dbf
), &st
) == 0 && st
.st_size
> maxlog
) {
678 if( dbf
&& get_file_size( debugf
) > maxlog
) {
681 slprintf( name
, sizeof(name
)-1, "%s.old", debugf
);
682 (void)rename( debugf
, name
);
684 if (!reopen_logs()) {
685 /* We failed to reopen a log - continue using the old name. */
686 (void)rename(name
, debugf
);
692 * Here's where we need to panic if dbf == NULL..
696 /* This code should only be reached in very strange
697 * circumstances. If we merely fail to open the new log we
698 * should stick with the old one. ergo this should only be
699 * reached when opening the logs for the first time: at
700 * startup or when the log level is increased from zero.
703 dbf
= x_fopen( "/dev/console", O_WRONLY
, 0);
705 DEBUG(0,("check_log_size: open of debug file %s failed - using console.\n",
709 * We cannot continue without a debug file handle.
717 /*************************************************************************
718 Write an debug message on the debugfile.
719 This is called by dbghdr() and format_debug_text().
720 ************************************************************************/
722 int Debug1( const char *format_str
, ... )
725 int old_errno
= errno
;
729 if( stdout_logging
) {
730 va_start( ap
, format_str
);
732 (void)x_vfprintf( dbf
, format_str
, ap
);
738 /* prevent recursion by checking if reopen_logs() has temporaily
739 set the debugf string to "" */
740 if( debugf
[0] == '\0')
744 if( !lp_syslog_only() )
748 mode_t oldumask
= umask( 022 );
750 dbf
= x_fopen( debugf
, O_WRONLY
|O_APPEND
|O_CREAT
, 0644 );
751 (void)umask( oldumask
);
753 x_setbuf( dbf
, NULL
);
762 if( syslog_level
< lp_syslog() ) {
763 /* map debug levels to syslog() priorities
764 * note that not all DEBUG(0, ...) calls are
765 * necessarily errors */
766 static int priority_map
[] = {
775 if( syslog_level
>= ( sizeof(priority_map
) / sizeof(priority_map
[0]) ) || syslog_level
< 0)
776 priority
= LOG_DEBUG
;
778 priority
= priority_map
[syslog_level
];
780 va_start( ap
, format_str
);
781 vslprintf( msgbuf
, sizeof(msgbuf
)-1, format_str
, ap
);
785 syslog( priority
, "%s", msgbuf
);
792 if( !lp_syslog_only() )
795 va_start( ap
, format_str
);
797 (void)x_vfprintf( dbf
, format_str
, ap
);
800 (void)x_fflush( dbf
);
809 /**************************************************************************
810 Print the buffer content via Debug1(), then reset the buffer.
813 ****************************************************************************/
815 static void bufr_print( void )
817 format_bufr
[format_pos
] = '\0';
818 (void)Debug1( "%s", format_bufr
);
822 /***************************************************************************
823 Format the debug message text.
825 Input: msg - Text to be added to the "current" debug message text.
829 Notes: The purpose of this is two-fold. First, each call to syslog()
830 (used by Debug1(), see above) generates a new line of syslog
831 output. This is fixed by storing the partial lines until the
832 newline character is encountered. Second, printing the debug
833 message lines when a newline is encountered allows us to add
834 spaces, thus indenting the body of the message and making it
836 **************************************************************************/
838 static void format_debug_text( const char *msg
)
841 BOOL timestamp
= (!stdout_logging
&& (lp_timestamp_logs() || !(lp_loaded())));
843 for( i
= 0; msg
[i
]; i
++ ) {
844 /* Indent two spaces at each new line. */
845 if(timestamp
&& 0 == format_pos
) {
846 format_bufr
[0] = format_bufr
[1] = ' ';
850 /* If there's room, copy the character to the format buffer. */
851 if( format_pos
< FORMAT_BUFR_MAX
)
852 format_bufr
[format_pos
++] = msg
[i
];
854 /* If a newline is encountered, print & restart. */
858 /* If the buffer is full dump it out, reset it, and put out a line
859 * continuation indicator.
861 if( format_pos
>= FORMAT_BUFR_MAX
) {
863 (void)Debug1( " +>\n" );
867 /* Just to be safe... */
868 format_bufr
[format_pos
] = '\0';
871 /***************************************************************************
872 Flush debug output, including the format buffer content.
876 ***************************************************************************/
878 void dbgflush( void )
882 (void)x_fflush( dbf
);
885 /***************************************************************************
886 Print a Debug Header.
888 Input: level - Debug level of the message (not the system-wide debug
890 file - Pointer to a string containing the name of the file
891 from which this function was called, or an empty string
892 if the __FILE__ macro is not implemented.
893 func - Pointer to a string containing the name of the function
894 from which this function was called, or an empty string
895 if the __FUNCTION__ macro is not implemented.
896 line - line number of the call to dbghdr, assuming __LINE__
899 Output: Always True. This makes it easy to fudge a call to dbghdr()
900 in a macro, since the function can be called as part of a test.
901 Eg: ( (level <= DEBUGLEVEL) && (dbghdr(level,"",line)) )
903 Notes: This function takes care of setting syslog_level.
905 ****************************************************************************/
907 BOOL
dbghdr( int level
, const char *file
, const char *func
, int line
)
909 /* Ensure we don't lose any real errno value. */
910 int old_errno
= errno
;
913 /* This is a fudge. If there is stuff sitting in the format_bufr, then
914 * the *right* thing to do is to call
915 * format_debug_text( "\n" );
916 * to write the remainder, and then proceed with the new header.
917 * Unfortunately, there are several places in the code at which
918 * the DEBUG() macro is used to build partial lines. That in mind,
919 * we'll work under the assumption that an incomplete line indicates
920 * that a new header is *not* desired.
926 /* Set syslog_level. */
927 syslog_level
= level
;
930 /* Don't print a header if we're logging to stdout. */
934 /* Print the header if timestamps are turned on. If parameters are
935 * not yet loaded, then default to timestamps on.
937 if( lp_timestamp_logs() || !(lp_loaded()) ) {
938 char header_str
[200];
940 header_str
[0] = '\0';
943 slprintf(header_str
,sizeof(header_str
)-1,", pid=%u",(unsigned int)sys_getpid());
945 if( lp_debug_uid()) {
946 size_t hs_len
= strlen(header_str
);
947 slprintf(header_str
+ hs_len
,
948 sizeof(header_str
) - 1 - hs_len
,
949 ", effective(%u, %u), real(%u, %u)",
950 (unsigned int)geteuid(), (unsigned int)getegid(),
951 (unsigned int)getuid(), (unsigned int)getgid());
954 /* Print it all out at once to prevent split syslog output. */
955 (void)Debug1( "[%s, %d%s] %s:%s(%d)\n",
956 timestring(lp_debug_hires_timestamp()), level
,
957 header_str
, file
, func
, line
);
964 /***************************************************************************
965 Add text to the body of the "current" debug message via the format buffer.
967 Input: format_str - Format string, as used in printf(), et. al.
968 ... - Variable argument list.
970 ..or.. va_alist - Old style variable parameter list starting point.
972 Output: Always True. See dbghdr() for more info, though this is not
973 likely to be used in the same way.
975 ***************************************************************************/
977 BOOL
dbgtext( const char *format_str
, ... )
982 va_start( ap
, format_str
);
983 vslprintf( msgbuf
, sizeof(msgbuf
)-1, format_str
, ap
);
986 format_debug_text( msgbuf
);