a4974fb5ce00d0b3df1424bd0faf4bfe8873878b
[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 <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 #include <schedule.h>
23 #include <devalarm.h>
24 #include <ns.h>
25
26 TAILQ_HEAD(vcore_tailq, vcore);
27 /* 'struct proc_list' declared in sched.h (not ideal...) */
28
29 // TODO: clean this up.
30 struct proc {
31         TAILQ_ENTRY(proc) proc_arsc_link;
32         TAILQ_ENTRY(proc) sibling_link;
33         spinlock_t proc_lock;
34         struct user_context scp_ctx;    /* context for an SCP.  TODO: move to vc0 */
35         char user[64]; /* user name */
36         pid_t pid;
37         /* Tempting to add a struct proc *parent, but we'd need to protect the use
38          * of that reference from concurrent parent-death (letting init inherit
39          * children, etc), which is basically what we do when we do pid2proc.  If we
40          * do add *parent, it'll be a weak ref, and you'll need to lock the child to
41          * kref_get or to remove the pointer. */
42         pid_t ppid;                                     /* parent's pid, not a reference */
43         struct proc_list children;      /* protected by the proc lock for now */
44         int exitcode;                           /* exit() param or main() return value */
45         struct cond_var child_wait;     /* signal for dying or o/w waitable child */
46         uint32_t state;                         // Status of the process
47         struct kref p_kref;             /* Refcnt */
48         uint32_t env_flags;
49         uintptr_t env_entry;
50         /* Lists of vcores */
51         struct vcore_tailq online_vcs;
52         struct vcore_tailq bulk_preempted_vcs;
53         struct vcore_tailq inactive_vcs;
54         /* Scheduler mgmt (info, data, whatever) */
55         struct sched_proc_data ksched_data;
56
57         /* Cache color map: bitmap of the cache colors currently allocated to this
58          * process */
59         uint8_t* cache_colors_map;
60         size_t next_cache_color;
61
62         /* Keeps track of this process's current memory allocation 
63      * (i.e. its heap pointer) */
64         void* heap_top;
65
66         // Address space
67         pde_t *COUNT(NPDENTRIES) env_pgdir;                     // Kernel virtual address of page dir
68         physaddr_t env_cr3;                     // Physical address of page dir
69         spinlock_t vmr_lock;            /* Protects VMR tree (mem mgmt) */
70         spinlock_t pte_lock;            /* Protects page tables (mem mgmt) */
71         struct vmr_tailq vm_regions;
72
73         // Per process info and data pages
74         procinfo_t *SAFE procinfo;       // KVA of per-process shared info table (RO)
75         procdata_t *SAFE procdata;       // KVA of per-process shared data table (RW)
76         
77         // The backring pointers for processing asynchronous system calls from the user
78         // Note this is the actual backring, not a pointer to it somewhere else
79         syscall_back_ring_t syscallbackring;
80         
81         // The front ring pointers for pushing asynchronous system events out to the user
82         // Note this is the actual frontring, not a pointer to it somewhere else
83         sysevent_front_ring_t syseventfrontring;
84
85         /* Filesystem info */
86         struct namespace                        *ns;
87         struct fs_struct                        fs_env;
88         struct files_struct                     open_files;
89         struct pgrp                             *pgrp;
90         struct fgrp                             *fgrp;
91
92         /* UCQ hashlocks */
93         struct hashlock                         *ucq_hashlock;
94         struct small_hashlock           ucq_hl_noref;   /* don't reference directly */
95         /* For devalarm */
96         struct proc_alarm_set           alarmset;
97         struct cv_lookup_tailq          abortable_sleepers;
98         spinlock_t                                      abort_list_lock;
99 };
100
101 /* Til we remove all Env references */
102 #define Env proc
103 typedef struct proc env_t;
104
105 /* Process Flags */
106 #define PROC_TRANSITION_TO_M                    0x0001
107
108 extern atomic_t num_envs;               // Number of envs
109
110 int             env_setup_vm(env_t *e);
111 void    env_user_mem_free(env_t* e, void* start, size_t len);
112 void    env_pagetable_free(env_t* e);
113
114 typedef int (*mem_walk_callback_t)(env_t* e, pte_t* pte, void* va, void* arg);
115 int             env_user_mem_walk(env_t* e, void* start, size_t len, mem_walk_callback_t callback, void* arg);
116
117 #endif // !ROS_KERN_ENV_H