[apple/xnu.git] / osfmk / kern / assert.h

/*
 * Copyright (c) 2000-2016 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 * 
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */
/*
 */

#ifndef	_KERN_ASSERT_H_
#define	_KERN_ASSERT_H_

/*	assert.h	4.2	85/01/21	*/

#include <kern/macro_help.h>
#include <sys/cdefs.h>

#ifdef	MACH_KERNEL_PRIVATE
#include <mach_assert.h>
#endif

__BEGIN_DECLS
/* Assert error */
extern void	Assert(
	const char	*file,
	int		line,
	const char	*expression) __attribute__((noinline));

extern int kext_assertions_enable;

#ifdef CONFIG_NO_PANIC_STRINGS
#define Assert(file, line, ex) (Assert)("", line, "")
#define __Panic(fmt, args...) panic("", ##args)
#else /* CONFIG_NO_PANIC_STRINGS */
#define __Panic(fmt, args...) panic(fmt, ##args)
#endif /* CONFIG_NO_PANIC_STRINGS */

__END_DECLS

#ifndef APPLE_KEXT_ASSERTIONS
#define APPLE_KEXT_ASSERTIONS	0
#endif

#if 	MACH_ASSERT

#define assert(ex)  \
	(__builtin_expect(!!((ex)), 1L) ? (void)0 : Assert(__FILE__, __LINE__, # ex))
#define assertf(ex, fmt, args...) \
	(__builtin_expect(!!((ex)), 1L) ? (void)0 : __Panic("%s:%d Assertion failed: %s : " fmt, __FILE__, __LINE__, # ex, ##args))
#define __assert_only

#elif APPLE_KEXT_ASSERTIONS && !XNU_KERNEL_PRIVATE	/* MACH_ASSERT */

#define assert(ex)  \
	(__builtin_expect(!!(((!kext_assertions_enable) || (ex))), 1L) ? (void)0 : Assert(__FILE__, __LINE__, # ex))
#define assertf(ex, fmt, args...) \
	(__builtin_expect(!!(((!kext_assertions_enable) || (ex))), 1L) ? (void)0 : __Panic("%s:%d Assertion failed: %s : " fmt, __FILE__, __LINE__, # ex, ##args))
#define __assert_only

#else 				/* APPLE_KEXT_ASSERTIONS && !XNU_KERNEL_PRIVATE */

#define assert(ex) ((void)0)
#define assertf(ex, fmt, args...) ((void)0)
#define __assert_only __unused

#endif	/* MACH_ASSERT */

/*
 * static_assert is a C11 / C++0x / C++1z feature.
 *
 * Beginning with C++0x, it is a keyword and should not be #defined
 *
 * static_assert is not disabled by MACH_ASSERT or NDEBUG
 */

#ifndef __cplusplus
	#if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L
		#define _STATIC_ASSERT_OVERLOADED_MACRO(_1, _2, NAME, ...) NAME
		#define static_assert(...) _STATIC_ASSERT_OVERLOADED_MACRO(__VA_ARGS__, _static_assert_2_args, _static_assert_1_arg)(__VA_ARGS__)

		#define _static_assert_2_args(ex, str) _Static_assert((ex), str)
		#define _static_assert_1_arg(ex) _Static_assert((ex), #ex)
	#endif
#else
	#if !defined(__cpp_static_assert)
		/* pre C++11 support */
		#define _STATIC_ASSERT_OVERLOADED_MACRO(_1, _2, NAME, ...) NAME
		#define static_assert(...) _STATIC_ASSERT_OVERLOADED_MACRO(__VA_ARGS__, _static_assert_2_args, _static_assert_1_arg)(__VA_ARGS__)

		#define _static_assert_2_args(ex, str) _Static_assert((ex), str)
		#define _static_assert_1_arg(ex) _Static_assert((ex), #ex)
	#else
		/*
		 * C++11 only supports the 2 argument version of static_assert.
		 * C++1z has added support for the 1 argument version.
		 */
		#define _static_assert_1_arg(ex) static_assert((ex), #ex)
	#endif
#endif

#endif	/* _KERN_ASSERT_H_ */
Commit	Line	Data
1c79356b	1	/*
39037602	2	* Copyright (c) 2000-2016 Apple Inc. All rights reserved.
1c79356b	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	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>
91447636	65	#include <sys/cdefs.h>
1c79356b A	66
	67	#ifdef MACH_KERNEL_PRIVATE
	68	#include <mach_assert.h>
	69	#endif
	70
91447636	71	__BEGIN_DECLS
1c79356b A	72	/* Assert error */
1c79356b A	73	extern void Assert(
2d21ac55 A	74	const char *file,
2d21ac55 A	75	int line,
fe8ab488	76	const char *expression) __attribute__((noinline));
b0d623f7	77
39037602 A	78	extern int kext_assertions_enable;
	79
	80	#ifdef CONFIG_NO_PANIC_STRINGS
b0d623f7	81	#define Assert(file, line, ex) (Assert)("", line, "")
490019cf A	82	#define __Panic(fmt, args...) panic("", ##args)
	83	#else /* CONFIG_NO_PANIC_STRINGS */
	84	#define __Panic(fmt, args...) panic(fmt, ##args)
	85	#endif /* CONFIG_NO_PANIC_STRINGS */
b0d623f7	86
91447636	87	__END_DECLS
1c79356b	88
39037602 A	89	#ifndef APPLE_KEXT_ASSERTIONS
	90	#define APPLE_KEXT_ASSERTIONS 0
	91	#endif
	92
	93	#if MACH_ASSERT
1c79356b	94
9bccf70c	95	#define assert(ex) \
813fb2f6	96	(__builtin_expect(!!((ex)), 1L) ? (void)0 : Assert(__FILE__, __LINE__, # ex))
490019cf	97	#define assertf(ex, fmt, args...) \
813fb2f6	98	(__builtin_expect(!!((ex)), 1L) ? (void)0 : __Panic("%s:%d Assertion failed: %s : " fmt, __FILE__, __LINE__, # ex, ##args))
39037602 A	99	#define __assert_only
	100
	101	#elif APPLE_KEXT_ASSERTIONS && !XNU_KERNEL_PRIVATE /* MACH_ASSERT */
1c79356b	102
39037602	103	#define assert(ex) \
813fb2f6	104	(__builtin_expect(!!(((!kext_assertions_enable) \|\| (ex))), 1L) ? (void)0 : Assert(__FILE__, __LINE__, # ex))
39037602	105	#define assertf(ex, fmt, args...) \
813fb2f6	106	(__builtin_expect(!!(((!kext_assertions_enable) \|\| (ex))), 1L) ? (void)0 : __Panic("%s:%d Assertion failed: %s : " fmt, __FILE__, __LINE__, # ex, ##args))
91447636 A	107	#define __assert_only
91447636 A	108
39037602	109	#else /* APPLE_KEXT_ASSERTIONS && !XNU_KERNEL_PRIVATE */
1c79356b	110
2d21ac55	111	#define assert(ex) ((void)0)
490019cf	112	#define assertf(ex, fmt, args...) ((void)0)
91447636 A	113	#define __assert_only __unused
91447636 A	114
1c79356b A	115	#endif /* MACH_ASSERT */
1c79356b A	116
39037602 A	117	/*
	118	* static_assert is a C11 / C++0x / C++1z feature.
	119	*
	120	* Beginning with C++0x, it is a keyword and should not be #defined
	121	*
	122	* static_assert is not disabled by MACH_ASSERT or NDEBUG
	123	*/
	124
	125	#ifndef __cplusplus
	126	#if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L
	127	#define _STATIC_ASSERT_OVERLOADED_MACRO(_1, _2, NAME, ...) NAME
	128	#define static_assert(...) _STATIC_ASSERT_OVERLOADED_MACRO(__VA_ARGS__, _static_assert_2_args, _static_assert_1_arg)(__VA_ARGS__)
	129
	130	#define _static_assert_2_args(ex, str) _Static_assert((ex), str)
	131	#define _static_assert_1_arg(ex) _Static_assert((ex), #ex)
	132	#endif
	133	#else
	134	#if !defined(__cpp_static_assert)
	135	/* pre C++11 support */
	136	#define _STATIC_ASSERT_OVERLOADED_MACRO(_1, _2, NAME, ...) NAME
	137	#define static_assert(...) _STATIC_ASSERT_OVERLOADED_MACRO(__VA_ARGS__, _static_assert_2_args, _static_assert_1_arg)(__VA_ARGS__)
	138
	139	#define _static_assert_2_args(ex, str) _Static_assert((ex), str)
	140	#define _static_assert_1_arg(ex) _Static_assert((ex), #ex)
	141	#else
	142	/*
	143	* C++11 only supports the 2 argument version of static_assert.
	144	* C++1z has added support for the 1 argument version.
	145	*/
	146	#define _static_assert_1_arg(ex) static_assert((ex), #ex)
	147	#endif
	148	#endif
	149
1c79356b	150	#endif /* _KERN_ASSERT_H_ */