Proc data structure management, env gutting
[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/error.h>
11 #include <ros/procdata.h>
12 #include <ros/resource.h>
13 #include <arch/trap.h>
14 #include <ros/common.h>
15 #include <arch/arch.h>
16 #include <sys/queue.h>
17
18 struct Env;
19 typedef struct Env env_t;
20
21 // TODO: clean this up.
22 struct Env {
23         TAILQ_ENTRY(Env) proc_link NOINIT;      // Free list link pointers
24         spinlock_t proc_lock;
25         trapframe_t env_tf                                              // Saved registers
26           __attribute__((aligned (8)));                 // for sparc --asw
27         ancillary_state_t env_ancillary_state   // State saved when descheduled
28           __attribute__((aligned (8)));                 // for sparc --asw
29         pid_t pid;
30         pid_t ppid;                 // Parent's PID
31         uint32_t state;                         // Status of the process
32         uint32_t env_refcnt;            // Reference count of kernel contexts using this
33         uint32_t env_flags;
34         uint32_t env_entry;
35         /* Virtual coremap: each index is the virtual core id, the contents at that
36          * index is the physical core_id() corresponding to the vcore.  -1 means it
37          * is unused */
38         int32_t vcoremap[MAX_NUM_CPUS];
39         uint32_t num_vcores;
40
41         /* Info about this process's resources (granted, desired) for each type. */
42         struct resource resources[MAX_NUM_RESOURCES];
43
44         // Address space
45         pde_t *COUNT(NPDENTRIES) env_pgdir;                     // Kernel virtual address of page dir
46         physaddr_t env_cr3;                     // Physical address of page dir
47 //      struct memregion_list memregions;
48
49         // Per process info and data pages
50         procinfo_t *SAFE env_procinfo;       // KVA of per-process shared info table (RO)
51         procdata_t *SAFE env_procdata;       // KVA of per-process shared data table (RW)
52         
53         // The backring pointers for processing asynchronous system calls from the user
54         // Note this is the actual backring, not a pointer to it somewhere else
55         syscall_back_ring_t syscallbackring;
56         
57         // The front ring pointers for pushing asynchronous system events out to the user
58         // Note this is the actual frontring, not a pointer to it somewhere else
59         sysevent_front_ring_t syseventfrontring;
60 };
61
62 /* Process Flags */
63 #define PROC_TRANSITION_TO_M                    0x0001
64
65 extern atomic_t num_envs;               // Number of envs
66
67 int             env_setup_vm(env_t *e);
68 void    load_icode(env_t *SAFE e, uint8_t *COUNT(size) binary, size_t size);
69 void    env_push_ancillary_state(env_t* e);
70 void    env_pop_ancillary_state(env_t* e);
71 void    env_user_mem_free(env_t* e);
72
73 // The following three functions do not return
74 void    env_pop_tf(trapframe_t *tf) __attribute__((noreturn));
75
76
77 /* Helper handler for smp_call to dispatch jobs to other cores */
78 #ifdef __IVY__
79 void run_env_handler(trapframe_t *tf, env_t * data);
80 #else
81 void run_env_handler(trapframe_t *tf, void * data);
82 #endif
83
84 #endif // !ROS_KERN_ENV_H