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