Ksched is interrupt driven
[akaros.git] / kern / src / schedule.c
1 /* Copyright (c) 2009, 2012 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Scheduling and dispatching. */
6
7 #ifdef __SHARC__
8 #pragma nosharc
9 #endif
10
11 #include <schedule.h>
12 #include <process.h>
13 #include <monitor.h>
14 #include <stdio.h>
15 #include <assert.h>
16 #include <atomic.h>
17 #include <smp.h>
18 #include <manager.h>
19 #include <alarm.h>
20 #include <sys/queue.h>
21
22 /* Process Lists */
23 struct proc_list runnable_scps = TAILQ_HEAD_INITIALIZER(runnable_scps);
24 struct proc_list all_mcps = TAILQ_HEAD_INITIALIZER(all_mcps);
25 spinlock_t sched_lock = SPINLOCK_INITIALIZER;
26
27 // This could be useful for making scheduling decisions.  
28 /* Physical coremap: each index is a physical core id, with a proc ptr for
29  * whoever *should be or is* running.  Very similar to current, which is what
30  * process is *really* running there. */
31 struct proc *pcoremap[MAX_NUM_CPUS];
32
33 /* Tracks which cores are idle, similar to the vcoremap.  Each value is the
34  * physical coreid of an unallocated core. */
35 spinlock_t idle_lock = SPINLOCK_INITIALIZER;
36 uint32_t idlecoremap[MAX_NUM_CPUS];
37 uint32_t num_idlecores = 0;
38 uint32_t num_mgmtcores = 1;
39
40 /* Helper, defined below */
41 static void __core_request(struct proc *p);
42
43 /* Alarm struct, for our example 'timer tick' */
44 struct alarm_waiter ksched_waiter;
45
46 #define TIMER_TICK_USEC 10000   /* 10msec */
47
48 /* Helper: Sets up a timer tick on the calling core to go off 10 msec from now.
49  * This assumes the calling core is an LL core, etc. */
50 static void set_ksched_alarm(void)
51 {
52         set_awaiter_rel(&ksched_waiter, TIMER_TICK_USEC);
53         set_alarm(&per_cpu_info[core_id()].tchain, &ksched_waiter);
54 }
55
56 /* Kmsg, to run the scheduler tick (not in interrupt context) and reset the
57  * alarm.  Note that interrupts will be disabled, but this is not the same as
58  * interrupt context.  We're a routine kmsg, which means the core is in a
59  * quiescent state. */
60 static void __ksched_tick(struct trapframe *tf, uint32_t srcid, long a0,
61                           long a1, long a2)
62 {
63         /* TODO: imagine doing some accounting here */
64         schedule();
65         /* Set our alarm to go off, incrementing from our last tick (instead of
66          * setting it relative to now, since some time has passed since the alarm
67          * first went off.  Note, this may be now or in the past! */
68         set_awaiter_inc(&ksched_waiter, TIMER_TICK_USEC);
69         set_alarm(&per_cpu_info[core_id()].tchain, &ksched_waiter);
70 }
71
72 /* Interrupt/alarm handler: tells our core to run the scheduler (out of
73  * interrupt context). */
74 static void __kalarm(struct alarm_waiter *waiter)
75 {
76         send_kernel_message(core_id(), __ksched_tick, 0, 0, 0, KMSG_ROUTINE);
77 }
78
79 void schedule_init(void)
80 {
81         TAILQ_INIT(&runnable_scps);
82         TAILQ_INIT(&all_mcps);
83         assert(!core_id());             /* want the alarm on core0 for now */
84         init_awaiter(&ksched_waiter, __kalarm);
85         set_ksched_alarm();
86
87         /* Ghetto old idle core init */
88         /* Init idle cores. Core 0 is the management core. */
89         spin_lock(&idle_lock);
90 #ifdef __CONFIG_DISABLE_SMT__
91         /* assumes core0 is the only management core (NIC and monitor functionality
92          * are run there too.  it just adds the odd cores to the idlecoremap */
93         assert(!(num_cpus % 2));
94         // TODO: consider checking x86 for machines that actually hyperthread
95         num_idlecores = num_cpus >> 1;
96  #ifdef __CONFIG_ARSC_SERVER__
97         // Dedicate one core (core 2) to sysserver, might be able to share wit NIC
98         num_mgmtcores++;
99         assert(num_cpus >= num_mgmtcores);
100         send_kernel_message(2, (amr_t)arsc_server, 0,0,0, KMSG_ROUTINE);
101  #endif
102         for (int i = 0; i < num_idlecores; i++)
103                 idlecoremap[i] = (i * 2) + 1;
104 #else
105         // __CONFIG_DISABLE_SMT__
106         #ifdef __CONFIG_NETWORKING__
107         num_mgmtcores++; // Next core is dedicated to the NIC
108         assert(num_cpus >= num_mgmtcores);
109         #endif
110         #ifdef __CONFIG_APPSERVER__
111         #ifdef __CONFIG_DEDICATED_MONITOR__
112         num_mgmtcores++; // Next core dedicated to running the kernel monitor
113         assert(num_cpus >= num_mgmtcores);
114         // Need to subtract 1 from the num_mgmtcores # to get the cores index
115         send_kernel_message(num_mgmtcores-1, (amr_t)monitor, 0,0,0, KMSG_ROUTINE);
116         #endif
117         #endif
118  #ifdef __CONFIG_ARSC_SERVER__
119         // Dedicate one core (core 2) to sysserver, might be able to share with NIC
120         num_mgmtcores++;
121         assert(num_cpus >= num_mgmtcores);
122         send_kernel_message(num_mgmtcores-1, (amr_t)arsc_server, 0,0,0, KMSG_ROUTINE);
123  #endif
124         num_idlecores = num_cpus - num_mgmtcores;
125         for (int i = 0; i < num_idlecores; i++)
126                 idlecoremap[i] = i + num_mgmtcores;
127 #endif /* __CONFIG_DISABLE_SMT__ */
128         spin_unlock(&idle_lock);
129         return;
130 }
131
132 /* _S procs are scheduled like in traditional systems */
133 void schedule_scp(struct proc *p)
134 {
135         /* up the refcnt since we are storing the reference */
136         proc_incref(p, 1);
137         spin_lock(&sched_lock);
138         printd("Scheduling PID: %d\n", p->pid);
139         TAILQ_INSERT_TAIL(&runnable_scps, p, proc_link);
140         spin_unlock(&sched_lock);
141 }
142
143 /* important to only call this on RUNNING_S, for now */
144 void register_mcp(struct proc *p)
145 {
146         proc_incref(p, 1);
147         spin_lock(&sched_lock);
148         TAILQ_INSERT_TAIL(&all_mcps, p, proc_link);
149         spin_unlock(&sched_lock);
150         //poke_ksched(p, RES_CORES);
151 }
152
153 /* Something has changed, and for whatever reason the scheduler should
154  * reevaluate things. 
155  *
156  * Don't call this from interrupt context (grabs proclocks). */
157 void schedule(void)
158 {
159         struct proc *p, *temp;
160         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
161         spin_lock(&sched_lock);
162         /* trivially try to handle the needs of all our MCPS.  smarter schedulers
163          * would do something other than FCFS */
164         TAILQ_FOREACH_SAFE(p, &all_mcps, proc_link, temp) {
165                 printd("Ksched has MCP %08p (%d)\n", p, p->pid);
166                 /* If they are dying, abort.  There's a bit of a race here.  If they
167                  * start dying right after the check, core_request/give_cores would
168                  * start dealing with a DYING proc.  The code can handle it, but this
169                  * will probably change. */
170                 if (p->state == PROC_DYING) {
171                         TAILQ_REMOVE(&all_mcps, p, proc_link);
172                         proc_decref(p);
173                         continue;
174                 }
175                 if (!num_idlecores)
176                         break;
177                 /* TODO: might use amt_wanted as a proxy.  right now, they have
178                  * amt_wanted == 1, even though they are waiting.
179                  * TODO: this is RACY too - just like with DYING. */
180                 if (p->state == PROC_WAITING)
181                         continue;
182                 __core_request(p);
183         }
184         /* prune any dying SCPs at the head of the queue and maybe sched our core */
185         while ((p = TAILQ_FIRST(&runnable_scps))) {
186                 if (p->state == PROC_DYING) {
187                         TAILQ_REMOVE(&runnable_scps, p, proc_link);
188                         proc_decref(p);
189                 } else {
190                         /* check our core to see if we can give it out to an SCP */
191                         if (management_core() && (!pcpui->owning_proc)) {
192                                 TAILQ_REMOVE(&runnable_scps, p, proc_link);
193                                 printd("PID of the SCP i'm running: %d\n", p->pid);
194                                 proc_run_s(p);  /* gives it core we're running on */
195                                 proc_decref(p);
196                         }
197                         break;
198                 }
199         }
200         spin_unlock(&sched_lock);
201 }
202
203 /* A process is asking the ksched to look at its resource desires.  The
204  * scheduler is free to ignore this, for its own reasons, so long as it
205  * eventually gets around to looking at resource desires. */
206 void poke_ksched(struct proc *p, int res_type)
207 {
208         /* TODO: probably want something to trigger all res_types */
209         spin_lock(&sched_lock);
210         switch (res_type) {
211                 case RES_CORES:
212                         /* ignore core requests from non-mcps (note we have races if we ever
213                          * allow procs to switch back). */
214                         if (!__proc_is_mcp(p))
215                                 break;
216                         __core_request(p);
217                         break;
218                 default:
219                         break;
220         }
221         spin_unlock(&sched_lock);
222 }
223
224 /* Helper function to return a core to the idlemap.  It causes some more lock
225  * acquisitions (like in a for loop), but it's a little easier.  Plus, one day
226  * we might be able to do this without locks (for the putting). */
227 void put_idle_core(uint32_t coreid)
228 {
229         spin_lock(&idle_lock);
230         idlecoremap[num_idlecores++] = coreid;
231         spin_unlock(&idle_lock);
232 }
233
234 /* Normally it'll be the max number of CG cores ever */
235 uint32_t max_vcores(struct proc *p)
236 {
237 #ifdef __CONFIG_DISABLE_SMT__
238         return num_cpus >> 1;
239 #else
240         return MAX(1, num_cpus - num_mgmtcores);
241 #endif /* __CONFIG_DISABLE_SMT__ */
242 }
243
244 /* Ghetto helper, just hands out up to 'amt_new' cores (no sense of locality or
245  * anything) */
246 static uint32_t get_idle_cores(struct proc *p, uint32_t *pc_arr,
247                                uint32_t amt_new)
248 {
249         uint32_t num_granted = 0;
250         spin_lock(&idle_lock);
251         for (int i = 0; i < num_idlecores && i < amt_new; i++) {
252                 /* grab the last one on the list */
253                 pc_arr[i] = idlecoremap[num_idlecores - 1];
254                 num_idlecores--;
255                 num_granted++;
256         }
257         spin_unlock(&idle_lock);
258         return num_granted;
259 }
260
261 /* This deals with a request for more cores.  The request is already stored in
262  * the proc's amt_wanted (it is compared to amt_granted). */
263 static void __core_request(struct proc *p)
264 {
265         uint32_t num_granted, amt_wanted, amt_granted;
266         uint32_t corelist[num_cpus];
267
268         /* TODO: consider copy-in for amt_wanted too. */
269         amt_wanted = p->procdata->res_req[RES_CORES].amt_wanted;
270         amt_granted = p->procinfo->res_grant[RES_CORES];
271
272         /* Help them out - if they ask for something impossible, give them 1 so they
273          * can make some progress. (this is racy). */
274         if (amt_wanted > p->procinfo->max_vcores) {
275                 p->procdata->res_req[RES_CORES].amt_wanted = 1;
276         }
277         /* if they are satisfied, we're done.  There's a slight chance they have
278          * cores, but they aren't running (sched gave them cores while they were
279          * yielding, and now we see them on the run queue). */
280         if (amt_wanted <= amt_granted)
281                 return;
282         /* Otherwise, see what they want, and try to give out as many as possible.
283          * Current models are simple - it's just a raw number of cores, and we just
284          * give out what we can. */
285         num_granted = get_idle_cores(p, corelist, amt_wanted - amt_granted);
286         /* Now, actually give them out */
287         if (num_granted) {
288                 /* give them the cores.  this will start up the extras if RUNNING_M. */
289                 spin_lock(&p->proc_lock);
290                 __proc_give_cores(p, corelist, num_granted);
291                 /* at some point after giving cores, call proc_run_m() (harmless on
292                  * RUNNING_Ms).  You can give small groups of cores, then run them
293                  * (which is more efficient than interleaving runs with the gives for
294                  * bulk preempted processes). */
295                 __proc_run_m(p); /* harmless to call this on RUNNING_Ms */
296                 spin_unlock(&p->proc_lock);
297         }
298 }
299
300 /************** Debugging **************/
301 void sched_diag(void)
302 {
303         struct proc *p;
304         TAILQ_FOREACH(p, &runnable_scps, proc_link)
305                 printk("_S PID: %d\n", p->pid);
306         TAILQ_FOREACH(p, &all_mcps, proc_link)
307                 printk("MCP PID: %d\n", p->pid);
308         return;
309 }
310
311 void print_idlecoremap(void)
312 {
313         spin_lock(&idle_lock);
314         printk("There are %d idle cores.\n", num_idlecores);
315         for (int i = 0; i < num_idlecores; i++)
316                 printk("idlecoremap[%d] = %d\n", i, idlecoremap[i]);
317         spin_unlock(&idle_lock);
318 }
319
320 void print_resources(struct proc *p)
321 {
322         printk("--------------------\n");
323         printk("PID: %d\n", p->pid);
324         printk("--------------------\n");
325         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
326                 printk("Res type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
327                        p->procdata->res_req[i].amt_wanted, p->procinfo->res_grant[i]);
328 }
329
330 void print_all_resources(void)
331 {
332         /* Hash helper */
333         void __print_resources(void *item)
334         {
335                 print_resources((struct proc*)item);
336         }
337         spin_lock(&pid_hash_lock);
338         hash_for_each(pid_hash, __print_resources);
339         spin_unlock(&pid_hash_lock);
340 }