summaryrefslogtreecommitdiffhomepage
path: root/dev/kernel/KernelKit/MemoryMgr.h
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal.elmahrouss@icloud.com>2025-03-23 19:13:48 +0100
committerAmlal El Mahrouss <amlal.elmahrouss@icloud.com>2025-03-23 19:15:17 +0100
commita13e1c0911c0627184bc38f18c7fdda64447b3ad (patch)
tree073a62c09bf216e85a3f310376640fa1805147f9 /dev/kernel/KernelKit/MemoryMgr.h
parent149fa096eb306d03686b3b67e813cf1a78e08cd0 (diff)
meta(kernel): Reworked repository's filesystem structure.
Removing useless parts of the project too. Signed-off-by: Amlal El Mahrouss <amlal.elmahrouss@icloud.com>
Diffstat (limited to 'dev/kernel/KernelKit/MemoryMgr.h')
-rw-r--r--dev/kernel/KernelKit/MemoryMgr.h87
1 files changed, 87 insertions, 0 deletions
diff --git a/dev/kernel/KernelKit/MemoryMgr.h b/dev/kernel/KernelKit/MemoryMgr.h
new file mode 100644
index 00000000..93718493
--- /dev/null
+++ b/dev/kernel/KernelKit/MemoryMgr.h
@@ -0,0 +1,87 @@
+/* -------------------------------------------
+
+ Copyright (C) 2024-2025, Amlal EL Mahrouss, all rights reserved.
+
+------------------------------------------- */
+
+#ifndef INC_KERNEL_HEAP_H
+#define INC_KERNEL_HEAP_H
+
+/// @date 30/01/24
+/// @file: MemoryMgr.h
+/// @brief: heap allocation support.
+
+#include <NewKit/KernelPanic.h>
+#include <KernelKit/LPC.h>
+#include <HintsKit/CompilerHint.h>
+
+namespace NeOS
+{
+ /// @brief Declare pointer as free.
+ /// @param heap_ptr the pointer.
+ /// @return a status code regarding the deallocation.
+ Int32 mm_delete_heap(VoidPtr heap_ptr);
+
+ /// @brief Declare a new size for heap_ptr.
+ /// @param heap_ptr the pointer.
+ /// @return unsupported always returns nullptr.
+ VoidPtr mm_realloc_heap(VoidPtr heap_ptr, SizeT new_sz);
+
+ /// @brief Check if pointer is a valid Kernel pointer.
+ /// @param heap_ptr the pointer
+ /// @return if it exists it returns true.
+ Boolean mm_is_valid_heap(VoidPtr heap_ptr);
+
+ /// @brief Allocate chunk of memory.
+ /// @param sz Size of pointer
+ /// @param wr Read Write bit.
+ /// @param user User enable bit.
+ /// @return The newly allocated pointer, or nullptr.
+ VoidPtr mm_new_heap(const SizeT sz, const Bool wr, const Bool user);
+
+ /// @brief Protect the heap with a CRC value.
+ /// @param heap_ptr pointer.
+ /// @return if it valid: point has crc now., otherwise fail.
+ Boolean mm_protect_heap(VoidPtr heap_ptr);
+
+ /// @brief Makes a Kernel page.
+ /// @param heap_ptr the page pointer.
+ /// @return status code
+ Int32 mm_make_page(VoidPtr heap_ptr);
+
+ /// @brief Overwrites and set the flags of a heap header.
+ /// @param heap_ptr the pointer to update.
+ /// @param flags the flags to set.
+ Int32 mm_make_flags(VoidPtr heap_ptr, UInt64 flags);
+
+ /// @brief Gets the flags of a heap header.
+ /// @param heap_ptr the pointer to get.
+ UInt64 mm_get_flags(VoidPtr heap_ptr);
+
+ /// @brief Allocate C++ class.
+ /// @param cls The class to allocate.
+ /// @param args The args to pass.
+ template <typename T, typename... Args>
+ inline BOOL mm_new_class(_Input _Output T** cls, _Input Args&&... args)
+ {
+ if (*cls)
+ {
+ err_global_get() = NeOS::kErrorInvalidData;
+ return NO;
+ }
+
+ *cls = new T(move(args)...);
+ return *cls;
+ }
+
+ /// @brief Delete and nullify C++ class.
+ /// @param cls The class to delete.
+ template <typename T>
+ inline Void mm_delete_class(_Input _Output T** cls)
+ {
+ delete *cls;
+ *cls = nullptr;
+ }
+} // namespace NeOS
+
+#endif // !INC_KERNEL_HEAP_H