Merge branch 'master' into proc-work
[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 <arch/trap.h>
12 #include <arch/types.h>
13 #include <arch/arch.h>
14 #include <sys/queue.h>
15
16 struct Env;
17 typedef struct Env env_t;
18
19 typedef int32_t envid_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 #define LOG2NENV                10
38 #define NENV                    (1 << LOG2NENV)
39 #define ENVX(envid)             ((envid) & (NENV - 1))
40
41 // TODO: clean this up.
42 struct Env {
43         LIST_ENTRY(Env) env_link NOINIT;        // Free list link pointers
44         uint32_t lock;
45         trapframe_t env_tf                                              // Saved registers
46           __attribute__((aligned (8)));                 // for sparc --asw
47         ancillary_state_t env_ancillary_state   // State saved when descheduled
48           __attribute__((aligned (8)));                 // for sparc --asw
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         // The backring for processing asynchronous system calls from the user
56         // Note this is the actual backring, not a pointer to it somewhere else
57         syscall_back_ring_t env_syscallbackring;
58         // The front ring for pushing asynchronous system events out to the user
59         // Note this is the actual frontring, not a pointer to it somewhere else
60         sysevent_front_ring_t env_syseventfrontring;
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
66         // TODO - give this a proper type (pointers to a struct)
67         // - not always going to be PGSIZE either!
68         void*COUNT(PGSIZE) env_procinfo;                // KVA of per-process shared info table (RO)
69         // TODO - do we really want to get rid of procdata?
70         //void*COUNT(PGSIZE) env_procdata;              // KVA of per-process shared data table (RW)
71         
72         // Do we need these and the above back/front rings?
73         // Ring buffers for communicating with user space
74         syscall_sring_t*SAFE env_syscallring;   // Per-process ring buffer for async syscalls
75         sysevent_sring_t*SAFE env_syseventring; // Per-process ring buffer for async sysevents
76 };
77
78 /* Process Flags */
79 // None yet
80
81 extern env_t *COUNT(NENV) envs;         // All environments
82 extern atomic_t num_envs;               // Number of envs
83 extern env_t* NORACE curenvs[MAX_NUM_CPUS];
84
85 LIST_HEAD(env_list, Env);               // Declares 'struct env_list'
86 typedef struct env_list env_list_t;
87
88 void    env_init(void);
89 int             env_alloc(env_t *SAFE*SAFE e, envid_t parent_id);
90 void    env_init_trapframe(env_t* e);
91 void    env_set_program_counter(env_t* e, uintptr_t pc);
92 void    env_push_ancillary_state(env_t* e);
93 void    env_pop_ancillary_state(env_t* e);
94 void    env_free(env_t *SAFE e);
95 void    env_user_mem_free(env_t* e);
96 error_t env_incref(env_t* e);
97 void    env_decref(env_t *SAFE e);
98 env_t*  env_create(uint8_t *COUNT(size) binary, size_t size);
99 void    (IN_HANDLER env_destroy)(env_t *SAFE e);        // Does not return if e == curenv
100 // Temporary scheduler function
101 void    schedule(void);
102
103 /*
104  * Allows the kernel to figure out what process is running on its core.
105  * Can be used just like a pointer to a struct process.
106  */
107 #define current (curenvs[core_id()])
108
109 int     envid2env(envid_t envid, env_t **env_store, bool checkperm);
110 // The following three functions do not return
111 void    (IN_HANDLER env_run)(env_t *e) __attribute__((noreturn));
112 void    env_pop_tf(trapframe_t *tf) __attribute__((noreturn));
113
114
115 /* Helper handler for smp_call to dispatch jobs to other cores */
116 void run_env_handler(trapframe_t *tf, void* data);
117
118 // TODO remove this legacy crap
119 #define ENV_CREATE(x)                   ({                                             \
120         extern uint8_t _binary_obj_user_apps_##x##_start[],                        \
121                 _binary_obj_user_apps_##x##_size[];                                    \
122         env_t *e = env_create(_binary_obj_user_apps_##x##_start,                   \
123                 (int)_binary_obj_user_apps_##x##_size);                                \
124         proc_set_state(e, PROC_RUNNABLE_S);                                        \
125         e;                                                                         \
126 })
127
128 #endif // !ROS_KERN_ENV_H