67213b02c0f7c87589431dcaf8b19e93f6522209
[akaros.git] / user / parlib / include / uthread.h
1 #ifndef _UTHREAD_H
2 #define _UTHREAD_H
3
4 #include <vcore.h>
5 #include <ros/syscall.h>
6
7 #define UTHREAD_DONT_MIGRATE            0x001 /* don't move to another vcore */
8 #define UTHREAD_SAVED                           0x002 /* uthread's state is in utf */
9
10 /* Thread States */
11 #define UT_CREATED      1
12 #define UT_RUNNABLE     2
13 #define UT_RUNNING      3
14 #define UT_BLOCKED      4
15 #define UT_DYING        5
16
17 /* Bare necessities of a user thread.  2LSs should allocate a bigger struct and
18  * cast their threads to uthreads when talking with vcore code.  Vcore/default
19  * 2LS code won't touch udata or beyond. */
20 struct uthread {
21         struct user_trapframe utf;
22         struct ancillary_state as;
23         void *tls_desc;
24         int flags;
25         struct syscall *sysc;   /* syscall we're blocking on, if any */
26         int state;
27 };
28 extern __thread struct uthread *current_uthread;
29
30 /* 2L-Scheduler operations.  Can be 0.  Examples in pthread.c. */
31 struct schedule_ops {
32         /* Functions supporting thread ops */
33         void (*sched_entry)(void);
34         void (*thread_runnable)(struct uthread *);
35         void (*thread_yield)(struct uthread *);
36         void (*thread_paused)(struct uthread *);
37         void (*thread_blockon_sysc)(struct syscall *);
38         /* Functions event handling wants */
39         void (*preempt_pending)(void);
40         void (*spawn_thread)(uintptr_t pc_start, void *data);   /* don't run yet */
41 };
42 extern struct schedule_ops *sched_ops;
43
44 /* Call this, passing it a uthread representing thread0, from your 2LS init
45  * routines.  When it returns, you're in _M mode (thread0 on vcore0) */
46 int uthread_lib_init(struct uthread *uthread);
47
48 /* Functions to make/manage uthreads.  Can be called by functions such as
49  * pthread_create(), which can wrap these with their own stuff (like attrs,
50  * retvals, etc). */
51
52 /* Does the uthread initialization of a uthread that the caller created.  Call
53  * this whenever you are "starting over" with a thread. */
54 void uthread_init(struct uthread *new_thread);
55 /* Call this when you are done with a uthread, forever, but before you free it */
56 void uthread_cleanup(struct uthread *uthread);
57 void uthread_runnable(struct uthread *uthread);
58 void uthread_yield(bool save_state);
59 /* Block the calling uthread on sysc until it makes progress or is done */
60 void ros_syscall_blockon(struct syscall *sysc);
61
62 /* Utility functions */
63 bool check_preempt_pending(uint32_t vcoreid);
64 void uth_disable_notifs(void);
65 void uth_enable_notifs(void);
66
67 bool register_evq(struct syscall *sysc, struct event_queue *ev_q);
68 void deregister_evq(struct syscall *sysc);
69
70 /* Helpers, which sched_entry() can call */
71 void run_current_uthread(void);
72 void run_uthread(struct uthread *uthread);
73
74 #endif /* _UTHREAD_H */