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