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