Split headers up to reduce namespace pollution
[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 #include <atomic.h>
18
19 struct Env;
20 typedef struct Env env_t;
21
22 // TODO: clean this up.
23 struct Env {
24         TAILQ_ENTRY(Env) proc_link NOINIT;      // Free list link pointers
25         spinlock_t proc_lock;
26         trapframe_t env_tf;                                             // Saved registers
27         ancillary_state_t env_ancillary_state;  // State saved when descheduled
28         pid_t pid;
29         pid_t ppid;                 // Parent's PID
30         pid_t exitcode;                         // exit() param or main() return value
31         uint32_t state;                         // Status of the process
32         uint32_t env_refcnt;            // Reference count of kernel contexts using this
33         uint32_t env_flags;
34         uint32_t env_entry;
35         /* Virtual coremap: each index is the virtual core id, the contents at that
36          * index is the physical core_id() corresponding to the vcore.  -1 means it
37          * is unused */
38         int32_t vcoremap[MAX_NUM_CPUS];
39         uint32_t num_vcores;
40
41         /* Cache color map: bitmap of the cache colors currently allocated to this
42          * process */
43         uint8_t* cache_colors_map;
44         size_t next_cache_color;
45
46         /* Info about this process's resources (granted, desired) for each type. */
47         struct resource resources[MAX_NUM_RESOURCES];
48
49         /* Keeps track of this process's current memory allocation 
50      * (i.e. its heap pointer) */
51         void* heap_bottom;
52         void* heap_top;
53
54         // Address space
55         pde_t *COUNT(NPDENTRIES) env_pgdir;                     // Kernel virtual address of page dir
56         physaddr_t env_cr3;                     // Physical address of page dir
57 //      struct memregion_list memregions;
58
59         // Per process info and data pages
60         procinfo_t *SAFE env_procinfo;       // KVA of per-process shared info table (RO)
61         procdata_t *SAFE env_procdata;       // KVA of per-process shared data table (RW)
62         
63         // The backring pointers for processing asynchronous system calls from the user
64         // Note this is the actual backring, not a pointer to it somewhere else
65         syscall_back_ring_t syscallbackring;
66         
67         // The front ring pointers for pushing asynchronous system events out to the user
68         // Note this is the actual frontring, not a pointer to it somewhere else
69         sysevent_front_ring_t syseventfrontring;
70 };
71
72 /* Process Flags */
73 #define PROC_TRANSITION_TO_M                    0x0001
74
75 extern atomic_t num_envs;               // Number of envs
76
77 int             env_setup_vm(env_t *e);
78 void    env_push_ancillary_state(env_t* e);
79 void    env_pop_ancillary_state(env_t* e);
80 void    env_user_mem_free(env_t* e);
81 void    env_segment_alloc(env_t *e, void *SNT va, size_t len);
82 void    env_segment_free(env_t *e, void *SNT va, size_t len);
83 void    env_load_icode(env_t* e, env_t* binary_env, uint8_t *COUNT(size) binary, size_t size);
84
85 // The following three functions do not return
86 void    env_pop_tf(trapframe_t *tf) __attribute__((noreturn));
87
88
89 /* Helper handler for smp_call to dispatch jobs to other cores */
90 #ifdef __IVY__
91 void run_env_handler(trapframe_t *tf, env_t * data);
92 #else
93 void run_env_handler(trapframe_t *tf, void * data);
94 #endif
95
96 #endif // !ROS_KERN_ENV_H