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