Compiles with GCC
[akaros.git] / kern / include / ros / ring_buffer.h
1 /******************************************************************************
2  * ring.h
3  * 
4  * Shared producer-consumer ring macros.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  * DEALINGS IN THE SOFTWARE.
23  *
24  * Tim Deegan and Andrew Warfield November 2004.
25  */
26
27 #ifndef ROS_INC_RING_BUFFER_H
28 #define ROS_INC_RING_BUFFER_H
29
30 #include <string.h>
31 #include <arch/atomic.h>
32
33 #define xen_mb()  mb()
34 #define xen_rmb() rmb()
35 #define xen_wmb() wmb()
36
37 typedef unsigned int RING_IDX;
38
39 /* Round a 32-bit unsigned constant down to the nearest power of two. */
40 #define __RD2(_x)  (((_x) & 0x00000002UL) ? 0x2                  : ((_x) & 0x1))
41 #define __RD4(_x)  (((_x) & 0x0000000cUL) ? __RD2((_x)>>2)<<2    : __RD2(_x))
42 #define __RD8(_x)  (((_x) & 0x000000f0UL) ? __RD4((_x)>>4)<<4    : __RD4(_x))
43 #define __RD16(_x) (((_x) & 0x0000ff00UL) ? __RD8((_x)>>8)<<8    : __RD8(_x))
44 #define __RD32(_x) (((_x) & 0xffff0000UL) ? __RD16((_x)>>16)<<16 : __RD16(_x))
45
46 /* Statically assert that two values are in fact equal.
47  * It works by enducing a compil error from a duplicate case in a switch 
48  * statement if the assertion is false.
49  */
50 #define __ASSERT_EQUAL(x, y) \
51         switch ((x) == (y)) case 0: case ((x) == (y)):
52
53 /*
54  * Calculate size of a shared ring, given the total available space for the
55  * ring and indexes (_sz), and the name tag of the request/response structure.
56  * A ring contains as many entries as will fit, rounded down to the nearest 
57  * power of two (so we can mask with (size-1) to loop around).
58  * This tells us how many elements the ring _s can contain, given _sz space.
59  */
60 #define __RING_SIZE(_s, _sz) \
61     __RING_SIZE_BYTES(_s, _sz) / sizeof((_s)->ring[0])
62
63 /*
64  * This is the same as above, except in terms of bytes instead of elements
65  */
66 #define __RING_SIZE_BYTES(_s, _sz) \
67     (__RD32((_sz) - (long)(_s)->ring + (long)(_s)))
68
69 /*
70  * These two are the same as above except that they rely on type information
71  * to determine the sizes statically, rather than the runtime instantiation
72  * of the ring buffer variable
73  */
74 #define __RING_SIZE_STATIC(__name, _sz) \
75     (__RING_SIZE_BYTES_STATIC(_sz) / sizeof(union __name##_sring_entry))
76
77 #define __RING_SIZE_BYTES_STATIC(_sz) \
78     (__RD32((_sz) - __RING_HEADER_SIZE()))
79
80 /*
81  * Macros to make the correct C datatypes for a new kind of ring.
82  * 
83  * To make a new ring datatype, you need to have two message structures,
84  * let's say request_t, and response_t already defined.
85  *
86  * In a header where you want the ring datatype declared, you then do:
87  *
88  *     DEFINE_RING_TYPES(mytag, request_t, response_t);
89  * or
90  *     DEFINE_RING_TYPES_WITH_SIZE(mytag, request_t, response_t, size);
91  *
92  * Both macros expand out to give you a set of types, as you can see below.
93  * The most important of these are:
94  * 
95  *     mytag_sring_t      - The shared ring.
96  *     mytag_front_ring_t - The 'front' half of the ring.
97  *     mytag_back_ring_t  - The 'back' half of the ring.
98  *
99  * The first of these macros will only declare a single element array to 
100  * represent the ring buffer in the shared ring struct that is ultimately
101  * created.  
102  *
103  * The second macro actually statically declares space of size (size) inside
104  * the shared ring struct. This size is rounded down to the nearest power of 2
105  * and space is subtracted off to account for holding any necessary ring 
106  * buffer headers.
107  *
108  * To initialize a ring in your code you need to know the location and size
109  * of the shared memory area (PAGE_SIZE, for instance). To initialise
110  * the front half:
111  *
112  *     mytag_front_ring_t front_ring;
113  *     SHARED_RING_INIT((mytag_sring_t *)shared_page);
114  *     FRONT_RING_INIT(&front_ring, (mytag_sring_t *)shared_page, PAGE_SIZE);
115  *
116  * Initializing the back follows similarly (note that only the front
117  * initializes the shared ring):
118  *
119  *     mytag_back_ring_t back_ring;
120  *     BACK_RING_INIT(&back_ring, (mytag_sring_t *)shared_page, PAGE_SIZE);
121  *
122  * If you use the second of the two macros when first defining your ring 
123  * structures, then the size you use when initializing your front and back 
124  * rings *should* match the size you passed into this macro (e.g. PAGE_SIZE
125  * in this example).
126  */
127
128 #define __RING_HEADER()                                                 \
129     RING_IDX req_prod, req_event;                                       \
130     RING_IDX rsp_prod, rsp_event;                                       \
131     uint8_t  pad[48];
132     
133 #define __RING_HEADER_SIZE() \
134     (sizeof(struct {__RING_HEADER()} ))
135
136 #define DEFINE_RING_TYPES(__name, __req_t, __rsp_t)                     \
137         DEFINE_RING_TYPES_WITH_SIZE(__name, __req_t, __rsp_t,               \
138                                     __RING_HEADER_SIZE() + 1)
139
140 #define DEFINE_RING_TYPES_WITH_SIZE(__name, __req_t, __rsp_t, __size)   \
141                                                                         \
142 /* Shared ring entry */                                                 \
143 union __name##_sring_entry {                                            \
144     __req_t req;                                                        \
145     __rsp_t rsp;                                                        \
146 } TRUSTED;                                                              \
147                                                                         \
148 /* Shared ring page */                                                  \
149 struct __name##_sring {                                                 \
150         __RING_HEADER()                                                     \
151     union __name##_sring_entry ring[__RING_SIZE_STATIC(__name, __size)];\
152 };                                                                      \
153                                                                         \
154 /* "Front" end's private variables */                                   \
155 struct __name##_front_ring {                                            \
156     RING_IDX req_prod_pvt;                                              \
157     RING_IDX rsp_cons;                                                  \
158     unsigned int nr_ents;                                               \
159     struct __name##_sring *sring;                                       \
160 };                                                                      \
161                                                                         \
162 /* "Back" end's private variables */                                    \
163 struct __name##_back_ring {                                             \
164     RING_IDX rsp_prod_pvt;                                              \
165     RING_IDX req_cons;                                                  \
166     unsigned int nr_ents;                                               \
167     struct __name##_sring *sring;                                       \
168 };                                                                      \
169                                                                         \
170 /* Syntactic sugar */                                                   \
171 typedef struct __name##_sring __name##_sring_t;                         \
172 typedef struct __name##_front_ring __name##_front_ring_t;               \
173 typedef struct __name##_back_ring __name##_back_ring_t;                 \
174                                                                         \
175 /* This is a dummy function just used to statically assert that         \
176  * there are no weird padding issues associated with our sring structs  \
177  */                                                                     \
178 static void __name##_assert_sring_size() __attribute__((used));         \
179 static void __name##_assert_sring_size() {                              \
180         __ASSERT_EQUAL( sizeof(__name##_sring_t),                           \
181                         ( __RING_HEADER_SIZE()  +                           \
182                           ( __RING_SIZE_STATIC(__name, __size) *            \
183                             sizeof(union __name##_sring_entry)              \
184                           )                                                 \
185                         )                                                   \
186                       );                                                    \
187 }              
188
189 /*
190  * Macros for manipulating rings.
191  * 
192  * FRONT_RING_whatever works on the "front end" of a ring: here 
193  * requests are pushed on to the ring and responses taken off it.
194  * 
195  * BACK_RING_whatever works on the "back end" of a ring: here 
196  * requests are taken off the ring and responses put on.
197  * 
198  * N.B. these macros do NO INTERLOCKS OR FLOW CONTROL. 
199  * This is OK in 1-for-1 request-response situations where the 
200  * requestor (front end) never has more than RING_SIZE()-1
201  * outstanding requests.
202  */
203
204 /* Initialising empty rings */
205 #define SHARED_RING_INIT(_s) do {                                       \
206     (_s)->req_prod  = (_s)->rsp_prod  = 0;                              \
207     (_s)->req_event = (_s)->rsp_event = 1;                              \
208     (void)memset((_s)->pad, 0, sizeof((_s)->pad));                      \
209 } while(0)
210
211 #define FRONT_RING_INIT(_r, _s, __size) do {                            \
212     (_r)->req_prod_pvt = 0;                                             \
213     (_r)->rsp_cons = 0;                                                 \
214     (_r)->nr_ents = __RING_SIZE(_s, __size);                            \
215     (_r)->sring = (_s);                                                 \
216 } while (0)
217
218 #define BACK_RING_INIT(_r, _s, __size) do {                             \
219     (_r)->rsp_prod_pvt = 0;                                             \
220     (_r)->req_cons = 0;                                                 \
221     (_r)->nr_ents = __RING_SIZE(_s, __size);                            \
222     (_r)->sring = (_s);                                                 \
223 } while (0)
224
225 /* Initialize to existing shared indexes -- for recovery */
226 #define FRONT_RING_ATTACH(_r, _s, __size) do {                          \
227     (_r)->sring = (_s);                                                 \
228     (_r)->req_prod_pvt = (_s)->req_prod;                                \
229     (_r)->rsp_cons = (_s)->rsp_prod;                                    \
230     (_r)->nr_ents = __RING_SIZE(_s, __size);                            \
231 } while (0)
232
233 #define BACK_RING_ATTACH(_r, _s, __size) do {                           \
234     (_r)->sring = (_s);                                                 \
235     (_r)->rsp_prod_pvt = (_s)->rsp_prod;                                \
236     (_r)->req_cons = (_s)->req_prod;                                    \
237     (_r)->nr_ents = __RING_SIZE(_s, __size);                            \
238 } while (0)
239
240 /* How big is this ring? */
241 #define RING_SIZE(_r)                                                   \
242     ((_r)->nr_ents)
243
244 /* Number of free requests (for use on front side only). */
245 #define RING_FREE_REQUESTS(_r)                                          \
246     (RING_SIZE(_r) - ((_r)->req_prod_pvt - (_r)->rsp_cons))
247
248 /* Test if there is an empty slot available on the front ring.
249  * (This is only meaningful from the front. )
250  */
251 #define RING_FULL(_r)                                                   \
252     (RING_FREE_REQUESTS(_r) == 0)
253
254 /* Test if there are outstanding messages to be processed on a ring. */
255 #define RING_HAS_UNCONSUMED_RESPONSES(_r)                               \
256     ((_r)->sring->rsp_prod - (_r)->rsp_cons)
257
258 #ifdef __GNUC__
259 #define RING_HAS_UNCONSUMED_REQUESTS(_r) ({                             \
260     unsigned int req = (_r)->sring->req_prod - (_r)->req_cons;          \
261     unsigned int rsp = RING_SIZE(_r) -                                  \
262         ((_r)->req_cons - (_r)->rsp_prod_pvt);                          \
263     req < rsp ? req : rsp;                                              \
264 })
265 #else
266 /* Same as above, but without the nice GCC ({ ... }) syntax. */
267 #define RING_HAS_UNCONSUMED_REQUESTS(_r)                                \
268     ((((_r)->sring->req_prod - (_r)->req_cons) <                        \
269       (RING_SIZE(_r) - ((_r)->req_cons - (_r)->rsp_prod_pvt))) ?        \
270      ((_r)->sring->req_prod - (_r)->req_cons) :                         \
271      (RING_SIZE(_r) - ((_r)->req_cons - (_r)->rsp_prod_pvt)))
272 #endif
273
274 /* Direct access to individual ring elements, by index. */
275 #define RING_GET_REQUEST(_r, _idx)                                      \
276     (&((_r)->sring->ring[((_idx) & (RING_SIZE(_r) - 1))].req))
277
278 #define RING_GET_RESPONSE(_r, _idx)                                     \
279     (&((_r)->sring->ring[((_idx) & (RING_SIZE(_r) - 1))].rsp))
280
281 /* Loop termination condition: Would the specified index overflow the ring? */
282 #define RING_REQUEST_CONS_OVERFLOW(_r, _cons)                           \
283     (((_cons) - (_r)->rsp_prod_pvt) >= RING_SIZE(_r))
284
285 #define RING_PUSH_REQUESTS(_r) do {                                     \
286     xen_wmb(); /* back sees requests /before/ updated producer index */ \
287     (_r)->sring->req_prod = (_r)->req_prod_pvt;                         \
288 } while (0)
289
290 #define RING_PUSH_RESPONSES(_r) do {                                    \
291     xen_wmb(); /* front sees resps /before/ updated producer index */   \
292     (_r)->sring->rsp_prod = (_r)->rsp_prod_pvt;                         \
293 } while (0)
294
295 /*
296  * Notification hold-off (req_event and rsp_event):
297  * 
298  * When queueing requests or responses on a shared ring, it may not always be
299  * necessary to notify the remote end. For example, if requests are in flight
300  * in a backend, the front may be able to queue further requests without
301  * notifying the back (if the back checks for new requests when it queues
302  * responses).
303  * 
304  * When enqueuing requests or responses:
305  * 
306  *  Use RING_PUSH_{REQUESTS,RESPONSES}_AND_CHECK_NOTIFY(). The second argument
307  *  is a boolean return value. True indicates that the receiver requires an
308  *  asynchronous notification.
309  * 
310  * After dequeuing requests or responses (before sleeping the connection):
311  * 
312  *  Use RING_FINAL_CHECK_FOR_REQUESTS() or RING_FINAL_CHECK_FOR_RESPONSES().
313  *  The second argument is a boolean return value. True indicates that there
314  *  are pending messages on the ring (i.e., the connection should not be put
315  *  to sleep).
316  * 
317  *  These macros will set the req_event/rsp_event field to trigger a
318  *  notification on the very next message that is enqueued. If you want to
319  *  create batches of work (i.e., only receive a notification after several
320  *  messages have been enqueued) then you will need to create a customised
321  *  version of the FINAL_CHECK macro in your own code, which sets the event
322  *  field appropriately.
323  */
324
325 #define RING_PUSH_REQUESTS_AND_CHECK_NOTIFY(_r, _notify) do {           \
326     RING_IDX __old = (_r)->sring->req_prod;                             \
327     RING_IDX __new = (_r)->req_prod_pvt;                                \
328     xen_wmb(); /* back sees requests /before/ updated producer index */ \
329     (_r)->sring->req_prod = __new;                                      \
330     xen_mb(); /* back sees new requests /before/ we check req_event */  \
331     (_notify) = ((RING_IDX)(__new - (_r)->sring->req_event) <           \
332                  (RING_IDX)(__new - __old));                            \
333 } while (0)
334
335 #define RING_PUSH_RESPONSES_AND_CHECK_NOTIFY(_r, _notify) do {          \
336     RING_IDX __old = (_r)->sring->rsp_prod;                             \
337     RING_IDX __new = (_r)->rsp_prod_pvt;                                \
338     xen_wmb(); /* front sees resps /before/ updated producer index */   \
339     (_r)->sring->rsp_prod = __new;                                      \
340     xen_mb(); /* front sees new resps /before/ we check rsp_event */    \
341     (_notify) = ((RING_IDX)(__new - (_r)->sring->rsp_event) <           \
342                  (RING_IDX)(__new - __old));                            \
343 } while (0)
344
345 #define RING_FINAL_CHECK_FOR_REQUESTS(_r, _work_to_do) do {             \
346     (_work_to_do) = RING_HAS_UNCONSUMED_REQUESTS(_r);                   \
347     if (_work_to_do) break;                                             \
348     (_r)->sring->req_event = (_r)->req_cons + 1;                        \
349     xen_mb();                                                           \
350     (_work_to_do) = RING_HAS_UNCONSUMED_REQUESTS(_r);                   \
351 } while (0)
352
353 #define RING_FINAL_CHECK_FOR_RESPONSES(_r, _work_to_do) do {            \
354     (_work_to_do) = RING_HAS_UNCONSUMED_RESPONSES(_r);                  \
355     if (_work_to_do) break;                                             \
356     (_r)->sring->rsp_event = (_r)->rsp_cons + 1;                        \
357     xen_mb();                                                           \
358     (_work_to_do) = RING_HAS_UNCONSUMED_RESPONSES(_r);                  \
359 } while (0)
360
361 #endif /* ROS_INC_RING_BUFFER_H */
362
363 /*
364  * Local variables:
365  * mode: C
366  * c-set-style: "BSD"
367  * c-basic-offset: 4
368  * tab-width: 4
369  * indent-tabs-mode: nil
370  * End:
371  */
372