Update version-controlled scripts for bash
[akaros.git] / kern / include / page_alloc.h
1 /* Copyright (c) 2009, 2010 The Regents of the University  of California.
2  * See the COPYRIGHT files at the top of this source tree for full
3  * license information.
4  *
5  * Kevin Klues <klueska@cs.berkeley.edu>
6  * Barret Rhoden <brho@cs.berkeley.edu> */
7
8 #pragma once
9
10 #include <atomic.h>
11 #include <sys/queue.h>
12 #include <error.h>
13 #include <arch/mmu.h>
14 #include <colored_page_alloc.h>
15 #include <process.h>
16 #include <kref.h>
17 #include <kthread.h>
18 #include <multiboot.h>
19
20 struct page_map;                /* preprocessor games */
21
22 /****************** Page Structures *********************/
23 struct page;
24 typedef size_t ppn_t;
25 typedef struct page page_t;
26 typedef BSD_LIST_HEAD(PageList, page) page_list_t;
27 typedef BSD_LIST_ENTRY(page) page_list_entry_t;
28
29 /* Per-page flag bits related to their state in the page cache */
30 #define PG_LOCKED               0x001   /* involved in an IO op */
31 #define PG_UPTODATE             0x002   /* page map, filled with file data */
32 #define PG_DIRTY                0x004   /* page map, data is dirty */
33 #define PG_BUFFER               0x008   /* is a buffer page, has BHs */
34 #define PG_PAGEMAP              0x010   /* belongs to a page map */
35 #define PG_REMOVAL              0x020   /* Working flag for page map removal */
36
37 /* TODO: this struct is not protected from concurrent operations in some
38  * functions.  If you want to lock on it, use the spinlock in the semaphore.
39  * This structure is getting pretty big (and we're wasting RAM).  If it becomes
40  * an issue, we can dynamically allocate some of these things when we're a
41  * buffer page (in a page mapping) */
42 struct page {
43         BSD_LIST_ENTRY(page)            pg_link;        /* membership in various lists */
44         struct kref                                     pg_kref;
45         atomic_t                                        pg_flags;
46         struct page_map                         *pg_mapping; /* for debugging... */
47         unsigned long                           pg_index;
48         void                                            **pg_tree_slot;
49         void                                            *pg_private;    /* type depends on page usage */
50         struct semaphore                        pg_sem;         /* for blocking on IO */
51         uint64_t                                gpa;            /* physical address in guest */
52                                                                 /* pg_private is overloaded. */
53 };
54
55 /******** Externally visible global variables ************/
56 extern uint8_t* global_cache_colors_map;
57 extern spinlock_t colored_page_free_list_lock;
58 extern page_list_t *colored_page_free_list;
59
60 /*************** Functional Interface *******************/
61 void page_alloc_init(struct multiboot_info *mbi);
62 void colored_page_alloc_init(void);
63
64 error_t upage_alloc(struct proc* p, page_t **page, int zero);
65 error_t kpage_alloc(page_t **page);
66 void *kpage_alloc_addr(void);
67 void *kpage_zalloc_addr(void);
68 error_t upage_alloc_specific(struct proc* p, page_t **page, size_t ppn);
69 error_t kpage_alloc_specific(page_t **page, size_t ppn);
70
71 void *get_cont_pages(size_t order, int flags);
72 void *get_cont_pages_node(int node, size_t order, int flags);
73 void *get_cont_phys_pages_at(size_t order, physaddr_t at, int flags);
74 void free_cont_pages(void *buf, size_t order);
75
76 void page_incref(page_t *page);
77 void page_decref(page_t *page);
78 void page_setref(page_t *page, size_t val);
79
80 int page_is_free(size_t ppn);
81 void lock_page(struct page *page);
82 void unlock_page(struct page *page);
83 void print_pageinfo(struct page *page);
84 static inline bool page_is_pagemap(struct page *page);
85
86 static inline bool page_is_pagemap(struct page *page)
87 {
88         return atomic_read(&page->pg_flags) & PG_PAGEMAP ? true : false;
89 }