source3/lib/debug.c

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