fff5312051bef4e5e4160d00cada756aa59482d9
[akaros.git] / user / parlib / include / parlib / uthread.h
1 #pragma once
2
3 #include <parlib/vcore.h>
4 #include <parlib/signal.h>
5 #include <ros/syscall.h>
6
7 __BEGIN_DECLS
8
9 #define UTHREAD_DONT_MIGRATE            0x001 /* don't move to another vcore */
10 #define UTHREAD_SAVED                           0x002 /* uthread's state is in utf */
11 #define UTHREAD_FPSAVED                         0x004 /* uthread's FP state is in uth->as */
12 #define UTHREAD_IS_THREAD0                      0x008 /* thread0: glibc's main() thread */
13
14 /* Thread States */
15 #define UT_RUNNING              1
16 #define UT_NOT_RUNNING  2
17
18 /* Externally blocked thread reasons (for uthread_has_blocked()) */
19 #define UTH_EXT_BLK_MUTEX                       1
20 #define UTH_EXT_BLK_EVENTQ                      2
21 #define UTH_EXT_BLK_JUSTICE                     3       /* whatever.  might need more options */
22
23 /* Bare necessities of a user thread.  2LSs should allocate a bigger struct and
24  * cast their threads to uthreads when talking with vcore code.  Vcore/default
25  * 2LS code won't touch udata or beyond. */
26 struct uthread {
27         struct user_context u_ctx;
28         struct ancillary_state as;
29         void *tls_desc;
30         int flags;
31         int state;
32         struct sigstate sigstate;
33         int notif_disabled_depth;
34         struct syscall *sysc;   /* syscall we're blocking on, if any */
35         struct syscall local_sysc;      /* for when we don't want to use the stack */
36         void (*yield_func)(struct uthread*, void*);
37         void *yield_arg;
38         int err_no;
39         char err_str[MAX_ERRSTR_LEN];
40 };
41 extern __thread struct uthread *current_uthread;
42 typedef void* uth_mutex_t;
43
44 /* 2L-Scheduler operations.  Examples in pthread.c. */
45 struct schedule_ops {
46         /**** These functions must be defined ****/
47         /* Functions supporting thread ops */
48         void (*sched_entry)(void);
49         void (*thread_runnable)(struct uthread *);
50         void (*thread_paused)(struct uthread *);
51         void (*thread_blockon_sysc)(struct uthread *, void *);
52         void (*thread_has_blocked)(struct uthread *, int);
53         void (*thread_refl_fault)(struct uthread *, struct user_context *);
54         /**** Defining these functions is optional. ****/
55         /* 2LSs can leave the mutex funcs empty for a default implementation */
56         uth_mutex_t (*mutex_alloc)(void);
57         void (*mutex_free)(uth_mutex_t);
58         void (*mutex_lock)(uth_mutex_t);
59         void (*mutex_unlock)(uth_mutex_t);
60         /* Functions event handling wants */
61         void (*preempt_pending)(void);
62 };
63 extern struct schedule_ops *sched_ops;
64
65 /* Low-level _S code calls this for basic uthreading without a 2LS */
66 void uthread_lib_init(void);
67 /* Call this, passing it a uthread representing thread0, from your 2LS init
68  * routines.  When it returns, you're in _M mode (thread0 on vcore0) */
69 void uthread_2ls_init(struct uthread *uthread, struct schedule_ops *ops);
70 /* Call this to become an mcp capable of worling with uthreads. */
71 void uthread_mcp_init(void);
72
73 /* Functions to make/manage uthreads.  Can be called by functions such as
74  * pthread_create(), which can wrap these with their own stuff (like attrs,
75  * retvals, etc). */
76
77 /* uthread_init() does the uthread initialization of a uthread that the caller
78  * created.  Call this whenever you are "starting over" with a thread.  Pass in
79  * attr, if you want to override any defaults. */
80 struct uth_thread_attr {
81         bool want_tls;          /* default, no */
82 };
83 void uthread_init(struct uthread *new_thread, struct uth_thread_attr *attr);
84 /* Call this when you are done with a uthread, forever, but before you free it */
85 void uthread_cleanup(struct uthread *uthread);
86 void uthread_runnable(struct uthread *uthread);
87 void uthread_yield(bool save_state, void (*yield_func)(struct uthread*, void*),
88                    void *yield_arg);
89 void uthread_sleep(unsigned int seconds);
90 void uthread_usleep(unsigned int usecs);
91 void uthread_has_blocked(struct uthread *uthread, int flags);
92 void uthread_paused(struct uthread *uthread);
93
94 /* Utility functions */
95 bool __check_preempt_pending(uint32_t vcoreid); /* careful: check the code */
96 void uth_disable_notifs(void);
97 void uth_enable_notifs(void);
98
99 /* Helpers, which sched_entry() can call */
100 void highjack_current_uthread(struct uthread *uthread);
101 void __attribute__((noreturn)) run_current_uthread(void);
102 void __attribute__((noreturn)) run_uthread(struct uthread *uthread);
103
104 /* Asking for trouble with this API, when we just want stacktop (or whatever
105  * the SP will be). */
106 static inline void init_uthread_ctx(struct uthread *uth, void (*entry)(void),
107                                     void *stack_bottom, uint32_t size)
108 {
109         init_user_ctx(&uth->u_ctx, (long)entry, (long)(stack_bottom) + size);
110 }
111
112 #define uthread_set_tls_var(uth, name, val)                                    \
113 ({                                                                             \
114         typeof(val) __val = val;                                                   \
115         begin_access_tls_vars(((struct uthread*)(uth))->tls_desc);                 \
116         name = __val;                                                              \
117         end_access_tls_vars();                                                     \
118 })
119
120 #define uthread_get_tls_var(uth, name)                                         \
121 ({                                                                             \
122         typeof(name) val;                                                          \
123         begin_access_tls_vars(((struct uthread*)(uth))->tls_desc);                 \
124         val = name;                                                                \
125         end_access_tls_vars();                                                     \
126         val;                                                                       \
127 })
128
129 /* Generic Uthread Mutexes.  2LSs implement their own methods, but we need a
130  * 2LS-independent interface and default implementation. */
131 uth_mutex_t uth_mutex_alloc(void);
132 void uth_mutex_free(uth_mutex_t m);
133 void uth_mutex_lock(uth_mutex_t m);
134 void uth_mutex_unlock(uth_mutex_t m);
135
136 __END_DECLS