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