ladybird/Kernel/Assertions.h

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

#pragma once

#define __STRINGIFY_HELPER(x) #x
#define __STRINGIFY(x) __STRINGIFY_HELPER(x)

[[noreturn]] void __assertion_failed(const char* msg, const char* file, unsigned line, const char* func);
#define VERIFY(expr)                                                            \
    do {                                                                        \
        if (!static_cast<bool>(expr)) [[unlikely]]                              \
            __assertion_failed(#expr, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
    } while (0)

#define VERIFY_NOT_REACHED() VERIFY(false)

extern "C" {
[[noreturn]] void _abort();
[[noreturn]] void abort();
}

#define VERIFY_INTERRUPTS_DISABLED() VERIFY(!(cpu_flags() & 0x200))
#define VERIFY_INTERRUPTS_ENABLED() VERIFY(cpu_flags() & 0x200)

static constexpr bool TODO = false;
#define TODO() VERIFY(TODO)
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 08:38:21 +00: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 08:24:48 +00: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 08:38:21 +00:00			`*/`

Import the "gerbert" kernel I worked on earlier this year. It's a lot crappier than I remembered it. It's gonna need a lot of work. 2018-10-16 09:01:38 +00:00			`#pragma once`
Kernel: Remove unneeded kassert.h. 2019-04-03 10:51:10 +00:00
Kernel: Implement software context switching and Processor structure Moving certain globals into a new Processor structure for each CPU allows us to eventually run an instance of the scheduler on each CPU. 2020-06-27 19:42:28 +00:00			`#define __STRINGIFY_HELPER(x) #x`
			`#define __STRINGIFY(x) __STRINGIFY_HELPER(x)`

Kernel: Remove unneeded kassert.h. 2019-04-03 10:51:10 +00:00			`[[noreturn]] void __assertion_failed(const char* msg, const char* file, unsigned line, const char* func);`
Kernel: Add `[[unlikely]]` attribute to VERIFY This optimization has already been done in LibC's `assert.h`, which Userland `VERIFY()` calls resolve to. We now use it in the kernel, but with the nicer C++ unlikely attribute instead of `__builtin_expect`. This tells the compiler to arrange the generated machine code so that the error-free branches execute faster (e.g. fewer jumps, better cache locality). 2021-06-29 13:46:50 +00:00			`#define VERIFY(expr) \`
			`do { \`
			`if (!static_cast<bool>(expr)) [[unlikely]] \`
			`__assertion_failed(#expr, __FILE__, __LINE__, __PRETTY_FUNCTION__); \`
			`} while (0)`

Kernel: Enable VERIFY() checks even if the DEBUG macro is not defined Fixes #7910. 2021-06-11 06:55:52 +00:00			`#define VERIFY_NOT_REACHED() VERIFY(false)`
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 06:43:10 +00:00
			`extern "C" {`
			`[[noreturn]] void _abort();`
			`[[noreturn]] void abort();`
			`}`
Kernel: List all CPUs in /proc/cpuinfo 2020-06-27 23:06:33 +00:00
Everywhere: Rename ASSERT => VERIFY (...and ASSERT_NOT_REACHED => VERIFY_NOT_REACHED) Since all of these checks are done in release builds as well, let's rename them to VERIFY to prevent confusion, as everyone is used to assertions being compiled out in release. We can introduce a new ASSERT macro that is specifically for debug checks, but I'm doing this wholesale conversion first since we've accumulated thousands of these already, and it's not immediately obvious which ones are suitable for ASSERT. 2021-02-23 19:42:32 +00:00			`#define VERIFY_INTERRUPTS_DISABLED() VERIFY(!(cpu_flags() & 0x200))`
			`#define VERIFY_INTERRUPTS_ENABLED() VERIFY(cpu_flags() & 0x200)`
AK+Kernel: Print TODO when a TODO() is executed Previously we would just print "ASSERTION FAILED: false", which was kinda cryptic and also didn't make it clear whether this was a TODO or an unreachable condition. Now, we actually print "ASSERTION FAILED: TODO", making it crystal clear. 2021-08-03 20:02:19 +00:00
			`static constexpr bool TODO = false;`
			`#define TODO() VERIFY(TODO)`