pm: Add a stub for pm_destroy()
[akaros.git] / kern / include / process.h
1 /* Copyright (c) 2009, 2010 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * All things processes!  As we move away from the old envs to processes,
6  * we'll move things into here that are designed for multicore processes. */
7
8 #pragma once
9
10 #include <ros/common.h>
11 #include <ros/event.h>
12 #include <trap.h>
13 #include <atomic.h>
14 #include <kref.h>
15 #include <schedule.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.
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 its 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  * DYING vs. DYING_ABORT:
35  * - DYING is the initial stage when a process is dying, but before all of its
36  * syscalls should abort.  At this point, we start closing FDs and blocking
37  * certain new operations.
38  * - DYING_ABORT is after all FDs were closed and all outstanding syscalls are
39  * aborted.
40  */
41
42 #define PROC_CREATED                    0x01
43 #define PROC_RUNNABLE_S                 0x02
44 #define PROC_RUNNING_S                  0x04
45 #define PROC_WAITING                    0x08 // can split out to INT and UINT
46 #define PROC_DYING                              0x10
47 #define PROC_DYING_ABORT                0x20
48 #define PROC_RUNNABLE_M                 0x40
49 #define PROC_RUNNING_M                  0x80
50
51 #define procstate2str(state) ((state) == PROC_CREATED     ? "CREATED"     : \
52                               (state) == PROC_RUNNABLE_S  ? "RUNNABLE_S"  : \
53                               (state) == PROC_RUNNING_S   ? "RUNNING_S"   : \
54                               (state) == PROC_WAITING     ? "WAITING"     : \
55                               (state) == PROC_DYING       ? "DYING"       : \
56                               (state) == PROC_DYING_ABORT ? "DYING_ABORT" : \
57                               (state) == PROC_RUNNABLE_M  ? "RUNNABLE_M"  : \
58                               (state) == PROC_RUNNING_M   ? "RUNNING_M"   : \
59                                                             "UNKNOWN")
60
61 #define DEFAULT_PROGNAME ""
62
63 #include <env.h>
64
65 static bool proc_is_dying(struct proc *p)
66 {
67         return (p->state == PROC_DYING) || (p->state == PROC_DYING_ABORT);
68 }
69
70 struct process_set {
71         size_t num_processes;
72         size_t size;
73         struct proc **procs;
74 };
75
76 /* Can use a htable iterator to iterate through all active procs */
77 extern struct hashtable *pid_hash;
78 extern spinlock_t pid_hash_lock;
79
80 /* Initialization */
81 void proc_init(void);
82 void proc_set_username(struct proc *p, char *name);
83 void proc_inherit_parent_username(struct proc *child, struct proc *parent);
84 void proc_set_progname(struct proc *p, char *name);
85 void proc_replace_binary_path(struct proc *p, char *path);
86 void proc_init_procinfo(struct proc* p);
87 void proc_init_procdata(struct proc* p);
88
89 /* Process management: */
90 struct proc *pid_nth(unsigned int n);
91 error_t proc_alloc(struct proc **pp, struct proc *parent, int flags);
92 void __proc_ready(struct proc *p);
93 struct proc *proc_create(struct file_or_chan *prog, char **argv, char **envp);
94 int __proc_set_state(struct proc *p, uint32_t state);
95 struct proc *pid2proc(pid_t pid);
96 bool proc_controls(struct proc *actor, struct proc *target);
97 void proc_incref(struct proc *p, unsigned int val);
98 void proc_decref(struct proc *p);
99 void proc_run_s(struct proc *p);
100 void __proc_run_m(struct proc *p);
101 void __proc_startcore(struct proc *p, struct user_context *ctx);
102 void proc_restartcore(void);
103 void proc_destroy(struct proc *p);
104 void proc_signal_parent(struct proc *child);
105 int __proc_disown_child(struct proc *parent, struct proc *child);
106 int proc_change_to_m(struct proc *p);
107 void __proc_save_fpu_s(struct proc *p);
108 void __proc_save_context_s(struct proc *p);
109 void proc_yield(struct proc *p, bool being_nice);
110 void proc_notify(struct proc *p, uint32_t vcoreid);
111 void proc_wakeup(struct proc *p);
112 bool __proc_is_mcp(struct proc *p);
113 bool proc_is_vcctx_ready(struct proc *p);
114 int proc_change_to_vcore(struct proc *p, uint32_t new_vcoreid,
115                          bool enable_my_notif);
116 void proc_get_set(struct process_set *pset);
117 void proc_free_set(struct process_set *pset);
118
119 /* Vcoremap info: */
120 uint32_t proc_get_vcoreid(struct proc *p);
121 /* TODO: make all of these inline once we gut the Env crap */
122 bool vcore_is_mapped(struct proc *p, uint32_t vcoreid);
123 uint32_t vcore2vcoreid(struct proc *p, struct vcore *vc);
124 struct vcore *vcoreid2vcore(struct proc *p, uint32_t vcoreid);
125
126 /* Process core management.  Only call these if you are RUNNING_M or RUNNABLE_M.
127  * These all adjust the vcoremap and take appropriate actions (like __startcore
128  * if you were already RUNNING_M.  You could be RUNNABLE_M with no vcores when
129  * these are done (basically preempted, and waiting to get run again).
130  *
131  * These are internal functions.  Error checking is to catch bugs, and you
132  * shouldn't call these functions with parameters you are not sure about (like
133  * an invalid corelist).
134  *
135  * WARNING: YOU MUST HOLD THE PROC_LOCK BEFORE CALLING THESE! */
136 /* Gives process p the additional num cores listed in corelist */
137 int __proc_give_cores(struct proc *p, uint32_t *pc_arr, uint32_t num);
138 /* Takes from process p the num cores listed in pc_arr */
139 void __proc_take_corelist(struct proc *p, uint32_t *pc_arr, uint32_t num,
140                           bool preempt);
141 /* Takes all cores, returns the count, fills in pc_arr with their pcoreid */
142 uint32_t __proc_take_allcores(struct proc *p, uint32_t *pc_arr, bool preempt);
143
144 /* Exposed for now for convenience */
145 void __map_vcore(struct proc *p, uint32_t vcoreid, uint32_t pcoreid);
146 void __unmap_vcore(struct proc *p, uint32_t vcoreid);
147 void vcore_account_online(struct proc *p, uint32_t vcoreid);
148 void vcore_account_offline(struct proc *p, uint32_t vcoreid);
149 uint64_t vcore_account_gettotal(struct proc *p, uint32_t vcoreid);
150
151 /* Preemption management.  Some of these will change */
152 void __proc_preempt_warn(struct proc *p, uint32_t vcoreid, uint64_t when);
153 void __proc_preempt_warnall(struct proc *p, uint64_t when);
154 void __proc_preempt_core(struct proc *p, uint32_t pcoreid);
155 uint32_t __proc_preempt_all(struct proc *p, uint32_t *pc_arr);
156 bool proc_preempt_core(struct proc *p, uint32_t pcoreid, uint64_t usec);
157 void proc_preempt_all(struct proc *p, uint64_t usec);
158
159 /* Current / cr3 / context management */
160 uintptr_t switch_to(struct proc *new_p);
161 void switch_back(struct proc *new_p, uintptr_t old_ret);
162 void abandon_core(void);
163 void clear_owning_proc(uint32_t coreid);
164 void proc_tlbshootdown(struct proc *p, uintptr_t start, uintptr_t end);
165
166 /* Kernel message handlers for process management */
167 void __startcore(uint32_t srcid, long a0, long a1, long a2);
168 void __set_curctx(uint32_t srcid, long a0, long a1, long a2);
169 void __notify(uint32_t srcid, long a0, long a1, long a2);
170 void __preempt(uint32_t srcid, long a0, long a1, long a2);
171 void __death(uint32_t srcid, long a0, long a1, long a2);
172 void __tlbshootdown(uint32_t srcid, long a0, long a1, long a2);
173
174 /* Arch Specific */
175 void proc_pop_ctx(struct user_context *ctx) __attribute__((noreturn));
176 void proc_init_ctx(struct user_context *ctx, uint32_t vcoreid, uintptr_t entryp,
177                    uintptr_t stack_top, uintptr_t tls_desc);
178 void proc_secure_ctx(struct user_context *ctx);
179 void __abandon_core(void);
180 void __clear_owning_proc(uint32_t coreid);
181
182 /* Degubbing */
183 void print_allpids(void);
184 void print_proc_info(pid_t pid, int verbosity);