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