6319e4509503d92159ba8e5fd1c95035dbba974d
[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 <parlib/arch/atomic.h>
10 #include <parlib/arch/arch.h>
11 #include <parlib/ucq.h>
12 #include <parlib/spinlock.h>
13 #include <sys/mman.h>
14 #include <assert.h>
15 #include <stdio.h>
16 #include <parlib/rassert.h> /* for the static_assert() */
17 #include <parlib/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 TRUE on success and fills *msg with the ev_msg.  If
63  * the ucq appears empty, it will return FALSE.  Messages may have arrived after
64  * we started getting that we do not receive. */
65 bool get_ucq_msg(struct ucq *ucq, struct event_msg *msg)
66 {
67         uintptr_t my_idx;
68         struct ucq_page *old_page, *other_page;
69         struct msg_container *my_msg;
70         struct spin_pdr_lock *ucq_lock = (struct spin_pdr_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 FALSE;
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                 spin_pdr_lock(ucq_lock);
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                         spin_pdr_unlock(ucq_lock);
93                         /* Make sure this new slot has a producer (ucq isn't empty) */
94                         if (my_idx == atomic_read(&ucq->prod_idx))
95                                 return FALSE;
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                         /* spinning on userspace here, specifically, another vcore and we
116                          * don't know who it is.  This will spin a bit, then make sure they
117                          * aren't preeempted */
118                         cpu_relax_vc(vcore_id());       /* pass in self to check everyone else*/
119                 }
120                 /* Now the page is done.  0 its metadata and give it up. */
121                 old_page->header.cons_next_pg = 0;
122                 atomic_set(&old_page->header.nr_cons, 0);
123                 /* We want to "free" the page.  We'll try and set it as the spare.  If
124                  * there is already a spare, we'll free that one. */
125                 other_page = (struct ucq_page*)atomic_swap(&ucq->spare_pg,
126                                                            (long)old_page);
127                 assert(!PGOFF(other_page));
128                 if (other_page) {
129                         munmap(other_page, PGSIZE);
130                         atomic_dec(&ucq->nr_extra_pgs);
131                 }
132                 /* All fixed up, unlock.  Other consumers may lock and check to make
133                  * sure things are done. */
134                 spin_pdr_unlock(ucq_lock);
135                 /* Now that everything is fixed, try again from the top */
136                 goto loop_top;
137 claim_slot:
138                 cmb();  /* so we can goto claim_slot */
139                 /* If we're still here, my_idx is good, and we'll try to claim it.  If
140                  * we fail, we need to repeat the whole process. */
141         } while (!atomic_cas(&ucq->cons_idx, my_idx, my_idx + 1));
142         assert(slot_is_good(my_idx));
143         /* Now we have a good slot that we can consume */
144         my_msg = slot2msg(my_idx);
145         /* linux would put an rmb_depends() here */
146         /* Wait til the msg is ready (kernel sets this flag) */
147         while (!my_msg->ready)
148                 cpu_relax();
149         rmb();  /* order the ready read before the contents */
150         /* Copy out */
151         *msg = my_msg->ev_msg;
152         /* Unset this for the next usage of the container */
153         my_msg->ready = FALSE;
154         wmb();  /* post the ready write before incrementing */
155         /* Increment nr_cons, showing we're done */
156         atomic_inc(&((struct ucq_page*)PTE_ADDR(my_idx))->header.nr_cons);
157         return TRUE;
158 }
159
160 bool ucq_is_empty(struct ucq *ucq)
161 {
162         /* The ucq is empty if the consumer and producer are on the same 'next'
163          * slot. */
164         return (atomic_read(&ucq->cons_idx) == atomic_read(&ucq->prod_idx));
165 }