Improved user binary loading
[akaros.git] / kern / include / env.h
1 /* See COPYRIGHT for copyright information. */
2
3 #ifndef ROS_KERN_ENV_H
4 #define ROS_KERN_ENV_H
5 /* Note that the old include/ros/env.h is merged into this file */
6
7 #include <ros/memlayout.h>
8 #include <ros/syscall.h>
9 #include <ros/sysevent.h>
10 #include <ros/error.h>
11 #include <ros/procdata.h>
12 #include <ros/resource.h>
13 #include <arch/trap.h>
14 #include <ros/common.h>
15 #include <arch/arch.h>
16 #include <sys/queue.h>
17
18 struct Env;
19 typedef struct Env env_t;
20
21 // An environment ID 'envid_t' has three parts:
22 //
23 // +1+---------------21-----------------+--------10--------+
24 // |0|          Uniqueifier             |   Environment    |
25 // | |                                  |      Index       |
26 // +------------------------------------+------------------+
27 //                                       \--- ENVX(eid) --/
28 //
29 // The environment index ENVX(eid) equals the environment's offset in the
30 // 'envs[]' array.  The uniqueifier distinguishes environments that were
31 // created at different times, but share the same environment index.
32 //
33 // All real environments are greater than 0 (so the sign bit is zero).
34 // envid_ts less than 0 signify errors.  The envid_t == 0 is special, and
35 // stands for the current environment.
36
37 typedef int32_t envid_t;
38
39 #define LOG2NENV                10
40 #define NENV                    (1 << LOG2NENV)
41 #define ENVX(envid)             ((envid) & (NENV - 1))
42
43 // TODO: clean this up.
44 struct Env {
45         TAILQ_ENTRY(Env) proc_link NOINIT;      // Free list link pointers
46         spinlock_t proc_lock;
47         trapframe_t env_tf;                                             // Saved registers
48         ancillary_state_t env_ancillary_state;  // State saved when descheduled
49         envid_t env_id;                         // Unique environment identifier
50         envid_t env_parent_id;          // env_id of this env's parent
51         uint32_t state;                         // Status of the process
52         uint32_t env_runs;                      // Number of times environment has run
53         uint32_t env_refcnt;            // Reference count of kernel contexts using this
54         uint32_t env_flags;
55         uint32_t env_entry;
56         /* Virtual coremap: each index is the virtual core id, the contents at that
57          * index is the physical core_id() corresponding to the vcore.  -1 means it
58          * is unused */
59         int32_t vcoremap[MAX_NUM_CPUS];
60         uint32_t num_vcores;
61
62         /* Cache color map: bitmap of the cache colors currently allocated to this
63          * process */
64         uint8_t* cache_colors_map;
65         size_t next_cache_color;
66
67         /* Info about this process's resources (granted, desired) for each type. */
68         struct resource resources[MAX_NUM_RESOURCES];
69
70         /* Keeps track of this process's current memory allocation 
71      * (i.e. its heap pointer) */
72         void* end_text_segment;
73         void* end_data_segment;
74
75         // Address space
76         pde_t *COUNT(NPDENTRIES) env_pgdir;                     // Kernel virtual address of page dir
77         physaddr_t env_cr3;                     // Physical address of page dir
78 //      struct memregion_list memregions;
79
80         // Per process info and data pages
81         procinfo_t *SAFE env_procinfo;       // KVA of per-process shared info table (RO)
82         procdata_t *SAFE env_procdata;       // KVA of per-process shared data table (RW)
83         
84         // The backring pointers for processing asynchronous system calls from the user
85         // Note this is the actual backring, not a pointer to it somewhere else
86         syscall_back_ring_t syscallbackring;
87         
88         // The front ring pointers for pushing asynchronous system events out to the user
89         // Note this is the actual frontring, not a pointer to it somewhere else
90         sysevent_front_ring_t syseventfrontring;
91 };
92
93 /* Process Flags */
94 // None yet
95
96 extern env_t *CT(NENV) RO envs;         // All environments
97 extern atomic_t num_envs;               // Number of envs
98 // TODO: consider moving this to struct per_cpu_info
99 extern env_t * (RO curenvs)[MAX_NUM_CPUS];
100
101 static inline env_t *
102 get_cpu_curenv() TRUSTED
103 {
104         return curenvs[core_id()];
105 }
106
107 static inline void
108 set_cpu_curenv(env_t *p) TRUSTED
109 {
110         curenvs[core_id()] = p;
111 }
112
113 void    env_init(void);
114 int             env_alloc(env_t *SAFE*SAFE e, envid_t parent_id);
115 void    env_push_ancillary_state(env_t* e);
116 void    env_pop_ancillary_state(env_t* e);
117 void    env_free(env_t *SAFE e);
118 void    env_user_mem_free(env_t* e);
119 void    env_segment_alloc(env_t *e, void *SNT va, size_t len);
120 void    env_segment_free(env_t *e, void *SNT va, size_t len);
121 env_t*  env_create();
122 void    env_load_icode(env_t* e, env_t* binary_env, uint8_t *COUNT(size) binary, size_t size);
123
124 /*
125  * Allows the kernel to figure out what process is running on its core.
126  * Can be used just like a pointer to a struct process.
127  */
128 #define current (get_cpu_curenv())
129 //#define current (curenvs[core_id()])
130
131 int     envid2env(envid_t envid, env_t **env_store, bool checkperm);
132 // The following three functions do not return
133 void    env_pop_tf(trapframe_t *tf) __attribute__((noreturn));
134
135
136 /* Helper handler for smp_call to dispatch jobs to other cores */
137 #ifdef __IVY__
138 void run_env_handler(trapframe_t *tf, env_t * data);
139 #else
140 void run_env_handler(trapframe_t *tf, void * data);
141 #endif
142
143 #endif // !ROS_KERN_ENV_H