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         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 static 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 debug 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 static BOOL debug_parse_params(char **params)
 374 {
 375         int   i, ndx;
 376         char *class_name;
 377         char *class_level;
 378
 379         if (!params)
 380                 return False;
 381
 382         /* Allow DBGC_ALL to be specified w/o requiring its class name e.g."10"
 383          * v.s. "all:10", this is the traditional way to set DEBUGLEVEL
 384          */
 385         if (isdigit((int)params[0][0])) {
 386                 DEBUGLEVEL_CLASS[DBGC_ALL] = atoi(params[0]);
 387                 DEBUGLEVEL_CLASS_ISSET[DBGC_ALL] = True;
 388                 i = 1; /* start processing at the next params */
 389         }
 390         else
 391                 i = 0; /* DBGC_ALL not specified OR class name was included */
 392
 393         /* Fill in new debug class levels */
 394         for (; i < debug_num_classes && params[i]; i++) {
 395                 if ((class_name=strtok(params[i],":")) &&
 396                         (class_level=strtok(NULL, "\0")) &&
 397             ((ndx = debug_lookup_classname(class_name)) != -1)) {
 398                                 DEBUGLEVEL_CLASS[ndx] = atoi(class_level);
 399                                 DEBUGLEVEL_CLASS_ISSET[ndx] = True;
 400                 } else {
 401                         DEBUG(0,("debug_parse_params: unrecognized debug class name or format [%s]\n", params[i]));
 402                         return False;
 403                 }
 404         }
 405
 406         return True;
 407 }
 408
 409 /****************************************************************************
 410 parse the debug levels from smb.conf. Example debug level string:
 411   3 tdb:5 printdrivers:7
 412 Note: the 1st param has no "name:" preceeding it.
 413 ****************************************************************************/
 414 BOOL debug_parse_levels(const char *params_str)
 415 {
 416         char **params;
 417
 418         /* Just in case */
 419         debug_init();
 420
 421         if (AllowDebugChange == False)
 422                 return True;
 423
 424         params = str_list_make(params_str, NULL);
 425
 426         if (debug_parse_params(params))
 427         {
 428                 debug_dump_status(5);
 429                 str_list_free(&params);
 430                 return True;
 431         } else {
 432                 str_list_free(&params);
 433                 return False;
 434         }
 435 }
 436
 437 /****************************************************************************
 438 receive a "set debug level" message
 439 ****************************************************************************/
 440 static void debug_message(int msg_type, pid_t src, void *buf, size_t len)
 441 {
 442         const char *params_str = buf;
 443
 444         /* Check, it's a proper string! */
 445         if (params_str[len-1] != '\0')
 446         {
 447                 DEBUG(1, ("Invalid debug message from pid %u to pid %u\n",
 448                           (unsigned int)src, (unsigned int)getpid()));
 449                 return;
 450         }
 451
 452         DEBUG(3, ("INFO: Remote set of debug to `%s'  (pid %u from pid %u)\n",
 453                   params_str, (unsigned int)getpid(), (unsigned int)src));
 454
 455         debug_parse_levels(params_str);
 456 }
 457
 458
 459 /****************************************************************************
 460 send a "set debug level" message
 461 ****************************************************************************/
 462 void debug_message_send(pid_t pid, const char *params_str)
 463 {
 464         if (!params_str)
 465                 return;
 466         message_send_pid(pid, MSG_DEBUG, params_str, strlen(params_str) + 1,
 467                          False);
 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 *message = debug_list_class_names_and_levels();
 477
 478         DEBUG(1,("INFO: Received REQ_DEBUGLEVEL message from PID %u\n",(unsigned int)src));
 479         message_send_pid(src, MSG_DEBUGLEVEL, message, strlen(message) + 1, True);
 480
 481         SAFE_FREE(message);
 482 }
 483
 484 /****************************************************************************
 485 Init debugging (one time stuff)
 486 ****************************************************************************/
 487 void debug_init(void)
 488 {
 489         static BOOL initialised = False;
 490         const char **p;
 491
 492         if (initialised)
 493                 return;
 494
 495         initialised = True;
 496
 497         message_register(MSG_DEBUG, debug_message);
 498         message_register(MSG_REQ_DEBUGLEVEL, debuglevel_message);
 499
 500         for(p = default_classname_table; *p; p++)
 501         {
 502                 debug_add_class(*p);
 503         }
 504 }
 505
 506
 507 /* ************************************************************************** **
 508  * get ready for syslog stuff
 509  * ************************************************************************** **
 510  */
 511 void setup_logging(const char *pname, BOOL interactive)
 512 {
 513         debug_init();
 514
 515         /* reset to allow multiple setup calls, going from interactive to
 516            non-interactive */
 517         stdout_logging = False;
 518         dbf = NULL;
 519
 520         if (interactive) {
 521                 stdout_logging = True;
 522                 dbf = x_stdout;
 523                 x_setbuf( x_stdout, NULL );
 524         }
 525 #ifdef WITH_SYSLOG
 526         else {
 527                 const char *p = strrchr_m( pname,'/' );
 528                 if (p)
 529                         pname = p + 1;
 530 #ifdef LOG_DAEMON
 531                 openlog( pname, LOG_PID, SYSLOG_FACILITY );
 532 #else
 533                 /* for old systems that have no facility codes. */
 534                 openlog( pname, LOG_PID );
 535 #endif
 536         }
 537 #endif
 538 } /* setup_logging */
 539
 540 /* ************************************************************************** **
 541  * reopen the log files
 542  * note that we now do this unconditionally
 543  * We attempt to open the new debug fp before closing the old. This means
 544  * if we run out of fd's we just keep using the old fd rather than aborting.
 545  * Fix from dgibson@linuxcare.com.
 546  * ************************************************************************** **
 547  */
 548
 549 BOOL reopen_logs( void )
 550 {
 551         pstring fname;
 552         mode_t oldumask;
 553         XFILE *new_dbf = NULL;
 554         XFILE *old_dbf = NULL;
 555         BOOL ret = True;
 556
 557         if (stdout_logging)
 558                 return True;
 559
 560         oldumask = umask( 022 );
 561
 562         pstrcpy(fname, debugf );
 563
 564         if (lp_loaded()) {
 565                 char *logfname;
 566
 567                 logfname = lp_logfile();
 568                 if (*logfname)
 569                         pstrcpy(fname, logfname);
 570         }
 571
 572         pstrcpy( debugf, fname );
 573         new_dbf = x_fopen( debugf, O_WRONLY|O_APPEND|O_CREAT, 0644);
 574
 575         if (!new_dbf) {
 576                 log_overflow = True;
 577                 DEBUG(0, ("Unable to open new log file %s: %s\n", debugf, strerror(errno)));
 578                 log_overflow = False;
 579                 if (dbf)
 580                         x_fflush(dbf);
 581                 ret = False;
 582         } else {
 583                 x_setbuf(new_dbf, NULL);
 584                 old_dbf = dbf;
 585                 dbf = new_dbf;
 586                 if (old_dbf)
 587                         (void) x_fclose(old_dbf);
 588         }
 589
 590         /* Fix from klausr@ITAP.Physik.Uni-Stuttgart.De
 591          * to fix problem where smbd's that generate less
 592          * than 100 messages keep growing the log.
 593          */
 594         force_check_log_size();
 595         (void)umask(oldumask);
 596
 597         /* Take over stderr to catch ouput into logs */
 598         if (dbf && sys_dup2(x_fileno(dbf), 2) == -1) {
 599                 close_low_fds(True); /* Close stderr too, if dup2 can't point it
 600                                         at the logfile */
 601         }
 602
 603         return ret;
 604 }
 605
 606 /* ************************************************************************** **
 607  * Force a check of the log size.
 608  * ************************************************************************** **
 609  */
 610 void force_check_log_size( void )
 611 {
 612   debug_count = 100;
 613 }
 614
 615 /***************************************************************************
 616  Check to see if there is any need to check if the logfile has grown too big.
 617 **************************************************************************/
 618
 619 BOOL need_to_check_log_size( void )
 620 {
 621         int maxlog;
 622
 623         if( debug_count < 100 )
 624                 return( False );
 625
 626         maxlog = lp_max_log_size() * 1024;
 627         if( !dbf || maxlog <= 0 ) {
 628                 debug_count = 0;
 629                 return(False);
 630         }
 631         return( True );
 632 }
 633
 634 /* ************************************************************************** **
 635  * Check to see if the log has grown to be too big.
 636  * ************************************************************************** **
 637  */
 638
 639 void check_log_size( void )
 640 {
 641         int         maxlog;
 642         SMB_STRUCT_STAT st;
 643
 644         /*
 645          *  We need to be root to check/change log-file, skip this and let the main
 646          *  loop check do a new check as root.
 647          */
 648
 649         if( geteuid() != 0 )
 650                 return;
 651
 652         if(log_overflow || !need_to_check_log_size() )
 653                 return;
 654
 655         maxlog = lp_max_log_size() * 1024;
 656
 657         if( sys_fstat( x_fileno( dbf ), &st ) == 0 && st.st_size > maxlog ) {
 658                 (void)reopen_logs();
 659                 if( dbf && get_file_size( debugf ) > maxlog ) {
 660                         pstring name;
 661
 662                         slprintf( name, sizeof(name)-1, "%s.old", debugf );
 663                         (void)rename( debugf, name );
 664
 665                         if (!reopen_logs()) {
 666                                 /* We failed to reopen a log - continue using the old name. */
 667                                 (void)rename(name, debugf);
 668                         }
 669                 }
 670         }
 671
 672         /*
 673          * Here's where we need to panic if dbf == NULL..
 674          */
 675
 676         if(dbf == NULL) {
 677                 /* This code should only be reached in very strange
 678                  * circumstances. If we merely fail to open the new log we
 679                  * should stick with the old one. ergo this should only be
 680                  * reached when opening the logs for the first time: at
 681                  * startup or when the log level is increased from zero.
 682                  * -dwg 6 June 2000
 683                  */
 684                 dbf = x_fopen( "/dev/console", O_WRONLY, 0);
 685                 if(dbf) {
 686                         DEBUG(0,("check_log_size: open of debug file %s failed - using console.\n",
 687                                         debugf ));
 688                 } else {
 689                         /*
 690                          * We cannot continue without a debug file handle.
 691                          */
 692                         abort();
 693                 }
 694         }
 695         debug_count = 0;
 696 } /* check_log_size */
 697
 698 /* ************************************************************************** **
 699  * Write an debug message on the debugfile.
 700  * This is called by dbghdr() and format_debug_text().
 701  * ************************************************************************** **
 702  */
 703  int Debug1( const char *format_str, ... )
 704 {
 705   va_list ap;
 706   int old_errno = errno;
 707
 708   debug_count++;
 709
 710   if( stdout_logging )
 711     {
 712     va_start( ap, format_str );
 713     if(dbf)
 714       (void)x_vfprintf( dbf, format_str, ap );
 715     va_end( ap );
 716     errno = old_errno;
 717     return( 0 );
 718     }
 719
 720 #ifdef WITH_SYSLOG
 721   if( !lp_syslog_only() )
 722 #endif
 723     {
 724     if( !dbf )
 725       {
 726       mode_t oldumask = umask( 022 );
 727
 728       dbf = x_fopen( debugf, O_WRONLY|O_APPEND|O_CREAT, 0644 );
 729       (void)umask( oldumask );
 730       if( dbf )
 731         {
 732         x_setbuf( dbf, NULL );
 733         }
 734       else
 735         {
 736         errno = old_errno;
 737         return(0);
 738         }
 739       }
 740     }
 741
 742 #ifdef WITH_SYSLOG
 743   if( syslog_level < lp_syslog() )
 744     {
 745     /* map debug levels to syslog() priorities
 746      * note that not all DEBUG(0, ...) calls are
 747      * necessarily errors
 748      */
 749     static int priority_map[] = {
 750       LOG_ERR,     /* 0 */
 751       LOG_WARNING, /* 1 */
 752       LOG_NOTICE,  /* 2 */
 753       LOG_INFO,    /* 3 */
 754       };
 755     int     priority;
 756     pstring msgbuf;
 757
 758     if( syslog_level >= ( sizeof(priority_map) / sizeof(priority_map[0]) )
 759      || syslog_level < 0)
 760       priority = LOG_DEBUG;
 761     else
 762       priority = priority_map[syslog_level];
 763
 764     va_start( ap, format_str );
 765     vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
 766     va_end( ap );
 767
 768     msgbuf[255] = '\0';
 769     syslog( priority, "%s", msgbuf );
 770     }
 771 #endif
 772
 773   check_log_size();
 774
 775 #ifdef WITH_SYSLOG
 776   if( !lp_syslog_only() )
 777 #endif
 778     {
 779     va_start( ap, format_str );
 780     if(dbf)
 781       (void)x_vfprintf( dbf, format_str, ap );
 782     va_end( ap );
 783     if(dbf)
 784       (void)x_fflush( dbf );
 785     }
 786
 787   errno = old_errno;
 788
 789   return( 0 );
 790   } /* Debug1 */
 791
 792
 793 /* ************************************************************************** **
 794  * Print the buffer content via Debug1(), then reset the buffer.
 795  *
 796  *  Input:  none
 797  *  Output: none
 798  *
 799  * ************************************************************************** **
 800  */
 801 static void bufr_print( void )
 802   {
 803   format_bufr[format_pos] = '\0';
 804   (void)Debug1( "%s", format_bufr );
 805   format_pos = 0;
 806   } /* bufr_print */
 807
 808 /* ************************************************************************** **
 809  * Format the debug message text.
 810  *
 811  *  Input:  msg - Text to be added to the "current" debug message text.
 812  *
 813  *  Output: none.
 814  *
 815  *  Notes:  The purpose of this is two-fold.  First, each call to syslog()
 816  *          (used by Debug1(), see above) generates a new line of syslog
 817  *          output.  This is fixed by storing the partial lines until the
 818  *          newline character is encountered.  Second, printing the debug
 819  *          message lines when a newline is encountered allows us to add
 820  *          spaces, thus indenting the body of the message and making it
 821  *          more readable.
 822  *
 823  * ************************************************************************** **
 824  */
 825 static void format_debug_text( char *msg )
 826   {
 827   size_t i;
 828   BOOL timestamp = (!stdout_logging && (lp_timestamp_logs() ||
 829                                         !(lp_loaded())));
 830
 831   for( i = 0; msg[i]; i++ )
 832     {
 833     /* Indent two spaces at each new line. */
 834     if(timestamp && 0 == format_pos)
 835       {
 836       format_bufr[0] = format_bufr[1] = ' ';
 837       format_pos = 2;
 838       }
 839
 840     /* If there's room, copy the character to the format buffer. */
 841     if( format_pos < FORMAT_BUFR_MAX )
 842       format_bufr[format_pos++] = msg[i];
 843
 844     /* If a newline is encountered, print & restart. */
 845     if( '\n' == msg[i] )
 846       bufr_print();
 847
 848     /* If the buffer is full dump it out, reset it, and put out a line
 849      * continuation indicator.
 850      */
 851     if( format_pos >= FORMAT_BUFR_MAX )
 852       {
 853       bufr_print();
 854       (void)Debug1( " +>\n" );
 855       }
 856     }
 857
 858   /* Just to be safe... */
 859   format_bufr[format_pos] = '\0';
 860   } /* format_debug_text */
 861
 862 /* ************************************************************************** **
 863  * Flush debug output, including the format buffer content.
 864  *
 865  *  Input:  none
 866  *  Output: none
 867  *
 868  * ************************************************************************** **
 869  */
 870 void dbgflush( void )
 871   {
 872   bufr_print();
 873   if(dbf)
 874     (void)x_fflush( dbf );
 875   } /* dbgflush */
 876
 877 /* ************************************************************************** **
 878  * Print a Debug Header.
 879  *
 880  *  Input:  level - Debug level of the message (not the system-wide debug
 881  *                  level. )
 882  *          file  - Pointer to a string containing the name of the file
 883  *                  from which this function was called, or an empty string
 884  *                  if the __FILE__ macro is not implemented.
 885  *          func  - Pointer to a string containing the name of the function
 886  *                  from which this function was called, or an empty string
 887  *                  if the __FUNCTION__ macro is not implemented.
 888  *          line  - line number of the call to dbghdr, assuming __LINE__
 889  *                  works.
 890  *
 891  *  Output: Always True.  This makes it easy to fudge a call to dbghdr()
 892  *          in a macro, since the function can be called as part of a test.
 893  *          Eg: ( (level <= DEBUGLEVEL) && (dbghdr(level,"",line)) )
 894  *
 895  *  Notes:  This function takes care of setting syslog_level.
 896  *
 897  * ************************************************************************** **
 898  */
 899
 900 BOOL dbghdr( int level, const char *file, const char *func, int line )
 901 {
 902   /* Ensure we don't lose any real errno value. */
 903   int old_errno = errno;
 904
 905   if( format_pos ) {
 906     /* This is a fudge.  If there is stuff sitting in the format_bufr, then
 907      * the *right* thing to do is to call
 908      *   format_debug_text( "\n" );
 909      * to write the remainder, and then proceed with the new header.
 910      * Unfortunately, there are several places in the code at which
 911      * the DEBUG() macro is used to build partial lines.  That in mind,
 912      * we'll work under the assumption that an incomplete line indicates
 913      * that a new header is *not* desired.
 914      */
 915     return( True );
 916   }
 917
 918 #ifdef WITH_SYSLOG
 919   /* Set syslog_level. */
 920   syslog_level = level;
 921 #endif
 922
 923   /* Don't print a header if we're logging to stdout. */
 924   if( stdout_logging )
 925     return( True );
 926
 927   /* Print the header if timestamps are turned on.  If parameters are
 928    * not yet loaded, then default to timestamps on.
 929    */
 930   if( lp_timestamp_logs() || !(lp_loaded()) ) {
 931     char header_str[200];
 932
 933         header_str[0] = '\0';
 934
 935         if( lp_debug_pid())
 936           slprintf(header_str,sizeof(header_str)-1,", pid=%u",(unsigned int)sys_getpid());
 937
 938         if( lp_debug_uid()) {
 939       size_t hs_len = strlen(header_str);
 940           slprintf(header_str + hs_len,
 941                sizeof(header_str) - 1 - hs_len,
 942                            ", effective(%u, %u), real(%u, %u)",
 943                (unsigned int)geteuid(), (unsigned int)getegid(),
 944                            (unsigned int)getuid(), (unsigned int)getgid());
 945         }
 946
 947     /* Print it all out at once to prevent split syslog output. */
 948     (void)Debug1( "[%s, %d%s] %s:%s(%d)\n",
 949                   timestring(lp_debug_hires_timestamp()), level,
 950                                   header_str, file, func, line );
 951   }
 952
 953   errno = old_errno;
 954   return( True );
 955 }
 956
 957 /* ************************************************************************** **
 958  * Add text to the body of the "current" debug message via the format buffer.
 959  *
 960  *  Input:  format_str  - Format string, as used in printf(), et. al.
 961  *          ...         - Variable argument list.
 962  *
 963  *  ..or..  va_alist    - Old style variable parameter list starting point.
 964  *
 965  *  Output: Always True.  See dbghdr() for more info, though this is not
 966  *          likely to be used in the same way.
 967  *
 968  * ************************************************************************** **
 969  */
 970  BOOL dbgtext( const char *format_str, ... )
 971   {
 972   va_list ap;
 973   pstring msgbuf;
 974
 975   va_start( ap, format_str );
 976   vslprintf( msgbuf, sizeof(msgbuf)-1, format_str, ap );
 977   va_end( ap );
 978
 979   format_debug_text( msgbuf );
 980
 981   return( True );
 982   } /* dbgtext */
 983
 984
 985 /* ************************************************************************** */