aboutsummaryrefslogtreecommitdiff
path: root/include/apos/mem_regions.h
blob: 38629f24d597a0e78368a1a69122450fc5552e8a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
#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 {
	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);

/**
 * Helper functions for converting between memory regions and page
 * mappings. Called by \ref map_fill_region().
 * \see map_fill_region() for further explanation.
 *
 * @param vmem Virtual memory space in which the operation is to be done.
 * @param offset Offset from where to start looking for next physical page. \see
 * alloc_page().
 * @param vaddr Current virtual address.
 * @param flags Virtual memory allocation flags.
 * @param order Order of physical page.
 * @param data Custom data.
 * @return \ref OK if succesful, \c INFO_TRGN if page order should be decreased,
 * anything else means error.
 */
typedef stat_t region_callback_t(struct vmem *vmem, 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 */