Moved Ivy lock tracking into per cpu info
[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 struct Env {
44         TAILQ_ENTRY(Env) proc_link NOINIT;      // Free list link pointers
45         spinlock_t proc_lock;
46         trapframe_t env_tf                                              // Saved registers
47           __attribute__((aligned (8)));                 // for sparc --asw
48         ancillary_state_t env_ancillary_state   // State saved when descheduled
49           __attribute__((aligned (8)));                 // for sparc --asw
50         envid_t env_id;                         // Unique environment identifier
51         envid_t env_parent_id;          // env_id of this env's parent
52         uint32_t state;                         // Status of the process
53         uint32_t env_runs;                      // Number of times environment has run
54         uint32_t env_refcnt;            // Reference count of kernel contexts using this
55         uint32_t env_flags;
56         uint32_t env_entry;
57         /* Virtual coremap: each index is the virtual core id, the contents at that
58          * index is the physical core_id() corresponding to the vcore. */
59         uint32_t vcoremap[MAX_NUM_CPUS];
60         uint32_t num_vcores;
61
62         // Address space
63         pde_t *COUNT(NPDENTRIES) env_pgdir;                     // Kernel virtual address of page dir
64         physaddr_t env_cr3;                     // Physical address of page dir
65 //      struct memregion_list memregions;
66
67         // Per process info and data pages
68         procinfo_t *SAFE env_procinfo;       // KVA of per-process shared info table (RO)
69         procdata_t *SAFE env_procdata;       // KVA of per-process shared data table (RW)
70         
71         // The backring pointers for processing asynchronous system calls from the user
72         // Note this is the actual backring, not a pointer to it somewhere else
73         syscall_back_ring_t syscallbackring;
74         
75         // The front ring pointers for pushing asynchronous system events out to the user
76         // Note this is the actual frontring, not a pointer to it somewhere else
77         sysevent_front_ring_t syseventfrontring;
78 };
79
80 /* Process Flags */
81 // None yet
82
83 extern env_t *CT(NENV) RO envs;         // All environments
84 extern atomic_t num_envs;               // Number of envs
85 // TODO: consider moving this to struct per_cpu_info
86 extern env_t * (RO curenvs)[MAX_NUM_CPUS];
87
88 static inline env_t *
89 get_cpu_curenv() TRUSTED
90 {
91         return curenvs[core_id()];
92 }
93
94 static inline void
95 set_cpu_curenv(env_t *p) TRUSTED
96 {
97         curenvs[core_id()] = p;
98 }
99
100 void    env_init(void);
101 int             env_alloc(env_t *SAFE*SAFE e, envid_t parent_id);
102 void    env_push_ancillary_state(env_t* e);
103 void    env_pop_ancillary_state(env_t* e);
104 void    env_free(env_t *SAFE e);
105 void    env_user_mem_free(env_t* e);
106 env_t*  env_create(uint8_t *COUNT(size) binary, size_t size);
107
108 /*
109  * Allows the kernel to figure out what process is running on its core.
110  * Can be used just like a pointer to a struct process.
111  */
112 #define current (get_cpu_curenv())
113 //#define current (curenvs[core_id()])
114
115 int     envid2env(envid_t envid, env_t **env_store, bool checkperm);
116 // The following three functions do not return
117 void    env_pop_tf(trapframe_t *tf) __attribute__((noreturn));
118
119
120 /* Helper handler for smp_call to dispatch jobs to other cores */
121 #ifdef __IVY__
122 void run_env_handler(trapframe_t *tf, env_t * data);
123 #else
124 void run_env_handler(trapframe_t *tf, void * data);
125 #endif
126
127 #endif // !ROS_KERN_ENV_H