Migrated Akaros code to use pragma once (XCC)
[akaros.git] / kern / include / colored_caches.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 #pragma once
9
10 #include <ros/common.h>
11 #include <error.h>
12 #include <atomic.h>
13
14 /****************** Cache Structures ********************/
15 typedef struct Cache {
16         size_t wa;
17         size_t sz_k;
18         size_t clsz;
19         uint8_t* free_colors_map;
20         
21         //Added as optimization (derived from above);
22         size_t num_colors;
23 } cache_t;
24
25 typedef struct AvailableCaches {
26         cache_t* l1;
27         cache_t* l2;
28         cache_t* l3;
29 } available_caches_t;
30
31 /******** Externally visible global variables ************/
32 extern available_caches_t available_caches;
33 extern cache_t* llc_cache;
34 extern spinlock_t cache_colors_lock;
35
36 /************** Cache Related Functions  *****************/
37 void cache_init();
38 void cache_color_alloc_init();
39 void init_cache_properties(cache_t *c, size_t sz_k, size_t wa, size_t clsz);
40 void init_free_cache_colors_map(cache_t* c);
41 size_t get_offset_in_cache_line(uintptr_t addr, cache_t *c);
42 void print_cache_properties(char *lstring, cache_t *c);
43
44 static inline size_t get_page_color(uintptr_t page, cache_t *c) {
45     return (page & (c->num_colors-1));
46 }
47
48
49 uint8_t* cache_colors_map_alloc();
50 void cache_colors_map_free(uint8_t* colors_map);
51 error_t cache_color_alloc(cache_t* c, uint8_t* colors_map);
52 error_t cache_color_alloc_specific(size_t color, cache_t* c, 
53                                          uint8_t* colors_map);
54 void cache_color_free(cache_t* c, uint8_t* colors_map);
55 void cache_color_free_specific(size_t color, cache_t* c, uint8_t* colors_map);
56
57 /****************** Cache Properties *********************/
58 inline size_t get_cache_ways_associative(cache_t *c);
59 inline size_t get_cache_line_size_bytes(cache_t *c);
60 inline size_t get_cache_size_bytes(cache_t *c);
61 inline size_t get_cache_size_kilobytes(cache_t *c);
62 inline size_t get_cache_size_megabytes(cache_t *c);
63 inline size_t get_cache_num_offset_bits(cache_t *c);
64 inline size_t get_cache_num_index_bits(cache_t *c);
65 inline size_t get_cache_num_tag_bits(cache_t *c);
66 inline size_t get_cache_num_page_color_bits(cache_t *c);
67 inline size_t get_cache_bytes_per_line(cache_t *c);
68 inline size_t get_cache_num_lines(cache_t *c);
69 inline size_t get_cache_num_sets(cache_t *c);
70 inline size_t get_cache_lines_per_set(cache_t *c);
71 inline size_t get_cache_lines_per_page(cache_t *c);
72 inline size_t get_cache_bytes_per_way(cache_t *c);
73 inline size_t get_cache_lines_per_way(cache_t *c);
74 inline size_t get_cache_pages_per_way(cache_t *c);
75 inline size_t get_cache_num_page_colors(cache_t *c);