lib/librte_eal/common/include/rte_debug.h

   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 #ifndef _RTE_DEBUG_H_
  35 #define _RTE_DEBUG_H_
  36
  37 /**
  38  * @file
  39  *
  40  * Debug Functions in RTE
  41  *
  42  * This file defines a generic API for debug operations. Part of
  43  * the implementation is architecture-specific.
  44  */
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 /**
  51  * Dump the stack of the calling core to the console.
  52  */
  53 void rte_dump_stack(void);
  54
  55 /**
  56  * Dump the registers of the calling core to the console.
  57  *
  58  * Note: Not implemented in a userapp environment; use gdb instead.
  59  */
  60 void rte_dump_registers(void);
  61
  62 /**
  63  * Provide notification of a critical non-recoverable error and terminate
  64  * execution abnormally.
  65  *
  66  * Display the format string and its expanded arguments (printf-like).
  67  *
  68  * In a linuxapp environment, this function dumps the stack and calls
  69  * abort() resulting in a core dump if enabled.
  70  *
  71  * The function never returns.
  72  *
  73  * @param format
  74  *   The format string
  75  * @param args
  76  *   The variable list of arguments.
  77  */
  78 #define rte_panic_(func, format, ...) __rte_panic(func, format "%.0s", __VA_ARGS__)
  79 #define rte_panic(...) rte_panic_(__func__, __VA_ARGS__, "dummy")
  80
  81 /*
  82  * Provide notification of a critical non-recoverable error and stop.
  83  *
  84  * This function should not be called directly. Refer to rte_panic() macro
  85  * documentation.
  86  */
  87 void __rte_panic(const char *funcname , const char *format, ...)
  88         __attribute__((cold))
  89         __attribute__((noreturn))
  90         __attribute__((format(printf, 2, 3)));
  91
  92 #ifdef __cplusplus
  93 }
  94 #endif
  95
  96 #endif /* _RTE_DEBUG_H_ */