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