ladybird/Kernel/Assertions.h

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

#pragma once

#include <AK/Platform.h>

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

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

#define VERIFY_NOT_REACHED() __assertion_failed("not reached", __FILE__, __LINE__, __PRETTY_FUNCTION__)

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

#define TODO() __assertion_failed("TODO", __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define VERIFY_INTERRUPTS_DISABLED() VERIFY(!(Processor::are_interrupts_enabled()))
#define VERIFY_INTERRUPTS_ENABLED() VERIFY(Processor::are_interrupts_enabled())
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 11: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 11: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 11:38:21 +03: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 12:01:38 +03:00			`#pragma once`
Kernel: Remove unneeded kassert.h. 2019-04-03 13:51:10 +03:00
Kernel: Remove ASM_Wrapper include from platform independent processor.h 2021-12-01 01:59:05 +03:00			`#include <AK/Platform.h>`

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 22:42:28 +03:00			`#define __STRINGIFY_HELPER(x) #x`
			`#define __STRINGIFY(x) __STRINGIFY_HELPER(x)`

Everywhere: Run clang-format 2022-04-01 20:58:27 +03:00			`[[noreturn]] void __assertion_failed(char const* msg, char const* file, unsigned line, char const* 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 16:46:50 +03:00			`#define VERIFY(expr) \`
			`do { \`
			`if (!static_cast<bool>(expr)) [[unlikely]] \`
			`__assertion_failed(#expr, __FILE__, __LINE__, __PRETTY_FUNCTION__); \`
			`} while (0)`

Kernel: Do not implement VERIFY_NOT_REACHED() as VERIFY(false) If a switch case ends in VERIFY_NOT_REACHED(), gcc 12 thinks it might fall through. 2022-05-07 18:46:27 +03:00			`#define VERIFY_NOT_REACHED() __assertion_failed("not reached", __FILE__, __LINE__, __PRETTY_FUNCTION__)`
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 09:43:10 +03:00
			`extern "C" {`
			`[[noreturn]] void _abort();`
			`[[noreturn]] void abort();`
			`}`
Kernel: List all CPUs in /proc/cpuinfo 2020-06-28 02:06:33 +03:00
Kernel: Do not implement VERIFY_NOT_REACHED() as VERIFY(false) If a switch case ends in VERIFY_NOT_REACHED(), gcc 12 thinks it might fall through. 2022-05-07 18:46:27 +03:00			`#define TODO() __assertion_failed("TODO", __FILE__, __LINE__, __PRETTY_FUNCTION__)`
Kernel: Remove ASM_Wrapper include from platform independent processor.h 2021-12-01 01:59:05 +03:00
Kernel/aarch64: Implement `VERIFY_INTERRUPTS_{ENABLED, DISABLED}` This requires to stub `Process::all_instances()`. 2022-08-23 23:24:42 +03:00			`#define VERIFY_INTERRUPTS_DISABLED() VERIFY(!(Processor::are_interrupts_enabled()))`
			`#define VERIFY_INTERRUPTS_ENABLED() VERIFY(Processor::are_interrupts_enabled())`