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 && dup2(state.fd, 2) == -1) {
 596                 close_low_fds(true); /* Close stderr too, if dup2 can't point it
 597                                         at the logfile */
 598         }
 599
 600         state.reopening_logs = false;
 601
 602         return ret;
 603 }
 604
 605 /**************************************************************************
 606  Force a check of the log size.
 607  ***************************************************************************/
 608
 609 void force_check_log_size( void )
 610 {
 611         debug_count = 100;
 612 }
 613
 614 _PUBLIC_ void debug_schedule_reopen_logs(void)
 615 {
 616         state.schedule_reopen_logs = true;
 617 }
 618
 619
 620 /***************************************************************************
 621  Check to see if there is any need to check if the logfile has grown too big.
 622 **************************************************************************/
 623
 624 bool need_to_check_log_size( void )
 625 {
 626         int maxlog;
 627
 628         if( debug_count < 100)
 629                 return( false );
 630
 631         maxlog = state.settings.max_log_size * 1024;
 632         if ( state.fd <=2 || maxlog <= 0 ) {
 633                 debug_count = 0;
 634                 return(false);
 635         }
 636         return( true );
 637 }
 638
 639 /**************************************************************************
 640  Check to see if the log has grown to be too big.
 641  **************************************************************************/
 642
 643 void check_log_size( void )
 644 {
 645         int         maxlog;
 646         struct stat st;
 647
 648         /*
 649          *  We need to be root to check/change log-file, skip this and let the main
 650          *  loop check do a new check as root.
 651          */
 652
 653 #if _SAMBA_BUILD_ == 3
 654         if (geteuid() != sec_initial_uid())
 655 #else
 656         if( geteuid() != 0)
 657 #endif
 658         {
 659                 /* We don't check sec_initial_uid() here as it isn't
 660                  * available in common code and we don't generally
 661                  * want to rotate and the possibly lose logs in
 662                  * make test or the build farm */
 663                 return;
 664         }
 665
 666         if(log_overflow || (!state.schedule_reopen_logs && !need_to_check_log_size())) {
 667                 return;
 668         }
 669
 670         maxlog = state.settings.max_log_size * 1024;
 671
 672         if (state.schedule_reopen_logs ||
 673            (fstat(state.fd, &st) == 0
 674             && st.st_size > maxlog )) {
 675                 (void)reopen_logs_internal();
 676                 if (state.fd > 0 && fstat(state.fd, &st) == 0) {
 677                         if (st.st_size > maxlog) {
 678                                 char *name = NULL;
 679
 680                                 if (asprintf(&name, "%s.old", state.debugf ) < 0) {
 681                                         return;
 682                                 }
 683                                 (void)rename(state.debugf, name);
 684
 685                                 if (!reopen_logs_internal()) {
 686                                         /* We failed to reopen a log - continue using the old name. */
 687                                         (void)rename(name, state.debugf);
 688                                 }
 689                                 SAFE_FREE(name);
 690                         }
 691                 }
 692         }
 693
 694         /*
 695          * Here's where we need to panic if state.fd == 0 or -1 (invalid values)
 696          */
 697
 698         if (state.fd <= 0) {
 699                 /* This code should only be reached in very strange
 700                  * circumstances. If we merely fail to open the new log we
 701                  * should stick with the old one. ergo this should only be
 702                  * reached when opening the logs for the first time: at
 703                  * startup or when the log level is increased from zero.
 704                  * -dwg 6 June 2000
 705                  */
 706                 int fd = open( "/dev/console", O_WRONLY, 0);
 707                 if (fd != -1) {
 708                         state.fd = fd;
 709                         DEBUG(0,("check_log_size: open of debug file %s failed - using console.\n",
 710                                         state.debugf ));
 711                 } else {
 712                         /*
 713                          * We cannot continue without a debug file handle.
 714                          */
 715                         abort();
 716                 }
 717         }
 718         debug_count = 0;
 719 }
 720
 721 /*************************************************************************
 722  Write an debug message on the debugfile.
 723  This is called by dbghdr() and format_debug_text().
 724 ************************************************************************/
 725
 726  int Debug1( const char *format_str, ... )
 727 {
 728         va_list ap;
 729         int old_errno = errno;
 730
 731         debug_count++;
 732
 733         if ( state.logtype != DEBUG_FILE ) {
 734                 va_start( ap, format_str );
 735                 if (state.fd > 0)
 736                         (void)vdprintf( state.fd, format_str, ap );
 737                 va_end( ap );
 738                 errno = old_errno;
 739                 goto done;
 740         }
 741
 742 #ifdef WITH_SYSLOG
 743         if( !state.settings.syslog_only)
 744 #endif
 745         {
 746                 if( state.fd <= 0 ) {
 747                         mode_t oldumask = umask( 022 );
 748                         int fd = open( state.debugf, O_WRONLY|O_APPEND|O_CREAT, 0644 );
 749                         (void)umask( oldumask );
 750                         if(fd == -1) {
 751                                 errno = old_errno;
 752                                 goto done;
 753                         }
 754                         state.fd = fd;
 755                 }
 756         }
 757
 758 #ifdef WITH_SYSLOG
 759         if( syslog_level < state.settings.syslog ) {
 760                 /* map debug levels to syslog() priorities
 761                  * note that not all DEBUG(0, ...) calls are
 762                  * necessarily errors */
 763                 static const int priority_map[4] = {
 764                         LOG_ERR,     /* 0 */
 765                         LOG_WARNING, /* 1 */
 766                         LOG_NOTICE,  /* 2 */
 767                         LOG_INFO,    /* 3 */
 768                 };
 769                 int     priority;
 770                 char *msgbuf = NULL;
 771                 int ret;
 772
 773                 if( syslog_level >= ARRAY_SIZE(priority_map) || syslog_level < 0)
 774                         priority = LOG_DEBUG;
 775                 else
 776                         priority = priority_map[syslog_level];
 777
 778                 /*
 779                  * Specify the facility to interoperate with other syslog
 780                  * callers (vfs_full_audit for example).
 781                  */
 782                 priority |= SYSLOG_FACILITY;
 783
 784                 va_start(ap, format_str);
 785                 ret = vasprintf(&msgbuf, format_str, ap);
 786                 va_end(ap);
 787
 788                 if (ret != -1) {
 789                         syslog(priority, "%s", msgbuf);
 790                 }
 791                 SAFE_FREE(msgbuf);
 792         }
 793 #endif
 794
 795         check_log_size();
 796
 797 #ifdef WITH_SYSLOG
 798         if( !state.settings.syslog_only)
 799 #endif
 800         {
 801                 va_start( ap, format_str );
 802                 if (state.fd > 0)
 803                         (void)vdprintf( state.fd, format_str, ap );
 804                 va_end( ap );
 805         }
 806
 807  done:
 808         errno = old_errno;
 809
 810         return( 0 );
 811 }
 812
 813
 814 /**************************************************************************
 815  Print the buffer content via Debug1(), then reset the buffer.
 816  Input:  none
 817  Output: none
 818 ****************************************************************************/
 819
 820 static void bufr_print( void )
 821 {
 822         format_bufr[format_pos] = '\0';
 823         (void)Debug1( "%s", format_bufr );
 824         format_pos = 0;
 825 }
 826
 827 /***************************************************************************
 828  Format the debug message text.
 829
 830  Input:  msg - Text to be added to the "current" debug message text.
 831
 832  Output: none.
 833
 834  Notes:  The purpose of this is two-fold.  First, each call to syslog()
 835          (used by Debug1(), see above) generates a new line of syslog
 836          output.  This is fixed by storing the partial lines until the
 837          newline character is encountered.  Second, printing the debug
 838          message lines when a newline is encountered allows us to add
 839          spaces, thus indenting the body of the message and making it
 840          more readable.
 841 **************************************************************************/
 842
 843 static void format_debug_text( const char *msg )
 844 {
 845         size_t i;
 846         bool timestamp = (state.logtype == DEBUG_FILE && (state.settings.timestamp_logs));
 847
 848         if (!format_bufr) {
 849                 debug_init();
 850         }
 851
 852         for( i = 0; msg[i]; i++ ) {
 853                 /* Indent two spaces at each new line. */
 854                 if(timestamp && 0 == format_pos) {
 855                         format_bufr[0] = format_bufr[1] = ' ';
 856                         format_pos = 2;
 857                 }
 858
 859                 /* If there's room, copy the character to the format buffer. */
 860                 if( format_pos < FORMAT_BUFR_MAX )
 861                         format_bufr[format_pos++] = msg[i];
 862
 863                 /* If a newline is encountered, print & restart. */
 864                 if( '\n' == msg[i] )
 865                         bufr_print();
 866
 867                 /* If the buffer is full dump it out, reset it, and put out a line
 868                  * continuation indicator.
 869                  */
 870                 if( format_pos >= FORMAT_BUFR_MAX ) {
 871                         bufr_print();
 872                         (void)Debug1( " +>\n" );
 873                 }
 874         }
 875
 876         /* Just to be safe... */
 877         format_bufr[format_pos] = '\0';
 878 }
 879
 880 /***************************************************************************
 881  Flush debug output, including the format buffer content.
 882
 883  Input:  none
 884  Output: none
 885 ***************************************************************************/
 886
 887 void dbgflush( void )
 888 {
 889         bufr_print();
 890 }
 891
 892 /***************************************************************************
 893  Print a Debug Header.
 894
 895  Input:  level - Debug level of the message (not the system-wide debug
 896                   level. )
 897           cls   - Debuglevel class of the calling module.
 898           file  - Pointer to a string containing the name of the file
 899                   from which this function was called, or an empty string
 900                   if the __FILE__ macro is not implemented.
 901           func  - Pointer to a string containing the name of the function
 902                   from which this function was called, or an empty string
 903                   if the __FUNCTION__ macro is not implemented.
 904          line  - line number of the call to dbghdr, assuming __LINE__
 905                  works.
 906
 907   Output: Always true.  This makes it easy to fudge a call to dbghdr()
 908           in a macro, since the function can be called as part of a test.
 909           Eg: ( (level <= DEBUGLEVEL) && (dbghdr(level,"",line)) )
 910
 911   Notes:  This function takes care of setting syslog_level.
 912
 913 ****************************************************************************/
 914
 915 bool dbghdrclass(int level, int cls, const char *location, const char *func)
 916 {
 917         /* Ensure we don't lose any real errno value. */
 918         int old_errno = errno;
 919
 920         if( format_pos ) {
 921                 /* This is a fudge.  If there is stuff sitting in the format_bufr, then
 922                  * the *right* thing to do is to call
 923                  *   format_debug_text( "\n" );
 924                  * to write the remainder, and then proceed with the new header.
 925                  * Unfortunately, there are several places in the code at which
 926                  * the DEBUG() macro is used to build partial lines.  That in mind,
 927                  * we'll work under the assumption that an incomplete line indicates
 928                  * that a new header is *not* desired.
 929                  */
 930                 return( true );
 931         }
 932
 933 #ifdef WITH_SYSLOG
 934         /* Set syslog_level. */
 935         syslog_level = level;
 936 #endif
 937
 938         /* Don't print a header if we're logging to stdout. */
 939         if ( state.logtype != DEBUG_FILE ) {
 940                 return( true );
 941         }
 942
 943         /* Print the header if timestamps are turned on.  If parameters are
 944          * not yet loaded, then default to timestamps on.
 945          */
 946         if( state.settings.timestamp_logs || state.settings.debug_prefix_timestamp) {
 947                 char header_str[200];
 948
 949                 header_str[0] = '\0';
 950
 951                 if (level >= 10 && state.settings.debug_pid)
 952                         slprintf(header_str,sizeof(header_str)-1,", pid=%u",(unsigned int)getpid());
 953
 954                 if (level >= 10 && state.settings.debug_uid) {
 955                         size_t hs_len = strlen(header_str);
 956                         slprintf(header_str + hs_len,
 957                         sizeof(header_str) - 1 - hs_len,
 958                                 ", effective(%u, %u), real(%u, %u)",
 959                                 (unsigned int)geteuid(), (unsigned int)getegid(),
 960                                 (unsigned int)getuid(), (unsigned int)getgid());
 961                 }
 962
 963                 if (level >= 10 && state.settings.debug_class && (cls != DBGC_ALL)) {
 964                         size_t hs_len = strlen(header_str);
 965                         slprintf(header_str + hs_len,
 966                                  sizeof(header_str) -1 - hs_len,
 967                                  ", class=%s",
 968                                  default_classname_table[cls]);
 969                 }
 970
 971                 /* Print it all out at once to prevent split syslog output. */
 972                 if( state.settings.debug_prefix_timestamp ) {
 973                         char *time_str = current_timestring(NULL,
 974                                                             state.settings.debug_hires_timestamp);
 975                         (void)Debug1( "[%s, %2d%s] ",
 976                                       time_str,
 977                                       level, header_str);
 978                         talloc_free(time_str);
 979                 } else {
 980                         char *time_str = current_timestring(NULL,
 981                                                             state.settings.debug_hires_timestamp);
 982                         (void)Debug1( "[%s, %2d%s] %s(%s)\n",
 983                                       time_str,
 984                                       level, header_str, location, func );
 985                         talloc_free(time_str);
 986                 }
 987         }
 988
 989         errno = old_errno;
 990         return( true );
 991 }
 992
 993 /***************************************************************************
 994  Add text to the body of the "current" debug message via the format buffer.
 995
 996   Input:  format_str  - Format string, as used in printf(), et. al.
 997           ...         - Variable argument list.
 998
 999   ..or..  va_alist    - Old style variable parameter list starting point.
1000
1001   Output: Always true.  See dbghdr() for more info, though this is not
1002           likely to be used in the same way.
1003
1004 ***************************************************************************/
1005
1006  bool dbgtext( const char *format_str, ... )
1007 {
1008         va_list ap;
1009         char *msgbuf = NULL;
1010         bool ret = true;
1011         int res;
1012
1013         va_start(ap, format_str);
1014         res = vasprintf(&msgbuf, format_str, ap);
1015         va_end(ap);
1016
1017         if (res != -1) {
1018                 format_debug_text(msgbuf);
1019         } else {
1020                 ret = false;
1021         }
1022         SAFE_FREE(msgbuf);
1023         return ret;
1024 }
1025
1026
1027 /* the registered mutex handlers */
1028 static struct {
1029         const char *name;
1030         struct debug_ops ops;
1031 } debug_handlers;
1032
1033 /**
1034   log suspicious usage - print comments and backtrace
1035 */
1036 _PUBLIC_ void log_suspicious_usage(const char *from, const char *info)
1037 {
1038         if (!debug_handlers.ops.log_suspicious_usage) return;
1039
1040         debug_handlers.ops.log_suspicious_usage(from, info);
1041 }
1042
1043
1044 /**
1045   print suspicious usage - print comments and backtrace
1046 */
1047 _PUBLIC_ void print_suspicious_usage(const char* from, const char* info)
1048 {
1049         if (!debug_handlers.ops.print_suspicious_usage) return;
1050
1051         debug_handlers.ops.print_suspicious_usage(from, info);
1052 }
1053
1054 _PUBLIC_ uint32_t get_task_id(void)
1055 {
1056         if (debug_handlers.ops.get_task_id) {
1057                 return debug_handlers.ops.get_task_id();
1058         }
1059         return getpid();
1060 }
1061
1062 _PUBLIC_ void log_task_id(void)
1063 {
1064         if (!debug_handlers.ops.log_task_id) return;
1065
1066         if (!reopen_logs_internal()) return;
1067
1068         debug_handlers.ops.log_task_id(state.fd);
1069 }
1070
1071 /**
1072   register a set of debug handlers.
1073 */
1074 _PUBLIC_ void register_debug_handlers(const char *name, struct debug_ops *ops)
1075 {
1076         debug_handlers.name = name;
1077         debug_handlers.ops = *ops;
1078 }