fb401ba90604ad7ab8796d5968688ccc6c7c0234
[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/procinfo.h>
11 #include <error.h>
12 #include <ros/procdata.h>
13 #include <ros/procinfo.h>
14 #include <ros/resource.h>
15 #include <arch/trap.h>
16 #include <ros/common.h>
17 #include <arch/arch.h>
18 #include <sys/queue.h>
19 #include <atomic.h>
20
21 struct Env;
22 typedef struct Env env_t;
23
24 // TODO: clean this up.
25 struct Env {
26         TAILQ_ENTRY(Env) proc_link NOINIT;      // Free list link pointers
27         spinlock_t proc_lock;
28         trapframe_t env_tf;                                             // Saved registers
29         ancillary_state_t env_ancillary_state;  // State saved when descheduled
30         pid_t pid;
31         pid_t ppid;                 // Parent's PID
32         pid_t exitcode;                         // exit() param or main() return value
33         uint32_t state;                         // Status of the process
34         uint32_t env_refcnt;            // Reference count of kernel contexts using this
35         uint32_t env_flags;
36         uint32_t env_entry;
37
38         /* Cache color map: bitmap of the cache colors currently allocated to this
39          * process */
40         uint8_t* cache_colors_map;
41         size_t next_cache_color;
42
43         /* Info about this process's resources (granted, desired) for each type. */
44         struct resource resources[MAX_NUM_RESOURCES];
45
46         /* Keeps track of this process's current memory allocation 
47      * (i.e. its heap pointer) */
48         void* heap_top;
49
50         // Address space
51         pde_t *COUNT(NPDENTRIES) env_pgdir;                     // Kernel virtual address of page dir
52         physaddr_t env_cr3;                     // Physical address of page dir
53 //      struct memregion_list memregions;
54
55         // Per process info and data pages
56         procinfo_t *SAFE procinfo;       // KVA of per-process shared info table (RO)
57         procdata_t *SAFE procdata;       // KVA of per-process shared data table (RW)
58         
59         // The backring pointers for processing asynchronous system calls from the user
60         // Note this is the actual backring, not a pointer to it somewhere else
61         syscall_back_ring_t syscallbackring;
62         
63         // The front ring pointers for pushing asynchronous system events out to the user
64         // Note this is the actual frontring, not a pointer to it somewhere else
65         sysevent_front_ring_t syseventfrontring;
66 };
67
68 /* Process Flags */
69 #define PROC_TRANSITION_TO_M                    0x0001
70
71 extern atomic_t num_envs;               // Number of envs
72
73 int             env_setup_vm(env_t *e);
74 void    env_push_ancillary_state(env_t* e);
75 void    env_pop_ancillary_state(env_t* e);
76 void    env_user_mem_free(env_t* e, void* start, size_t len);
77 void    env_pagetable_free(env_t* e);
78 void    env_load_icode(env_t* e, env_t* binary_env, uint8_t *COUNT(size) binary, size_t size);
79
80 typedef int (*mem_walk_callback_t)(env_t* e, pte_t* pte, void* va, void* arg);
81 int             env_user_mem_walk(env_t* e, void* start, size_t len, mem_walk_callback_t callback, void* arg);
82
83 // The following three functions do not return
84 void    env_pop_tf(trapframe_t *tf) __attribute__((noreturn));
85
86 #endif // !ROS_KERN_ENV_H