MHR-23: :boom:, refactors.

- Move NewBoot to /Boot, thus making Kernel directory only containing the kernel.

Signed-off-by: Amlal El Mahrouss <amlal.elmahrouss@icloud.com>

1 files changed, 373 insertions, 0 deletions

diff --git a/Boot/BootKit/BootKit.hxx b/Boot/BootKit/BootKit.hxx
new file mode 100644
index 00000000..179ca141
--- /dev/null
+++ b/Boot/BootKit/BootKit.hxx
@@ -0,0 +1,373 @@
+/* -------------------------------------------
+
+    Copyright SoftwareLabs
+
+------------------------------------------- */
+
+/***********************************************************************************/
+/// @file Boot.hxx
+/// @brief Bootloader Programming Interface.
+/***********************************************************************************/
+
+#pragma once
+
+#include <BootKit/HW/ATA.hxx>
+#include <CompilerKit/Version.hxx>
+
+/// include NewFS header and Support header as well.
+
+#include <FSKit/NewFS.hxx>
+#include <cstring>
+#include <BootKit/Vendor/Support.hxx>
+
+/***********************************************************************************/
+/// Include other APIs.
+/***********************************************************************************/
+
+#include <NewKit/Defines.hpp>
+#include <Builtins/ATA/ATA.hxx>
+
+#include <FirmwareKit/EFI.hxx>
+
+/***********************************************************************************/
+/// Framebuffer helpers.
+/***********************************************************************************/
+
+class BTextWriter;
+class BFileReader;
+class BFileRunner;
+class BVersionString;
+
+using namespace NewOS;
+
+typedef Char* PEFImagePtr;
+typedef Char* PEImagePtr;
+
+typedef WideChar CharacterTypeUTF16;
+typedef Char	 CharacterTypeUTF8;
+
+namespace EFI
+{
+	extern void ThrowError(const CharacterTypeUTF16* ErrorCode,
+						   const CharacterTypeUTF16* Reason) noexcept;
+}
+
+/**
+ * @brief BootKit Text Writer class
+ * Writes to UEFI StdOut.
+ */
+class BTextWriter final
+{
+	BTextWriter& _Write(const Long& num);
+
+public:
+	BTextWriter& Write(const Long& num);
+	BTextWriter& Write(const Char* str);
+	BTextWriter& Write(const CharacterTypeUTF16* str);
+	BTextWriter& WriteCharacter(CharacterTypeUTF16 c);
+
+public:
+	explicit BTextWriter() = default;
+	~BTextWriter()		   = default;
+
+public:
+	BTextWriter& operator=(const BTextWriter&) = default;
+	BTextWriter(const BTextWriter&)			   = default;
+};
+
+NewOS::SizeT BCopyMem(CharacterTypeUTF16* dest, CharacterTypeUTF16* src, const NewOS::SizeT len);
+
+NewOS::SizeT BSetMem(CharacterTypeUTF8* src, const CharacterTypeUTF8 byte, const NewOS::SizeT len);
+
+/// String length functions.
+
+/// @brief get string length.
+NewOS::SizeT BStrLen(const CharacterTypeUTF16* ptr);
+
+/// @brief set memory with custom value.
+NewOS::SizeT BSetMem(CharacterTypeUTF16* src, const CharacterTypeUTF16 byte, const NewOS::SizeT len);
+
+/**
+ * @brief BootKit File Reader class
+ * Reads the Firmware Boot partition and filesystem.
+ */
+class BFileReader final
+{
+public:
+	explicit BFileReader(const CharacterTypeUTF16* path,
+						 EfiHandlePtr			   ImageHandle);
+	~BFileReader();
+
+public:
+	Void ReadAll(SizeT until, SizeT chunk = 4096);
+
+	enum
+	{
+		kOperationOkay,
+		kNotSupported,
+		kEmptyDirectory,
+		kNoSuchEntry,
+		kIsDirectory,
+		kCount,
+	};
+
+	/// @brief error code getter.
+	/// @return the error code.
+	Int32& Error();
+
+	/// @brief blob getter.
+	/// @return the blob.
+	VoidPtr Blob();
+
+	/// @breif Size getter.
+	/// @return the size of the file.
+	UInt64& Size();
+
+public:
+	BFileReader& operator=(const BFileReader&) = default;
+	BFileReader(const BFileReader&)			   = default;
+
+private:
+	Int32			   mErrorCode{kOperationOkay};
+	VoidPtr			   mBlob{nullptr};
+	CharacterTypeUTF16 mPath[kPathLen];
+	BTextWriter		   mWriter;
+	EfiFileProtocol*   mFile{nullptr};
+	UInt64			   mSizeFile{0};
+};
+
+typedef UInt8* BlobType;
+
+class BVersionString final
+{
+public:
+	static const CharacterTypeUTF16* Shared()
+	{
+		return BOOTLOADER_VERSION;
+	}
+};
+
+/***********************************************************************************/
+/// Provide some useful processor features.
+/***********************************************************************************/
+
+#ifdef __EFI_x86_64__
+
+/***
+ * Common processor instructions.
+ */
+
+EXTERN_C void	Out8(UInt16 port, UInt8 value);
+EXTERN_C void	Out16(UInt16 port, UInt16 value);
+EXTERN_C void	Out32(UInt16 port, UInt32 value);
+EXTERN_C UInt8	In8(UInt16 port);
+EXTERN_C UInt16 In16(UInt16 port);
+EXTERN_C UInt32 In32(UInt16 port);
+
+EXTERN_C void rt_hlt();
+EXTERN_C void rt_cli();
+EXTERN_C void rt_sti();
+EXTERN_C void rt_cld();
+EXTERN_C void rt_std();
+
+#endif // __EFI_x86_64__
+
+static inline const UInt32 kRgbRed	 = 0x000000FF;
+static inline const UInt32 kRgbGreen = 0x0000FF00;
+static inline const UInt32 kRgbBlue	 = 0x00FF0000;
+static inline const UInt32 kRgbBlack = 0x00000000;
+static inline const UInt32 kRgbWhite = 0x00FFFFFF;
+
+#define kBKBootFileMime "boot-x/file"
+#define kBKBootDirMime	"boot-x/dir"
+
+/// @brief BootKit Disk Formatter.
+template <typename BootDev>
+class BDiskFormatFactory final
+{
+public:
+	/// @brief File entry for **BDiskFormatFactory**.
+	struct BFileDescriptor final
+	{
+		Char  fFileName[kNewFSNodeNameLen];
+		Int32 fKind;
+	};
+
+public:
+	explicit BDiskFormatFactory() = default;
+	explicit BDiskFormatFactory(BootDev dev)
+		: fDiskDev(dev)
+	{
+	}
+
+	~BDiskFormatFactory() = default;
+
+	NEWOS_COPY_DELETE(BDiskFormatFactory);
+
+	/// @brief Format disk.
+	/// @param Partition Name
+	/// @param Blobs.
+	/// @param Number of blobs.
+	/// @retval True disk has been formatted.
+	/// @retval False failed to format.
+	Boolean Format(const char* partName, BFileDescriptor* fileBlobs, SizeT blobCount);
+
+	/// @brief check if partition is good.
+	Bool IsPartitionValid() noexcept
+	{
+		fDiskDev.Leak().mBase = (kNewFSAddressAsLba);
+		fDiskDev.Leak().mSize = BootDev::kSectorSize;
+
+		Char buf[BootDev::kSectorSize] = {0};
+
+		fDiskDev.Read(buf, BootDev::kSectorSize);
+
+		NewPartitionBlock* blockPart = reinterpret_cast<NewPartitionBlock*>(buf);
+
+		BTextWriter writer;
+
+		for (SizeT indexMag = 0UL; indexMag < kNewFSIdentLen; ++indexMag)
+		{
+			if (blockPart->Ident[indexMag] != kNewFSIdent[indexMag])
+				return false;
+		}
+
+		writer.Write(L"Device Size: ").Write(this->fDiskDev.GetDiskSize()).Write(L"\r");
+
+		if (blockPart->DiskSize != this->fDiskDev.GetDiskSize() ||
+			blockPart->DiskSize < 1 ||
+			blockPart->SectorSize != BootDev::kSectorSize ||
+			blockPart->Version != kNewFSVersionInteger)
+		{
+			EFI::ThrowError(L"Invalid-Disk-Geometry", L"Invalid disk geometry.");
+		}
+		else if (blockPart->PartitionName[0] == 0)
+		{
+			EFI::ThrowError(L"Invalid-Partition-Name", L"Invalid disk partition.");
+		}
+
+		writer.Write(L"Device Partition: ").Write(blockPart->PartitionName).Write(L" is healthy.\r");
+
+		return true;
+	}
+
+private:
+	/// @brief Write all of the requested catalogs into the filesystem.
+	/// @param fileBlobs the blobs.
+	/// @param blobCount the number of blobs to write.
+	/// @param partBlock the NewFS partition block.
+	Boolean WriteRootCatalog(BFileDescriptor* fileBlobs, SizeT blobCount, NewPartitionBlock& partBlock)
+	{
+		if (partBlock.SectorSize != BootDev::kSectorSize)
+			return false;
+
+		BFileDescriptor* blob	  = fileBlobs;
+		Lba				 startLba = partBlock.StartCatalog;
+		BTextWriter		 writer;
+
+		Char bufCatalog[sizeof(NewCatalog)] = {0};
+
+		constexpr auto cNewFSCatalogPadding = 4;
+
+		NewCatalog* catalogKind	 = (NewCatalog*)bufCatalog;
+		catalogKind->PrevSibling = startLba;
+		catalogKind->NextSibling = (startLba + (sizeof(NewCatalog) * cNewFSCatalogPadding));
+
+		/// Fill catalog kind.
+		catalogKind->Kind  = blob->fKind;
+		catalogKind->Flags = kNewFSFlagCreated;
+
+		/// before going to forks, we must check for the catalog name first.
+		if (blob->fKind == kNewFSCatalogKindDir &&
+			blob->fFileName[strlen(blob->fFileName) - 1] != '/')
+		{
+			EFI::ThrowError(L"Developer-Error", L"This is caused by the developer of the bootloader.");
+		}
+
+		writer.Write((catalogKind->Kind == kNewFSCatalogKindFile) ? L"New Boot: Write-File: " : L"New Boot: Write-Directory: ").Write(blob->fFileName).Write(L"\r");
+
+		memcpy(catalogKind->Name, blob->fFileName, strlen(blob->fFileName));
+
+		fDiskDev.Leak().mBase = startLba;
+		fDiskDev.Leak().mSize = sizeof(NewCatalog);
+
+		fDiskDev.Write((Char*)bufCatalog, sizeof(NewCatalog));
+
+		--partBlock.FreeCatalog;
+		--partBlock.FreeSectors;
+
+		memset(bufCatalog, 0, sizeof(NewCatalog));
+
+		return true;
+	}
+
+private:
+	BootDev fDiskDev;
+};
+
+/// @brief Format disk.
+/// @param Partition Name
+/// @param Blobs.
+/// @param Number of blobs.
+/// @retval True disk has been formatted.
+/// @retval False failed to format.
+template <typename BootDev>
+inline Boolean BDiskFormatFactory<BootDev>::Format(const char*							partName,
+												   BDiskFormatFactory::BFileDescriptor* fileBlobs,
+												   SizeT								blobCount)
+{
+	if (!fileBlobs || !blobCount)
+		return false; /// sanity check
+
+	/// convert the sector into something that the disk understands.
+	SizeT sectorSz					= BootDev::kSectorSize;
+	Char  buf[BootDev::kSectorSize] = {0};
+
+	NewPartitionBlock* partBlock = reinterpret_cast<NewPartitionBlock*>(buf);
+
+	memcpy(partBlock->Ident, kNewFSIdent, kNewFSIdentLen - 1);
+	memcpy(partBlock->PartitionName, partName, strlen(partName));
+
+	/// @note A catalog roughly equal to a sector.
+
+	constexpr auto cMinimumDiskSize = 10; // at minimum.
+
+	/// @note also look at EPM headers, for free part blocks.
+
+	if (GIB(fDiskDev.GetDiskSize()) < cMinimumDiskSize)
+	{
+		EFI::ThrowError(L"Disk-Too-Tiny", L"Disk can't contain a New Filesystem partition.");
+		return false;
+	}
+
+	partBlock->Version		= kNewFSVersionInteger;
+	partBlock->CatalogCount = blobCount;
+	partBlock->Kind			= kNewFSHardDrive;
+	partBlock->SectorSize	= sectorSz;
+	partBlock->FreeCatalog	= fDiskDev.GetSectorsCount() / sizeof(NewCatalog);
+	partBlock->SectorCount	= fDiskDev.GetSectorsCount();
+	partBlock->FreeSectors	= fDiskDev.GetSectorsCount();
+	partBlock->StartCatalog = kNewFSCatalogStartAddress;
+	partBlock->DiskSize		= fDiskDev.GetDiskSize();
+	partBlock->Flags |= kNewFSPartitionTypeBoot;
+
+	/// if we can write a root catalog, then write the partition block.
+	if (this->WriteRootCatalog(fileBlobs, blobCount, *partBlock))
+	{
+		fDiskDev.Leak().mBase = kNewFSAddressAsLba;
+		fDiskDev.Leak().mSize = sectorSz;
+
+		fDiskDev.Write(buf, sectorSz);
+
+		BTextWriter writer;
+		writer.Write(L"New Boot: Write-Partition, OK.\r");
+
+		return true;
+	}
+	else
+	{
+		EFI::ThrowError(L"Filesystem-Failure-Part", L"Filesystem couldn't be partitioned.");
+	}
+
+	return false;
+}