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