log: deprecate history dump
[dpdk.git] / lib / librte_eal / bsdapp / eal / eal_debug.c
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #include <execinfo.h>
35 #include <stdarg.h>
36 #include <signal.h>
37 #include <stdlib.h>
38 #include <stdio.h>
39 #include <stdint.h>
40
41 #include <rte_log.h>
42 #include <rte_debug.h>
43 #include <rte_common.h>
44
45 #define BACKTRACE_SIZE 256
46
47 /* dump the stack of the calling core */
48 void rte_dump_stack(void)
49 {
50         void *func[BACKTRACE_SIZE];
51         char **symb = NULL;
52         int size;
53
54         size = backtrace(func, BACKTRACE_SIZE);
55         symb = backtrace_symbols(func, size);
56
57         if (symb == NULL)
58                 return;
59
60         while (size > 0) {
61                 rte_log(RTE_LOG_ERR, RTE_LOGTYPE_EAL,
62                         "%d: [%s]\n", size, symb[size - 1]);
63                 size --;
64         }
65
66         free(symb);
67 }
68
69 /* not implemented in this environment */
70 void rte_dump_registers(void)
71 {
72         return;
73 }
74
75 /* call abort(), it will generate a coredump if enabled */
76 void __rte_panic(const char *funcname, const char *format, ...)
77 {
78         va_list ap;
79
80         rte_log(RTE_LOG_CRIT, RTE_LOGTYPE_EAL, "PANIC in %s():\n", funcname);
81         va_start(ap, format);
82         rte_vlog(RTE_LOG_CRIT, RTE_LOGTYPE_EAL, format, ap);
83         va_end(ap);
84         rte_dump_stack();
85         rte_dump_registers();
86         abort();
87 }
88
89 /*
90  * Like rte_panic this terminates the application. However, no traceback is
91  * provided and no core-dump is generated.
92  */
93 void
94 rte_exit(int exit_code, const char *format, ...)
95 {
96         va_list ap;
97
98         if (exit_code != 0)
99                 RTE_LOG(CRIT, EAL, "Error - exiting with code: %d\n"
100                                 "  Cause: ", exit_code);
101
102         va_start(ap, format);
103         rte_vlog(RTE_LOG_CRIT, RTE_LOGTYPE_EAL, format, ap);
104         va_end(ap);
105
106 #ifndef RTE_EAL_ALWAYS_PANIC_ON_ERROR
107         exit(exit_code);
108 #else
109         rte_dump_stack();
110         rte_dump_registers();
111         abort();
112 #endif
113 }