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

122 lines
2.7 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
/*
* 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 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
#ifdef __i386__
AK: Use endianness flags to determine if conversion is necessary
2020-02-19 14:58:54 +00:00
# define AK_ARCH_I386 1
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
#ifdef __x86_64__
AK: Use endianness flags to determine if conversion is necessary
2020-02-19 14:58:54 +00:00
# define AK_ARCH_X86_64 1
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 support for ARCH(AARCH64) to Platform.h
2021-10-11 22:38:16 +00:00
#ifdef __aarch64__
# define AK_ARCH_AARCH64 1
#endif
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
#if defined(__APPLE__) && defined(__MACH__)
# define AK_OS_MACOS
# define AK_OS_BSD_GENERIC
#endif
#if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
# define AK_OS_BSD_GENERIC
#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
#define ARCH(arch) (defined(AK_ARCH_##arch) && AK_ARCH_##arch)
AK: Use conditionally trivial special member functions This commit makes use of the conditionally trivial special member functions introduced in C++20. Basically, `Optional` and `Variant` inherits whether its wrapped type is trivially copy constructible, trivially copy assignable or trivially destructible. This lets the compiler optimize optimize a large number of their use cases. The constraints have been applied to `Optional`'s converting constructors too in order to make the API more explicit. This feature is not supported by Clang yet, so we use conditional compilation so that Lagom can be built on macOS. Once Clang has P0848R3 support, these can be removed.
2021-07-02 15:42:50 +00:00
#if !defined(__clang__)
# define AK_HAS_CONDITIONALLY_TRIVIAL
#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))
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: 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 NO_SANITIZE_ADDRESS __attribute__((no_sanitize_address))
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
#define NAKED __attribute__((naked))
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
#ifdef __clang__
# 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)
#else
# define ASAN_POISON_MEMORY_REGION(addr, size)
# define ASAN_UNPOISON_MEMORY_REGION(addr, size)
#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
#ifndef __serenity__
Everywhere: Remove klog(), dbg() and purge all LogStream usage :^) Good-bye LogStream. Long live AK::Format!
2021-03-12 16:29:37 +00:00
# include <unistd.h>
AK: Fix redefinition of macro inside AK/Platform.h
2021-04-28 10:22:20 +00:00
# undef PAGE_SIZE
AK: Use endianness flags to determine if conversion is necessary
2020-02-19 14:58:54 +00:00
# define PAGE_SIZE sysconf(_SC_PAGESIZE)
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
Kernel: Introduce basic pre-kernel environment This implements a simple bootloader that is capable of loading ELF64 kernel images. It does this by using QEMU/GRUB to load the kernel image from disk and pass it to our bootloader as a Multiboot module. The bootloader then parses the ELF image and sets it up appropriately. The kernel's entry point is a C++ function with architecture-native code. Co-authored-by: Liav A <liavalb@gmail.com>
2021-07-18 12:47:32 +00:00
#ifdef __cplusplus
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
ALWAYS_INLINE int count_trailing_zeroes_32(unsigned int val)
AK: Add count_trailing_zeroes_32() Add count_trailing_zeroes_32() which is implemented with builtins if available, otherwise there's a generic fallback.
2020-03-23 14:31:37 +00:00
{
Kernel: Merge the x86 and x86_64 boot code into a single file They're mostly the same apart from some x86_64-specific parts.
2021-07-04 22:55:09 +00:00
# if defined(__GNUC__) || defined(__clang__)
AK: Add Endian.h header to replace NetworkOrdered.h.
2020-08-25 13:11:15 +00:00
return __builtin_ctz(val);
Kernel: Merge the x86 and x86_64 boot code into a single file They're mostly the same apart from some x86_64-specific parts.
2021-07-04 22:55:09 +00:00
# else
AK: Add Endian.h header to replace NetworkOrdered.h.
2020-08-25 13:11:15 +00:00
for (u8 i = 0; i < 32; ++i) {
if ((val >> i) & 1) {
return i;
AK: Add count_trailing_zeroes_32() Add count_trailing_zeroes_32() which is implemented with builtins if available, otherwise there's a generic fallback.
2020-03-23 14:31:37 +00:00
}
AK: Add Endian.h header to replace NetworkOrdered.h.
2020-08-25 13:11:15 +00:00
}
return 0;
Kernel: Merge the x86 and x86_64 boot code into a single file They're mostly the same apart from some x86_64-specific parts.
2021-07-04 22:55:09 +00:00
# endif
LibGfx: Fix dynamic bitmasks in BMPs I overlooked a corner case where we might call the built-in ctz() on zero. Furthermore, the calculation of the shift was wrong and the results were often unusable. Both issue were caused by a forgotten 36daeee34ff04f64c933e94a9cdffe9080061fb0. This time I made sure to look at bmpsuite_files first, and now they look good. Found by OSS-Fuzz: https://bugs.chromium.org/p/oss-fuzz/issues/detail?id=28985
2021-01-30 00:24:41 +00:00
}
ALWAYS_INLINE int count_trailing_zeroes_32_safe(unsigned int val)
{
if (val == 0)
return 32;
return count_trailing_zeroes_32(val);
}
Kernel: Merge the x86 and x86_64 boot code into a single file They're mostly the same apart from some x86_64-specific parts.
2021-07-04 22:55:09 +00:00
#endif
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
#ifdef AK_OS_BSD_GENERIC
# define CLOCK_MONOTONIC_COARSE CLOCK_MONOTONIC
# define CLOCK_REALTIME_COARSE CLOCK_REALTIME
#endif
Reference in a new issue Copy permalink