e1c7554826e55e7d9b6a6038973eb71e9ab49c53
[deb_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 #ifdef RTE_BACKTRACE
35 #include <execinfo.h>
36 #endif
37 #include <stdarg.h>
38 #include <signal.h>
39 #include <stdlib.h>
40 #include <stdio.h>
41 #include <stdint.h>
42
43 #include <rte_log.h>
44 #include <rte_debug.h>
45 #include <rte_common.h>
46
47 #define BACKTRACE_SIZE 256
48
49 /* dump the stack of the calling core */
50 void rte_dump_stack(void)
51 {
52 #ifdef RTE_BACKTRACE
53         void *func[BACKTRACE_SIZE];
54         char **symb = NULL;
55         int size;
56
57         size = backtrace(func, BACKTRACE_SIZE);
58         symb = backtrace_symbols(func, size);
59
60         if (symb == NULL)
61                 return;
62
63         while (size > 0) {
64                 rte_log(RTE_LOG_ERR, RTE_LOGTYPE_EAL,
65                         "%d: [%s]\n", size, symb[size - 1]);
66                 size --;
67         }
68
69         free(symb);
70 #endif /* RTE_BACKTRACE */
71 }
72
73 /* not implemented in this environment */
74 void rte_dump_registers(void)
75 {
76         return;
77 }
78
79 /* call abort(), it will generate a coredump if enabled */
80 void __rte_panic(const char *funcname, const char *format, ...)
81 {
82         va_list ap;
83
84         rte_log(RTE_LOG_CRIT, RTE_LOGTYPE_EAL, "PANIC in %s():\n", funcname);
85         va_start(ap, format);
86         rte_vlog(RTE_LOG_CRIT, RTE_LOGTYPE_EAL, format, ap);
87         va_end(ap);
88         rte_dump_stack();
89         rte_dump_registers();
90         abort();
91 }
92
93 /*
94  * Like rte_panic this terminates the application. However, no traceback is
95  * provided and no core-dump is generated.
96  */
97 void
98 rte_exit(int exit_code, const char *format, ...)
99 {
100         va_list ap;
101
102         if (exit_code != 0)
103                 RTE_LOG(CRIT, EAL, "Error - exiting with code: %d\n"
104                                 "  Cause: ", exit_code);
105
106         va_start(ap, format);
107         rte_vlog(RTE_LOG_CRIT, RTE_LOGTYPE_EAL, format, ap);
108         va_end(ap);
109
110 #ifndef RTE_EAL_ALWAYS_PANIC_ON_ERROR
111         exit(exit_code);
112 #else
113         rte_dump_stack();
114         rte_dump_registers();
115         abort();
116 #endif
117 }