Adds hexdump to a parlib header
[akaros.git] / user / parlib / include / uthread.h
1 #ifndef PARLIB_UTHREAD_H
2 #define PARLIB_UTHREAD_H
3
4 #include <parlib/vcore.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_JUSTICE                     2       /* whatever.  might need more options */
21
22 /* Bare necessities of a user thread.  2LSs should allocate a bigger struct and
23  * cast their threads to uthreads when talking with vcore code.  Vcore/default
24  * 2LS code won't touch udata or beyond. */
25 struct uthread {
26         struct user_context u_ctx;
27         struct ancillary_state as;
28         void *tls_desc;
29         int flags;
30         int state;
31         int notif_disabled_depth;
32         struct syscall *sysc;   /* syscall we're blocking on, if any */
33         struct syscall local_sysc;      /* for when we don't want to use the stack */
34         void (*yield_func)(struct uthread*, void*);
35         void *yield_arg;
36         int err_no;
37         char err_str[MAX_ERRSTR_LEN];
38 };
39 typedef struct uthread uthread_t;
40 extern __thread struct uthread *current_uthread;
41
42 /* 2L-Scheduler operations.  Examples in pthread.c. */
43 struct schedule_ops {
44         /* Functions supporting thread ops */
45         void (*sched_entry)(void);
46         void (*thread_runnable)(struct uthread *);
47         void (*thread_paused)(struct uthread *);
48         void (*thread_blockon_sysc)(struct uthread *, void *);
49         void (*thread_has_blocked)(struct uthread *, int);
50         void (*thread_refl_fault)(struct uthread *, unsigned int, unsigned int,
51                                                           unsigned long);
52         /* Functions event handling wants */
53         void (*preempt_pending)(void);
54         void (*spawn_thread)(uintptr_t pc_start, void *data);   /* don't run yet */
55 };
56 extern struct schedule_ops *sched_ops;
57
58 /* Call this, passing it a uthread representing thread0, from your 2LS init
59  * routines.  When it returns, you're in _M mode (thread0 on vcore0) */
60 void uthread_lib_init(struct uthread *uthread);
61
62 /* Functions to make/manage uthreads.  Can be called by functions such as
63  * pthread_create(), which can wrap these with their own stuff (like attrs,
64  * retvals, etc). */
65
66 /* uthread_init() does the uthread initialization of a uthread that the caller
67  * created.  Call this whenever you are "starting over" with a thread.  Pass in
68  * attr, if you want to override any defaults. */
69 struct uth_thread_attr {
70         bool want_tls;          /* default, no */
71 };
72 void uthread_init(struct uthread *new_thread, struct uth_thread_attr *attr);
73 /* Low-level _S code calls this for basic uthreading without a 2LS */
74 void uthread_slim_init(void);
75 /* Call this when you are done with a uthread, forever, but before you free it */
76 void uthread_cleanup(struct uthread *uthread);
77 void uthread_runnable(struct uthread *uthread);
78 void uthread_yield(bool save_state, void (*yield_func)(struct uthread*, void*),
79                    void *yield_arg);
80 void uthread_sleep(unsigned int seconds);
81 void uthread_usleep(unsigned int usecs);
82
83 /* Utility functions */
84 bool __check_preempt_pending(uint32_t vcoreid); /* careful: check the code */
85 void uth_disable_notifs(void);
86 void uth_enable_notifs(void);
87
88 bool register_evq(struct syscall *sysc, struct event_queue *ev_q);
89 void deregister_evq(struct syscall *sysc);
90
91 /* Helpers, which sched_entry() can call */
92 void highjack_current_uthread(struct uthread *uthread);
93 void run_current_uthread(void);
94 void run_uthread(struct uthread *uthread);
95
96 /* Asking for trouble with this API, when we just want stacktop (or whatever
97  * the SP will be). */
98 static inline void init_uthread_ctx(struct uthread *uth, void (*entry)(void),
99                                     void *stack_bottom, uint32_t size)
100 {
101         init_user_ctx(&uth->u_ctx, (long)entry, (long)(stack_bottom) + size);
102 }
103
104 #define uthread_set_tls_var(uth, name, val)                                    \
105 ({                                                                             \
106         typeof(val) __val = val;                                                   \
107         begin_access_tls_vars(((struct uthread*)(uth))->tls_desc);                 \
108         name = __val;                                                              \
109         end_access_tls_vars();                                                     \
110 })
111
112 #define uthread_get_tls_var(uth, name)                                         \
113 ({                                                                             \
114         typeof(name) val;                                                          \
115         begin_access_tls_vars(((struct uthread*)(uth))->tls_desc);                 \
116         val = name;                                                                \
117         end_access_tls_vars();                                                     \
118         val;                                                                       \
119 })
120
121 __END_DECLS
122
123 #endif /* PARLIB_UTHREAD_H */