qio: Remove qconsume()
[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
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 #define DEFAULT_PROGNAME ""
53
54 #include <env.h>
55
56 struct process_set {
57         size_t num_processes;
58         size_t size;
59         struct proc **procs;
60 };
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 /* Initialization */
67 void proc_init(void);
68 void proc_set_progname(struct proc *p, char *name);
69 void proc_replace_binary_path(struct proc *p, char *path);
70 void proc_init_procinfo(struct proc* p);
71 void proc_init_procdata(struct proc* p);
72
73 /* Process management: */
74 struct proc *pid_nth(unsigned int n);
75 error_t proc_alloc(struct proc **pp, struct proc *parent, int flags);
76 void __proc_ready(struct proc *p);
77 struct proc *proc_create(struct file *prog, char **argv, char **envp);
78 int __proc_set_state(struct proc *p, uint32_t state);
79 struct proc *pid2proc(pid_t pid);
80 bool proc_controls(struct proc *actor, struct proc *target);
81 void proc_incref(struct proc *p, unsigned int val);
82 void proc_decref(struct proc *p);
83 void proc_run_s(struct proc *p);
84 void __proc_run_m(struct proc *p);
85 void __proc_startcore(struct proc *p, struct user_context *ctx);
86 void proc_restartcore(void);
87 void proc_destroy(struct proc *p);
88 void proc_signal_parent(struct proc *child);
89 int __proc_disown_child(struct proc *parent, struct proc *child);
90 int proc_change_to_m(struct proc *p);
91 void __proc_save_fpu_s(struct proc *p);
92 void __proc_save_context_s(struct proc *p);
93 void proc_yield(struct proc *p, bool being_nice);
94 void proc_notify(struct proc *p, uint32_t vcoreid);
95 void proc_wakeup(struct proc *p);
96 bool __proc_is_mcp(struct proc *p);
97 bool proc_is_vcctx_ready(struct proc *p);
98 int proc_change_to_vcore(struct proc *p, uint32_t new_vcoreid,
99                          bool enable_my_notif);
100 void proc_get_set(struct process_set *pset);
101 void proc_free_set(struct process_set *pset);
102
103 /* Vcoremap info: */
104 uint32_t proc_get_vcoreid(struct proc *p);
105 /* TODO: make all of these inline once we gut the Env crap */
106 bool vcore_is_mapped(struct proc *p, uint32_t vcoreid);
107 uint32_t vcore2vcoreid(struct proc *p, struct vcore *vc);
108 struct vcore *vcoreid2vcore(struct proc *p, uint32_t vcoreid);
109
110 /* Process core management.  Only call these if you are RUNNING_M or RUNNABLE_M.
111  * These all adjust the vcoremap and take appropriate actions (like __startcore
112  * if you were already RUNNING_M.  You could be RUNNABLE_M with no vcores when
113  * these are done (basically preempted, and waiting to get run again).
114  *
115  * These are internal functions.  Error checking is to catch bugs, and you
116  * shouldn't call these functions with parameters you are not sure about (like
117  * an invalid corelist).  
118  *
119  * WARNING: YOU MUST HOLD THE PROC_LOCK BEFORE CALLING THESE! */
120 /* Gives process p the additional num cores listed in corelist */
121 int __proc_give_cores(struct proc *p, uint32_t *pc_arr, uint32_t num);
122 /* Takes from process p the num cores listed in pc_arr */
123 void __proc_take_corelist(struct proc *p, uint32_t *pc_arr, uint32_t num,
124                           bool preempt);
125 /* Takes all cores, returns the count, fills in pc_arr with their pcoreid */
126 uint32_t __proc_take_allcores(struct proc *p, uint32_t *pc_arr, bool preempt);
127
128 /* Exposed for now for convenience */
129 void __map_vcore(struct proc *p, uint32_t vcoreid, uint32_t pcoreid);
130 void __unmap_vcore(struct proc *p, uint32_t vcoreid);
131 void vcore_account_online(struct proc *p, uint32_t vcoreid);
132 void vcore_account_offline(struct proc *p, uint32_t vcoreid);
133 uint64_t vcore_account_gettotal(struct proc *p, uint32_t vcoreid);
134
135 /* Preemption management.  Some of these will change */
136 void __proc_preempt_warn(struct proc *p, uint32_t vcoreid, uint64_t when);
137 void __proc_preempt_warnall(struct proc *p, uint64_t when);
138 void __proc_preempt_core(struct proc *p, uint32_t pcoreid);
139 uint32_t __proc_preempt_all(struct proc *p, uint32_t *pc_arr);
140 bool proc_preempt_core(struct proc *p, uint32_t pcoreid, uint64_t usec);
141 void proc_preempt_all(struct proc *p, uint64_t usec);
142
143 /* Current / cr3 / context management */
144 uintptr_t switch_to(struct proc *new_p);
145 void switch_back(struct proc *new_p, uintptr_t old_ret);
146 void abandon_core(void);
147 void clear_owning_proc(uint32_t coreid);
148 void proc_tlbshootdown(struct proc *p, uintptr_t start, uintptr_t end);
149
150 /* Kernel message handlers for process management */
151 void __startcore(uint32_t srcid, long a0, long a1, long a2);
152 void __set_curctx(uint32_t srcid, long a0, long a1, long a2);
153 void __notify(uint32_t srcid, long a0, long a1, long a2);
154 void __preempt(uint32_t srcid, long a0, long a1, long a2);
155 void __death(uint32_t srcid, long a0, long a1, long a2);
156 void __tlbshootdown(uint32_t srcid, long a0, long a1, long a2);
157
158 /* Arch Specific */
159 void proc_pop_ctx(struct user_context *ctx) __attribute__((noreturn));
160 void proc_init_ctx(struct user_context *ctx, uint32_t vcoreid, uintptr_t entryp,
161                    uintptr_t stack_top, uintptr_t tls_desc);
162 void proc_secure_ctx(struct user_context *ctx);
163 void __abandon_core(void);
164
165 /* Degubbing */
166 void print_allpids(void);
167 void print_proc_info(pid_t pid);