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