321b08e0996c4d32889ce9ed51561bc79081eed3
[sfrench/samba-autobuild/.git] / source3 / lib / debug.c
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
7
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 3 of the License, or
11    (at your option) any later version.
12
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.
17
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
20 */
21
22 #include "includes.h"
23 #include "librpc/gen_ndr/messaging.h"
24
25 /* -------------------------------------------------------------------------- **
26  * Defines...
27  *
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.
31  */
32
33 #define FORMAT_BUFR_SIZE 1024
34 #define FORMAT_BUFR_MAX (FORMAT_BUFR_SIZE - 1)
35
36 /* -------------------------------------------------------------------------- **
37  * This module implements Samba's debugging utility.
38  *
39  * The syntax of a debugging log file is represented as:
40  *
41  *  <debugfile> :== { <debugmsg> }
42  *
43  *  <debugmsg>  :== <debughdr> '\n' <debugtext>
44  *
45  *  <debughdr>  :== '[' TIME ',' LEVEL ']' [ [FILENAME ':'] [FUNCTION '()'] ]
46  *
47  *  <debugtext> :== { <debugline> }
48  *
49  *  <debugline> :== TEXT '\n'
50  *
51  * TEXT     is a string of characters excluding the newline character.
52  * LEVEL    is the DEBUG level of the message (an integer in the range 0..10).
53  * TIME     is a timestamp.
54  * FILENAME is the name of the file from which the debug message was generated.
55  * FUNCTION is the function from which the debug message was generated.
56  *
57  * Basically, what that all means is:
58  *
59  * - A debugging log file is made up of debug messages.
60  *
61  * - Each debug message is made up of a header and text.  The header is
62  *   separated from the text by a newline.
63  *
64  * - The header begins with the timestamp and debug level of the message
65  *   enclosed in brackets.  The filename and function from which the
66  *   message was generated may follow.  The filename is terminated by a
67  *   colon, and the function name is terminated by parenthesis.
68  *
69  * - The message text is made up of zero or more lines, each terminated by
70  *   a newline.
71  */
72
73 /* state variables for the debug system */
74 static struct {
75         XFILE   *dbf;   /* The log file handle */
76         enum debug_logtype logtype; /* The type of logging we are doing: eg stdout, file, stderr */
77         const char *prog_name;
78         bool reopening_logs;
79 } state;
80
81 /* -------------------------------------------------------------------------- **
82  * External variables.
83  *
84  *  debugf        - Debug file name.
85  *  DEBUGLEVEL    - System-wide debug message limit.  Messages with message-
86  *                  levels higher than DEBUGLEVEL will not be processed.
87  */
88
89 static char *debugf = NULL;
90 bool    debug_warn_unknown_class = True;
91 bool    debug_auto_add_unknown_class = True;
92 bool    AllowDebugChange = True;
93
94 /*
95    used to check if the user specified a
96    logfile on the command line
97 */
98 bool    override_logfile;
99
100 /*
101  * This is to allow assignment to DEBUGLEVEL before the debug
102  * system has been initialized.
103  */
104 static int debug_all_class_hack = 1;
105 static bool debug_all_class_isset_hack = True;
106
107 static int debug_num_classes = 0;
108 int     *DEBUGLEVEL_CLASS = &debug_all_class_hack;
109 bool    *DEBUGLEVEL_CLASS_ISSET = &debug_all_class_isset_hack;
110
111 /* DEBUGLEVEL is #defined to *debug_level */
112 int     DEBUGLEVEL = &debug_all_class_hack;
113
114
115 /* -------------------------------------------------------------------------- **
116  * Internal variables.
117  *
118  *  debug_count     - Number of debug messages that have been output.
119  *                    Used to check log size.
120  *
121  *  syslog_level    - Internal copy of the message debug level.  Written by
122  *                    dbghdr() and read by Debug1().
123  *
124  *  format_bufr     - Used to format debug messages.  The dbgtext() function
125  *                    prints debug messages to a string, and then passes the
126  *                    string to format_debug_text(), which uses format_bufr
127  *                    to build the formatted output.
128  *
129  *  format_pos      - Marks the first free byte of the format_bufr.
130  * 
131  *
132  *  log_overflow    - When this variable is True, never attempt to check the
133  *                    size of the log. This is a hack, so that we can write
134  *                    a message using DEBUG, from open_logs() when we
135  *                    are unable to open a new log file for some reason.
136  */
137
138 static int     debug_count    = 0;
139 #ifdef WITH_SYSLOG
140 static int     syslog_level   = 0;
141 #endif
142 static char *format_bufr = NULL;
143 static size_t     format_pos     = 0;
144 static bool    log_overflow   = False;
145
146 /*
147  * Define all the debug class selection names here. Names *MUST NOT* contain 
148  * white space. There must be one name for each DBGC_<class name>, and they 
149  * must be in the table in the order of DBGC_<class name>.. 
150  */
151 static const char *default_classname_table[] = {
152         "all",               /* DBGC_ALL; index refs traditional DEBUGLEVEL */
153         "tdb",               /* DBGC_TDB          */
154         "printdrivers",      /* DBGC_PRINTDRIVERS */
155         "lanman",            /* DBGC_LANMAN       */
156         "smb",               /* DBGC_SMB          */
157         "rpc_parse",         /* DBGC_RPC_PARSE    */
158         "rpc_srv",           /* DBGC_RPC_SRV      */
159         "rpc_cli",           /* DBGC_RPC_CLI      */
160         "passdb",            /* DBGC_PASSDB       */
161         "sam",               /* DBGC_SAM          */
162         "auth",              /* DBGC_AUTH         */
163         "winbind",           /* DBGC_WINBIND      */
164         "vfs",               /* DBGC_VFS          */
165         "idmap",             /* DBGC_IDMAP        */
166         "quota",             /* DBGC_QUOTA        */
167         "acls",              /* DBGC_ACLS         */
168         "locking",           /* DBGC_LOCKING      */
169         "msdfs",             /* DBGC_MSDFS        */
170         "dmapi",             /* DBGC_DMAPI        */
171         "registry",          /* DBGC_REGISTRY     */
172         NULL
173 };
174
175 static char **classname_table = NULL;
176
177
178 /* -------------------------------------------------------------------------- **
179  * Functions...
180  */
181
182 /***************************************************************************
183  Free memory pointed to by global pointers.
184 ****************************************************************************/
185
186 static bool initialized;
187
188 void gfree_debugsyms(void)
189 {
190         int i;
191
192         if ( classname_table ) {
193                 for ( i = 0; i < debug_num_classes; i++ ) {
194                         SAFE_FREE( classname_table[i] );
195                 }
196                 SAFE_FREE( classname_table );
197         }
198
199         if ( DEBUGLEVEL_CLASS != &debug_all_class_hack ) {
200                 SAFE_FREE( DEBUGLEVEL_CLASS );
201                 DEBUGLEVEL_CLASS = &debug_all_class_hack;
202         }
203
204         if ( DEBUGLEVEL_CLASS_ISSET != &debug_all_class_isset_hack ) {
205                 SAFE_FREE( DEBUGLEVEL_CLASS_ISSET );
206                 DEBUGLEVEL_CLASS_ISSET = &debug_all_class_isset_hack;
207         }
208
209         SAFE_FREE(format_bufr);
210
211         debug_num_classes = 0;
212
213         debug_level = DEBUGLEVEL_CLASS;
214
215         initialized = false;
216 }
217
218 /****************************************************************************
219 utility lists registered debug class names's
220 ****************************************************************************/
221
222 #define MAX_CLASS_NAME_SIZE 1024
223
224 static char *debug_list_class_names_and_levels(void)
225 {
226         int i, dim;
227         char **list;
228         char *buf = NULL;
229         char *b;
230         bool err = False;
231
232         if (DEBUGLEVEL_CLASS == &debug_all_class_hack) {
233                 return NULL;
234         }
235
236         list = SMB_CALLOC_ARRAY(char *, debug_num_classes + 1);
237         if (!list) {
238                 return NULL;
239         }
240
241         /* prepare strings */
242         for (i = 0, dim = 0; i < debug_num_classes; i++) {
243                 int l = asprintf(&list[i],
244                                 "%s:%d ",
245                                 classname_table[i],
246                                 DEBUGLEVEL_CLASS_ISSET[i]?DEBUGLEVEL_CLASS[i]:DEBUGLEVEL);
247                 if (l < 0 || l > MAX_CLASS_NAME_SIZE) {
248                         err = True;
249                         goto done;
250                 }
251                 dim += l;
252         }
253
254         /* create single string list - add space for newline */
255         b = buf = (char *)SMB_MALLOC(dim+1);
256         if (!buf) {
257                 err = True;
258                 goto done;
259         }
260         for (i = 0; i < debug_num_classes; i++) {
261                 int l = strlen(list[i]);
262                 strncpy(b, list[i], l);
263                 b = b + l;
264         }
265         b[-1] = '\n'; /* replace last space with newline */
266         b[0] = '\0';  /* null terminate string */
267
268 done:
269         /* free strings list */
270         for (i = 0; i < debug_num_classes; i++) {
271                 SAFE_FREE(list[i]);
272         }
273         SAFE_FREE(list);
274
275         if (err) {
276                 return NULL;
277         } else {
278                 return buf;
279         }
280 }
281
282 /****************************************************************************
283  Utility access to debug class names's.
284 ****************************************************************************/
285
286 const char *debug_classname_from_index(int ndx)
287 {
288         if (ndx < 0 || ndx >= debug_num_classes)
289                 return NULL;
290         else
291                 return classname_table[ndx];
292 }
293
294 /****************************************************************************
295  Utility to translate names to debug class index's (internal version).
296 ****************************************************************************/
297
298 static int debug_lookup_classname_int(const char* classname)
299 {
300         int i;
301
302         if (!classname) return -1;
303
304         for (i=0; i < debug_num_classes; i++) {
305                 if (strcmp(classname, classname_table[i])==0)
306                         return i;
307         }
308         return -1;
309 }
310
311 /****************************************************************************
312  Add a new debug class to the system.
313 ****************************************************************************/
314
315 int debug_add_class(const char *classname)
316 {
317         int ndx;
318         void *new_ptr;
319
320         if (!classname)
321                 return -1;
322
323         /* check the init has yet been called */
324         debug_init();
325
326         ndx = debug_lookup_classname_int(classname);
327         if (ndx >= 0)
328                 return ndx;
329         ndx = debug_num_classes;
330
331         new_ptr = DEBUGLEVEL_CLASS;
332         if (DEBUGLEVEL_CLASS == &debug_all_class_hack) {
333                 /* Initial loading... */
334                 new_ptr = NULL;
335         }
336         new_ptr = SMB_REALLOC_ARRAY(new_ptr, int, debug_num_classes + 1);
337         if (!new_ptr)
338                 return -1;
339         DEBUGLEVEL_CLASS = (int *)new_ptr;
340         DEBUGLEVEL_CLASS[ndx] = 0;
341
342         /* debug_level is the pointer used for the DEBUGLEVEL-thingy */
343         if (ndx==0) {
344                 /* Transfer the initial level from debug_all_class_hack */
345                 DEBUGLEVEL_CLASS[ndx] = DEBUGLEVEL;
346         }
347         debug_level = DEBUGLEVEL_CLASS;
348
349         new_ptr = DEBUGLEVEL_CLASS_ISSET;
350         if (new_ptr == &debug_all_class_isset_hack) {
351                 new_ptr = NULL;
352         }
353         new_ptr = SMB_REALLOC_ARRAY(new_ptr, bool, debug_num_classes + 1);
354         if (!new_ptr)
355                 return -1;
356         DEBUGLEVEL_CLASS_ISSET = (bool *)new_ptr;
357         DEBUGLEVEL_CLASS_ISSET[ndx] = False;
358
359         new_ptr = SMB_REALLOC_ARRAY(classname_table, char *, debug_num_classes + 1);
360         if (!new_ptr)
361                 return -1;
362         classname_table = (char **)new_ptr;
363
364         classname_table[ndx] = SMB_STRDUP(classname);
365         if (! classname_table[ndx])
366                 return -1;
367         
368         debug_num_classes++;
369
370         return ndx;
371 }
372
373 /****************************************************************************
374  Utility to translate names to debug class index's (public version).
375 ****************************************************************************/
376
377 int debug_lookup_classname(const char *classname)
378 {
379         int ndx;
380        
381         if (!classname || !*classname)
382                 return -1;
383
384         ndx = debug_lookup_classname_int(classname);
385
386         if (ndx != -1)
387                 return ndx;
388
389         if (debug_warn_unknown_class) {
390                 DEBUG(0, ("debug_lookup_classname(%s): Unknown class\n",
391                           classname));
392         }
393         if (debug_auto_add_unknown_class) {
394                 return debug_add_class(classname);
395         }
396         return -1;
397 }
398
399 /****************************************************************************
400  Dump the current registered debug levels.
401 ****************************************************************************/
402
403 static void debug_dump_status(int level)
404 {
405         int q;
406
407         DEBUG(level, ("INFO: Current debug levels:\n"));
408         for (q = 0; q < debug_num_classes; q++) {
409                 DEBUGADD(level, ("  %s: %s/%d\n",
410                                  classname_table[q],
411                                  (DEBUGLEVEL_CLASS_ISSET[q]
412                                   ? "True" : "False"),
413                                  DEBUGLEVEL_CLASS[q]));
414         }
415 }
416
417 /****************************************************************************
418  parse the debug levels from smbcontrol. Example debug level parameter:
419  printdrivers:7
420 ****************************************************************************/
421
422 static bool debug_parse_params(char **params)
423 {
424         int   i, ndx;
425         char *class_name;
426         char *class_level;
427
428         if (!params)
429                 return False;
430
431         /* Allow DBGC_ALL to be specified w/o requiring its class name e.g."10"  
432          * v.s. "all:10", this is the traditional way to set DEBUGLEVEL 
433          */
434         if (isdigit((int)params[0][0])) {
435                 DEBUGLEVEL_CLASS[DBGC_ALL] = atoi(params[0]);
436                 DEBUGLEVEL_CLASS_ISSET[DBGC_ALL] = True;
437                 i = 1; /* start processing at the next params */
438         } else {
439                 i = 0; /* DBGC_ALL not specified OR class name was included */
440         }
441
442         /* Fill in new debug class levels */
443         for (; i < debug_num_classes && params[i]; i++) {
444                 char *saveptr;
445                 if ((class_name = strtok_r(params[i],":", &saveptr)) &&
446                         (class_level = strtok_r(NULL, "\0", &saveptr)) &&
447             ((ndx = debug_lookup_classname(class_name)) != -1)) {
448                                 DEBUGLEVEL_CLASS[ndx] = atoi(class_level);
449                                 DEBUGLEVEL_CLASS_ISSET[ndx] = True;
450                 } else {
451                         DEBUG(0,("debug_parse_params: unrecognized debug class name or format [%s]\n", params[i]));
452                         return False;
453                 }
454         }
455
456         return True;
457 }
458
459 /****************************************************************************
460  Parse the debug levels from smb.conf. Example debug level string:
461   3 tdb:5 printdrivers:7
462  Note: the 1st param has no "name:" preceeding it.
463 ****************************************************************************/
464
465 bool debug_parse_levels(const char *params_str)
466 {
467         char **params;
468
469         /* Just in case */
470         debug_init();
471
472         if (AllowDebugChange == False)
473                 return True;
474
475         params = str_list_make_v3(talloc_tos(), params_str, NULL);
476
477         if (debug_parse_params(params)) {
478                 debug_dump_status(5);
479                 TALLOC_FREE(params);
480                 return True;
481         } else {
482                 TALLOC_FREE(params);
483                 return False;
484         }
485 }
486
487 /****************************************************************************
488  Receive a "set debug level" message.
489 ****************************************************************************/
490
491 void debug_message(struct messaging_context *msg_ctx,
492                           void *private_data, 
493                           uint32_t msg_type, 
494                           struct server_id src,
495                           DATA_BLOB *data)
496 {
497         const char *params_str = (const char *)data->data;
498
499         /* Check, it's a proper string! */
500         if (params_str[(data->length)-1] != '\0') {
501                 DEBUG(1, ("Invalid debug message from pid %u to pid %u\n",
502                           (unsigned int)procid_to_pid(&src),
503                           (unsigned int)getpid()));
504                 return;
505         }
506
507         DEBUG(3, ("INFO: Remote set of debug to `%s'  (pid %u from pid %u)\n",
508                   params_str, (unsigned int)getpid(),
509                   (unsigned int)procid_to_pid(&src)));
510
511         debug_parse_levels(params_str);
512 }
513
514 /****************************************************************************
515  Return current debug level.
516 ****************************************************************************/
517
518 static void debuglevel_message(struct messaging_context *msg_ctx,
519                                void *private_data, 
520                                uint32_t msg_type, 
521                                struct server_id src,
522                                DATA_BLOB *data)
523 {
524         char *message = debug_list_class_names_and_levels();
525
526         if (!message) {
527                 DEBUG(0,("debuglevel_message - debug_list_class_names_and_levels returned NULL\n"));
528                 return;
529         }
530
531         DEBUG(1,("INFO: Received REQ_DEBUGLEVEL message from PID %s\n",
532                  procid_str_static(&src)));
533         messaging_send_buf(msg_ctx, src, MSG_DEBUGLEVEL,
534                            (uint8 *)message, strlen(message) + 1);
535
536         SAFE_FREE(message);
537 }
538
539 /****************************************************************************
540 Init debugging (one time stuff)
541 ****************************************************************************/
542
543 void debug_init(void)
544 {
545         const char **p;
546
547         if (initialized)
548                 return;
549
550         initialized = true;
551
552         for(p = default_classname_table; *p; p++) {
553                 debug_add_class(*p);
554         }
555         format_bufr = (char *)SMB_MALLOC(FORMAT_BUFR_SIZE);
556         if (!format_bufr) {
557                 smb_panic("debug_init: unable to create buffer");
558         }
559 }
560
561 void debug_register_msgs(struct messaging_context *msg_ctx)
562 {
563         messaging_register(msg_ctx, NULL, MSG_DEBUG, debug_message);
564         messaging_register(msg_ctx, NULL, MSG_REQ_DEBUGLEVEL,
565                            debuglevel_message);
566 }
567
568 /**
569   control the name of the logfile and whether logging will be to stdout, stderr
570   or a file, and set up syslog
571 */
572 void setup_logging(const char *prog_name, enum debug_logtype new_logtype)
573 {
574         debug_init();
575         if (state.logtype < new_logtype) {
576                 state.logtype = new_logtype;
577         }
578         if (prog_name) {
579                 state.prog_name = prog_name;
580         }
581         reopen_logs();
582
583         if (state.logtype == DEBUG_FILE) {
584 #ifdef WITH_SYSLOG
585                 const char *p = strrchr_m( prog_name,'/' );
586                 if (p)
587                         prog_name = p + 1;
588 #ifdef LOG_DAEMON
589                 openlog( prog_name, LOG_PID, SYSLOG_FACILITY );
590 #else
591                 /* for old systems that have no facility codes. */
592                 openlog( prog_name, LOG_PID );
593 #endif
594 #endif
595         }
596 }
597
598 /***************************************************************************
599  Set the logfile name.
600 **************************************************************************/
601
602 void debug_set_logfile(const char *name)
603 {
604         SAFE_FREE(debugf);
605         debugf = SMB_STRDUP(name);
606 }
607
608 static void debug_close_xfile(XFILE *dbf)
609 {
610         if (dbf && (dbf != x_stderr && dbf != x_stdout)) {
611                 x_fclose(dbf);
612         }
613 }
614
615 void debug_close_dbf(void)
616 {
617         debug_close_xfile(state.dbf);
618         state.dbf = NULL;
619 }
620 /**************************************************************************
621  reopen the log files
622  note that we now do this unconditionally
623  We attempt to open the new debug fp before closing the old. This means
624  if we run out of fd's we just keep using the old fd rather than aborting.
625  Fix from dgibson@linuxcare.com.
626 **************************************************************************/
627
628 /**
629   reopen the log file (usually called because the log file name might have changed)
630 */
631 bool reopen_logs(void)
632 {
633         mode_t oldumask;
634         XFILE *new_dbf = NULL;
635         XFILE *old_dbf = NULL;
636         bool ret = True;
637
638         char *fname = NULL;
639         if (state.reopening_logs) {
640                 return true;
641         }
642
643         switch (state.logtype) {
644         case DEBUG_STDOUT:
645                 state.dbf = x_stdout;
646                 x_setbuf( x_stdout, NULL );
647                 return true;
648
649         case DEBUG_DEFAULT_STDERR:
650         case DEBUG_STDERR:
651                 debug_close_xfile(state.dbf);
652                 state.dbf = x_stderr;
653                 x_setbuf( x_stderr, NULL );
654                 return true;
655
656         case DEBUG_FILE:
657                 break;
658         }
659
660         oldumask = umask( 022 );
661
662         fname = debugf;
663         if (!fname) {
664                 return false;
665         }
666         debugf = NULL;
667
668         if (lp_loaded()) {
669                 char *logfname;
670
671                 logfname = lp_logfile();
672                 if (*logfname) {
673                         SAFE_FREE(fname);
674                         fname = SMB_STRDUP(logfname);
675                         if (!fname) {
676                                 return false;
677                         }
678                 }
679         }
680
681         debugf = fname;
682         new_dbf = x_fopen( debugf, O_WRONLY|O_APPEND|O_CREAT, 0644);
683
684         if (!new_dbf) {
685                 log_overflow = True;
686                 DEBUG(0, ("Unable to open new log file %s: %s\n", debugf, strerror(errno)));
687                 log_overflow = False;
688                 if (state.dbf)
689                         x_fflush(state.dbf);
690                 ret = False;
691         } else {
692                 x_setbuf(new_dbf, NULL);
693                 old_dbf = state.dbf;
694                 state.dbf = new_dbf;
695                 if (old_dbf)
696                         debug_close_xfile(old_dbf);
697         }
698
699         /* Fix from klausr@ITAP.Physik.Uni-Stuttgart.De
700          * to fix problem where smbd's that generate less
701          * than 100 messages keep growing the log.
702          */
703         force_check_log_size();
704         (void)umask(oldumask);
705
706         /* Take over stderr to catch output into logs */
707         if (state.dbf && dup2(x_fileno(state.dbf), 2) == -1) {
708                 close_low_fds(True); /* Close stderr too, if dup2 can't point it
709                                         at the logfile */
710         }
711
712         return ret;
713 }
714
715 /**************************************************************************
716  Force a check of the log size.
717  ***************************************************************************/
718
719 void force_check_log_size( void )
720 {
721         debug_count = 100;
722 }
723
724 /***************************************************************************
725  Check to see if there is any need to check if the logfile has grown too big.
726 **************************************************************************/
727
728 bool need_to_check_log_size( void )
729 {
730         int maxlog;
731
732         if( debug_count < 100 )
733                 return( False );
734
735         maxlog = lp_max_log_size() * 1024;
736         if( !state.dbf || maxlog <= 0 ) {
737                 debug_count = 0;
738                 return(False);
739         }
740         return( True );
741 }
742
743 /**************************************************************************
744  Check to see if the log has grown to be too big.
745  **************************************************************************/
746
747 void check_log_size( void )
748 {
749         int         maxlog;
750         SMB_STRUCT_STAT st;
751
752         /*
753          *  We need to be root to check/change log-file, skip this and let the main
754          *  loop check do a new check as root.
755          */
756
757         if( geteuid() != sec_initial_uid() )
758                 return;
759
760         if(log_overflow || !need_to_check_log_size() )
761                 return;
762
763         maxlog = lp_max_log_size() * 1024;
764
765         if(sys_fstat(x_fileno(state.dbf), &st, false) == 0
766            && st.st_ex_size > maxlog ) {
767                 (void)reopen_logs();
768                 if( state.dbf && get_file_size( debugf ) > maxlog ) {
769                         char *name = NULL;
770
771                         if (asprintf(&name, "%s.old", debugf ) < 0) {
772                                 return;
773                         }
774                         (void)rename(debugf, name);
775
776                         if (!reopen_logs()) {
777                                 /* We failed to reopen a log - continue using the old name. */
778                                 (void)rename(name, debugf);
779                         }
780                         SAFE_FREE(name);
781                 }
782         }
783
784         /*
785          * Here's where we need to panic if dbf == NULL..
786          */
787
788         if(state.dbf == NULL) {
789                 /* This code should only be reached in very strange
790                  * circumstances. If we merely fail to open the new log we
791                  * should stick with the old one. ergo this should only be
792                  * reached when opening the logs for the first time: at
793                  * startup or when the log level is increased from zero.
794                  * -dwg 6 June 2000
795                  */
796                 state.dbf = x_fopen( "/dev/console", O_WRONLY, 0);
797                 if(state.dbf) {
798                         DEBUG(0,("check_log_size: open of debug file %s failed - using console.\n",
799                                         debugf ));
800                 } else {
801                         /*
802                          * We cannot continue without a debug file handle.
803                          */
804                         abort();
805                 }
806         }
807         debug_count = 0;
808 }
809
810 /*************************************************************************
811  Write an debug message on the debugfile.
812  This is called by dbghdr() and format_debug_text().
813 ************************************************************************/
814
815  int Debug1( const char *format_str, ... )
816 {
817         va_list ap;
818         int old_errno = errno;
819
820         debug_count++;
821
822         if ( state.logtype != DEBUG_FILE ) {
823                 va_start( ap, format_str );
824                 if(state.dbf)
825                         (void)x_vfprintf( state.dbf, format_str, ap );
826                 va_end( ap );
827                 errno = old_errno;
828                 goto done;
829         }
830
831         /* prevent recursion by checking if reopen_logs() has temporaily
832            set the debugf string to NULL */
833         if( debugf == NULL)
834                 goto done;
835
836 #ifdef WITH_SYSLOG
837         if( !lp_syslog_only() )
838 #endif
839         {
840                 if( !state.dbf ) {
841                         mode_t oldumask = umask( 022 );
842
843                         state.dbf = x_fopen( debugf, O_WRONLY|O_APPEND|O_CREAT, 0644 );
844                         (void)umask( oldumask );
845                         if( state.dbf ) {
846                                 x_setbuf( state.dbf, NULL );
847                         } else {
848                                 errno = old_errno;
849                                 goto done;
850                         }
851                 }
852         }
853
854 #ifdef WITH_SYSLOG
855         if( syslog_level < lp_syslog() ) {
856                 /* map debug levels to syslog() priorities
857                  * note that not all DEBUG(0, ...) calls are
858                  * necessarily errors */
859                 static const int priority_map[4] = {
860                         LOG_ERR,     /* 0 */
861                         LOG_WARNING, /* 1 */
862                         LOG_NOTICE,  /* 2 */
863                         LOG_INFO,    /* 3 */
864                 };
865                 int     priority;
866                 char *msgbuf = NULL;
867                 int ret;
868
869                 if( syslog_level >= ARRAY_SIZE(priority_map) || syslog_level < 0)
870                         priority = LOG_DEBUG;
871                 else
872                         priority = priority_map[syslog_level];
873
874                 /*
875                  * Specify the facility to interoperate with other syslog
876                  * callers (vfs_full_audit for example).
877                  */
878                 priority |= SYSLOG_FACILITY;
879
880                 va_start(ap, format_str);
881                 ret = vasprintf(&msgbuf, format_str, ap);
882                 va_end(ap);
883
884                 if (ret != -1) {
885                         syslog(priority, "%s", msgbuf);
886                 }
887                 SAFE_FREE(msgbuf);
888         }
889 #endif
890
891         check_log_size();
892
893 #ifdef WITH_SYSLOG
894         if( !lp_syslog_only() )
895 #endif
896         {
897                 va_start( ap, format_str );
898                 if(state.dbf)
899                         (void)x_vfprintf( state.dbf, format_str, ap );
900                 va_end( ap );
901                 if(state.dbf)
902                         (void)x_fflush( state.dbf );
903         }
904
905  done:
906         errno = old_errno;
907
908         return( 0 );
909 }
910
911
912 /**************************************************************************
913  Print the buffer content via Debug1(), then reset the buffer.
914  Input:  none
915  Output: none
916 ****************************************************************************/
917
918 static void bufr_print( void )
919 {
920         format_bufr[format_pos] = '\0';
921         (void)Debug1( "%s", format_bufr );
922         format_pos = 0;
923 }
924
925 /***************************************************************************
926  Format the debug message text.
927
928  Input:  msg - Text to be added to the "current" debug message text.
929
930  Output: none.
931
932  Notes:  The purpose of this is two-fold.  First, each call to syslog()
933          (used by Debug1(), see above) generates a new line of syslog
934          output.  This is fixed by storing the partial lines until the
935          newline character is encountered.  Second, printing the debug
936          message lines when a newline is encountered allows us to add
937          spaces, thus indenting the body of the message and making it
938          more readable.
939 **************************************************************************/
940
941 static void format_debug_text( const char *msg )
942 {
943         size_t i;
944         bool timestamp = (state.logtype == DEBUG_FILE && (lp_timestamp_logs() || !(lp_loaded())));
945
946         if (!format_bufr) {
947                 debug_init();
948         }
949
950         for( i = 0; msg[i]; i++ ) {
951                 /* Indent two spaces at each new line. */
952                 if(timestamp && 0 == format_pos) {
953                         format_bufr[0] = format_bufr[1] = ' ';
954                         format_pos = 2;
955                 }
956
957                 /* If there's room, copy the character to the format buffer. */
958                 if( format_pos < FORMAT_BUFR_MAX )
959                         format_bufr[format_pos++] = msg[i];
960
961                 /* If a newline is encountered, print & restart. */
962                 if( '\n' == msg[i] )
963                         bufr_print();
964
965                 /* If the buffer is full dump it out, reset it, and put out a line
966                  * continuation indicator.
967                  */
968                 if( format_pos >= FORMAT_BUFR_MAX ) {
969                         bufr_print();
970                         (void)Debug1( " +>\n" );
971                 }
972         }
973
974         /* Just to be safe... */
975         format_bufr[format_pos] = '\0';
976 }
977
978 /***************************************************************************
979  Flush debug output, including the format buffer content.
980
981  Input:  none
982  Output: none
983 ***************************************************************************/
984
985 void dbgflush( void )
986 {
987         bufr_print();
988         if(state.dbf)
989                 (void)x_fflush( state.dbf );
990 }
991
992 /***************************************************************************
993  Print a Debug Header.
994
995  Input:  level - Debug level of the message (not the system-wide debug
996                   level. )
997           cls   - Debuglevel class of the calling module.
998           file  - Pointer to a string containing the name of the file
999                   from which this function was called, or an empty string
1000                   if the __FILE__ macro is not implemented.
1001           func  - Pointer to a string containing the name of the function
1002                   from which this function was called, or an empty string
1003                   if the __FUNCTION__ macro is not implemented.
1004          line  - line number of the call to dbghdr, assuming __LINE__
1005                  works.
1006
1007   Output: Always True.  This makes it easy to fudge a call to dbghdr()
1008           in a macro, since the function can be called as part of a test.
1009           Eg: ( (level <= DEBUGLEVEL) && (dbghdr(level,"",line)) )
1010
1011   Notes:  This function takes care of setting syslog_level.
1012
1013 ****************************************************************************/
1014
1015 bool dbghdrclass(int level, int cls, const char *location, const char *func)
1016 {
1017         /* Ensure we don't lose any real errno value. */
1018         int old_errno = errno;
1019
1020         if( format_pos ) {
1021                 /* This is a fudge.  If there is stuff sitting in the format_bufr, then
1022                  * the *right* thing to do is to call
1023                  *   format_debug_text( "\n" );
1024                  * to write the remainder, and then proceed with the new header.
1025                  * Unfortunately, there are several places in the code at which
1026                  * the DEBUG() macro is used to build partial lines.  That in mind,
1027                  * we'll work under the assumption that an incomplete line indicates
1028                  * that a new header is *not* desired.
1029                  */
1030                 return( True );
1031         }
1032
1033 #ifdef WITH_SYSLOG
1034         /* Set syslog_level. */
1035         syslog_level = level;
1036 #endif
1037
1038         /* Don't print a header if we're logging to stdout. */
1039         if ( state.logtype != DEBUG_FILE ) {
1040                 return( True );
1041         }
1042
1043         /* Print the header if timestamps are turned on.  If parameters are
1044          * not yet loaded, then default to timestamps on.
1045          */
1046         if( lp_timestamp_logs() || lp_debug_prefix_timestamp() || !(lp_loaded()) ) {
1047                 char header_str[200];
1048
1049                 header_str[0] = '\0';
1050
1051                 if( lp_debug_pid())
1052                         slprintf(header_str,sizeof(header_str)-1,", pid=%u",(unsigned int)sys_getpid());
1053
1054                 if( lp_debug_uid()) {
1055                         size_t hs_len = strlen(header_str);
1056                         slprintf(header_str + hs_len,
1057                         sizeof(header_str) - 1 - hs_len,
1058                                 ", effective(%u, %u), real(%u, %u)",
1059                                 (unsigned int)geteuid(), (unsigned int)getegid(),
1060                                 (unsigned int)getuid(), (unsigned int)getgid()); 
1061                 }
1062
1063                 if (lp_debug_class() && (cls != DBGC_ALL)) {
1064                         size_t hs_len = strlen(header_str);
1065                         slprintf(header_str + hs_len,
1066                                  sizeof(header_str) -1 - hs_len,
1067                                  ", class=%s",
1068                                  default_classname_table[cls]);
1069                 }
1070   
1071                 /* Print it all out at once to prevent split syslog output. */
1072                 if( lp_debug_prefix_timestamp() ) {
1073                     (void)Debug1( "[%s, %2d%s] ",
1074                         current_timestring(talloc_tos(),
1075                                            lp_debug_hires_timestamp()),
1076                         level, header_str);
1077                 } else {
1078                     (void)Debug1( "[%s, %2d%s] %s(%s)\n",
1079                         current_timestring(talloc_tos(),
1080                                            lp_debug_hires_timestamp()),
1081                         level, header_str, location, func );
1082                 }
1083         }
1084
1085         errno = old_errno;
1086         return( True );
1087 }
1088
1089 bool dbghdr(int level, const char *location, const char *func)
1090 {
1091         /* For compatibility with Samba 4, which doesn't have debug classes */
1092         return dbghdrclass(level, 0, location, func);
1093 }
1094
1095 /***************************************************************************
1096  Add text to the body of the "current" debug message via the format buffer.
1097
1098   Input:  format_str  - Format string, as used in printf(), et. al.
1099           ...         - Variable argument list.
1100
1101   ..or..  va_alist    - Old style variable parameter list starting point.
1102
1103   Output: Always True.  See dbghdr() for more info, though this is not
1104           likely to be used in the same way.
1105
1106 ***************************************************************************/
1107
1108  bool dbgtext( const char *format_str, ... )
1109 {
1110         va_list ap;
1111         char *msgbuf = NULL;
1112         bool ret = true;
1113         int res;
1114
1115         va_start(ap, format_str);
1116         res = vasprintf(&msgbuf, format_str, ap);
1117         va_end(ap);
1118
1119         if (res != -1) {
1120                 format_debug_text(msgbuf);
1121         } else {
1122                 ret = false;
1123         }
1124         SAFE_FREE(msgbuf);
1125         return ret;
1126 }