src/vppinfra/error_bootstrap.h

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 /*
  16   Copyright (c) 2001, 2002, 2003 Eliot Dresselhaus
  17
  18   Permission is hereby granted, free of charge, to any person obtaining
  19   a copy of this software and associated documentation files (the
  20   "Software"), to deal in the Software without restriction, including
  21   without limitation the rights to use, copy, modify, merge, publish,
  22   distribute, sublicense, and/or sell copies of the Software, and to
  23   permit persons to whom the Software is furnished to do so, subject to
  24   the following conditions:
  25
  26   The above copyright notice and this permission notice shall be
  27   included in all copies or substantial portions of the Software.
  28
  29   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  30   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  31   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  32   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  33   LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  34   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  35   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  36 */
  37
  38 #ifndef included_error_bootstrap_h
  39 #define included_error_bootstrap_h
  40
  41 /* Bootstrap include so that #include <vppinfra/mem.h> can include e.g.
  42    <vppinfra/mheap.h> which depends on <vppinfra/vec.h>. */
  43
  44 #include <vppinfra/clib.h>      /* for uword */
  45
  46 enum
  47 {
  48   CLIB_ERROR_FATAL = 1 << 0,
  49   CLIB_ERROR_ABORT = 1 << 1,
  50   CLIB_ERROR_WARNING = 1 << 2,
  51   CLIB_ERROR_ERRNO_VALID = 1 << 16,
  52   CLIB_ERROR_NO_RATE_LIMIT = 1 << 17,
  53 };
  54
  55 /* Current function name.  Need (char *) cast to silence gcc4 pointer signedness warning. */
  56 #define clib_error_function ((char *) __FUNCTION__)
  57
  58 #ifndef CLIB_ASSERT_ENABLE
  59 #define CLIB_ASSERT_ENABLE (CLIB_DEBUG > 0)
  60 #endif
  61
  62 /* Low level error reporting function.
  63    Code specifies whether to call exit, abort or nothing at
  64    all (for non-fatal warnings). */
  65 extern void _clib_error (int code, const char *function_name,
  66                          uword line_number, const char *format, ...);
  67
  68 #define ASSERT(truth)                                   \
  69 do {                                                    \
  70   if (CLIB_ASSERT_ENABLE && ! (truth))                  \
  71     {                                                   \
  72       _clib_error (CLIB_ERROR_ABORT, 0, 0,              \
  73                    "%s:%d (%s) assertion `%s' fails",   \
  74                    __FILE__,                            \
  75                    (uword) __LINE__,                    \
  76                    clib_error_function,                 \
  77                    # truth);                            \
  78     }                                                   \
  79 } while (0)
  80
  81 /*
  82  * This version always generates code, and has a Coverity-specific
  83  * version to stop Coverity complaining about
  84  * ALWAYS_ASSERT(p != 0); p->member...
  85  */
  86
  87 #ifndef __COVERITY__
  88 #define ALWAYS_ASSERT(truth)                            \
  89 do {                                                    \
  90   if (PREDICT_FALSE(!(truth)))                          \
  91     {                                                   \
  92       _clib_error (CLIB_ERROR_ABORT, 0, 0,              \
  93                    "%s:%d (%s) assertion `%s' fails",   \
  94                    __FILE__,                            \
  95                    (uword) __LINE__,                    \
  96                    clib_error_function,                 \
  97                    # truth);                            \
  98     }                                                   \
  99 } while (0)
 100 #else /* __COVERITY__ */
 101 #define ALWAYS_ASSERT(truth)                    \
 102 do {                                            \
 103   if (PREDICT_FALSE(!(truth)))                  \
 104     {                                           \
 105       abort();                                  \
 106     }                                           \
 107 } while (0)
 108 #endif /* __COVERITY */
 109
 110 #define STATIC_ASSERT(truth,...) _Static_assert(truth, __VA_ARGS__)
 111
 112 #define STATIC_ASSERT_SIZEOF(d, s) \
 113   STATIC_ASSERT (sizeof (d) == s, "Size of " #d " must be " # s " bytes")
 114
 115 #define STATIC_ASSERT_SIZEOF_ELT(d, e, s) \
 116   STATIC_ASSERT (sizeof (((d *)0)->e) == s, "Size of " #d "." #e " must be " # s " bytes")
 117
 118 #define STATIC_ASSERT_OFFSET_OF(s, e, o) \
 119   STATIC_ASSERT (STRUCT_OFFSET_OF(s,e) == o, "Offset of " #s "." #e " must be " # o)
 120
 121 #define STATIC_ASSERT_FITS_IN(s, e, o) \
 122   STATIC_ASSERT (STRUCT_OFFSET_OF(s,e) <= (o - sizeof(((s *)0)->e)), \
 123   #s "." #e " does not fit into " # o " bytes")
 124
 125 /* Assert without allocating memory. */
 126 #define ASSERT_AND_PANIC(truth)                 \
 127 do {                                            \
 128   if (CLIB_ASSERT_ENABLE && ! (truth))          \
 129     os_panic ();                                \
 130 } while (0)
 131
 132 #endif /* included_error_bootstrap_h */
 133
 134 /*
 135  * fd.io coding-style-patch-verification: ON
 136  *
 137  * Local Variables:
 138  * eval: (c-set-style "gnu")
 139  * End:
 140  */