#ifndef SOCKS_VM_H_
#define SOCKS_VM_H_

#include <stddef.h>
#include <socks/types.h>
#include <socks/status.h>
#include <socks/queue.h>

#define VM_PAGE_SIZE 0x1000

typedef enum vm_zone_id {
	VM_ZONE_DMA		= 1u,
	VM_ZONE_NORMAL		= 2u,
	VM_ZONE_HIGHMEM		= 3u,
	VM_ZONE_COUNT
} vm_zone_id_t;

typedef enum vm_memory_region_status {
	VM_REGION_FREE		= 0x01u,
	VM_REGION_RESERVED	= 0x02u,
} vm_memory_region_status_t;

typedef struct vm_zone_descriptor {
	vm_zone_id_t zd_id;
	phys_addr_t zd_base;
	phys_addr_t zd_limit;
} vm_zone_descriptor_t;

typedef struct vm_zone {
	unsigned char z_reserved[32];
} vm_zone_t;

typedef struct vm_pg_data {
	vm_zone_t pg_zones[VM_ZONE_COUNT];
} vm_pg_data_t;

typedef struct vm_region {
	vm_memory_region_status_t r_status;
	phys_addr_t r_base;
	phys_addr_t r_limit;
} vm_region_t;

typedef enum vm_page_flags {
	VM_PAGE_RESERVED = 0x01u,
} vm_page_flags_t;

typedef struct vm_page {
	uint32_t p_flags; /* vm_page_flags_t bitfield */

	/* buddy allocator free page list head */
	queue_entry_t p_buddy_list;

	/* order of the page block that this page belongs too */
	unsigned int p_order;
} __attribute__((packed)) vm_page_t;

extern kern_status_t vm_bootstrap(void);

extern void vm_page_init(vm_page_t *pg);

#endif