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