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