lib/librte_eal/common/include/rte_debug.h

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