#ifndef APOS_MEM_REGIONS_H
#define APOS_MEM_REGIONS_H

/**
 * @file mem_regions.h
 * Memory region subsytem. Mainly used by the virtual memory subsytems, i.e. device and
 * user memory.
 */

#include <apos/mem.h>
#include <apos/types.h>
#include <apos/sp_tree.h>
#include <arch/vmem.h>

#define mem_container(ptr) container_of(ptr, struct mem_region, sp_n)
#define is_region_used(r)  __is_set(r->flags, MR_USED)
#define is_region_owned(r) __is_set(r->flags, MR_OWNED)
#define is_region_shared(r) __is_set(r->flags, MR_SHARED)
#define is_region_kept(r) __is_set(r->flags, MR_KEEP)

struct mem_region_root {
	struct sp_root free_regions;
	struct sp_root used_regions;
	struct mem_region *first;
};

struct mem_region {
	struct sp_node sp_n;

	struct mem_region *next;
	struct mem_region *prev;

	vmflags_t flags;

	vm_t end;
	vm_t start;
};

stat_t init_region(struct mem_region_root *r, vm_t start, size_t arena_size);
stat_t destroy_region(struct mem_region_root *r);

vm_t alloc_region(struct mem_region_root *r, size_t size, size_t *actual_size,
                  vmflags_t flags);
vm_t alloc_fixed_region(struct mem_region_root *r, vm_t start, size_t size,
                        size_t *actual_size, vmflags_t flags);
stat_t free_region(struct mem_region_root *r, vm_t start);
stat_t free_known_region(struct mem_region_root *r, struct mem_region *m);

struct mem_region *find_first_region(struct mem_region_root *r);
struct mem_region *find_used_region(struct mem_region_root *r, vm_t start);
struct mem_region *find_closest_used_region(struct mem_region_root *r,
                                            vm_t start);
struct mem_region *find_free_region(struct mem_region_root *r, size_t size,
                                    size_t *align);

typedef stat_t region_callback_t(struct vmem *b, pm_t *offset, vm_t vaddr,
                                 vmflags_t flags, enum mm_order order,
                                 void *data);

stat_t stat_region(struct mem_region_root *r, vm_t va, vmflags_t *flags);
stat_t mod_region(struct mem_region_root *r, vm_t va, vmflags_t flags);

vm_t map_fill_region(struct vmem *b, region_callback_t *mem_handler,
                     pm_t offset, vm_t start, size_t bytes, vmflags_t flags,
                     void *data);

#endif /* APOS_MEM_REGIONS_H */