Proc refcnting wrappers
[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 <arch/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
23 // TODO: clean this up.
24 struct proc {
25         TAILQ_ENTRY(proc) proc_link NOINIT;     // Free list link pointers
26         TAILQ_ENTRY(proc) proc_arsc_link NOINIT; // Free list link pointers for the arsc list
27         spinlock_t proc_lock;
28         trapframe_t env_tf;                                             // Saved registers
29         ancillary_state_t env_ancillary_state;  // State saved when descheduled
30         pid_t pid;
31         pid_t ppid;                 // Parent's PID
32         pid_t exitcode;                         // exit() param or main() return value
33         uint32_t state;                         // Status of the process
34         struct kref p_kref;             /* Refcnt */
35         uint32_t env_flags;
36         uint32_t env_entry;
37
38         /* Cache color map: bitmap of the cache colors currently allocated to this
39          * process */
40         uint8_t* cache_colors_map;
41         size_t next_cache_color;
42
43         /* Info about this process's resources (granted, desired) for each type. */
44         struct resource resources[MAX_NUM_RESOURCES];
45
46         /* Keeps track of this process's current memory allocation 
47      * (i.e. its heap pointer) */
48         void* heap_top;
49
50         // Address space
51         pde_t *COUNT(NPDENTRIES) env_pgdir;                     // Kernel virtual address of page dir
52         physaddr_t env_cr3;                     // Physical address of page dir
53         struct vmr_tailq vm_regions;
54
55         // Per process info and data pages
56         procinfo_t *SAFE procinfo;       // KVA of per-process shared info table (RO)
57         procdata_t *SAFE procdata;       // KVA of per-process shared data table (RW)
58         
59         // The backring pointers for processing asynchronous system calls from the user
60         // Note this is the actual backring, not a pointer to it somewhere else
61         syscall_back_ring_t syscallbackring;
62         
63         // The front ring pointers for pushing asynchronous system events out to the user
64         // Note this is the actual frontring, not a pointer to it somewhere else
65         sysevent_front_ring_t syseventfrontring;
66
67         /* Filesystem info */
68         struct namespace                        *ns;
69         struct fs_struct                        fs_env;
70         struct files_struct                     open_files;
71 };
72
73 /* Til we remove all Env references */
74 #define Env proc
75 typedef struct proc env_t;
76
77 /* Process Flags */
78 #define PROC_TRANSITION_TO_M                    0x0001
79
80 extern atomic_t num_envs;               // Number of envs
81
82 int             env_setup_vm(env_t *e);
83 void    env_push_ancillary_state(env_t* e);
84 void    env_pop_ancillary_state(env_t* e);
85 void    env_user_mem_free(env_t* e, void* start, size_t len);
86 void    env_pagetable_free(env_t* e);
87
88 typedef int (*mem_walk_callback_t)(env_t* e, pte_t* pte, void* va, void* arg);
89 int             env_user_mem_walk(env_t* e, void* start, size_t len, mem_walk_callback_t callback, void* arg);
90
91 // The following three functions do not return
92 void    env_pop_tf(trapframe_t *tf) __attribute__((noreturn));
93
94 #endif // !ROS_KERN_ENV_H