Merge of 64-bit printf warning fixes.
[Samba/gebeck_regimport.git] / source3 / lib / debug.c
blobfdbd54fafb01756f4e6d851229f638720ab15309
1 /*
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.
23 #include "includes.h"
25 /* -------------------------------------------------------------------------- **
26 * Defines...
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
69 * a newline.
72 /* -------------------------------------------------------------------------- **
73 * External variables.
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.
81 XFILE *dbf = NULL;
82 pstring debugf = "";
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;
131 #ifdef WITH_SYSLOG
132 static int syslog_level = 0;
133 #endif
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 */
157 "idmap", /* DBGC_IDMAP */
158 NULL
161 static char **classname_table = NULL;
164 /* -------------------------------------------------------------------------- **
165 * Functions...
169 /****************************************************************************
170 utility lists registered debug class names's
171 ****************************************************************************/
173 #define MAX_CLASS_NAME_SIZE 1024
175 static char *debug_list_class_names_and_levels(void)
177 int i, dim;
178 char **list;
179 char *buf = NULL;
180 char *b;
181 BOOL err = False;
183 if (DEBUGLEVEL_CLASS == &debug_all_class_hack)
184 return NULL;
186 list = calloc(debug_num_classes + 1, sizeof(char *));
187 if (!list)
188 return NULL;
190 /* prepare strings */
191 for (i = 0, dim = 0; i < debug_num_classes; i++) {
192 int l = asprintf(&list[i],
193 "%s:%d ",
194 classname_table[i],
195 DEBUGLEVEL_CLASS_ISSET[i]?DEBUGLEVEL_CLASS[i]:DEBUGLEVEL);
196 if (l < 0 || l > MAX_CLASS_NAME_SIZE) {
197 err = True;
198 goto done;
200 dim += l;
203 /* create single string list */
204 b = buf = malloc(dim);
205 if (!buf) {
206 err = True;
207 goto done;
209 for (i = 0; i < debug_num_classes; i++) {
210 int l = strlen(list[i]);
211 strncpy(b, list[i], l);
212 b = b + l;
214 b[-1] = '\0';
216 done:
217 /* free strings list */
218 for (i = 0; i < debug_num_classes; i++)
219 if (list[i]) free(list[i]);
220 free(list);
222 if (err) {
223 if (buf)
224 free(buf);
225 return NULL;
226 } else {
227 return buf;
231 /****************************************************************************
232 utility access to debug class names's
233 ****************************************************************************/
234 const char *debug_classname_from_index(int ndx)
236 if (ndx < 0 || ndx >= debug_num_classes)
237 return NULL;
238 else
239 return classname_table[ndx];
242 /****************************************************************************
243 utility to translate names to debug class index's (internal version)
244 ****************************************************************************/
245 static int debug_lookup_classname_int(const char* classname)
247 int i;
249 if (!classname) return -1;
251 for (i=0; i < debug_num_classes; i++) {
252 if (strcmp(classname, classname_table[i])==0)
253 return i;
255 return -1;
258 /****************************************************************************
259 Add a new debug class to the system
260 ****************************************************************************/
261 int debug_add_class(const char *classname)
263 int ndx;
264 void *new_ptr;
266 if (!classname)
267 return -1;
269 /* check the init has yet been called */
270 debug_init();
272 ndx = debug_lookup_classname_int(classname);
273 if (ndx >= 0)
274 return ndx;
275 ndx = debug_num_classes;
277 new_ptr = DEBUGLEVEL_CLASS;
278 if (DEBUGLEVEL_CLASS == &debug_all_class_hack)
280 /* Initial loading... */
281 new_ptr = NULL;
283 new_ptr = Realloc(new_ptr,
284 sizeof(int) * (debug_num_classes + 1));
285 if (!new_ptr)
286 return -1;
287 DEBUGLEVEL_CLASS = new_ptr;
288 DEBUGLEVEL_CLASS[ndx] = 0;
290 /* debug_level is the pointer used for the DEBUGLEVEL-thingy */
291 if (ndx==0)
293 /* Transfer the initial level from debug_all_class_hack */
294 DEBUGLEVEL_CLASS[ndx] = DEBUGLEVEL;
296 debug_level = DEBUGLEVEL_CLASS;
298 new_ptr = DEBUGLEVEL_CLASS_ISSET;
299 if (new_ptr == &debug_all_class_isset_hack)
301 new_ptr = NULL;
303 new_ptr = Realloc(new_ptr,
304 sizeof(BOOL) * (debug_num_classes + 1));
305 if (!new_ptr)
306 return -1;
307 DEBUGLEVEL_CLASS_ISSET = new_ptr;
308 DEBUGLEVEL_CLASS_ISSET[ndx] = False;
310 new_ptr = Realloc(classname_table,
311 sizeof(char *) * (debug_num_classes + 1));
312 if (!new_ptr)
313 return -1;
314 classname_table = new_ptr;
316 classname_table[ndx] = strdup(classname);
317 if (! classname_table[ndx])
318 return -1;
320 debug_num_classes++;
322 return ndx;
325 /****************************************************************************
326 utility to translate names to debug class index's (public version)
327 ****************************************************************************/
328 int debug_lookup_classname(const char *classname)
330 int ndx;
332 if (!classname || !*classname) return -1;
334 ndx = debug_lookup_classname_int(classname);
336 if (ndx != -1)
337 return ndx;
339 if (debug_warn_unknown_class)
341 DEBUG(0, ("debug_lookup_classname(%s): Unknown class\n",
342 classname));
344 if (debug_auto_add_unknown_class)
346 return debug_add_class(classname);
348 return -1;
352 /****************************************************************************
353 dump the current registered debug levels
354 ****************************************************************************/
355 static void debug_dump_status(int level)
357 int q;
359 DEBUG(level, ("INFO: Current debug levels:\n"));
360 for (q = 0; q < debug_num_classes; q++)
362 DEBUGADD(level, (" %s: %s/%d\n",
363 classname_table[q],
364 (DEBUGLEVEL_CLASS_ISSET[q]
365 ? "True" : "False"),
366 DEBUGLEVEL_CLASS[q]));
370 /****************************************************************************
371 parse the debug levels from smbcontrol. Example debug level parameter:
372 printdrivers:7
373 ****************************************************************************/
374 static BOOL debug_parse_params(char **params)
376 int i, ndx;
377 char *class_name;
378 char *class_level;
380 if (!params)
381 return False;
383 /* Allow DBGC_ALL to be specified w/o requiring its class name e.g."10"
384 * v.s. "all:10", this is the traditional way to set DEBUGLEVEL
386 if (isdigit((int)params[0][0])) {
387 DEBUGLEVEL_CLASS[DBGC_ALL] = atoi(params[0]);
388 DEBUGLEVEL_CLASS_ISSET[DBGC_ALL] = True;
389 i = 1; /* start processing at the next params */
391 else
392 i = 0; /* DBGC_ALL not specified OR class name was included */
394 /* Fill in new debug class levels */
395 for (; i < debug_num_classes && params[i]; i++) {
396 if ((class_name=strtok(params[i],":")) &&
397 (class_level=strtok(NULL, "\0")) &&
398 ((ndx = debug_lookup_classname(class_name)) != -1)) {
399 DEBUGLEVEL_CLASS[ndx] = atoi(class_level);
400 DEBUGLEVEL_CLASS_ISSET[ndx] = True;
401 } else {
402 DEBUG(0,("debug_parse_params: unrecognized debug class name or format [%s]\n", params[i]));
403 return False;
407 return True;
410 /****************************************************************************
411 parse the debug levels from smb.conf. Example debug level string:
412 3 tdb:5 printdrivers:7
413 Note: the 1st param has no "name:" preceeding it.
414 ****************************************************************************/
415 BOOL debug_parse_levels(const char *params_str)
417 char **params;
419 /* Just in case */
420 debug_init();
422 if (AllowDebugChange == False)
423 return True;
425 params = str_list_make(params_str, NULL);
427 if (debug_parse_params(params))
429 debug_dump_status(5);
430 str_list_free(&params);
431 return True;
432 } else {
433 str_list_free(&params);
434 return False;
438 /****************************************************************************
439 receive a "set debug level" message
440 ****************************************************************************/
441 static void debug_message(int msg_type, pid_t src, void *buf, size_t len)
443 const char *params_str = buf;
445 /* Check, it's a proper string! */
446 if (params_str[len-1] != '\0')
448 DEBUG(1, ("Invalid debug message from pid %u to pid %u\n",
449 (unsigned int)src, (unsigned int)getpid()));
450 return;
453 DEBUG(3, ("INFO: Remote set of debug to `%s' (pid %u from pid %u)\n",
454 params_str, (unsigned int)getpid(), (unsigned int)src));
456 debug_parse_levels(params_str);
460 /****************************************************************************
461 send a "set debug level" message
462 ****************************************************************************/
463 void debug_message_send(pid_t pid, const char *params_str)
465 if (!params_str)
466 return;
467 message_send_pid(pid, MSG_DEBUG, params_str, strlen(params_str) + 1,
468 False);
471 /****************************************************************************
472 Return current debug level.
473 ****************************************************************************/
475 static void debuglevel_message(int msg_type, pid_t src, void *buf, size_t len)
477 char *message = debug_list_class_names_and_levels();
479 DEBUG(1,("INFO: Received REQ_DEBUGLEVEL message from PID %u\n",(unsigned int)src));
480 message_send_pid(src, MSG_DEBUGLEVEL, message, strlen(message) + 1, True);
482 SAFE_FREE(message);
485 /****************************************************************************
486 Init debugging (one time stuff)
487 ****************************************************************************/
488 void debug_init(void)
490 static BOOL initialised = False;
491 const char **p;
493 if (initialised)
494 return;
496 initialised = True;
498 message_register(MSG_DEBUG, debug_message);
499 message_register(MSG_REQ_DEBUGLEVEL, debuglevel_message);
501 for(p = default_classname_table; *p; p++)
503 debug_add_class(*p);
508 /* ************************************************************************** **
509 * get ready for syslog stuff
510 * ************************************************************************** **
512 void setup_logging(const char *pname, BOOL interactive)
514 debug_init();
516 /* reset to allow multiple setup calls, going from interactive to
517 non-interactive */
518 stdout_logging = False;
519 dbf = NULL;
521 if (interactive) {
522 stdout_logging = True;
523 dbf = x_stdout;
524 x_setbuf( x_stdout, NULL );
526 #ifdef WITH_SYSLOG
527 else {
528 const char *p = strrchr_m( pname,'/' );
529 if (p)
530 pname = p + 1;
531 #ifdef LOG_DAEMON
532 openlog( pname, LOG_PID, SYSLOG_FACILITY );
533 #else
534 /* for old systems that have no facility codes. */
535 openlog( pname, LOG_PID );
536 #endif
538 #endif
539 } /* setup_logging */
541 /* ************************************************************************** **
542 * reopen the log files
543 * note that we now do this unconditionally
544 * We attempt to open the new debug fp before closing the old. This means
545 * if we run out of fd's we just keep using the old fd rather than aborting.
546 * Fix from dgibson@linuxcare.com.
547 * ************************************************************************** **
550 BOOL reopen_logs( void )
552 pstring fname;
553 mode_t oldumask;
554 XFILE *new_dbf = NULL;
555 XFILE *old_dbf = NULL;
556 BOOL ret = True;
558 if (stdout_logging)
559 return True;
561 oldumask = umask( 022 );
563 pstrcpy(fname, debugf );
565 if (lp_loaded()) {
566 char *logfname;
568 logfname = lp_logfile();
569 if (*logfname)
570 pstrcpy(fname, logfname);
573 pstrcpy( debugf, fname );
574 new_dbf = x_fopen( debugf, O_WRONLY|O_APPEND|O_CREAT, 0644);
576 if (!new_dbf) {
577 log_overflow = True;
578 DEBUG(0, ("Unable to open new log file %s: %s\n", debugf, strerror(errno)));
579 log_overflow = False;
580 if (dbf)
581 x_fflush(dbf);
582 ret = False;
583 } else {
584 x_setbuf(new_dbf, NULL);
585 old_dbf = dbf;
586 dbf = new_dbf;
587 if (old_dbf)
588 (void) x_fclose(old_dbf);
591 /* Fix from klausr@ITAP.Physik.Uni-Stuttgart.De
592 * to fix problem where smbd's that generate less
593 * than 100 messages keep growing the log.
595 force_check_log_size();
596 (void)umask(oldumask);
598 /* Take over stderr to catch ouput into logs */
599 if (dbf && sys_dup2(x_fileno(dbf), 2) == -1) {
600 close_low_fds(True); /* Close stderr too, if dup2 can't point it
601 at the logfile */
604 return ret;
607 /* ************************************************************************** **
608 * Force a check of the log size.
609 * ************************************************************************** **
611 void force_check_log_size( void )
613 debug_count = 100;
616 /***************************************************************************
617 Check to see if there is any need to check if the logfile has grown too big.
618 **************************************************************************/
620 BOOL need_to_check_log_size( void )
622 int maxlog;
624 if( debug_count < 100 )
625 return( False );
627 maxlog = lp_max_log_size() * 1024;
628 if( !dbf || maxlog <= 0 ) {
629 debug_count = 0;
630 return(False);
632 return( True );
635 /* ************************************************************************** **
636 * Check to see if the log has grown to be too big.
637 * ************************************************************************** **
640 void check_log_size( void )
642 int maxlog;
643 SMB_STRUCT_STAT st;
646 * We need to be root to check/change log-file, skip this and let the main
647 * loop check do a new check as root.
650 if( geteuid() != 0 )
651 return;
653 if(log_overflow || !need_to_check_log_size() )
654 return;
656 maxlog = lp_max_log_size() * 1024;
658 if( sys_fstat( x_fileno( dbf ), &st ) == 0 && st.st_size > maxlog ) {
659 (void)reopen_logs();
660 if( dbf && get_file_size( debugf ) > maxlog ) {
661 pstring name;
663 slprintf( name, sizeof(name)-1, "%s.old", debugf );
664 (void)rename( debugf, name );
666 if (!reopen_logs()) {
667 /* We failed to reopen a log - continue using the old name. */
668 (void)rename(name, debugf);
674 * Here's where we need to panic if dbf == NULL..
677 if(dbf == NULL) {
678 /* This code should only be reached in very strange
679 * circumstances. If we merely fail to open the new log we
680 * should stick with the old one. ergo this should only be
681 * reached when opening the logs for the first time: at
682 * startup or when the log level is increased from zero.
683 * -dwg 6 June 2000
685 dbf = x_fopen( "/dev/console", O_WRONLY, 0);
686 if(dbf) {
687 DEBUG(0,("check_log_size: open of debug file %s failed - using console.\n",
688 debugf ));
689 } else {
691 * We cannot continue without a debug file handle.
693 abort();
696 debug_count = 0;
697 } /* check_log_size */
699 /* ************************************************************************** **
700 * Write an debug message on the debugfile.
701 * This is called by dbghdr() and format_debug_text().
702 * ************************************************************************** **
704 int Debug1( const char *format_str, ... )
706 va_list ap;
707 int old_errno = errno;
709 debug_count++;
711 if( stdout_logging )
713 va_start( ap, format_str );
714 if(dbf)
715 (void)x_vfprintf( dbf, format_str, ap );
716 va_end( ap );
717 errno = old_errno;
718 return( 0 );
721 #ifdef WITH_SYSLOG
722 if( !lp_syslog_only() )
723 #endif
725 if( !dbf )
727 mode_t oldumask = umask( 022 );
729 dbf = x_fopen( debugf, O_WRONLY|O_APPEND|O_CREAT, 0644 );
730 (void)umask( oldumask );
731 if( dbf )
733 x_setbuf( dbf, NULL );
735 else
737 errno = old_errno;
738 return(0);
743 #ifdef WITH_SYSLOG
744 if( syslog_level < lp_syslog() )
746 /* map debug levels to syslog() priorities
747 * note that not all DEBUG(0, ...) calls are
748 * necessarily errors
750 static int priority_map[] = {
751 LOG_ERR, /* 0 */
752 LOG_WARNING, /* 1 */
753 LOG_NOTICE, /* 2 */
754 LOG_INFO, /* 3 */
756 int priority;
757 pstring msgbuf;
759 if( syslog_level >= ( sizeof(priority_map) / sizeof(priority_map[0]) )
760 || syslog_level < 0)
761 priority = LOG_DEBUG;
762 else
763 priority = priority_map[syslog_level];
765 va_start( ap, format_str );
766 vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
767 va_end( ap );
769 msgbuf[255] = '\0';
770 syslog( priority, "%s", msgbuf );
772 #endif
774 check_log_size();
776 #ifdef WITH_SYSLOG
777 if( !lp_syslog_only() )
778 #endif
780 va_start( ap, format_str );
781 if(dbf)
782 (void)x_vfprintf( dbf, format_str, ap );
783 va_end( ap );
784 if(dbf)
785 (void)x_fflush( dbf );
788 errno = old_errno;
790 return( 0 );
791 } /* Debug1 */
794 /* ************************************************************************** **
795 * Print the buffer content via Debug1(), then reset the buffer.
797 * Input: none
798 * Output: none
800 * ************************************************************************** **
802 static void bufr_print( void )
804 format_bufr[format_pos] = '\0';
805 (void)Debug1( "%s", format_bufr );
806 format_pos = 0;
807 } /* bufr_print */
809 /* ************************************************************************** **
810 * Format the debug message text.
812 * Input: msg - Text to be added to the "current" debug message text.
814 * Output: none.
816 * Notes: The purpose of this is two-fold. First, each call to syslog()
817 * (used by Debug1(), see above) generates a new line of syslog
818 * output. This is fixed by storing the partial lines until the
819 * newline character is encountered. Second, printing the debug
820 * message lines when a newline is encountered allows us to add
821 * spaces, thus indenting the body of the message and making it
822 * more readable.
824 * ************************************************************************** **
826 static void format_debug_text( char *msg )
828 size_t i;
829 BOOL timestamp = (!stdout_logging && (lp_timestamp_logs() ||
830 !(lp_loaded())));
832 for( i = 0; msg[i]; i++ )
834 /* Indent two spaces at each new line. */
835 if(timestamp && 0 == format_pos)
837 format_bufr[0] = format_bufr[1] = ' ';
838 format_pos = 2;
841 /* If there's room, copy the character to the format buffer. */
842 if( format_pos < FORMAT_BUFR_MAX )
843 format_bufr[format_pos++] = msg[i];
845 /* If a newline is encountered, print & restart. */
846 if( '\n' == msg[i] )
847 bufr_print();
849 /* If the buffer is full dump it out, reset it, and put out a line
850 * continuation indicator.
852 if( format_pos >= FORMAT_BUFR_MAX )
854 bufr_print();
855 (void)Debug1( " +>\n" );
859 /* Just to be safe... */
860 format_bufr[format_pos] = '\0';
861 } /* format_debug_text */
863 /* ************************************************************************** **
864 * Flush debug output, including the format buffer content.
866 * Input: none
867 * Output: none
869 * ************************************************************************** **
871 void dbgflush( void )
873 bufr_print();
874 if(dbf)
875 (void)x_fflush( dbf );
876 } /* dbgflush */
878 /* ************************************************************************** **
879 * Print a Debug Header.
881 * Input: level - Debug level of the message (not the system-wide debug
882 * level. )
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__
890 * works.
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 * ************************************************************************** **
901 BOOL dbghdr( int level, const char *file, const char *func, int line )
903 /* Ensure we don't lose any real errno value. */
904 int old_errno = errno;
906 if( format_pos ) {
907 /* This is a fudge. If there is stuff sitting in the format_bufr, then
908 * the *right* thing to do is to call
909 * format_debug_text( "\n" );
910 * to write the remainder, and then proceed with the new header.
911 * Unfortunately, there are several places in the code at which
912 * the DEBUG() macro is used to build partial lines. That in mind,
913 * we'll work under the assumption that an incomplete line indicates
914 * that a new header is *not* desired.
916 return( True );
919 #ifdef WITH_SYSLOG
920 /* Set syslog_level. */
921 syslog_level = level;
922 #endif
924 /* Don't print a header if we're logging to stdout. */
925 if( stdout_logging )
926 return( True );
928 /* Print the header if timestamps are turned on. If parameters are
929 * not yet loaded, then default to timestamps on.
931 if( lp_timestamp_logs() || !(lp_loaded()) ) {
932 char header_str[200];
934 header_str[0] = '\0';
936 if( lp_debug_pid())
937 slprintf(header_str,sizeof(header_str)-1,", pid=%u",(unsigned int)sys_getpid());
939 if( lp_debug_uid()) {
940 size_t hs_len = strlen(header_str);
941 slprintf(header_str + hs_len,
942 sizeof(header_str) - 1 - hs_len,
943 ", effective(%u, %u), real(%u, %u)",
944 (unsigned int)geteuid(), (unsigned int)getegid(),
945 (unsigned int)getuid(), (unsigned int)getgid());
948 /* Print it all out at once to prevent split syslog output. */
949 (void)Debug1( "[%s, %d%s] %s:%s(%d)\n",
950 timestring(lp_debug_hires_timestamp()), level,
951 header_str, file, func, line );
954 errno = old_errno;
955 return( True );
958 /* ************************************************************************** **
959 * Add text to the body of the "current" debug message via the format buffer.
961 * Input: format_str - Format string, as used in printf(), et. al.
962 * ... - Variable argument list.
964 * ..or.. va_alist - Old style variable parameter list starting point.
966 * Output: Always True. See dbghdr() for more info, though this is not
967 * likely to be used in the same way.
969 * ************************************************************************** **
971 BOOL dbgtext( const char *format_str, ... )
973 va_list ap;
974 pstring msgbuf;
976 va_start( ap, format_str );
977 vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
978 va_end( ap );
980 format_debug_text( msgbuf );
982 return( True );
983 } /* dbgtext */
986 /* ************************************************************************** */