Fixes list management bug in the ksched
[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 #include <kmalloc.h>
22
23 /* Process Lists.  'unrunnable' is a holding list for SCPs that are running or
24  * waiting or otherwise not considered for sched decisions. */
25 struct proc_list unrunnable_scps = TAILQ_HEAD_INITIALIZER(unrunnable_scps);
26 struct proc_list runnable_scps = TAILQ_HEAD_INITIALIZER(runnable_scps);
27 /* mcp lists.  we actually could get by with one list and a TAILQ_CONCAT, but
28  * I'm expecting to want the flexibility of the pointers later. */
29 struct proc_list all_mcps_1 = TAILQ_HEAD_INITIALIZER(all_mcps_1);
30 struct proc_list all_mcps_2 = TAILQ_HEAD_INITIALIZER(all_mcps_2);
31 struct proc_list *primary_mcps = &all_mcps_1;
32 struct proc_list *secondary_mcps = &all_mcps_2;
33
34 /* The pcores in the system.  (array gets alloced in init()).  */
35 struct sched_pcore *all_pcores;
36
37 /* TAILQ of all unallocated, idle (CG) cores */
38 struct sched_pcore_tailq idlecores = TAILQ_HEAD_INITIALIZER(idlecores);
39
40 /* Helper, defined below */
41 static void __core_request(struct proc *p, uint32_t amt_needed);
42 static void __put_idle_cores(struct proc *p, uint32_t *pc_arr, uint32_t num);
43 static void add_to_list(struct proc *p, struct proc_list *list);
44 static void remove_from_list(struct proc *p, struct proc_list *list);
45 static void switch_lists(struct proc *p, struct proc_list *old,
46                          struct proc_list *new);
47 static uint32_t spc2pcoreid(struct sched_pcore *spc);
48 static struct sched_pcore *pcoreid2spc(uint32_t pcoreid);
49 static bool is_ll_core(uint32_t pcoreid);
50 static void __prov_track_alloc(struct proc *p, uint32_t pcoreid);
51 static void __prov_track_dealloc(struct proc *p, uint32_t pcoreid);
52 static void __prov_track_dealloc_bulk(struct proc *p, uint32_t *pc_arr,
53                                       uint32_t nr_cores);
54 static void __run_mcp_ksched(void *arg);        /* don't call directly */
55 static uint32_t get_cores_needed(struct proc *p);
56
57 /* Locks / sync tools */
58
59 /* poke-style ksched - ensures the MCP ksched only runs once at a time.  since
60  * only one mcp ksched runs at a time, while this is set, the ksched knows no
61  * cores are being allocated by other code (though they could be dealloc, due to
62  * yield). 
63  *
64  * The main value to this sync method is to make the 'make sure the ksched runs
65  * only once at a time and that it actually runs' invariant/desire wait-free, so
66  * that it can be called anywhere (deep event code, etc).
67  *
68  * As the ksched gets smarter, we'll probably embedd this poker in a bigger
69  * struct that can handle the posting of different types of work. */
70 struct poke_tracker ksched_poker = {0, 0, __run_mcp_ksched};
71
72 /* this 'big ksched lock' protects a bunch of things, which i may make fine
73  * grained: */
74 /* - protects the integrity of proc tailqs/structures, as well as the membership
75  * of a proc on those lists.  proc lifetime within the ksched but outside this
76  * lock is protected by the proc kref. */
77 //spinlock_t proclist_lock = SPINLOCK_INITIALIZER; /* subsumed by bksl */
78 /* - protects the provisioning assignment, membership of sched_pcores in
79  * provision lists, and the integrity of all prov lists (the lists of each
80  * proc).  does NOT protect spc->alloc_proc. */
81 //spinlock_t prov_lock = SPINLOCK_INITIALIZER;
82 /* - protects allocation structures: spc->alloc_proc, the integrity and
83  * membership of the idelcores tailq. */
84 //spinlock_t alloc_lock = SPINLOCK_INITIALIZER;
85 spinlock_t sched_lock = SPINLOCK_INITIALIZER;
86
87 /* Alarm struct, for our example 'timer tick' */
88 struct alarm_waiter ksched_waiter;
89
90 #define TIMER_TICK_USEC 10000   /* 10msec */
91
92 /* Helper: Sets up a timer tick on the calling core to go off 10 msec from now.
93  * This assumes the calling core is an LL core, etc. */
94 static void set_ksched_alarm(void)
95 {
96         set_awaiter_rel(&ksched_waiter, TIMER_TICK_USEC);
97         set_alarm(&per_cpu_info[core_id()].tchain, &ksched_waiter);
98 }
99
100 /* Kmsg, to run the scheduler tick (not in interrupt context) and reset the
101  * alarm.  Note that interrupts will be disabled, but this is not the same as
102  * interrupt context.  We're a routine kmsg, which means the core is in a
103  * quiescent state. */
104 static void __ksched_tick(struct trapframe *tf, uint32_t srcid, long a0,
105                           long a1, long a2)
106 {
107         /* TODO: imagine doing some accounting here */
108         schedule();
109         /* Set our alarm to go off, incrementing from our last tick (instead of
110          * setting it relative to now, since some time has passed since the alarm
111          * first went off.  Note, this may be now or in the past! */
112         set_awaiter_inc(&ksched_waiter, TIMER_TICK_USEC);
113         set_alarm(&per_cpu_info[core_id()].tchain, &ksched_waiter);
114 }
115
116 /* Interrupt/alarm handler: tells our core to run the scheduler (out of
117  * interrupt context). */
118 static void __kalarm(struct alarm_waiter *waiter)
119 {
120         send_kernel_message(core_id(), __ksched_tick, 0, 0, 0, KMSG_ROUTINE);
121 }
122
123 void schedule_init(void)
124 {
125         spin_lock(&sched_lock);
126         /* init provisioning stuff */
127         all_pcores = kmalloc(sizeof(struct sched_pcore) * num_cpus, 0);
128         memset(all_pcores, 0, sizeof(struct sched_pcore) * num_cpus);
129         assert(!core_id());             /* want the alarm on core0 for now */
130         init_awaiter(&ksched_waiter, __kalarm);
131         set_ksched_alarm();
132         /* init the idlecore list.  if they turned off hyperthreading, give them the
133          * odds from 1..max-1.  otherwise, give them everything by 0 (default mgmt
134          * core).  TODO: (CG/LL) better LL/CG mgmt */
135 #ifndef __CONFIG_DISABLE_SMT__
136         for (int i = 1; i < num_cpus; i++)
137                 TAILQ_INSERT_TAIL(&idlecores, pcoreid2spc(i), alloc_next);
138 #else
139         assert(!(num_cpus % 2));
140         for (int i = 1; i < num_cpus; i += 2)
141                 TAILQ_INSERT_TAIL(&idlecores, pcoreid2spc(i), alloc_next);
142 #endif /* __CONFIG_DISABLE_SMT__ */
143 #ifdef __CONFIG_ARSC_SERVER__
144         struct sched_pcore *a_core = TAILQ_FIRST(&idlecores);
145         assert(a_core);
146         TAILQ_REMOVE(&idlecores, a_core, alloc_next);
147         send_kernel_message(spc2pcoreid(a_core), (amr_t)arsc_server, 0, 0, 0,
148                             KMSG_ROUTINE);
149         warn("Using core %d for the ARSCs - there are probably issues with this.",
150              spc2pcoreid(a_core));
151 #endif /* __CONFIG_ARSC_SERVER__ */
152         spin_unlock(&sched_lock);
153         return;
154 }
155
156 static uint32_t spc2pcoreid(struct sched_pcore *spc)
157 {
158         return spc - all_pcores;
159 }
160
161 static struct sched_pcore *pcoreid2spc(uint32_t pcoreid)
162 {
163         return &all_pcores[pcoreid];
164 }
165
166 /* Round-robins on whatever list it's on */
167 static void add_to_list(struct proc *p, struct proc_list *new)
168 {
169         assert(!(p->ksched_data.cur_list));
170         TAILQ_INSERT_TAIL(new, p, ksched_data.proc_link);
171         p->ksched_data.cur_list = new;
172 }
173
174 static void remove_from_list(struct proc *p, struct proc_list *old)
175 {
176         assert(p->ksched_data.cur_list == old);
177         TAILQ_REMOVE(old, p, ksched_data.proc_link);
178         p->ksched_data.cur_list = 0;
179 }
180
181 static void switch_lists(struct proc *p, struct proc_list *old,
182                          struct proc_list *new)
183 {
184         remove_from_list(p, old);
185         add_to_list(p, new);
186 }
187
188 /* Removes from whatever list p is on */
189 static void remove_from_any_list(struct proc *p)
190 {
191         if (p->ksched_data.cur_list) {
192                 TAILQ_REMOVE(p->ksched_data.cur_list, p, ksched_data.proc_link);
193                 p->ksched_data.cur_list = 0;
194         }
195 }
196
197 /************** Process Management Callbacks **************/
198 /* a couple notes:
199  * - the proc lock is NOT held for any of these calls.  currently, there is no
200  *   lock ordering between the sched lock and the proc lock.  since the proc
201  *   code doesn't know what we do, it doesn't hold its lock when calling our
202  *   CBs.
203  * - since the proc lock isn't held, the proc could be dying, which means we
204  *   will receive a __sched_proc_destroy() either before or after some of these
205  *   other CBs.  the CBs related to list management need to check and abort if
206  *   DYING */
207 void __sched_proc_register(struct proc *p)
208 {
209         assert(p->state != PROC_DYING); /* shouldn't be abel to happen yet */
210         /* one ref for the proc's existence, cradle-to-grave */
211         proc_incref(p, 1);      /* need at least this OR the 'one for existing' */
212         spin_lock(&sched_lock);
213         TAILQ_INIT(&p->ksched_data.prov_alloc_me);
214         TAILQ_INIT(&p->ksched_data.prov_not_alloc_me);
215         add_to_list(p, &unrunnable_scps);
216         spin_unlock(&sched_lock);
217 }
218
219 /* Returns 0 if it succeeded, an error code otherwise. */
220 void __sched_proc_change_to_m(struct proc *p)
221 {
222         spin_lock(&sched_lock);
223         /* Need to make sure they aren't dying.  if so, we already dealt with their
224          * list membership, etc (or soon will).  taking advantage of the 'immutable
225          * state' of dying (so long as refs are held). */
226         if (p->state == PROC_DYING) {
227                 spin_unlock(&sched_lock);
228                 return;
229         }
230         /* Catch user bugs */
231         if (!p->procdata->res_req[RES_CORES].amt_wanted) {
232                 printk("[kernel] process needs to specify amt_wanted\n");
233                 p->procdata->res_req[RES_CORES].amt_wanted = 1;
234         }
235         /* For now, this should only ever be called on an unrunnable.  It's
236          * probably a bug, at this stage in development, to do o/w. */
237         remove_from_list(p, &unrunnable_scps);
238         //remove_from_any_list(p);      /* ^^ instead of this */
239         add_to_list(p, primary_mcps);
240         spin_unlock(&sched_lock);
241         //poke_ksched(p, RES_CORES);
242 }
243
244 /* Helper for the destroy CB : unprovisions any pcores for the given list */
245 static void unprov_pcore_list(struct sched_pcore_tailq *list_head)
246 {
247         struct sched_pcore *spc_i;
248         /* We can leave them connected within the tailq, since the scps don't have a
249          * default list (if they aren't on a proc's list, then we don't care about
250          * them), and since the INSERTs don't care what list you were on before
251          * (chummy with the implementation).  Pretty sure this is right.  If there's
252          * suspected list corruption, be safer here. */
253         TAILQ_FOREACH(spc_i, list_head, prov_next)
254                 spc_i->prov_proc = 0;
255         TAILQ_INIT(list_head);
256 }
257
258 /* Sched callback called when the proc dies.  pc_arr holds the cores the proc
259  * had, if any, and nr_cores tells us how many are in the array.
260  *
261  * An external, edible ref is passed in.  when we return and they decref,
262  * __proc_free will be called (when the last one is done). */
263 void __sched_proc_destroy(struct proc *p, uint32_t *pc_arr, uint32_t nr_cores)
264 {
265         spin_lock(&sched_lock);
266         /* Unprovision any cores.  Note this is different than track_dealloc.
267          * The latter does bookkeeping when an allocation changes.  This is a
268          * bulk *provisioning* change. */
269         unprov_pcore_list(&p->ksched_data.prov_alloc_me);
270         unprov_pcore_list(&p->ksched_data.prov_not_alloc_me);
271         /* Remove from whatever list we are on (if any - might not be on one if it
272          * was in the middle of __run_mcp_sched) */
273         remove_from_any_list(p);
274         if (nr_cores) {
275                 __put_idle_cores(p, pc_arr, nr_cores);
276                 __prov_track_dealloc_bulk(p, pc_arr, nr_cores);
277         }
278         spin_unlock(&sched_lock);
279         /* Drop the cradle-to-the-grave reference, jet-li */
280         proc_decref(p);
281 }
282
283 /* ksched callbacks.  p just woke up and is UNLOCKED. */
284 void __sched_mcp_wakeup(struct proc *p)
285 {
286         spin_lock(&sched_lock);
287         if (p->state == PROC_DYING) {
288                 spin_unlock(&sched_lock);
289                 return;
290         }
291         /* could try and prioritize p somehow (move it to the front of the list).
292          * for now, just help them out a bit (mild help here, can remove this) */
293         if (!p->procdata->res_req[RES_CORES].amt_wanted)
294                 p->procdata->res_req[RES_CORES].amt_wanted = 1;
295         spin_unlock(&sched_lock);
296         /* note they could be dying at this point too. */
297         poke(&ksched_poker, p);
298 }
299
300 /* ksched callbacks.  p just woke up and is UNLOCKED. */
301 void __sched_scp_wakeup(struct proc *p)
302 {
303         spin_lock(&sched_lock);
304         if (p->state == PROC_DYING) {
305                 spin_unlock(&sched_lock);
306                 return;
307         }
308         /* might not be on a list if it is new.  o/w, it should be unrunnable */
309         remove_from_any_list(p);
310         add_to_list(p, &runnable_scps);
311         spin_unlock(&sched_lock);
312 }
313
314 /* Callback to return a core to the ksched, which tracks it as idle and
315  * deallocated from p.  The proclock is held (__core_req depends on that).
316  *
317  * This also is a trigger, telling us we have more cores.  We could/should make
318  * a scheduling decision (or at least plan to). */
319 void __sched_put_idle_core(struct proc *p, uint32_t coreid)
320 {
321         struct sched_pcore *spc = pcoreid2spc(coreid);
322         spin_lock(&sched_lock);
323         TAILQ_INSERT_TAIL(&idlecores, spc, alloc_next);
324         __prov_track_dealloc(p, coreid);
325         spin_unlock(&sched_lock);
326 }
327
328 /* Helper for put_idle and core_req.  Note this does not track_dealloc.  When we
329  * get rid of / revise proc_preempt_all and put_idle_cores, we can get rid of
330  * this.  (the ksched will never need it - only external callers). */
331 static void __put_idle_cores(struct proc *p, uint32_t *pc_arr, uint32_t num)
332 {
333         struct sched_pcore *spc_i;
334         for (int i = 0; i < num; i++) {
335                 spc_i = pcoreid2spc(pc_arr[i]);
336                 TAILQ_INSERT_TAIL(&idlecores, spc_i, alloc_next);
337         }
338 }
339
340 /* Callback, bulk interface for put_idle.  Note this one also calls track_dealloc,
341  * which the internal version does not.  The proclock is held for this. */
342 void __sched_put_idle_cores(struct proc *p, uint32_t *pc_arr, uint32_t num)
343 {
344         spin_lock(&sched_lock);
345         /* TODO: when we revise this func, look at __put_idle */
346         __put_idle_cores(p, pc_arr, num);
347         __prov_track_dealloc_bulk(p, pc_arr, num);
348         spin_unlock(&sched_lock);
349         /* could trigger a sched decision here */
350 }
351
352 /* mgmt/LL cores should call this to schedule the calling core and give it to an
353  * SCP.  will also prune the dead SCPs from the list.  hold the lock before
354  * calling.  returns TRUE if it scheduled a proc. */
355 static bool __schedule_scp(void)
356 {
357         // TODO: sort out lock ordering (proc_run_s also locks)
358         struct proc *p;
359         uint32_t pcoreid = core_id();
360         struct per_cpu_info *pcpui = &per_cpu_info[pcoreid];
361         int8_t state = 0;
362         /* if there are any runnables, run them here and put any currently running
363          * SCP on the tail of the runnable queue. */
364         if ((p = TAILQ_FIRST(&runnable_scps))) {
365                 /* protect owning proc, cur_tf, etc.  note this nests with the
366                  * calls in proc_yield_s */
367                 disable_irqsave(&state);
368                 /* someone is currently running, dequeue them */
369                 if (pcpui->owning_proc) {
370                         printd("Descheduled %d in favor of %d\n", pcpui->owning_proc->pid,
371                                p->pid);
372                         /* locking just to be safe */
373                         spin_lock(&p->proc_lock);
374                         __proc_set_state(pcpui->owning_proc, PROC_RUNNABLE_S);
375                         __proc_save_context_s(pcpui->owning_proc, pcpui->cur_tf);
376                         spin_unlock(&p->proc_lock);
377                         /* round-robin the SCPs (inserts at the end of the queue) */
378                         switch_lists(pcpui->owning_proc, &unrunnable_scps, &runnable_scps);
379                         clear_owning_proc(pcoreid);
380                         /* Note we abandon core.  It's not strictly necessary.  If
381                          * we didn't, the TLB would still be loaded with the old
382                          * one, til we proc_run_s, and the various paths in
383                          * proc_run_s would pick it up.  This way is a bit safer for
384                          * future changes, but has an extra (empty) TLB flush.  */
385                         abandon_core();
386                 } 
387                 /* Run the new proc */
388                 switch_lists(p, &runnable_scps, &unrunnable_scps);
389                 printd("PID of the SCP i'm running: %d\n", p->pid);
390                 proc_run_s(p);  /* gives it core we're running on */
391                 enable_irqsave(&state);
392                 return TRUE;
393         }
394         return FALSE;
395 }
396
397 /* Returns how many new cores p needs.  This doesn't lock the proc, so your
398  * answer might be stale. */
399 static uint32_t get_cores_needed(struct proc *p)
400 {
401         uint32_t amt_wanted, amt_granted;
402         amt_wanted = p->procdata->res_req[RES_CORES].amt_wanted;
403         /* Help them out - if they ask for something impossible, give them 1 so they
404          * can make some progress. (this is racy, and unnecessary). */
405         if (amt_wanted > p->procinfo->max_vcores) {
406                 p->procdata->res_req[RES_CORES].amt_wanted = 1;
407                 amt_wanted = 1;
408         }
409         /* amt_granted is racy - they could be *yielding*, but currently they can't
410          * be getting any new cores if the caller is in the mcp_ksched.  this is
411          * okay - we won't accidentally give them more cores than they *ever* wanted
412          * (which could crash them), but our answer might be a little stale. */
413         amt_granted = p->procinfo->res_grant[RES_CORES];
414         /* Do not do an assert like this: it could fail (yield in progress): */
415         //assert(amt_granted == p->procinfo->num_vcores);
416         if (amt_wanted <= amt_granted)
417                 return 0;
418         return amt_wanted - amt_granted;
419 }
420
421 /* Actual work of the MCP kscheduler.  if we were called by poke_ksched, *arg
422  * might be the process who wanted special service.  this would be the case if
423  * we weren't already running the ksched.  Sort of a ghetto way to "post work",
424  * such that it's an optimization. */
425 static void __run_mcp_ksched(void *arg)
426 {
427         struct proc *p, *temp;
428         uint32_t amt_needed;
429         struct proc_list *temp_mcp_list;
430         /* locking to protect the MCP lists' integrity and membership */
431         spin_lock(&sched_lock);
432         /* 2-pass scheme: check each proc on the primary list (FCFS).  if they need
433          * nothing, put them on the secondary list.  if they need something, rip
434          * them off the list, service them, and if they are still not dying, put
435          * them on the secondary list.  We cull the entire primary list, so that
436          * when we start from the beginning each time, we aren't repeatedly checking
437          * procs we looked at on previous waves.
438          *
439          * TODO: we could modify this such that procs that we failed to service move
440          * to yet another list or something.  We can also move the WAITINGs to
441          * another list and have wakeup move them back, etc. */
442         while (!TAILQ_EMPTY(primary_mcps)) {
443                 TAILQ_FOREACH_SAFE(p, primary_mcps, ksched_data.proc_link, temp) {
444                         if (p->state == PROC_WAITING) { /* unlocked peek at the state */
445                                 switch_lists(p, primary_mcps, secondary_mcps);
446                                 continue;
447                         }
448                         amt_needed = get_cores_needed(p);
449                         if (!amt_needed) {
450                                 switch_lists(p, primary_mcps, secondary_mcps);
451                                 continue;
452                         }
453                         /* o/w, we want to give cores to this proc */
454                         remove_from_list(p, primary_mcps);
455                         /* now it won't die, but it could get removed from lists and have
456                          * its stuff unprov'd when we unlock */
457                         proc_incref(p, 1);
458                         /* GIANT WARNING: __core_req will unlock the sched lock for a bit.
459                          * It will return with it locked still.  We could unlock before we
460                          * pass in, but they will relock right away. */
461                         // notionally_unlock(&ksched_lock);     /* for mouse-eyed viewers */
462                         __core_request(p, amt_needed);
463                         // notionally_lock(&ksched_lock);
464                         /* Peeking at the state is okay, since we hold a ref.  Once it is
465                          * DYING, it'll remain DYING until we decref.  And if there is a
466                          * concurrent death, that will spin on the ksched lock (which we
467                          * hold, and which protects the proc lists). */
468                         if (p->state != PROC_DYING)
469                                 add_to_list(p, secondary_mcps);
470                         proc_decref(p);                 /* fyi, this may trigger __proc_free */
471                         /* need to break: the proc lists may have changed when we unlocked
472                          * in core_req in ways that the FOREACH_SAFE can't handle. */
473                         break;
474                 }
475         }
476         /* at this point, we moved all the procs over to the secondary list, and
477          * attempted to service the ones that wanted something.  now just swap the
478          * lists for the next invocation of the ksched. */
479         temp_mcp_list = primary_mcps;
480         primary_mcps = secondary_mcps;
481         secondary_mcps = temp_mcp_list;
482         spin_unlock(&sched_lock);
483 }
484
485 /* Something has changed, and for whatever reason the scheduler should
486  * reevaluate things. 
487  *
488  * Don't call this from interrupt context (grabs proclocks). */
489 void schedule(void)
490 {
491         /* MCP scheduling: post work, then poke.  for now, i just want the func to
492          * run again, so merely a poke is sufficient. */
493         poke(&ksched_poker, 0);
494         if (management_core()) {
495                 spin_lock(&sched_lock);
496                 __schedule_scp();
497                 spin_unlock(&sched_lock);
498         }
499 }
500
501 /* A process is asking the ksched to look at its resource desires.  The
502  * scheduler is free to ignore this, for its own reasons, so long as it
503  * eventually gets around to looking at resource desires. */
504 void poke_ksched(struct proc *p, int res_type)
505 {
506         /* ignoring res_type for now.  could post that if we wanted (would need some
507          * other structs/flags) */
508         if (!__proc_is_mcp(p))
509                 return;
510         poke(&ksched_poker, p);
511 }
512
513 /* The calling cpu/core has nothing to do and plans to idle/halt.  This is an
514  * opportunity to pick the nature of that halting (low power state, etc), or
515  * provide some other work (_Ss on LL cores).  Note that interrupts are
516  * disabled, and if you return, the core will cpu_halt(). */
517 void cpu_bored(void)
518 {
519         bool new_proc = FALSE;
520         if (!management_core())
521                 return;
522         spin_lock(&sched_lock);
523         new_proc = __schedule_scp();
524         spin_unlock(&sched_lock);
525         /* if we just scheduled a proc, we need to manually restart it, instead of
526          * returning.  if we return, the core will halt. */
527         if (new_proc) {
528                 proc_restartcore();
529                 assert(0);
530         }
531         /* Could drop into the monitor if there are no processes at all.  For now,
532          * the 'call of the giraffe' suffices. */
533 }
534
535 /* Available resources changed (plus or minus).  Some parts of the kernel may
536  * call this if a particular resource that is 'quantity-based' changes.  Things
537  * like available RAM to processes, bandwidth, etc.  Cores would probably be
538  * inappropriate, since we need to know which specific core is now free. */
539 void avail_res_changed(int res_type, long change)
540 {
541         printk("[kernel] ksched doesn't track any resources yet!\n");
542 }
543
544 /* Normally it'll be the max number of CG cores ever */
545 uint32_t max_vcores(struct proc *p)
546 {
547 /* TODO: (CG/LL) */
548 #ifdef __CONFIG_DISABLE_SMT__
549         return num_cpus >> 1;
550 #else
551         return num_cpus - 1;    /* reserving core 0 */
552 #endif /* __CONFIG_DISABLE_SMT__ */
553 }
554
555 /* This deals with a request for more cores.  The amt of new cores needed is
556  * passed in.  The ksched lock is held, but we are free to unlock if we want
557  * (and we must, if calling out of the ksched to anything high-level).
558  *
559  * Side note: if we want to warn, then we can't deal with this proc's prov'd
560  * cores until we wait til the alarm goes off.  would need to put all
561  * alarmed cores on a list and wait til the alarm goes off to do the full
562  * preempt.  and when those cores come in voluntarily, we'd need to know to
563  * give them to this proc. */
564 static void __core_request(struct proc *p, uint32_t amt_needed)
565 {
566         uint32_t nr_to_grant = 0;
567         uint32_t corelist[num_cpus];
568         struct sched_pcore *spc_i, *temp;
569         struct proc *proc_to_preempt;
570         bool success;
571         /* we come in holding the ksched lock, and we hold it here to protect
572          * allocations and provisioning. */
573         /* get all available cores from their prov_not_alloc list.  the list might
574          * change when we unlock (new cores added to it, or the entire list emptied,
575          * but no core allocations will happen (we hold the poke)). */
576         while (!TAILQ_EMPTY(&p->ksched_data.prov_not_alloc_me)) {
577                 if (nr_to_grant == amt_needed)
578                         break;
579                 /* picking the next victim (first on the not_alloc list) */
580                 spc_i = TAILQ_FIRST(&p->ksched_data.prov_not_alloc_me);
581                 /* someone else has this proc's pcore, so we need to try to preempt.
582                  * after this block, the core will be tracked dealloc'd and on the idle
583                  * list (regardless of whether we had to preempt or not) */
584                 if (spc_i->alloc_proc) {
585                         proc_to_preempt = spc_i->alloc_proc;
586                         /* would break both preemption and maybe the later decref */
587                         assert(proc_to_preempt != p);
588                         /* need to keep a valid, external ref when we unlock */
589                         proc_incref(proc_to_preempt, 1);
590                         spin_unlock(&sched_lock);
591                         /* sending no warning time for now - just an immediate preempt. */
592                         success = proc_preempt_core(proc_to_preempt, spc2pcoreid(spc_i), 0);
593                         /* reaquire locks to protect provisioning and idle lists */
594                         spin_lock(&sched_lock);
595                         if (success) {
596                                 /* we preempted it before the proc could yield or die.
597                                  * alloc_proc should not have changed (it'll change in death and
598                                  * idle CBs).  the core is not on the idle core list.  (if we
599                                  * ever have proc alloc lists, it'll still be on the old proc's
600                                  * list). */
601                                 assert(spc_i->alloc_proc);
602                                 /* regardless of whether or not it is still prov to p, we need
603                                  * to note its dealloc.  we are doing some excessive checking of
604                                  * p == prov_proc, but using this helper is a lot clearer. */
605                                 __prov_track_dealloc(proc_to_preempt, spc2pcoreid(spc_i));
606                                 /* here, we rely on the fact that we are the only preemptor.  we
607                                  * assume no one else preempted it, so we know it is available*/
608                                 TAILQ_INSERT_TAIL(&idlecores, spc_i, alloc_next);
609                         } else {
610                                 /* the preempt failed, which should only happen if the pcore was
611                                  * unmapped (could be dying, could be yielding, but NOT
612                                  * preempted).  whoever unmapped it also triggered (or will soon
613                                  * trigger) a track_dealloc and put it on the idle list.  our
614                                  * signal for this is spc_i->alloc_proc being 0.  We need to
615                                  * spin and let whoever is trying to free the core grab the
616                                  * ksched lock.  We could use an 'ignore_next_idle' flag per
617                                  * sched_pcore, but it's not critical anymore.
618                                  *
619                                  * Note, we're relying on us being the only preemptor - if the
620                                  * core was unmapped by *another* preemptor, there would be no
621                                  * way of knowing the core was made idle *yet* (the success
622                                  * branch in another thread).  likewise, if there were another
623                                  * allocator, the pcore could have been put on the idle list and
624                                  * then quickly removed/allocated. */
625                                 cmb();
626                                 while (spc_i->alloc_proc) {
627                                         /* this loop should be very rare */
628                                         spin_unlock(&sched_lock);
629                                         udelay(1);
630                                         spin_lock(&sched_lock);
631                                 }
632                         }
633                         /* no longer need to keep p_to_pre alive */
634                         proc_decref(proc_to_preempt);
635                         /* might not be prov to p anymore (rare race).  spc_i is idle - we
636                          * might get it later, or maybe we'll give it to its rightful proc*/
637                         if (spc_i->prov_proc != p)
638                                 continue;
639                 }
640                 /* at this point, the pcore is idle, regardless of how we got here
641                  * (successful preempt, failed preempt, or it was idle in the first
642                  * place.  the core is still provisioned.  lets pull from the idle list
643                  * and add it to the pc_arr for p.  here, we rely on the fact that we
644                  * are the only allocator (spc_i is still idle, despite unlocking). */
645                 TAILQ_REMOVE(&idlecores, spc_i, alloc_next);
646                 /* At this point, we have the core, ready to try to give it to the proc.
647                  * It is on no alloc lists, and is track_dealloc'd() (regardless of how
648                  * we got here).
649                  *
650                  * We'll give p its cores via a bulk list, which is better for the proc
651                  * mgmt code (when going from runnable to running). */
652                 corelist[nr_to_grant] = spc2pcoreid(spc_i);
653                 nr_to_grant++;
654                 __prov_track_alloc(p, spc2pcoreid(spc_i));
655         }
656         /* Try to get cores from the idle list that aren't prov to me (FCFS) */
657         TAILQ_FOREACH_SAFE(spc_i, &idlecores, alloc_next, temp) {
658                 if (nr_to_grant == amt_needed)
659                         break;
660                 TAILQ_REMOVE(&idlecores, spc_i, alloc_next);
661                 corelist[nr_to_grant] = spc2pcoreid(spc_i);
662                 nr_to_grant++;
663                 __prov_track_alloc(p, spc2pcoreid(spc_i));
664         }
665         /* Now, actually give them out */
666         if (nr_to_grant) {
667                 /* Need to unlock before calling out to proc code.  We are somewhat
668                  * relying on being the only one allocating 'thread' here, since another
669                  * allocator could have seen these cores (if they are prov to some proc)
670                  * and could be trying to give them out (and assuming they are already
671                  * on the idle list). */
672                 spin_unlock(&sched_lock);
673                 /* give them the cores.  this will start up the extras if RUNNING_M. */
674                 spin_lock(&p->proc_lock);
675                 /* if they fail, it is because they are WAITING or DYING.  we could give
676                  * the cores to another proc or whatever.  for the current type of
677                  * ksched, we'll just put them back on the pile and return.  Note, the
678                  * ksched could check the states after locking, but it isn't necessary:
679                  * just need to check at some point in the ksched loop. */
680                 if (__proc_give_cores(p, corelist, nr_to_grant)) {
681                         spin_unlock(&p->proc_lock);
682                         /* we failed, put the cores and track their dealloc.  lock is
683                          * protecting those structures. */
684                         spin_lock(&sched_lock);
685                         __put_idle_cores(p, corelist, nr_to_grant);
686                         __prov_track_dealloc_bulk(p, corelist, nr_to_grant);
687                 } else {
688                         /* at some point after giving cores, call proc_run_m() (harmless on
689                          * RUNNING_Ms).  You can give small groups of cores, then run them
690                          * (which is more efficient than interleaving runs with the gives
691                          * for bulk preempted processes). */
692                         __proc_run_m(p);
693                         spin_unlock(&p->proc_lock);
694                         /* main mcp_ksched wants this held (it came to __core_req held) */
695                         spin_lock(&sched_lock);
696                 }
697         }
698         /* note the ksched lock is still held */
699 }
700
701 /* TODO: need more thorough CG/LL management.  For now, core0 is the only LL
702  * core.  This won't play well with the ghetto shit in schedule_init() if you do
703  * anything like 'DEDICATED_MONITOR' or the ARSC server.  All that needs an
704  * overhaul. */
705 static bool is_ll_core(uint32_t pcoreid)
706 {
707         if (pcoreid == 0)
708                 return TRUE;
709         return FALSE;
710 }
711
712 /* Helper, makes sure the prov/alloc structures track the pcore properly when it
713  * is allocated to p.  Might make this take a sched_pcore * in the future. */
714 static void __prov_track_alloc(struct proc *p, uint32_t pcoreid)
715 {
716         struct sched_pcore *spc;
717         assert(pcoreid < num_cpus);             /* catch bugs */
718         spc = pcoreid2spc(pcoreid);
719         assert(spc->alloc_proc != p);   /* corruption or double-alloc */
720         spc->alloc_proc = p;
721         /* if the pcore is prov to them and now allocated, move lists */
722         if (spc->prov_proc == p) {
723                 TAILQ_REMOVE(&p->ksched_data.prov_not_alloc_me, spc, prov_next);
724                 TAILQ_INSERT_TAIL(&p->ksched_data.prov_alloc_me, spc, prov_next);
725         }
726 }
727
728 /* Helper, makes sure the prov/alloc structures track the pcore properly when it
729  * is deallocated from p. */
730 static void __prov_track_dealloc(struct proc *p, uint32_t pcoreid)
731 {
732         struct sched_pcore *spc;
733         assert(pcoreid < num_cpus);             /* catch bugs */
734         spc = pcoreid2spc(pcoreid);
735         spc->alloc_proc = 0;
736         /* if the pcore is prov to them and now deallocated, move lists */
737         if (spc->prov_proc == p) {
738                 TAILQ_REMOVE(&p->ksched_data.prov_alloc_me, spc, prov_next);
739                 /* this is the victim list, which can be sorted so that we pick the
740                  * right victim (sort by alloc_proc reverse priority, etc).  In this
741                  * case, the core isn't alloc'd by anyone, so it should be the first
742                  * victim. */
743                 TAILQ_INSERT_HEAD(&p->ksched_data.prov_not_alloc_me, spc, prov_next);
744         }
745 }
746
747 /* Bulk interface for __prov_track_dealloc */
748 static void __prov_track_dealloc_bulk(struct proc *p, uint32_t *pc_arr,
749                                       uint32_t nr_cores)
750 {
751         for (int i = 0; i < nr_cores; i++)
752                 __prov_track_dealloc(p, pc_arr[i]);
753 }
754
755 /* P will get pcore if it needs more cores next time we look at it */
756 void provision_core(struct proc *p, uint32_t pcoreid)
757 {
758         struct sched_pcore *spc;
759         struct sched_pcore_tailq *prov_list;
760         /* Make sure we aren't asking for something that doesn't exist (bounds check
761          * on the pcore array) */
762         if (!(pcoreid < num_cpus))
763                 return; /* could do an error code */
764         /* Don't allow the provisioning of LL cores */
765         if (is_ll_core(pcoreid))
766                 return;
767         spc = pcoreid2spc(pcoreid);
768         /* Note the sched lock protects the spc tailqs for all procs in this code.
769          * If we need a finer grained sched lock, this is one place where we could
770          * have a different lock */
771         spin_lock(&sched_lock);
772         /* If the core is already prov to someone else, take it away.  (last write
773          * wins, some other layer or new func can handle permissions). */
774         if (spc->prov_proc) {
775                 /* the list the spc is on depends on whether it is alloced to the
776                  * prov_proc or not */
777                 prov_list = (spc->alloc_proc == spc->prov_proc ?
778                              &spc->prov_proc->ksched_data.prov_alloc_me :
779                              &spc->prov_proc->ksched_data.prov_not_alloc_me);
780                 TAILQ_REMOVE(prov_list, spc, prov_next);
781         }
782         /* Now prov it to p.  Again, the list it goes on depends on whether it is
783          * alloced to p or not.  Callers can also send in 0 to de-provision. */
784         if (p) {
785                 if (spc->alloc_proc == p) {
786                         TAILQ_INSERT_TAIL(&p->ksched_data.prov_alloc_me, spc, prov_next);
787                 } else {
788                         /* this is be the victim list, which can be sorted so that we pick
789                          * the right victim (sort by alloc_proc reverse priority, etc). */
790                         TAILQ_INSERT_TAIL(&p->ksched_data.prov_not_alloc_me, spc,
791                                           prov_next);
792                 }
793         }
794         spc->prov_proc = p;
795         spin_unlock(&sched_lock);
796 }
797
798 /************** Debugging **************/
799 void sched_diag(void)
800 {
801         struct proc *p;
802         spin_lock(&sched_lock);
803         TAILQ_FOREACH(p, &runnable_scps, ksched_data.proc_link)
804                 printk("Runnable _S PID: %d\n", p->pid);
805         TAILQ_FOREACH(p, &unrunnable_scps, ksched_data.proc_link)
806                 printk("Unrunnable _S PID: %d\n", p->pid);
807         TAILQ_FOREACH(p, primary_mcps, ksched_data.proc_link)
808                 printk("Primary MCP PID: %d\n", p->pid);
809         TAILQ_FOREACH(p, secondary_mcps, ksched_data.proc_link)
810                 printk("Secondary MCP PID: %d\n", p->pid);
811         spin_unlock(&sched_lock);
812         return;
813 }
814
815 void print_idlecoremap(void)
816 {
817         struct sched_pcore *spc_i;
818         /* not locking, so we can look at this without deadlocking. */
819         printk("Idle cores (unlocked!):\n");
820         TAILQ_FOREACH(spc_i, &idlecores, alloc_next)
821                 printk("Core %d, prov to %d (%08p)\n", spc2pcoreid(spc_i),
822                        spc_i->prov_proc ? spc_i->prov_proc->pid : 0, spc_i->prov_proc);
823 }
824
825 void print_resources(struct proc *p)
826 {
827         printk("--------------------\n");
828         printk("PID: %d\n", p->pid);
829         printk("--------------------\n");
830         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
831                 printk("Res type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
832                        p->procdata->res_req[i].amt_wanted, p->procinfo->res_grant[i]);
833 }
834
835 void print_all_resources(void)
836 {
837         /* Hash helper */
838         void __print_resources(void *item)
839         {
840                 print_resources((struct proc*)item);
841         }
842         spin_lock(&pid_hash_lock);
843         hash_for_each(pid_hash, __print_resources);
844         spin_unlock(&pid_hash_lock);
845 }
846
847 void print_prov_map(void)
848 {
849         struct sched_pcore *spc_i;
850         /* Doing this unlocked, which is dangerous, but won't deadlock */
851         printk("Which cores are provisioned to which procs:\n------------------\n");
852         for (int i = 0; i < num_cpus; i++) {
853                 spc_i = pcoreid2spc(i);
854                 printk("Core %02d, prov: %d(%08p) alloc: %d(%08p)\n", i,
855                        spc_i->prov_proc ? spc_i->prov_proc->pid : 0, spc_i->prov_proc,
856                        spc_i->alloc_proc ? spc_i->alloc_proc->pid : 0,
857                        spc_i->alloc_proc);
858         }
859 }
860
861 void print_proc_prov(struct proc *p)
862 {
863         struct sched_pcore *spc_i;
864         if (!p)
865                 return;
866         printk("Prov cores alloced to proc %d (%08p)\n----------\n", p->pid, p);
867         TAILQ_FOREACH(spc_i, &p->ksched_data.prov_alloc_me, prov_next)
868                 printk("Pcore %d\n", spc2pcoreid(spc_i));
869         printk("Prov cores not alloced to proc %d (%08p)\n----------\n", p->pid, p);
870         TAILQ_FOREACH(spc_i, &p->ksched_data.prov_not_alloc_me, prov_next)
871                 printk("Pcore %d (alloced to %d (%08p))\n", spc2pcoreid(spc_i),
872                        spc_i->alloc_proc ? spc_i->alloc_proc->pid : 0,
873                        spc_i->alloc_proc);
874 }