lib/librte_eal/linuxapp/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         /* disable history */
  81         rte_log_set_history(0);
  82
  83         rte_log(RTE_LOG_CRIT, RTE_LOGTYPE_EAL, "PANIC in %s():\n", funcname);
  84         va_start(ap, format);
  85         rte_vlog(RTE_LOG_CRIT, RTE_LOGTYPE_EAL, format, ap);
  86         va_end(ap);
  87         rte_dump_stack();
  88         rte_dump_registers();
  89         abort();
  90 }
  91
  92 /*
  93  * Like rte_panic this terminates the application. However, no traceback is
  94  * provided and no core-dump is generated.
  95  */
  96 void
  97 rte_exit(int exit_code, const char *format, ...)
  98 {
  99         va_list ap;
 100
 101         /* disable history */
 102         rte_log_set_history(0);
 103
 104         if (exit_code != 0)
 105                 RTE_LOG(CRIT, EAL, "Error - exiting with code: %d\n"
 106                                 "  Cause: ", exit_code);
 107
 108         va_start(ap, format);
 109         rte_vlog(RTE_LOG_CRIT, RTE_LOGTYPE_EAL, format, ap);
 110         va_end(ap);
 111
 112 #ifndef RTE_EAL_ALWAYS_PANIC_ON_ERROR
 113         exit(exit_code);
 114 #else
 115         rte_dump_stack();
 116         rte_dump_registers();
 117         abort();
 118 #endif
 119 }