Allow larger CEQs (XCC)
[akaros.git] / user / parlib / ceq.c
1 /* Copyright (c) 2015 Google Inc.
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Coalescing Event Queue: encapuslates the essence of epoll/kqueue in shared
6  * memory: a dense array of sticky status bits.
7  *
8  * User side (consumer).
9  *
10  * When initializing, the nr_events is the maximum count of events you are
11  * tracking, e.g. 100 FDs being tapped, but not the actual FD numbers.  If you
12  * use a large number, don't worry about memory; the memory is reserved but only
13  * allocated on demand (i.e. mmap without MAP_POPULATE).
14  *
15  * The ring_sz is a rough guess of the number of concurrent events.  It's not a
16  * big deal what you pick, but it must be a power of 2.  Otherwise the kernel
17  * will probably scribble over your memory.  If you pick a value that is too
18  * small, then the ring may overflow, triggering an O(n) scan of the events
19  * array (where n is the largest event ID ever seen).  You could make it the
20  * nearest power of 2 >= nr_expected_events, for reasonable behavior at the
21  * expense of memory.  It'll be very rare for the ring to have more entries than
22  * the array has events. */
23
24 #include <parlib/ceq.h>
25 #include <parlib/arch/atomic.h>
26 #include <parlib/vcore.h>
27 #include <parlib/assert.h>
28 #include <parlib/spinlock.h>
29 #include <stdlib.h>
30 #include <stdio.h>
31 #include <sys/mman.h>
32
33 void ceq_init(struct ceq *ceq, uint8_t op, unsigned int nr_events,
34               size_t ring_sz)
35 {
36         /* In case they already had an mbox initialized, cleanup whatever was there
37          * so we don't leak memory.  They better not have asked for events before
38          * doing this init call... */
39         ceq_cleanup(ceq);
40         ceq->events = mmap(NULL, sizeof(struct ceq_event) * nr_events,
41                            PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS,
42                            -1, 0);
43         parlib_assert_perror(ceq->events != MAP_FAILED);
44         ceq->nr_events = nr_events;
45         atomic_init(&ceq->max_event_ever, 0);
46         assert(IS_PWR2(ring_sz));
47         ceq->ring = malloc(sizeof(int32_t) * ring_sz);
48         memset(ceq->ring, 0xff, sizeof(int32_t) * ring_sz);
49         ceq->ring_sz = ring_sz;
50         ceq->operation = op;
51         ceq->ring_overflowed = FALSE;
52         atomic_init(&ceq->prod_idx, 0);
53         atomic_init(&ceq->cons_pub_idx, 0);
54         atomic_init(&ceq->cons_pvt_idx, 0);
55         parlib_static_assert(sizeof(struct spin_pdr_lock) <= sizeof(ceq->u_lock));
56         spin_pdr_init((struct spin_pdr_lock*)&ceq->u_lock);
57 }
58
59 /* Helper, returns an index into the events array from the ceq ring.  -1 if the
60  * ring was empty when we looked (could be filled right after we looked).  This
61  * is the same algorithm used with BCQs, but with a magic value (-1) instead of
62  * a bool to track whether or not the slot is ready for consumption. */
63 static int32_t get_ring_idx(struct ceq *ceq)
64 {
65         long pvt_idx, prod_idx;
66         int32_t ret;
67         do {
68                 prod_idx = atomic_read(&ceq->prod_idx);
69                 pvt_idx = atomic_read(&ceq->cons_pvt_idx);
70                 if (__ring_empty(prod_idx, pvt_idx))
71                         return -1;
72         } while (!atomic_cas(&ceq->cons_pvt_idx, pvt_idx, pvt_idx + 1));
73         /* We claimed our slot, which is pvt_idx.  The new cons_pvt_idx is advanced
74          * by 1 for the next consumer.  Now we need to wait on the kernel to fill
75          * the value: */
76         while ((ret = ceq->ring[pvt_idx & (ceq->ring_sz - 1)]) == -1)
77                 cpu_relax();
78         /* Set the value back to -1 for the next time the slot is used */
79         ceq->ring[pvt_idx & (ceq->ring_sz - 1)] = -1;
80         /* We now have our entry.  We need to make sure the pub_idx is updated.  All
81          * consumers are doing this.  We can just wait on all of them to update the
82          * cons_pub to our location, then we update it to the next.
83          *
84          * We're waiting on other vcores, but we don't know which one(s). */
85         while (atomic_read(&ceq->cons_pub_idx) != pvt_idx)
86                 cpu_relax_vc(vcore_id());       /* wait on all of them */
87         /* This is the only time we update cons_pub.  We also know no one else is
88          * updating it at this moment; the while loop acts as a lock, such that
89          * no one gets to this point until pub == their pvt_idx, all of which are
90          * unique. */
91         /* No rwmb needed, it's the same variable (con_pub) */
92         atomic_set(&ceq->cons_pub_idx, pvt_idx + 1);
93         return ret;
94 }
95
96 /* Helper, extracts a message from a ceq[idx], returning TRUE if there was a
97  * message.  Note that there might have been nothing in the message (coal == 0).
98  * still, that counts; it's more about idx_posted.  A concurrent reader could
99  * have swapped out the coal contents (imagine two consumers, each gets past the
100  * idx_posted check).  If having an "empty" coal is a problem, then higher level
101  * software can ask for another event.
102  *
103  * Implied in all of that is that idx_posted is also racy.  The consumer blindly
104  * sets it to false.  So long as it extracts coal after doing so, we're fine. */
105 static bool extract_ceq_msg(struct ceq *ceq, int32_t idx, struct event_msg *msg)
106 {
107         struct ceq_event *ceq_ev = &ceq->events[idx];
108         if (!ceq_ev->idx_posted)
109                 return FALSE;
110         /* Once we clear this flag, any new coalesces will trigger another ring
111          * event, so we don't need to worry about missing anything.  It is possible
112          * that this CEQ event will get those new coalesces as part of this message,
113          * and future messages will have nothing.  That's fine. */
114         ceq_ev->idx_posted = FALSE;
115         cmb();  /* order the read after the flag write.  swap provides cpu_mb */
116         /* We extract the existing coals and reset the collection to 0; now the
117          * collected events are in our msg. */
118         msg->ev_arg2 = atomic_swap(&ceq_ev->coalesce, 0);
119         /* if the user wants access to user_data, they can peak in the event array
120          * via ceq->events[msg->ev_type].user_data. */
121         msg->ev_type = idx;
122         msg->ev_arg3 = (void*)ceq_ev->blob_data;
123         ceq_ev->blob_data = 0;  /* racy, but there are no blob guarantees */
124         return TRUE;
125 }
126
127 /* Consumer side, returns TRUE on success and fills *msg with the ev_msg.  If
128  * the ceq appears empty, it will return FALSE.  Messages may have arrived after
129  * we started getting that we do not receive. */
130 bool get_ceq_msg(struct ceq *ceq, struct event_msg *msg)
131 {
132         int32_t idx = get_ring_idx(ceq);
133
134         if (idx == -1) {
135                 /* We didn't get anything via the ring, but if we're overflowed, then we
136                  * need to look in the array directly.  Note that we only handle
137                  * overflow when we failed to get something.  Eventually, we'll deal
138                  * with overflow (which should be very rare).  Also note that while we
139                  * are dealing with overflow, the kernel could be producing and using
140                  * the ring, and we could have consumers consuming from the ring.
141                  *
142                  * Overall, we need to clear the overflow flag, then check every event.
143                  * If we find an event, we need to make sure the *next* consumer
144                  * continues our recovery, hence the overflow_recovery field.  We could
145                  * do the check for recovery immediately, but that adds complexity and
146                  * there's no stated guarantee of CEQ message ordering (you don't have
147                  * it with the ring, either, technically (consider a coalesce)).  So
148                  * we're fine by having *a* consumer finish the recovery, but not
149                  * necesarily the *next* consumer.  So long as no one thinks the CEQ is
150                  * empty when there actually are old messages, then we're okay. */
151                 if (!ceq->ring_overflowed && !ceq->overflow_recovery)
152                         return FALSE;
153                 spin_pdr_lock((struct spin_pdr_lock*)&ceq->u_lock);
154                 if (!ceq->overflow_recovery) {
155                         ceq->overflow_recovery = TRUE;
156                         wmb();  /* set recovery before clearing overflow */
157                         ceq->ring_overflowed = FALSE;
158                         ceq->last_recovered = 0;
159                         wrmb(); /* clear overflowed before reading event entries */
160                 }
161                 for (int i = ceq->last_recovered;
162                      i <= atomic_read(&ceq->max_event_ever);
163                      i++) {
164                         /* Regardles of whether there's a msg here, we checked it. */
165                         ceq->last_recovered++;
166                         if (extract_ceq_msg(ceq, i, msg)) {
167                                 /* We found something.  There might be more, but a future
168                                  * consumer will have to deal with it, or verify there isn't. */
169                                 spin_pdr_unlock((struct spin_pdr_lock*)&ceq->u_lock);
170                                 return TRUE;
171                         }
172                 }
173                 ceq->overflow_recovery = FALSE;
174                 /* made it to the end, looks like there was no overflow left.  there
175                  * could be new ones added behind us (they'd be in the ring or overflow
176                  * would be turned on again), but those message were added after we
177                  * started consuming, and therefore not our obligation to extract. */
178                 spin_pdr_unlock((struct spin_pdr_lock*)&ceq->u_lock);
179                 return FALSE;
180         }
181         if (!extract_ceq_msg(ceq, idx, msg))
182                 return FALSE;
183         return TRUE;
184 }
185
186 /* pvt_idx is the next slot that a new consumer will try to consume.  when
187  * pvt_idx != pub_idx, pub_idx is lagging, and it represents consumptions in
188  * progress. */
189 static bool __ceq_ring_is_empty(struct ceq *ceq)
190 {
191         return __ring_empty(atomic_read(&ceq->prod_idx),
192                             atomic_read(&ceq->cons_pvt_idx));
193 }
194
195 bool ceq_is_empty(struct ceq *ceq)
196 {
197         if (!__ceq_ring_is_empty(ceq) ||
198             ceq->ring_overflowed ||
199             spin_pdr_locked((struct spin_pdr_lock*)&ceq->u_lock)) {
200                 return FALSE;
201         }
202         return TRUE;
203 }
204
205 void ceq_cleanup(struct ceq *ceq)
206 {
207         munmap(ceq->events, sizeof(struct ceq_event) * ceq->nr_events);
208         free(ceq->ring);
209 }