9ns: Fix dangling negative TFs
[akaros.git] / kern / src / rendez.c
1 /* Copyright (c) 2013 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Plan9 style Rendezvous (http://plan9.bell-labs.com/sys/doc/sleep.html)
6  *
7  * We implement it with CVs, and it can handle multiple sleepers/wakers. */
8
9 #include <rendez.h>
10 #include <kthread.h>
11 #include <alarm.h>
12 #include <assert.h>
13 #include <smp.h>
14 #include <err.h>
15
16 void rendez_init(struct rendez *rv)
17 {
18         cv_init_irqsave(&rv->cv);
19 }
20
21 void rendez_sleep(struct rendez *rv, int (*cond)(void*), void *arg)
22 {
23         int8_t irq_state = 0;
24         struct cv_lookup_elm cle;
25
26         assert(can_block(this_pcpui_ptr()));
27         /* Do a quick check before registering and sleeping.  this is the 'check,
28          * signal, check again' pattern, where the first check is an optimization.
29          * Many rendezes will already be satisfied, so we want to avoid excessive
30          * locking associated with reg/dereg. */
31         cv_lock_irqsave(&rv->cv, &irq_state);
32         if (cond(arg)) {
33                 cv_unlock_irqsave(&rv->cv, &irq_state);
34                 return;
35         }
36         __reg_abortable_cv(&cle, &rv->cv);
37         /* Mesa-style semantics, which is definitely what you want.  See the
38          * discussion at the end of the URL above. */
39         while (!cond(arg)) {
40                 /* it's okay if we miss the ABORT flag; we hold the cv lock, so an
41                  * aborter's broadcast is waiting until we unlock. */
42                 if (should_abort(&cle)) {
43                         cv_unlock_irqsave(&rv->cv, &irq_state);
44                         dereg_abortable_cv(&cle);
45                         error(EINTR, "syscall aborted");
46                 }
47                 cv_wait(&rv->cv);
48                 cpu_relax();
49         }
50         cv_unlock_irqsave(&rv->cv, &irq_state);
51         dereg_abortable_cv(&cle);
52 }
53
54 /* Force a wakeup of all waiters on the rv, including non-timeout users.  For
55  * those, they will just wake up, see the condition is still false (probably)
56  * and go back to sleep. */
57 static void rendez_alarm_handler(struct alarm_waiter *awaiter,
58                                  struct hw_trapframe *hw_tf)
59 {
60         struct rendez *rv = (struct rendez*)awaiter->data;
61
62         rendez_wakeup(rv);
63 }
64
65 /* Like sleep, but it will timeout in 'usec' microseconds. */
66 void rendez_sleep_timeout(struct rendez *rv, int (*cond)(void*), void *arg,
67                           uint64_t usec)
68 {
69         int8_t irq_state = 0;
70         struct alarm_waiter awaiter;
71         struct cv_lookup_elm cle;
72         struct timer_chain *pcpui_tchain = &per_cpu_info[core_id()].tchain;
73
74         assert(can_block(this_pcpui_ptr()));
75         if (!usec)
76                 return;
77         /* Doing this cond check early, but then unlocking again.  Mostly just to
78          * avoid weird issues with the CV lock and the alarm tchain lock. */
79         cv_lock_irqsave(&rv->cv, &irq_state);
80         if (cond(arg)) {
81                 cv_unlock_irqsave(&rv->cv, &irq_state);
82                 return;
83         }
84         cv_unlock_irqsave(&rv->cv, &irq_state);
85         /* The handler will call rendez_wake, but won't mess with the condition
86          * state.  It's enough to break us out of cv_wait() to see .on_tchain.
87          * Since all we're doing is poking a rendez, we might as well just do it
88          * from IRQ ctx instead of mucking with an extra RKM.  It also avoids issues
89          * with unset_alarm blocking. */
90         init_awaiter_irq(&awaiter, rendez_alarm_handler);
91         awaiter.data = rv;
92         set_awaiter_rel(&awaiter, usec);
93         /* Set our alarm on this cpu's tchain.  Note that when we sleep in cv_wait,
94          * we could be migrated, and later on we could be unsetting the alarm
95          * remotely. */
96         set_alarm(pcpui_tchain, &awaiter);
97         cv_lock_irqsave(&rv->cv, &irq_state);
98         __reg_abortable_cv(&cle, &rv->cv);
99         /* We could wake early for a few reasons.  Legit wakeups after a changed
100          * condition (and we should exit), other alarms with different timeouts (and
101          * we should go back to sleep), etc.  Note it is possible for our alarm to
102          * fire immediately upon setting it: before we even cv_lock. */
103         while (!cond(arg) && awaiter.on_tchain) {
104                 if (should_abort(&cle)) {
105                         cv_unlock_irqsave(&rv->cv, &irq_state);
106                         unset_alarm(pcpui_tchain, &awaiter);
107                         dereg_abortable_cv(&cle);
108                         error(EINTR, "syscall aborted");
109                 }
110                 cv_wait(&rv->cv);
111                 cpu_relax();
112         }
113         cv_unlock_irqsave(&rv->cv, &irq_state);
114         dereg_abortable_cv(&cle);
115         /* Turn off our alarm.  If it already fired, this is a no-op.  Note this
116          * could be cross-core. */
117         unset_alarm(pcpui_tchain, &awaiter);
118 }
119
120 /* plan9 rendez returned a pointer to the proc woken up.  we return "true" if we
121  * woke someone up. */
122 bool rendez_wakeup(struct rendez *rv)
123 {
124         int8_t irq_state = 0;
125         bool ret;
126         /* The plan9 style "one sleeper, one waker" could get by with a signal here.
127          * But we want to make sure all potential waiters are woken up. */
128         cv_lock_irqsave(&rv->cv, &irq_state);
129         ret = rv->cv.nr_waiters ? TRUE : FALSE;
130         __cv_broadcast(&rv->cv);
131         cv_unlock_irqsave(&rv->cv, &irq_state);
132         return ret;
133 }