88418da1b8ef71a58682ee92eeb3a20993b08ca8
[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 <schedule.h>
21 #include <devalarm.h>
22 #include <ns.h>
23 #include <arch/vmm/vmm.h>
24
25 TAILQ_HEAD(vcore_tailq, vcore);
26 /* 'struct proc_list' declared in sched.h (not ideal...) */
27
28 struct username {
29         char name[128];
30         spinlock_t name_lock;
31 };
32 void __set_username(struct username *u, char *name);
33 void set_username(struct username *u, char *name);
34
35 #define PROC_PROGNAME_SZ 20
36 // TODO: clean this up.
37 struct proc {
38         TAILQ_ENTRY(proc) proc_arsc_link;
39         TAILQ_ENTRY(proc) sibling_link;
40         spinlock_t proc_lock;
41         struct user_context scp_ctx; /* context for an SCP. TODO: move to vc0 */
42         struct username user;
43
44         /* This is effectively a (potentially short) version of argv[0].
45          */
46         char progname[PROC_PROGNAME_SZ];
47
48         /* This is the full path of the binary which the current proc structure
49          * is tracking.
50          */
51         char *binary_path;
52
53         pid_t pid;
54         /* Tempting to add a struct proc *parent, but we'd need to protect the
55          * use of that reference from concurrent parent-death (letting init
56          * inherit children, etc), which is basically what we do when we do
57          * pid2proc.  If we do add *parent, it'll be a weak ref, and you'll need
58          * to lock the child to kref_get or to remove the pointer. */
59         pid_t ppid;             /* parent's pid, not a reference */
60         struct proc_list children; /* protected by the proc lock for now */
61         int exitcode;           /* exit() param or main() return value */
62         struct cond_var child_wait; /* signal for dying or o/w waitable child */
63         uint32_t state;                         // Status of the process
64         struct kref p_kref;     /* Refcnt */
65         uint32_t env_flags;
66         /* Lists of vcores */
67         struct vcore_tailq online_vcs;
68         struct vcore_tailq bulk_preempted_vcs;
69         struct vcore_tailq inactive_vcs;
70         /* Scheduler mgmt (info, data, whatever) */
71         struct sched_proc_data ksched_data;
72
73         /* The args_base pointer is a user pointer which points to the base of
74          * the executable boot block (where args, environment, aux vectors, ...)
75          * are stored.
76          */
77         void *args_base;
78
79         // Address space
80         pgdir_t env_pgdir;              // Kernel virtual address of page dir
81         physaddr_t env_cr3;             // Physical address of page dir
82         spinlock_t vmr_lock;            /* Protects VMR tree (mem mgmt) */
83         spinlock_t pte_lock;            /* Protects page tables (mem mgmt) */
84         struct vmr_tailq vm_regions;
85         int vmr_history;
86
87         // Per process info and data pages
88         procinfo_t *procinfo;       // KVA of per-process shared info table (RO)
89         procdata_t *procdata;       // KVA of per-process shared data table (RW)
90
91         // The backring pointers for processing asynchronous system calls from
92         // the user Note this is the actual backring, not a pointer to it
93         // somewhere else
94         syscall_back_ring_t syscallbackring;
95
96         // The front ring pointers for pushing asynchronous system events out to
97         // the user Note this is the actual frontring, not a pointer to it
98         // somewhere else
99         sysevent_front_ring_t syseventfrontring;
100
101         /* Filesystem info */
102         int                     umask;
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,
139                       mem_walk_callback_t callback, void* arg);
140
141 static inline void set_traced_proc(struct proc *p, bool traced)
142 {
143         if (traced)
144                 p->env_flags |= PROC_TRACED;
145         else
146                 p->env_flags &= ~PROC_TRACED;
147 }
148
149 static inline bool is_traced_proc(const struct proc *p)
150 {
151         return (p->env_flags & PROC_TRACED) != 0;
152 }