Angel Pons | 32859fc | 2020-04-02 23:48:27 +0200 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
Stefan Reinauer | eca92fb | 2006-08-23 14:28:37 +0000 | [diff] [blame] | 2 | |
Stefan Reinauer | 55259bd | 2010-02-28 18:13:09 +0000 | [diff] [blame] | 3 | #ifndef __ASSERT_H__ |
| 4 | #define __ASSERT_H__ |
Uwe Hermann | c70e9fc | 2010-02-15 23:10:19 +0000 | [diff] [blame] | 5 | |
Julius Werner | d82e0cf | 2015-02-17 17:27:23 -0800 | [diff] [blame] | 6 | #include <arch/hlt.h> |
Hung-Te Lin | 34c5933 | 2014-02-21 16:22:52 +0800 | [diff] [blame] | 7 | #include <console/console.h> |
Elyes HAOUAS | 5817c56 | 2020-07-12 09:03:22 +0200 | [diff] [blame] | 8 | #include <stdint.h> |
Hung-Te Lin | 34c5933 | 2014-02-21 16:22:52 +0800 | [diff] [blame] | 9 | |
Julius Werner | a73e5a7 | 2019-05-09 14:12:17 -0700 | [diff] [blame] | 10 | /* TODO: Fix vendorcode headers to not define macros coreboot uses or to be more |
| 11 | properly isolated. */ |
| 12 | #ifdef ASSERT |
| 13 | #undef ASSERT |
| 14 | #endif |
| 15 | |
Angel Pons | 4645197 | 2020-06-08 15:52:03 +0200 | [diff] [blame] | 16 | /* Do not use filenames nor line numbers on timeless builds, to preserve reproducibility */ |
| 17 | #if ENV_TIMELESS |
| 18 | #define __ASSERT_FILE__ "(filenames not available on timeless builds)" |
| 19 | #define __ASSERT_LINE__ 404 |
| 20 | #else |
| 21 | #define __ASSERT_FILE__ __FILE__ |
| 22 | #define __ASSERT_LINE__ __LINE__ |
| 23 | #endif |
| 24 | |
Julius Werner | 2aedc97 | 2020-07-29 16:55:18 -0700 | [diff] [blame] | 25 | #ifndef _PORTING_H_ /* TODO: Isolate AGESA properly. */ |
| 26 | #define __build_time_assert(x) \ |
| 27 | (__builtin_constant_p(x) ? ((x) ? 1 : dead_code_t(int)) : 0) |
| 28 | #else |
| 29 | #define __build_time_assert(x) 0 |
| 30 | #endif |
| 31 | |
Jakub Czapiga | 45d37d5 | 2021-03-25 14:28:29 +0100 | [diff] [blame] | 32 | /* CMocka function redefinition. */ |
| 33 | void mock_assert(const int result, const char *const expression, |
| 34 | const char *const file, const int line); |
| 35 | |
| 36 | #if ENV_TEST |
| 37 | #define MOCK_ASSERT(result, expression) \ |
| 38 | mock_assert((result), (expression), __ASSERT_FILE__, __ASSERT_LINE__) |
| 39 | #else |
| 40 | #define MOCK_ASSERT(result, expression) |
| 41 | #endif |
| 42 | |
Julius Werner | 2bd18ed | 2022-12-15 08:56:14 -0800 | [diff] [blame] | 43 | /* |
| 44 | * assert() should be used to test stuff that the programmer *knows* to be true. |
| 45 | * It should not be used to test something that may actually change at runtime |
| 46 | * (e.g. anything involving hardware accesses). For example, testing whether |
| 47 | * function parameters match the documented requirements is a good use of |
| 48 | * assert() (where it is still the responsibility of the caller to ensure it |
| 49 | * passes valid values, and the callee is just double-checking). |
| 50 | * |
| 51 | * Depending on CONFIG(FATAL_ASSERTS), assert() will either halt execution or |
| 52 | * just print an error message and continue. For more guidelines on error |
| 53 | * handling, see Documentation/contributing/coding_style.md. |
| 54 | */ |
Angel Pons | 4645197 | 2020-06-08 15:52:03 +0200 | [diff] [blame] | 55 | #define ASSERT(x) { \ |
Julius Werner | 2aedc97 | 2020-07-29 16:55:18 -0700 | [diff] [blame] | 56 | if (!__build_time_assert(x) && !(x)) { \ |
Angel Pons | 4645197 | 2020-06-08 15:52:03 +0200 | [diff] [blame] | 57 | printk(BIOS_EMERG, \ |
| 58 | "ASSERTION ERROR: file '%s', line %d\n", \ |
| 59 | __ASSERT_FILE__, __ASSERT_LINE__); \ |
Jakub Czapiga | 45d37d5 | 2021-03-25 14:28:29 +0100 | [diff] [blame] | 60 | MOCK_ASSERT(!!(x), #x); \ |
Angel Pons | 4645197 | 2020-06-08 15:52:03 +0200 | [diff] [blame] | 61 | if (CONFIG(FATAL_ASSERTS)) \ |
| 62 | hlt(); \ |
| 63 | } \ |
Stefan Reinauer | 55259bd | 2010-02-28 18:13:09 +0000 | [diff] [blame] | 64 | } |
Angel Pons | 4645197 | 2020-06-08 15:52:03 +0200 | [diff] [blame] | 65 | #define ASSERT_MSG(x, msg) { \ |
Julius Werner | 2aedc97 | 2020-07-29 16:55:18 -0700 | [diff] [blame] | 66 | if (!__build_time_assert(x) && !(x)) { \ |
Angel Pons | 4645197 | 2020-06-08 15:52:03 +0200 | [diff] [blame] | 67 | printk(BIOS_EMERG, \ |
| 68 | "ASSERTION ERROR: file '%s', line %d\n", \ |
| 69 | __ASSERT_FILE__, __ASSERT_LINE__); \ |
| 70 | printk(BIOS_EMERG, "%s", msg); \ |
Jakub Czapiga | 45d37d5 | 2021-03-25 14:28:29 +0100 | [diff] [blame] | 71 | MOCK_ASSERT(!!(x), (msg)); \ |
Angel Pons | 4645197 | 2020-06-08 15:52:03 +0200 | [diff] [blame] | 72 | if (CONFIG(FATAL_ASSERTS)) \ |
| 73 | hlt(); \ |
| 74 | } \ |
Eric Peers | 9d49598 | 2019-12-17 10:02:15 -0700 | [diff] [blame] | 75 | } |
Angel Pons | 4645197 | 2020-06-08 15:52:03 +0200 | [diff] [blame] | 76 | #define BUG() { \ |
| 77 | printk(BIOS_EMERG, \ |
| 78 | "ERROR: BUG ENCOUNTERED at file '%s', line %d\n", \ |
| 79 | __ASSERT_FILE__, __ASSERT_LINE__); \ |
Jakub Czapiga | 45d37d5 | 2021-03-25 14:28:29 +0100 | [diff] [blame] | 80 | MOCK_ASSERT(0, "BUG ENCOUNTERED"); \ |
Angel Pons | 4645197 | 2020-06-08 15:52:03 +0200 | [diff] [blame] | 81 | if (CONFIG(FATAL_ASSERTS)) \ |
| 82 | hlt(); \ |
Stefan Reinauer | 55259bd | 2010-02-28 18:13:09 +0000 | [diff] [blame] | 83 | } |
| 84 | |
Hung-Te Lin | 34c5933 | 2014-02-21 16:22:52 +0800 | [diff] [blame] | 85 | #define assert(statement) ASSERT(statement) |
Uwe Hermann | 2bb4acf | 2010-03-01 17:19:55 +0000 | [diff] [blame] | 86 | |
Julius Werner | b8534f7 | 2017-07-14 14:14:11 -0700 | [diff] [blame] | 87 | /* |
| 88 | * These macros can be used to assert that a certain branch of code is dead and |
| 89 | * will be compile-time eliminated. This differs from _Static_assert(), which |
| 90 | * will generate a compiler error even if the scope it was called from is dead |
| 91 | * code. This may be useful to double-check things like constants that are only |
| 92 | * valid if a certain Kconfig option is set. |
Julius Werner | 988ac29 | 2019-03-28 13:39:06 -0700 | [diff] [blame] | 93 | * |
| 94 | * The error message when this hits will look like this: |
| 95 | * |
| 96 | * ramstage/lib/bootmode.o: In function `display_init_required': |
Nico Huber | db2c8df | 2020-04-06 23:02:12 +0200 | [diff] [blame] | 97 | * bootmode.c:42: undefined reference to `_dead_code_assertion_failed' |
Julius Werner | b8534f7 | 2017-07-14 14:14:11 -0700 | [diff] [blame] | 98 | */ |
Nico Huber | db2c8df | 2020-04-06 23:02:12 +0200 | [diff] [blame] | 99 | extern void _dead_code_assertion_failed(void) __attribute__((noreturn)); |
| 100 | #define dead_code() _dead_code_assertion_failed() |
Julius Werner | b8534f7 | 2017-07-14 14:14:11 -0700 | [diff] [blame] | 101 | |
| 102 | /* This can be used in the context of an expression of type 'type'. */ |
Julius Werner | 988ac29 | 2019-03-28 13:39:06 -0700 | [diff] [blame] | 103 | #define dead_code_t(type) ({ \ |
| 104 | dead_code(); \ |
Julius Werner | b8534f7 | 2017-07-14 14:14:11 -0700 | [diff] [blame] | 105 | *(type *)(uintptr_t)0; \ |
| 106 | }) |
| 107 | |
Patrick Rudolph | adcf782 | 2020-08-27 20:50:18 +0200 | [diff] [blame] | 108 | #if ENV_X86_64 |
Patrick Rudolph | e563815 | 2018-12-09 10:48:59 +0100 | [diff] [blame] | 109 | #define pointer_to_uint32_safe(x) ({ \ |
| 110 | if ((uintptr_t)(x) > 0xffffffffUL) \ |
| 111 | die("Cast from pointer to uint32_t overflows"); \ |
| 112 | (uint32_t)(uintptr_t)(x); \ |
| 113 | }) |
| 114 | #else |
| 115 | #define pointer_to_uint32_safe(x) ({ \ |
| 116 | (uint32_t)(uintptr_t)(x); \ |
| 117 | }) |
| 118 | #endif |
Uwe Hermann | 2bb4acf | 2010-03-01 17:19:55 +0000 | [diff] [blame] | 119 | #endif // __ASSERT_H__ |