include/babeltrace/assert-internal.h

   1 #ifndef BABELTRACE_ASSERT_INTERNAL_H
   2 #define BABELTRACE_ASSERT_INTERNAL_H
   3
   4 /*
   5  * Copyright (c) 2018 EfficiOS Inc. and Linux Foundation
   6  * Copyright (c) 2018 Philippe Proulx <pproulx@efficios.com>
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  */
  26
  27 #include <assert.h>
  28
  29 #ifdef BT_DEBUG_MODE
  30 /*
  31  * Internal assertion (to detect logic errors on which the library user
  32  * has no influence). Use BT_ASSERT_PRE() to check a precondition which
  33  * must be directly or indirectly satisfied by the library user.
  34  */
  35 # define BT_ASSERT(_cond)       do { assert(_cond); } while (0)
  36
  37 /*
  38  * Marks a function as being only used within a BT_ASSERT() context.
  39  */
  40 # define BT_ASSERT_FUNC
  41 #else
  42 # define BT_ASSERT(_cond)
  43 # define BT_ASSERT_FUNC         __attribute__((unused))
  44 #endif /* BT_DEBUG_MODE */
  45
  46 #endif /* BABELTRACE_ASSERT_INTERNAL_H */