MCP ksched doesn't need to hold the lock forever
[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 /* Round-robins on whatever list it's on */
157 static void add_to_list(struct proc *p, struct proc_list *new)
158 {
159         TAILQ_INSERT_TAIL(new, p, ksched_data.proc_link);
160         p->ksched_data.cur_list = new;
161 }
162
163 static void remove_from_list(struct proc *p, struct proc_list *old)
164 {
165         assert(p->ksched_data.cur_list == old);
166         TAILQ_REMOVE(old, p, ksched_data.proc_link);
167 }
168
169 static void switch_lists(struct proc *p, struct proc_list *old,
170                          struct proc_list *new)
171 {
172         remove_from_list(p, old);
173         add_to_list(p, new);
174 }
175
176 static void __remove_from_any_list(struct proc *p)
177 {
178         if (p->ksched_data.cur_list)
179                 TAILQ_REMOVE(p->ksched_data.cur_list, p, ksched_data.proc_link);
180 }
181
182 /* Removes from whatever list p is on */
183 static void remove_from_any_list(struct proc *p)
184 {
185         assert(p->ksched_data.cur_list);
186         TAILQ_REMOVE(p->ksched_data.cur_list, p, ksched_data.proc_link);
187 }
188
189 void register_proc(struct proc *p)
190 {
191         /* one ref for the proc's existence, cradle-to-grave */
192         proc_incref(p, 1);      /* need at least this OR the 'one for existing' */
193         spin_lock(&sched_lock);
194         TAILQ_INIT(&p->ksched_data.prov_alloc_me);
195         TAILQ_INIT(&p->ksched_data.prov_not_alloc_me);
196         add_to_list(p, &unrunnable_scps);
197         spin_unlock(&sched_lock);
198 }
199
200 /* Returns 0 if it succeeded, an error code otherwise. */
201 int proc_change_to_m(struct proc *p)
202 {
203         int retval;
204         spin_lock(&sched_lock);
205         /* Should only be necessary to lock around the change_to_m call.  It's
206          * definitely necessary to hold the sched lock the whole time - need to
207          * atomically change the proc's state and have the ksched take action (and
208          * not squeeze a proc_destroy in there or something). */
209         spin_lock(&p->proc_lock);
210         retval = __proc_change_to_m(p);
211         spin_unlock(&p->proc_lock);
212         if (retval) {
213                 /* Failed for some reason. */
214                 spin_unlock(&sched_lock);
215                 return retval;
216         }
217         /* Catch user bugs */
218         if (!p->procdata->res_req[RES_CORES].amt_wanted) {
219                 printk("[kernel] process needs to specify amt_wanted\n");
220                 p->procdata->res_req[RES_CORES].amt_wanted = 1;
221         }
222         /* For now, this should only ever be called on an unrunnable.  It's
223          * probably a bug, at this stage in development, to do o/w. */
224         remove_from_list(p, &unrunnable_scps);
225         //remove_from_any_list(p);      /* ^^ instead of this */
226         add_to_list(p, primary_mcps);
227         spin_unlock(&sched_lock);
228         //poke_ksched(p, RES_CORES);
229         return retval;
230 }
231
232 /* Makes sure p is runnable.  Callers may spam this, so it needs to handle
233  * repeated calls for the same event.  Callers include event delivery, SCP
234  * yield, and new SCPs.  Most every scheduler should do something like this -
235  * grab whatever lock you have, then call the proc helper. */
236 void proc_wakeup(struct proc *p)
237 {
238         /* catch current shitty deadlock... */
239         assert(!per_cpu_info[core_id()].lock_depth);
240         spin_lock(&sched_lock);
241         /* will trigger one of the __sched_.cp_wakeup()s */
242         __proc_wakeup(p);
243         spin_unlock(&sched_lock);
244 }
245
246 static uint32_t spc2pcoreid(struct sched_pcore *spc)
247 {
248         return spc - all_pcores;
249 }
250
251 static struct sched_pcore *pcoreid2spc(uint32_t pcoreid)
252 {
253         return &all_pcores[pcoreid];
254 }
255
256 /* Helper for proc destroy: unprovisions any pcores for the given list */
257 static void unprov_pcore_list(struct sched_pcore_tailq *list_head)
258 {
259         struct sched_pcore *spc_i;
260         /* We can leave them connected within the tailq, since the scps don't have a
261          * default list (if they aren't on a proc's list, then we don't care about
262          * them), and since the INSERTs don't care what list you were on before
263          * (chummy with the implementation).  Pretty sure this is right.  If there's
264          * suspected list corruption, be safer here. */
265         TAILQ_FOREACH(spc_i, list_head, prov_next)
266                 spc_i->prov_proc = 0;
267         TAILQ_INIT(list_head);
268 }
269
270 /* Destroys the given process.  This may be called from another process, a light
271  * kernel thread (no real process context), asynchronously/cross-core, or from
272  * the process on its own core.
273  *
274  * An external, edible ref is passed in.  when we return and they decref,
275  * __proc_free will be called */
276 void proc_destroy(struct proc *p)
277 {
278         uint32_t nr_cores_revoked = 0;
279         spin_lock(&sched_lock);
280         spin_lock(&p->proc_lock);
281         /* storage for pc_arr is alloced at decl, which is after grabbing the lock*/
282         uint32_t pc_arr[p->procinfo->num_vcores];
283         /* If this returns true, it means we successfully destroyed the proc */
284         if (__proc_destroy(p, pc_arr, &nr_cores_revoked)) {
285                 /* Do our cleanup.  note that proc_free won't run since we have an
286                  * external reference, passed in */
287                 /* Unprovision any cores.  Note this is different than track_dealloc.
288                  * The latter does bookkeeping when an allocation changes.  This is a
289                  * bulk *provisioning* change. */
290                 unprov_pcore_list(&p->ksched_data.prov_alloc_me);
291                 unprov_pcore_list(&p->ksched_data.prov_not_alloc_me);
292                 /* Remove from whatever list we are on */
293                 remove_from_any_list(p);
294                 /* Drop the cradle-to-the-grave reference, jet-li */
295                 proc_decref(p);
296                 if (nr_cores_revoked) {
297                         __put_idle_cores(p, pc_arr, nr_cores_revoked);
298                         __prov_track_dealloc_bulk(p, pc_arr, nr_cores_revoked);
299                 }
300         }
301         spin_unlock(&p->proc_lock);
302         spin_unlock(&sched_lock);
303 }
304
305 /* mgmt/LL cores should call this to schedule the calling core and give it to an
306  * SCP.  will also prune the dead SCPs from the list.  hold the lock before
307  * calling.  returns TRUE if it scheduled a proc. */
308 static bool __schedule_scp(void)
309 {
310         struct proc *p;
311         uint32_t pcoreid = core_id();
312         struct per_cpu_info *pcpui = &per_cpu_info[pcoreid];
313         int8_t state = 0;
314         /* if there are any runnables, run them here and put any currently running
315          * SCP on the tail of the runnable queue. */
316         if ((p = TAILQ_FIRST(&runnable_scps))) {
317                 /* protect owning proc, cur_tf, etc.  note this nests with the
318                  * calls in proc_yield_s */
319                 disable_irqsave(&state);
320                 /* someone is currently running, dequeue them */
321                 if (pcpui->owning_proc) {
322                         printd("Descheduled %d in favor of %d\n", pcpui->owning_proc->pid,
323                                p->pid);
324                         /* locking just to be safe */
325                         spin_lock(&p->proc_lock);
326                         __proc_set_state(pcpui->owning_proc, PROC_RUNNABLE_S);
327                         __proc_save_context_s(pcpui->owning_proc, pcpui->cur_tf);
328                         spin_unlock(&p->proc_lock);
329                         /* round-robin the SCPs (inserts at the end of the queue) */
330                         switch_lists(pcpui->owning_proc, &unrunnable_scps, &runnable_scps);
331                         clear_owning_proc(pcoreid);
332                         /* Note we abandon core.  It's not strictly necessary.  If
333                          * we didn't, the TLB would still be loaded with the old
334                          * one, til we proc_run_s, and the various paths in
335                          * proc_run_s would pick it up.  This way is a bit safer for
336                          * future changes, but has an extra (empty) TLB flush.  */
337                         abandon_core();
338                 } 
339                 /* Run the new proc */
340                 switch_lists(p, &runnable_scps, &unrunnable_scps);
341                 printd("PID of the SCP i'm running: %d\n", p->pid);
342                 proc_run_s(p);  /* gives it core we're running on */
343                 enable_irqsave(&state);
344                 return TRUE;
345         }
346         return FALSE;
347 }
348
349 /* Returns how many new cores p needs.  This doesn't lock the proc, so your
350  * answer might be stale. */
351 static uint32_t get_cores_needed(struct proc *p)
352 {
353         uint32_t amt_wanted, amt_granted;
354         amt_wanted = p->procdata->res_req[RES_CORES].amt_wanted;
355         /* Help them out - if they ask for something impossible, give them 1 so they
356          * can make some progress. (this is racy, and unnecessary). */
357         if (amt_wanted > p->procinfo->max_vcores) {
358                 p->procdata->res_req[RES_CORES].amt_wanted = 1;
359                 amt_wanted = 1;
360         }
361         /* amt_granted is racy - they could be *yielding*, but currently they can't
362          * be getting any new cores if the caller is in the mcp_ksched.  this is
363          * okay - we won't accidentally give them more cores than they *ever* wanted
364          * (which could crash them), but our answer might be a little stale. */
365         amt_granted = p->procinfo->res_grant[RES_CORES];
366         /* Do not do an assert like this: it could fail (yield in progress): */
367         //assert(amt_granted == p->procinfo->num_vcores);
368         if (amt_wanted <= amt_granted)
369                 return 0;
370         return amt_wanted - amt_granted;
371 }
372
373 /* Actual work of the MCP kscheduler.  if we were called by poke_ksched, *arg
374  * might be the process who wanted special service.  this would be the case if
375  * we weren't already running the ksched.  Sort of a ghetto way to "post work",
376  * such that it's an optimization. */
377 static void __run_mcp_ksched(void *arg)
378 {
379         struct proc *p, *temp;
380         uint32_t amt_needed;
381         struct proc_list *temp_mcp_list;
382         /* locking to protect the MCP lists' integrity and membership */
383         spin_lock(&sched_lock);
384         /* 2-pass scheme: check each proc on the primary list (FCFS).  if they need
385          * nothing, put them on the secondary list.  if they need something, rip
386          * them off the list, service them, and if they are still not dying, put
387          * them on the secondary list.  We cull the entire primary list, so that
388          * when we start from the beginning each time, we aren't repeatedly checking
389          * procs we looked at on previous waves.
390          *
391          * TODO: we could modify this such that procs that we failed to service move
392          * to yet another list or something.  We can also move the WAITINGs to
393          * another list and have wakeup move them back, etc. */
394         while (!TAILQ_EMPTY(primary_mcps)) {
395                 TAILQ_FOREACH_SAFE(p, primary_mcps, ksched_data.proc_link, temp) {
396                         if (p->state == PROC_WAITING) { /* unlocked peek at the state */
397                                 switch_lists(p, primary_mcps, secondary_mcps);
398                                 continue;
399                         }
400                         amt_needed = get_cores_needed(p);
401                         if (!amt_needed) {
402                                 switch_lists(p, primary_mcps, secondary_mcps);
403                                 continue;
404                         }
405                         /* o/w, we want to give cores to this proc */
406                         remove_from_list(p, primary_mcps);
407                         /* now it won't die, but it could get removed from lists and have
408                          * its stuff unprov'd when we unlock */
409                         proc_incref(p, 1);
410                         /* GIANT WARNING: __core_req will unlock the sched lock for a bit.
411                          * It will return with it locked still.  We could unlock before we
412                          * pass in, but they will relock right away. */
413                         // notionally_unlock(&ksched_lock);     /* for mouse-eyed viewers */
414                         __core_request(p, amt_needed);
415                         // notionally_lock(&ksched_lock);
416                         /* Peeking at the state is okay, since we hold a ref.  Once it is
417                          * DYING, it'll remain DYING until we decref.  And if there is a
418                          * concurrent death, that will spin on the ksched lock (which we
419                          * hold, and which protects the proc lists). */
420                         if (p->state != PROC_DYING)
421                                 add_to_list(p, secondary_mcps);
422                         proc_decref(p);                 /* fyi, this may trigger __proc_free */
423                         /* need to break: the proc lists may have changed when we unlocked
424                          * in core_req in ways that the FOREACH_SAFE can't handle. */
425                         break;
426                 }
427         }
428         /* at this point, we moved all the procs over to the secondary list, and
429          * attempted to service the ones that wanted something.  now just swap the
430          * lists for the next invocation of the ksched. */
431         temp_mcp_list = primary_mcps;
432         primary_mcps = secondary_mcps;
433         secondary_mcps = temp_mcp_list;
434         spin_unlock(&sched_lock);
435 }
436
437 /* Something has changed, and for whatever reason the scheduler should
438  * reevaluate things. 
439  *
440  * Don't call this from interrupt context (grabs proclocks). */
441 void schedule(void)
442 {
443         /* MCP scheduling: post work, then poke.  for now, i just want the func to
444          * run again, so merely a poke is sufficient. */
445         poke(&ksched_poker, 0);
446         if (management_core()) {
447                 spin_lock(&sched_lock);
448                 __schedule_scp();
449                 spin_unlock(&sched_lock);
450         }
451 }
452
453 /* A process is asking the ksched to look at its resource desires.  The
454  * scheduler is free to ignore this, for its own reasons, so long as it
455  * eventually gets around to looking at resource desires. */
456 void poke_ksched(struct proc *p, int res_type)
457 {
458         /* ignoring res_type for now.  could post that if we wanted (would need some
459          * other structs/flags) */
460         if (!__proc_is_mcp(p))
461                 return;
462         poke(&ksched_poker, p);
463 }
464
465 /* ksched callbacks.  p just woke up, is unlocked, and the ksched lock is held */
466 void __sched_mcp_wakeup(struct proc *p)
467 {
468         /* could try and prioritize p somehow (move it to the front of the list) */
469         poke(&ksched_poker, p);
470 }
471
472 /* ksched callbacks.  p just woke up, is unlocked, and the ksched lock is held */
473 void __sched_scp_wakeup(struct proc *p)
474 {
475         /* might not be on a list if it is new.  o/w, it should be unrunnable */
476         __remove_from_any_list(p);
477         add_to_list(p, &runnable_scps);
478 }
479
480 /* The calling cpu/core has nothing to do and plans to idle/halt.  This is an
481  * opportunity to pick the nature of that halting (low power state, etc), or
482  * provide some other work (_Ss on LL cores).  Note that interrupts are
483  * disabled, and if you return, the core will cpu_halt(). */
484 void cpu_bored(void)
485 {
486         bool new_proc = FALSE;
487         if (!management_core())
488                 return;
489         spin_lock(&sched_lock);
490         new_proc = __schedule_scp();
491         spin_unlock(&sched_lock);
492         /* if we just scheduled a proc, we need to manually restart it, instead of
493          * returning.  if we return, the core will halt. */
494         if (new_proc) {
495                 proc_restartcore();
496                 assert(0);
497         }
498         /* Could drop into the monitor if there are no processes at all.  For now,
499          * the 'call of the giraffe' suffices. */
500 }
501
502 /* Externally called function to return a core to the ksched, which tracks it as
503  * idle and deallocated from p.
504  *
505  * This also is a trigger, telling us we have more cores.  We could/should make
506  * a scheduling decision (or at least plan to). */
507 void put_idle_core(struct proc *p, uint32_t coreid)
508 {
509         struct sched_pcore *spc = pcoreid2spc(coreid);
510         spin_lock(&sched_lock);
511         /* ignore_next_idle gets set if the ksched notices a core is not allocated
512          * before put_idle gets called.  This can happen if the proc yielded the
513          * core while the ksched is holding its lock (protecting lists), and the
514          * proc is spinning on the lock in this function, trying to give it back.
515          * When this happens, the core has already been 'given back', so we ignore
516          * the signal.  We're using a count instead of a bool for cases where this
517          * stacks (would require a change in provisioning, so it shouldn't happen
518          * for now). */
519         if (spc->ignore_next_idle) {
520                 spc->ignore_next_idle--;
521         } else {
522                 TAILQ_INSERT_TAIL(&idlecores, spc, alloc_next);
523                 __prov_track_dealloc(p, coreid);
524         }
525         spin_unlock(&sched_lock);
526 }
527
528 /* Helper for put_idle and core_req.  Note this does not track_dealloc, but it
529  * does handle ignore_next.  When we get rid of / revise proc_preempt_all and
530  * put_idle_cores, we can get rid of this.  (the ksched will never need it -
531  * only external callers). */
532 static void __put_idle_cores(struct proc *p, uint32_t *pc_arr, uint32_t num)
533 {
534         struct sched_pcore *spc_i;
535         for (int i = 0; i < num; i++) {
536                 spc_i = pcoreid2spc(pc_arr[i]);
537                 if (spc_i->ignore_next_idle)
538                         spc_i->ignore_next_idle--;
539                 else
540                         TAILQ_INSERT_TAIL(&idlecores, spc_i, alloc_next);
541         }
542 }
543
544 /* External interface for put_idle.  Note this one also calls track_dealloc,
545  * which the internal version does not. */
546 void put_idle_cores(struct proc *p, uint32_t *pc_arr, uint32_t num)
547 {
548         spin_lock(&sched_lock);
549         /* TODO: when we revise this func, look at __put_idle */
550         __put_idle_cores(p, pc_arr, num);
551         __prov_track_dealloc_bulk(p, pc_arr, num);
552         spin_unlock(&sched_lock);
553         /* could trigger a sched decision here */
554 }
555
556 /* Available resources changed (plus or minus).  Some parts of the kernel may
557  * call this if a particular resource that is 'quantity-based' changes.  Things
558  * like available RAM to processes, bandwidth, etc.  Cores would probably be
559  * inappropriate, since we need to know which specific core is now free. */
560 void avail_res_changed(int res_type, long change)
561 {
562         printk("[kernel] ksched doesn't track any resources yet!\n");
563 }
564
565 /* Normally it'll be the max number of CG cores ever */
566 uint32_t max_vcores(struct proc *p)
567 {
568 /* TODO: (CG/LL) */
569 #ifdef __CONFIG_DISABLE_SMT__
570         return num_cpus >> 1;
571 #else
572         return num_cpus - 1;    /* reserving core 0 */
573 #endif /* __CONFIG_DISABLE_SMT__ */
574 }
575
576 /* This deals with a request for more cores.  The amt of new cores needed is
577  * passed in.  The ksched lock is held, but we are free to unlock if we want
578  * (and we must, if calling out of the ksched to anything high-level). */
579 static void __core_request(struct proc *p, uint32_t amt_needed)
580 {
581         uint32_t nr_to_grant = 0;
582         uint32_t corelist[num_cpus];
583         struct sched_pcore *spc_i, *temp;
584
585         /* Try to give out provisioned cores.  the not_alloc_me list is the victim
586          * list.  Side note: if we want to warn, then we can't deal with this proc's
587          * prov'd cores until we wait til the alarm goes off.  would need to put all
588          * alarmed cores on a list and wait til the alarm goes off to do the full
589          * preempt.  and when those cores come in voluntarily, we'd need to know to
590          * give them to this proc. */
591         TAILQ_FOREACH_SAFE(spc_i, &p->ksched_data.prov_not_alloc_me, prov_next,
592                            temp) {
593                 if (nr_to_grant == amt_needed)
594                         break;
595                 if (spc_i->alloc_proc) {
596                         assert(spc_i->alloc_proc != spc_i->prov_proc);
597                         /* TODO: reverse lock order: proc->ksched */
598                         /* someone else has this proc's pcore, so we need to try to preempt.
599                          * sending no warning time for now - just an immediate preempt. */
600                         if (!proc_preempt_core(spc_i->alloc_proc, spc2pcoreid(spc_i), 0)) {
601                                 /* core is unmapped, they must have just yielded and are
602                                  * spinning in put_idle */
603                                 spc_i->ignore_next_idle++;
604                                 if (spc_i->ignore_next_idle > 100)
605                                         warn("Unusually high ignore_next_idle %d",
606                                              spc_i->ignore_next_idle);
607                         }
608                         /* Note that we do NOT want to __prov_track_dealloc.  Instead, we
609                          * just leave it on its list (which we'll change later), and clear
610                          * alloc_proc (which is what __prov_track_dealloc does). */
611                         spc_i->alloc_proc = 0;
612                 } else {
613                         /* must be an idle core, rip it off that list */
614                         TAILQ_REMOVE(&idlecores, spc_i, alloc_next);
615                 }
616                 /* At this point, we have the core, ready to try to give it to the proc.
617                  * We'll give them via a list, which is better for the proc mgmt code
618                  * (when going from runnable to running. */
619                 corelist[nr_to_grant] = spc2pcoreid(spc_i);
620                 nr_to_grant++;
621         }
622         /* Try to get cores from the idle list that aren't prov to me (FCFS) */
623         TAILQ_FOREACH_SAFE(spc_i, &idlecores, alloc_next, temp) {
624                 if (nr_to_grant == amt_needed)
625                         break;
626                 TAILQ_REMOVE(&idlecores, spc_i, alloc_next);
627                 corelist[nr_to_grant] = spc2pcoreid(spc_i);
628                 nr_to_grant++;
629         }
630         /* TODO: reverse lock order: proc->ksched */
631         /* Now, actually give them out */
632         if (nr_to_grant) {
633                 /* give them the cores.  this will start up the extras if RUNNING_M. */
634                 spin_lock(&p->proc_lock);
635                 /* if they fail, it is because they are WAITING or DYING.  we could give
636                  * the cores to another proc or whatever.  for the current type of
637                  * ksched, we'll just put them back on the pile and return.  Note, the
638                  * ksched could check the states after locking, but it isn't necessary:
639                  * just need to check at some point in the ksched loop. */
640                 if (__proc_give_cores(p, corelist, nr_to_grant)) {
641                         __put_idle_cores(p, corelist, nr_to_grant);
642                 } else {
643                         /* track the (successful) allocation of the sched_pcores */
644                         for (int i = 0; i < nr_to_grant; i++)
645                                 __prov_track_alloc(p, corelist[i]);
646                         /* at some point after giving cores, call proc_run_m() (harmless on
647                          * RUNNING_Ms).  You can give small groups of cores, then run them
648                          * (which is more efficient than interleaving runs with the gives
649                          * for bulk preempted processes). */
650                         __proc_run_m(p);
651                 }
652                 spin_unlock(&p->proc_lock);
653         }
654 }
655
656 /* TODO: need more thorough CG/LL management.  For now, core0 is the only LL
657  * core.  This won't play well with the ghetto shit in schedule_init() if you do
658  * anything like 'DEDICATED_MONITOR' or the ARSC server.  All that needs an
659  * overhaul. */
660 static bool is_ll_core(uint32_t pcoreid)
661 {
662         if (pcoreid == 0)
663                 return TRUE;
664         return FALSE;
665 }
666
667 /* Helper, makes sure the prov/alloc structures track the pcore properly when it
668  * is allocated to p.  Might make this take a sched_pcore * in the future. */
669 static void __prov_track_alloc(struct proc *p, uint32_t pcoreid)
670 {
671         struct sched_pcore *spc;
672         assert(pcoreid < num_cpus);             /* catch bugs */
673         spc = pcoreid2spc(pcoreid);
674         assert(spc->alloc_proc != p);   /* corruption or double-alloc */
675         spc->alloc_proc = p;
676         /* if the pcore is prov to them and now allocated, move lists */
677         if (spc->prov_proc == p) {
678                 TAILQ_REMOVE(&p->ksched_data.prov_not_alloc_me, spc, prov_next);
679                 TAILQ_INSERT_TAIL(&p->ksched_data.prov_alloc_me, spc, prov_next);
680         }
681 }
682
683 /* Helper, makes sure the prov/alloc structures track the pcore properly when it
684  * is deallocated from p. */
685 static void __prov_track_dealloc(struct proc *p, uint32_t pcoreid)
686 {
687         struct sched_pcore *spc;
688         assert(pcoreid < num_cpus);             /* catch bugs */
689         spc = pcoreid2spc(pcoreid);
690         spc->alloc_proc = 0;
691         /* if the pcore is prov to them and now deallocated, move lists */
692         if (spc->prov_proc == p) {
693                 TAILQ_REMOVE(&p->ksched_data.prov_alloc_me, spc, prov_next);
694                 /* this is the victim list, which can be sorted so that we pick the
695                  * right victim (sort by alloc_proc reverse priority, etc).  In this
696                  * case, the core isn't alloc'd by anyone, so it should be the first
697                  * victim. */
698                 TAILQ_INSERT_HEAD(&p->ksched_data.prov_not_alloc_me, spc, prov_next);
699         }
700 }
701
702 /* Bulk interface for __prov_track_dealloc */
703 static void __prov_track_dealloc_bulk(struct proc *p, uint32_t *pc_arr,
704                                       uint32_t nr_cores)
705 {
706         for (int i = 0; i < nr_cores; i++)
707                 __prov_track_dealloc(p, pc_arr[i]);
708 }
709
710 /* P will get pcore if it needs more cores next time we look at it */
711 void provision_core(struct proc *p, uint32_t pcoreid)
712 {
713         struct sched_pcore *spc;
714         struct sched_pcore_tailq *prov_list;
715         /* Make sure we aren't asking for something that doesn't exist (bounds check
716          * on the pcore array) */
717         if (!(pcoreid < num_cpus))
718                 return; /* could do an error code */
719         /* Don't allow the provisioning of LL cores */
720         if (is_ll_core(pcoreid))
721                 return;
722         spc = pcoreid2spc(pcoreid);
723         /* Note the sched lock protects the spc tailqs for all procs in this code.
724          * If we need a finer grained sched lock, this is one place where we could
725          * have a different lock */
726         spin_lock(&sched_lock);
727         /* If the core is already prov to someone else, take it away.  (last write
728          * wins, some other layer or new func can handle permissions). */
729         if (spc->prov_proc) {
730                 /* the list the spc is on depends on whether it is alloced to the
731                  * prov_proc or not */
732                 prov_list = (spc->alloc_proc == spc->prov_proc ?
733                              &spc->prov_proc->ksched_data.prov_alloc_me :
734                              &spc->prov_proc->ksched_data.prov_not_alloc_me);
735                 TAILQ_REMOVE(prov_list, spc, prov_next);
736         }
737         /* Now prov it to p.  Again, the list it goes on depends on whether it is
738          * alloced to p or not.  Callers can also send in 0 to de-provision. */
739         if (p) {
740                 if (spc->alloc_proc == p) {
741                         TAILQ_INSERT_TAIL(&p->ksched_data.prov_alloc_me, spc, prov_next);
742                 } else {
743                         /* this is be the victim list, which can be sorted so that we pick
744                          * the right victim (sort by alloc_proc reverse priority, etc). */
745                         TAILQ_INSERT_TAIL(&p->ksched_data.prov_not_alloc_me, spc,
746                                           prov_next);
747                 }
748         }
749         spc->prov_proc = p;
750         spin_unlock(&sched_lock);
751 }
752
753 /************** Debugging **************/
754 void sched_diag(void)
755 {
756         struct proc *p;
757         spin_lock(&sched_lock);
758         TAILQ_FOREACH(p, &runnable_scps, ksched_data.proc_link)
759                 printk("Runnable _S PID: %d\n", p->pid);
760         TAILQ_FOREACH(p, &unrunnable_scps, ksched_data.proc_link)
761                 printk("Unrunnable _S PID: %d\n", p->pid);
762         TAILQ_FOREACH(p, primary_mcps, ksched_data.proc_link)
763                 printk("Primary MCP PID: %d\n", p->pid);
764         TAILQ_FOREACH(p, secondary_mcps, ksched_data.proc_link)
765                 printk("Secondary MCP PID: %d\n", p->pid);
766         spin_unlock(&sched_lock);
767         return;
768 }
769
770 void print_idlecoremap(void)
771 {
772         struct sched_pcore *spc_i;
773         /* not locking, so we can look at this without deadlocking. */
774         printk("Idle cores (unlocked!):\n");
775         TAILQ_FOREACH(spc_i, &idlecores, alloc_next)
776                 printk("Core %d, prov to %d (%08p)\n", spc2pcoreid(spc_i),
777                        spc_i->prov_proc ? spc_i->prov_proc->pid : 0, spc_i->prov_proc);
778 }
779
780 void print_resources(struct proc *p)
781 {
782         printk("--------------------\n");
783         printk("PID: %d\n", p->pid);
784         printk("--------------------\n");
785         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
786                 printk("Res type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
787                        p->procdata->res_req[i].amt_wanted, p->procinfo->res_grant[i]);
788 }
789
790 void print_all_resources(void)
791 {
792         /* Hash helper */
793         void __print_resources(void *item)
794         {
795                 print_resources((struct proc*)item);
796         }
797         spin_lock(&pid_hash_lock);
798         hash_for_each(pid_hash, __print_resources);
799         spin_unlock(&pid_hash_lock);
800 }
801
802 void print_prov_map(void)
803 {
804         struct sched_pcore *spc_i;
805         /* Doing this unlocked, which is dangerous, but won't deadlock */
806         printk("Which cores are provisioned to which procs:\n------------------\n");
807         for (int i = 0; i < num_cpus; i++) {
808                 spc_i = pcoreid2spc(i);
809                 printk("Core %02d, prov: %d(%08p) alloc: %d(%08p)\n", i,
810                        spc_i->prov_proc ? spc_i->prov_proc->pid : 0, spc_i->prov_proc,
811                        spc_i->alloc_proc ? spc_i->alloc_proc->pid : 0,
812                        spc_i->alloc_proc);
813         }
814 }
815
816 void print_proc_prov(struct proc *p)
817 {
818         struct sched_pcore *spc_i;
819         if (!p)
820                 return;
821         printk("Prov cores alloced to proc %d (%08p)\n----------\n", p->pid, p);
822         TAILQ_FOREACH(spc_i, &p->ksched_data.prov_alloc_me, prov_next)
823                 printk("Pcore %d\n", spc2pcoreid(spc_i));
824         printk("Prov cores not alloced to proc %d (%08p)\n----------\n", p->pid, p);
825         TAILQ_FOREACH(spc_i, &p->ksched_data.prov_not_alloc_me, prov_next)
826                 printk("Pcore %d (alloced to %d (%08p))\n", spc2pcoreid(spc_i),
827                        spc_i->alloc_proc ? spc_i->alloc_proc->pid : 0,
828                        spc_i->alloc_proc);
829 }