Fixes page reference counting wrt to upage_alloc()
[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 #ifndef PAGE_ALLOC_H
9 #define PAGE_ALLOC_H
10
11 #include <atomic.h>
12 #include <sys/queue.h>
13 #include <error.h>
14 #include <arch/mmu.h>
15 #include <colored_page_alloc.h>
16 #include <process.h>
17 #include <kref.h>
18
19 struct page_map;                /* preprocessor games */
20
21 /****************** Page Structures *********************/
22 struct page;
23 typedef size_t ppn_t;
24 typedef struct page page_t;
25 typedef LIST_HEAD(PageList, page) page_list_t;
26 typedef LIST_ENTRY(page) page_list_entry_t;
27
28 /* Per-page flag bits related to their state in the page cache */
29 #define PG_LOCKED               0x001   /* involved in an IO op */
30 #define PG_UPTODATE             0x002   /* page map, filled with file data */
31 #define PG_DIRTY                0x004   /* page map, data is dirty */
32
33 /* TODO: this struct is not protected from concurrent operations in any
34  * function.  We may want a lock, but a better thing would be a good use of
35  * reference counting and atomic operations. */
36 struct page {
37         LIST_ENTRY(page)                        pg_link;        /* membership in various lists */
38         struct kref                                     pg_kref;
39         unsigned int                            pg_flags;
40         struct page_map                         *pg_mapping;
41         unsigned long                           pg_index;
42 };
43
44 /******** Externally visible global variables ************/
45 extern uint8_t* global_cache_colors_map;
46 extern spinlock_t colored_page_free_list_lock;
47 extern page_list_t LCKD(&colored_page_free_list_lock) * RO CT(llc_num_colors)
48     colored_page_free_list;
49
50 /*************** Functional Interface *******************/
51 void page_alloc_init(void);
52 void colored_page_alloc_init(void);
53
54 error_t upage_alloc(struct proc* p, page_t *SAFE *page, int zero);
55 error_t kpage_alloc(page_t *SAFE *page);
56 error_t upage_alloc_specific(struct proc* p, page_t *SAFE *page, size_t ppn);
57 error_t kpage_alloc_specific(page_t *SAFE *page, size_t ppn);
58
59 void *CT(1 << order) get_cont_pages(size_t order, int flags);
60 void free_cont_pages(void *buf, size_t order);
61
62 void page_incref(page_t *SAFE page);
63 void page_decref(page_t *SAFE page);
64 void page_setref(page_t *SAFE page, size_t val);
65
66 int page_is_free(size_t ppn);
67 void lock_page(struct page *page);
68 void unlock_page(struct page *page);
69
70 #endif //PAGE_ALLOC_H
71