Support for blocking and restarting uthreads (XCC)
[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_DYING                           0x002 /* uthread is exiting */
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         struct uthread *(*sched_init)(void);
34         void (*sched_entry)(void);
35         struct uthread *(*thread_create)(void (*func)(void), void *);
36         void (*thread_runnable)(struct uthread *);
37         void (*thread_yield)(struct uthread *);
38         void (*thread_exit)(struct uthread *);
39         void (*thread_blockon_sysc)(struct syscall *);
40         unsigned int (*vcores_wanted)(void);
41         /* Functions event handling wants */
42         void (*preempt_pending)(void);
43         void (*spawn_thread)(uintptr_t pc_start, void *data);   /* don't run yet */
44 };
45 extern struct schedule_ops *sched_ops;
46
47 /* Functions to make/manage uthreads.  Can be called by functions such as
48  * pthread_create(), which can wrap these with their own stuff (like attrs,
49  * retvals, etc). */
50
51 /* Creates a uthread.  Will pass udata to sched_ops's thread_create.  Func is
52  * what gets run, and if you want args, wrap it (like pthread) */
53 struct uthread *uthread_create(void (*func)(void), void *udata);
54 void uthread_runnable(struct uthread *uthread);
55 void uthread_yield(void);
56 void uthread_exit(void);
57 /* Block the calling uthread on sysc until it makes progress or is done */
58 void ros_syscall_blockon(struct syscall *sysc);
59
60 /* Utility function.  Event code also calls this. */
61 bool check_preempt_pending(uint32_t vcoreid);
62 bool register_evq(struct syscall *sysc, struct event_queue *ev_q);
63
64 /* Helpers, which sched_entry() can call */
65 void run_current_uthread(void);
66 void run_uthread(struct uthread *uthread);
67
68 #endif /* _UTHREAD_H */