beenull/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-11-25 09:00:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7
ladybird/AK/Userspace.h

80 lines
1.7 KiB
C
Raw Normal View History

AK: Add Userspace<T>, a wrapper for userspace pointers This will be used in the kernel to wrap pointers into userspace memory without convenient direct access. The idea is to use the compiler to enforce that we don't dereference userspace pointers.
2020-07-31 14:26:44 +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
AK: Add Userspace<T>, a wrapper for userspace pointers This will be used in the kernel to wrap pointers into userspace memory without convenient direct access. The idea is to use the compiler to enforce that we don't dereference userspace pointers.
2020-07-31 14:26:44 +00:00
*/
#pragma once
Kernel: Don't assert on PT_PEEK with kernelspace address We were casting the address to Userspace<T> without validating it first which is no good and will trap an assertion soon after. Let's catch this sooner with an ASSERT in the Userspace<T> constructor and update the PT_PEEK and PT_POKE handlers to avoid it. Fixes #4505.
2020-12-23 13:42:22 +00:00
#include <AK/Assertions.h>
AK: Add Userspace<T>, a wrapper for userspace pointers This will be used in the kernel to wrap pointers into userspace memory without convenient direct access. The idea is to use the compiler to enforce that we don't dereference userspace pointers.
2020-07-31 14:26:44 +00:00
#include <AK/Types.h>
AK+Kernel: Remove implicit conversion from Userspace<T*> to FlatPtr This feels like it was a refactor transition kind of conversion. The places that were relying on it can easily be changed to explicitly ask for the ptr() or a new vaddr() method on Userspace<T*>. FlatPtr can still implicitly convert to Userspace<T> because the constructor is not explicit, but there's quite a few more places that are relying on that conversion.
2021-11-14 22:52:48 +00:00
#ifdef KERNEL
# include <Kernel/VirtualAddress.h>
#endif
AK: Add Userspace<T>, a wrapper for userspace pointers This will be used in the kernel to wrap pointers into userspace memory without convenient direct access. The idea is to use the compiler to enforce that we don't dereference userspace pointers.
2020-07-31 14:26:44 +00:00
namespace AK {
template<typename T>
AK+Everywhere: Make StdLibExtras templates less wrapper-y This commit makes the user-facing StdLibExtras templates and utilities arguably more nice-looking by removing the need to reach into the wrapper structs generated by them to get the value/type needed. The C++ standard library had to invent `_v` and `_t` variants (likely because of backwards compat), but we don't need to cater to any codebase except our own, so might as well have good things for free. :^)
2021-04-10 13:59:06 +00:00
concept PointerTypeName = IsPointer<T>;
AK: Hack Userspace<T> to not break Qt Creator syntax highlighting This is a very cheesy patch and I don't like it, but as Qt Creator does not grok C++20 concepts yet, this makes it possible to still use syntax highlighting. We'll remove this hack the moment it stops being a problem. Note that it doesn't actually affect the build since we use GCC, not Clang.
2020-08-01 17:34:53 +00:00
AK: Make C++ concepts support mandatory for compilers The latest GCC and Clang versions both support this, so we can freely use these in our code.
2021-06-19 11:13:31 +00:00
template<PointerTypeName T>
AK: Add Userspace<T>, a wrapper for userspace pointers This will be used in the kernel to wrap pointers into userspace memory without convenient direct access. The idea is to use the compiler to enforce that we don't dereference userspace pointers.
2020-07-31 14:26:44 +00:00
class Userspace {
public:
AK: Simplify constructors and conversions from nullptr_t Problem: - Many constructors are defined as `{}` rather than using the ` = default` compiler-provided constructor. - Some types provide an implicit conversion operator from `nullptr_t` instead of requiring the caller to default construct. This violates the C++ Core Guidelines suggestion to declare single-argument constructors explicit (https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#c46-by-default-declare-single-argument-constructors-explicit). Solution: - Change default constructors to use the compiler-provided default constructor. - Remove implicit conversion operators from `nullptr_t` and change usage to enforce type consistency without conversion.
2021-01-10 23:29:28 +00:00
Userspace() = default;
AK: Add Userspace<T>, a wrapper for userspace pointers This will be used in the kernel to wrap pointers into userspace memory without convenient direct access. The idea is to use the compiler to enforce that we don't dereference userspace pointers.
2020-07-31 14:26:44 +00:00
AK: Prevent confusing silent misuse of Userspace<T>
2020-08-22 14:45:52 +00:00
// Disable default implementations that would use surprising integer promotion.
Everywhere: Run clang-format
2022-04-01 17:58:27 +00:00
bool operator==(Userspace const&) const = delete;
bool operator<=(Userspace const&) const = delete;
bool operator>=(Userspace const&) const = delete;
bool operator<(Userspace const&) const = delete;
bool operator>(Userspace const&) const = delete;
AK: Prevent confusing silent misuse of Userspace<T>
2020-08-22 14:45:52 +00:00
AK: In Userspace.h, #if defined(KERNEL) => #ifdef KERNEL
2020-08-01 05:18:24 +00:00
#ifdef KERNEL
AK: Add Userspace<T>, a wrapper for userspace pointers This will be used in the kernel to wrap pointers into userspace memory without convenient direct access. The idea is to use the compiler to enforce that we don't dereference userspace pointers.
2020-07-31 14:26:44 +00:00
Userspace(FlatPtr ptr)
: m_ptr(ptr)
{
}
AK: Resolve clang-tidy readability-bool-conversion warnings ... In files included by Kernel/Process.cpp and Kernel/Thread.cpp
2021-11-06 20:12:16 +00:00
explicit operator bool() const { return m_ptr != 0; }
AK: Add Userspace<T>, a wrapper for userspace pointers This will be used in the kernel to wrap pointers into userspace memory without convenient direct access. The idea is to use the compiler to enforce that we don't dereference userspace pointers.
2020-07-31 14:26:44 +00:00
FlatPtr ptr() const { return m_ptr; }
AK+Kernel: Remove implicit conversion from Userspace<T*> to FlatPtr This feels like it was a refactor transition kind of conversion. The places that were relying on it can easily be changed to explicitly ask for the ptr() or a new vaddr() method on Userspace<T*>. FlatPtr can still implicitly convert to Userspace<T> because the constructor is not explicit, but there's quite a few more places that are relying on that conversion.
2021-11-14 22:52:48 +00:00
VirtualAddress vaddr() const { return VirtualAddress(m_ptr); }
T unsafe_userspace_ptr() const { return reinterpret_cast<T>(m_ptr); }
AK: Add Userspace<T>, a wrapper for userspace pointers This will be used in the kernel to wrap pointers into userspace memory without convenient direct access. The idea is to use the compiler to enforce that we don't dereference userspace pointers.
2020-07-31 14:26:44 +00:00
#else
Userspace(T ptr)
: m_ptr(ptr)
{
}
AK: Resolve clang-tidy readability-bool-conversion warnings ... In files included by Kernel/Process.cpp and Kernel/Thread.cpp
2021-11-06 20:12:16 +00:00
explicit operator bool() const { return m_ptr != nullptr; }
AK: Add Userspace<T>, a wrapper for userspace pointers This will be used in the kernel to wrap pointers into userspace memory without convenient direct access. The idea is to use the compiler to enforce that we don't dereference userspace pointers.
2020-07-31 14:26:44 +00:00
T ptr() const { return m_ptr; }
#endif
private:
AK: In Userspace.h, #if defined(KERNEL) => #ifdef KERNEL
2020-08-01 05:18:24 +00:00
#ifdef KERNEL
AK: Add Userspace<T>, a wrapper for userspace pointers This will be used in the kernel to wrap pointers into userspace memory without convenient direct access. The idea is to use the compiler to enforce that we don't dereference userspace pointers.
2020-07-31 14:26:44 +00:00
FlatPtr m_ptr { 0 };
#else
T m_ptr { nullptr };
#endif
};
AK: Add static_ptr_cast support for the Userspace<T> pointer type When using Userspace<T> there are certain syscalls where being able to cast between types is needed. You should be able to easily cast away the Userspace<T> wrapper, but it's perfectly safe to be able to cast the internal type that is being wrapped.
2020-08-07 07:38:36 +00:00
template<typename T, typename U>
Everywhere: Run clang-format
2022-04-01 17:58:27 +00:00
inline Userspace<T> static_ptr_cast(Userspace<U> const& ptr)
AK: Add static_ptr_cast support for the Userspace<T> pointer type When using Userspace<T> there are certain syscalls where being able to cast between types is needed. You should be able to easily cast away the Userspace<T> wrapper, but it's perfectly safe to be able to cast the internal type that is being wrapped.
2020-08-07 07:38:36 +00:00
{
#ifdef KERNEL
auto casted_ptr = static_cast<T>(ptr.unsafe_userspace_ptr());
#else
auto casted_ptr = static_cast<T>(ptr.ptr());
#endif
return Userspace<T>((FlatPtr)casted_ptr);
}
AK: Add Userspace<T>, a wrapper for userspace pointers This will be used in the kernel to wrap pointers into userspace memory without convenient direct access. The idea is to use the compiler to enforce that we don't dereference userspace pointers.
2020-07-31 14:26:44 +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
#if USING_AK_GLOBALLY
AK: Add static_ptr_cast support for the Userspace<T> pointer type When using Userspace<T> there are certain syscalls where being able to cast between types is needed. You should be able to easily cast away the Userspace<T> wrapper, but it's perfectly safe to be able to cast the internal type that is being wrapped.
2020-08-07 07:38:36 +00:00
using AK::static_ptr_cast;
AK: Prevent confusing silent misuse of Userspace<T>
2020-08-22 14:45:52 +00:00
using AK::Userspace;
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
#endif
Reference in a new issue Copy permalink