Changes user includes to <library/header.h> (XCC)
[akaros.git] / kern / include / ros / bcq.h
1 /* Copyright (c) 2010 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Multi-producer, multi-consumer queues.  Designed initially for an untrusted
6  * consumer.
7  */
8
9 #ifndef ROS_INC_BCQ_H
10 #define ROS_INC_BCQ_H
11
12 #include <ros/common.h>
13 #include <ros/bcq_struct.h>
14 #include <string.h>
15
16 /* Pain in the ass includes.  Glibc has an atomic.h, and eventually userspace
17  * will have to deal with the clobbering. */
18 #ifdef ROS_KERNEL
19 #include <atomic.h>
20 #else
21 #include <parlib/arch/atomic.h>
22 #endif /* ROS_KERNEL */
23
24 /* Bounded Concurrent Queues, untrusted consumer
25  *
26  * This is a producer/consumer circular buffer, in which the producer never
27  * blocks and does not need to trust the data structure (which is writable by
28  * the consumer).
29  *
30  * A producer enqueues an item, based on the indexes of the producer and
31  * consumer.  Enqueue cannot block, but can fail if the queue is full or if it
32  * fails to enqueue after a certain amount of tries.
33  *
34  * prod_idx:     the next item to be produced
35  * cons_pvt_idx: the next item a consumer can claim
36  * cons_pub_idx: the last item (farthest left / oldest) that hasn't been
37  *               consumed/made ready to be clobbered by the producer (it is
38  *               what the consumer produces).  Once all are clear, this will be
39  *               the same as the prod_idx.
40  *
41  * The number of free slots in the buffer is: BufSize - (prod_idx - cons_pub)
42  * The power-of-two nature of the number of elements makes this work when it
43  * wraps around, just like with Xen.  Check it yourself with a counter of 8 and
44  * bufsizes of 8 and 4.
45  *
46  *
47  * General plan:
48  *
49  * Producers compete among themselves, using the prod_idx, to get a free spot.
50  * Once they have a spot, they fill in the item, and then toggle the "ready for
51  * consumption" bool for a client.  If it cannot find one after a number of
52  * tries, it simply fails (could be a DoS from the client).
53  *
54  * Consumers fight with their private index, which they use to determine who is
55  * consuming which item.  If there is an unconsumed item, they try to advance
56  * the pvt counter.  If they succeed, they can consume the item.  The item
57  * might not be there yet, so they must spin until it is there.  Then, the
58  * consumer copies the item out, and clears the bool (rdy_for_cons).
59  *
60  * At this point, the consumer needs to make sure the pub_idx is advanced
61  * enough so the producer knows the item is free.  If pub_idx was their item,
62  * they move it forward to the next item.  If it is not, currently, they spin
63  * and wait until the previous consumer finishes, and then move it forward.
64  * This isn't ideal, and we can deal with this in the future.  
65  *
66  * Enqueue will enqueue the item pointed to by elem.  Dequeue will write an
67  * item into the memory pointed to by elem.
68  *
69  * The number of items must be a power of two.  In the future, we'll probably
70  * use Xen's rounding macros.  Not using powers of two is a pain, esp with mods
71  * of negative numbers.
72  *
73  * Here's how to use it:
74  *
75  * DEFINE_BCQ_TYPES(my_name, my_type, my_size);
76  * struct my_name_bcq some_bcq;
77  * bcq_init(&some_bcq, my_type, my_size);
78  *
79  * bcq_enqueue(&some_bcq, &some_my_type, my_size, num_fails_okay);
80  * bcq_dequeue(&some_bcq, &some_my_type, my_size);
81  *
82  * They both return 0 on success, or some error code on failure.
83  *
84  * TODO later:
85  * How about an atomic_add_return for the prod?  Now that we use powers of two,
86  * CAS is probably overkill.
87  *
88  * Automatically round up.
89  *
90  * Watch out for ABA.  Could use ctrs in the top of the indexes.  Not really an
91  * issue, since that would be a wraparound.
92  *
93  * Consumers could also just set their bit, and have whoever has the pub_idx
94  * right before them be the one to advance it all the way up.
95  *
96  * Using uint32_t for now, since that's the comp_and_swap we have.  We'll
97  * probably get other sizes once we're sure we like the current one.  */
98
99 #if 0 // Defined in the included header
100
101 struct bcq_header {
102         uint32_t prod_idx;              /* next to be produced in */
103         uint32_t cons_pub_idx;  /* last completely consumed */
104         uint32_t cons_pvt_idx;  /* last a consumer has dibs on */
105 };
106
107 // This is there too:
108 #define DEFINE_BCQ_TYPES(__name, __elem_t, __num_elems)
109
110 #endif
111
112 /* Functions */                                                                
113 #define bcq_init(_bcq, _ele_type, _num_elems)                                  \
114 ({                                                                             \
115         memset((_bcq), 0, sizeof(*(_bcq)));                                        \
116         assert((_num_elems) == ROUNDUPPWR2(_num_elems));                           \
117 })
118
119 /* Num empty buffer slots in the BCQ */
120 #define BCQ_FREE_SLOTS(_p, _cp, _ne) ((_ne) - ((_p) - (_cp)))
121
122 /* Really empty */
123 #define BCQ_EMPTY(_p, _cp, _ne) ((_ne) == BCQ_FREE_SLOTS(_p, _cp, _ne))
124
125 /* All work claimed by a consumer */
126 #define BCQ_NO_WORK(_p, _cpv) ((_p) == (_cpv))
127
128 /* Buffer full */
129 #define BCQ_FULL(_p, _cp, _ne) (0 == BCQ_FREE_SLOTS(_p, _cp, _ne))
130
131 /* Figure out the slot you want, bail if it's full, or if you failed too many
132  * times, CAS to set the new prod.  Fill yours in, toggle the bool.  Sorry, the
133  * macro got a bit ugly, esp with the __retval hackery. */
134 #define bcq_enqueue(_bcq, _elem, _num_elems, _num_fail)                        \
135 ({                                                                             \
136         uint32_t __prod, __new_prod, __cons_pub, __failctr = 0;                    \
137         int __retval = 0;                                                          \
138         do {                                                                       \
139                 cmb();                                                                 \
140                 if (((_num_fail)) && (__failctr++ >= (_num_fail))) {                   \
141                         __retval = -EFAIL;                                                 \
142                         break;                                                             \
143                 }                                                                      \
144                 __prod = (_bcq)->hdr.prod_idx;                                         \
145                 __cons_pub = (_bcq)->hdr.cons_pub_idx;                                 \
146                 if (BCQ_FULL(__prod, __cons_pub, (_num_elems))) {                      \
147                         __retval = -EBUSY;                                                 \
148                         break;                                                             \
149                 }                                                                      \
150                 __new_prod = __prod + 1;                                               \
151         } while (!atomic_cas_u32(&(_bcq)->hdr.prod_idx, __prod, __new_prod));      \
152         if (!__retval) {                                                           \
153                 /* from here out, __prod is the local __prod that we won */            \
154                 (_bcq)->wraps[__prod & ((_num_elems)-1)].elem = *(_elem);              \
155                 wmb();                                                                 \
156                 (_bcq)->wraps[__prod & ((_num_elems)-1)].rdy_for_cons = TRUE;          \
157         }                                                                          \
158         __retval;                                                                  \
159 })
160
161 /* Similar to enqueue, spin afterwards til cons_pub is our element, then
162  * advance it. */
163 #define bcq_dequeue(_bcq, _elem, _num_elems)                                   \
164 ({                                                                             \
165         uint32_t __prod, __cons_pvt, __new_cons_pvt, __cons_pub;                   \
166         int __retval = 0;                                                          \
167         do {                                                                       \
168                 cmb();                                                                 \
169                 __prod = (_bcq)->hdr.prod_idx;                                         \
170                 __cons_pvt = (_bcq)->hdr.cons_pvt_idx;                                 \
171                 if (BCQ_NO_WORK(__prod, __cons_pvt)) {                                 \
172                         __retval = -EBUSY;                                                 \
173                         break;                                                             \
174                 }                                                                      \
175                 __new_cons_pvt = (__cons_pvt + 1);                                     \
176         } while (!atomic_cas_u32(&(_bcq)->hdr.cons_pvt_idx, __cons_pvt,            \
177                                    __new_cons_pvt));                               \
178         if (!__retval) {                                                           \
179                 /* from here out, __cons_pvt is the local __cons_pvt that we won */    \
180                 /* wait for the producer to finish copying it in */                    \
181                 while (!(_bcq)->wraps[__cons_pvt & ((_num_elems)-1)].rdy_for_cons)     \
182                         cpu_relax();                                                       \
183                 *(_elem) = (_bcq)->wraps[__cons_pvt & ((_num_elems)-1)].elem;          \
184                 (_bcq)->wraps[__cons_pvt & ((_num_elems)-1)].rdy_for_cons = FALSE;     \
185                 /* wait til we're the cons_pub, then advance it by one */              \
186                 while ((_bcq)->hdr.cons_pub_idx != __cons_pvt)                         \
187                         cpu_relax();                                                       \
188                 (_bcq)->hdr.cons_pub_idx = __cons_pvt + 1;                             \
189         }                                                                          \
190         __retval;                                                                  \
191 })
192
193 /* Checks of a bcq is empty (meaning no work), instead of trying to dequeue */
194 #define bcq_empty(_bcq)                                                        \
195         BCQ_NO_WORK((_bcq)->hdr.prod_idx, (_bcq)->hdr.cons_pvt_idx)
196
197 #define bcq_nr_full(_bcq)                                                      \
198         ((_bcq)->hdr.prod_idx - (_bcq)->hdr.cons_pub_idx)
199
200 #endif /* ROS_INC_BCQ_H */