Reworks MCS-PDR locks to avoid preempt storms
[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 <spinlock.h>
13 #include <sys/mman.h>
14 #include <assert.h>
15 #include <stdio.h>
16 #include <rassert.h> /* for the static_assert() */
17 #include <vcore.h>
18
19 /* Initializes a ucq.  You pass in addresses of mmaped pages for the main page
20  * (prod_idx) and the spare page.  I recommend mmaping a big chunk and breaking
21  * it up over a bunch of ucqs, instead of doing a lot of little mmap() calls. */
22 void ucq_init_raw(struct ucq *ucq, uintptr_t pg1, uintptr_t pg2)
23 {
24         printd("[user] initializing ucq %08p for proc %d\n", ucq, getpid());
25         assert(!PGOFF(pg1));
26         assert(!PGOFF(pg2));
27         /* Prod and cons both start on the first page, slot 0.  When they are equal,
28          * the ucq is empty. */
29         atomic_set(&ucq->prod_idx, pg1);
30         atomic_set(&ucq->cons_idx, pg1);
31         ucq->prod_overflow = FALSE;
32         atomic_set(&ucq->nr_extra_pgs, 0);
33         atomic_set(&ucq->spare_pg, pg2);
34         static_assert(sizeof(struct spin_pdr_lock) <= sizeof(ucq->u_lock));
35         spin_pdr_init((struct spin_pdr_lock*)(&ucq->u_lock));
36         ucq->ucq_ready = TRUE;
37 }
38
39 /* Inits a ucq, where you don't have to bother with the memory allocation.  This
40  * would be appropriate for one or two UCQs, though if you're allocating in
41  * bulk, use the raw version. */
42 void ucq_init(struct ucq *ucq)
43 {
44         uintptr_t two_pages = (uintptr_t)mmap(0, PGSIZE * 2,
45                                               PROT_WRITE | PROT_READ,
46                                               MAP_POPULATE | MAP_ANONYMOUS, -1, 0);
47         assert(two_pages);
48         ucq_init_raw(ucq, two_pages, two_pages + PGSIZE);
49 }
50
51 /* Only call this on ucq's made with the simple ucq_init().  And be sure the ucq
52  * is no longer in use. */
53 void ucq_free_pgs(struct ucq *ucq)
54 {
55         uintptr_t pg1 = atomic_read(&ucq->prod_idx);
56         uintptr_t pg2 = atomic_read(&ucq->spare_pg);
57         assert(pg1 && pg2);
58         munmap((void*)pg1, PGSIZE);
59         munmap((void*)pg2, PGSIZE);
60 }
61
62 /* Consumer side, returns 0 on success and fills *msg with the ev_msg.  If the
63  * ucq is empty, it will return -1. */
64 int get_ucq_msg(struct ucq *ucq, struct event_msg *msg)
65 {
66         uintptr_t my_idx;
67         struct ucq_page *old_page, *other_page;
68         struct msg_container *my_msg;
69         struct spin_pdr_lock *ucq_lock = (struct spin_pdr_lock*)(&ucq->u_lock);
70
71         do {
72 loop_top:
73                 cmb();
74                 my_idx = atomic_read(&ucq->cons_idx);
75                 /* The ucq is empty if the consumer and producer are on the same 'next'
76                  * slot. */
77                 if (my_idx == atomic_read(&ucq->prod_idx))
78                         return -1;
79                 /* Is the slot we want good?  If not, we're going to need to try and
80                  * move on to the next page.  If it is, we bypass all of this and try to
81                  * CAS on us getting my_idx. */
82                 if (slot_is_good(my_idx))
83                         goto claim_slot;
84                 /* Slot is bad, let's try and fix it */
85                 spin_pdr_lock(ucq_lock);
86                 /* Reread the idx, in case someone else fixed things up while we
87                  * were waiting/fighting for the lock */
88                 my_idx = atomic_read(&ucq->cons_idx);
89                 if (slot_is_good(my_idx)) {
90                         /* Someone else fixed it already, let's just try to get out */
91                         spin_pdr_unlock(ucq_lock);
92                         /* Make sure this new slot has a producer (ucq isn't empty) */
93                         if (my_idx == atomic_read(&ucq->prod_idx))
94                                 return -1;
95                         goto claim_slot;
96                 }
97                 /* At this point, the slot is bad, and all other possible consumers are
98                  * spinning on the lock.  Time to fix things up: Set the counter to the
99                  * next page, and free the old one. */
100                 /* First, we need to wait and make sure the kernel has posted the next
101                  * page.  Worst case, we know that the kernel is working on it, since
102                  * prod_idx != cons_idx */
103                 old_page = (struct ucq_page*)PTE_ADDR(my_idx);
104                 while (!old_page->header.cons_next_pg)
105                         cpu_relax();
106                 /* Now set the counter to the next page */
107                 assert(!PGOFF(old_page->header.cons_next_pg));
108                 atomic_set(&ucq->cons_idx, old_page->header.cons_next_pg);
109                 /* Side note: at this point, any *new* consumers coming in will grab
110                  * slots based off the new counter index (cons_idx) */
111                 /* Now free up the old page.  Need to make sure all other consumers are
112                  * done.  We spin til enough are done, like an inverted refcnt. */
113                 while (atomic_read(&old_page->header.nr_cons) < NR_MSG_PER_PAGE) {
114                         /* spinning on userspace here, specifically, another vcore and we
115                          * don't know who it is.  This will spin a bit, then make sure they
116                          * aren't preeempted */
117                         cpu_relax_vc(vcore_id());       /* pass in self to check everyone else*/
118                 }
119                 /* Now the page is done.  0 its metadata and give it up. */
120                 old_page->header.cons_next_pg = 0;
121                 atomic_set(&old_page->header.nr_cons, 0);
122                 /* We want to "free" the page.  We'll try and set it as the spare.  If
123                  * there is already a spare, we'll free that one. */
124                 other_page = (struct ucq_page*)atomic_swap(&ucq->spare_pg,
125                                                            (long)old_page);
126                 assert(!PGOFF(other_page));
127                 if (other_page) {
128                         munmap(other_page, PGSIZE);
129                         atomic_dec(&ucq->nr_extra_pgs);
130                 }
131                 /* All fixed up, unlock.  Other consumers may lock and check to make
132                  * sure things are done. */
133                 spin_pdr_unlock(ucq_lock);
134                 /* Now that everything is fixed, try again from the top */
135                 goto loop_top;
136 claim_slot:
137                 cmb();  /* so we can goto claim_slot */
138                 /* If we're still here, my_idx is good, and we'll try to claim it.  If
139                  * we fail, we need to repeat the whole process. */
140         } while (!atomic_cas(&ucq->cons_idx, my_idx, my_idx + 1));
141         assert(slot_is_good(my_idx));
142         /* Now we have a good slot that we can consume */
143         my_msg = slot2msg(my_idx);
144         /* linux would put an rmb_depends() here */
145         /* Wait til the msg is ready (kernel sets this flag) */
146         while (!my_msg->ready)
147                 cpu_relax();
148         rmb();  /* order the ready read before the contents */
149         /* Copy out */
150         *msg = my_msg->ev_msg;
151         /* Unset this for the next usage of the container */
152         my_msg->ready = FALSE;
153         wmb();  /* post the ready write before incrementing */
154         /* Increment nr_cons, showing we're done */
155         atomic_inc(&((struct ucq_page*)PTE_ADDR(my_idx))->header.nr_cons);
156         return 0;
157 }
158
159 bool ucq_is_empty(struct ucq *ucq)
160 {
161         /* The ucq is empty if the consumer and producer are on the same 'next'
162          * slot. */
163         return (atomic_read(&ucq->cons_idx) == atomic_read(&ucq->prod_idx));
164 }