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