Fixes race in UCQ consumer
[akaros.git] / user / parlib / ucq.c
1 /* Copyright (c) 2011 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Unbounded concurrent queues, user side.  Check k/i/r/ucq.h or the
6  * Documentation for more info. */
7
8 #include <ros/arch/membar.h>
9 #include <arch/atomic.h>
10 #include <arch/arch.h>
11 #include <ucq.h>
12 #include <mcs.h>
13 #include <sys/mman.h>
14 #include <assert.h>
15 #include <stdio.h>
16 #include <rassert.h> /* for the static_assert() */
17
18 /* Initializes a ucq.  You pass in addresses of mmaped pages for the main page
19  * (prod_idx) and the spare page.  I recommend mmaping a big chunk and breaking
20  * it up over a bunch of ucqs, instead of doing a lot of little mmap() calls. */
21 void ucq_init_raw(struct ucq *ucq, uintptr_t pg1, uintptr_t pg2)
22 {
23         assert(!PGOFF(pg1));
24         assert(!PGOFF(pg2));
25         /* Prod and cons both start on the first page, slot 0.  When they are equal,
26          * the ucq is empty. */
27         atomic_set(&ucq->prod_idx, pg1);
28         atomic_set(&ucq->cons_idx, pg1);
29         ucq->prod_overflow = FALSE;
30         atomic_set(&ucq->nr_extra_pgs, 0);
31         atomic_set(&ucq->spare_pg, pg2);
32         static_assert(sizeof(struct mcs_lock) <= sizeof(ucq->u_lock));
33         mcs_lock_init((struct mcs_lock*)(&ucq->u_lock));
34         ucq->ucq_ready = TRUE;
35 }
36
37 /* Inits a ucq, where you don't have to bother with the memory allocation.  This
38  * would be appropriate for one or two UCQs, though if you're allocating in
39  * bulk, use the raw version. */
40 void ucq_init(struct ucq *ucq)
41 {
42         uintptr_t two_pages = (uintptr_t)mmap(0, PGSIZE * 2,
43                                               PROT_WRITE | PROT_READ,
44                                               MAP_POPULATE | MAP_ANONYMOUS, -1, 0);
45         assert(two_pages);
46         ucq_init_raw(ucq, two_pages, two_pages + PGSIZE);
47 }
48
49 /* Only call this on ucq's made with the simple ucq_init().  And be sure the ucq
50  * is no longer in use. */
51 void ucq_free_pgs(struct ucq *ucq)
52 {
53         uintptr_t pg1 = atomic_read(&ucq->prod_idx);
54         uintptr_t pg2 = atomic_read(&ucq->spare_pg);
55         assert(pg1 && pg2);
56         munmap((void*)pg1, PGSIZE);
57         munmap((void*)pg2, PGSIZE);
58 }
59
60 /* Consumer side, returns 0 on success and fills *msg with the ev_msg.  If the
61  * ucq is empty, it will return -1. */
62 int get_ucq_msg(struct ucq *ucq, struct event_msg *msg)
63 {
64         uintptr_t my_idx;
65         struct ucq_page *old_page, *other_page;
66         struct msg_container *my_msg;
67         /* Locking stuff.  Would be better with a spinlock, if we had them, since
68          * this should be lightly contested.  */
69         struct mcs_lock_qnode local_qn = {0};
70         struct mcs_lock *ucq_lock = (struct mcs_lock*)(&ucq->u_lock);
71
72         do {
73 loop_top:
74                 cmb();
75                 my_idx = atomic_read(&ucq->cons_idx);
76                 /* The ucq is empty if the consumer and producer are on the same 'next'
77                  * slot. */
78                 if (my_idx == atomic_read(&ucq->prod_idx))
79                         return -1;
80                 /* Is the slot we want good?  If not, we're going to need to try and
81                  * move on to the next page.  If it is, we bypass all of this and try to
82                  * CAS on us getting my_idx. */
83                 if (slot_is_good(my_idx))
84                         goto claim_slot;
85                 /* Slot is bad, let's try and fix it */
86                 mcs_lock_notifsafe(ucq_lock, &local_qn);
87                 /* Reread the idx, in case someone else fixed things up while we
88                  * were waiting/fighting for the lock */
89                 my_idx = atomic_read(&ucq->cons_idx);
90                 if (slot_is_good(my_idx)) {
91                         /* Someone else fixed it already, let's just try to get out */
92                         mcs_unlock_notifsafe(ucq_lock, &local_qn);
93                         /* Make sure this new slot has a producer (ucq isn't empty) */
94                         if (my_idx == atomic_read(&ucq->prod_idx))
95                                 return -1;
96                         goto claim_slot;
97                 }
98                 /* At this point, the slot is bad, and all other possible consumers are
99                  * spinning on the lock.  Time to fix things up: Set the counter to the
100                  * next page, and free the old one. */
101                 /* First, we need to wait and make sure the kernel has posted the next
102                  * page.  Worst case, we know that the kernel is working on it, since
103                  * prod_idx != cons_idx */
104                 old_page = (struct ucq_page*)PTE_ADDR(my_idx);
105                 while (!old_page->header.cons_next_pg)
106                         cpu_relax();
107                 /* Now set the counter to the next page */
108                 assert(!PGOFF(old_page->header.cons_next_pg));
109                 atomic_set(&ucq->cons_idx, old_page->header.cons_next_pg);
110                 /* Side note: at this point, any *new* consumers coming in will grab
111                  * slots based off the new counter index (cons_idx) */
112                 /* Now free up the old page.  Need to make sure all other consumers are
113                  * done.  We spin til enough are done, like an inverted refcnt. */
114                 while (atomic_read(&old_page->header.nr_cons) < NR_MSG_PER_PAGE)
115                         cpu_relax();
116                 /* Now the page is done.  0 its metadata and give it up. */
117                 old_page->header.cons_next_pg = 0;
118                 atomic_set(&old_page->header.nr_cons, 0);
119                 /* We want to "free" the page.  We'll try and set it as the spare.  If
120                  * there is already a spare, we'll free that one. */
121                 other_page = (struct ucq_page*)atomic_swap(&ucq->spare_pg,
122                                                            (long)old_page);
123                 assert(!PGOFF(other_page));
124                 if (other_page) {
125                         munmap(other_page, PGSIZE);
126                         atomic_dec(&ucq->nr_extra_pgs);
127                 }
128                 /* All fixed up, unlock.  Other consumers may lock and check to make
129                  * sure things are done. */
130                 mcs_unlock_notifsafe(ucq_lock, &local_qn);
131                 /* Now that everything is fixed, try again from the top */
132                 goto loop_top;
133 claim_slot:
134                 cmb();  /* so we can goto claim_slot */
135                 /* If we're still here, my_idx is good, and we'll try to claim it.  If
136                  * we fail, we need to repeat the whole process. */
137         } while (!atomic_cas(&ucq->cons_idx, my_idx, my_idx + 1));
138         assert(slot_is_good(my_idx));
139         /* Now we have a good slot that we can consume */
140         my_msg = slot2msg(my_idx);
141         /* Wait til the msg is ready (kernel sets this flag) */
142         while (!my_msg->ready)
143                 cpu_relax();
144         /* Copy out */
145         *msg = my_msg->ev_msg;
146         /* Unset this for the next usage of the container */
147         my_msg->ready = FALSE;
148         wmb();
149         /* Increment nr_cons, showing we're done */
150         atomic_inc(&((struct ucq_page*)PTE_ADDR(my_idx))->header.nr_cons);
151         return 0;
152 }