Merge origin/netpush (networking code) (XCC)
[akaros.git] / kern / include / kthread.h
1 /* Copyright (c) 2010 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Kernel threading.  These are for blocking within the kernel for whatever
6  * reason, usually during blocking IO operations.  Check out
7  * Documentation/kthreads.txt for more info than you care about. */
8
9 #ifndef ROS_KERN_KTHREAD_H
10 #define ROS_KERN_KTHREAD_H
11
12 #include <ros/common.h>
13 #include <trap.h>
14 #include <sys/queue.h>
15 #include <atomic.h>
16
17 struct proc;
18 struct kthread;
19 struct semaphore;
20 struct semaphore_entry;
21 TAILQ_HEAD(kthread_tailq, kthread);
22 LIST_HEAD(semaphore_list, semaphore_entry);
23
24
25 /* This captures the essence of a kernel context that we want to suspend.  When
26  * a kthread is running, we make sure its stacktop is the default kernel stack,
27  * meaning it will receive the interrupts from userspace. */
28 struct kthread {
29         struct trapframe                        context;
30         uintptr_t                                       stacktop;
31         struct proc                                     *proc;
32         struct syscall                          *sysc;
33         TAILQ_ENTRY(kthread)            link;
34         /* ID, other shit, etc */
35 };
36
37 /* Semaphore for kthreads to sleep on.  0 or less means you need to sleep */
38 struct semaphore {
39         struct kthread_tailq            waiters;
40         int                                             nr_signals;
41         spinlock_t                                      lock;
42         bool                                            irq_okay;
43 };
44
45 struct cond_var {
46         struct semaphore                        sem;
47         spinlock_t                                      lock;
48         unsigned long                           nr_waiters;
49         bool                                            irq_okay;
50 };
51
52 /* TODO: consider building this into struct semaphore */
53 struct semaphore_entry {
54         struct semaphore sem;
55         int fd;
56         LIST_ENTRY(semaphore_entry) link;
57 };
58
59 void kthread_init(void);
60 void restart_kthread(struct kthread *kthread);
61 void kthread_runnable(struct kthread *kthread);
62 void kthread_yield(void);
63
64 void sem_init(struct semaphore *sem, int signals);
65 void sem_init_irqsave(struct semaphore *sem, int signals);
66 void sem_down(struct semaphore *sem);
67 bool sem_up(struct semaphore *sem);
68 void sem_down_irqsave(struct semaphore *sem, int8_t *irq_state);
69 bool sem_up_irqsave(struct semaphore *sem, int8_t *irq_state);
70
71 void cv_init(struct cond_var *cv);
72 void cv_init_irqsave(struct cond_var *cv);
73 void cv_lock(struct cond_var *cv);
74 void cv_unlock(struct cond_var *cv);
75 void cv_lock_irqsave(struct cond_var *cv, int8_t *irq_state);
76 void cv_unlock_irqsave(struct cond_var *cv, int8_t *irq_state);
77 void cv_wait_and_unlock(struct cond_var *cv);   /* does not mess with irqs */
78 void cv_wait(struct cond_var *cv);
79 void __cv_signal(struct cond_var *cv);
80 void __cv_broadcast(struct cond_var *cv);
81 void cv_signal(struct cond_var *cv);
82 void cv_broadcast(struct cond_var *cv);
83 void cv_signal_irqsave(struct cond_var *cv, int8_t *irq_state);
84 void cv_broadcast_irqsave(struct cond_var *cv, int8_t *irq_state);
85
86 #endif /* ROS_KERN_KTHREAD_H */