Reworked the user VM map and added sysevent queue
[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 <arch/types.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         LIST_ENTRY(Env) env_link NOINIT;        // Free list link pointers
45         uint32_t 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
57         // Address space
58         pde_t *COUNT(NPDENTRIES) env_pgdir;                     // Kernel virtual address of page dir
59         physaddr_t env_cr3;                     // Physical address of page dir
60
61         // Per process info and data pages
62         procinfo_t *SAFE env_procinfo;       // KVA of per-process shared info table (RO)
63         procdata_t *SAFE env_procdata;       // KVA of per-process shared data table (RW)
64         
65         // The backring pointers for processing asynchronous system calls from the user
66         // Note this is the actual backring, not a pointer to it somewhere else
67         syscall_back_ring_t syscallbackring;
68         
69         // The front ring pointers for pushing asynchronous system events out to the user
70         // Note this is the actual frontring, not a pointer to it somewhere else
71         sysevent_front_ring_t syseventfrontring;
72 };
73
74 /* Process Flags */
75 // None yet
76
77 extern env_t *COUNT(NENV) envs;         // All environments
78 extern atomic_t num_envs;               // Number of envs
79 extern env_t* NORACE curenvs[MAX_NUM_CPUS];
80
81 LIST_HEAD(env_list, Env);               // Declares 'struct env_list'
82 typedef struct env_list env_list_t;
83
84 void    env_init(void);
85 int             env_alloc(env_t *SAFE*SAFE e, envid_t parent_id);
86 void    env_init_trapframe(env_t* e);
87 void    env_set_program_counter(env_t* e, uintptr_t pc);
88 void    env_push_ancillary_state(env_t* e);
89 void    env_pop_ancillary_state(env_t* e);
90 void    env_free(env_t *SAFE e);
91 void    env_user_mem_free(env_t* e);
92 error_t env_incref(env_t* e);
93 void    env_decref(env_t *SAFE e);
94 env_t*  env_create(uint8_t *COUNT(size) binary, size_t size);
95 void    (IN_HANDLER env_destroy)(env_t *SAFE e);        // Does not return if e == curenv
96 // Temporary scheduler function
97 void    schedule(void);
98
99 /*
100  * Allows the kernel to figure out what process is running on its core.
101  * Can be used just like a pointer to a struct process.
102  */
103 #define current (curenvs[core_id()])
104
105 int     envid2env(envid_t envid, env_t **env_store, bool checkperm);
106 // The following three functions do not return
107 void    (IN_HANDLER env_run)(env_t *e) __attribute__((noreturn));
108 void    env_pop_tf(trapframe_t *tf) __attribute__((noreturn));
109
110
111 /* Helper handler for smp_call to dispatch jobs to other cores */
112 void run_env_handler(trapframe_t *tf, void* data);
113
114 // TODO remove this legacy crap
115 #define ENV_CREATE(x)                   ({                                             \
116         extern uint8_t _binary_obj_user_apps_##x##_start[],                        \
117                 _binary_obj_user_apps_##x##_size[];                                    \
118         env_t *e = env_create(_binary_obj_user_apps_##x##_start,                   \
119                 (int)_binary_obj_user_apps_##x##_size);                                \
120         proc_set_state(e, PROC_RUNNABLE_S);                                        \
121         e;                                                                         \
122 })
123
124 #endif // !ROS_KERN_ENV_H