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