blob: 750d12e9a8140a6de7022ac1606abb78756a2d65 [file] [log] [blame]
The Android Open Source Project1dc9e472009-03-03 19:28:35 -08001/*-
2 * Copyright (c) 1992, 1993
3 * The Regents of the University of California. All rights reserved.
4 * (c) UNIX System Laboratories, Inc.
5 * All or some portions of this file are derived from material licensed
6 * to the University of California by American Telephone and Telegraph
7 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8 * the permission of UNIX System Laboratories, Inc.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080033 */
34
Elliott Hughes462e90c2018-08-21 16:10:48 -070035/**
36 * @file assert.h
37 * @brief Assertions.
38 *
Elliott Hughesf6495c72016-07-25 09:20:57 -070039 * There's no include guard in this file because <assert.h> may usefully be
40 * included multiple times, with and without NDEBUG defined.
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080041 */
42
43#include <sys/cdefs.h>
44
45#undef assert
Elliott Hughesf6495c72016-07-25 09:20:57 -070046#undef __assert_no_op
47
Elliott Hughes462e90c2018-08-21 16:10:48 -070048/** Internal implementation detail. Do not use. */
Elliott Hughesf6495c72016-07-25 09:20:57 -070049#define __assert_no_op __BIONIC_CAST(static_cast, void, 0)
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080050
51#ifdef NDEBUG
Elliott Hughesf6495c72016-07-25 09:20:57 -070052# define assert(e) __assert_no_op
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080053#else
Elliott Hughesf6495c72016-07-25 09:20:57 -070054# if defined(__cplusplus) || __STDC_VERSION__ >= 199901L
55# define assert(e) ((e) ? __assert_no_op : __assert2(__FILE__, __LINE__, __PRETTY_FUNCTION__, #e))
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080056# else
Elliott Hughes462e90c2018-08-21 16:10:48 -070057/**
58 * assert() aborts the program after logging an error message, if the
59 * expression evaluates to false.
60 *
61 * On Android, the error goes to both stderr and logcat.
62 */
Elliott Hughesf6495c72016-07-25 09:20:57 -070063# define assert(e) ((e) ? __assert_no_op : __assert(__FILE__, __LINE__, #e))
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080064# endif
65#endif
66
Elliott Hughes525761f2023-05-24 08:48:42 -070067/* `static_assert` is a keyword in C++11 and C23; C11 had `_Static_assert` instead. */
68#if !defined(__cplusplus) && (__STDC_VERSION__ >= 201112L && __STDC_VERSION__ < 202311L)
Elliott Hughesf6495c72016-07-25 09:20:57 -070069# undef static_assert
70# define static_assert _Static_assert
Elliott Hughes409e48a2016-06-08 10:52:15 -070071#endif
72
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080073__BEGIN_DECLS
Elliott Hughes462e90c2018-08-21 16:10:48 -070074
75/**
76 * __assert() is called by assert() on failure. Most users want assert()
77 * instead, but this can be useful for reporting other failures.
78 */
zijunzhao698b6162023-03-08 21:02:48 +000079void __assert(const char* _Nonnull __file, int __line, const char* _Nonnull __msg) __noreturn;
Elliott Hughes462e90c2018-08-21 16:10:48 -070080
81/**
82 * __assert2() is called by assert() on failure. Most users want assert()
83 * instead, but this can be useful for reporting other failures.
84 */
zijunzhao698b6162023-03-08 21:02:48 +000085void __assert2(const char* _Nonnull __file, int __line, const char* _Nonnull __function, const char* _Nonnull __msg) __noreturn;
Elliott Hughes462e90c2018-08-21 16:10:48 -070086
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080087__END_DECLS