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