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