ladybird/Userland/Libraries/LibC/assert.h

/*
 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <sys/cdefs.h>

__BEGIN_DECLS

#ifndef NDEBUG
__attribute__((noreturn)) void __assertion_failed(const char* msg);
#    define __stringify_helper(x) #    x
#    define __stringify(x) __stringify_helper(x)
#    define assert(expr)                                                            \
        (__builtin_expect(!(expr), 0)                                               \
                ? __assertion_failed(#expr "\n" __FILE__ ":" __stringify(__LINE__)) \
                : (void)0)

#else
#    define assert(expr) ((void)(0))
#    define VERIFY_NOT_REACHED() _abort()
#endif

__attribute__((noreturn)) void _abort();

#ifndef __cplusplus
#    define static_assert _Static_assert
#endif

__END_DECLS
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header. 2020-01-18 05:38:21 -03:00			`/*`
			`* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>`
			`*`
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt * 2021-04-22 05:24:48 -03:00			`* SPDX-License-Identifier: BSD-2-Clause`
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header. 2020-01-18 05:38:21 -03:00			`*/`

Canonicalize the path used by sh. With a bunch of LibC work to support the feature. LibC now initializes AK::StringImpl by default. It's now fine to use AK in LibC/Userland! :^) 2018-10-28 05:36:21 -03:00			`#pragma once`

A bunch of LibC boilerplate stuff added while trying to get figlet to build. 2018-10-30 22:09:11 -03:00			`#include <sys/cdefs.h>`

			`__BEGIN_DECLS`
Canonicalize the path used by sh. With a bunch of LibC work to support the feature. LibC now initializes AK::StringImpl by default. It's now fine to use AK in LibC/Userland! :^) 2018-10-28 05:36:21 -03:00
LibC: Use correct macro to disable assert() The C standard doesn't say anything about DEBUG, just NDEBUG :^) 2021-07-12 04:15:22 -03:00			`#ifndef NDEBUG`
LibC: Don't use C++ attribute syntax in C-visible headers Fixes errors when building Clang's compiler-rt, which compiles in C11 more. 2021-06-29 05:31:48 -03:00			`__attribute__((noreturn)) void __assertion_failed(const char* msg);`
LibC: Simplify ASSERT() to reduce code size Instead of pushing the message, file name, line# and function name separately, we now mash the message, file name and line# into a string constant and pass that. This means that the failure path only has to push a single address onto the stack, reducing the code size and causing the compiler to inline many more functions containing an assertions (e.g RefPtr::operator*()) Obviously if you wanted minimal size, you could turn assertions off entirely, but I really like running with assertions, so let's make a little effort to reduce their impact. :^) 2020-04-13 06:20:43 -03:00			`# define __stringify_helper(x) # x`
			`# define __stringify(x) __stringify_helper(x)`
LibC: Replace use of do/while in assert() with the ternary operator It's a single expression, no do/while needed. This makes assert() work with the comma operator (assert(foo), assert(bar), assert(baz)). Found because exactly this is being used somewhere in the guts of LLVM. 2021-07-12 17:37:31 -03:00			`# define assert(expr) \`
			`(__builtin_expect(!(expr), 0) \`
			`? __assertion_failed(#expr "\n" __FILE__ ":" __stringify(__LINE__)) \`
LibC: Use C-style void cast in assert() 2021-07-13 15:02:20 -03:00			`: (void)0)`
LibC: Replace use of do/while in assert() with the ternary operator It's a single expression, no do/while needed. This makes assert() work with the comma operator (assert(foo), assert(bar), assert(baz)). Found because exactly this is being used somewhere in the guts of LLVM. 2021-07-12 17:37:31 -03:00
Put assertions behind a DEBUG flag to make it easy to build without them. 2019-04-23 16:52:02 -03:00			`#else`
LibC: Unbreak assert.h when compiled with a C compiler :^) 2020-12-23 17:23:41 -03:00			`# define assert(expr) ((void)(0))`
Kernel+LibC: Clean up how assertions work in the kernel and LibC This also brings LibC's abort() function closer to the spec. 2021-04-18 03:43:10 -03:00			`# define VERIFY_NOT_REACHED() _abort()`
Put assertions behind a DEBUG flag to make it easy to build without them. 2019-04-23 16:52:02 -03:00			`#endif`

LibC: Don't use C++ attribute syntax in C-visible headers Fixes errors when building Clang's compiler-rt, which compiles in C11 more. 2021-06-29 05:31:48 -03:00			`__attribute__((noreturn)) void _abort();`
LibC: Turn CRASH() into a function and add noreturn attribute This way CRASH() can be used in functions that are themselves marked as noreturn. 2021-04-11 13:22:48 -03:00
LibC: Define static_assert in assert.h when it's being used in C 2021-03-07 11:54:38 -03:00			`#ifndef __cplusplus`
			`# define static_assert _Static_assert`
			`#endif`

A bunch of LibC boilerplate stuff added while trying to get figlet to build. 2018-10-30 22:09:11 -03:00			`__END_DECLS`