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