Stowage/ladybird
2
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2025-11-10 02:01:03 +00:00
Code Issues Projects Releases Packages Wiki Activity
ladybird/AK/Assertions.h

39 lines
2.2 KiB
C
Raw Normal View History

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
/*
Meta: Update my e-mail address everywhere
2024-10-04 13:19:50 +02:00
* Copyright (c) 2018-2020, Andreas Kling <andreas@ladybird.org>
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
*
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 all this stuff into a single repo called Serenity.
2018-10-10 11:53:07 +02:00
#pragma once
AK: Expose `dump_backtrace()` publicly for debugging purposes At this point, I've repeatedly felt the desire to be able to log stacktraces to be able to see more easily what kind of call-sites exist for a given piece of code. So this commit exposes `dump_backtrace()` in the header so it can be used for this purpose.
2025-05-04 17:33:39 +02:00
extern "C" void dump_backtrace();
AK: Print a more useful error message when a `MUST(...)` fails ``` VERIFICATION FAILED: !_temporary_result.is_error() ``` is not really a helpful error message. When we are including `AK/Format.h`, which is most of the time, we can easily print a much more useful error message: ``` UNEXPECTED ERROR: Cannot allocate memory (errno=12) ```
2024-11-30 16:29:25 +01:00
extern "C" bool ak_colorize_output(void);
extern "C" __attribute__((noreturn)) void ak_trap(void);
AK: Always define ak_assertion_failed, even when NDEBUG is false Just because we may compile serenity with or without NDEBUG doesn't mean that consuming projects or Ports will share the setting. Always define the custom assertion function so that we don't have to keep the same debug settings between all projects.
2023-02-05 08:15:55 -07:00
extern "C" __attribute__((noreturn)) void ak_verification_failed(char const*);
Everywhere: Remove all KERNEL `#define`s
2024-06-17 23:12:53 +01:00
#define __stringify_helper(x) #x
#define __stringify(x) __stringify_helper(x)
AK: Allow calling `ASSERT` and `VERIFY` on list-initializers List initializers may contain commas without surrounding parenthesis, causing them to be passed as multiple macro arguments.
2024-11-17 15:20:23 +01:00
#define VERIFY(...) \
(__builtin_expect(/* NOLINT(readability-simplify-boolean-expr) */ !(__VA_ARGS__), 0) \
? ak_verification_failed(#__VA_ARGS__ " at " __FILE__ ":" __stringify(__LINE__)) \
Everywhere: Remove all KERNEL `#define`s
2024-06-17 23:12:53 +01:00
: (void)0)
#define VERIFY_NOT_REACHED() VERIFY(false) /* NOLINT(cert-dcl03-c,misc-static-assert) No, this can't be static_assert, it's a runtime check */
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;
Everywhere: Remove all KERNEL `#define`s
2024-06-17 23:12:53 +01:00
#define TODO() VERIFY(TODO) /* NOLINT(cert-dcl03-c,misc-static-assert) No, this can't be static_assert, it's a runtime check */
#define TODO_AARCH64() VERIFY(TODO) /* NOLINT(cert-dcl03-c,misc-static-assert) No, this can't be static_assert, it's a runtime check */
#define TODO_RISCV64() VERIFY(TODO) /* NOLINT(cert-dcl03-c,misc-static-assert) No, this can't be static_assert, it's a runtime check */
AK: Add TODO_PPC* assertions
2024-07-04 20:24:56 +02:00
#define TODO_PPC64() VERIFY(TODO) /* NOLINT(cert-dcl03-c,misc-static-assert) No, this can't be static_assert, it's a runtime check */
#define TODO_PPC() VERIFY(TODO) /* NOLINT(cert-dcl03-c,misc-static-assert) No, this can't be static_assert, it's a runtime check */
AK: Add ASSERT() and ASSERT_NOT_REACHED() for debug-only assertions Let's move towards using these for things that are "nice to check in debug builds, but not essential".
2024-07-09 14:21:34 +02:00
extern "C" __attribute__((noreturn)) void ak_assertion_failed(char const*);
Everywhere: Warn on function definitions without prototypes If no header includes the prototype of a function, then it cannot be used from outside the translation unit it was defined in. In that case, it should be marked as `static`, in order to avoid possible ODR problems, unnecessary exported symbols, and allow the compiler to better optimize those. If this warning triggers in a function defined in a header, `inline` needs to be added, otherwise if the header is included in more than one TU, it will fail to link with a duplicate definition error. The reason this diff got so big is that Lagom-only code wasn't built with this flag even in Serenity times.
2024-07-14 18:29:33 +02:00
#ifndef NDEBUG
AK: Allow calling `ASSERT` and `VERIFY` on list-initializers List initializers may contain commas without surrounding parenthesis, causing them to be passed as multiple macro arguments.
2024-11-17 15:20:23 +01:00
# define ASSERT(...) \
(__builtin_expect(/* NOLINT(readability-simplify-boolean-expr) */ !(__VA_ARGS__), 0) \
? ak_assertion_failed(#__VA_ARGS__ " at " __FILE__ ":" __stringify(__LINE__)) \
AK: Add ASSERT() and ASSERT_NOT_REACHED() for debug-only assertions Let's move towards using these for things that are "nice to check in debug builds, but not essential".
2024-07-09 14:21:34 +02:00
: (void)0)
AK: Fix `ASSERT_NOT_REACHED` macro when `NDEBUG` is not defined This is supposed to be a function-like macro just like `VERIFY_NOT_REACHED()` and when `NDEBUG` is defined.
2024-11-15 16:48:56 +01:00
# define ASSERT_NOT_REACHED() ASSERT(false) /* NOLINT(cert-dcl03-c,misc-static-assert) No, this can't be static_assert, it's a runtime check */
AK: Add ASSERT() and ASSERT_NOT_REACHED() for debug-only assertions Let's move towards using these for things that are "nice to check in debug builds, but not essential".
2024-07-09 14:21:34 +02:00
#else
AK: Allow calling `ASSERT` and `VERIFY` on list-initializers List initializers may contain commas without surrounding parenthesis, causing them to be passed as multiple macro arguments.
2024-11-17 15:20:23 +01:00
# define ASSERT(...)
AK: Add ASSERT() and ASSERT_NOT_REACHED() for debug-only assertions Let's move towards using these for things that are "nice to check in debug builds, but not essential".
2024-07-09 14:21:34 +02:00
# define ASSERT_NOT_REACHED() __builtin_unreachable()
#endif
Reference in a new issue Copy permalink