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