VM regions: management functions and structs
[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 #include <mm.h>
21
22 // TODO: clean this up.
23 struct proc {
24         TAILQ_ENTRY(proc) 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
36         /* Cache color map: bitmap of the cache colors currently allocated to this
37          * process */
38         uint8_t* cache_colors_map;
39         size_t next_cache_color;
40
41         /* Info about this process's resources (granted, desired) for each type. */
42         struct resource resources[MAX_NUM_RESOURCES];
43
44         /* Keeps track of this process's current memory allocation 
45      * (i.e. its heap pointer) */
46         void* heap_top;
47
48         // Address space
49         pde_t *COUNT(NPDENTRIES) env_pgdir;                     // Kernel virtual address of page dir
50         physaddr_t env_cr3;                     // Physical address of page dir
51         struct vmr_tailq vm_regions;
52
53         // Per process info and data pages
54         procinfo_t *SAFE procinfo;       // KVA of per-process shared info table (RO)
55         procdata_t *SAFE procdata;       // KVA of per-process shared data table (RW)
56         
57         // The backring pointers for processing asynchronous system calls from the user
58         // Note this is the actual backring, not a pointer to it somewhere else
59         syscall_back_ring_t syscallbackring;
60         
61         // The front ring pointers for pushing asynchronous system events out to the user
62         // Note this is the actual frontring, not a pointer to it somewhere else
63         sysevent_front_ring_t syseventfrontring;
64 };
65
66 /* Til we remove all Env references */
67 #define Env proc
68 typedef struct proc env_t;
69
70 /* Process Flags */
71 #define PROC_TRANSITION_TO_M                    0x0001
72
73 extern atomic_t num_envs;               // Number of envs
74
75 int             env_setup_vm(env_t *e);
76 void    env_push_ancillary_state(env_t* e);
77 void    env_pop_ancillary_state(env_t* e);
78 void    env_user_mem_free(env_t* e, void* start, size_t len);
79 void    env_pagetable_free(env_t* e);
80 void    env_load_icode(env_t* e, env_t* binary_env, uint8_t *COUNT(size) binary, size_t size);
81
82 typedef int (*mem_walk_callback_t)(env_t* e, pte_t* pte, void* va, void* arg);
83 int             env_user_mem_walk(env_t* e, void* start, size_t len, mem_walk_callback_t callback, void* arg);
84
85 // The following three functions do not return
86 void    env_pop_tf(trapframe_t *tf) __attribute__((noreturn));
87
88 #endif // !ROS_KERN_ENV_H