649ddf508ff2a5ca7a12a78f5db4844944fbcc12
[akaros.git] / kern / arch / i386 / types.h
1 #ifndef ROS_INC_TYPES_H
2 #define ROS_INC_TYPES_H
3
4 #define LITTLE_ENDIAN
5
6 #ifndef NULL
7 #define NULL ((void*) 0)
8 #endif
9
10 #ifndef TRUE
11 #define TRUE    1
12 #endif
13
14 #ifndef FALSE
15 #define FALSE   0
16 #endif
17
18 #define CHECK_FLAG(flags,bit)   ((flags) & (1 << (bit)))
19
20 // Represents true-or-false values
21 typedef int bool;
22
23 // Explicitly-sized versions of integer types
24 typedef __signed char int8_t;
25 typedef unsigned char uint8_t;
26 typedef short int16_t;
27 typedef unsigned short uint16_t;
28 typedef int int32_t;
29 typedef unsigned int uint32_t;
30 typedef long long int64_t;
31 typedef unsigned long long uint64_t;
32
33 // Pointers and addresses are 32 bits long.
34 // We use pointer types to represent virtual addresses,
35 // uintptr_t to represent the numerical values of virtual addresses,
36 // and physaddr_t to represent physical addresses.
37 typedef int32_t intptr_t;
38 typedef uint32_t uintptr_t;
39 typedef uint32_t physaddr_t;
40
41 // Registers are 32 bits long
42 typedef int32_t intreg_t;
43 typedef uint32_t uintreg_t;
44
45 // Page numbers are 32 bits long.
46 typedef uint32_t ppn_t;
47
48 // size_t is used for memory object sizes.
49 typedef uint32_t size_t;
50 // ssize_t is a signed version of ssize_t, used in case there might be an
51 // error return.
52 typedef int32_t ssize_t;
53
54 // off_t is used for file offsets and lengths.
55 typedef int32_t off_t;
56
57 // Efficient min and max operations
58 #define MIN(_a, _b)                                             \
59 ({                                                              \
60         typeof(_a) __a = (_a);                                  \
61         typeof(_b) __b = (_b);                                  \
62         __a <= __b ? __a : __b;                                 \
63 })
64 #define MAX(_a, _b)                                             \
65 ({                                                              \
66         typeof(_a) __a = (_a);                                  \
67         typeof(_b) __b = (_b);                                  \
68         __a >= __b ? __a : __b;                                 \
69 })
70
71 // Rounding operations (efficient when n is a power of 2)
72 // Round down to the nearest multiple of n
73 #define ROUNDDOWN(a, n)                                         \
74 ({                                                              \
75         uint32_t __a = (uint32_t) (a);                          \
76         (typeof(a)) (__a - __a % (n));                          \
77 })
78 // Round up to the nearest multiple of n
79 #define ROUNDUP(a, n)                                           \
80 ({                                                              \
81         uint32_t __n = (uint32_t) (n);                          \
82         (typeof(a)) (ROUNDDOWN((uint32_t) (a) + __n - 1, __n)); \
83 })
84
85
86 // Round down to the nearest multiple of n
87 #define PTRROUNDDOWN(a, n)                                              \
88 ({                                                              \
89         char * __a = (char *) (a);                              \
90         (typeof(a)) (__a - (uint32_t)__a % (n));                                \
91 })
92 // Round pointer up to the nearest multiple of n
93 #define PTRROUNDUP(a, n)                                                \
94 ({                                                              \
95         uint32_t __n = (uint32_t) (n);                          \
96         (typeof(a)) (PTRROUNDDOWN((char *) (a) + __n - 1, __n));        \
97 })
98
99 // Return the offset of 'member' relative to the beginning of a struct type
100 #ifndef offsetof
101 #define offsetof(type, member)  ((size_t) (&((type*)0)->member))
102 #endif
103
104 // Ivy currently can only handle 63 bits (OCaml thing), so use this to make
105 // a uint64_t programatically
106 #define UINT64(upper, lower) ( (((uint64_t)(upper)) << 32) | (lower) )
107
108 /*********************** Bitmask stuff **********************/
109 #define BYTES_FOR_BITMASK(size) (((size) - 1) / 8 + 1)
110 #define BYTES_FOR_BITMASK_WITH_CHECK(size) ((size) ? ((size) - (1)) / (8) + (1) : (0))
111 #define DECL_BITMASK(name, size) uint8_t (name)[BYTES_FOR_BITMASK((size))]
112
113 #define GET_BITMASK_BIT(name, bit) (((name)[(bit)/8] & (1 << ((bit) % 8))) ? 1 : 0)
114 #define SET_BITMASK_BIT(name, bit) ((name)[(bit)/8] |= (1 << ((bit) % 8)))
115 #define CLR_BITMASK_BIT(name, bit) ((name)[(bit)/8] &= ~(1 << ((bit) % 8)))
116 #define SET_BITMASK_BIT_ATOMIC(name, bit) (atomic_orb(&(name)[(bit)/8], (1 << ((bit) % 8))))
117 #define CLR_BITMASK_BIT_ATOMIC(name, bit) (atomic_andb(&(name)[(bit)/8], ~(1 << ((bit) % 8))))
118
119 #define CLR_BITMASK(name, size) \
120 ({ \
121         {TRUSTEDBLOCK \
122         memset((void*)((uintptr_t)(name)), 0, BYTES_FOR_BITMASK((size))); \
123         } \
124 })
125
126 #define FILL_BITMASK(name, size) \
127 ({ \
128         {TRUSTEDBLOCK \
129         memset((void*)((uintptr_t)(name)), 255, BYTES_FOR_BITMASK((size))); \
130         } \
131         (name)[BYTES_FOR_BITMASK((size))-1] >>= (((size) % 8) ? (8 - ((size) % 8)) : 0 ); \
132 }) 
133
134 #define COPY_BITMASK(newmask, oldmask, size) \
135 ({ \
136         {TRUSTEDBLOCK \
137         memcpy((void*)((uintptr_t)(newmask)), \
138            (void*)((uintptr_t)(oldmask)), \
139            BYTES_FOR_BITMASK((size))); \
140         } \
141 })
142
143 // this checks the entire last byte, so keep it 0 in the other macros
144 #define BITMASK_IS_CLEAR(name, size) ({ \
145         uint32_t __n = BYTES_FOR_BITMASK((size)); \
146         bool clear = 1; \
147         while (__n-- > 0) { \
148                 if ((name)[__n]) { \
149                         clear = 0; \
150                         break;\
151                 }\
152         } \
153         clear; })
154
155 #define PRINT_BITMASK(name, size) { \
156         int i;  \
157         for (i = 0; i < BYTES_FOR_BITMASK(size); i++) { \
158                 int j;  \
159                 for (j = 0; j < 8; j++) \
160                         printk("%x", ((name)[i] >> j) & 1);     \
161         } \
162         printk("\n"); \
163 }
164 /**************************************************************/
165
166 #endif /* !ROS_INC_TYPES_H */