1 /*
2  * Copyright (c) 2015 Google, Inc. All rights reserved
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining
5  * a copy of this software and associated documentation files
6  * (the "Software"), to deal in the Software without restriction,
7  * including without limitation the rights to use, copy, modify, merge,
8  * publish, distribute, sublicense, and/or sell copies of the Software,
9  * and to permit persons to whom the Software is furnished to do so,
10  * subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be
13  * included in all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
19  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
20  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
21  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22  */
23 #ifndef __LIB_PAGE_ALLOC_H
24 #define __LIB_PAGE_ALLOC_H
25 
26 #include <stddef.h>
27 #include <sys/types.h>
28 #include <compiler.h>
29 
30 // to pick up PAGE_SIZE, PAGE_ALIGN, etc
31 #if WITH_KERNEL_VM
32 #include <kernel/vm.h>
33 #else
34 #include <kernel/novm.h>
35 #endif
36 
37 /* A simple page-aligned wrapper around the pmm or novm implementation of
38  * the underlying physical page allocator. Used by system heaps or any
39  * other user that wants pages of memory but doesn't want to use LK
40  * specific apis.
41  */
42 
43 __BEGIN_CDECLS;
44 
45 #define PAGE_ALLOC_ANY_ARENA (-1)
46 
47 /* Pass PAGE_ALLOC_ANY_ARENA as the arena mask if you don't care which arena
48  * the allocation comes from. The arena mask is only used on non-virtual memory
49  * platforms.
50  */
51 void *page_alloc(size_t pages, int arena_mask);
52 void page_free(void *ptr, size_t pages);
53 
54 #if WITH_KERNEL_VM
55 struct page_range {
56     void *address;
57     size_t size;
58 };
59 #endif
60 
61 int page_get_arenas(struct page_range* ranges, int number_of_ranges);
62 
63 // You can call this once at the start, and it will either return a page or it
64 // will return some non-page-aligned memory that would otherwise go to waste.
65 void *page_first_alloc(size_t *size_return);
66 
67 __END_CDECLS;
68 
69 #endif
70