first public release
[dpdk.git] / lib / librte_eal / linuxapp / eal / eal_debug.c
1 /*-
2  *   BSD LICENSE
3  * 
4  *   Copyright(c) 2010-2012 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  *  version: DPDK.L.1.2.3-3
34  */
35
36 #include <execinfo.h>
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         void *func[BACKTRACE_SIZE];
53         char **symb = NULL;
54         int size;
55
56         size = backtrace(func, BACKTRACE_SIZE);
57         symb = backtrace_symbols(func, size);
58         while (size > 0) {
59                 rte_log(RTE_LOG_ERR, RTE_LOGTYPE_EAL,
60                         "%d: [%s]\n", size, symb[size - 1]);
61                 size --;
62         }
63 }
64
65 /* not implemented in this environment */
66 void rte_dump_registers(void)
67 {
68         return;
69 }
70
71 /* call abort(), it will generate a coredump if enabled */
72 void __rte_panic(const char *funcname, const char *format, ...)
73 {
74         va_list ap;
75
76         /* disable history */
77         rte_log_set_history(0);
78
79         rte_log(RTE_LOG_CRIT, RTE_LOGTYPE_EAL, "PANIC in %s():\n", funcname);
80         va_start(ap, format);
81         rte_vlog(RTE_LOG_CRIT, RTE_LOGTYPE_EAL, format, ap);
82         va_end(ap);
83         rte_dump_stack();
84         rte_dump_registers();
85         abort();
86 }
87
88 /*
89  * Like rte_panic this terminates the application. However, no traceback is
90  * provided and no core-dump is generated.
91  */
92 void
93 rte_exit(int exit_code, const char *format, ...)
94 {
95         va_list ap;
96
97         /* disable history */
98         rte_log_set_history(0);
99
100         if (exit_code != 0)
101                 RTE_LOG(CRIT, EAL, "Error - exiting with code: %d\nCause: ", exit_code);
102
103         va_start(ap, format);
104         rte_vlog(RTE_LOG_CRIT, RTE_LOGTYPE_EAL, format, ap);
105         va_end(ap);
106
107 #ifndef RTE_EAL_ALWAYS_PANIC_ON_ERROR
108         exit(exit_code);
109 #else
110         rte_dump_stack();
111         rte_dump_registers();
112         abort();
113 #endif
114 }