b5b255b8218345918ba66e008b6bf6c10d4ec243
[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 /* Each arch has some basic atomic ops.  We need comp_and_swap for now. */
15 #include <arch/atomic.h>
16 #include <string.h>
17
18 /* Bounded Concurrent Queues, untrusted consumer
19  *
20  * This is a producer/consumer circular buffer, in which the producer never
21  * blocks and does not need to trust the data structure (which is writable by
22  * the consumer).
23  *
24  * A producer enqueues and item, based on the indexes of the producer and
25  * consumer.  Enqueue cannot block, but can fail if the queue is full or if it
26  * fails to enqueue after a certain amount of tries.
27  *
28  * prod_idx:     the next item to be produced
29  * cons_pvt_idx: the next item a consumer can claim
30  * cons_pub_idx: the last item (farthest left / oldest) that hasn't been
31  *               consumed/made ready to be clobbered by the producer (it is
32  *               what the consumer produces).  Once all are clear, this will be
33  *               the same as the prod_idx.
34  *
35  * The number of free slots in the buffer is: BufSize - (prod_idx - cons_pub)
36  * The power-of-two nature of the number of elements makes this work when it
37  * wraps around, just like with Xen.  Check it yourself with a counter of 8 and
38  * bufsizes of 8 and 4.
39  *
40  *
41  * General plan:
42  *
43  * Producers compete among themselves, using the prod_idx, to get a free spot.
44  * Once they have a spot, they fill in the item, and then toggle the "ready for
45  * consumption" bool for a client.  If it cannot find one after a number of
46  * tries, it simply fails (could be a DoS from the client).
47  *
48  * Consumers fight with their private index, which they use to determine who is
49  * consuming which item.  If there is an unconsumed item, they try to advance
50  * the pvt counter.  If they succeed, they can consume the item.  The item
51  * might not be there yet, so they must spin until it is there.  Then, the
52  * consumer copies the item out, and clears the bool (rdy_for_cons).
53  *
54  * At this point, the consumer needs to make sure the pub_idx is advanced
55  * enough so the producer knows the item is free.  If pub_idx was their item,
56  * they move it forward to the next item.  If it is not, currently, they spin
57  * and wait until the previous consumer finishes, and then move it forward.
58  * This isn't ideal, and we can deal with this in the future.  
59  *
60  * Enqueue will enqueue the item pointed to by elem.  Dequeue will write an
61  * item into the memory pointed to by elem.
62  *
63  * The number of items must be a power of two.  In the future, we'll probably
64  * use Xen's rounding macros.  Not using powers of two is a pain, esp with mods
65  * of negative numbers.
66  *
67  * Here's how to use it:
68  *
69  * DEFINE_BCQ_TYPES(my_name, my_type, my_size);
70  * struct my_name_bcq some_bcq;
71  * bcq_init(&some_bcq, my_type, my_size);
72  *
73  * bcq_enqueue(&some_bcq, &some_my_type, my_size, num_fails_okay);
74  * bcq_dequeue(&some_bcq, &some_my_type, my_size);
75  *
76  *
77  * TODO later:
78  * How about an atomic_add_return for the prod?  Now that we use powers of two,
79  * CAS is probably overkill.
80  *
81  * Automatically round up.
82  *
83  * Watch out for ABA.  Could use ctrs in the top of the indexes.  Not really an
84  * issue, since that would be a wraparound.
85  *
86  * Consumers could also just set their bit, and have whoever has the pub_idx
87  * right before them be the one to advance it all the way up.
88  *
89  * Using uint32_t for now, since that's the comp_and_swap we have.  We'll
90  * probably get other sizes once we're sure we like the current one.  */
91
92 #if 0 // Defined in the included header
93
94 struct bcq_header {
95         uint32_t prod_idx;              /* next to be produced in */
96         uint32_t cons_pub_idx;  /* last completely consumed */
97         uint32_t cons_pvt_idx;  /* last a consumer has dibs on */
98 };
99
100 // This is there too:
101 #define DEFINE_BCQ_TYPES(__name, __elem_t, __num_elems)
102
103 #endif
104
105 /* Functions */                                                                
106 #define bcq_init(_bcq, _ele_type, _num_elems)                                  \
107         memset((_bcq), 0, sizeof( _ele_type ) * (_num_elems))                                 
108
109 /* Num empty buffer slots in the BCQ */
110 #define BCQ_FREE_SLOTS(_p, _cp, _ne) ((_ne) - ((_p) - (_cp)))
111
112 /* Really empty */
113 #define BCQ_EMPTY(_p, _cp, _ne) ((_ne) == BCQ_FREE_SLOTS(_p, _cp, _ne))
114
115 /* All work claimed by a consumer */
116 #define BCQ_NO_WORK(_p, _cpv) ((_p) == (_cpv))
117
118 /* Buffer full */
119 #define BCQ_FULL(_p, _cp, _ne) (0 == BCQ_FREE_SLOTS(_p, _cp, _ne))
120
121 /* Figure out the slot you want, bail if it's full, or if you failed too many
122  * times, CAS to set the new prod.  Fill yours in, toggle the bool.  Sorry, the
123  * macro got a bit ugly, esp with the __retval hackery. */
124 #define bcq_enqueue(_bcq, _elem, _num_elems, _num_fail)                        \
125 ({                                                                             \
126         uint32_t __prod, __new_prod, __cons_pub, __failctr = 0;                    \
127         int __retval = 0;                                                          \
128         do {                                                                       \
129                 if (((_num_fail)) && (__failctr++ >= (_num_fail))) {                   \
130                         __retval = -EFAIL;                                                 \
131                         break;                                                             \
132                 }                                                                      \
133                 __prod = (_bcq)->hdr.prod_idx;                                         \
134                 __cons_pub = (_bcq)->hdr.cons_pub_idx;                                 \
135                 if (BCQ_FULL(__prod, __cons_pub, (_num_elems))) {                      \
136                         __retval = -EBUSY;                                                 \
137                         break;                                                             \
138                 }                                                                      \
139                 __new_prod = __prod + 1;                                               \
140         } while (!atomic_comp_swap(&(_bcq)->hdr.prod_idx, __prod, __new_prod));    \
141         if (!__retval) {                                                           \
142                 /* from here out, __prod is the local __prod that we won */            \
143                 (_bcq)->wraps[__prod & ((_num_elems)-1)].elem = *(_elem);              \
144                 (_bcq)->wraps[__prod & ((_num_elems)-1)].rdy_for_cons = TRUE;          \
145         }                                                                          \
146         __retval;                                                                  \
147 })
148
149 /* Similar to enqueue, spin afterwards til cons_pub is our element, then
150  * advance it. */
151 #define bcq_dequeue(_bcq, _elem, _num_elems)                                   \
152 ({                                                                             \
153         uint32_t __prod, __cons_pvt, __new_cons_pvt, __cons_pub;                   \
154         int __retval = 0;                                                          \
155         do {                                                                       \
156                 __prod = (_bcq)->hdr.prod_idx;                                         \
157                 __cons_pvt = (_bcq)->hdr.cons_pvt_idx;                                 \
158                 if (BCQ_NO_WORK(__prod, __cons_pvt)) {                                 \
159                         __retval = -EBUSY;                                                 \
160                         break;                                                             \
161                 }                                                                      \
162                 __new_cons_pvt = (__cons_pvt + 1);                                     \
163         } while (!atomic_comp_swap(&(_bcq)->hdr.cons_pvt_idx, __cons_pvt,          \
164                                    __new_cons_pvt));                               \
165         if (!__retval) {                                                           \
166                 /* from here out, __cons_pvt is the local __cons_pvt that we won */    \
167                 /* wait for the producer to finish copying it in */                    \
168                 while (!(_bcq)->wraps[__cons_pvt & ((_num_elems)-1)].rdy_for_cons)     \
169                         cpu_relax();                                                       \
170                 *(_elem) = (_bcq)->wraps[__cons_pvt & ((_num_elems)-1)].elem;          \
171                 (_bcq)->wraps[__cons_pvt & ((_num_elems)-1)].rdy_for_cons = FALSE;     \
172                 /* wait til we're the cons_pub, then advance it by one */              \
173                 while ((_bcq)->hdr.cons_pub_idx != __cons_pvt)                         \
174                         cpu_relax();                                                       \
175                 (_bcq)->hdr.cons_pub_idx = __cons_pvt + 1;                             \
176         }                                                                          \
177         __retval;                                                                  \
178 })
179
180 #if 0
181 /* Original C Code, for posterity / debugging */
182 static inline int enqueue(struct __name_bcq *bcq, __elem_t *elem,
183                           int num_fail)
184 {
185         uint32_t __prod, __new_prod, __cons_pub, __failctr = 0;
186         do {
187                 if ((num_fail) && (__failctr++ >= num_fail)) {
188                         printk("FAILED\n");
189                         return -EFAIL;
190                 }
191                 __prod = bcq->hdr.prod_idx;
192                 __cons_pub = bcq->hdr.cons_pub_idx;
193         printk("# free slots : %d\n", BCQ_FREE_SLOTS(__prod, __cons_pub, __num_elems));
194
195 //              printk("__prod = %p, cons_pub = %p\n", __prod, __cons_pub-1);
196 //              printk("__prod mod = %p, cons_pub mod = %p\n", __prod &(__num_elems-1), (__cons_pub-1) &(__num_elems-1));
197
198                 if (BCQ_FULL(__prod, __cons_pub, __num_elems)) {
199                         printk("BUSY\n");
200                         return -EBUSY;
201                 }
202                 __new_prod = __prod + 1;
203         } while (!atomic_comp_swap(&bcq->hdr.prod_idx, __prod, __new_prod));
204         /* from here out, __prod is the local __prod that we won */
205
206         printk("enqueuing to location %d\n", __prod & (__num_elems-1));
207
208         bcq->wraps[__prod & (__num_elems-1)].elem = *elem;
209         bcq->wraps[__prod & (__num_elems-1)].rdy_for_cons = TRUE;
210         return 0;
211 }
212
213 /* Similar to enqueue, spin afterwards til cons_pub is our element, then */
214 /* advance it. */
215 static inline int dequeue(struct __name_bcq *bcq, __elem_t *elem)
216 {
217         uint32_t __prod, __cons_pvt, __new_cons_pvt, __cons_pub;
218         do {
219                 __prod = bcq->hdr.prod_idx;
220                 __cons_pvt = bcq->hdr.cons_pvt_idx;
221                 if (BCQ_NO_WORK(__prod, __cons_pvt))
222                         return -EBUSY;
223                 __new_cons_pvt = (__cons_pvt + 1);
224         } while (!atomic_comp_swap(&bcq->hdr.cons_pvt_idx, __cons_pvt,
225                                    __new_cons_pvt));
226         /* from here out, __cons_pvt is the local __cons_pvt that we won */
227         printk("dequeueing from location %d\n", __cons_pvt & (__num_elems-1));
228
229         /* wait for the producer to finish copying it in */
230         while (!bcq->wraps[__cons_pvt & (__num_elems-1)].rdy_for_cons)
231                 cpu_relax();
232         *elem = bcq->wraps[__cons_pvt & (__num_elems-1)].elem;
233         bcq->wraps[__cons_pvt & (__num_elems-1)].rdy_for_cons = FALSE;
234         /* wait til we're the cons_pub, then advance it by one */
235         while (bcq->hdr.cons_pub_idx != __cons_pvt)
236                 cpu_relax();
237         bcq->hdr.cons_pub_idx = __cons_pvt + 1;
238         return 0;
239 }
240 #endif
241
242 #endif /* !ROS_INC_BCQ_H */