4ef2ea88089af107683ae8dfba0261661ed4d9b5
[akaros.git] / kern / src / 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  * Kernel side of ucqs. */
6
7 #include <ucq.h>
8 #include <umem.h>
9 #include <assert.h>
10 #include <mm.h>
11 #include <atomic.h>
12
13 /* Proc p needs to be current, and you should have checked that ucq is valid
14  * memory.  We'll assert it here, to catch any of your bugs.  =) */
15 void send_ucq_msg(struct ucq *ucq, struct proc *p, struct event_msg *msg)
16 {
17         uintptr_t my_slot = 0;
18         struct ucq_page *new_page, *old_page;
19         struct msg_container *my_msg;
20
21         assert(is_user_rwaddr(ucq, sizeof(struct ucq)));
22         /* So we can try to send ucqs to _Ss before they initialize */
23         if (!ucq->ucq_ready) {
24                 if (p->state & (PROC_RUNNING_M | PROC_RUNNABLE_M))
25                         warn("proc %d is _M with an uninitialized ucq %08p\n", p->pid, ucq);
26                 return;
27         }
28         /* Bypass fetching/incrementing the counter if we're overflowing, helps
29          * prevent wraparound issues on the counter (only 12 bits of counter) */
30         if (ucq->prod_overflow)
31                 goto grab_lock;
32         /* Grab a potential slot */
33         my_slot = (uintptr_t)atomic_fetch_and_add(&ucq->prod_idx, 1);
34         if (slot_is_good(my_slot))
35                 goto have_slot;
36         /* Warn others to not bother with the fetch_and_add */
37         ucq->prod_overflow = TRUE;
38         /* Sanity check */
39         if (PGOFF(my_slot) > 3000)
40                 warn("Abnormally high counter, there's probably something wrong!");
41 grab_lock:
42         /* Lock, for this proc/ucq.  Using an irqsave, since we may want to send ucq
43          * messages from irq context. */
44         hash_lock_irqsave(p->ucq_hashlock, (long)ucq);
45         /* Grab a potential slot (again, preventing another DoS) */
46         my_slot = (uintptr_t)atomic_fetch_and_add(&ucq->prod_idx, 1);
47         if (slot_is_good(my_slot))
48                 goto unlock_lock;
49         /* Check to make sure the old_page was good before we do anything too
50          * intense (we deref it later).  Bad pages are likely due to
51          * user-malfeasance or neglect.
52          *
53          * The is_user_rwaddr() check on old_page might catch addresses below
54          * MMAP_LOWEST_VA, and we can also handle a PF, but we'll explicitly check
55          * for 0 just to be sure (and it's a likely error). */
56         old_page = (struct ucq_page*)PTE_ADDR(my_slot);
57         if (!is_user_rwaddr(old_page, PGSIZE) || !old_page)
58                 goto error_addr_unlock;
59         /* Things still aren't fixed, so we need to reset everything */
60         /* Try to get the spare page, so we don't have to mmap a new one */
61         new_page = (struct ucq_page*)atomic_swap(&ucq->spare_pg, 0);
62         if (!new_page) {
63                 /* Warn if we have a ridiculous amount of pages in the ucq */
64                 if (atomic_fetch_and_add(&ucq->nr_extra_pgs, 1) > UCQ_WARN_THRESH)
65                         warn("Over %d pages in ucq %08p!\n", UCQ_WARN_THRESH, ucq);
66                 new_page = (struct ucq_page*)do_mmap(p, 0, PGSIZE,
67                                                      PROT_READ | PROT_WRITE,
68                                                      MAP_ANON | MAP_POPULATE, 0, 0);
69                 assert(new_page);
70                 assert(!PGOFF(new_page));
71         } else {
72                 /* If we're using the user-supplied new_page, we need to check it */
73                 if (!is_user_rwaddr(new_page, PGSIZE) || PGOFF(new_page))
74                         goto error_addr_unlock;
75         }
76         /* Now we have a page.  Lets make sure it's set up properly */
77         new_page->header.cons_next_pg = 0;
78         new_page->header.nr_cons = 0;
79         /* Link the old page to the new one, so consumers know how to follow */
80         old_page->header.cons_next_pg = (uintptr_t)new_page;
81         /* Set the prod_idx counter to 1 (and the new_page), reserving the first
82          * slot (number '0') for us (reservation prevents DoS). */
83         my_slot = (uintptr_t)new_page;
84         atomic_set(&ucq->prod_idx, my_slot + 1);
85         /* Fallthrough to clear overflow and unlock */
86 unlock_lock:
87         /* Clear the overflow, so new producers will try to get a slot */
88         ucq->prod_overflow = FALSE;
89         /* At this point, any normal (non-locking) producers can succeed in getting
90          * a slot.  The ones that failed earlier will fight for the lock, then
91          * quickly proceed when they get a good slot */
92         hash_unlock_irqsave(p->ucq_hashlock, (long)ucq);
93         /* Fall through to having a slot */
94 have_slot:
95         /* Sanity check on our slot. */
96         assert(slot_is_good(my_slot));
97         /* Convert slot to actual msg_container.  Note we never actually deref
98          * my_slot here (o/w we'd need a rw_addr check). */
99         my_msg = slot2msg(my_slot);
100         /* Make sure our msg is user RW */
101         if (!is_user_rwaddr(my_msg, sizeof(struct msg_container)))
102                 goto error_addr;
103         /* Finally write the message */
104         my_msg->ev_msg = *msg;
105         wmb();
106         /* Now that the write is done, signal to the consumer that they can consume
107          * our message (they could have been spinning on it) */
108         my_msg->ready = TRUE;
109         return;
110 error_addr_unlock:
111         /* Had a bad addr while holding the lock.  This is a bit more serious */
112         warn("Bad addr in ucq page management!");
113         ucq->prod_overflow = FALSE;
114         hash_unlock_irqsave(p->ucq_hashlock, (long)ucq);
115         /* Fall-through to normal error out */
116 error_addr:
117         warn("Invalid user address, not sending a message");
118         /* TODO: consider killing the process here.  For now, just catch it.  For
119          * some cases, we have a slot that we never fill in, though if we had a bad
120          * addr, none of this will work out and the kernel just needs to protect
121          * itself. */
122         return;
123 }