Atomic PCI-space accesses
[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 #ifndef ROS_KERN_PROCESS_H
9 #define ROS_KERN_PROCESS_H
10
11 #include <ros/common.h>
12 #include <ros/event.h>
13 #include <trap.h>
14 #include <atomic.h>
15 #include <kref.h>
16 #include <schedule.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.
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 its 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 /* Can use a htable iterator to iterate through all active procs */
56 extern struct hashtable *pid_hash;
57 extern spinlock_t pid_hash_lock;
58
59 /* Initialization */
60 void proc_init(void);
61
62 /* Process management: */
63 struct proc *pid_nth(unsigned int n);
64 error_t proc_alloc(struct proc **pp, struct proc *parent);
65 void __proc_ready(struct proc *p);
66 struct proc *proc_create(struct file *prog, char **argv, char **envp);
67 int __proc_set_state(struct proc *p, uint32_t state) WRITES(p->state);
68 struct proc *pid2proc(pid_t pid);
69 bool proc_controls(struct proc *SAFE actor, struct proc *SAFE target);
70 void proc_incref(struct proc *p, unsigned int val);
71 void proc_decref(struct proc *p);
72 void proc_run_s(struct proc *p);
73 void __proc_run_m(struct proc *p);
74 void __proc_startcore(struct proc *p, struct user_context *ctx);
75 void proc_restartcore(void);
76 void proc_destroy(struct proc *p);
77 void proc_signal_parent(struct proc *child);
78 int __proc_disown_child(struct proc *parent, struct proc *child);
79 int proc_change_to_m(struct proc *p);
80 void __proc_save_fpu_s(struct proc *p);
81 void __proc_save_context_s(struct proc *p, struct user_context *ctx);
82 void proc_yield(struct proc *SAFE p, bool being_nice);
83 void proc_notify(struct proc *p, uint32_t vcoreid);
84 void proc_wakeup(struct proc *p);
85 bool __proc_is_mcp(struct proc *p);
86 int proc_change_to_vcore(struct proc *p, uint32_t new_vcoreid,
87                          bool enable_my_notif);
88
89 /* Vcoremap info: */
90 uint32_t proc_get_vcoreid(struct proc *p);
91 /* TODO: make all of these inline once we gut the Env crap */
92 bool vcore_is_mapped(struct proc *p, uint32_t vcoreid);
93 uint32_t vcore2vcoreid(struct proc *p, struct vcore *vc);
94 struct vcore *vcoreid2vcore(struct proc *p, uint32_t vcoreid);
95
96 /* Process core management.  Only call these if you are RUNNING_M or RUNNABLE_M.
97  * These all adjust the vcoremap and take appropriate actions (like __startcore
98  * if you were already RUNNING_M.  You could be RUNNABLE_M with no vcores when
99  * these are done (basically preempted, and waiting to get run again).
100  *
101  * These are internal functions.  Error checking is to catch bugs, and you
102  * shouldn't call these functions with parameters you are not sure about (like
103  * an invalid corelist).  
104  *
105  * WARNING: YOU MUST HOLD THE PROC_LOCK BEFORE CALLING THESE! */
106 /* Gives process p the additional num cores listed in corelist */
107 int __proc_give_cores(struct proc *p, uint32_t *pc_arr, uint32_t num);
108 /* Takes from process p the num cores listed in pc_arr */
109 void __proc_take_corelist(struct proc *p, uint32_t *pc_arr, uint32_t num,
110                           bool preempt);
111 /* Takes all cores, returns the count, fills in pc_arr with their pcoreid */
112 uint32_t __proc_take_allcores(struct proc *p, uint32_t *pc_arr, bool preempt);
113
114 /* Exposed for kern/src/resource.c for now */
115 void __map_vcore(struct proc *p, uint32_t vcoreid, uint32_t pcoreid);
116 void __unmap_vcore(struct proc *p, uint32_t vcoreid);
117
118 /* Preemption management.  Some of these will change */
119 void __proc_preempt_warn(struct proc *p, uint32_t vcoreid, uint64_t when);
120 void __proc_preempt_warnall(struct proc *p, uint64_t when);
121 void __proc_preempt_core(struct proc *p, uint32_t pcoreid);
122 uint32_t __proc_preempt_all(struct proc *p, uint32_t *pc_arr);
123 bool proc_preempt_core(struct proc *p, uint32_t pcoreid, uint64_t usec);
124 void proc_preempt_all(struct proc *p, uint64_t usec);
125
126 /* Current / cr3 / context management */
127 struct proc *switch_to(struct proc *new_p);
128 void switch_back(struct proc *new_p, struct proc *old_proc);
129 void abandon_core(void);
130 void clear_owning_proc(uint32_t coreid);
131 void proc_tlbshootdown(struct proc *p, uintptr_t start, uintptr_t end);
132
133 /* Kernel message handlers for process management */
134 void __startcore(uint32_t srcid, long a0, long a1, long a2);
135 void __set_curctx(uint32_t srcid, long a0, long a1, long a2);
136 void __notify(uint32_t srcid, long a0, long a1, long a2);
137 void __preempt(uint32_t srcid, long a0, long a1, long a2);
138 void __death(uint32_t srcid, long a0, long a1, long a2);
139 void __tlbshootdown(uint32_t srcid, long a0, long a1, long a2);
140
141 /* Arch Specific */
142 void proc_pop_ctx(struct user_context *ctx) __attribute__((noreturn));
143 void proc_init_ctx(struct user_context *ctx, uint32_t vcoreid, uintptr_t entryp,
144                    uintptr_t stack_top, uintptr_t tls_desc);
145 void proc_secure_ctx(struct user_context *ctx);
146 void __abandon_core(void);
147
148 /* Degubbing */
149 void print_allpids(void);
150 void print_proc_info(pid_t pid);
151
152 #endif /* !ROS_KERN_PROCESS_H */