Marked lock-required proc functions with __
[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 // TODO don't use this shit for process allocation flagging
43 #define ENV_FREE                                0x80
44
45 #include <env.h>
46
47 // Till we remove the old struct Env
48 #define proc Env
49
50 TAILQ_HEAD(proc_list, proc);            // Declares 'struct proc_list'
51
52 extern spinlock_t freelist_lock;
53 extern struct proc_list LCKD(&freelist_lock)proc_freelist;
54
55 extern spinlock_t runnablelist_lock;
56 extern struct proc_list LCKD(&runnablelist_lock) proc_runnablelist;
57
58 /* Idle cores: ones able to be exclusively given to a process (worker cores). */
59 extern spinlock_t idle_lock;  // never grab this before a proc_lock
60 extern uint32_t LCKD(&idle_lock) (RO idlecoremap)[MAX_NUM_CPUS];
61 extern uint32_t LCKD(&idle_lock) num_idlecores;
62
63 /* Process management: */
64 int __proc_set_state(struct proc *p, uint32_t state) WRITES(p->state);
65 struct proc *get_proc(unsigned pid);
66 bool proc_controls(struct proc *SAFE actor, struct proc *SAFE target);
67 /* Transition from RUNNABLE_* to RUNNING_*. */
68 void proc_run(struct proc *SAFE p);
69 void proc_startcore(struct proc *SAFE p, trapframe_t *SAFE tf)
70      __attribute__((noreturn));
71 void proc_destroy(struct proc *SAFE p);
72 void proc_yield(struct proc *SAFE p);
73
74 /* Process core management.  Only call these if you are RUNNING_M or RUNNABLE_M.
75  * These all adjust the vcoremap and take appropriate actions (like __startcore
76  * if you were already RUNNING_M.  You could be RUNNABLE_M with no vcores when
77  * these are done (basically preempted, and waiting to get run again).
78  * All of these could modify corelist and *num to communicate info back out,
79  * which would be the list of cores that are known to be free.
80  *
81  * WARNING: YOU MUST HOLD THE PROC_LOCK BEFORE CALLING THESE! */
82 /* Gives process p the additional num cores listed in corelist */
83 error_t __proc_give_cores(struct proc *SAFE p, uint32_t corelist[], size_t *num);
84 /* Makes process p's coremap look like corelist (add, remove, etc) */
85 error_t __proc_set_allcores(struct proc *SAFE p, uint32_t corelist[],
86                             size_t *num, amr_t message, TV(a0t) arg0,
87                             TV(a1t) arg1, TV(a2t) arg2);
88 /* Takes from process p the num cores listed in corelist */
89 error_t __proc_take_cores(struct proc *SAFE p, uint32_t corelist[],
90                           size_t *num, amr_t message, TV(a0t) arg0,
91                           TV(a1t) arg1, TV(a2t) arg2);
92 error_t __proc_take_allcores(struct proc *SAFE p, amr_t message, TV(a0t) arg0,
93                              TV(a1t) arg1, TV(a2t) arg2);
94
95 /* The reference counts are mostly to track how many cores loaded the cr3 */
96 error_t proc_incref(struct proc *SAFE p);
97 void proc_decref(struct proc *SAFE p);
98
99 /* Allows the kernel to figure out what process is running on this core.  Can be
100  * used just like a pointer to a struct proc.  Need these to be macros due to
101  * some circular dependencies with smp.h. */
102 #include <smp.h>
103 #define current per_cpu_info[core_id()].cur_proc
104 #define set_current_proc(p) per_cpu_info[core_id()].cur_proc = (p)
105
106 /* Allows the kernel to figure out what tf is on this core's stack.  Can be used
107  * just like a pointer to a struct Trapframe.  Need these to be macros due to
108  * some circular dependencies with smp.h.  This is done here instead of
109  * elsewhere (like trap.h) for other elliptical reasons. */
110 #define current_tf per_cpu_info[core_id()].cur_tf
111 #define set_current_tf(tf) per_cpu_info[core_id()].cur_tf = (tf)
112
113 void abandon_core(void);
114
115 /* Active message handlers for process management */
116 #ifdef __IVY__
117 void __startcore(trapframe_t *tf, uint32_t srcid, struct proc *CT(1) a0,
118                  trapframe_t *CT(1) a1, void *SNT a2);
119 void __death(trapframe_t *tf, uint32_t srcid, void *SNT a0, void *SNT a1,
120              void *SNT a2);
121 #else
122 void __startcore(trapframe_t *tf, uint32_t srcid, void * a0, void * a1,
123                  void * a2);
124 void __death(trapframe_t *tf, uint32_t srcid, void * a0, void * a1,
125              void * a2);
126 #endif
127
128 /* Arch Specific */
129 void proc_set_program_counter(trapframe_t *SAFE tf, uintptr_t pc);
130 void proc_init_trapframe(trapframe_t *SAFE tf);
131 void proc_set_tfcoreid(trapframe_t *SAFE tf, uint32_t id);
132 void proc_set_syscall_retval(trapframe_t *SAFE tf, intreg_t value);
133
134 /* Degubbing */
135 void print_idlecoremap(void);
136 void print_proc_info(pid_t pid);
137
138 #endif // !ROS_KERN_PROCESS_H