vmm: Rename SYS_vmm_setup -> SYS_vmm_add_gpcs (XCC)
[akaros.git] / kern / include / env.h
1 /* See COPYRIGHT for copyright information. */
2
3 #pragma once
4 /* Note that the old include/ros/env.h is merged into this file */
5
6 #include <ros/memlayout.h>
7 #include <ros/syscall.h>
8 #include <ros/sysevent.h>
9 #include <ros/procinfo.h>
10 #include <error.h>
11 #include <ros/procdata.h>
12 #include <ros/procinfo.h>
13 #include <ros/resource.h>
14 #include <trap.h>
15 #include <ros/common.h>
16 #include <arch/arch.h>
17 #include <sys/queue.h>
18 #include <atomic.h>
19 #include <mm.h>
20 #include <vfs.h>
21 #include <schedule.h>
22 #include <devalarm.h>
23 #include <ns.h>
24 #include <arch/vmm/vmm.h>
25
26 TAILQ_HEAD(vcore_tailq, vcore);
27 /* 'struct proc_list' declared in sched.h (not ideal...) */
28
29 struct username {
30         char name[128];
31         spinlock_t name_lock;
32 };
33 void __set_username(struct username *u, char *name);
34 void set_username(struct username *u, char *name);
35
36 #define PROC_PROGNAME_SZ 20
37 // TODO: clean this up.
38 struct proc {
39         TAILQ_ENTRY(proc) proc_arsc_link;
40         TAILQ_ENTRY(proc) sibling_link;
41         spinlock_t proc_lock;
42         struct user_context scp_ctx;    /* context for an SCP.  TODO: move to vc0 */
43         struct username user;
44
45         /* This is effectively a (potentially short) version of argv[0].
46          */
47         char progname[PROC_PROGNAME_SZ];
48
49         /* This is the full path of the binary which the current proc structure
50          * is tracking.
51          */
52         char *binary_path;
53
54         pid_t pid;
55         /* Tempting to add a struct proc *parent, but we'd need to protect the use
56          * of that reference from concurrent parent-death (letting init inherit
57          * children, etc), which is basically what we do when we do pid2proc.  If we
58          * do add *parent, it'll be a weak ref, and you'll need to lock the child to
59          * kref_get or to remove the pointer. */
60         pid_t ppid;                                     /* parent's pid, not a reference */
61         struct proc_list children;      /* protected by the proc lock for now */
62         int exitcode;                           /* exit() param or main() return value */
63         struct cond_var child_wait;     /* signal for dying or o/w waitable child */
64         uint32_t state;                         // Status of the process
65         struct kref p_kref;             /* Refcnt */
66         uint32_t env_flags;
67         /* Lists of vcores */
68         struct vcore_tailq online_vcs;
69         struct vcore_tailq bulk_preempted_vcs;
70         struct vcore_tailq inactive_vcs;
71         /* Scheduler mgmt (info, data, whatever) */
72         struct sched_proc_data ksched_data;
73
74         /* The args_base pointer is a user pointer which points to the base of
75          * the executable boot block (where args, environment, aux vectors, ...)
76          * are stored.
77          */
78         void *args_base;
79
80         // Address space
81         pgdir_t env_pgdir;                      // Kernel virtual address of page dir
82         physaddr_t env_cr3;                     // Physical address of page dir
83         spinlock_t vmr_lock;            /* Protects VMR tree (mem mgmt) */
84         spinlock_t pte_lock;            /* Protects page tables (mem mgmt) */
85         struct vmr_tailq vm_regions;
86         int vmr_history;
87
88         // Per process info and data pages
89         procinfo_t *procinfo;       // KVA of per-process shared info table (RO)
90         procdata_t *procdata;       // KVA of per-process shared data table (RW)
91
92         // The backring pointers for processing asynchronous system calls from the user
93         // Note this is the actual backring, not a pointer to it somewhere else
94         syscall_back_ring_t syscallbackring;
95
96         // The front ring pointers for pushing asynchronous system events out to the user
97         // Note this is the actual frontring, not a pointer to it somewhere else
98         sysevent_front_ring_t syseventfrontring;
99
100         /* Filesystem info */
101         struct namespace                        *ns;
102         struct fs_struct                        fs_env;
103         struct fd_table                         open_files;
104         struct pgrp                                     *pgrp;
105         struct chan                                     *slash;
106         struct chan                                     *dot;
107
108
109         /* UCQ hashlocks */
110         struct hashlock                         *ucq_hashlock;
111         struct small_hashlock           ucq_hl_noref;   /* don't reference directly */
112         /* For devalarm */
113         struct proc_alarm_set           alarmset;
114         struct cv_lookup_tailq          abortable_sleepers;
115         spinlock_t                                      abort_list_lock;
116
117         /* VMMCP */
118         struct vmm vmm;
119
120         struct strace                           *strace;
121 };
122
123 /* Til we remove all Env references */
124 #define Env proc
125 typedef struct proc env_t;
126
127 /* Process Flags */
128 #define PROC_TRANSITION_TO_M    (1 << 0)
129 #define PROC_TRACED                             (1 << 1)
130
131 extern atomic_t num_envs;               // Number of envs
132
133 int             env_setup_vm(env_t *e);
134 void    env_user_mem_free(env_t* e, void* start, size_t len);
135 void    env_pagetable_free(env_t* e);
136
137 typedef int (*mem_walk_callback_t)(env_t* e, pte_t pte, void* va, void* arg);
138 int             env_user_mem_walk(env_t* e, void* start, size_t len, mem_walk_callback_t callback, void* arg);
139
140 static inline void set_traced_proc(struct proc *p, bool traced)
141 {
142         if (traced)
143                 p->env_flags |= PROC_TRACED;
144         else
145                 p->env_flags &= ~PROC_TRACED;
146 }
147
148 static inline bool is_traced_proc(const struct proc *p)
149 {
150         return (p->env_flags & PROC_TRACED) != 0;
151 }