Event delivery to _S procs
[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
22 /* Process Lists */
23 struct proc_list runnable_scps = TAILQ_HEAD_INITIALIZER(runnable_scps);
24 struct proc_list all_mcps = TAILQ_HEAD_INITIALIZER(all_mcps);
25 spinlock_t sched_lock = SPINLOCK_INITIALIZER;
26
27 // This could be useful for making scheduling decisions.  
28 /* Physical coremap: each index is a physical core id, with a proc ptr for
29  * whoever *should be or is* running.  Very similar to current, which is what
30  * process is *really* running there. */
31 struct proc *pcoremap[MAX_NUM_CPUS];
32
33 /* Tracks which cores are idle, similar to the vcoremap.  Each value is the
34  * physical coreid of an unallocated core. */
35 spinlock_t idle_lock = SPINLOCK_INITIALIZER;
36 uint32_t idlecoremap[MAX_NUM_CPUS];
37 uint32_t num_idlecores = 0;
38 uint32_t num_mgmtcores = 1;
39
40 /* Helper, defined below */
41 static void __core_request(struct proc *p);
42 static void __put_idle_cores(uint32_t *pc_arr, uint32_t num);
43
44 /* Alarm struct, for our example 'timer tick' */
45 struct alarm_waiter ksched_waiter;
46
47 #define TIMER_TICK_USEC 10000   /* 10msec */
48
49 /* Helper: Sets up a timer tick on the calling core to go off 10 msec from now.
50  * This assumes the calling core is an LL core, etc. */
51 static void set_ksched_alarm(void)
52 {
53         set_awaiter_rel(&ksched_waiter, TIMER_TICK_USEC);
54         set_alarm(&per_cpu_info[core_id()].tchain, &ksched_waiter);
55 }
56
57 /* Kmsg, to run the scheduler tick (not in interrupt context) and reset the
58  * alarm.  Note that interrupts will be disabled, but this is not the same as
59  * interrupt context.  We're a routine kmsg, which means the core is in a
60  * quiescent state. */
61 static void __ksched_tick(struct trapframe *tf, uint32_t srcid, long a0,
62                           long a1, long a2)
63 {
64         /* TODO: imagine doing some accounting here */
65         schedule();
66         /* Set our alarm to go off, incrementing from our last tick (instead of
67          * setting it relative to now, since some time has passed since the alarm
68          * first went off.  Note, this may be now or in the past! */
69         set_awaiter_inc(&ksched_waiter, TIMER_TICK_USEC);
70         set_alarm(&per_cpu_info[core_id()].tchain, &ksched_waiter);
71 }
72
73 /* Interrupt/alarm handler: tells our core to run the scheduler (out of
74  * interrupt context). */
75 static void __kalarm(struct alarm_waiter *waiter)
76 {
77         send_kernel_message(core_id(), __ksched_tick, 0, 0, 0, KMSG_ROUTINE);
78 }
79
80 void schedule_init(void)
81 {
82         TAILQ_INIT(&runnable_scps);
83         TAILQ_INIT(&all_mcps);
84         assert(!core_id());             /* want the alarm on core0 for now */
85         init_awaiter(&ksched_waiter, __kalarm);
86         set_ksched_alarm();
87
88         /* Ghetto old idle core init */
89         /* Init idle cores. Core 0 is the management core. */
90         spin_lock(&idle_lock);
91 #ifdef __CONFIG_DISABLE_SMT__
92         /* assumes core0 is the only management core (NIC and monitor functionality
93          * are run there too.  it just adds the odd cores to the idlecoremap */
94         assert(!(num_cpus % 2));
95         // TODO: consider checking x86 for machines that actually hyperthread
96         num_idlecores = num_cpus >> 1;
97  #ifdef __CONFIG_ARSC_SERVER__
98         // Dedicate one core (core 2) to sysserver, might be able to share wit NIC
99         num_mgmtcores++;
100         assert(num_cpus >= num_mgmtcores);
101         send_kernel_message(2, (amr_t)arsc_server, 0,0,0, KMSG_ROUTINE);
102  #endif
103         for (int i = 0; i < num_idlecores; i++)
104                 idlecoremap[i] = (i * 2) + 1;
105 #else
106         // __CONFIG_DISABLE_SMT__
107         #ifdef __CONFIG_NETWORKING__
108         num_mgmtcores++; // Next core is dedicated to the NIC
109         assert(num_cpus >= num_mgmtcores);
110         #endif
111         #ifdef __CONFIG_APPSERVER__
112         #ifdef __CONFIG_DEDICATED_MONITOR__
113         num_mgmtcores++; // Next core dedicated to running the kernel monitor
114         assert(num_cpus >= num_mgmtcores);
115         // Need to subtract 1 from the num_mgmtcores # to get the cores index
116         send_kernel_message(num_mgmtcores-1, (amr_t)monitor, 0,0,0, KMSG_ROUTINE);
117         #endif
118         #endif
119  #ifdef __CONFIG_ARSC_SERVER__
120         // Dedicate one core (core 2) to sysserver, might be able to share with NIC
121         num_mgmtcores++;
122         assert(num_cpus >= num_mgmtcores);
123         send_kernel_message(num_mgmtcores-1, (amr_t)arsc_server, 0,0,0, KMSG_ROUTINE);
124  #endif
125         num_idlecores = num_cpus - num_mgmtcores;
126         for (int i = 0; i < num_idlecores; i++)
127                 idlecoremap[i] = i + num_mgmtcores;
128 #endif /* __CONFIG_DISABLE_SMT__ */
129         spin_unlock(&idle_lock);
130         return;
131 }
132
133 /* TODO: the proc lock is currently held for sched and register, though not
134  * currently in any situations that can deadlock */
135 /* _S procs are scheduled like in traditional systems */
136 void schedule_scp(struct proc *p)
137 {
138         /* up the refcnt since we are storing the reference */
139         proc_incref(p, 1);
140         spin_lock(&sched_lock);
141         printd("Scheduling PID: %d\n", p->pid);
142         TAILQ_INSERT_TAIL(&runnable_scps, p, proc_link);
143         spin_unlock(&sched_lock);
144 }
145
146 /* important to only call this on RUNNING_S, for now */
147 void register_mcp(struct proc *p)
148 {
149         proc_incref(p, 1);
150         spin_lock(&sched_lock);
151         TAILQ_INSERT_TAIL(&all_mcps, p, proc_link);
152         spin_unlock(&sched_lock);
153         //poke_ksched(p, RES_CORES);
154 }
155
156 /* Something has changed, and for whatever reason the scheduler should
157  * reevaluate things. 
158  *
159  * Don't call this from interrupt context (grabs proclocks). */
160 void schedule(void)
161 {
162         struct proc *p, *temp;
163         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
164         spin_lock(&sched_lock);
165         /* trivially try to handle the needs of all our MCPS.  smarter schedulers
166          * would do something other than FCFS */
167         TAILQ_FOREACH_SAFE(p, &all_mcps, proc_link, temp) {
168                 printd("Ksched has MCP %08p (%d)\n", p, p->pid);
169                 /* If they are dying, abort.  There's a bit of a race here.  If they
170                  * start dying right after the check, core_request/give_cores would
171                  * start dealing with a DYING proc.  The code can handle it, but this
172                  * will probably change. */
173                 if (p->state == PROC_DYING) {
174                         TAILQ_REMOVE(&all_mcps, p, proc_link);
175                         proc_decref(p);
176                         continue;
177                 }
178                 if (!num_idlecores)
179                         break;
180                 /* TODO: might use amt_wanted as a proxy.  right now, they have
181                  * amt_wanted == 1, even though they are waiting.
182                  * TODO: this is RACY too - just like with DYING. */
183                 if (p->state == PROC_WAITING)
184                         continue;
185                 __core_request(p);
186         }
187         /* prune any dying SCPs at the head of the queue and maybe sched our core */
188         while ((p = TAILQ_FIRST(&runnable_scps))) {
189                 if (p->state == PROC_DYING) {
190                         TAILQ_REMOVE(&runnable_scps, p, proc_link);
191                         proc_decref(p);
192                 } else {
193                         /* check our core to see if we can give it out to an SCP */
194                         if (management_core() && (!pcpui->owning_proc)) {
195                                 TAILQ_REMOVE(&runnable_scps, p, proc_link);
196                                 printd("PID of the SCP i'm running: %d\n", p->pid);
197                                 proc_run_s(p);  /* gives it core we're running on */
198                                 proc_decref(p);
199                         }
200                         break;
201                 }
202         }
203         spin_unlock(&sched_lock);
204 }
205
206 /* A process is asking the ksched to look at its resource desires.  The
207  * scheduler is free to ignore this, for its own reasons, so long as it
208  * eventually gets around to looking at resource desires. */
209 void poke_ksched(struct proc *p, int res_type)
210 {
211         /* TODO: probably want something to trigger all res_types */
212         spin_lock(&sched_lock);
213         switch (res_type) {
214                 case RES_CORES:
215                         /* ignore core requests from non-mcps (note we have races if we ever
216                          * allow procs to switch back). */
217                         if (!__proc_is_mcp(p))
218                                 break;
219                         __core_request(p);
220                         break;
221                 default:
222                         break;
223         }
224         spin_unlock(&sched_lock);
225 }
226
227 /* Proc p just woke up (due to an event).  Our dumb ksched will just try to deal
228  * with its core desires. */
229 void ksched_proc_unblocked(struct proc *p)
230 {
231         /* TODO: this now gets called when an _S unblocks.  schedule_scp() also gets
232          * called, so the process is on the _S runqueue.  Might merge the two in the
233          * future. */
234         poke_ksched(p, RES_CORES);
235 }
236
237 /* The calling cpu/core has nothing to do and plans to idle/halt.  This is an
238  * opportunity to pick the nature of that halting (low power state, etc), or
239  * provide some other work (_Ss on LL cores).  Note that interrupts are
240  * disabled, and if you return, the core will cpu_halt(). */
241 void cpu_bored(void)
242 {
243         if (!management_core())
244                 return;
245         /* TODO: something smart.  For now, do what smp_idle did */
246         manager();
247         assert(0);
248         /* TODO run a process, and if none exist at all and we're core 0, bring up
249          * the monitor/manager */
250 }
251
252 /* Helper function to return a core to the idlemap.  It causes some more lock
253  * acquisitions (like in a for loop), but it's a little easier.  Plus, one day
254  * we might be able to do this without locks (for the putting).
255  *
256  * This is a trigger, telling us we have more cores.  We could/should make a
257  * scheduling decision (or at least plan to). */
258 void put_idle_core(uint32_t coreid)
259 {
260         spin_lock(&idle_lock);
261         idlecoremap[num_idlecores++] = coreid;
262         spin_unlock(&idle_lock);
263 }
264
265 /* Helper for put_idle and core_req. */
266 static void __put_idle_cores(uint32_t *pc_arr, uint32_t num)
267 {
268         spin_lock(&idle_lock);
269         for (int i = 0; i < num; i++)
270                 idlecoremap[num_idlecores++] = pc_arr[i];
271         spin_unlock(&idle_lock);
272 }
273
274 /* Bulk interface for put_idle */
275 void put_idle_cores(uint32_t *pc_arr, uint32_t num)
276 {
277         /* could trigger a sched decision here */
278         __put_idle_cores(pc_arr, num);
279 }
280
281 /* Available resources changed (plus or minus).  Some parts of the kernel may
282  * call this if a particular resource that is 'quantity-based' changes.  Things
283  * like available RAM to processes, bandwidth, etc.  Cores would probably be
284  * inappropriate, since we need to know which specific core is now free. */
285 void avail_res_changed(int res_type, long change)
286 {
287         printk("[kernel] ksched doesn't track any resources yet!\n");
288 }
289
290 /* Normally it'll be the max number of CG cores ever */
291 uint32_t max_vcores(struct proc *p)
292 {
293 #ifdef __CONFIG_DISABLE_SMT__
294         return num_cpus >> 1;
295 #else
296         return MAX(1, num_cpus - num_mgmtcores);
297 #endif /* __CONFIG_DISABLE_SMT__ */
298 }
299
300 /* Ghetto helper, just hands out up to 'amt_new' cores (no sense of locality or
301  * anything) */
302 static uint32_t get_idle_cores(struct proc *p, uint32_t *pc_arr,
303                                uint32_t amt_new)
304 {
305         uint32_t num_granted = 0;
306         spin_lock(&idle_lock);
307         for (int i = 0; i < num_idlecores && i < amt_new; i++) {
308                 /* grab the last one on the list */
309                 pc_arr[i] = idlecoremap[num_idlecores - 1];
310                 num_idlecores--;
311                 num_granted++;
312         }
313         spin_unlock(&idle_lock);
314         return num_granted;
315 }
316
317 /* This deals with a request for more cores.  The request is already stored in
318  * the proc's amt_wanted (it is compared to amt_granted). */
319 static void __core_request(struct proc *p)
320 {
321         uint32_t num_granted, amt_wanted, amt_granted;
322         uint32_t corelist[num_cpus];
323
324         /* TODO: consider copy-in for amt_wanted too. */
325         amt_wanted = p->procdata->res_req[RES_CORES].amt_wanted;
326         amt_granted = p->procinfo->res_grant[RES_CORES];
327
328         /* Help them out - if they ask for something impossible, give them 1 so they
329          * can make some progress. (this is racy). */
330         if (amt_wanted > p->procinfo->max_vcores) {
331                 p->procdata->res_req[RES_CORES].amt_wanted = 1;
332         }
333         /* if they are satisfied, we're done.  There's a slight chance they have
334          * cores, but they aren't running (sched gave them cores while they were
335          * yielding, and now we see them on the run queue). */
336         if (amt_wanted <= amt_granted)
337                 return;
338         /* Otherwise, see what they want, and try to give out as many as possible.
339          * Current models are simple - it's just a raw number of cores, and we just
340          * give out what we can. */
341         num_granted = get_idle_cores(p, corelist, amt_wanted - amt_granted);
342         /* Now, actually give them out */
343         if (num_granted) {
344                 /* give them the cores.  this will start up the extras if RUNNING_M. */
345                 spin_lock(&p->proc_lock);
346                 /* if they fail, it is because they are WAITING or DYING.  we could give
347                  * the cores to another proc or whatever.  for the current type of
348                  * ksched, we'll just put them back on the pile and return.  Note, the
349                  * ksched could check the states after locking, but it isn't necessary:
350                  * just need to check at some point in the ksched loop. */
351                 if (__proc_give_cores(p, corelist, num_granted)) {
352                         __put_idle_cores(corelist, num_granted);
353                 } else {
354                         /* at some point after giving cores, call proc_run_m() (harmless on
355                          * RUNNING_Ms).  You can give small groups of cores, then run them
356                          * (which is more efficient than interleaving runs with the gives
357                          * for bulk preempted processes). */
358                         __proc_run_m(p);
359                 }
360                 spin_unlock(&p->proc_lock);
361         }
362 }
363
364 /************** Debugging **************/
365 void sched_diag(void)
366 {
367         struct proc *p;
368         TAILQ_FOREACH(p, &runnable_scps, proc_link)
369                 printk("_S PID: %d\n", p->pid);
370         TAILQ_FOREACH(p, &all_mcps, proc_link)
371                 printk("MCP PID: %d\n", p->pid);
372         return;
373 }
374
375 void print_idlecoremap(void)
376 {
377         spin_lock(&idle_lock);
378         printk("There are %d idle cores.\n", num_idlecores);
379         for (int i = 0; i < num_idlecores; i++)
380                 printk("idlecoremap[%d] = %d\n", i, idlecoremap[i]);
381         spin_unlock(&idle_lock);
382 }
383
384 void print_resources(struct proc *p)
385 {
386         printk("--------------------\n");
387         printk("PID: %d\n", p->pid);
388         printk("--------------------\n");
389         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
390                 printk("Res type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
391                        p->procdata->res_req[i].amt_wanted, p->procinfo->res_grant[i]);
392 }
393
394 void print_all_resources(void)
395 {
396         /* Hash helper */
397         void __print_resources(void *item)
398         {
399                 print_resources((struct proc*)item);
400         }
401         spin_lock(&pid_hash_lock);
402         hash_for_each(pid_hash, __print_resources);
403         spin_unlock(&pid_hash_lock);
404 }