osfmk/kern/assert.h

   1 /*
   2  * Copyright (c) 2000-2016 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * Mach Operating System
  33  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
  34  * All Rights Reserved.
  35  *
  36  * Permission to use, copy, modify and distribute this software and its
  37  * documentation is hereby granted, provided that both the copyright
  38  * notice and this permission notice appear in all copies of the
  39  * software, derivative works or modified versions, and any portions
  40  * thereof, and that both notices appear in supporting documentation.
  41  *
  42  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  43  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  44  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  45  *
  46  * Carnegie Mellon requests users of this software to return to
  47  *
  48  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  49  *  School of Computer Science
  50  *  Carnegie Mellon University
  51  *  Pittsburgh PA 15213-3890
  52  *
  53  * any improvements or extensions that they make and grant Carnegie Mellon
  54  * the rights to redistribute these changes.
  55  */
  56 /*
  57  */
  58
  59 #ifndef _KERN_ASSERT_H_
  60 #define _KERN_ASSERT_H_
  61
  62 /*      assert.h        4.2     85/01/21        */
  63
  64 #include <kern/macro_help.h>
  65 #include <sys/cdefs.h>
  66
  67 #ifdef  MACH_KERNEL_PRIVATE
  68 #include <mach_assert.h>
  69 #endif
  70
  71 __BEGIN_DECLS
  72 /* Assert error */
  73 extern void     Assert(
  74         const char      *file,
  75         int             line,
  76         const char      *expression) __attribute__((noinline));
  77
  78 extern int kext_assertions_enable;
  79
  80 #define __Panic(fmt, args...) panic(fmt, ##args)
  81
  82 __END_DECLS
  83
  84 #ifndef APPLE_KEXT_ASSERTIONS
  85 #define APPLE_KEXT_ASSERTIONS   0
  86 #endif
  87
  88 #if     MACH_ASSERT
  89
  90 #define assert(ex)  \
  91         (__builtin_expect(!!((ex)), 1L) ? (void)0 : Assert(__FILE__, __LINE__, # ex))
  92 #define assertf(ex, fmt, args...) \
  93         (__builtin_expect(!!((ex)), 1L) ? (void)0 : __Panic("%s:%d Assertion failed: %s : " fmt, __FILE__, __LINE__, # ex, ##args))
  94 #define __assert_only
  95
  96 #elif APPLE_KEXT_ASSERTIONS && !XNU_KERNEL_PRIVATE      /* MACH_ASSERT */
  97
  98 #define assert(ex)  \
  99         (__builtin_expect(!!(((!kext_assertions_enable) || (ex))), 1L) ? (void)0 : Assert(__FILE__, __LINE__, # ex))
 100 #define assertf(ex, fmt, args...) \
 101         (__builtin_expect(!!(((!kext_assertions_enable) || (ex))), 1L) ? (void)0 : __Panic("%s:%d Assertion failed: %s : " fmt, __FILE__, __LINE__, # ex, ##args))
 102 #define __assert_only
 103
 104 #else                           /* APPLE_KEXT_ASSERTIONS && !XNU_KERNEL_PRIVATE */
 105
 106 #define assert(ex) ((void)0)
 107 #define assertf(ex, fmt, args...) ((void)0)
 108 #define __assert_only __unused
 109
 110 #endif  /* MACH_ASSERT */
 111
 112 /*
 113  * static_assert is a C11 / C++0x / C++1z feature.
 114  *
 115  * Beginning with C++0x, it is a keyword and should not be #defined
 116  *
 117  * static_assert is not disabled by MACH_ASSERT or NDEBUG
 118  */
 119
 120 #ifndef __cplusplus
 121         #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L
 122                 #define _STATIC_ASSERT_OVERLOADED_MACRO(_1, _2, NAME, ...) NAME
 123                 #define static_assert(...) _STATIC_ASSERT_OVERLOADED_MACRO(__VA_ARGS__, _static_assert_2_args, _static_assert_1_arg)(__VA_ARGS__)
 124
 125                 #define _static_assert_2_args(ex, str) _Static_assert((ex), str)
 126                 #define _static_assert_1_arg(ex) _Static_assert((ex), #ex)
 127         #endif
 128 #else
 129         #if !defined(__cpp_static_assert)
 130 /* pre C++11 support */
 131                 #define _STATIC_ASSERT_OVERLOADED_MACRO(_1, _2, NAME, ...) NAME
 132                 #define static_assert(...) _STATIC_ASSERT_OVERLOADED_MACRO(__VA_ARGS__, _static_assert_2_args, _static_assert_1_arg)(__VA_ARGS__)
 133
 134                 #define _static_assert_2_args(ex, str) _Static_assert((ex), str)
 135                 #define _static_assert_1_arg(ex) _Static_assert((ex), #ex)
 136         #else
 137 /*
 138  * C++11 only supports the 2 argument version of static_assert.
 139  * C++1z has added support for the 1 argument version.
 140  */
 141                 #define _static_assert_1_arg(ex) static_assert((ex), #ex)
 142         #endif
 143 #endif
 144
 145 #endif  /* _KERN_ASSERT_H_ */