Migrated Akaros code to use pragma once (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 #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         char progname[PROC_PROGNAME_SZ];
38         pid_t pid;
39         /* Tempting to add a struct proc *parent, but we'd need to protect the use
40          * of that reference from concurrent parent-death (letting init inherit
41          * children, etc), which is basically what we do when we do pid2proc.  If we
42          * do add *parent, it'll be a weak ref, and you'll need to lock the child to
43          * kref_get or to remove the pointer. */
44         pid_t ppid;                                     /* parent's pid, not a reference */
45         struct proc_list children;      /* protected by the proc lock for now */
46         int exitcode;                           /* exit() param or main() return value */
47         struct cond_var child_wait;     /* signal for dying or o/w waitable child */
48         uint32_t state;                         // Status of the process
49         struct kref p_kref;             /* Refcnt */
50         uint32_t env_flags;
51         /* Lists of vcores */
52         struct vcore_tailq online_vcs;
53         struct vcore_tailq bulk_preempted_vcs;
54         struct vcore_tailq inactive_vcs;
55         /* Scheduler mgmt (info, data, whatever) */
56         struct sched_proc_data ksched_data;
57
58         /* Cache color map: bitmap of the cache colors currently allocated to this
59          * process */
60         uint8_t* cache_colors_map;
61         size_t next_cache_color;
62
63         /* Keeps track of this process's current memory allocation 
64      * (i.e. its heap pointer) */
65         void* heap_top;
66
67         // Address space
68         pgdir_t env_pgdir;                      // Kernel virtual address of page dir
69         physaddr_t env_cr3;                     // Physical address of page dir
70         spinlock_t vmr_lock;            /* Protects VMR tree (mem mgmt) */
71         spinlock_t pte_lock;            /* Protects page tables (mem mgmt) */
72         struct vmr_tailq vm_regions;
73         int vmr_history;
74
75         // Per process info and data pages
76         procinfo_t *procinfo;       // KVA of per-process shared info table (RO)
77         procdata_t *procdata;       // KVA of per-process shared data table (RW)
78         
79         // The backring pointers for processing asynchronous system calls from the user
80         // Note this is the actual backring, not a pointer to it somewhere else
81         syscall_back_ring_t syscallbackring;
82         
83         // The front ring pointers for pushing asynchronous system events out to the user
84         // Note this is the actual frontring, not a pointer to it somewhere else
85         sysevent_front_ring_t syseventfrontring;
86
87         /* Filesystem info */
88         struct namespace                        *ns;
89         struct fs_struct                        fs_env;
90         struct fd_table                         open_files;
91         struct pgrp                                     *pgrp;
92         struct chan                                     *slash;
93         struct chan                                     *dot;
94
95
96         /* UCQ hashlocks */
97         struct hashlock                         *ucq_hashlock;
98         struct small_hashlock           ucq_hl_noref;   /* don't reference directly */
99         /* For devalarm */
100         struct proc_alarm_set           alarmset;
101         struct cv_lookup_tailq          abortable_sleepers;
102         spinlock_t                                      abort_list_lock;
103
104         /* VMMCP */
105         struct vmm vmm;
106 };
107
108 /* Til we remove all Env references */
109 #define Env proc
110 typedef struct proc env_t;
111
112 /* Process Flags */
113 #define PROC_TRANSITION_TO_M    (1 << 0)
114 #define PROC_TRACED                             (1 << 1)
115
116 extern atomic_t num_envs;               // Number of envs
117
118 int             env_setup_vm(env_t *e);
119 void    env_user_mem_free(env_t* e, void* start, size_t len);
120 void    env_pagetable_free(env_t* e);
121
122 typedef int (*mem_walk_callback_t)(env_t* e, pte_t pte, void* va, void* arg);
123 int             env_user_mem_walk(env_t* e, void* start, size_t len, mem_walk_callback_t callback, void* arg);
124
125 static inline void set_traced_proc(struct proc *p, bool traced)
126 {
127         if (traced)
128                 p->env_flags |= PROC_TRACED;
129         else
130                 p->env_flags &= ~PROC_TRACED;
131 }
132
133 static inline bool is_traced_proc(const struct proc *p)
134 {
135         return (p->env_flags & PROC_TRACED) != 0;
136 }