Cosmetic changes, biggest being current_thread renamed to current_uthread
[akaros.git] / user / parlib / include / vcore.h
1 #ifndef _VCORE_H
2 #define _VCORE_H
3
4 #ifdef __cplusplus
5 extern "C" {
6 #endif
7
8 #include <arch/vcore.h>
9 #include <sys/param.h>
10 #include <string.h>
11
12 /*****************************************************************************/
13 /* TODO: This is a complete hack, but necessary for vcore stuff to work for now
14  * The issue is that exit sometimes calls sys_yield(), and we can't recover from
15  * that properly under our vcore model (we shouldn't though).  We really need to
16  * rethink what sys_yield 'should' do when in multicore mode, or else come up 
17  * with a different syscall entirely. */
18 #include <stdlib.h>
19 #include <unistd.h>
20 #undef exit
21 #define exit(status) ros_syscall(SYS_proc_destroy, getpid(), status, 0, 0, 0, 0)
22 /*****************************************************************************/
23
24 #define LOG2_MAX_VCORES 6
25 #define MAX_VCORES (1 << LOG2_MAX_VCORES)
26
27 #define TRANSITION_STACK_PAGES 2
28 #define TRANSITION_STACK_SIZE (TRANSITION_STACK_PAGES*PGSIZE)
29
30 /* Defined by glibc; Must be implemented by a user level threading library */
31 extern void vcore_entry();
32 /* Declared in glibc's start.c */
33 extern __thread bool __vcore_context;
34
35 /* Utility Functions */
36 void *allocate_tls(void);
37 void free_tls(void *tcb);
38
39 /* Vcore API functions */
40 static inline size_t max_vcores(void);
41 static inline size_t num_vcores(void);
42 static inline int vcore_id(void);
43 static inline bool in_vcore_context(void);
44 static inline void enable_notifs(uint32_t vcoreid);
45 static inline void disable_notifs(uint32_t vcoreid);
46 int vcore_init(void);
47 int vcore_request(size_t k);
48 void vcore_yield(void);
49 bool check_preempt_pending(uint32_t vcoreid);
50 void clear_notif_pending(uint32_t vcoreid);
51
52 /* Bare necessities of a user thread.  2LSs should allocate a bigger struct and
53  * cast their threads to uthreads when talking with vcore code.  Vcore/default
54  * 2LS code won't touch udata or beyond. */
55 struct uthread {
56         struct user_trapframe utf;
57         struct ancillary_state as;
58         void *tls_desc;
59         /* whether or not the scheduler can migrate you from your vcore */
60         bool dont_migrate;
61 };
62 extern __thread struct uthread *current_uthread;
63
64 /* 2L-Scheduler operations.  Can be 0.  Examples in pthread.c. */
65 struct schedule_ops {
66         /* Functions supporting thread ops */
67         struct uthread *(*sched_init)(void);
68         void (*sched_entry)(void);
69         struct uthread *(*thread_create)(void (*func)(void), void *);
70         void (*thread_runnable)(struct uthread *);
71         void (*thread_yield)(struct uthread *);
72         void (*thread_exit)(struct uthread *);
73         /* Functions event handling wants */
74         void (*preempt_pending)(void);
75         void (*spawn_thread)(uintptr_t pc_start, void *data);   /* don't run yet */
76 };
77 extern struct schedule_ops *sched_ops;
78
79 /* Functions to make/manage uthreads.  Can be called by functions such as
80  * pthread_create(), which can wrap these with their own stuff (like attrs,
81  * retvals, etc). */
82
83 /* Creates a uthread.  Will pass udata to sched_ops's thread_create.  Func is
84  * what gets run, and if you want args, wrap it (like pthread) */
85 struct uthread *uthread_create(void (*func)(void), void *udata);
86 void uthread_runnable(struct uthread *uthread);
87 void uthread_yield(void);
88 void uthread_exit(void);
89
90 /* Helpers, which sched_entry() can call */
91 void run_current_uthread(void);
92 void run_uthread(struct uthread *uthread);
93
94 /* Static inlines */
95 static inline size_t max_vcores(void)
96 {
97         return MIN(__procinfo.max_vcores, MAX_VCORES);
98 }
99
100 static inline size_t num_vcores(void)
101 {
102         return __procinfo.num_vcores;
103 }
104
105 static inline int vcore_id(void)
106 {
107         return __vcoreid;
108 }
109
110 static inline bool in_vcore_context(void)
111 {
112         return __vcore_context;
113 }
114
115 static inline void enable_notifs(uint32_t vcoreid)
116 {
117         __procdata.vcore_preempt_data[vcoreid].notif_enabled = TRUE;
118 }
119
120 static inline void disable_notifs(uint32_t vcoreid)
121 {
122         __procdata.vcore_preempt_data[vcoreid].notif_enabled = FALSE;
123 }
124
125 #ifdef __cplusplus
126 }
127 #endif
128
129 #endif