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