Moves retvals, start_routine, and args to the 2LSs
[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
38 /* Vcore API functions */
39 static inline size_t max_vcores(void);
40 static inline size_t num_vcores(void);
41 static inline int vcore_id(void);
42 static inline bool in_vcore_context(void);
43 static inline void enable_notifs(uint32_t vcoreid);
44 static inline void disable_notifs(uint32_t vcoreid);
45 int vcore_init(void);
46 int vcore_request(size_t k);
47 void vcore_yield(void);
48 bool check_preempt_pending(uint32_t vcoreid);
49 void clear_notif_pending(uint32_t vcoreid);
50
51 /* Bare necessities of a user thread.  2LSs should allocate a bigger struct and
52  * cast their threads to uthreads when talking with vcore code.  Vcore/default
53  * 2LS code won't touch udata or beyond. */
54 struct uthread {
55         struct user_trapframe utf;
56         struct ancillary_state as;
57         void *tls_desc;
58         /* whether or not the scheduler can migrate you from your vcore */
59         bool dont_migrate;
60 };
61 extern __thread struct uthread *current_thread;
62
63 /* 2L-Scheduler operations.  Can be 0.  Examples in pthread.c. */
64 struct schedule_ops {
65         /* Functions supporting thread ops */
66         struct uthread *(*sched_init)(void);
67         void (*sched_entry)(void);
68         struct uthread *(*thread_create)(void (*func)(void), void *);
69         void (*thread_runnable)(struct uthread *);
70         void (*thread_yield)(struct uthread *);
71         void (*thread_exit)(struct uthread *);
72         /* Functions event handling wants */
73         void (*preempt_pending)(void);
74         void (*spawn_thread)(uintptr_t pc_start, void *data);   /* don't run yet */
75 };
76 extern struct schedule_ops *sched_ops;
77
78 /* Functions to make/manage uthreads.  Can be called by functions such as
79  * pthread_create(), which can wrap these with their own stuff (like attrs,
80  * retvals, etc). */
81
82 /* Creates a uthread.  Will pass udata to sched_ops's thread_create.  Func is
83  * what gets run, and if you want args, wrap it (like pthread) */
84 struct uthread *uthread_create(void (*func)(void), void *udata);
85 void uthread_runnable(struct uthread *uthread);
86 void uthread_yield(void);
87 void uthread_exit(void);
88
89 /* Helpers, which sched_entry() can call */
90 void run_current_uthread(void);
91 void run_uthread(struct uthread *uthread);
92
93 /* Static inlines */
94 static inline size_t max_vcores(void)
95 {
96         return MIN(__procinfo.max_vcores, MAX_VCORES);
97 }
98
99 static inline size_t num_vcores(void)
100 {
101         return __procinfo.num_vcores;
102 }
103
104 static inline int vcore_id(void)
105 {
106         return __vcoreid;
107 }
108
109 static inline bool in_vcore_context(void)
110 {
111         return __vcore_context;
112 }
113
114 static inline void enable_notifs(uint32_t vcoreid)
115 {
116         __procdata.vcore_preempt_data[vcoreid].notif_enabled = TRUE;
117 }
118
119 static inline void disable_notifs(uint32_t vcoreid)
120 {
121         __procdata.vcore_preempt_data[vcoreid].notif_enabled = FALSE;
122 }
123
124 #ifdef __cplusplus
125 }
126 #endif
127
128 #endif