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)

#ifdef DEBUG
[[noreturn]] void __assertion_failed(const char* msg, const char* file, unsigned line, const char* func);
#    define VERIFY(expr) (static_cast<bool>(expr) ? void(0) : __assertion_failed(#    expr, __FILE__, __LINE__, __PRETTY_FUNCTION__))
#    define VERIFY_NOT_REACHED() VERIFY(false)
#else
#    define VERIFY(expr)
#    define VERIFY_NOT_REACHED() _abort()
#endif

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

#define VERIFY_INTERRUPTS_DISABLED() VERIFY(!(cpu_flags() & 0x200))
#define VERIFY_INTERRUPTS_ENABLED() VERIFY(cpu_flags() & 0x200)
#define TODO VERIFY_NOT_REACHED
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 09:38:21 +01: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 01:24:48 -07: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 09:38:21 +01: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 11:01:38 +02:00			`#pragma once`
Kernel: Remove unneeded kassert.h. 2019-04-03 12:51:10 +02: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 13:42:28 -06:00			`#define __STRINGIFY_HELPER(x) #x`
			`#define __STRINGIFY(x) __STRINGIFY_HELPER(x)`

Put assertions behind a DEBUG flag to make it easy to build without them. 2019-04-23 21:52:02 +02:00			`#ifdef DEBUG`
Kernel: Remove unneeded kassert.h. 2019-04-03 12:51:10 +02:00			`[[noreturn]] void __assertion_failed(const char* msg, const char* file, unsigned line, const char* func);`
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 20:42:32 +01:00			`# define VERIFY(expr) (static_cast<bool>(expr) ? void(0) : __assertion_failed(# expr, __FILE__, __LINE__, __PRETTY_FUNCTION__))`
			`# define VERIFY_NOT_REACHED() VERIFY(false)`
Put assertions behind a DEBUG flag to make it easy to build without them. 2019-04-23 21:52:02 +02:00			`#else`
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 20:42:32 +01:00			`# define VERIFY(expr)`
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 08:43:10 +02:00			`# define VERIFY_NOT_REACHED() _abort()`
Put assertions behind a DEBUG flag to make it easy to build without them. 2019-04-23 21:52:02 +02:00			`#endif`
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 08:43:10 +02:00
			`extern "C" {`
			`[[noreturn]] void _abort();`
			`[[noreturn]] void abort();`
			`}`
Kernel: List all CPUs in /proc/cpuinfo 2020-06-27 17:06:33 -06: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 20:42:32 +01:00			`#define VERIFY_INTERRUPTS_DISABLED() VERIFY(!(cpu_flags() & 0x200))`
			`#define VERIFY_INTERRUPTS_ENABLED() VERIFY(cpu_flags() & 0x200)`
			`#define TODO VERIFY_NOT_REACHED`