jsix/src/kernel/memory_pages.h

#pragma once
/// \file memory_pages.h
/// The page memory manager and related definitions.

#include <stddef.h>
#include <stdint.h>

#include "kutil/enum_bitfields.h"

struct page_block;
struct free_page_header;


/// Manager for allocation of physical pages.
class page_manager
{
public:
	static const uint64_t page_size = 0x1000;
	static const uint64_t high_offset = 0xffff800000000000;

	page_manager();

	void * map_pages(uint64_t address, unsigned count);
	void unmap_pages(uint64_t address, unsigned count);

private:
	friend void memory_initialize_managers(const void *, size_t, size_t);

	/// Set up the memory manager from bootstraped memory
	void init(
			page_block *free,
			page_block *used,
			page_block *block_cache,
			uint64_t scratch_start,
			uint64_t scratch_pages,
			uint64_t scratch_cur);

	/// Initialize the virtual memory manager based on this object's state
	void init_memory_manager();

	/// Create a `page_block` struct or pull one from the cache.
	/// \returns  An empty `page_block` struct
	page_block * get_block();

	/// Return a list of `page_block` structs to the cache.
	/// \arg block   A list of `page_block` structs
	void free_blocks(page_block *block);

	/// Consolidate the free and used block lists. Return freed blocks
	/// to the cache.
	void consolidate_blocks();

	page_block *m_free; ///< Free pages list
	page_block *m_used; ///< In-use pages list

	page_block *m_block_cache; ///< Cache of unused page_block structs
	free_page_header *m_page_cache; ///< Cache of free pages to use for tables

	page_manager(const page_manager &) = delete;
};

/// Global page manager.
extern page_manager g_page_manager;

/// Flags used by `page_block`.
enum class page_block_flags : uint32_t
{
	free         = 0x00000000,  ///< Not a flag, value for free memory
	used         = 0x00000001,  ///< Memory is in use
	mapped       = 0x00000002,  ///< Memory is mapped to virtual address
	pending_free = 0x00000004,  ///< Memory should be freed

	nonvolatile  = 0x00000010,  ///< Memory is non-volatile storage
	acpi_wait    = 0x00000020,  ///< Memory should be freed after ACPI init
	permanent    = 0x80000000,  ///< Memory is permanently unusable

	max_flags
};
IS_BITFIELD(page_block_flags);


/// A block of contiguous pages. Each `page_block` represents contiguous
/// physical pages with the same attributes. A `page_block *` is also a
/// linked list of such structures.
struct page_block
{
	uint64_t physical_address;
	uint64_t virtual_address;
	uint32_t count;
	page_block_flags flags;
	page_block *next;

	inline bool has_flag(page_block_flags f) const { return bitfield_contains(flags, f); }
	inline uint64_t physical_end() const { return physical_address + (count * page_manager::page_size); }
	inline uint64_t virtual_end() const { return virtual_address + (count * page_manager::page_size); }
	inline bool contains(uint64_t vaddr) const { return vaddr >= virtual_address && vaddr < virtual_end(); }

	/// Helper to zero out a block and optionally set the next pointer.
	/// \arg next  [optional] The value for the `next` pointer
	void zero(page_block *set_next = nullptr);

	/// Helper to copy a bock from another block
	/// \arg other  The block to copy from
	void copy(page_block *other);

	/// \name Linked list functions
	/// Functions to act on a `page_block *` as a linked list
	/// @{

	/// Count the items in this linked list.
	/// \returns  The number of entries in the list.
	size_t list_count();

	/// Append the gien block or list to this lit.
	/// \arg list  The list to append to the current list
	void list_append(page_block *list);

	/// Sorted-insert of a block into the list.
	/// \arg block  The single block to insert
	/// \returns    The new list head
	page_block * list_insert(page_block *block);

	/// Traverse the list, joining adjacent blocks where possible.
	/// \returns  A linked list of freed page_block structures.
	page_block * list_consolidate();

	/// Traverse the list, printing debug info on this list.
	/// \arg name  [optional] String to print as the name of this list
	/// \arg show_permanent [optional] If false, hide unmapped blocks
	void list_dump(const char *name = nullptr, bool show_unmapped = false);

	/// @}
};


/// Struct to allow easy accessing of a memory page being used as a page table.
struct page_table
{
	uint64_t entries[512];
	inline page_table * next(int i) const {
		return reinterpret_cast<page_table *>(entries[i] & ~0xfffull);
	}
};


/// Helper struct for computing page table indices of a given address.
struct page_table_indices
{
	page_table_indices(uint64_t v = 0) :
		index{
			(v >> 39) & 0x1ff,
			(v >> 30) & 0x1ff,
			(v >> 21) & 0x1ff,
			(v >> 12) & 0x1ff }
	{}

	/// Get the index for a given level of page table.
	uint64_t & operator[](size_t i) { return index[i]; }
	uint64_t index[4]; ///< Indices for each level of tables.
};


/// Calculate a page-aligned address.
/// \arg p    The address to align.
/// \returns  The next page-aligned address _after_ `p`.
template <typename T> inline T page_align(T p)
{
	return ((p - 1) & ~(page_manager::page_size - 1)) + page_manager::page_size;
}

/// Calculate a page-table-aligned address. That is, an address that is
/// page-aligned to the first page in a page table.
/// \arg p    The address to align.
/// \returns  The next page-table-aligned address _after_ `p`.
template <typename T> inline T page_table_align(T p) { return ((p - 1) & ~0x1fffffull) + 0x200000; }

/// Low-level routine for mapping a number of pages into the given page table.
/// \arg pml4       The root page table to map into
/// \arg phys_addr  The starting physical address of the pages to be mapped
/// \arg virt_addr  The starting virtual address ot the memory to be mapped
/// \arg count      The number of pages to map
/// \arg free_pages A pointer to a list of free, mapped pages to use for new page tables.
/// \returns        The number of pages consumed from `free_pages`.
unsigned page_in(
		page_table *pml4,
		uint64_t phys_addr,
		uint64_t virt_addr,
		uint64_t count,
		page_table *free_pages);

/// Low-level routine for unmapping a number of pages from the given page table.
/// \arg pml4       The root page table for this mapping
/// \arg virt_addr  The starting virtual address ot the memory to be unmapped
/// \arg count      The number of pages to unmap
void page_out(
		page_table *pml4,
		uint64_t virt_addr,
		uint64_t count);