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