Allow copy_*_user to be included from umem.h
[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 #define PROC_PROGNAME_SZ 20
30 // TODO: clean this up.
31 struct proc {
32         TAILQ_ENTRY(proc) proc_arsc_link;
33         TAILQ_ENTRY(proc) sibling_link;
34         spinlock_t proc_lock;
35         struct user_context scp_ctx;    /* context for an SCP.  TODO: move to vc0 */
36         char user[64]; /* user name */
37
38         /* This is effectively a (potentially short) version of argv[0].
39          */
40         char progname[PROC_PROGNAME_SZ];
41
42         /* This is the full path of the binary which the current proc structure
43          * is tracking.
44          */
45         char *binary_path;
46
47         pid_t pid;
48         /* Tempting to add a struct proc *parent, but we'd need to protect the use
49          * of that reference from concurrent parent-death (letting init inherit
50          * children, etc), which is basically what we do when we do pid2proc.  If we
51          * do add *parent, it'll be a weak ref, and you'll need to lock the child to
52          * kref_get or to remove the pointer. */
53         pid_t ppid;                                     /* parent's pid, not a reference */
54         struct proc_list children;      /* protected by the proc lock for now */
55         int exitcode;                           /* exit() param or main() return value */
56         struct cond_var child_wait;     /* signal for dying or o/w waitable child */
57         uint32_t state;                         // Status of the process
58         struct kref p_kref;             /* Refcnt */
59         uint32_t env_flags;
60         /* Lists of vcores */
61         struct vcore_tailq online_vcs;
62         struct vcore_tailq bulk_preempted_vcs;
63         struct vcore_tailq inactive_vcs;
64         /* Scheduler mgmt (info, data, whatever) */
65         struct sched_proc_data ksched_data;
66
67         /* Cache color map: bitmap of the cache colors currently allocated to this
68          * process */
69         uint8_t* cache_colors_map;
70         size_t next_cache_color;
71
72         /* Keeps track of this process's current memory allocation 
73      * (i.e. its heap pointer) */
74         void *heap_top;
75
76         /* The args_base pointer is a user pointer which points to the base of
77          * the executable boot block (where args, environment, aux vectors, ...)
78          * are stored.
79          */
80         void *args_base;
81
82         // Address space
83         pgdir_t env_pgdir;                      // Kernel virtual address of page dir
84         physaddr_t env_cr3;                     // Physical address of page dir
85         spinlock_t vmr_lock;            /* Protects VMR tree (mem mgmt) */
86         spinlock_t pte_lock;            /* Protects page tables (mem mgmt) */
87         struct vmr_tailq vm_regions;
88         int vmr_history;
89
90         // Per process info and data pages
91         procinfo_t *procinfo;       // KVA of per-process shared info table (RO)
92         procdata_t *procdata;       // KVA of per-process shared data table (RW)
93         
94         // The backring pointers for processing asynchronous system calls from the user
95         // Note this is the actual backring, not a pointer to it somewhere else
96         syscall_back_ring_t syscallbackring;
97         
98         // The front ring pointers for pushing asynchronous system events out to the user
99         // Note this is the actual frontring, not a pointer to it somewhere else
100         sysevent_front_ring_t syseventfrontring;
101
102         /* Filesystem info */
103         struct namespace                        *ns;
104         struct fs_struct                        fs_env;
105         struct fd_table                         open_files;
106         struct pgrp                                     *pgrp;
107         struct chan                                     *slash;
108         struct chan                                     *dot;
109
110
111         /* UCQ hashlocks */
112         struct hashlock                         *ucq_hashlock;
113         struct small_hashlock           ucq_hl_noref;   /* don't reference directly */
114         /* For devalarm */
115         struct proc_alarm_set           alarmset;
116         struct cv_lookup_tailq          abortable_sleepers;
117         spinlock_t                                      abort_list_lock;
118
119         /* VMMCP */
120         struct vmm vmm;
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 }