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