Breaks up the proc_lock to use the mm_lock
[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 #include <vfs.h>
22
23 /* List def for the three vcore lists */
24 TAILQ_HEAD(vcore_tailq, vcore);
25
26 // TODO: clean this up.
27 struct proc {
28         TAILQ_ENTRY(proc) proc_link NOINIT;     // Free list link pointers
29         TAILQ_ENTRY(proc) proc_arsc_link NOINIT; // Free list link pointers for the arsc list
30         spinlock_t proc_lock;
31         trapframe_t env_tf;                                             // Saved registers
32         ancillary_state_t env_ancillary_state;  // State saved when descheduled
33         pid_t pid;
34         pid_t ppid;                 // Parent's PID
35         pid_t exitcode;                         // exit() param or main() return value
36         uint32_t state;                         // Status of the process
37         bool is_mcp;                    /* is in multi mode */
38         struct kref p_kref;             /* Refcnt */
39         uint32_t env_flags;
40         uintptr_t env_entry;
41         /* Lists of vcores */
42         struct vcore_tailq online_vcs;
43         struct vcore_tailq bulk_preempted_vcs;
44         struct vcore_tailq inactive_vcs;
45
46         /* Cache color map: bitmap of the cache colors currently allocated to this
47          * process */
48         uint8_t* cache_colors_map;
49         size_t next_cache_color;
50
51         /* Info about this process's resources (granted, desired) for each type. */
52         struct resource resources[MAX_NUM_RESOURCES];
53
54         /* Keeps track of this process's current memory allocation 
55      * (i.e. its heap pointer) */
56         void* heap_top;
57
58         // Address space
59         pde_t *COUNT(NPDENTRIES) env_pgdir;                     // Kernel virtual address of page dir
60         physaddr_t env_cr3;                     // Physical address of page dir
61         spinlock_t mm_lock;             /* Protects page tables and VMRs (mem mgmt) */
62         struct vmr_tailq vm_regions;
63
64         // Per process info and data pages
65         procinfo_t *SAFE procinfo;       // KVA of per-process shared info table (RO)
66         procdata_t *SAFE procdata;       // KVA of per-process shared data table (RW)
67         
68         // The backring pointers for processing asynchronous system calls from the user
69         // Note this is the actual backring, not a pointer to it somewhere else
70         syscall_back_ring_t syscallbackring;
71         
72         // The front ring pointers for pushing asynchronous system events out to the user
73         // Note this is the actual frontring, not a pointer to it somewhere else
74         sysevent_front_ring_t syseventfrontring;
75
76         /* Filesystem info */
77         struct namespace                        *ns;
78         struct fs_struct                        fs_env;
79         struct files_struct                     open_files;
80
81         /* UCQ hashlocks */
82         struct hashlock                         *ucq_hashlock;
83         struct small_hashlock           ucq_hl_noref;   /* don't reference directly */
84 };
85
86 /* Til we remove all Env references */
87 #define Env proc
88 typedef struct proc env_t;
89
90 /* Process Flags */
91 #define PROC_TRANSITION_TO_M                    0x0001
92
93 extern atomic_t num_envs;               // Number of envs
94
95 int             env_setup_vm(env_t *e);
96 void    env_push_ancillary_state(env_t* e);
97 void    env_pop_ancillary_state(env_t* e);
98 void    env_user_mem_free(env_t* e, void* start, size_t len);
99 void    env_pagetable_free(env_t* e);
100
101 typedef int (*mem_walk_callback_t)(env_t* e, pte_t* pte, void* va, void* arg);
102 int             env_user_mem_walk(env_t* e, void* start, size_t len, mem_walk_callback_t callback, void* arg);
103
104 // The following three functions do not return
105 void    env_pop_tf(trapframe_t *tf) __attribute__((noreturn));
106
107 #endif // !ROS_KERN_ENV_H