IMP: :boom: Breaking changes some checks are needed to be done.

Signed-off-by: Amlal <amlalelmahrouss@icloud.com>

1 files changed, 86 insertions, 0 deletions

diff --git a/dev/Kernel/KernelKit/Heap.h b/dev/Kernel/KernelKit/Heap.h
new file mode 100644
index 00000000..4a3afff4
--- /dev/null
+++ b/dev/Kernel/KernelKit/Heap.h
@@ -0,0 +1,86 @@
+/* -------------------------------------------
+
+	Copyright (C) 2024, TQ B.V, all rights reserved.
+
+------------------------------------------- */
+
+#ifndef INC_KERNEL_HEAP_H
+#define INC_KERNEL_HEAP_H
+
+// last-rev 30/01/24
+// file: Heap.h
+// description: heap allocation support.
+
+#include <NewKit/Stop.h>
+#include <KernelKit/LPC.h>
+#include <HintKit/CompilerHint.h>
+
+namespace Kernel
+{
+	/// @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 Void mm_new_class(_Input _Output T** cls, _Input Args&&... args)
+	{
+		if (*cls)
+		{
+			err_global_get() = Kernel::kErrorInvalidData;
+			return;
+		}
+
+		*cls = new T(move(args)...);
+	}
+
+	/// @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 Kernel
+
+#endif // !INC_KERNEL_HEAP_H