f046556b3aacd22d088b401f7396da78e9187f8d
[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
28          * 'check, signal, check again' pattern, where the first check is an
29          * optimization.  Many rendezes will already be satisfied, so we want to
30          * avoid excessive 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
41                  * an 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 {
59         struct rendez *rv = (struct rendez*)awaiter->data;
60
61         rendez_wakeup(rv);
62 }
63
64 void rendez_debug_waiter(struct alarm_waiter *awaiter)
65 {
66         struct rendez *rv = (struct rendez*)awaiter->data;
67         struct cond_var *cv = &rv->cv;
68         struct kthread *kth;
69         int8_t irq_state = 0;
70
71         cv_lock_irqsave(cv, &irq_state);
72         TAILQ_FOREACH(kth, &cv->waiters, link) {
73                 print_lock();
74                 printk("-------- kth %s ----------\n", kth->name);
75                 backtrace_kthread(kth);
76                 printk("-----------------\n");
77                 print_unlock();
78         }
79         cv_unlock_irqsave(cv, &irq_state);
80 }
81
82 /* Like sleep, but it will timeout in 'usec' microseconds. */
83 void rendez_sleep_timeout(struct rendez *rv, int (*cond)(void*), void *arg,
84                           uint64_t usec)
85 {
86         int8_t irq_state = 0;
87         struct alarm_waiter awaiter;
88         struct cv_lookup_elm cle;
89         struct timer_chain *pcpui_tchain = &per_cpu_info[core_id()].tchain;
90
91         assert(can_block(this_pcpui_ptr()));
92         if (!usec)
93                 return;
94         /* Doing this cond check early, but then unlocking again.  Mostly just
95          * to avoid weird issues with the CV lock and the alarm tchain lock. */
96         cv_lock_irqsave(&rv->cv, &irq_state);
97         if (cond(arg)) {
98                 cv_unlock_irqsave(&rv->cv, &irq_state);
99                 return;
100         }
101         cv_unlock_irqsave(&rv->cv, &irq_state);
102         /* The handler will call rendez_wake, but won't mess with the condition
103          * state.  It's enough to break us out of cv_wait() to see .on_tchain is
104          * clear, which is a proxy for "has my alarm fired or will it soon." */
105         init_awaiter(&awaiter, rendez_alarm_handler);
106         awaiter.data = rv;
107         set_awaiter_rel(&awaiter, usec);
108         /* Set our alarm on this cpu's tchain.  Note that when we sleep in
109          * cv_wait, we could be migrated, and later on we could be unsetting the
110          * alarm remotely. */
111         set_alarm(pcpui_tchain, &awaiter);
112         cv_lock_irqsave(&rv->cv, &irq_state);
113         __reg_abortable_cv(&cle, &rv->cv);
114         /* We could wake early for a few reasons.  Legit wakeups after a changed
115          * condition (and we should exit), other alarms with different timeouts
116          * (and we should go back to sleep), etc.  Note it is possible for our
117          * alarm to fire immediately upon setting it: before we even cv_lock. */
118         while (!cond(arg) && !alarm_expired(&awaiter)) {
119                 if (should_abort(&cle)) {
120                         cv_unlock_irqsave(&rv->cv, &irq_state);
121                         unset_alarm(pcpui_tchain, &awaiter);
122                         dereg_abortable_cv(&cle);
123                         error(EINTR, "syscall aborted");
124                 }
125                 cv_wait(&rv->cv);
126                 cpu_relax();
127         }
128         cv_unlock_irqsave(&rv->cv, &irq_state);
129         dereg_abortable_cv(&cle);
130         /* Turn off our alarm.  If it already fired, this is a no-op.  Note this
131          * could be cross-core. */
132         unset_alarm(pcpui_tchain, &awaiter);
133 }
134
135 /* plan9 rendez returned a pointer to the proc woken up.  we return "true" if we
136  * woke someone up. */
137 bool rendez_wakeup(struct rendez *rv)
138 {
139         int8_t irq_state = 0;
140         bool ret;
141
142         /* The plan9 style "one sleeper, one waker" could get by with a signal
143          * here.  But we want to make sure all potential waiters are woken up.
144          */
145         cv_lock_irqsave(&rv->cv, &irq_state);
146         ret = rv->cv.nr_waiters ? TRUE : FALSE;
147         __cv_broadcast(&rv->cv);
148         cv_unlock_irqsave(&rv->cv, &irq_state);
149         return ret;
150 }