kmalloc_incref()
[akaros.git] / kern / src / page_alloc.c
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 #ifdef __SHARC__
9 #pragma nosharc
10 #endif
11
12 #include <sys/queue.h>
13 #include <bitmask.h>
14 #include <page_alloc.h>
15 #include <pmap.h>
16 #include <string.h>
17 #include <kmalloc.h>
18 #include <blockdev.h>
19
20 #define l1 (available_caches.l1)
21 #define l2 (available_caches.l2)
22 #define l3 (available_caches.l3)
23
24 static void __page_decref(page_t *CT(1) page);
25 static error_t __page_alloc_specific(page_t** page, size_t ppn);
26
27 #ifdef CONFIG_PAGE_COLORING
28 #define NUM_KERNEL_COLORS 8
29 #else
30 #define NUM_KERNEL_COLORS 1
31 #endif
32
33
34 // Global list of colors allocated to the general purpose memory allocator
35 uint8_t* global_cache_colors_map;
36 size_t global_next_color = 0;
37
38 void colored_page_alloc_init()
39 {
40         global_cache_colors_map = 
41                kmalloc(BYTES_FOR_BITMASK(llc_cache->num_colors), 0);
42         CLR_BITMASK(global_cache_colors_map, llc_cache->num_colors);
43         for(int i = 0; i < llc_cache->num_colors/NUM_KERNEL_COLORS; i++)
44                 cache_color_alloc(llc_cache, global_cache_colors_map);
45 }
46
47 /* Initializes a page.  We can optimize this a bit since 0 usually works to init
48  * most structures, but we'll hold off on that til it is a problem. */
49 static void __page_init(struct page *page)
50 {
51         memset(page, 0, sizeof(page_t));
52         page_setref(page, 1);
53         sem_init(&page->pg_sem, 0);
54 }
55
56 #define __PAGE_ALLOC_FROM_RANGE_GENERIC(page, base_color, range, predicate) \
57         /* Find first available color with pages available */                   \
58     /* in the given range */                                                \
59         int i = base_color;                                                     \
60         for (i; i < (base_color+range); i++) {                                  \
61                 if((predicate))                                                     \
62                         break;                                                          \
63         }                                                                       \
64         /* Allocate a page from that color */                                   \
65         if(i < (base_color+range)) {                                            \
66                 *page = LIST_FIRST(&colored_page_free_list[i]);                     \
67                 LIST_REMOVE(*page, pg_link);                                        \
68                 __page_init(*page);                                                 \
69                 return i;                                                           \
70         }                                                                       \
71         return -ENOMEM;
72
73 static ssize_t __page_alloc_from_color_range(page_t** page,  
74                                            uint16_t base_color,
75                                            uint16_t range) 
76 {
77         __PAGE_ALLOC_FROM_RANGE_GENERIC(page, base_color, range, 
78                          !LIST_EMPTY(&colored_page_free_list[i]));
79 }
80
81 static ssize_t __page_alloc_from_color_map_range(page_t** page, uint8_t* map, 
82                                               size_t base_color, size_t range)
83 {  
84         __PAGE_ALLOC_FROM_RANGE_GENERIC(page, base_color, range, 
85                     GET_BITMASK_BIT(map, i) && !LIST_EMPTY(&colored_page_free_list[i]))
86 }
87
88 static ssize_t __colored_page_alloc(uint8_t* map, page_t** page, 
89                                                size_t next_color)
90 {
91         ssize_t ret;
92         if((ret = __page_alloc_from_color_map_range(page, map, 
93                                    next_color, llc_cache->num_colors - next_color)) < 0)
94                 ret = __page_alloc_from_color_map_range(page, map, 0, next_color);
95         return ret;
96 }
97
98 /* Internal version of page_alloc_specific.  Grab the lock first. */
99 static error_t __page_alloc_specific(page_t** page, size_t ppn)
100 {
101         page_t* sp_page = ppn2page(ppn);
102         if (!page_is_free(ppn))
103                 return -ENOMEM;
104         *page = sp_page;
105         LIST_REMOVE(*page, pg_link);
106         __page_init(*page);
107         return 0;
108 }
109
110 /**
111  * @brief Allocates a physical page from a pool of unused physical memory.
112  * Note, the page IS reference counted.
113  *
114  * Zeroes the page.
115  *
116  * @param[out] page  set to point to the Page struct
117  *                   of the newly allocated page
118  *
119  * @return ESUCCESS on success
120  * @return -ENOMEM  otherwise
121  */
122 error_t upage_alloc(struct proc* p, page_t** page, int zero)
123 {
124         spin_lock_irqsave(&colored_page_free_list_lock);
125         ssize_t ret = __colored_page_alloc(p->cache_colors_map, 
126                                              page, p->next_cache_color);
127         spin_unlock_irqsave(&colored_page_free_list_lock);
128
129         if (ret >= 0) {
130                 if(zero)
131                         memset(page2kva(*page),0,PGSIZE);
132                 p->next_cache_color = (ret + 1) & (llc_cache->num_colors-1);
133                 return 0;
134         }
135         return ret;
136 }
137
138 /* Allocates a refcounted page of memory for the kernel's use */
139 error_t kpage_alloc(page_t** page) 
140 {
141         ssize_t ret;
142         spin_lock_irqsave(&colored_page_free_list_lock);
143         if ((ret = __page_alloc_from_color_range(page, global_next_color, 
144                                     llc_cache->num_colors - global_next_color)) < 0)
145                 ret = __page_alloc_from_color_range(page, 0, global_next_color);
146
147         if (ret >= 0) {
148                 global_next_color = ret;        
149                 ret = ESUCCESS;
150         }
151         spin_unlock_irqsave(&colored_page_free_list_lock);
152         
153         return ret;
154 }
155
156 /* Helper: allocates a refcounted page of memory for the kernel's use and
157  * returns the kernel address (kernbase), or 0 on error. */
158 void *kpage_alloc_addr(void)
159 {
160         struct page *a_page;
161         if (kpage_alloc(&a_page))
162                 return 0;
163         return page2kva(a_page);
164 }
165
166 void *kpage_zalloc_addr(void)
167 {
168         void *retval = kpage_alloc_addr();
169         if (retval)
170                 memset(retval, 0, PGSIZE);
171         return retval;
172 }
173
174 /**
175  * @brief Allocated 2^order contiguous physical pages.  Will increment the
176  * reference count for the pages.
177  *
178  * @param[in] order order of the allocation
179  * @param[in] flags memory allocation flags
180  *
181  * @return The KVA of the first page, NULL otherwise.
182  */
183 void *get_cont_pages(size_t order, int flags)
184 {
185         size_t npages = 1 << order;     
186
187         size_t naddrpages = max_paddr / PGSIZE;
188         // Find 'npages' free consecutive pages
189         int first = -1;
190         spin_lock_irqsave(&colored_page_free_list_lock);
191         for(int i=(naddrpages-1); i>=(npages-1); i--) {
192                 int j;
193                 for(j=i; j>=(i-(npages-1)); j--) {
194                         if( !page_is_free(j) ) {
195                                 i = j - 1;
196                                 break;
197                         }
198                 }
199                 if( j == (i-(npages-1)-1)) {
200                         first = j+1;
201                         break;
202                 }
203         }
204         //If we couldn't find them, return NULL
205         if( first == -1 ) {
206                 spin_unlock_irqsave(&colored_page_free_list_lock);
207                 return NULL;
208         }
209
210         for(int i=0; i<npages; i++) {
211                 page_t* page;
212                 __page_alloc_specific(&page, first+i);
213         }
214         spin_unlock_irqsave(&colored_page_free_list_lock);
215         return ppn2kva(first);
216 }
217
218 /**
219  * @brief Allocated 2^order contiguous physical pages.  Will increment the
220  * reference count for the pages. Get them from NUMA node node.
221  *
222  * @param[in] node which node to allocate from. Unimplemented.
223  * @param[in] order order of the allocation
224  * @param[in] flags memory allocation flags
225  *
226  * @return The KVA of the first page, NULL otherwise.
227  */
228 void *get_cont_pages_node(int node, size_t order, int flags)
229 {
230         return get_cont_pages(order, flags);
231 }
232
233 void free_cont_pages(void *buf, size_t order)
234 {
235         size_t npages = 1 << order;     
236         spin_lock_irqsave(&colored_page_free_list_lock);
237         for (size_t i = kva2ppn(buf); i < kva2ppn(buf) + npages; i++) {
238                 page_t* page = ppn2page(i);
239                 __page_decref(ppn2page(i));
240                 assert(page_is_free(i));
241         }
242         spin_unlock_irqsave(&colored_page_free_list_lock);
243         return; 
244 }
245
246 /*
247  * Allocates a specific physical page.
248  * Does NOT set the contents of the physical page to zero -
249  * the caller must do that if necessary.
250  *
251  * ppn         -- the page number to allocate
252  * *page       -- is set to point to the Page struct 
253  *                of the newly allocated page
254  *
255  * RETURNS 
256  *   ESUCCESS  -- on success
257  *   -ENOMEM   -- otherwise 
258  */
259 error_t upage_alloc_specific(struct proc* p, page_t** page, size_t ppn)
260 {
261         spin_lock_irqsave(&colored_page_free_list_lock);
262         __page_alloc_specific(page, ppn);
263         spin_unlock_irqsave(&colored_page_free_list_lock);
264         return 0;
265 }
266
267 error_t kpage_alloc_specific(page_t** page, size_t ppn)
268 {
269         spin_lock_irqsave(&colored_page_free_list_lock);
270         __page_alloc_specific(page, ppn);
271         spin_unlock_irqsave(&colored_page_free_list_lock);
272         return 0;
273 }
274
275 /* Check if a page with the given physical page # is free. */
276 int page_is_free(size_t ppn) {
277         page_t* page = ppn2page(ppn);
278         if (kref_refcnt(&page->pg_kref))
279                 return FALSE;
280         return TRUE;
281 }
282
283 /*
284  * Increment the reference count on a page
285  */
286 void page_incref(page_t *page)
287 {
288         kref_get(&page->pg_kref, 1);
289 }
290
291 /* Decrement the reference count on a page, freeing it if there are no more
292  * refs. */
293 void page_decref(page_t *page)
294 {
295         spin_lock_irqsave(&colored_page_free_list_lock);
296         __page_decref(page);
297         spin_unlock_irqsave(&colored_page_free_list_lock);
298 }
299
300 /* Decrement the reference count on a page, freeing it if there are no more
301  * refs.  Don't call this without holding the lock already. */
302 static void __page_decref(page_t *page)
303 {
304         kref_put(&page->pg_kref);
305 }
306
307 /* Kref release function. */
308 static void page_release(struct kref *kref)
309 {
310         struct page *page = container_of(kref, struct page, pg_kref);
311
312         if (atomic_read(&page->pg_flags) & PG_BUFFER)
313                 free_bhs(page);
314         /* Give our page back to the free list.  The protections for this are that
315          * the list lock is grabbed by page_decref. */
316         LIST_INSERT_HEAD(
317            &(colored_page_free_list[get_page_color(page2ppn(page), llc_cache)]),
318            page,
319            pg_link
320         );
321 }
322
323 /* Helper when initializing a page - just to prevent the proliferation of
324  * page_release references (and because this function is sitting around in the
325  * code).  Sets the reference count on a page to a specific value, usually 1. */
326 void page_setref(page_t *page, size_t val)
327 {
328         kref_init(&page->pg_kref, page_release, val); 
329 }
330
331 /* Attempts to get a lock on the page for IO operations.  If it is already
332  * locked, it will block the kthread until it is unlocked.  Note that this is
333  * really a "sleep on some event", not necessarily the IO, but it is "the page
334  * is ready". */
335 void lock_page(struct page *page)
336 {
337         /* when this returns, we have are the ones to have locked the page */
338         sem_down(&page->pg_sem);
339         assert(!(atomic_read(&page->pg_flags) & PG_LOCKED));
340         atomic_or(&page->pg_flags, PG_LOCKED);
341 }
342
343 /* Unlocks the page, and wakes up whoever is waiting on the lock */
344 void unlock_page(struct page *page)
345 {
346         atomic_and(&page->pg_flags, ~PG_LOCKED);
347         sem_up(&page->pg_sem);
348 }
349
350 void print_pageinfo(struct page *page)
351 {
352         int i;
353         if (!page) {
354                 printk("Null page\n");
355                 return;
356         }
357         printk("Page %d (%p), Flags: 0x%08x Refcnt: %d\n", page2ppn(page),
358                page2kva(page), atomic_read(&page->pg_flags),
359                kref_refcnt(&page->pg_kref));
360         if (page->pg_mapping) {
361                 printk("\tMapped into object %p at index %d\n",
362                        page->pg_mapping->pm_host, page->pg_index);
363         }
364         if (atomic_read(&page->pg_flags) & PG_BUFFER) {
365                 struct buffer_head *bh = (struct buffer_head*)page->pg_private;
366                 i = 0;
367                 while (bh) {
368                         printk("\tBH %d: buffer: %p, sector: %d, nr_sector: %d\n", i,
369                                bh->bh_buffer, bh->bh_sector, bh->bh_nr_sector);
370                         i++;
371                         bh = bh->bh_next;
372                 }
373                 printk("\tPage is %sup to date\n",
374                        atomic_read(&page->pg_flags) & PG_UPTODATE ? "" : "not ");
375         }
376         printk("\tPage is %slocked\n",
377                atomic_read(&page->pg_flags) & PG_LOCKED ? "" : "un");
378         printk("\tPage is %s\n",
379                atomic_read(&page->pg_flags) & PG_DIRTY ? "dirty" : "clean");
380 }