Split env_run into proc_startcore, early work
[akaros.git] / 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/trap.h>
8 #include <ros/memlayout.h>
9 #include <ros/syscall.h>
10 #include <ros/error.h>
11 #include <arch/types.h>
12 #include <arch/x86.h>
13 #include <sys/queue.h>
14
15 struct Env;
16 typedef struct Env env_t;
17
18 typedef int32_t envid_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 #define LOG2NENV                10
37 #define NENV                    (1 << LOG2NENV)
38 #define ENVX(envid)             ((envid) & (NENV - 1))
39
40 struct Env {
41         LIST_ENTRY(Env) env_link NOINIT;        // Free list link pointers
42         uint32_t lock;
43         trapframe_t env_tf;                     // Saved registers
44         envid_t env_id;                         // Unique environment identifier
45         envid_t env_parent_id;          // env_id of this env's parent
46         uint32_t state;                         // Status of the process
47         uint32_t env_runs;                      // Number of times environment has run
48         uint32_t env_refcnt;            // Reference count of kernel contexts using this
49         uint32_t env_flags;
50         // Note this is the actual backring, not a pointer to it somewhere else
51         syscall_back_ring_t env_sysbackring;    // BackRing for generic syscalls
52
53         // Address space
54         pde_t *COUNT(NPDENTRIES) env_pgdir;                     // Kernel virtual address of page dir
55         physaddr_t env_cr3;                     // Physical address of page dir
56         // TODO - give these two proper types (pointers to structs)
57         // TODO - not always going to be PGSIZE either!
58         void*COUNT(PGSIZE) env_procinfo;                // KVA of per-process shared info table (RO)
59         void*COUNT(PGSIZE) env_procdata;                // KVA of per-process shared data table (RW)
60         // Eventually want to move this to a per-system shared-info page
61         uint64_t env_tscfreq;           // Frequency of the TSC for measurements
62 };
63
64 /* Process Flags */
65 // None yet
66
67 extern env_t *COUNT(NENV) envs;         // All environments
68 extern uint32_t num_envs;               // Number of envs
69 extern env_t* NORACE curenvs[MAX_NUM_CPUS];
70
71 LIST_HEAD(env_list, Env);               // Declares 'struct env_list'
72 typedef struct env_list env_list_t;
73
74 void    env_init(void);
75 int             env_alloc(env_t *SAFE*SAFE e, envid_t parent_id);
76 void    env_free(env_t *SAFE e);
77 error_t env_incref(env_t* e);
78 void    env_decref(env_t *SAFE e);
79 env_t*  env_create(uint8_t *COUNT(size) binary, size_t size);
80 void    (IN_HANDLER env_destroy)(env_t *SAFE e);        // Does not return if e == curenv
81 // Temporary scheduler function
82 void    schedule(void);
83
84 /*
85  * Allows the kernel to figure out what process is running on its core.
86  * Can be used just like a pointer to a struct process.
87  */
88 #define current (curenvs[coreid()])
89
90 int     envid2env(envid_t envid, env_t **env_store, bool checkperm);
91 // The following three functions do not return
92 void    (IN_HANDLER env_run)(env_t *e) __attribute__((noreturn));
93 void    env_pop_tf(trapframe_t *tf) __attribute__((noreturn));
94 void    env_pop_tf_sysexit(trapframe_t *tf) __attribute__((noreturn));
95
96
97 /* Helper handler for smp_call to dispatch jobs to other cores */
98 void run_env_handler(trapframe_t *tf, void* data);
99
100 // TODO remove this legacy crap
101 #define ENV_CREATE(x)                   ({                                             \
102         extern uint8_t _binary_obj_user_apps_##x##_start[],                        \
103                 _binary_obj_user_apps_##x##_size[];                                    \
104         env_t *e = env_create(_binary_obj_user_apps_##x##_start,                   \
105                 (int)_binary_obj_user_apps_##x##_size);                                \
106         proc_set_state(e, PROC_RUNNABLE_S);                                        \
107         e;                                                                         \
108 })
109
110 #endif // !ROS_KERN_ENV_H