2 Unix SMB/CIFS implementation.
3 Critical Fault handling
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Tim Prouty 2009
6 Copyright (C) James Peach 2006
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.
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.
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/>.
23 #include "system/filesys.h"
24 #include "system/wait.h"
27 #ifdef HAVE_SYS_SYSCTL_H
28 #include <sys/sysctl.h>
32 #ifdef HAVE_SYS_PRCTL_H
33 #include <sys/prctl.h>
37 #include "lib/util/signal.h" /* Avoid /usr/include/signal.h */
39 #include "util_process.h"
43 smb_panic_handler_t panic_handler;
47 /*******************************************************************
48 setup variables used for fault handling
49 ********************************************************************/
50 void fault_configure(smb_panic_handler_t panic_handler)
52 fault_state.panic_handler = panic_handler;
57 disable setting up fault handlers
58 This is used for the bind9 dlz module, as we
59 don't want a Samba module in bind9 to override the bind
62 _PUBLIC_ void fault_setup_disable(void)
64 fault_state.disabled = true;
68 #if !defined(HAVE_DISABLE_FAULT_HANDLING)
69 /*******************************************************************
71 ********************************************************************/
72 static void fault_report(int sig)
75 char signal_string[128];
77 if (counter) _exit(1);
81 snprintf(signal_string, sizeof(signal_string),
82 "Signal %d: %s", sig, strsignal(sig));
83 smb_panic(signal_string);
85 /* smb_panic() never returns, so this is really redundant */
89 /****************************************************************************
91 ****************************************************************************/
92 static void sig_fault(int sig)
97 /*******************************************************************
98 setup our fault handlers
99 ********************************************************************/
100 void fault_setup(void)
102 if (fault_state.disabled) {
105 #if !defined(HAVE_DISABLE_FAULT_HANDLING)
107 CatchSignal(SIGSEGV, sig_fault);
110 CatchSignal(SIGBUS, sig_fault);
113 CatchSignal(SIGABRT, sig_fault);
118 _PUBLIC_ const char *panic_action = NULL;
121 default smb_panic() implementation
123 static void smb_panic_default(const char *why) _NORETURN_;
124 static void smb_panic_default(const char *why)
126 #if defined(HAVE_PRCTL) && defined(PR_SET_PTRACER)
128 * Make sure all children can attach a debugger.
130 prctl(PR_SET_PTRACER, getpid(), 0, 0, 0);
133 if (panic_action && *panic_action) {
135 if (strlcpy(cmdstring, panic_action, sizeof(cmdstring)) < sizeof(cmdstring)) {
140 snprintf(pidstr, sizeof(pidstr), "%d", (int) getpid());
142 p = strstr(cmdstring, "%d");
151 strlcpy(cmdstring, subst, sizeof(cmdstring));
154 DEBUG(0, ("smb_panic(): calling panic action [%s]\n", cmdstring));
155 result = system(cmdstring);
158 DEBUG(0, ("smb_panic(): fork failed in panic action: %s\n",
161 DEBUG(0, ("smb_panic(): action returned status %d\n",
162 WEXITSTATUS(result)));
167 CatchSignal(SIGABRT, SIG_DFL);
172 _PUBLIC_ void smb_panic_log(const char *why)
174 const char *binary_name = process_get_saved_binary_name();
175 const char *short_title = process_get_short_title();
176 const char *long_title = process_get_long_title();
179 DEBUG(0,("INTERNAL ERROR: %s in %s (%s) (%s) pid %lld (%s)\n",
184 (unsigned long long)getpid(),
185 SAMBA_VERSION_STRING));
186 DEBUG(0,("If you are running a recent Samba version, and "
187 "if you think this problem is not yet fixed in the "
188 "latest versions, please consider reporting this "
190 "https://wiki.samba.org/index.php/Bug_Reporting\n"));
192 DEBUG(0,("PANIC (pid %llu): %s in " SAMBA_VERSION_STRING "\n",
193 (unsigned long long)getpid(), why));
199 Something really nasty happened - panic !
201 This function is in this file to allow sharing the last set process
202 title into the logs before the backtrace
204 _PUBLIC_ void smb_panic(const char *why)
208 if (fault_state.panic_handler) {
209 fault_state.panic_handler(why);
212 smb_panic_default(why);
215 /*******************************************************************
216 Print a backtrace of the stack to the debug log. This function
217 DELIBERATELY LEAKS MEMORY. The expectation is that you should
218 exit shortly after calling it.
219 ********************************************************************/
221 /* Buffer size to use when printing backtraces */
222 #define BACKTRACE_STACK_SIZE 64
225 #ifdef HAVE_LIBUNWIND_H
226 #include <libunwind.h>
229 #ifdef HAVE_EXECINFO_H
230 #include <execinfo.h>
233 void log_stack_trace(void)
235 #ifdef HAVE_LIBUNWIND
237 * --with-libunwind is required to use libunwind, the
238 * backtrace_symbols() code below is the default.
240 * This code is available because a previous version of this
241 * comment asserted that on ia64 libunwind correctly walks the
242 * stack in more circumstances than backtrace.
249 unw_word_t ip, sp, off;
251 procname[sizeof(procname) - 1] = '\0';
253 if (unw_getcontext(&uc) != 0) {
254 goto libunwind_failed;
257 if (unw_init_local(&cursor, &uc) != 0) {
258 goto libunwind_failed;
261 DEBUG(0, ("BACKTRACE:\n"));
265 unw_get_reg(&cursor, UNW_REG_IP, &ip);
266 unw_get_reg(&cursor, UNW_REG_SP, &sp);
268 switch (unw_get_proc_name(&cursor,
269 procname, sizeof(procname) - 1, &off) ) {
273 /* Name truncated. */
274 DEBUGADD(0, (" #%u %s + %#llx [ip=%#llx] [sp=%#llx]\n",
275 i, procname, (long long)off,
276 (long long)ip, (long long) sp));
279 /* case -UNW_ENOINFO: */
280 /* case -UNW_EUNSPEC: */
281 /* No symbol name found. */
282 DEBUGADD(0, (" #%u %s [ip=%#llx] [sp=%#llx]\n",
283 i, "<unknown symbol>",
284 (long long)ip, (long long) sp));
287 } while (unw_step(&cursor) > 0);
292 DEBUG(0, ("unable to produce a stack trace with libunwind\n"));
294 #elif defined(HAVE_BACKTRACE_SYMBOLS)
295 void *backtrace_stack[BACKTRACE_STACK_SIZE];
296 size_t backtrace_size;
297 char **backtrace_strings;
299 /* get the backtrace (stack frames) */
300 backtrace_size = backtrace(backtrace_stack,BACKTRACE_STACK_SIZE);
301 backtrace_strings = backtrace_symbols(backtrace_stack, backtrace_size);
303 DEBUG(0, ("BACKTRACE: %lu stack frames:\n",
304 (unsigned long)backtrace_size));
306 if (backtrace_strings) {
309 for (i = 0; i < backtrace_size; i++)
310 DEBUGADD(0, (" #%zu %s\n", i, backtrace_strings[i]));
312 /* Leak the backtrace_strings, rather than risk what free() might do */
316 DEBUG(0, ("unable to produce a stack trace on this platform\n"));