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