SYS_notify and SYS_self_notify
[akaros.git] / kern / include / process.h
1 /*
2  * Copyright (c) 2009 The Regents of the University of California
3  * Barret Rhoden <brho@cs.berkeley.edu>
4  * See LICENSE for details.
5  *
6  * All things processes!  As we move away from the old envs to processes,
7  * we'll move things into here that are designed for multicore processes.
8  */
9
10 #ifndef ROS_KERN_PROCESS_H
11 #define ROS_KERN_PROCESS_H
12
13 #include <ros/common.h>
14 #include <ros/notification.h>
15 #include <trap.h>
16 #include <atomic.h>
17
18 /* Process States.  Not 100% on the names yet.  RUNNABLE_* are waiting to go to
19  * RUNNING_*.  For instance, RUNNABLE_M is expecting to go to RUNNING_M.  It
20  * could be waiting for it's timeslice, or possibly for all the cores it asked
21  * for.  You use proc_run() to transition between these states.
22  *
23  * Difference between the _M and the _S states:
24  * - _S : legacy process mode
25  * - RUNNING_M implies *guaranteed* core(s).  You can be a single core in the
26  *   RUNNING_M state.  The guarantee is subject to time slicing, but when you
27  *   run, you get all of your cores.
28  * - The time slicing is at a coarser granularity for _M states.  This means
29  *   that when you run an _S on a core, it should be interrupted/time sliced
30  *   more often, which also means the core should be classified differently for
31  *   a while.  Possibly even using it's local APIC timer.
32  * - A process in an _M state will be informed about changes to its state, e.g.,
33  *   will have a handler run in the event of a page fault
34  */
35
36 #define PROC_CREATED                    0x01
37 #define PROC_RUNNABLE_S                 0x02
38 #define PROC_RUNNING_S                  0x04
39 #define PROC_WAITING                    0x08 // can split out to INT and UINT
40 #define PROC_DYING                              0x10
41 #define PROC_RUNNABLE_M                 0x20
42 #define PROC_RUNNING_M                  0x40
43
44 #define procstate2str(state) ((state)==PROC_CREATED    ? "CREATED   " : \
45                               (state)==PROC_RUNNABLE_S ? "RUNNABLE_S" : \
46                               (state)==PROC_RUNNING_S  ? "RUNNING_S " : \
47                               (state)==PROC_WAITING    ? "WAITING   " : \
48                               (state)==PROC_DYING      ? "DYING     " : \
49                               (state)==PROC_RUNNABLE_M ? "RUNNABLE_M" : \
50                               (state)==PROC_RUNNING_M  ? "RUNNING_M " : \
51                                                          "UNKNOWN   ")
52
53 #include <env.h>
54
55 // Till we remove the old struct Env
56 #define proc Env
57
58 TAILQ_HEAD(proc_list, proc);            // Declares 'struct proc_list'
59
60 extern spinlock_t runnablelist_lock;
61 extern struct proc_list LCKD(&runnablelist_lock) proc_runnablelist;
62
63 /* Can use a htable iterator to iterate through all active procs */
64 extern struct hashtable *pid_hash;
65 extern spinlock_t pid_hash_lock;
66
67 /* Idle cores: ones able to be exclusively given to a process (worker cores). */
68 extern spinlock_t idle_lock;  // never grab this before a proc_lock
69 extern uint32_t LCKD(&idle_lock) (RO idlecoremap)[MAX_NUM_CPUS];
70 extern uint32_t LCKD(&idle_lock) num_idlecores;
71
72 /* Initialization */
73 void proc_init(void);
74 void proc_init_procinfo(struct proc *p);
75
76 /* Process management: */
77 struct proc *proc_create(uint8_t *COUNT(size) binary, size_t size);
78 int __proc_set_state(struct proc *p, uint32_t state) WRITES(p->state);
79 struct proc *pid2proc(pid_t pid);
80 bool proc_controls(struct proc *SAFE actor, struct proc *SAFE target);
81 void proc_run(struct proc *SAFE p);
82 void proc_restartcore(struct proc *SAFE p, trapframe_t *SAFE tf);
83 void proc_destroy(struct proc *SAFE p);
84 void proc_yield(struct proc *SAFE p);
85 void do_notify(struct proc *p, uint32_t vcoreid, unsigned int notif,
86                struct notif_event *ne);
87 void proc_notify(struct proc *p, unsigned int notif, struct notif_event *ne);
88
89 /* Exposed for sys_getvcoreid(), til it's unnecessary */
90 uint32_t proc_get_vcoreid(struct proc *SAFE p, uint32_t pcoreid);
91
92 /* Process core management.  Only call these if you are RUNNING_M or RUNNABLE_M.
93  * These all adjust the vcoremap and take appropriate actions (like __startcore
94  * if you were already RUNNING_M.  You could be RUNNABLE_M with no vcores when
95  * these are done (basically preempted, and waiting to get run again).
96  *
97  * These are internal functions.  Error checking is to catch bugs, and you
98  * shouldn't call these functions with parameters you are not sure about (like
99  * an invalid corelist).  
100  *
101  * They also may cause an IPI to be sent to core it is called on.  If so, the
102  * return value will be true.  Once you unlock (and enable interrupts) you will
103  * be preempted, and usually lose your stack.  There is a helper to unlock and
104  * handle the refcnt.
105  *
106  * WARNING: YOU MUST HOLD THE PROC_LOCK BEFORE CALLING THESE! */
107 /* Gives process p the additional num cores listed in corelist */
108 bool __proc_give_cores(struct proc *SAFE p, uint32_t *pcorelist, size_t num);
109 /* Makes process p's coremap look like corelist (add, remove, etc). Not used */
110 bool __proc_set_allcores(struct proc *SAFE p, uint32_t *pcorelist,
111                          size_t *num, amr_t message, TV(a0t) arg0,
112                          TV(a1t) arg1, TV(a2t) arg2);
113 /* Takes from process p the num cores listed in corelist */
114 bool __proc_take_cores(struct proc *SAFE p, uint32_t *pcorelist,
115                        size_t num, amr_t message, TV(a0t) arg0,
116                        TV(a1t) arg1, TV(a2t) arg2);
117 bool __proc_take_allcores(struct proc *SAFE p, amr_t message, TV(a0t) arg0,
118                           TV(a1t) arg1, TV(a2t) arg2);
119 void __proc_unlock_ipi_pending(struct proc *p, bool ipi_pending);
120 /* Exposed for kern/src/resource.c for now */
121 void __map_vcore(struct proc *p, uint32_t vcoreid, uint32_t pcoreid);
122 void __unmap_vcore(struct proc *p, uint32_t vcoreid);
123
124 /* Will probably have generic versions of these later. */
125 void proc_incref(struct proc *SAFE p, size_t count);
126 void proc_decref(struct proc *SAFE p, size_t count);
127  
128 /* Allows the kernel to figure out what process is running on this core.  Can be
129  * used just like a pointer to a struct proc.  Need these to be macros due to
130  * some circular dependencies with smp.h. */
131 #include <smp.h>
132 #define current per_cpu_info[core_id()].cur_proc
133 #define set_current_proc(p) per_cpu_info[core_id()].cur_proc = (p)
134
135 /* Allows the kernel to figure out what tf is on this core's stack.  Can be used
136  * just like a pointer to a struct Trapframe.  Need these to be macros due to
137  * some circular dependencies with smp.h.  This is done here instead of
138  * elsewhere (like trap.h) for other elliptical reasons. */
139 #define current_tf per_cpu_info[core_id()].cur_tf
140 #define set_current_tf(tf) per_cpu_info[core_id()].cur_tf = (tf)
141
142 void abandon_core(void);
143
144 /* Kernel message handlers for process management */
145 #ifdef __IVY__
146 void __startcore(trapframe_t *tf, uint32_t srcid, struct proc *CT(1) a0,
147                  trapframe_t *CT(1) a1, void *SNT a2);
148 void __death(trapframe_t *tf, uint32_t srcid, void *SNT a0, void *SNT a1,
149              void *SNT a2);
150 #else
151 void __startcore(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2);
152 void __death(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2);
153 void __notify(trapframe_t *tf, uint32_t srcid, void *a0, void *a1, void *a2);
154 #endif
155
156 /* Arch Specific */
157 void proc_init_trapframe(trapframe_t *SAFE tf, uint32_t vcoreid,
158                          uint32_t entryp, uint32_t stack_top);
159 void proc_set_syscall_retval(trapframe_t *SAFE tf, intreg_t value);
160 void __abandon_core(void);
161
162 /* Degubbing */
163 void print_idlecoremap(void);
164 void print_allpids(void);
165 void print_proc_info(pid_t pid);
166
167 #endif // !ROS_KERN_PROCESS_H