beenull/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-11-22 15:40:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6
ladybird/AK/Platform.h

300 lines
7.5 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 08:38:21 +00:00
/*
AK: Make it possible to not `using` AK classes into the global namespace This patch adds the `USING_AK_GLOBALLY` macro which is enabled by default, but can be overridden by build flags. This is a step towards integrating Jakt and AK types.
2022-11-26 11:18:30 +00:00
* Copyright (c) 2018-2022, Andreas Kling <kling@serenityos.org>
AK+Everywhere: Add AK_COMPILER_{GCC,CLANG} and use them most places Doesn't use them in libc headers so that those don't have to pull in AK/Platform.h. AK_COMPILER_GCC is set _only_ for gcc, not for clang too. (__GNUC__ is defined in clang builds as well.) Using AK_COMPILER_GCC simplifies things some. AK_COMPILER_CLANG isn't as much of a win, other than that it's consistent with AK_COMPILER_GCC.
2022-10-04 19:04:13 +00:00
* Copyright (c) 2022, Nico Weber <thakis@chromium.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 08:38:21 +00: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 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
*/
AK: Add Platform.h with an ARCH() macro. You can currently use this to detect the CPU architecture like so: #if ARCH(I386) ... #elif ARCH(X86_64) ... #else ... #endif This will be helpful for separating out architecture-specific code blocks.
2019-07-09 13:46:22 +00:00
#pragma once
AK: Include <features.h> before checking for platform macros AK/Platform.h did not include any other header file, but expected various macros to be defined. While many of the macros checked here are predefined by the compiler (i.e. GCC's TARGET_OS_CPP_BUILTINS), some may be defined by the system headers instead. In particular, so is __GLIBC__ on glibc-based systems. We have to include some system header for getting __GLIBC__ (or not). It could be possible to include something relatively small and innocuous, like <string.h> for example, but that would still clutter the name space and make other code that would use <string.h> functionality, but forget to include it, build on accident; we wouldn't want that. At the end of the day, the header that actually defines __GLIBC__ (or not) is <features.h>. It's typically included from other glibc headers, and not by user code directly, which makes it unlikely to mask other code accidentlly forgetting to include it, since it wouldn't include it in the first place. <features.h> is not defined by POSIX and could be missing on other systems (but it seems to be present at least when using either glibc or musl), so guard its inclusion with __has_include(). Specifically, this fixes AK/StackInfo.cpp not picking up the glibc code path in the cross aarch64-gnu (GNU/Hurd on 64-bit ARM) Lagom build.
2024-04-25 12:34:27 +00:00
#if __has_include(<features.h>)
# include <features.h>
#endif
AK: Make it possible to not `using` AK classes into the global namespace This patch adds the `USING_AK_GLOBALLY` macro which is enabled by default, but can be overridden by build flags. This is a step towards integrating Jakt and AK types.
2022-11-26 11:18:30 +00:00
#ifndef USING_AK_GLOBALLY
# define USING_AK_GLOBALLY 1
#endif
AK: Add Platform.h with an ARCH() macro. You can currently use this to detect the CPU architecture like so: #if ARCH(I386) ... #elif ARCH(X86_64) ... #else ... #endif This will be helpful for separating out architecture-specific code blocks.
2019-07-09 13:46:22 +00:00
#ifdef __x86_64__
AK+readelf: Issue error when using ARCH(arch) with nonexistent arch This disallows erroneous `#if ARCH(x86_64)` (note lowercase x).
2023-03-02 11:47:03 +00:00
# define AK_IS_ARCH_X86_64() 1
#else
# define AK_IS_ARCH_X86_64() 0
AK: Add Platform.h with an ARCH() macro. You can currently use this to detect the CPU architecture like so: #if ARCH(I386) ... #elif ARCH(X86_64) ... #else ... #endif This will be helpful for separating out architecture-specific code blocks.
2019-07-09 13:46:22 +00:00
#endif
AK: Add back ARCH(I386) This now checks whether the platform is i386-based (but not x86_64).
2023-09-03 17:44:26 +00:00
#if defined(__i386__) && !defined(__x86_64__)
# define AK_IS_ARCH_I386() 1
#else
# define AK_IS_ARCH_I386() 0
#endif
AK: Add support for ARCH(AARCH64) to Platform.h
2021-10-11 22:38:16 +00:00
#ifdef __aarch64__
AK+readelf: Issue error when using ARCH(arch) with nonexistent arch This disallows erroneous `#if ARCH(x86_64)` (note lowercase x).
2023-03-02 11:47:03 +00:00
# define AK_IS_ARCH_AARCH64() 1
#else
# define AK_IS_ARCH_AARCH64() 0
AK: Add support for ARCH(AARCH64) to Platform.h
2021-10-11 22:38:16 +00:00
#endif
AK: Add riscv64 support
2023-08-20 17:46:05 +00:00
#if defined(__riscv) && __riscv_xlen == 64
# define AK_IS_ARCH_RISCV64() 1
#else
# define AK_IS_ARCH_RISCV64() 0
#endif
AK: Add AK_IS_ARCH defines for PowerPC CPU architecture
2024-06-24 21:13:27 +00:00
#if defined(__ppc64__) || defined(__PPC64__)
# define AK_IS_ARCH_PPC64() 1
#else
# define AK_IS_ARCH_PPC64() 0
#endif
#if defined(__ppc64le__) || defined(__PPC64LE__)
# define AK_IS_ARCH_PPC64LE() 1
#else
# define AK_IS_ARCH_PPC64LE() 0
#endif
#if defined(__ppc__) || defined(__PPC__) || defined(__powerpc__) || defined(__powerpc) || defined(__POWERPC__)
# define AK_IS_ARCH_PPC() 1
#else
# define AK_IS_ARCH_PPC() 0
#endif
Everywhere: Add support for compilation under emscripten Co-Authored-By: Andrew Kaster <akaster@serenityos.org>
2022-11-20 03:23:14 +00:00
#ifdef __wasm32__
AK+readelf: Issue error when using ARCH(arch) with nonexistent arch This disallows erroneous `#if ARCH(x86_64)` (note lowercase x).
2023-03-02 11:47:03 +00:00
# define AK_IS_ARCH_WASM32() 1
#else
# define AK_IS_ARCH_WASM32() 0
Everywhere: Add support for compilation under emscripten Co-Authored-By: Andrew Kaster <akaster@serenityos.org>
2022-11-20 03:23:14 +00:00
#endif
AK+LibJS: Handle NaN-boxing pointers on AArch64 JS::Value stores 48 bit pointers to separately allocated objects in its payload. On x86-64, canonical addresses have their top 16 bits set to the same value as bit 47, effectively meaning that the value has to be sign-extended to get the pointer. AArch64, however, expects the topmost bits to be all zeros. This commit gates sign extension behind `#if ARCH(X86_64)`, and adds an `#error` for unsupported architectures, so that we do not forget to think about pointer handling when porting to a new architecture. Fixes #15290 Fixes SerenityOS/ladybird#56
2022-09-20 16:09:33 +00:00
#if (defined(__SIZEOF_POINTER__) && __SIZEOF_POINTER__ == 8) || defined(_WIN64)
# define AK_ARCH_64_BIT
#else
# define AK_ARCH_32_BIT
#endif
AK: Bake CLion IDE check into AK_COMPILER_CLANG For whatever reason, when CLion does its code indexing thing, it doesn't define __clang__ despite using Clang. This causes it to run into various problems that we've solved by checking for Clang. Since CLion does define __CLION_IDE__ (or sometimes __CLION_IDE_, no idea why but I have seen this issue locally), let's make that part of the AK_COMPILER_CLANG check. This makes CLion stop highlighting various things as errors.
2023-04-08 05:34:01 +00:00
#if defined(__clang__) || defined(__CLION_IDE__) || defined(__CLION_IDE_)
AK+Everywhere: Add AK_COMPILER_{GCC,CLANG} and use them most places Doesn't use them in libc headers so that those don't have to pull in AK/Platform.h. AK_COMPILER_GCC is set _only_ for gcc, not for clang too. (__GNUC__ is defined in clang builds as well.) Using AK_COMPILER_GCC simplifies things some. AK_COMPILER_CLANG isn't as much of a win, other than that it's consistent with AK_COMPILER_GCC.
2022-10-04 19:04:13 +00:00
# define AK_COMPILER_CLANG
#elif defined(__GNUC__)
# define AK_COMPILER_GCC
#endif
AK+Kernel+LibVideo: Include workarounds for missing P0960 only in Xcode With this change, ".*make.*" function family now does error checking earlier, which improves experience while using clangd. Note that the change also make them instantiate classes a bit more eagerly, so in LibVideo/PlaybackManager, we have to first define SeekingStateHandler and only then make() it. Co-Authored-By: stelar7 <dudedbz@gmail.com>
2024-05-17 16:39:29 +00:00
#if defined(AK_COMPILER_CLANG) && defined(__apple_build_version__)
# define AK_COMPILER_APPLE_CLANG
#endif
AK: Add AK_LIBC_GLIBC This is defined when we're compiling against the GNU C Library, whether on Linux or on other kernels that glibc works on. More AK_LIBC_xxxx definitions could be potentially added in the future. Also add AK_LIBC_GLIBC_PREREQ(), which checks for a specific glibc version.
2023-09-03 18:59:06 +00:00
#if defined(__GLIBC__)
# define AK_LIBC_GLIBC
# define AK_LIBC_GLIBC_PREREQ(maj, min) __GLIBC_PREREQ((maj), (min))
#else
# define AK_LIBC_GLIBC_PREREQ(maj, min) 0
#endif
AK: Add more AK_OS_FOO macros, including AK_OS_SERENITY
2022-10-01 12:23:49 +00:00
#if defined(__serenity__)
# define AK_OS_SERENITY
#endif
#if defined(__linux__)
# define AK_OS_LINUX
#endif
AK+Lagom: Make it possible to build for iOS This commit makes it possible to build AK and most of Lagom for iOS, based on the work for the Ladybird build demoed on discord: https://discord.com/channels/830522505605283862/830525031720943627/1211987732646068314
2024-02-27 13:32:29 +00:00
#if defined(__APPLE__) && defined(__MACH__) && !defined(__IOS__)
AK: Add CLOCK_*_COARSE aliases for darwin and BSD variants The coarse clocks in time.h are a linux extension that we've adopted. MacOS and the BSDs don't have it, so we need an alias in a platform header for Lagom builds.
2020-12-27 22:38:32 +00:00
# define AK_OS_MACOS
# define AK_OS_BSD_GENERIC
#endif
AK+Lagom: Make it possible to build for iOS This commit makes it possible to build AK and most of Lagom for iOS, based on the work for the Ladybird build demoed on discord: https://discord.com/channels/830522505605283862/830525031720943627/1211987732646068314
2024-02-27 13:32:29 +00:00
#if defined(__IOS__)
# define AK_OS_IOS
# define AK_OS_BSD_GENERIC
#endif
AK: Add more AK_OS_FOO macros, including AK_OS_SERENITY
2022-10-01 12:23:49 +00:00
#if defined(__FreeBSD__)
# define AK_OS_BSD_GENERIC
# define AK_OS_FREEBSD
#endif
#if defined(__NetBSD__)
# define AK_OS_BSD_GENERIC
# define AK_OS_NETBSD
#endif
#if defined(__OpenBSD__)
# define AK_OS_BSD_GENERIC
# define AK_OS_OPENBSD
#endif
#if defined(__DragonFly__)
AK: Add CLOCK_*_COARSE aliases for darwin and BSD variants The coarse clocks in time.h are a linux extension that we've adopted. MacOS and the BSDs don't have it, so we need an alias in a platform header for Lagom builds.
2020-12-27 22:38:32 +00:00
# define AK_OS_BSD_GENERIC
AK: Add more AK_OS_FOO macros, including AK_OS_SERENITY
2022-10-01 12:23:49 +00:00
# define AK_OS_DRAGONFLY
AK: Add CLOCK_*_COARSE aliases for darwin and BSD variants The coarse clocks in time.h are a linux extension that we've adopted. MacOS and the BSDs don't have it, so we need an alias in a platform header for Lagom builds.
2020-12-27 22:38:32 +00:00
#endif
AK: Add Solaris to platform detection
2023-02-25 16:57:26 +00:00
#if defined(__sun)
# define AK_OS_BSD_GENERIC
# define AK_OS_SOLARIS
#endif
AK: Add Haiku to platform detection
2023-08-27 18:41:32 +00:00
#if defined(__HAIKU__)
# define AK_OS_HAIKU
#endif
AK: Add AK_OS_GNU_HURD :^) This is defined when building on GNU/Hurd, the GNU operating system with the Hurd as its kernel (as it was designed originally, before Linux and GNU/Linux came to be). Also, define the corresponding part of User-Agent.
2023-09-03 19:20:58 +00:00
#if defined(__gnu_hurd__)
# define AK_OS_GNU_HURD
#endif
AK: Add platform macro for Mach-based operating system environments
2024-04-04 19:55:48 +00:00
#if defined(__MACH__)
# define AK_OS_MACH
#endif
Lagom: Win32 support baby steps This is the initial port of Lagom to win32. This will enable developers to use Lagom as an alternative to vanilla STL/StandardC++Library - which gives a much richer environment (think QtCore - but modern). My main incentive - is to have a native Windows Ladybird working. I am starting with AK, which does not yet fully compile (on mingw). When AK is compiling (currently fails building StringBuffer.cpp) - I will continue to LibCore and then the rest of the user space libraries (excluding the GUI, which will be another different effort). Most of the code is happily stollen from Andrew Kaster's fork - he deserves the credit. Co-authored-by: Andrew Kaster <akaster@serenityos.org>
2022-09-20 07:15:12 +00:00
#if defined(_WIN32) || defined(_WIN64)
# define AK_OS_WINDOWS
#endif
AK: Add support for building on Android with API version >= 30
2022-07-11 07:04:39 +00:00
#if defined(__ANDROID__)
# define STR(x) __STR(x)
# define __STR(x) #x
# if __ANDROID_API__ < 30
# pragma message "Invalid android API " STR(__ANDROID_API__)
# error "Build configuration not tested on configured Android API version"
# endif
# undef STR
# undef __STR
# define AK_OS_ANDROID
#endif
Everywhere: Add support for compilation under emscripten Co-Authored-By: Andrew Kaster <akaster@serenityos.org>
2022-11-20 03:23:14 +00:00
#if defined(__EMSCRIPTEN__)
# define AK_OS_EMSCRIPTEN
#endif
AK+readelf: Issue error when using ARCH(arch) with nonexistent arch This disallows erroneous `#if ARCH(x86_64)` (note lowercase x).
2023-03-02 11:47:03 +00:00
#define ARCH(arch) (AK_IS_ARCH_##arch())
AK: Add Platform.h with an ARCH() macro. You can currently use this to detect the CPU architecture like so: #if ARCH(I386) ... #elif ARCH(X86_64) ... #else ... #endif This will be helpful for separating out architecture-specific code blocks.
2019-07-09 13:46:22 +00:00
AK: Add back ARCH(I386) This now checks whether the platform is i386-based (but not x86_64).
2023-09-03 17:44:26 +00:00
#if ARCH(X86_64) || ARCH(I386)
Kernel: Add VALIDATE_IS_X86 macro
2021-12-01 17:10:36 +00:00
# define VALIDATE_IS_X86()
#else
# define VALIDATE_IS_X86() static_assert(false, "Trying to include x86 only header on non x86 platform");
#endif
Kernel: Add VALIDATE_IS_AARCH64 guard macro
2022-10-16 14:55:42 +00:00
#if ARCH(AARCH64)
# define VALIDATE_IS_AARCH64()
#else
# define VALIDATE_IS_AARCH64() static_assert(false, "Trying to include aarch64 only header on non aarch64 platform");
#endif
AK: Add riscv64 support
2023-08-20 17:46:05 +00:00
#if ARCH(RISCV64)
# define VALIDATE_IS_RISCV64()
#else
# define VALIDATE_IS_RISCV64() static_assert(false, "Trying to include riscv64 only header on non riscv64 platform");
#endif
AK: Work around Apple Clang `__builtin_subc` codegen issue Apple Clang 14.0.3 (Xcode 14.3) miscompiles this builtin on AArch64, causing the borrow flag to be set incorrectly. I have added a detailed writeup on Qemu's issue tracker, where the same issue led to a hang when emulating x86: https://gitlab.com/qemu-project/qemu/-/issues/1659#note_1408275831 I don't know of any specific issue caused by this on Lagom, but better safe than sorry.
2023-06-23 09:18:29 +00:00
// Apple Clang 14.0.3 (shipped in Xcode 14.3) has a bug that causes __builtin_subc{,l,ll}
// to incorrectly return whether a borrow occurred on AArch64. See our writeup for the Qemu
// issue also caused by it: https://gitlab.com/qemu-project/qemu/-/issues/1659#note_1408275831
#if ARCH(AARCH64) && defined(__apple_build_version__) && __clang_major__ == 14
# define AK_BUILTIN_SUBC_BROKEN
#endif
AK: Add ALWAYS_INLINE, NEVER_INLINE and FLATTEN macros It's tedious to write (and look at) [[gnu::always_inline]] etc. :^)
2020-04-30 09:43:25 +00:00
#ifdef ALWAYS_INLINE
AK: Add Endian.h header to replace NetworkOrdered.h.
2020-08-25 13:11:15 +00:00
# undef ALWAYS_INLINE
AK: Add ALWAYS_INLINE, NEVER_INLINE and FLATTEN macros It's tedious to write (and look at) [[gnu::always_inline]] etc. :^)
2020-04-30 09:43:25 +00:00
#endif
AK: Use `__attribute__((name))` for functions everywhere Clang enforces the ordering that attributes specified with the `[[attr_name]]` syntax must comes before those defines as `__attribute__((attr_name))`. We don't want to deal with that, so we should stick to a single syntax (for functions, at least). This commit favors the latter, as it's used more widely in the code (for declaring more "exotic" options), and changing those would be a larger effort than modifying this single file.
2021-06-20 14:59:51 +00:00
#define ALWAYS_INLINE __attribute__((always_inline)) inline
AK: Add ALWAYS_INLINE, NEVER_INLINE and FLATTEN macros It's tedious to write (and look at) [[gnu::always_inline]] etc. :^)
2020-04-30 09:43:25 +00:00
#ifdef NEVER_INLINE
AK: Add Endian.h header to replace NetworkOrdered.h.
2020-08-25 13:11:15 +00:00
# undef NEVER_INLINE
AK: Add ALWAYS_INLINE, NEVER_INLINE and FLATTEN macros It's tedious to write (and look at) [[gnu::always_inline]] etc. :^)
2020-04-30 09:43:25 +00:00
#endif
AK: Use `__attribute__((name))` for functions everywhere Clang enforces the ordering that attributes specified with the `[[attr_name]]` syntax must comes before those defines as `__attribute__((attr_name))`. We don't want to deal with that, so we should stick to a single syntax (for functions, at least). This commit favors the latter, as it's used more widely in the code (for declaring more "exotic" options), and changing those would be a larger effort than modifying this single file.
2021-06-20 14:59:51 +00:00
#define NEVER_INLINE __attribute__((noinline))
AK: Add ALWAYS_INLINE, NEVER_INLINE and FLATTEN macros It's tedious to write (and look at) [[gnu::always_inline]] etc. :^)
2020-04-30 09:43:25 +00:00
#ifdef FLATTEN
AK: Add Endian.h header to replace NetworkOrdered.h.
2020-08-25 13:11:15 +00:00
# undef FLATTEN
AK: Add ALWAYS_INLINE, NEVER_INLINE and FLATTEN macros It's tedious to write (and look at) [[gnu::always_inline]] etc. :^)
2020-04-30 09:43:25 +00:00
#endif
AK: Use `__attribute__((name))` for functions everywhere Clang enforces the ordering that attributes specified with the `[[attr_name]]` syntax must comes before those defines as `__attribute__((attr_name))`. We don't want to deal with that, so we should stick to a single syntax (for functions, at least). This commit favors the latter, as it's used more widely in the code (for declaring more "exotic" options), and changing those would be a larger effort than modifying this single file.
2021-06-20 14:59:51 +00:00
#define FLATTEN __attribute__((flatten))
AK: Add ALWAYS_INLINE, NEVER_INLINE and FLATTEN macros It's tedious to write (and look at) [[gnu::always_inline]] etc. :^)
2020-04-30 09:43:25 +00:00
AK: Add RETURNS_NONNULL attribute and use it This attribute tells compilers that the pointer returned by a function is never null, which lets it optimize away null checks in some places. This seems like a nice addition to `NonnullOwnPtr` and `NonnullRefPtr`. Using this attribute causes extra UBSan checks to be emitted. To offset its performance loss, some additional methods were marked ALWAYS_INLINE, which lets the compiler optimize duplicate checks
2021-06-29 13:45:24 +00:00
#ifdef RETURNS_NONNULL
# undef RETURNS_NONNULL
#endif
#define RETURNS_NONNULL __attribute__((returns_nonnull))
Kernel: Exclude individual functions from coverage instrumentation Sticking this to the function source has multiple benefits: - We instrument more code, by not excluding entire files. - NO_SANITIZE_COVERAGE can be used in Header files. - Keeping the info with the source code, means if a function or file is moved around, the NO_SANITIZE_COVERAGE moves with it.
2024-04-08 00:52:13 +00:00
#ifdef NO_SANITIZE_COVERAGE
# undef NO_SANITIZE_COVERAGE
#endif
#if defined(AK_COMPILER_CLANG)
# define NO_SANITIZE_COVERAGE __attribute__((no_sanitize("coverage")))
#else
# define NO_SANITIZE_COVERAGE __attribute__((no_sanitize_coverage))
#endif
AK: Add #define for [[gnu::no_sanitize_address]] This lines up with other attribute global #defines
2021-05-12 11:51:02 +00:00
#ifdef NO_SANITIZE_ADDRESS
# undef NO_SANITIZE_ADDRESS
#endif
AK: Toolchain dependend instrumentation __attribute__ GCC sometimes complains about the The `no_sanitize("address")` syntax, and clang sometimes complains abouth the `no_sanitize_address` syntax. Both claim to support both, so that's neat!
2024-04-10 20:11:31 +00:00
#if defined(AK_COMPILER_CLANG)
# define NO_SANITIZE_ADDRESS __attribute__((no_sanitize("address")))
#else
# define NO_SANITIZE_ADDRESS __attribute__((no_sanitize_address))
#endif
AK: Add #define for [[gnu::no_sanitize_address]] This lines up with other attribute global #defines
2021-05-12 11:51:02 +00:00
Kernel: Replace raw asm functions with naked ones
2021-07-05 13:34:07 +00:00
#ifdef NAKED
# undef NAKED
#endif
AK: Define `NAKED` more resiliently for AArch64 This attribute is used for functions in the kernel that are entirely written in assembly, yet defined in C++ source files. Without `__attribute__((naked))`, Clang might decide to inline these functions, making any `ret` instructions within them actually exit the caller, or discard argument values as they appear "dead". This issue caused a kernel panic when using the `execve` syscall in AArch64 SerenityOS built by Clang. While the empty definition so far appears to work fine with GCC, simpler test cases do similarly suffer from unintended inlining, so define `NAKED` as a synonym of `NEVER_INLINE` to avert future issues. Perhaps we should move users of `NAKED` to plain assembly files? This makes aarch64Clang builds boot :^)
2023-05-22 09:11:29 +00:00
#if !ARCH(AARCH64) || defined(AK_COMPILER_CLANG)
AK: Stub out the NAKED macro on AARCH64 This is almost certainly incorrect but we'll see about that once the kernel actually gets to userspace init.
2022-10-12 20:05:41 +00:00
# define NAKED __attribute__((naked))
#else
AK: Define `NAKED` more resiliently for AArch64 This attribute is used for functions in the kernel that are entirely written in assembly, yet defined in C++ source files. Without `__attribute__((naked))`, Clang might decide to inline these functions, making any `ret` instructions within them actually exit the caller, or discard argument values as they appear "dead". This issue caused a kernel panic when using the `execve` syscall in AArch64 SerenityOS built by Clang. While the empty definition so far appears to work fine with GCC, simpler test cases do similarly suffer from unintended inlining, so define `NAKED` as a synonym of `NEVER_INLINE` to avert future issues. Perhaps we should move users of `NAKED` to plain assembly files? This makes aarch64Clang builds boot :^)
2023-05-22 09:11:29 +00:00
// GCC doesn't support __attribute__((naked)) on AArch64. We use NAKED to mark functions
// that are entirely written in inline assembly; having these be inlined would cause
// various problems, such as explicit `ret` instructions accidentally exiting the caller
// function or GCC discarding function arguments as they appear "dead".
# define NAKED NEVER_INLINE
AK: Stub out the NAKED macro on AARCH64 This is almost certainly incorrect but we'll see about that once the kernel actually gets to userspace init.
2022-10-12 20:05:41 +00:00
#endif
Kernel: Replace raw asm functions with naked ones
2021-07-05 13:34:07 +00:00
Kernel+AK: Generate compile-time error for non-sized `delete` This is a much more ergonomic option than getting a `VERIFY_NOT_REACHED()` failure at run-time. I encountered this issue with Clang, where sized deallocation is not the default due to ABI breakage concerns. Note that we can't simply just not declare these functions, because the C++ standard states: > If this function with size parameter is defined, the program shall > also define the version without the size parameter.
2021-07-15 11:50:55 +00:00
#ifdef DISALLOW
# undef DISALLOW
#endif
AK+Everywhere: Add AK_COMPILER_{GCC,CLANG} and use them most places Doesn't use them in libc headers so that those don't have to pull in AK/Platform.h. AK_COMPILER_GCC is set _only_ for gcc, not for clang too. (__GNUC__ is defined in clang builds as well.) Using AK_COMPILER_GCC simplifies things some. AK_COMPILER_CLANG isn't as much of a win, other than that it's consistent with AK_COMPILER_GCC.
2022-10-04 19:04:13 +00:00
#if defined(AK_COMPILER_CLANG)
Kernel+AK: Generate compile-time error for non-sized `delete` This is a much more ergonomic option than getting a `VERIFY_NOT_REACHED()` failure at run-time. I encountered this issue with Clang, where sized deallocation is not the default due to ABI breakage concerns. Note that we can't simply just not declare these functions, because the C++ standard states: > If this function with size parameter is defined, the program shall > also define the version without the size parameter.
2021-07-15 11:50:55 +00:00
# define DISALLOW(message) __attribute__((diagnose_if(1, message, "error")))
#else
# define DISALLOW(message) __attribute__((error(message)))
#endif
AK: Add platform macros to detect presence of AddressSanitizer The ASAN_[UN]POISON_MEMORY_REGION macros can be used to manually notify the AddressSanitizer runtime about the reachability of instrumented code accessing a memory region. This is most useful for manually managed heaps and arenas that do not go directly to malloc or alligned_alloc.
2021-05-27 23:49:40 +00:00
// GCC doesn't have __has_feature but clang does
#ifndef __has_feature
# define __has_feature(...) 0
#endif
#if __has_feature(address_sanitizer) || defined(__SANITIZE_ADDRESS__)
# define HAS_ADDRESS_SANITIZER
# define ASAN_POISON_MEMORY_REGION(addr, size) __asan_poison_memory_region(addr, size)
# define ASAN_UNPOISON_MEMORY_REGION(addr, size) __asan_unpoison_memory_region(addr, size)
LibJS+AK: Register GC memory as root regions for LeakSanitizer This should fix the gigantic list of false positives dumped by LeakSanitizer on exit .
2024-04-03 05:53:54 +00:00
# define LSAN_REGISTER_ROOT_REGION(base, size) __lsan_register_root_region(base, size)
# define LSAN_UNREGISTER_ROOT_REGION(base, size) __lsan_unregister_root_region(base, size)
AK: Add platform macros to detect presence of AddressSanitizer The ASAN_[UN]POISON_MEMORY_REGION macros can be used to manually notify the AddressSanitizer runtime about the reachability of instrumented code accessing a memory region. This is most useful for manually managed heaps and arenas that do not go directly to malloc or alligned_alloc.
2021-05-27 23:49:40 +00:00
#else
# define ASAN_POISON_MEMORY_REGION(addr, size)
# define ASAN_UNPOISON_MEMORY_REGION(addr, size)
LibJS+AK: Register GC memory as root regions for LeakSanitizer This should fix the gigantic list of false positives dumped by LeakSanitizer on exit .
2024-04-03 05:53:54 +00:00
# define LSAN_REGISTER_ROOT_REGION(base, size)
# define LSAN_UNREGISTER_ROOT_REGION(base, size)
AK: Add platform macros to detect presence of AddressSanitizer The ASAN_[UN]POISON_MEMORY_REGION macros can be used to manually notify the AddressSanitizer runtime about the reachability of instrumented code accessing a memory region. This is most useful for manually managed heaps and arenas that do not go directly to malloc or alligned_alloc.
2021-05-27 23:49:40 +00:00
#endif
Everywhere: Replace uses of __serenity__ with AK_OS_SERENITY Now that we have OS macros for essentially every supported OS, let's try to use them everywhere.
2022-10-09 21:23:23 +00:00
#ifndef AK_OS_SERENITY
AK: Don't try to include <unistd.h> on windows for PAGE_SIZE
2022-12-12 14:39:24 +00:00
# ifdef AK_OS_WINDOWS
// FIXME: No idea where to get this, but it's 4096 anyway :^)
# define PAGE_SIZE 4096
AK: Actually don't include <unistd.h> for windows in Platform.h I got the conditions wrong last time, oops :^)
2022-12-12 16:27:01 +00:00
# else
# include <unistd.h>
# undef PAGE_SIZE
# define PAGE_SIZE sysconf(_SC_PAGESIZE)
AK: On macOS host builds, wrap unistd.h with missing extern "C" During the build process on macOS, multiple versions of <unistd.h> were being included (Apple's version and GCC's version). It appears that all other places #include the version from GCC, but in Platform.h the Apple header was being used. GCC's <unistd.h> is wrapped in `extern "C"`, while Apple's is not. This causes a conflicting declaration, so we need to wrap the #include with extern "C". Issue has been observed on macOS Mojave. See https://github.com/microsoft/vcpkg/issues/11320 for a similar issue.
2021-09-01 01:23:29 +00:00
# endif
AK: Allow NonnullRefPtr::ptr() when in "unknown" typestate. Clang loses the typestate when passing NonnullRefPtr's via lambda captures. This is unfortunate, but not much we can do about it. Allowing ptr() makes it possible to use captured NonnullRefPtrs as you'd expect.
2019-07-25 09:51:24 +00:00
#endif
AK: Shim open_with_path_length() for non-Serenity builds. This is pretty ugly but I don't want to *not* use open_with_path_length() so let's just shim it.
2019-07-25 12:25:45 +00:00
Lagom: Win32 support baby steps This is the initial port of Lagom to win32. This will enable developers to use Lagom as an alternative to vanilla STL/StandardC++Library - which gives a much richer environment (think QtCore - but modern). My main incentive - is to have a native Windows Ladybird working. I am starting with AK, which does not yet fully compile (on mingw). When AK is compiling (currently fails building StringBuffer.cpp) - I will continue to LibCore and then the rest of the user space libraries (excluding the GUI, which will be another different effort). Most of the code is happily stollen from Andrew Kaster's fork - he deserves the credit. Co-authored-by: Andrew Kaster <akaster@serenityos.org>
2022-09-20 07:15:12 +00:00
#if defined(AK_OS_WINDOWS)
# define CLOCK_MONOTONIC_COARSE CLOCK_MONOTONIC
#endif
AK: Defined _COARSE clocks as the normal ones on Haiku
2023-09-06 18:22:08 +00:00
#if defined(AK_OS_BSD_GENERIC) && !defined(AK_OS_FREEBSD) || defined(AK_OS_HAIKU)
AK: Add CLOCK_*_COARSE aliases for darwin and BSD variants The coarse clocks in time.h are a linux extension that we've adopted. MacOS and the BSDs don't have it, so we need an alias in a platform header for Lagom builds.
2020-12-27 22:38:32 +00:00
# define CLOCK_MONOTONIC_COARSE CLOCK_MONOTONIC
# define CLOCK_REALTIME_COARSE CLOCK_REALTIME
#endif
AK: Allow alignment to cache line size with CACHE_ALIGNED This is particularly important to avoid false sharing, which thrashes performance when two process-shared atomics are on the same cache line.
2022-03-04 13:57:38 +00:00
AK: Prefix CACHE_ALIGNED & SYSTEM_CACHE_ALIGNMENT_SIZE
2022-07-31 20:32:33 +00:00
#ifndef AK_SYSTEM_CACHE_ALIGNMENT_SIZE
AK+readelf: Issue error when using ARCH(arch) with nonexistent arch This disallows erroneous `#if ARCH(x86_64)` (note lowercase x).
2023-03-02 11:47:03 +00:00
# if ARCH(AARCH64) || ARCH(X86_64)
AK: Prefix CACHE_ALIGNED & SYSTEM_CACHE_ALIGNMENT_SIZE
2022-07-31 20:32:33 +00:00
# define AK_SYSTEM_CACHE_ALIGNMENT_SIZE 64
AK: Allow alignment to cache line size with CACHE_ALIGNED This is particularly important to avoid false sharing, which thrashes performance when two process-shared atomics are on the same cache line.
2022-03-04 13:57:38 +00:00
# else
AK: Prefix CACHE_ALIGNED & SYSTEM_CACHE_ALIGNMENT_SIZE
2022-07-31 20:32:33 +00:00
# define AK_SYSTEM_CACHE_ALIGNMENT_SIZE 128
AK: Allow alignment to cache line size with CACHE_ALIGNED This is particularly important to avoid false sharing, which thrashes performance when two process-shared atomics are on the same cache line.
2022-03-04 13:57:38 +00:00
# endif
AK: Prefix CACHE_ALIGNED & SYSTEM_CACHE_ALIGNMENT_SIZE
2022-07-31 20:32:33 +00:00
#endif /* AK_SYSTEM_CACHE_ALIGNMENT_SIZE */
AK: Allow alignment to cache line size with CACHE_ALIGNED This is particularly important to avoid false sharing, which thrashes performance when two process-shared atomics are on the same cache line.
2022-03-04 13:57:38 +00:00
AK: Prefix CACHE_ALIGNED & SYSTEM_CACHE_ALIGNMENT_SIZE
2022-07-31 20:32:33 +00:00
#ifdef AK_CACHE_ALIGNED
# undef AK_CACHE_ALIGNED
AK: Allow alignment to cache line size with CACHE_ALIGNED This is particularly important to avoid false sharing, which thrashes performance when two process-shared atomics are on the same cache line.
2022-03-04 13:57:38 +00:00
#endif
AK: Prefix CACHE_ALIGNED & SYSTEM_CACHE_ALIGNMENT_SIZE
2022-07-31 20:32:33 +00:00
#define AK_CACHE_ALIGNED alignas(AK_SYSTEM_CACHE_ALIGNMENT_SIZE)
Reference in a new issue Copy permalink