More pruning of files we don't need.
[akaros.git] / kern / include / smp.h
1 /*
2  * Copyright (c) 2009 The Regents of the University of California
3  * Barret Rhoden <brho@cs.berkeley.edu>
4  * See LICENSE for details.
5  */
6
7 #ifndef ROS_INC_SMP_H
8 #define ROS_INC_SMP_H
9
10 /* SMP related functions */
11
12 #include <arch/smp.h>
13 #include <ros/common.h>
14 #include <sys/queue.h>
15 #include <trap.h>
16 #include <atomic.h>
17 #include <process.h>
18 #include <syscall.h>
19 #include <alarm.h>
20 #include <trace.h>
21
22 #ifdef __SHARC__
23 typedef sharC_env_t;
24 #endif
25
26 #define CPU_STATE_IRQ                   0
27 #define CPU_STATE_KERNEL                1
28 #define CPU_STATE_USER                  2
29 #define CPU_STATE_IDLE                  3
30 #define NR_CPU_STATES                   4
31
32 static char *cpu_state_names[NR_CPU_STATES] =
33 {
34         "irq",
35         "kern",
36         "user",
37         "idle",
38 };
39
40 struct per_cpu_info {
41 #ifdef CONFIG_X86
42         uintptr_t stacktop;                     /* must be first */
43         int coreid;                                     /* must be second */
44         /* virtual machines */
45         //struct vmcs *vmxarea;
46         pseudodesc_t host_gdt;
47         int vmx_enabled;
48         void *local_vcpu;
49 #endif
50         spinlock_t lock;
51         /* Process management */
52         // cur_proc should be valid on all cores that are not management cores.
53         struct proc *cur_proc;          /* which process context is loaded */
54         struct proc *owning_proc;       /* proc owning the core / cur_ctx */
55         uint32_t owning_vcoreid;        /* vcoreid of owning proc (if applicable */
56         struct user_context *cur_ctx;   /* user ctx we came in on (can be 0) */
57         struct user_context actual_ctx; /* storage for cur_ctx */
58         uint32_t __ctx_depth;           /* don't access directly.  see trap.h. */
59         int __lock_checking_enabled;/* == 1, enables spinlock depth checking */
60         struct kthread *cur_kthread;/* tracks the running kernel context */
61         struct kthread *spare;          /* useful when restarting */
62         struct timer_chain tchain;      /* for the per-core alarm */
63         unsigned int lock_depth;
64         struct trace_ring traces;
65         int cpu_state;
66         uint64_t last_tick_cnt;
67         uint64_t state_ticks[NR_CPU_STATES];
68 #ifdef __SHARC__
69         // held spin-locks. this will have to go elsewhere if multiple kernel
70         // threads can share a CPU.
71         // zra: Used by Ivy. Let me know if this should go elsewhere.
72         sharC_env_t sharC_env;
73 #endif
74         /* TODO: 64b (not sure if we'll need these at all */
75 #ifdef CONFIG_X86
76         taskstate_t *tss;
77         segdesc_t *gdt;
78 #endif
79         /* KMSGs */
80         spinlock_t immed_amsg_lock;
81         struct kernel_msg_list NTPTV(a0t) NTPTV(a1t) NTPTV(a2t) immed_amsgs;
82         spinlock_t routine_amsg_lock;
83         struct kernel_msg_list NTPTV(a0t) NTPTV(a1t) NTPTV(a2t) routine_amsgs;
84         /* profiling -- opaque to all but the profiling code. */
85         void *profiling;
86 }__attribute__((aligned(ARCH_CL_SIZE)));
87
88 /* Allows the kernel to figure out what process is running on this core.  Can be
89  * used just like a pointer to a struct proc. */
90 #define current per_cpu_info[core_id()].cur_proc
91 /* Allows the kernel to figure out what *user* ctx is on this core's stack.  Can
92  * be used just like a pointer to a struct user_context.  Note the distinction
93  * between kernel and user contexts.  The kernel always returns to its nested,
94  * interrupted contexts via iret/etc.  We never do that for user contexts. */
95 #define current_ctx per_cpu_info[core_id()].cur_ctx
96
97 typedef struct per_cpu_info NTPTV(t) NTPTV(a0t) NTPTV(a1t) NTPTV(a2t) per_cpu_info_t;
98
99 extern per_cpu_info_t (RO per_cpu_info)[MAX_NUM_CPUS];
100 extern volatile uint32_t RO num_cpus;
101
102 /* SMP bootup functions */
103 void smp_boot(void);
104 void smp_idle(void) __attribute__((noreturn));
105 void smp_percpu_init(void); // this must be called by each core individually
106 void __arch_pcpu_init(uint32_t coreid); /* each arch has one of these */
107
108 void __set_cpu_state(struct per_cpu_info *pcpui, int state);
109 void reset_cpu_state_ticks(int coreid);
110
111 /* SMP utility functions */
112 int smp_call_function_self(isr_t handler, void *data,
113                            handler_wrapper_t **wait_wrapper);
114 int smp_call_function_all(isr_t handler, void *data,
115                           handler_wrapper_t **wait_wrapper);
116 int smp_call_function_single(uint32_t dest, isr_t handler, void *data,
117                              handler_wrapper_t **wait_wrapper);
118 int smp_call_wait(handler_wrapper_t *wrapper);
119
120 /* PCPUI Trace Rings: */
121 struct pcpu_trace_event {
122         int                                                     type;
123         int                                                     arg0;
124         uint64_t                                        arg1;
125 };
126
127 /* If you want to add a type, use the next available number, increment NR_TYPES,
128  * use your own macro, and provide a handler.  Add your handler to
129  * pcpui_tr_handlers in smp.c. */
130 #define PCPUI_TR_TYPE_NULL              0
131 #define PCPUI_TR_TYPE_KMSG              1
132 #define PCPUI_TR_TYPE_LOCKS             2
133 #define PCPUI_NR_TYPES                  3
134
135 #ifdef CONFIG_TRACE_KMSGS
136
137 # define pcpui_trace_kmsg(pcpui, pc)                                           \
138 {                                                                              \
139         struct pcpu_trace_event *e = get_trace_slot_racy(&pcpui->traces);          \
140         if (e) {                                                                   \
141                 e->type = PCPUI_TR_TYPE_KMSG;                                          \
142                 e->arg1 = pc;                                                          \
143         }                                                                          \
144 }
145
146 #else
147
148 # define pcpui_trace_kmsg(pcpui, pc)
149
150 #endif /* CONFIG_TRACE_KMSGS */
151
152
153 #ifdef CONFIG_TRACE_LOCKS
154
155 # define pcpui_trace_locks(pcpui, lock)                                        \
156 {                                                                              \
157         struct pcpu_trace_event *e = get_trace_slot_overwrite(&pcpui->traces);     \
158         if (e) {                                                                   \
159                 e->type = PCPUI_TR_TYPE_LOCKS;                                         \
160                 e->arg0 = (int)tsc2usec(read_tsc());                                   \
161                 e->arg1 = (uintptr_t)lock;                                             \
162         }                                                                          \
163 }
164
165 #else
166
167 # define pcpui_trace_locks(pcpui, lock)
168
169 #endif /* CONFIG_TRACE_LOCKS */
170
171 /* Run the handlers for all events in a pcpui ring.  Can run on all cores, or
172  * just one core.  'type' selects which event type is handled (0 for all). */
173 void pcpui_tr_foreach(int coreid, int type);
174 void pcpui_tr_foreach_all(int type);
175 void pcpui_tr_reset_all(void);
176 void pcpui_tr_reset_and_clear_all(void);
177
178 #endif /* ROS_INC_SMP_H */