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