Merge remote branch 'origin/sparc-dev'
[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         ancillary_state_t env_ancillary_state;  // State saved when descheduled
27         pid_t pid;
28         pid_t ppid;                 // Parent's PID
29         uint32_t state;                         // Status of the process
30         uint32_t env_refcnt;            // Reference count of kernel contexts using this
31         uint32_t env_flags;
32         uint32_t env_entry;
33         /* Virtual coremap: each index is the virtual core id, the contents at that
34          * index is the physical core_id() corresponding to the vcore.  -1 means it
35          * is unused */
36         int32_t vcoremap[MAX_NUM_CPUS];
37         uint32_t num_vcores;
38
39         /* Cache color map: bitmap of the cache colors currently allocated to this
40          * process */
41         uint8_t* cache_colors_map;
42         size_t next_cache_color;
43
44         /* Info about this process's resources (granted, desired) for each type. */
45         struct resource resources[MAX_NUM_RESOURCES];
46
47         /* Keeps track of this process's current memory allocation 
48      * (i.e. its heap pointer) */
49         void* heap_bottom;
50         void* heap_top;
51
52         // Address space
53         pde_t *COUNT(NPDENTRIES) env_pgdir;                     // Kernel virtual address of page dir
54         physaddr_t env_cr3;                     // Physical address of page dir
55 //      struct memregion_list memregions;
56
57         // Per process info and data pages
58         procinfo_t *SAFE env_procinfo;       // KVA of per-process shared info table (RO)
59         procdata_t *SAFE env_procdata;       // KVA of per-process shared data table (RW)
60         
61         // The backring pointers for processing asynchronous system calls from the user
62         // Note this is the actual backring, not a pointer to it somewhere else
63         syscall_back_ring_t syscallbackring;
64         
65         // The front ring pointers for pushing asynchronous system events out to the user
66         // Note this is the actual frontring, not a pointer to it somewhere else
67         sysevent_front_ring_t syseventfrontring;
68 };
69
70 /* Process Flags */
71 #define PROC_TRANSITION_TO_M                    0x0001
72
73 extern atomic_t num_envs;               // Number of envs
74
75 int             env_setup_vm(env_t *e);
76 void    env_push_ancillary_state(env_t* e);
77 void    env_pop_ancillary_state(env_t* e);
78 void    env_user_mem_free(env_t* e);
79 void    env_segment_alloc(env_t *e, void *SNT va, size_t len);
80 void    env_segment_free(env_t *e, void *SNT va, size_t len);
81 void    env_load_icode(env_t* e, env_t* binary_env, uint8_t *COUNT(size) binary, size_t size);
82
83 // The following three functions do not return
84 void    env_pop_tf(trapframe_t *tf) __attribute__((noreturn));
85
86
87 /* Helper handler for smp_call to dispatch jobs to other cores */
88 #ifdef __IVY__
89 void run_env_handler(trapframe_t *tf, env_t * data);
90 #else
91 void run_env_handler(trapframe_t *tf, void * data);
92 #endif
93
94 #endif // !ROS_KERN_ENV_H