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