Kernel scheduler tracks procs 'cradle to grave'
[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.  'unrunnable' is a holding list for SCPs that are running or
23  * waiting or otherwise not considered for sched decisions. */
24 struct proc_list unrunnable_scps = TAILQ_HEAD_INITIALIZER(unrunnable_scps);
25 struct proc_list runnable_scps = TAILQ_HEAD_INITIALIZER(runnable_scps);
26 struct proc_list all_mcps = TAILQ_HEAD_INITIALIZER(all_mcps);
27 spinlock_t sched_lock = SPINLOCK_INITIALIZER;
28
29 // This could be useful for making scheduling decisions.  
30 /* Physical coremap: each index is a physical core id, with a proc ptr for
31  * whoever *should be or is* running.  Very similar to current, which is what
32  * process is *really* running there. */
33 struct proc *pcoremap[MAX_NUM_CPUS];
34
35 /* Tracks which cores are idle, similar to the vcoremap.  Each value is the
36  * physical coreid of an unallocated core. */
37 spinlock_t idle_lock = SPINLOCK_INITIALIZER;
38 uint32_t idlecoremap[MAX_NUM_CPUS];
39 uint32_t num_idlecores = 0;
40 uint32_t num_mgmtcores = 1;
41
42 /* Helper, defined below */
43 static void __core_request(struct proc *p);
44 static void __put_idle_cores(uint32_t *pc_arr, uint32_t num);
45 static void add_to_list(struct proc *p, struct proc_list *list);
46 static void remove_from_list(struct proc *p, struct proc_list *list);
47 static void switch_lists(struct proc *p, struct proc_list *old,
48                          struct proc_list *new);
49
50 /* Alarm struct, for our example 'timer tick' */
51 struct alarm_waiter ksched_waiter;
52
53 #define TIMER_TICK_USEC 10000   /* 10msec */
54
55 /* Helper: Sets up a timer tick on the calling core to go off 10 msec from now.
56  * This assumes the calling core is an LL core, etc. */
57 static void set_ksched_alarm(void)
58 {
59         set_awaiter_rel(&ksched_waiter, TIMER_TICK_USEC);
60         set_alarm(&per_cpu_info[core_id()].tchain, &ksched_waiter);
61 }
62
63 /* Kmsg, to run the scheduler tick (not in interrupt context) and reset the
64  * alarm.  Note that interrupts will be disabled, but this is not the same as
65  * interrupt context.  We're a routine kmsg, which means the core is in a
66  * quiescent state. */
67 static void __ksched_tick(struct trapframe *tf, uint32_t srcid, long a0,
68                           long a1, long a2)
69 {
70         /* TODO: imagine doing some accounting here */
71         schedule();
72         /* Set our alarm to go off, incrementing from our last tick (instead of
73          * setting it relative to now, since some time has passed since the alarm
74          * first went off.  Note, this may be now or in the past! */
75         set_awaiter_inc(&ksched_waiter, TIMER_TICK_USEC);
76         set_alarm(&per_cpu_info[core_id()].tchain, &ksched_waiter);
77 }
78
79 /* Interrupt/alarm handler: tells our core to run the scheduler (out of
80  * interrupt context). */
81 static void __kalarm(struct alarm_waiter *waiter)
82 {
83         send_kernel_message(core_id(), __ksched_tick, 0, 0, 0, KMSG_ROUTINE);
84 }
85
86 void schedule_init(void)
87 {
88         TAILQ_INIT(&runnable_scps);
89         TAILQ_INIT(&all_mcps);
90         assert(!core_id());             /* want the alarm on core0 for now */
91         init_awaiter(&ksched_waiter, __kalarm);
92         set_ksched_alarm();
93
94         /* Ghetto old idle core init */
95         /* Init idle cores. Core 0 is the management core. */
96         spin_lock(&idle_lock);
97 #ifdef __CONFIG_DISABLE_SMT__
98         /* assumes core0 is the only management core (NIC and monitor functionality
99          * are run there too.  it just adds the odd cores to the idlecoremap */
100         assert(!(num_cpus % 2));
101         // TODO: consider checking x86 for machines that actually hyperthread
102         num_idlecores = num_cpus >> 1;
103  #ifdef __CONFIG_ARSC_SERVER__
104         // Dedicate one core (core 2) to sysserver, might be able to share wit NIC
105         num_mgmtcores++;
106         assert(num_cpus >= num_mgmtcores);
107         send_kernel_message(2, (amr_t)arsc_server, 0,0,0, KMSG_ROUTINE);
108  #endif
109         for (int i = 0; i < num_idlecores; i++)
110                 idlecoremap[i] = (i * 2) + 1;
111 #else
112         // __CONFIG_DISABLE_SMT__
113         #ifdef __CONFIG_NETWORKING__
114         num_mgmtcores++; // Next core is dedicated to the NIC
115         assert(num_cpus >= num_mgmtcores);
116         #endif
117         #ifdef __CONFIG_APPSERVER__
118         #ifdef __CONFIG_DEDICATED_MONITOR__
119         num_mgmtcores++; // Next core dedicated to running the kernel monitor
120         assert(num_cpus >= num_mgmtcores);
121         // Need to subtract 1 from the num_mgmtcores # to get the cores index
122         send_kernel_message(num_mgmtcores-1, (amr_t)monitor, 0,0,0, KMSG_ROUTINE);
123         #endif
124         #endif
125  #ifdef __CONFIG_ARSC_SERVER__
126         // Dedicate one core (core 2) to sysserver, might be able to share with NIC
127         num_mgmtcores++;
128         assert(num_cpus >= num_mgmtcores);
129         send_kernel_message(num_mgmtcores-1, (amr_t)arsc_server, 0,0,0, KMSG_ROUTINE);
130  #endif
131         num_idlecores = num_cpus - num_mgmtcores;
132         for (int i = 0; i < num_idlecores; i++)
133                 idlecoremap[i] = i + num_mgmtcores;
134 #endif /* __CONFIG_DISABLE_SMT__ */
135         spin_unlock(&idle_lock);
136         return;
137 }
138
139 /* Round-robins on whatever list it's on */
140 static void add_to_list(struct proc *p, struct proc_list *new)
141 {
142         TAILQ_INSERT_TAIL(new, p, ksched_data.proc_link);
143         p->ksched_data.cur_list = new;
144 }
145
146 static void remove_from_list(struct proc *p, struct proc_list *old)
147 {
148         assert(p->ksched_data.cur_list == old);
149         TAILQ_REMOVE(old, p, ksched_data.proc_link);
150 }
151
152 static void switch_lists(struct proc *p, struct proc_list *old,
153                          struct proc_list *new)
154 {
155         remove_from_list(p, old);
156         add_to_list(p, new);
157 }
158
159 /* Removes from whatever list p is on */
160 static void remove_from_any_list(struct proc *p)
161 {
162         assert(p->ksched_data.cur_list);
163         TAILQ_REMOVE(p->ksched_data.cur_list, p, ksched_data.proc_link);
164 }
165
166 void register_proc(struct proc *p)
167 {
168         /* one ref for the proc's existence, cradle-to-grave */
169         proc_incref(p, 1);      /* need at least this OR the 'one for existing' */
170         spin_lock(&sched_lock);
171         add_to_list(p, &unrunnable_scps);
172         spin_unlock(&sched_lock);
173 }
174
175 /* TODO: the proc lock is currently held for sched and register */
176 /* sched_scp tells us to try and run the scp
177  * TODO: change this horrible name */
178 void schedule_scp(struct proc *p)
179 {
180         spin_lock(&sched_lock);
181         printd("Scheduling PID: %d\n", p->pid);
182         switch_lists(p, &unrunnable_scps, &runnable_scps);
183         spin_unlock(&sched_lock);
184 }
185
186 /* Tells us the proc is now an mcp.  Assuming it was RUNNING before */
187 /* TODO: the proc lock is currently held for sched and register */
188 void register_mcp(struct proc *p)
189 {
190         spin_lock(&sched_lock);
191         /* For now, this should only ever be called on an unrunnable.  It's probably
192          * a bug, at this stage in development, to do o/w. */
193         remove_from_list(p, &unrunnable_scps);
194         //remove_from_any_list(p);      /* ^^ instead of this */
195         add_to_list(p, &all_mcps);
196         spin_unlock(&sched_lock);
197         //poke_ksched(p, RES_CORES);
198 }
199
200 /* Destroys the given process.  This may be called from another process, a light
201  * kernel thread (no real process context), asynchronously/cross-core, or from
202  * the process on its own core.
203  *
204  * An external, edible ref is passed in.  when we return and they decref,
205  * __proc_free will be called */
206 void proc_destroy(struct proc *p)
207 {
208         uint32_t nr_cores_revoked = 0;
209         spin_lock(&sched_lock);
210         spin_lock(&p->proc_lock);
211         /* storage for pc_arr is alloced at decl, which is after grabbing the lock*/
212         uint32_t pc_arr[p->procinfo->num_vcores];
213         /* If this returns true, it means we successfully destroyed the proc */
214         if (__proc_destroy(p, pc_arr, &nr_cores_revoked)) {
215                 /* Do our cleanup.  note that proc_free won't run since we have an
216                  * external reference, passed in */
217
218                 /* Remove from whatever list we are on */
219                 remove_from_any_list(p);
220                 /* Drop the cradle-to-the-grave reference, jet-li */
221                 proc_decref(p);
222                 /* Put the cores back on the idlecore map.  For future changes, be
223                  * careful with the idle_lock.  It's safe to call this here or outside
224                  * the sched lock (for now). */
225                 if (nr_cores_revoked) 
226                         put_idle_cores(pc_arr, nr_cores_revoked);
227         }
228         spin_unlock(&p->proc_lock);
229         spin_unlock(&sched_lock);
230 }
231
232 /* mgmt/LL cores should call this to schedule the calling core and give it to an
233  * SCP.  will also prune the dead SCPs from the list.  hold the lock before
234  * calling.  returns TRUE if it scheduled a proc. */
235 static bool __schedule_scp(void)
236 {
237         struct proc *p;
238         uint32_t pcoreid = core_id();
239         struct per_cpu_info *pcpui = &per_cpu_info[pcoreid];
240         int8_t state = 0;
241         /* if there are any runnables, run them here and put any currently running
242          * SCP on the tail of the runnable queue. */
243         if ((p = TAILQ_FIRST(&runnable_scps))) {
244                 /* protect owning proc, cur_tf, etc.  note this nests with the
245                  * calls in proc_yield_s */
246                 disable_irqsave(&state);
247                 /* someone is currently running, dequeue them */
248                 if (pcpui->owning_proc) {
249                         printd("Descheduled %d in favor of %d\n", pcpui->owning_proc->pid,
250                                p->pid);
251                         __proc_yield_s(pcpui->owning_proc, pcpui->cur_tf);
252                         /* round-robin the SCPs (inserts at the end of the queue) */
253                         switch_lists(pcpui->owning_proc, &unrunnable_scps, &runnable_scps);
254                         clear_owning_proc(pcoreid);
255                         /* Note we abandon core.  It's not strictly necessary.  If
256                          * we didn't, the TLB would still be loaded with the old
257                          * one, til we proc_run_s, and the various paths in
258                          * proc_run_s would pick it up.  This way is a bit safer for
259                          * future changes, but has an extra (empty) TLB flush.  */
260                         abandon_core();
261                 } 
262                 /* Run the new proc */
263                 switch_lists(p, &runnable_scps, &unrunnable_scps);
264                 printd("PID of the SCP i'm running: %d\n", p->pid);
265                 proc_run_s(p);  /* gives it core we're running on */
266                 enable_irqsave(&state);
267                 return TRUE;
268         }
269         return FALSE;
270 }
271
272 /* Something has changed, and for whatever reason the scheduler should
273  * reevaluate things. 
274  *
275  * Don't call this from interrupt context (grabs proclocks). */
276 void schedule(void)
277 {
278         struct proc *p, *temp;
279         spin_lock(&sched_lock);
280         /* trivially try to handle the needs of all our MCPS.  smarter schedulers
281          * would do something other than FCFS */
282         TAILQ_FOREACH_SAFE(p, &all_mcps, ksched_data.proc_link, temp) {
283                 printd("Ksched has MCP %08p (%d)\n", p, p->pid);
284                 if (!num_idlecores)
285                         break;
286                 /* TODO: might use amt_wanted as a proxy.  right now, they have
287                  * amt_wanted == 1, even though they are waiting.
288                  * TODO: this is RACY too - just like with DYING. */
289                 if (p->state == PROC_WAITING)
290                         continue;
291                 __core_request(p);
292         }
293         if (management_core())
294                 __schedule_scp();
295         spin_unlock(&sched_lock);
296 }
297
298 /* A process is asking the ksched to look at its resource desires.  The
299  * scheduler is free to ignore this, for its own reasons, so long as it
300  * eventually gets around to looking at resource desires. */
301 void poke_ksched(struct proc *p, int res_type)
302 {
303         /* TODO: probably want something to trigger all res_types */
304         spin_lock(&sched_lock);
305         switch (res_type) {
306                 case RES_CORES:
307                         /* ignore core requests from non-mcps (note we have races if we ever
308                          * allow procs to switch back). */
309                         if (!__proc_is_mcp(p))
310                                 break;
311                         __core_request(p);
312                         break;
313                 default:
314                         break;
315         }
316         spin_unlock(&sched_lock);
317 }
318
319 /* Proc p just woke up (due to an event).  Our dumb ksched will just try to deal
320  * with its core desires. 
321  * TODO: this may get called multiple times per unblock */
322 void ksched_proc_unblocked(struct proc *p)
323 {
324         /* TODO: this now gets called when an _S unblocks.  schedule_scp() also gets
325          * called, so the process is on the _S runqueue.  Might merge the two in the
326          * future. */
327         poke_ksched(p, RES_CORES);
328 }
329
330 /* The calling cpu/core has nothing to do and plans to idle/halt.  This is an
331  * opportunity to pick the nature of that halting (low power state, etc), or
332  * provide some other work (_Ss on LL cores).  Note that interrupts are
333  * disabled, and if you return, the core will cpu_halt(). */
334 void cpu_bored(void)
335 {
336         bool new_proc = FALSE;
337         if (!management_core())
338                 return;
339         spin_lock(&sched_lock);
340         new_proc = __schedule_scp();
341         spin_unlock(&sched_lock);
342         /* if we just scheduled a proc, we need to manually restart it, instead of
343          * returning.  if we return, the core will halt. */
344         if (new_proc) {
345                 proc_restartcore();
346                 assert(0);
347         }
348         /* Could drop into the monitor if there are no processes at all.  For now,
349          * the 'call of the giraffe' suffices. */
350 }
351
352 /* Helper function to return a core to the idlemap.  It causes some more lock
353  * acquisitions (like in a for loop), but it's a little easier.  Plus, one day
354  * we might be able to do this without locks (for the putting).
355  *
356  * This is a trigger, telling us we have more cores.  We could/should make a
357  * scheduling decision (or at least plan to). */
358 void put_idle_core(uint32_t coreid)
359 {
360         spin_lock(&idle_lock);
361         idlecoremap[num_idlecores++] = coreid;
362         spin_unlock(&idle_lock);
363 }
364
365 /* Helper for put_idle and core_req. */
366 static void __put_idle_cores(uint32_t *pc_arr, uint32_t num)
367 {
368         spin_lock(&idle_lock);
369         for (int i = 0; i < num; i++)
370                 idlecoremap[num_idlecores++] = pc_arr[i];
371         spin_unlock(&idle_lock);
372 }
373
374 /* Bulk interface for put_idle */
375 void put_idle_cores(uint32_t *pc_arr, uint32_t num)
376 {
377         /* could trigger a sched decision here */
378         __put_idle_cores(pc_arr, num);
379 }
380
381 /* Available resources changed (plus or minus).  Some parts of the kernel may
382  * call this if a particular resource that is 'quantity-based' changes.  Things
383  * like available RAM to processes, bandwidth, etc.  Cores would probably be
384  * inappropriate, since we need to know which specific core is now free. */
385 void avail_res_changed(int res_type, long change)
386 {
387         printk("[kernel] ksched doesn't track any resources yet!\n");
388 }
389
390 /* Normally it'll be the max number of CG cores ever */
391 uint32_t max_vcores(struct proc *p)
392 {
393 #ifdef __CONFIG_DISABLE_SMT__
394         return num_cpus >> 1;
395 #else
396         return MAX(1, num_cpus - num_mgmtcores);
397 #endif /* __CONFIG_DISABLE_SMT__ */
398 }
399
400 /* Ghetto helper, just hands out up to 'amt_new' cores (no sense of locality or
401  * anything) */
402 static uint32_t get_idle_cores(struct proc *p, uint32_t *pc_arr,
403                                uint32_t amt_new)
404 {
405         uint32_t num_granted = 0;
406         spin_lock(&idle_lock);
407         for (int i = 0; i < num_idlecores && i < amt_new; i++) {
408                 /* grab the last one on the list */
409                 pc_arr[i] = idlecoremap[num_idlecores - 1];
410                 num_idlecores--;
411                 num_granted++;
412         }
413         spin_unlock(&idle_lock);
414         return num_granted;
415 }
416
417 /* This deals with a request for more cores.  The request is already stored in
418  * the proc's amt_wanted (it is compared to amt_granted). */
419 static void __core_request(struct proc *p)
420 {
421         uint32_t num_granted, amt_wanted, amt_granted;
422         uint32_t corelist[num_cpus];
423
424         /* TODO: consider copy-in for amt_wanted too. */
425         amt_wanted = p->procdata->res_req[RES_CORES].amt_wanted;
426         amt_granted = p->procinfo->res_grant[RES_CORES];
427
428         /* Help them out - if they ask for something impossible, give them 1 so they
429          * can make some progress. (this is racy). */
430         if (amt_wanted > p->procinfo->max_vcores) {
431                 p->procdata->res_req[RES_CORES].amt_wanted = 1;
432         }
433         /* if they are satisfied, we're done.  There's a slight chance they have
434          * cores, but they aren't running (sched gave them cores while they were
435          * yielding, and now we see them on the run queue). */
436         if (amt_wanted <= amt_granted)
437                 return;
438         /* Otherwise, see what they want, and try to give out as many as possible.
439          * Current models are simple - it's just a raw number of cores, and we just
440          * give out what we can. */
441         num_granted = get_idle_cores(p, corelist, amt_wanted - amt_granted);
442         /* Now, actually give them out */
443         if (num_granted) {
444                 /* give them the cores.  this will start up the extras if RUNNING_M. */
445                 spin_lock(&p->proc_lock);
446                 /* if they fail, it is because they are WAITING or DYING.  we could give
447                  * the cores to another proc or whatever.  for the current type of
448                  * ksched, we'll just put them back on the pile and return.  Note, the
449                  * ksched could check the states after locking, but it isn't necessary:
450                  * just need to check at some point in the ksched loop. */
451                 if (__proc_give_cores(p, corelist, num_granted)) {
452                         __put_idle_cores(corelist, num_granted);
453                 } else {
454                         /* at some point after giving cores, call proc_run_m() (harmless on
455                          * RUNNING_Ms).  You can give small groups of cores, then run them
456                          * (which is more efficient than interleaving runs with the gives
457                          * for bulk preempted processes). */
458                         __proc_run_m(p);
459                 }
460                 spin_unlock(&p->proc_lock);
461         }
462 }
463
464 /************** Debugging **************/
465 void sched_diag(void)
466 {
467         struct proc *p;
468         spin_lock(&sched_lock);
469         TAILQ_FOREACH(p, &runnable_scps, ksched_data.proc_link)
470                 printk("Runnable _S PID: %d\n", p->pid);
471         TAILQ_FOREACH(p, &unrunnable_scps, ksched_data.proc_link)
472                 printk("Unrunnable _S PID: %d\n", p->pid);
473         TAILQ_FOREACH(p, &all_mcps, ksched_data.proc_link)
474                 printk("MCP PID: %d\n", p->pid);
475         spin_unlock(&sched_lock);
476         return;
477 }
478
479 void print_idlecoremap(void)
480 {
481         spin_lock(&idle_lock);
482         printk("There are %d idle cores.\n", num_idlecores);
483         for (int i = 0; i < num_idlecores; i++)
484                 printk("idlecoremap[%d] = %d\n", i, idlecoremap[i]);
485         spin_unlock(&idle_lock);
486 }
487
488 void print_resources(struct proc *p)
489 {
490         printk("--------------------\n");
491         printk("PID: %d\n", p->pid);
492         printk("--------------------\n");
493         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
494                 printk("Res type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
495                        p->procdata->res_req[i].amt_wanted, p->procinfo->res_grant[i]);
496 }
497
498 void print_all_resources(void)
499 {
500         /* Hash helper */
501         void __print_resources(void *item)
502         {
503                 print_resources((struct proc*)item);
504         }
505         spin_lock(&pid_hash_lock);
506         hash_for_each(pid_hash, __print_resources);
507         spin_unlock(&pid_hash_lock);
508 }