Process reference counting
[akaros.git] / kern / include / page_alloc.h
1 /* Copyright (c) 2009 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  */
7  
8 #ifndef PAGE_ALLOC_H
9 #define PAGE_ALLOC_H
10
11 #include <atomic.h>
12 #include <sys/queue.h>
13 #include <ros/error.h>
14 #include <arch/mmu.h>
15 #include <colored_page_alloc.h>
16
17 /****************** Page Structures *********************/
18 struct Page;
19 typedef size_t ppn_t;
20 typedef struct Page page_t;
21 typedef LIST_HEAD(PageList, Page) page_list_t;
22 typedef LIST_ENTRY(Page) page_list_entry_t;
23
24 /* TODO: this struct is not protected from concurrent operations in any
25  * function.  We may want a lock, but a better thing would be a good use of
26  * reference counting and atomic operations. */
27 struct Page {
28         page_list_entry_t LCKD(&colored_page_free_list_lock)page_link;
29     size_t page_ref;
30 };
31
32
33 /******** Externally visible global variables ************/
34 extern uint16_t RO llc_num_colors;
35 extern spinlock_t colored_page_free_list_lock;
36 extern page_list_t LCKD(&colored_page_free_list_lock) * RO CT(llc_num_colors)
37     colored_page_free_list;
38
39 /*************** Functional Interface *******************/
40 void page_alloc_init(void);
41 error_t page_alloc(page_t *SAFE *page);
42 void *CT(1 << order) get_cont_pages(size_t order, int flags);
43 void free_cont_pages(void *buf, size_t order);
44 error_t page_alloc_specific(page_t *SAFE *page, size_t ppn);
45 error_t l1_page_alloc(page_t *SAFE *page, size_t color);
46 error_t l2_page_alloc(page_t *SAFE *page, size_t color);
47 error_t l3_page_alloc(page_t *SAFE *page, size_t color);
48 error_t page_free(page_t *SAFE page);
49 void page_incref(page_t *SAFE page);
50 void page_decref(page_t *SAFE page);
51 size_t page_getref(page_t *SAFE page);
52 void page_setref(page_t *SAFE page, size_t val);
53 int page_is_free(size_t ppn);
54
55 #endif //PAGE_ALLOC_H
56