AK+Kernel: Add AK::AtomicRefCounted and use everywhere in the kernel

Instead of having two separate implementations of AK::RefCounted, one for userspace and one for kernelspace, there is now RefCounted and AtomicRefCounted.
lanmonster · Aug 20, 2022 · e475263 · e475263
1 parent 4889eb0
commit e475263
Show file tree

Hide file tree

Showing 45 changed files with 81 additions and 94 deletions.
diff --git a/Kernel/Library/ThreadSafeRefCounted.h → AK/AtomicRefCounted.h b/Kernel/Library/ThreadSafeRefCounted.h → AK/AtomicRefCounted.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018-2020, Andreas Kling <[email protected]>
+ * Copyright (c) 2018-2022, Andreas Kling <[email protected]>
  *
  * SPDX-License-Identifier: BSD-2-Clause
  */
@@ -15,9 +15,9 @@
 
 namespace AK {
 
-class RefCountedBase {
- AK_MAKE_NONCOPYABLE(RefCountedBase);
- AK_MAKE_NONMOVABLE(RefCountedBase);
+class AtomicRefCountedBase {
+ AK_MAKE_NONCOPYABLE(AtomicRefCountedBase);
+ AK_MAKE_NONMOVABLE(AtomicRefCountedBase);
 
 public:
  using RefCountType = unsigned int;
@@ -48,8 +48,8 @@ class RefCountedBase {
  }
 
 protected:
- RefCountedBase() = default;
- ~RefCountedBase()
+ AtomicRefCountedBase() = default;
+ ~AtomicRefCountedBase()
  {
  VERIFY(m_ref_count.load(AK::MemoryOrder::memory_order_relaxed) == 0);
  }
@@ -65,7 +65,7 @@ class RefCountedBase {
 };
 
 template<typename T>
-class RefCounted : public RefCountedBase {
+class AtomicRefCounted : public AtomicRefCountedBase {
 public:
  bool unref() const
  {
@@ -83,5 +83,5 @@ class RefCounted : public RefCountedBase {
 
 }
 
-using AK::RefCounted;
-using AK::RefCountedBase;
+using AK::AtomicRefCounted;
+using AK::AtomicRefCountedBase;
diff --git a/AK/RefCounted.h b/AK/RefCounted.h
@@ -6,15 +6,11 @@
 
 #pragma once
 
-#ifdef KERNEL
-# include <Kernel/Library/ThreadSafeRefCounted.h>
-#else
-
-# include <AK/Assertions.h>
-# include <AK/Checked.h>
-# include <AK/Noncopyable.h>
-# include <AK/Platform.h>
-# include <AK/StdLibExtras.h>
+#include <AK/Assertions.h>
+#include <AK/Checked.h>
+#include <AK/Noncopyable.h>
+#include <AK/Platform.h>
+#include <AK/StdLibExtras.h>
 
 namespace AK {
 
@@ -67,7 +63,7 @@ class RefCounted : public RefCountedBase {
  if (new_ref_count == 0) {
  if constexpr (requires { that->will_be_destroyed(); })
  that->will_be_destroyed();
- delete static_cast<const T*>(this);
+ delete static_cast<T const*>(this);
  return true;
  }
  return false;
@@ -78,5 +74,3 @@ class RefCounted : public RefCountedBase {
 
 using AK::RefCounted;
 using AK::RefCountedBase;
-
-#endif
diff --git a/Kernel/Arch/aarch64/IRQController.h b/Kernel/Arch/aarch64/IRQController.h
@@ -6,14 +6,14 @@
 
 #pragma once
 
-#include <AK/RefCounted.h>
+#include <AK/AtomicRefCounted.h>
 #include <AK/Types.h>
 
 namespace Kernel {
 
 class GenericInterruptHandler;
 
-class IRQController : public RefCounted<IRQController> {
+class IRQController : public AtomicRefCounted<IRQController> {
 public:
  virtual ~IRQController() = default;
 

diff --git a/Kernel/Arch/x86/IRQController.h b/Kernel/Arch/x86/IRQController.h
@@ -6,7 +6,7 @@
 
 #pragma once
 
-#include <AK/RefCounted.h>
+#include <AK/AtomicRefCounted.h>
 #include <AK/Types.h>
 #include <Kernel/Interrupts/GenericInterruptHandler.h>
 
@@ -19,7 +19,7 @@ enum class IRQControllerType {
  i82093AA = 2 /* Intel 82093AA I/O ADVANCED PROGRAMMABLE INTERRUPT CONTROLLER (IOAPIC) */
 };
 
-class IRQController : public RefCounted<IRQController> {
+class IRQController : public AtomicRefCounted<IRQController> {
 public:
  virtual ~IRQController() = default;
 

diff --git a/Kernel/Arch/x86/InterruptManagement.h b/Kernel/Arch/x86/InterruptManagement.h
@@ -9,7 +9,6 @@
 #include <AK/Function.h>
 #include <AK/NonnullOwnPtr.h>
 #include <AK/OwnPtr.h>
-#include <AK/RefCounted.h>
 #include <AK/RefPtr.h>
 #include <AK/Types.h>
 #include <Kernel/Arch/x86/IRQController.h>

diff --git a/Kernel/Bus/USB/USBController.h b/Kernel/Bus/USB/USBController.h
@@ -6,14 +6,14 @@
 
 #pragma once
 
+#include <AK/AtomicRefCounted.h>
 #include <AK/Error.h>
-#include <AK/RefCounted.h>
 #include <Kernel/Bus/USB/USBDevice.h>
 #include <Kernel/Bus/USB/USBTransfer.h>
 
 namespace Kernel::USB {
 
-class USBController : public RefCounted<USBController> {
+class USBController : public AtomicRefCounted<USBController> {
 public:
  virtual ~USBController() = default;
 

diff --git a/Kernel/Bus/USB/USBDevice.h b/Kernel/Bus/USB/USBDevice.h
@@ -27,7 +27,7 @@ class USBConfiguration;
 //
 // https://www.ftdichip.com/Support/Documents/TechnicalNotes/TN_113_Simplified%20Description%20of%20USB%20Device%20Enumeration.pdf
 class Hub;
-class Device : public RefCounted<Device> {
+class Device : public AtomicRefCounted<Device> {
 public:
  enum class DeviceSpeed : u8 {
  FullSpeed = 0,

diff --git a/Kernel/Bus/USB/USBHub.h b/Kernel/Bus/USB/USBHub.h
@@ -6,7 +6,6 @@
 
 #pragma once
 
-#include <AK/RefCounted.h>
 #include <AK/Types.h>
 #include <Kernel/Bus/USB/USBDevice.h>
 

diff --git a/Kernel/Bus/USB/USBTransfer.h b/Kernel/Bus/USB/USBTransfer.h
@@ -6,6 +6,7 @@
 
 #pragma once
 
+#include <AK/AtomicRefCounted.h>
 #include <AK/OwnPtr.h>
 #include <AK/RefPtr.h>
 #include <Kernel/Bus/USB/PacketTypes.h>
@@ -17,7 +18,7 @@
 // TODO: Callback stuff in this class please!
 namespace Kernel::USB {
 
-class Transfer : public RefCounted<Transfer> {
+class Transfer final : public AtomicRefCounted<Transfer> {
 public:
  static ErrorOr<NonnullRefPtr<Transfer>> try_create(Pipe&, u16 length, Memory::Region& dma_buffer);
 

diff --git a/Kernel/Bus/VirtIO/Console.h b/Kernel/Bus/VirtIO/Console.h
@@ -14,7 +14,7 @@
 namespace Kernel::VirtIO {
 class Console
  : public VirtIO::Device
- , public RefCounted<Console> {
+ , public AtomicRefCounted<Console> {
  friend VirtIO::ConsolePort;
 
 public:

diff --git a/Kernel/Bus/VirtIO/RNG.h b/Kernel/Bus/VirtIO/RNG.h
@@ -6,7 +6,7 @@
 
 #pragma once
 
-#include <AK/RefCounted.h>
+#include <AK/AtomicRefCounted.h>
 #include <Kernel/Bus/VirtIO/Device.h>
 #include <Kernel/Devices/CharacterDevice.h>
 #include <Kernel/Random.h>
@@ -16,7 +16,7 @@ namespace Kernel::VirtIO {
 #define REQUESTQ 0
 
 class RNG final
- : public RefCounted<RNG>
+ : public AtomicRefCounted<RNG>
  , public VirtIO::Device {
 public:
  static NonnullRefPtr<RNG> must_create(PCI::DeviceIdentifier const&);

diff --git a/Kernel/Devices/AsyncDeviceRequest.h b/Kernel/Devices/AsyncDeviceRequest.h
@@ -20,7 +20,7 @@ class Device;
 
 extern WorkQueue* g_io_work;
 
-class AsyncDeviceRequest : public RefCounted<AsyncDeviceRequest> {
+class AsyncDeviceRequest : public AtomicRefCounted<AsyncDeviceRequest> {
  AK_MAKE_NONCOPYABLE(AsyncDeviceRequest);
  AK_MAKE_NONMOVABLE(AsyncDeviceRequest);
 

diff --git a/Kernel/Devices/Audio/Controller.h b/Kernel/Devices/Audio/Controller.h
@@ -23,7 +23,7 @@ namespace Kernel {
 
 class AudioManagement;
 class AudioController
- : public RefCounted<AudioController>
+ : public AtomicRefCounted<AudioController>
  , public Weakable<AudioController> {
  friend class AudioManagement;
 

diff --git a/Kernel/Devices/HID/I8042Controller.h b/Kernel/Devices/HID/I8042Controller.h
@@ -6,7 +6,7 @@
 
 #pragma once
 
-#include <AK/RefCounted.h>
+#include <AK/AtomicRefCounted.h>
 #include <Kernel/Devices/HID/KeyboardDevice.h>
 #include <Kernel/Devices/HID/MouseDevice.h>
 #include <Kernel/Locking/Spinlock.h>
@@ -83,7 +83,7 @@ class I8042Device {
 class PS2KeyboardDevice;
 class PS2MouseDevice;
 class HIDManagement;
-class I8042Controller : public RefCounted<I8042Controller> {
+class I8042Controller final : public AtomicRefCounted<I8042Controller> {
  friend class PS2KeyboardDevice;
  friend class PS2MouseDevice;
 

diff --git a/Kernel/FileSystem/File.h b/Kernel/FileSystem/File.h
@@ -6,9 +6,9 @@
 
 #pragma once
 
+#include <AK/AtomicRefCounted.h>
 #include <AK/Error.h>
 #include <AK/NonnullRefPtr.h>
-#include <AK/RefCounted.h>
 #include <AK/StringView.h>
 #include <AK/Types.h>
 #include <AK/Weakable.h>
@@ -71,10 +71,10 @@ class FileBlockerSet final : public Thread::BlockerSet {
 // - Should create a Region in the Process and return it if successful.
 
 class File
- : public RefCounted<File>
+ : public AtomicRefCounted<File>
  , public Weakable<File> {
 public:
- virtual bool unref() const { return RefCounted<File>::unref(); }
+ virtual bool unref() const { return AtomicRefCounted<File>::unref(); }
  virtual void will_be_destroyed() { }
  virtual ~File();
 

diff --git a/Kernel/FileSystem/FileSystem.h b/Kernel/FileSystem/FileSystem.h
@@ -6,8 +6,8 @@
 
 #pragma once
 
+#include <AK/AtomicRefCounted.h>
 #include <AK/Error.h>
-#include <AK/RefCounted.h>
 #include <AK/RefPtr.h>
 #include <AK/StringView.h>
 #include <Kernel/FileSystem/InodeIdentifier.h>
@@ -18,7 +18,7 @@
 
 namespace Kernel {
 
-class FileSystem : public RefCounted<FileSystem> {
+class FileSystem : public AtomicRefCounted<FileSystem> {
  friend class Inode;
 
 public:

diff --git a/Kernel/FileSystem/ISO9660FileSystem.h b/Kernel/FileSystem/ISO9660FileSystem.h
@@ -283,7 +283,7 @@ class ISO9660FS final : public BlockBasedFileSystem {
  friend ISO9660DirectoryIterator;
 
 public:
- struct DirectoryEntry : public RefCounted<DirectoryEntry> {
+ struct DirectoryEntry final : public AtomicRefCounted<DirectoryEntry> {
  u32 extent { 0 };
  u32 length { 0 };
 

diff --git a/Kernel/FileSystem/OpenFileDescription.h b/Kernel/FileSystem/OpenFileDescription.h
@@ -6,8 +6,8 @@
 
 #pragma once
 
+#include <AK/AtomicRefCounted.h>
 #include <AK/Badge.h>
-#include <AK/RefCounted.h>
 #include <Kernel/FileSystem/FIFO.h>
 #include <Kernel/FileSystem/Inode.h>
 #include <Kernel/FileSystem/InodeMetadata.h>
@@ -22,7 +22,7 @@ class OpenFileDescriptionData {
  virtual ~OpenFileDescriptionData() = default;
 };
 
-class OpenFileDescription : public RefCounted<OpenFileDescription> {
+class OpenFileDescription final : public AtomicRefCounted<OpenFileDescription> {
 public:
  static ErrorOr<NonnullRefPtr<OpenFileDescription>> try_create(Custody&);
  static ErrorOr<NonnullRefPtr<OpenFileDescription>> try_create(File&);

diff --git a/Kernel/FileSystem/Plan9FileSystem.h b/Kernel/FileSystem/Plan9FileSystem.h
@@ -69,7 +69,7 @@ class Plan9FS final : public FileBackedFileSystem {
  mutable Spinlock m_lock { LockRank::None };
  };
 
- struct ReceiveCompletion : public RefCounted<ReceiveCompletion> {
+ struct ReceiveCompletion final : public AtomicRefCounted<ReceiveCompletion> {
  mutable Spinlock lock { LockRank::None };
  bool completed { false };
  const u16 tag;

diff --git a/Kernel/FileSystem/SysFS/Component.h b/Kernel/FileSystem/SysFS/Component.h
@@ -6,9 +6,9 @@
 
 #pragma once
 
+#include <AK/AtomicRefCounted.h>
 #include <AK/Error.h>
 #include <AK/Function.h>
-#include <AK/RefCounted.h>
 #include <AK/RefPtr.h>
 #include <AK/StringView.h>
 #include <AK/Types.h>
@@ -24,7 +24,7 @@ struct SysFSInodeData : public OpenFileDescriptionData {
 };
 
 class SysFSDirectory;
-class SysFSComponent : public RefCounted<SysFSComponent> {
+class SysFSComponent : public AtomicRefCounted<SysFSComponent> {
  friend class SysFSDirectory;
 
 public:

diff --git a/Kernel/Firmware/ACPI/Definitions.h b/Kernel/Firmware/ACPI/Definitions.h
@@ -6,9 +6,7 @@
 
 #pragma once
 
-#include <AK/RefCounted.h>
 #include <AK/Types.h>
-#include <AK/Vector.h>
 #include <Kernel/PhysicalAddress.h>
 
 namespace Kernel::ACPI {

diff --git a/Kernel/FutexQueue.h b/Kernel/FutexQueue.h
@@ -6,16 +6,14 @@
 
 #pragma once
 
-#include <AK/Atomic.h>
-#include <AK/RefCounted.h>
+#include <AK/AtomicRefCounted.h>
 #include <Kernel/Locking/Spinlock.h>
-#include <Kernel/Memory/VMObject.h>
 #include <Kernel/Thread.h>
 
 namespace Kernel {
 
 class FutexQueue final
- : public RefCounted<FutexQueue>
+ : public AtomicRefCounted<FutexQueue>
  , public Thread::BlockerSet {
 public:
  FutexQueue();

diff --git a/Kernel/Graphics/Console/Console.h b/Kernel/Graphics/Console/Console.h
@@ -6,13 +6,13 @@
 
 #pragma once
 
-#include <AK/RefCounted.h>
+#include <AK/AtomicRefCounted.h>
 #include <AK/Types.h>
 #include <Kernel/Graphics/GenericGraphicsAdapter.h>
 
 namespace Kernel::Graphics {
 
-class Console : public RefCounted<Console> {
+class Console : public AtomicRefCounted<Console> {
 public:
  // Stanadard VGA text mode colors
  enum Color : u8 {

diff --git a/Kernel/Graphics/Console/GenericFramebufferConsole.h b/Kernel/Graphics/Console/GenericFramebufferConsole.h
@@ -6,7 +6,6 @@
 
 #pragma once
 
-#include <AK/RefCounted.h>
 #include <AK/Types.h>
 #include <Kernel/Graphics/Console/Console.h>
 #include <Kernel/PhysicalAddress.h>