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 2 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, write to the Free Software
  20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21 */
  22
  23 #include "includes.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_MAX ( sizeof( format_bufr ) - 1 )
  34
  35 /* -------------------------------------------------------------------------- **
  36  * This module implements Samba's debugging utility.
  37  *
  38  * The syntax of a debugging log file is represented as:
  39  *
  40  *  <debugfile> :== { <debugmsg> }
  41  *
  42  *  <debugmsg>  :== <debughdr> '\n' <debugtext>
  43  *
  44  *  <debughdr>  :== '[' TIME ',' LEVEL ']' [ [FILENAME ':'] [FUNCTION '()'] ]
  45  *
  46  *  <debugtext> :== { <debugline> }
  47  *
  48  *  <debugline> :== TEXT '\n'
  49  *
  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.
  55  *
  56  * Basically, what that all means is:
  57  *
  58  * - A debugging log file is made up of debug messages.
  59  *
  60  * - Each debug message is made up of a header and text.  The header is
  61  *   separated from the text by a newline.
  62  *
  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.
  67  *
  68  * - The message text is made up of zero or more lines, each terminated by
  69  *   a newline.
  70  */
  71
  72 /* -------------------------------------------------------------------------- **
  73  * External variables.
  74  *
  75  *  dbf           - Global debug file handle.
  76  *  debugf        - Debug file name.
  77  *  append_log    - If True, then the output file will be opened in append
  78  *                  mode.
  79  *  DEBUGLEVEL    - System-wide debug message limit.  Messages with message-
  80  *                  levels higher than DEBUGLEVEL will not be processed.
  81  */
  82
  83 XFILE   *dbf        = NULL;
  84 pstring debugf     = "";
  85 BOOL    append_log = False;
  86 BOOL    debug_warn_unknown_class = True;
  87 BOOL    debug_auto_add_unknown_class = True;
  88 BOOL    AllowDebugChange = True;
  89
  90 /*
  91  * This is to allow assignment to DEBUGLEVEL before the debug
  92  * system has been initialised.
  93  */
  94 static int debug_all_class_hack = 1;
  95 static BOOL debug_all_class_isset_hack = True;
  96
  97 static int debug_num_classes = 0;
  98 int     *DEBUGLEVEL_CLASS = &debug_all_class_hack;
  99 BOOL    *DEBUGLEVEL_CLASS_ISSET = &debug_all_class_isset_hack;
 100
 101 /* DEBUGLEVEL is #defined to *debug_level */
 102 int     DEBUGLEVEL = &debug_all_class_hack;
 103
 104
 105 /* -------------------------------------------------------------------------- **
 106  * Internal variables.
 107  *
 108  *  stdout_logging  - Default False, if set to True then dbf will be set to
 109  *                    stdout and debug output will go to dbf only, and not
 110  *                    to syslog.  Set in setup_logging() and read in Debug1().
 111  *
 112  *  debug_count     - Number of debug messages that have been output.
 113  *                    Used to check log size.
 114  *
 115  *  syslog_level    - Internal copy of the message debug level.  Written by
 116  *                    dbghdr() and read by Debug1().
 117  *
 118  *  format_bufr     - Used to format debug messages.  The dbgtext() function
 119  *                    prints debug messages to a string, and then passes the
 120  *                    string to format_debug_text(), which uses format_bufr
 121  *                    to build the formatted output.
 122  *
 123  *  format_pos      - Marks the first free byte of the format_bufr.
 124  *
 125  *
 126  *  log_overflow    - When this variable is True, never attempt to check the
 127  *                    size of the log. This is a hack, so that we can write
 128  *                    a message using DEBUG, from open_logs() when we
 129  *                    are unable to open a new log file for some reason.
 130  */
 131
 132 static BOOL    stdout_logging = False;
 133 static int     debug_count    = 0;
 134 #ifdef WITH_SYSLOG
 135 static int     syslog_level   = 0;
 136 #endif
 137 static pstring format_bufr    = { '\0' };
 138 static size_t     format_pos     = 0;
 139 static BOOL    log_overflow   = False;
 140
 141 /*
 142  * Define all the debug class selection names here. Names *MUST NOT* contain
 143  * white space. There must be one name for each DBGC_<class name>, and they
 144  * must be in the table in the order of DBGC_<class name>..
 145  */
 146 static const char *default_classname_table[] = {
 147         "all",               /* DBGC_ALL; index refs traditional DEBUGLEVEL */
 148         "tdb",               /* DBGC_TDB          */
 149         "printdrivers",      /* DBGC_PRINTDRIVERS */
 150         "lanman",            /* DBGC_LANMAN       */
 151         "smb",               /* DBGC_SMB          */
 152         "rpc",               /* DBGC_RPC          */
 153         "rpc_hdr",           /* DBGC_RPC_HDR      */
 154         "passdb",            /* DBGC_PASSDB       */
 155         "auth",              /* DBGC_AUTH         */
 156         "bdc",               /* DBGC_BDC          */
 157         NULL
 158 };
 159
 160 static char **classname_table = NULL;
 161
 162
 163 /* -------------------------------------------------------------------------- **
 164  * Functions...
 165  */
 166
 167
 168 /****************************************************************************
 169 utility lists registered debug class names's
 170 ****************************************************************************/
 171
 172 #define MAX_CLASS_NAME_SIZE 1024
 173
 174 char *debug_list_class_names_and_levels(void)
 175 {
 176         int i, dim;
 177         char **list;
 178         char *buf = NULL;
 179         char *b;
 180         BOOL err = False;
 181
 182         if (DEBUGLEVEL_CLASS == &debug_all_class_hack)
 183                 return NULL;
 184
 185         list = calloc(debug_num_classes + 1, sizeof(char *));
 186         if (!list)
 187                 return NULL;
 188
 189         /* prepare strings */
 190         for (i = 0, dim = 0; i < debug_num_classes; i++) {
 191                 int l = asprintf(&list[i],
 192                                 "%s:%d ",
 193                                 classname_table[i],
 194                                 DEBUGLEVEL_CLASS_ISSET[i]?DEBUGLEVEL_CLASS[i]:DEBUGLEVEL);
 195                 if (l < 0 || l > MAX_CLASS_NAME_SIZE) {
 196                         err = True;
 197                         goto done;
 198                 }
 199                 dim += l;
 200         }
 201
 202         /* create single string list */
 203         b = buf = malloc(dim);
 204         if (!buf) {
 205                 err = True;
 206                 goto done;
 207         }
 208         for (i = 0; i < debug_num_classes; i++) {
 209                 int l = strlen(list[i]);
 210                 strncpy(b, list[i], l);
 211                 b = b + l;
 212         }
 213         b[-1] = '\0';
 214
 215 done:
 216         /* free strings list */
 217         for (i = 0; i < debug_num_classes; i++)
 218                 if (list[i]) free(list[i]);
 219         free(list);
 220
 221         if (err) {
 222                 if (buf)
 223                         free(buf);
 224                 return NULL;
 225         } else {
 226                 return buf;
 227         }
 228 }
 229
 230 /****************************************************************************
 231 utility access to debug class names's
 232 ****************************************************************************/
 233 const char *debug_classname_from_index(int ndx)
 234 {
 235         if (ndx < 0 || ndx >= debug_num_classes)
 236                 return NULL;
 237         else
 238                 return classname_table[ndx];
 239 }
 240
 241 /****************************************************************************
 242 utility to translate names to debug class index's (internal version)
 243 ****************************************************************************/
 244 static int debug_lookup_classname_int(const char* classname)
 245 {
 246         int i;
 247
 248         if (!classname) return -1;
 249
 250         for (i=0; i < debug_num_classes; i++) {
 251                 if (strcmp(classname, classname_table[i])==0)
 252                         return i;
 253         }
 254         return -1;
 255 }
 256
 257 /****************************************************************************
 258 Add a new debug class to the system
 259 ****************************************************************************/
 260 int debug_add_class(const char *classname)
 261 {
 262         int ndx;
 263         void *new_ptr;
 264
 265         if (!classname)
 266                 return -1;
 267
 268         /* check the init has yet been called */
 269         debug_init();
 270
 271         ndx = debug_lookup_classname_int(classname);
 272         if (ndx >= 0)
 273                 return ndx;
 274         ndx = debug_num_classes;
 275
 276         new_ptr = DEBUGLEVEL_CLASS;
 277         if (DEBUGLEVEL_CLASS == &debug_all_class_hack)
 278         {
 279                 /* Initial loading... */
 280                 new_ptr = NULL;
 281         }
 282         new_ptr = Realloc(new_ptr,
 283                           sizeof(int) * (debug_num_classes + 1));
 284         if (!new_ptr)
 285                 return -1;
 286         DEBUGLEVEL_CLASS = new_ptr;
 287         DEBUGLEVEL_CLASS[ndx] = 0;
 288
 289         /* debug_level is the pointer used for the DEBUGLEVEL-thingy */
 290         if (ndx==0)
 291         {
 292                 /* Transfer the initial level from debug_all_class_hack */
 293                 DEBUGLEVEL_CLASS[ndx] = DEBUGLEVEL;
 294         }
 295         debug_level = DEBUGLEVEL_CLASS;
 296
 297         new_ptr = DEBUGLEVEL_CLASS_ISSET;
 298         if (new_ptr == &debug_all_class_isset_hack)
 299         {
 300                 new_ptr = NULL;
 301         }
 302         new_ptr = Realloc(new_ptr,
 303                           sizeof(BOOL) * (debug_num_classes + 1));
 304         if (!new_ptr)
 305                 return -1;
 306         DEBUGLEVEL_CLASS_ISSET = new_ptr;
 307         DEBUGLEVEL_CLASS_ISSET[ndx] = False;
 308
 309         new_ptr = Realloc(classname_table,
 310                           sizeof(char *) * (debug_num_classes + 1));
 311         if (!new_ptr)
 312                 return -1;
 313         classname_table = new_ptr;
 314
 315         classname_table[ndx] = strdup(classname);
 316         if (! classname_table[ndx])
 317                 return -1;
 318
 319         debug_num_classes++;
 320
 321         return ndx;
 322 }
 323
 324 /****************************************************************************
 325 utility to translate names to debug class index's (public version)
 326 ****************************************************************************/
 327 int debug_lookup_classname(const char *classname)
 328 {
 329         int ndx;
 330
 331         if (!classname || !*classname) return -1;
 332
 333         ndx = debug_lookup_classname_int(classname);
 334
 335         if (ndx != -1)
 336                 return ndx;
 337
 338         if (debug_warn_unknown_class)
 339         {
 340                 DEBUG(0, ("debug_lookup_classname(%s): Unknown class\n",
 341                           classname));
 342         }
 343         if (debug_auto_add_unknown_class)
 344         {
 345                 return debug_add_class(classname);
 346         }
 347         return -1;
 348 }
 349
 350
 351 /****************************************************************************
 352 dump the current registered denug levels
 353 ****************************************************************************/
 354 static void debug_dump_status(int level)
 355 {
 356         int q;
 357
 358         DEBUG(level, ("INFO: Current debug levels:\n"));
 359         for (q = 0; q < debug_num_classes; q++)
 360         {
 361                 DEBUGADD(level, ("  %s: %s/%d\n",
 362                                  classname_table[q],
 363                                  (DEBUGLEVEL_CLASS_ISSET[q]
 364                                   ? "True" : "False"),
 365                                  DEBUGLEVEL_CLASS[q]));
 366         }
 367 }
 368
 369 /****************************************************************************
 370 parse the debug levels from smbcontrol. Example debug level parameter:
 371   printdrivers:7
 372 ****************************************************************************/
 373 BOOL debug_parse_params(char **params, int *debuglevel_class,
 374                         BOOL *debuglevel_class_isset)
 375 {
 376         int   i, ndx;
 377         char *class_name;
 378         char *class_level;
 379
 380         if (!params)
 381                 return False;
 382
 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
 385          */
 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 */
 390         }
 391         else
 392                 i = 0; /* DBGC_ALL not specified OR class name was included */
 393
 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;
 404                 }
 405         }
 406
 407         return True;
 408 }
 409
 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)
 416 {
 417         char **params;
 418
 419         if (AllowDebugChange == False)
 420         return True;
 421
 422         params = lp_list_make(params_str);
 423
 424         if (debug_parse_params(params, DEBUGLEVEL_CLASS,
 425                                DEBUGLEVEL_CLASS_ISSET))
 426         {
 427                 debug_dump_status(5);
 428                 lp_list_free(&params);
 429                 return True;
 430         } else {
 431                 lp_list_free(&params);
 432                 return False;
 433         }
 434 }
 435
 436 /****************************************************************************
 437 receive a "set debug level" message
 438 ****************************************************************************/
 439 static void debug_message(int msg_type, pid_t src, void *buf, size_t len)
 440 {
 441         const char *params_str = buf;
 442
 443         /* Check, it's a proper string! */
 444         if (params_str[len-1] != '\0')
 445         {
 446                 DEBUG(1, ("Invalid debug message from pid %u to pid %u\n",
 447                           (unsigned int)src, (unsigned int)getpid()));
 448                 return;
 449         }
 450
 451         DEBUG(3, ("INFO: Remote set of debug to `%s'  (pid %u from pid %u)\n",
 452                   params_str, (unsigned int)getpid(), (unsigned int)src));
 453
 454         debug_parse_levels(params_str);
 455 }
 456
 457
 458 /****************************************************************************
 459 send a "set debug level" message
 460 ****************************************************************************/
 461 void debug_message_send(pid_t pid, const char *params_str)
 462 {
 463         if (!params_str)
 464                 return;
 465         message_send_pid(pid, MSG_DEBUG, params_str, strlen(params_str) + 1,
 466                          False);
 467 }
 468
 469
 470 /****************************************************************************
 471  Return current debug level.
 472 ****************************************************************************/
 473
 474 static void debuglevel_message(int msg_type, pid_t src, void *buf, size_t len)
 475 {
 476         char *debug_level_classes;
 477         DEBUG(1,("INFO: Received REQ_DEBUGLEVEL message from PID %u\n",(unsigned int)src));
 478
 479         if ((debug_level_classes = debug_list_class_names_and_levels())) {
 480         /*{ debug_level_classes = "test:1000";*/
 481                 message_send_pid(src, MSG_DEBUGLEVEL, debug_level_classes, strlen(debug_level_classes) + 1, True);
 482                 SAFE_FREE(debug_level_classes);
 483         } else {
 484                 DEBUG(0, ("debuglevel_message: error retrieving class levels!\n"));
 485         }
 486 }
 487
 488 /****************************************************************************
 489 Init debugging (one time stuff)
 490 ****************************************************************************/
 491 void debug_init(void)
 492 {
 493         static BOOL initialised = False;
 494         const char **p;
 495
 496         if (initialised)
 497                 return;
 498
 499         initialised = True;
 500
 501         message_register(MSG_DEBUG, debug_message);
 502         message_register(MSG_REQ_DEBUGLEVEL, debuglevel_message);
 503
 504         for(p = default_classname_table; *p; p++)
 505         {
 506                 debug_add_class(*p);
 507         }
 508 }
 509
 510
 511 /* ************************************************************************** **
 512  * get ready for syslog stuff
 513  * ************************************************************************** **
 514  */
 515 void setup_logging(char *pname, BOOL interactive)
 516 {
 517         debug_init();
 518
 519         /* reset to allow multiple setup calls, going from interactive to
 520            non-interactive */
 521         stdout_logging = False;
 522         dbf = NULL;
 523
 524         if (interactive) {
 525                 stdout_logging = True;
 526                 dbf = x_stdout;
 527         }
 528 #ifdef WITH_SYSLOG
 529         else {
 530                 char *p = strrchr_m( pname,'/' );
 531                 if (p)
 532                         pname = p + 1;
 533 #ifdef LOG_DAEMON
 534                 openlog( pname, LOG_PID, SYSLOG_FACILITY );
 535 #else
 536                 /* for old systems that have no facility codes. */
 537                 openlog( pname, LOG_PID );
 538 #endif
 539         }
 540 #endif
 541 } /* setup_logging */
 542
 543 /* ************************************************************************** **
 544  * reopen the log files
 545  * note that we now do this unconditionally
 546  * We attempt to open the new debug fp before closing the old. This means
 547  * if we run out of fd's we just keep using the old fd rather than aborting.
 548  * Fix from dgibson@linuxcare.com.
 549  * ************************************************************************** **
 550  */
 551
 552 BOOL reopen_logs( void )
 553 {
 554         pstring fname;
 555         mode_t oldumask;
 556         XFILE *new_dbf = NULL;
 557         BOOL ret = True;
 558
 559         if (stdout_logging)
 560                 return True;
 561
 562         oldumask = umask( 022 );
 563
 564         pstrcpy(fname, debugf );
 565
 566         if (lp_loaded()) {
 567                 char *logfname;
 568
 569                 logfname = lp_logfile();
 570                 if (*logfname)
 571                         pstrcpy(fname, logfname);
 572         }
 573
 574         pstrcpy( debugf, fname );
 575         if (append_log)
 576                 new_dbf = x_fopen( debugf, O_WRONLY|O_APPEND|O_CREAT, 0644);
 577         else
 578                 new_dbf = x_fopen( debugf, O_WRONLY|O_CREAT|O_TRUNC, 0644 );
 579
 580         if (!new_dbf) {
 581                 log_overflow = True;
 582                 DEBUG(0, ("Unable to open new log file %s: %s\n", debugf, strerror(errno)));
 583                 log_overflow = False;
 584                 if (dbf)
 585                         x_fflush(dbf);
 586                 ret = False;
 587         } else {
 588                 x_setbuf(new_dbf, NULL);
 589                 if (dbf)
 590                         (void) x_fclose(dbf);
 591                 dbf = new_dbf;
 592         }
 593
 594         /* Fix from klausr@ITAP.Physik.Uni-Stuttgart.De
 595          * to fix problem where smbd's that generate less
 596          * than 100 messages keep growing the log.
 597          */
 598         force_check_log_size();
 599         (void)umask(oldumask);
 600
 601         return ret;
 602 }
 603
 604 /* ************************************************************************** **
 605  * Force a check of the log size.
 606  * ************************************************************************** **
 607  */
 608 void force_check_log_size( void )
 609 {
 610   debug_count = 100;
 611 }
 612
 613 /***************************************************************************
 614  Check to see if there is any need to check if the logfile has grown too big.
 615 **************************************************************************/
 616
 617 BOOL need_to_check_log_size( void )
 618 {
 619         int maxlog;
 620
 621         if( debug_count++ < 100 )
 622                 return( False );
 623
 624         maxlog = lp_max_log_size() * 1024;
 625         if( !dbf || maxlog <= 0 ) {
 626                 debug_count = 0;
 627                 return(False);
 628         }
 629         return( True );
 630 }
 631
 632 /* ************************************************************************** **
 633  * Check to see if the log has grown to be too big.
 634  * ************************************************************************** **
 635  */
 636
 637 void check_log_size( void )
 638 {
 639         int         maxlog;
 640         SMB_STRUCT_STAT st;
 641
 642         /*
 643          *  We need to be root to check/change log-file, skip this and let the main
 644          *  loop check do a new check as root.
 645          */
 646
 647         if( geteuid() != 0 )
 648                 return;
 649
 650         if(log_overflow || !need_to_check_log_size() )
 651                 return;
 652
 653         maxlog = lp_max_log_size() * 1024;
 654
 655         if( sys_fstat( x_fileno( dbf ), &st ) == 0 && st.st_size > maxlog ) {
 656                 (void)reopen_logs();
 657                 if( dbf && get_file_size( debugf ) > maxlog ) {
 658                         pstring name;
 659
 660                         slprintf( name, sizeof(name)-1, "%s.old", debugf );
 661                         (void)rename( debugf, name );
 662
 663                         if (!reopen_logs()) {
 664                                 /* We failed to reopen a log - continue using the old name. */
 665                                 (void)rename(name, debugf);
 666                         }
 667                 }
 668         }
 669
 670         /*
 671          * Here's where we need to panic if dbf == NULL..
 672          */
 673
 674         if(dbf == NULL) {
 675                 /* This code should only be reached in very strange
 676                  * circumstances. If we merely fail to open the new log we
 677                  * should stick with the old one. ergo this should only be
 678                  * reached when opening the logs for the first time: at
 679                  * startup or when the log level is increased from zero.
 680                  * -dwg 6 June 2000
 681                  */
 682                 dbf = x_fopen( "/dev/console", O_WRONLY, 0);
 683                 if(dbf) {
 684                         DEBUG(0,("check_log_size: open of debug file %s failed - using console.\n",
 685                                         debugf ));
 686                 } else {
 687                         /*
 688                          * We cannot continue without a debug file handle.
 689                          */
 690                         abort();
 691                 }
 692         }
 693         debug_count = 0;
 694 } /* check_log_size */
 695
 696 /* ************************************************************************** **
 697  * Write an debug message on the debugfile.
 698  * This is called by dbghdr() and format_debug_text().
 699  * ************************************************************************** **
 700  */
 701  int Debug1( char *format_str, ... )
 702 {
 703   va_list ap;
 704   int old_errno = errno;
 705
 706   if( stdout_logging )
 707     {
 708     va_start( ap, format_str );
 709     if(dbf)
 710       (void)x_vfprintf( dbf, format_str, ap );
 711     va_end( ap );
 712     errno = old_errno;
 713     return( 0 );
 714     }
 715
 716 #ifdef WITH_SYSLOG
 717   if( !lp_syslog_only() )
 718 #endif
 719     {
 720     if( !dbf )
 721       {
 722       mode_t oldumask = umask( 022 );
 723
 724       if( append_log )
 725         dbf = x_fopen( debugf, O_WRONLY|O_APPEND|O_CREAT, 0644 );
 726       else
 727         dbf = x_fopen( debugf, O_WRONLY|O_CREAT|O_TRUNC, 0644 );
 728       (void)umask( oldumask );
 729       if( dbf )
 730         {
 731         x_setbuf( dbf, NULL );
 732         }
 733       else
 734         {
 735         errno = old_errno;
 736         return(0);
 737         }
 738       }
 739     }
 740
 741 #ifdef WITH_SYSLOG
 742   if( syslog_level < lp_syslog() )
 743     {
 744     /* map debug levels to syslog() priorities
 745      * note that not all DEBUG(0, ...) calls are
 746      * necessarily errors
 747      */
 748     static int priority_map[] = {
 749       LOG_ERR,     /* 0 */
 750       LOG_WARNING, /* 1 */
 751       LOG_NOTICE,  /* 2 */
 752       LOG_INFO,    /* 3 */
 753       };
 754     int     priority;
 755     pstring msgbuf;
 756
 757     if( syslog_level >= ( sizeof(priority_map) / sizeof(priority_map[0]) )
 758      || syslog_level < 0)
 759       priority = LOG_DEBUG;
 760     else
 761       priority = priority_map[syslog_level];
 762
 763     va_start( ap, format_str );
 764     vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
 765     va_end( ap );
 766
 767     msgbuf[255] = '\0';
 768     syslog( priority, "%s", msgbuf );
 769     }
 770 #endif
 771
 772   check_log_size();
 773
 774 #ifdef WITH_SYSLOG
 775   if( !lp_syslog_only() )
 776 #endif
 777     {
 778     va_start( ap, format_str );
 779     if(dbf)
 780       (void)x_vfprintf( dbf, format_str, ap );
 781     va_end( ap );
 782     if(dbf)
 783       (void)x_fflush( dbf );
 784     }
 785
 786   errno = old_errno;
 787
 788   return( 0 );
 789   } /* Debug1 */
 790
 791
 792 /* ************************************************************************** **
 793  * Print the buffer content via Debug1(), then reset the buffer.
 794  *
 795  *  Input:  none
 796  *  Output: none
 797  *
 798  * ************************************************************************** **
 799  */
 800 static void bufr_print( void )
 801   {
 802   format_bufr[format_pos] = '\0';
 803   (void)Debug1( "%s", format_bufr );
 804   format_pos = 0;
 805   } /* bufr_print */
 806
 807 /* ************************************************************************** **
 808  * Format the debug message text.
 809  *
 810  *  Input:  msg - Text to be added to the "current" debug message text.
 811  *
 812  *  Output: none.
 813  *
 814  *  Notes:  The purpose of this is two-fold.  First, each call to syslog()
 815  *          (used by Debug1(), see above) generates a new line of syslog
 816  *          output.  This is fixed by storing the partial lines until the
 817  *          newline character is encountered.  Second, printing the debug
 818  *          message lines when a newline is encountered allows us to add
 819  *          spaces, thus indenting the body of the message and making it
 820  *          more readable.
 821  *
 822  * ************************************************************************** **
 823  */
 824 static void format_debug_text( char *msg )
 825   {
 826   size_t i;
 827   BOOL timestamp = (!stdout_logging && (lp_timestamp_logs() ||
 828                                         !(lp_loaded())));
 829
 830   for( i = 0; msg[i]; i++ )
 831     {
 832     /* Indent two spaces at each new line. */
 833     if(timestamp && 0 == format_pos)
 834       {
 835       format_bufr[0] = format_bufr[1] = ' ';
 836       format_pos = 2;
 837       }
 838
 839     /* If there's room, copy the character to the format buffer. */
 840     if( format_pos < FORMAT_BUFR_MAX )
 841       format_bufr[format_pos++] = msg[i];
 842
 843     /* If a newline is encountered, print & restart. */
 844     if( '\n' == msg[i] )
 845       bufr_print();
 846
 847     /* If the buffer is full dump it out, reset it, and put out a line
 848      * continuation indicator.
 849      */
 850     if( format_pos >= FORMAT_BUFR_MAX )
 851       {
 852       bufr_print();
 853       (void)Debug1( " +>\n" );
 854       }
 855     }
 856
 857   /* Just to be safe... */
 858   format_bufr[format_pos] = '\0';
 859   } /* format_debug_text */
 860
 861 /* ************************************************************************** **
 862  * Flush debug output, including the format buffer content.
 863  *
 864  *  Input:  none
 865  *  Output: none
 866  *
 867  * ************************************************************************** **
 868  */
 869 void dbgflush( void )
 870   {
 871   bufr_print();
 872   if(dbf)
 873     (void)x_fflush( dbf );
 874   } /* dbgflush */
 875
 876 /* ************************************************************************** **
 877  * Print a Debug Header.
 878  *
 879  *  Input:  level - Debug level of the message (not the system-wide debug
 880  *                  level. )
 881  *          file  - Pointer to a string containing the name of the file
 882  *                  from which this function was called, or an empty string
 883  *                  if the __FILE__ macro is not implemented.
 884  *          func  - Pointer to a string containing the name of the function
 885  *                  from which this function was called, or an empty string
 886  *                  if the __FUNCTION__ macro is not implemented.
 887  *          line  - line number of the call to dbghdr, assuming __LINE__
 888  *                  works.
 889  *
 890  *  Output: Always True.  This makes it easy to fudge a call to dbghdr()
 891  *          in a macro, since the function can be called as part of a test.
 892  *          Eg: ( (level <= DEBUGLEVEL) && (dbghdr(level,"",line)) )
 893  *
 894  *  Notes:  This function takes care of setting syslog_level.
 895  *
 896  * ************************************************************************** **
 897  */
 898
 899 BOOL dbghdr( int level, char *file, char *func, int line )
 900 {
 901   /* Ensure we don't lose any real errno value. */
 902   int old_errno = errno;
 903
 904   if( format_pos ) {
 905     /* This is a fudge.  If there is stuff sitting in the format_bufr, then
 906      * the *right* thing to do is to call
 907      *   format_debug_text( "\n" );
 908      * to write the remainder, and then proceed with the new header.
 909      * Unfortunately, there are several places in the code at which
 910      * the DEBUG() macro is used to build partial lines.  That in mind,
 911      * we'll work under the assumption that an incomplete line indicates
 912      * that a new header is *not* desired.
 913      */
 914     return( True );
 915   }
 916
 917 #ifdef WITH_SYSLOG
 918   /* Set syslog_level. */
 919   syslog_level = level;
 920 #endif
 921
 922   /* Don't print a header if we're logging to stdout. */
 923   if( stdout_logging )
 924     return( True );
 925
 926   /* Print the header if timestamps are turned on.  If parameters are
 927    * not yet loaded, then default to timestamps on.
 928    */
 929   if( lp_timestamp_logs() || !(lp_loaded()) ) {
 930     char header_str[200];
 931
 932         header_str[0] = '\0';
 933
 934         if( lp_debug_pid())
 935           slprintf(header_str,sizeof(header_str)-1,", pid=%u",(unsigned int)sys_getpid());
 936
 937         if( lp_debug_uid()) {
 938       size_t hs_len = strlen(header_str);
 939           slprintf(header_str + hs_len,
 940                sizeof(header_str) - 1 - hs_len,
 941                            ", effective(%u, %u), real(%u, %u)",
 942                (unsigned int)geteuid(), (unsigned int)getegid(),
 943                            (unsigned int)getuid(), (unsigned int)getgid());
 944         }
 945
 946     /* Print it all out at once to prevent split syslog output. */
 947     (void)Debug1( "[%s, %d%s] %s:%s(%d)\n",
 948                   timestring(lp_debug_hires_timestamp()), level,
 949                                   header_str, file, func, line );
 950   }
 951
 952   errno = old_errno;
 953   return( True );
 954 }
 955
 956 /* ************************************************************************** **
 957  * Add text to the body of the "current" debug message via the format buffer.
 958  *
 959  *  Input:  format_str  - Format string, as used in printf(), et. al.
 960  *          ...         - Variable argument list.
 961  *
 962  *  ..or..  va_alist    - Old style variable parameter list starting point.
 963  *
 964  *  Output: Always True.  See dbghdr() for more info, though this is not
 965  *          likely to be used in the same way.
 966  *
 967  * ************************************************************************** **
 968  */
 969  BOOL dbgtext( char *format_str, ... )
 970   {
 971   va_list ap;
 972   pstring msgbuf;
 973
 974   va_start( ap, format_str );
 975   vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
 976   va_end( ap );
 977
 978   format_debug_text( msgbuf );
 979
 980   return( True );
 981   } /* dbgtext */
 982
 983
 984 /* ************************************************************************** */