space.h

Go to the documentation of this file.

#pragma once
 
#include <kernel/cpu/stack_pointer.h>
#include <kernel/fs/path.h>
#include <kernel/mem/paging_types.h>
#include <kernel/sched/wait.h>
#include <kernel/sync/lock.h>
 
#include <boot/boot_info.h>
 
#include <sys/bitmap.h>
#include <sys/list.h>
#include <sys/proc.h>
 
typedef enum
{
    SPACE_NONE = 0,
    SPACE_USE_PMM_BITMAP = 1 << 0,
    SPACE_MAP_KERNEL_BINARY = 1 << 1, 
    SPACE_MAP_KERNEL_HEAP = 1 << 2,   
    SPACE_MAP_IDENTITY = 1 << 3,      
} space_flags_t;
 
typedef void (*space_callback_func_t)(void* private);
 
typedef struct
{
    space_callback_func_t func;
    void* private;
    uint64_t pageAmount;
} space_callback_t;
 
typedef struct
{
    map_entry_t mapEntry;
    uint64_t pinCount; 
} space_pinned_page_t;
 
typedef struct space
{
    map_t pinnedPages;      
    page_table_t pageTable; 
    uintptr_t startAddress; 
    uintptr_t endAddress;   
    uintptr_t freeAddress;  
    space_flags_t flags;
    space_callback_t* callbacks;
    uint64_t callbacksLength; 
    bitmap_t callbackBitmap;  
    uint64_t bitmapBuffer[BITMAP_BITS_TO_QWORDS(PML_MAX_CALLBACK)];
    list_t cpus; 
    atomic_uint16_t shootdownAcks;
    lock_t lock;
} space_t;
 
#define SPACE_TLB_SHOOTDOWN_TIMEOUT (CLOCKS_PER_SEC)
 
uint64_t space_init(space_t* space, uintptr_t startAddress, uintptr_t endAddress, space_flags_t flags);
 
void space_deinit(space_t* space);
 
void space_load(space_t* space);
 
uint64_t space_pin(space_t* space, const void* address, uint64_t length, stack_pointer_t* userStack);
 
uint64_t space_pin_terminated(space_t* space, const void* address, const void* terminator, uint8_t objectSize,
    uint64_t maxCount, stack_pointer_t* userStack);
 
void space_unpin(space_t* space, const void* address, uint64_t length);
 
uint64_t space_check_access(space_t* space, const void* addr, uint64_t length);
 
typedef struct
{
    void* virtAddr;
    void* physAddr;
    uint64_t pageAmount;
    pml_flags_t flags;
} space_mapping_t;
 
uint64_t space_mapping_start(space_t* space, space_mapping_t* mapping, void* virtAddr, void* physAddr, uint64_t length,
    pml_flags_t flags);
 
pml_callback_id_t space_alloc_callback(space_t* space, uint64_t pageAmount, space_callback_func_t func, void* private);
 
void space_free_callback(space_t* space, pml_callback_id_t callbackId);
 
void space_tlb_shootdown(space_t* space, void* virtAddr, uint64_t pageAmount);
 
void* space_mapping_end(space_t* space, space_mapping_t* mapping, errno_t err);
 
bool space_is_mapped(space_t* space, const void* virtAddr, uint64_t length);