sys_read() from /dev/stdin
[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 <arch/bitmask.h>
14 #include <page_alloc.h>
15 #include <pmap.h>
16 #include <string.h>
17 #include <kmalloc.h>
18
19 #define l1 (available_caches.l1)
20 #define l2 (available_caches.l2)
21 #define l3 (available_caches.l3)
22
23 static void __page_decref(page_t *CT(1) page);
24 static void __page_incref(page_t *CT(1) page);
25 static error_t __page_alloc_specific(page_t** page, size_t ppn);
26 static error_t __page_free(page_t *CT(1) page);
27
28 #ifdef __CONFIG_PAGE_COLORING__
29 #define NUM_KERNEL_COLORS 8
30 #else
31 #define NUM_KERNEL_COLORS 1
32 #endif
33
34
35 // Global list of colors allocated to the general purpose memory allocator
36 uint8_t* global_cache_colors_map;
37 size_t global_next_color = 0;
38
39 void colored_page_alloc_init()
40 {
41         global_cache_colors_map = 
42                kmalloc(BYTES_FOR_BITMASK(llc_cache->num_colors), 0);
43         CLR_BITMASK(global_cache_colors_map, llc_cache->num_colors);
44         for(int i = 0; i < llc_cache->num_colors/NUM_KERNEL_COLORS; i++)
45                 cache_color_alloc(llc_cache, global_cache_colors_map);
46 }
47
48 /**
49  * @brief Clear a Page structure.
50  *
51  * The result has null links and 0 refcount.
52  * Note that the corresponding physical page is NOT initialized!
53  */
54 static void __page_clear(page_t *SAFE page)
55 {
56         memset(page, 0, sizeof(page_t));
57 }
58
59 #define __PAGE_ALLOC_FROM_RANGE_GENERIC(page, base_color, range, predicate) \
60         /* Find first available color with pages available */                   \
61     /* in the given range */                                                \
62         int i = base_color;                                                     \
63         for (i; i < (base_color+range); i++) {                                  \
64                 if((predicate))                                                     \
65                         break;                                                          \
66         }                                                                       \
67         /* Allocate a page from that color */                                   \
68         if(i < (base_color+range)) {                                            \
69                 *page = LIST_FIRST(&colored_page_free_list[i]);                     \
70                 LIST_REMOVE(*page, pg_link);                                      \
71                 __page_clear(*page);                                                \
72                 return i;                                                           \
73         }                                                                       \
74         return -ENOMEM;
75
76 static ssize_t __page_alloc_from_color_range(page_t** page,  
77                                            uint16_t base_color,
78                                            uint16_t range) 
79 {
80         __PAGE_ALLOC_FROM_RANGE_GENERIC(page, base_color, range, 
81                          !LIST_EMPTY(&colored_page_free_list[i]));
82 }
83
84 static ssize_t __page_alloc_from_color_map_range(page_t** page, uint8_t* map, 
85                                               size_t base_color, size_t range)
86 {  
87         __PAGE_ALLOC_FROM_RANGE_GENERIC(page, base_color, range, 
88                     GET_BITMASK_BIT(map, i) && !LIST_EMPTY(&colored_page_free_list[i]))
89 }
90
91 static ssize_t __colored_page_alloc(uint8_t* map, page_t** page, 
92                                                size_t next_color)
93 {
94         ssize_t ret;
95         if((ret = __page_alloc_from_color_map_range(page, map, 
96                                    next_color, llc_cache->num_colors - next_color)) < 0)
97                 ret = __page_alloc_from_color_map_range(page, map, 0, next_color);
98         return ret;
99 }
100
101 /* Internal version of page_alloc_specific.  Grab the lock first. */
102 static error_t __page_alloc_specific(page_t** page, size_t ppn)
103 {
104         page_t* sp_page = ppn2page(ppn);
105         if (atomic_read(&sp_page->pg_refcnt) != 0)
106                 return -ENOMEM;
107         *page = sp_page;
108         LIST_REMOVE(*page, pg_link);
109
110         __page_clear(*page);
111         return 0;
112 }
113
114 /**
115  * @brief Allocates a physical page from a pool of unused physical memory.
116  *
117  * Zeroes the page.
118  *
119  * @param[out] page  set to point to the Page struct
120  *                   of the newly allocated page
121  *
122  * @return ESUCCESS on success
123  * @return -ENOMEM  otherwise
124  */
125 error_t upage_alloc(struct proc* p, page_t** page, int zero)
126 {
127         spin_lock_irqsave(&colored_page_free_list_lock);
128         ssize_t ret = __colored_page_alloc(p->cache_colors_map, 
129                                              page, p->next_cache_color);
130         spin_unlock_irqsave(&colored_page_free_list_lock);
131
132         if(ret >= 0)
133         {
134                 if(zero)
135                         memset(page2kva(*page),0,PGSIZE);
136                 p->next_cache_color = (ret + 1) & (llc_cache->num_colors-1);
137                 return 0;
138         }
139         return ret;
140 }
141
142 error_t kpage_alloc(page_t** page) 
143 {
144         ssize_t ret;
145         spin_lock_irqsave(&colored_page_free_list_lock);
146         if((ret = __page_alloc_from_color_range(page, global_next_color, 
147                                     llc_cache->num_colors - global_next_color)) < 0)
148                 ret = __page_alloc_from_color_range(page, 0, global_next_color);
149
150         if(ret >= 0) {
151                 global_next_color = ret;        
152                 page_incref(*page);
153                 ret = ESUCCESS;
154         }
155         spin_unlock_irqsave(&colored_page_free_list_lock);
156         
157         return ret;
158 }
159
160 /**
161  * @brief Allocated 2^order contiguous physical pages.  Will increment the
162  * reference count for the pages.
163  *
164  * @param[in] order order of the allocation
165  * @param[in] flags memory allocation flags
166  *
167  * @return The KVA of the first page, NULL otherwise.
168  */
169 void *get_cont_pages(size_t order, int flags)
170 {
171         size_t npages = 1 << order;     
172
173         // Find 'npages' free consecutive pages
174         int first = -1;
175         spin_lock_irqsave(&colored_page_free_list_lock);
176         for(int i=(naddrpages-1); i>=(npages-1); i--) {
177                 int j;
178                 for(j=i; j>=(i-(npages-1)); j--) {
179                         if( !page_is_free(j) ) {
180                                 i = j - 1;
181                                 break;
182                         }
183                 }
184                 if( j == (i-(npages-1)-1)) {
185                         first = j+1;
186                         break;
187                 }
188         }
189         //If we couldn't find them, return NULL
190         if( first == -1 ) {
191                 spin_unlock_irqsave(&colored_page_free_list_lock);
192                 return NULL;
193         }
194
195         for(int i=0; i<npages; i++) {
196                 page_t* page;
197                 __page_alloc_specific(&page, first+i);
198                 page_incref(page); 
199         }
200         spin_unlock_irqsave(&colored_page_free_list_lock);
201         return ppn2kva(first);
202 }
203
204 void free_cont_pages(void *buf, size_t order)
205 {
206         size_t npages = 1 << order;     
207         spin_lock_irqsave(&colored_page_free_list_lock);
208         for (int i = kva2ppn(buf); i < kva2ppn(buf) + npages; i++) {
209                 __page_decref(ppn2page(i));
210                 assert(page_is_free(i));
211         }
212         spin_unlock_irqsave(&colored_page_free_list_lock);
213         return; 
214 }
215
216 /*
217  * Allocates a specific physical page.
218  * Does NOT set the contents of the physical page to zero -
219  * the caller must do that if necessary.
220  *
221  * ppn         -- the page number to allocate
222  * *page       -- is set to point to the Page struct 
223  *                of the newly allocated page
224  *
225  * RETURNS 
226  *   ESUCCESS  -- on success
227  *   -ENOMEM   -- otherwise 
228  */
229 error_t upage_alloc_specific(struct proc* p, page_t** page, size_t ppn)
230 {
231         spin_lock_irqsave(&colored_page_free_list_lock);
232         __page_alloc_specific(page, ppn);
233         spin_unlock_irqsave(&colored_page_free_list_lock);
234         return 0;
235 }
236
237 error_t kpage_alloc_specific(page_t** page, size_t ppn)
238 {
239         spin_lock_irqsave(&colored_page_free_list_lock);
240         __page_alloc_specific(page, ppn);
241         page_incref(*page);
242         spin_unlock_irqsave(&colored_page_free_list_lock);
243         return 0;
244 }
245
246 /*
247  * Return a page to the free list.
248  * (This function should only be called when pp->pg_refcnt reaches 0.)
249  * You must hold the page_free list lock before calling this.
250  */
251 static error_t __page_free(page_t* page) 
252 {
253         __page_clear(page);
254
255         LIST_INSERT_HEAD(
256            &(colored_page_free_list[get_page_color(page2ppn(page), llc_cache)]),
257            page,
258            pg_link
259         );
260
261         return ESUCCESS;
262 }
263
264 error_t page_free(page_t *SAFE page)
265 {
266         error_t retval;
267         spin_lock_irqsave(&colored_page_free_list_lock);
268         retval = __page_free(page);
269         spin_unlock_irqsave(&colored_page_free_list_lock);
270         return retval;
271 }
272
273 /*
274  * Check if a page with the given physical page # is free
275  */
276 int page_is_free(size_t ppn) {
277         page_t* page = ppn2page(ppn);
278         if (atomic_read(&page->pg_refcnt) == 0)
279                 return TRUE;
280         return FALSE;
281 }
282
283 /*
284  * Increment the reference count on a page
285  */
286 void page_incref(page_t *page)
287 {
288         __page_incref(page);
289 }
290
291 /* TODO: (REF) poor refcnting */
292 void __page_incref(page_t *page)
293 {
294         atomic_inc(&page->pg_refcnt);
295 }
296
297 /*
298  * Decrement the reference count on a page,
299  * freeing it if there are no more refs.
300  */
301 void page_decref(page_t *page)
302 {
303         spin_lock_irqsave(&colored_page_free_list_lock);
304         __page_decref(page);
305         spin_unlock_irqsave(&colored_page_free_list_lock);
306 }
307
308 /*
309  * Decrement the reference count on a page,
310  * freeing it if there are no more refs.
311  *
312  * TODO: (REF) this is insufficient protection (poor use of atomics, etc).
313  */
314 static void __page_decref(page_t *page)
315 {
316         if (atomic_read(&page->pg_refcnt) == 0) {
317                 panic("Trying to Free already freed page: %d...\n", page2ppn(page));
318                 return;
319         }
320         atomic_dec(&page->pg_refcnt);
321         if (atomic_read(&page->pg_refcnt) == 0)
322                 __page_free(page);
323 }
324
325 /*
326  * Set the reference count on a page to a specific value
327  */
328 void page_setref(page_t *page, size_t val)
329 {
330         atomic_set(&page->pg_refcnt, val);
331 }
332
333 /*
334  * Get the reference count on a page
335  */
336 size_t page_getref(page_t *page)
337 {
338         return atomic_read(&page->pg_refcnt);
339 }
340
341 /* Attempts to get a lock on the page for IO operations.  If it is already
342  * locked, it will block the thread until it is unlocked. */
343 void lock_page(struct page *page)
344 {
345         /* TODO: (BLK) actually do something!  And this has a race!  Not a big deal
346          * right now, since the only users of this are serialized, but once we have
347          * any sort of real IO, this will be an issue. */
348         assert(!(page->pg_flags & PG_LOCKED));
349         page->pg_flags |= PG_LOCKED;
350 }
351
352 /* Unlocks the page, and wakes up whoever is waiting on the lock */
353 void unlock_page(struct page *page)
354 {
355         /* TODO: (BLK) actually do something!  However this unlock works, it will
356          * need to know who to unlock, and it will have to be called in response to
357          * a basic interrupt...  */
358         page->pg_flags &= ~PG_LOCKED;
359 }