4 * DEBUG: section 00 Debug Routines
5 * AUTHOR: Harvest Derived
7 * SQUID Web Proxy Cache http://www.squid-cache.org/
8 * ----------------------------------------------------------
10 * Squid is the result of efforts by numerous individuals from
11 * the Internet community; see the CONTRIBUTORS file for full
12 * details. Many organizations have provided support for Squid's
13 * development; see the SPONSORS file for full details. Squid is
14 * Copyrighted (C) 2001 by the Regents of the University of
15 * California; see the COPYRIGHT file for full details. Squid
16 * incorporates software developed and/or copyrighted by other
17 * sources; see the CREDITS file for full details.
19 * This program is free software; you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation; either version 2 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program; if not, write to the Free Software
31 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
37 #include "SquidTime.h"
41 /* for shutting_down flag in xassert() */
44 char *Debug::debugOptions
= NULL
;
45 int Debug::override_X
= 0;
46 int Debug::log_stderr
= -1;
47 bool Debug::log_syslog
= false;
48 int Debug::Levels
[MAX_DEBUG_SECTIONS
];
50 char *Debug::cache_log
= NULL
;
51 int Debug::rotateNumber
= -1;
52 FILE *debug_log
= NULL
;
53 static char *debug_log_file
= NULL
;
54 static int Ctx_Lock
= 0;
55 static const char *debugLogTime(void);
56 static const char *debugLogKid(void);
57 static void ctx_print(void);
60 static int syslog_facility
= 0;
62 static void _db_print_syslog(const char *format
, va_list args
);
64 static void _db_print_stderr(const char *format
, va_list args
);
65 static void _db_print_file(const char *format
, va_list args
);
68 SQUIDCEXTERN LPCRITICAL_SECTION dbg_mutex
;
69 typedef BOOL (WINAPI
* PFInitializeCriticalSectionAndSpinCount
) (LPCRITICAL_SECTION
, DWORD
);
73 _db_print(const char *format
,...)
82 /* Multiple WIN32 threads may call this simultaneously */
85 HMODULE krnl_lib
= GetModuleHandle("Kernel32");
86 PFInitializeCriticalSectionAndSpinCount InitializeCriticalSectionAndSpinCount
= NULL
;
89 InitializeCriticalSectionAndSpinCount
=
90 (PFInitializeCriticalSectionAndSpinCount
) GetProcAddress(krnl_lib
,
91 "InitializeCriticalSectionAndSpinCount");
93 dbg_mutex
= static_cast<CRITICAL_SECTION
*>(xcalloc(1, sizeof(CRITICAL_SECTION
)));
95 if (InitializeCriticalSectionAndSpinCount
) {
96 /* let multiprocessor systems EnterCriticalSection() fast */
98 if (!InitializeCriticalSectionAndSpinCount(dbg_mutex
, 4000)) {
100 fprintf(debug_log
, "FATAL: _db_print: can't initialize critical section\n");
104 fprintf(stderr
, "FATAL: _db_print: can't initialize critical section\n");
107 InitializeCriticalSection(dbg_mutex
);
111 EnterCriticalSection(dbg_mutex
);
114 /* give a chance to context-based debugging to print current context */
118 va_start(args1
, format
);
119 va_start(args2
, format
);
120 va_start(args3
, format
);
122 snprintf(f
, BUFSIZ
, "%s%s| %s",
127 _db_print_file(f
, args1
);
128 _db_print_stderr(f
, args2
);
131 _db_print_syslog(format
, args3
);
135 LeaveCriticalSection(dbg_mutex
);
144 _db_print_file(const char *format
, va_list args
)
146 if (debug_log
== NULL
)
149 /* give a chance to context-based debugging to print current context */
153 vfprintf(debug_log
, format
, args
);
158 _db_print_stderr(const char *format
, va_list args
)
160 if (Debug::log_stderr
< Debug::level
)
163 if (debug_log
== stderr
)
166 vfprintf(stderr
, format
, args
);
171 _db_print_syslog(const char *format
, va_list args
)
173 /* level 0,1 go to syslog */
175 if (Debug::level
> 1)
178 if (!Debug::log_syslog
)
184 vsnprintf(tmpbuf
, BUFSIZ
, format
, args
);
186 tmpbuf
[BUFSIZ
- 1] = '\0';
188 syslog(Debug::level
== 0 ? LOG_WARNING
: LOG_NOTICE
, "%s", tmpbuf
);
190 #endif /* HAVE_SYSLOG */
193 debugArg(const char *arg
)
199 if (!strncasecmp(arg
, "rotate=", 7)) {
201 Debug::rotateNumber
= atoi(arg
);
203 } else if (!strncasecmp(arg
, "ALL", 3)) {
208 while (*arg
&& *arg
++ != ',');
214 if (s
>= MAX_DEBUG_SECTIONS
)
215 s
= MAX_DEBUG_SECTIONS
-1;
224 Debug::Levels
[s
] = l
;
228 for (i
= 0; i
< MAX_DEBUG_SECTIONS
; i
++)
229 Debug::Levels
[i
] = l
;
233 debugOpenLog(const char *logfile
)
235 if (logfile
== NULL
) {
241 xfree(debug_log_file
);
243 debug_log_file
= xstrdup(logfile
); /* keep a static copy */
245 if (debug_log
&& debug_log
!= stderr
)
248 debug_log
= fopen(logfile
, "a+");
251 fprintf(stderr
, "WARNING: Cannot write log file: %s\n", logfile
);
253 fprintf(stderr
, " messages will be sent to 'stderr'.\n");
259 setmode(fileno(debug_log
), O_TEXT
);
266 static struct syslog_facility_name
{
271 syslog_facility_names
[] = {
280 "authpriv", LOG_AUTHPRIV
381 _db_set_syslog(const char *facility
)
383 Debug::log_syslog
= true;
388 syslog_facility
= LOG_DAEMON
;
391 syslog_facility
= LOG_LOCAL4
;
392 #endif /* LOG_DAEMON */
396 struct syslog_facility_name
*n
;
398 for (n
= syslog_facility_names
; n
->name
; n
++) {
399 if (strcmp(n
->name
, facility
) == 0) {
400 syslog_facility
= n
->facility
;
405 fprintf(stderr
, "unknown syslog facility '%s'\n", facility
);
411 fprintf(stderr
, "syslog facility type not supported on your system\n");
413 #endif /* LOG_LOCAL4 */
419 Debug::parseOptions(char const *options
)
426 debugs(0, 9, "command-line -X overrides: " << options
);
430 for (i
= 0; i
< MAX_DEBUG_SECTIONS
; i
++)
431 Debug::Levels
[i
] = 0;
434 p
= xstrdup(options
);
436 for (s
= strtok(p
, w_space
); s
; s
= strtok(NULL
, w_space
))
444 _db_init(const char *logfile
, const char *options
)
446 Debug::parseOptions(options
);
448 debugOpenLog(logfile
);
450 #if HAVE_SYSLOG && defined(LOG_LOCAL4)
452 if (Debug::log_syslog
)
453 openlog(APP_SHORTNAME
, LOG_PID
| LOG_NDELAY
| LOG_CONS
, syslog_facility
);
455 #endif /* HAVE_SYSLOG */
457 /* Pre-Init TZ env, see bug #2656 */
464 if (debug_log_file
== NULL
)
469 if (stat(debug_log_file
, &sb
) == 0)
470 if (S_ISREG(sb
.st_mode
) == 0)
474 char from
[MAXPATHLEN
];
481 * NOTE: we cannot use xrename here without having it in a
482 * separate file -- tools.c has too many dependencies to be
483 * used everywhere debug.c is used.
485 /* Rotate numbers 0 through N up one */
486 for (int i
= Debug::rotateNumber
; i
> 1;) {
488 snprintf(from
, MAXPATHLEN
, "%s.%d", debug_log_file
, i
- 1);
489 snprintf(to
, MAXPATHLEN
, "%s.%d", debug_log_file
, i
);
498 * You can't rename open files on Microsoft "operating systems"
499 * so we close before renaming.
502 if (debug_log
!= stderr
)
505 /* Rotate the current log to .0 */
506 if (Debug::rotateNumber
> 0) {
507 snprintf(to
, MAXPATHLEN
, "%s.%d", debug_log_file
, 0);
512 rename(debug_log_file
, to
);
515 /* Close and reopen the log. It may have been renamed "manually"
516 * before HUP'ing us. */
517 if (debug_log
!= stderr
)
518 debugOpenLog(Debug::cache_log
);
525 time_t t
= getCurrentTime();
528 static char buf
[128];
529 static time_t last_t
= 0;
531 if (Debug::level
> 1) {
534 strftime(buf2
, 127, "%Y/%m/%d %H:%M:%S", tm
);
536 snprintf(buf
, 127, "%s.%03d", buf2
, (int) current_time
.tv_usec
/ 1000);
538 } else if (t
!= last_t
) {
540 strftime(buf
, 127, "%Y/%m/%d %H:%M:%S", tm
);
551 if (KidIdentifier
!= 0) {
553 if (!*buf
) // optimization: fill only once after KidIdentifier is set
554 snprintf(buf
, sizeof(buf
), " kid%d", KidIdentifier
);
562 xassert(const char *msg
, const char *file
, int line
)
564 debugs(0, 0, "assertion failed: " << file
<< ":" << line
<< ": \"" << msg
<< "\"");
571 * Context-based Debugging
576 * When you have a long nested processing sequence, it is often impossible
577 * for low level routines to know in what larger context they operate. If a
578 * routine coredumps, one can restore the context using debugger trace.
579 * However, in many case you do not want to coredump, but just want to report
580 * a potential problem. A report maybe useless out of problem context.
582 * To solve this potential problem, use the following approach:
585 * top_level_foo(const char *url)
587 * // define current context
588 * // note: we stack but do not dup ctx descriptions!
589 * Ctx ctx = ctx_enter(url);
591 * // go down; middle_level_bar will eventually call bottom_level_boo
592 * middle_level_bar(method, protocol);
594 * // exit, clean after yourself
599 * bottom_level_boo(int status, void *data)
601 * // detect exceptional condition, and simply report it, the context
602 * // information will be available somewhere close in the log file
603 * if (status == STRANGE_STATUS)
604 * debugs(13, 6, "DOS attack detected, data: " << data);
608 * Current implementation is extremely simple but still very handy. It has a
609 * negligible overhead (descriptions are not duplicated).
611 * When the _first_ debug message for a given context is printed, it is
612 * prepended with the current context description. Context is printed with
613 * the same debugging level as the original message.
615 * Note that we do not print context every type you do ctx_enter(). This
616 * approach would produce too many useless messages. For the same reason, a
617 * context description is printed at most _once_ even if you have 10
618 * debugging messages within one context.
620 * Contexts can be nested, of course. You must use ctx_enter() to enter a
621 * context (push it onto stack). It is probably safe to exit several nested
622 * contexts at _once_ by calling ctx_exit() at the top level (this will pop
623 * all context till current one). However, as in any stack, you cannot start
627 * i) locate debugging message,
628 * ii) locate current context by going _upstream_ in your log file,
635 * decide if we want to dup() descriptions (adds overhead) but allows to
636 * add printf()-style interface
641 * descriptions for contexts over CTX_MAX_LEVEL limit are ignored, you probably
642 * have a bug if your nesting goes that deep.
645 #define CTX_MAX_LEVEL 255
648 * produce a warning when nesting reaches this level and then double
651 static int Ctx_Warn_Level
= 32;
652 /* all descriptions has been printed up to this level */
653 static int Ctx_Reported_Level
= -1;
654 /* descriptions are still valid or active up to this level */
655 static int Ctx_Valid_Level
= -1;
656 /* current level, the number of nested ctx_enter() calls */
657 static int Ctx_Current_Level
= -1;
658 /* saved descriptions (stack) */
659 static const char *Ctx_Descrs
[CTX_MAX_LEVEL
+ 1];
660 /* "safe" get secription */
661 static const char *ctx_get_descr(Ctx ctx
);
665 ctx_enter(const char *descr
)
669 if (Ctx_Current_Level
<= CTX_MAX_LEVEL
)
670 Ctx_Descrs
[Ctx_Current_Level
] = descr
;
672 if (Ctx_Current_Level
== Ctx_Warn_Level
) {
673 debugs(0, 0, "# ctx: suspiciously deep (" << Ctx_Warn_Level
<< ") nesting:");
677 return Ctx_Current_Level
;
684 Ctx_Current_Level
= (ctx
>= 0) ? ctx
- 1 : -1;
686 if (Ctx_Valid_Level
> Ctx_Current_Level
)
687 Ctx_Valid_Level
= Ctx_Current_Level
;
691 * the idea id to print each context description at most once but provide enough
692 * info for deducing the current execution stack
697 /* lock so _db_print will not call us recursively */
699 /* ok, user saw [0,Ctx_Reported_Level] descriptions */
700 /* first inform about entries popped since user saw them */
702 if (Ctx_Valid_Level
< Ctx_Reported_Level
) {
703 if (Ctx_Reported_Level
!= Ctx_Valid_Level
+ 1)
704 _db_print("ctx: exit levels from %2d down to %2d\n",
705 Ctx_Reported_Level
, Ctx_Valid_Level
+ 1);
707 _db_print("ctx: exit level %2d\n", Ctx_Reported_Level
);
709 Ctx_Reported_Level
= Ctx_Valid_Level
;
712 /* report new contexts that were pushed since last report */
713 while (Ctx_Reported_Level
< Ctx_Current_Level
) {
714 Ctx_Reported_Level
++;
716 _db_print("ctx: enter level %2d: '%s'\n", Ctx_Reported_Level
,
717 ctx_get_descr(Ctx_Reported_Level
));
724 /* checks for nulls and overflows */
726 ctx_get_descr(Ctx ctx
)
728 if (ctx
< 0 || ctx
> CTX_MAX_LEVEL
)
731 return Ctx_Descrs
[ctx
] ? Ctx_Descrs
[ctx
] : "<null>";
734 int Debug::TheDepth
= 0;
739 assert(TheDepth
>= 0);
742 assert(CurrentDebug
);
743 *CurrentDebug
<< std::endl
<< "reentrant debuging " << TheDepth
<< "-{";
745 assert(!CurrentDebug
);
746 CurrentDebug
= new std::ostringstream();
747 // set default formatting flags
748 CurrentDebug
->setf(std::ios::fixed
);
749 CurrentDebug
->precision(2);
751 return *CurrentDebug
;
757 assert(TheDepth
>= 0);
758 assert(CurrentDebug
);
760 *CurrentDebug
<< "}-" << TheDepth
<< std::endl
;
762 assert(TheDepth
== 1);
763 _db_print("%s\n", CurrentDebug
->str().c_str());
770 // Hack: replaces global ::xassert() to debug debugging assertions
771 // Relies on assert macro calling xassert() without a specific scope.
773 Debug::xassert(const char *msg
, const char *file
, int line
)
777 *CurrentDebug
<< "assertion failed: " << file
<< ":" << line
<<
778 ": \"" << msg
<< "\"";
783 std::ostringstream (*Debug::CurrentDebug
)(NULL
);
788 // XXX: This must be kept in sync with the actual debug.cc location
789 const char *ThisFileNameTail
= "src/debug.cc";
791 const char *file
=__FILE__
;
793 // Disable heuristic if it does not work.
794 if (!strstr(file
, ThisFileNameTail
))
797 return strlen(file
)-strlen(ThisFileNameTail
);
801 SkipBuildPrefix(const char* path
)
803 static const size_t BuildPrefixLength
= BuildPrefixInit();
805 return path
+BuildPrefixLength
;