uthread yield and exit code merged
[akaros.git] / user / parlib / include / uthread.h
1 #ifndef _UTHREAD_H
2 #define _UTHREAD_H
3
4 #include <vcore.h>
5
6 #define UTHREAD_DONT_MIGRATE            0x001 /* don't move to another vcore */
7 #define UTHREAD_DYING                           0x002 /* uthread is exiting */
8
9 /* Bare necessities of a user thread.  2LSs should allocate a bigger struct and
10  * cast their threads to uthreads when talking with vcore code.  Vcore/default
11  * 2LS code won't touch udata or beyond. */
12 struct uthread {
13         struct user_trapframe utf;
14         struct ancillary_state as;
15         void *tls_desc;
16         int flags;
17 };
18 extern __thread struct uthread *current_uthread;
19
20 /* 2L-Scheduler operations.  Can be 0.  Examples in pthread.c. */
21 struct schedule_ops {
22         /* Functions supporting thread ops */
23         struct uthread *(*sched_init)(void);
24         void (*sched_entry)(void);
25         struct uthread *(*thread_create)(void (*func)(void), void *);
26         void (*thread_runnable)(struct uthread *);
27         void (*thread_yield)(struct uthread *);
28         void (*thread_exit)(struct uthread *);
29         void (*thread_blockon_sysc)(struct syscall *);
30         unsigned int (*vcores_wanted)(void);
31         /* Functions event handling wants */
32         void (*preempt_pending)(void);
33         void (*spawn_thread)(uintptr_t pc_start, void *data);   /* don't run yet */
34 };
35 extern struct schedule_ops *sched_ops;
36
37 /* Functions to make/manage uthreads.  Can be called by functions such as
38  * pthread_create(), which can wrap these with their own stuff (like attrs,
39  * retvals, etc). */
40
41 /* Creates a uthread.  Will pass udata to sched_ops's thread_create.  Func is
42  * what gets run, and if you want args, wrap it (like pthread) */
43 struct uthread *uthread_create(void (*func)(void), void *udata);
44 void uthread_runnable(struct uthread *uthread);
45 void uthread_yield(void);
46 void uthread_exit(void);
47 /* Block the calling uthread on sysc until it makes progress or is done */
48 void ros_syscall_blockon(struct syscall *sysc);
49
50 /* Utility function.  Event code also calls this. */
51 bool check_preempt_pending(uint32_t vcoreid);
52
53 /* Helpers, which sched_entry() can call */
54 void run_current_uthread(void);
55 void run_uthread(struct uthread *uthread);
56
57 #endif /* _UTHREAD_H */