Moves genbuf into kthreads
[akaros.git] / kern / include / kthread.h
1 /* Copyright (c) 2010-13 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 TAILQ_HEAD(kthread_tailq, kthread);
21 TAILQ_HEAD(semaphore_tailq, semaphore);
22
23 #define GENBUF_SZ 128   /* plan9 uses this as a scratch space, per syscall */
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 kernel_ctx                       context;
30         uintptr_t                                       stacktop;
31         struct proc                                     *proc;
32         struct syscall                          *sysc;
33         void                                            *errbuf;        /* TODO: avoiding include loops */
34         TAILQ_ENTRY(kthread)            link;
35         /* ID, other shit, etc */
36         bool                                            is_ktask;       /* default is FALSE */
37         char                                            *name;
38         char                                            generic_buf[GENBUF_SZ];
39 };
40
41 /* Semaphore for kthreads to sleep on.  0 or less means you need to sleep */
42 struct semaphore {
43         struct kthread_tailq            waiters;
44         int                                             nr_signals;
45         spinlock_t                                      lock;
46         bool                                            irq_okay;
47 #ifdef CONFIG_SEMAPHORE_DEBUG
48         TAILQ_ENTRY(semaphore)          link;
49         bool                                            is_on_list;     /* would like better sys/queue.h */
50         uintptr_t                                       bt_pc;          /* program counter of last down */
51         uintptr_t                                       bt_fp;          /* frame pointer of last down */
52         uint32_t                                        calling_core;
53 #endif
54 };
55
56 struct cond_var {
57         struct semaphore                        sem;
58         spinlock_t                                      *lock;          /* usually points to internal_ */
59         spinlock_t                                      internal_lock;
60         unsigned long                           nr_waiters;
61         bool                                            irq_okay;
62 };
63
64 uintptr_t get_kstack(void);
65 void put_kstack(uintptr_t stacktop);
66 uintptr_t *kstack_bottom_addr(uintptr_t stacktop);
67 void kthread_init(void);
68 struct kthread *__kthread_zalloc(void);
69 void restart_kthread(struct kthread *kthread);
70 void kthread_runnable(struct kthread *kthread);
71 void kthread_yield(void);
72 void ktask(char *name, void (*fn)(void*), void *arg);
73 /* Debugging */
74 void check_poison(char *msg);
75
76 void sem_init(struct semaphore *sem, int signals);
77 void sem_init_irqsave(struct semaphore *sem, int signals);
78 bool sem_trydown(struct semaphore *sem);
79 void sem_down(struct semaphore *sem);
80 bool sem_up(struct semaphore *sem);
81 bool sem_trydown_irqsave(struct semaphore *sem, int8_t *irq_state);
82 void sem_down_irqsave(struct semaphore *sem, int8_t *irq_state);
83 bool sem_up_irqsave(struct semaphore *sem, int8_t *irq_state);
84 void print_sem_info(struct semaphore *sem);
85 void print_all_sem_info(void);
86
87 void cv_init(struct cond_var *cv);
88 void cv_init_irqsave(struct cond_var *cv);
89 void cv_init_with_lock(struct cond_var *cv, spinlock_t *lock);
90 void cv_init_irqsave_with_lock(struct cond_var *cv, spinlock_t *lock);
91 void cv_lock(struct cond_var *cv);
92 void cv_unlock(struct cond_var *cv);
93 void cv_lock_irqsave(struct cond_var *cv, int8_t *irq_state);
94 void cv_unlock_irqsave(struct cond_var *cv, int8_t *irq_state);
95 void cv_wait_and_unlock(struct cond_var *cv);   /* does not mess with irqs */
96 void cv_wait(struct cond_var *cv);
97 void __cv_signal(struct cond_var *cv);
98 void __cv_broadcast(struct cond_var *cv);
99 void cv_signal(struct cond_var *cv);
100 void cv_broadcast(struct cond_var *cv);
101 void cv_signal_irqsave(struct cond_var *cv, int8_t *irq_state);
102 void cv_broadcast_irqsave(struct cond_var *cv, int8_t *irq_state);
103
104 #endif /* ROS_KERN_KTHREAD_H */