proc_destroy() now starts in the ksched
[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 /* Destroys the given process.  This may be called from another process, a light
157  * kernel thread (no real process context), asynchronously/cross-core, or from
158  * the process on its own core.
159  *
160  * An external, edible ref is passed in.  when we return and they decref,
161  * __proc_free will be called */
162 void proc_destroy(struct proc *p)
163 {
164         uint32_t nr_cores_revoked = 0;
165         spin_lock(&sched_lock);
166         spin_lock(&p->proc_lock);
167         /* storage for pc_arr is alloced at decl, which is after grabbing the lock*/
168         uint32_t pc_arr[p->procinfo->num_vcores];
169         /* If this returns true, it means we successfully destroyed the proc */
170         if (__proc_destroy(p, pc_arr, &nr_cores_revoked)) {
171                 /* Do our cleanup.  note that proc_free won't run since we have an
172                  * external reference, passed in */
173                 /* TODO: pull from lists (no list polling), free structs, etc. */
174
175                 /* Put the cores back on the idlecore map.  For future changes, be
176                  * careful with the idle_lock.  It's safe to call this here or outside
177                  * the sched lock (for now). */
178                 if (nr_cores_revoked) 
179                         put_idle_cores(pc_arr, nr_cores_revoked);
180         }
181         spin_unlock(&p->proc_lock);
182         spin_unlock(&sched_lock);
183 }
184
185 /* mgmt/LL cores should call this to schedule the calling core and give it to an
186  * SCP.  will also prune the dead SCPs from the list.  hold the lock before
187  * calling.  returns TRUE if it scheduled a proc. */
188 static bool __schedule_scp(void)
189 {
190         struct proc *p;
191         uint32_t pcoreid = core_id();
192         struct per_cpu_info *pcpui = &per_cpu_info[pcoreid];
193         int8_t state = 0;
194         /* prune any dying SCPs at the head of the queue and maybe sched our core
195          * (let all the cores do this, whoever happens to be running schedule()). */
196         while ((p = TAILQ_FIRST(&runnable_scps))) {
197                 if (p->state == PROC_DYING) {
198                         TAILQ_REMOVE(&runnable_scps, p, proc_link);
199                         proc_decref(p);
200                 } else {
201                         /* protect owning proc, cur_tf, etc.  note this nests with the
202                          * calls in proc_yield_s */
203                         disable_irqsave(&state);
204                         /* someone is currently running, dequeue them */
205                         if (pcpui->owning_proc) {
206                                 printd("Descheduled %d in favor of %d\n",
207                                        pcpui->owning_proc->pid, p->pid);
208                                 __proc_yield_s(pcpui->owning_proc, pcpui->cur_tf);
209                                 /* round-robin the SCPs */
210                                 TAILQ_INSERT_TAIL(&runnable_scps, pcpui->owning_proc,
211                                                   proc_link);
212                                 /* could optimize the refcnting if we cared */
213                                 proc_incref(pcpui->owning_proc, 1);
214                                 clear_owning_proc(pcoreid);
215                                 /* Note we abandon core.  It's not strictly necessary.  If
216                                  * we didn't, the TLB would still be loaded with the old
217                                  * one, til we proc_run_s, and the various paths in
218                                  * proc_run_s would pick it up.  This way is a bit safer for
219                                  * future changes, but has an extra (empty) TLB flush.  */
220                                 abandon_core();
221                         } 
222                         /* Run the new proc */
223                         TAILQ_REMOVE(&runnable_scps, p, proc_link);
224                         printd("PID of the SCP i'm running: %d\n", p->pid);
225                         proc_run_s(p);  /* gives it core we're running on */
226                         proc_decref(p);
227                         enable_irqsave(&state);
228                         return TRUE;
229                 }
230         }
231         return FALSE;
232 }
233
234 /* Something has changed, and for whatever reason the scheduler should
235  * reevaluate things. 
236  *
237  * Don't call this from interrupt context (grabs proclocks). */
238 void schedule(void)
239 {
240         struct proc *p, *temp;
241         spin_lock(&sched_lock);
242         /* trivially try to handle the needs of all our MCPS.  smarter schedulers
243          * would do something other than FCFS */
244         TAILQ_FOREACH_SAFE(p, &all_mcps, proc_link, temp) {
245                 printd("Ksched has MCP %08p (%d)\n", p, p->pid);
246                 /* If they are dying, abort.  There's a bit of a race here.  If they
247                  * start dying right after the check, core_request/give_cores would
248                  * start dealing with a DYING proc.  The code can handle it, but this
249                  * will probably change. */
250                 if (p->state == PROC_DYING) {
251                         TAILQ_REMOVE(&all_mcps, p, proc_link);
252                         proc_decref(p);
253                         continue;
254                 }
255                 if (!num_idlecores)
256                         break;
257                 /* TODO: might use amt_wanted as a proxy.  right now, they have
258                  * amt_wanted == 1, even though they are waiting.
259                  * TODO: this is RACY too - just like with DYING. */
260                 if (p->state == PROC_WAITING)
261                         continue;
262                 __core_request(p);
263         }
264         if (management_core())
265                 __schedule_scp();
266         spin_unlock(&sched_lock);
267 }
268
269 /* A process is asking the ksched to look at its resource desires.  The
270  * scheduler is free to ignore this, for its own reasons, so long as it
271  * eventually gets around to looking at resource desires. */
272 void poke_ksched(struct proc *p, int res_type)
273 {
274         /* TODO: probably want something to trigger all res_types */
275         spin_lock(&sched_lock);
276         switch (res_type) {
277                 case RES_CORES:
278                         /* ignore core requests from non-mcps (note we have races if we ever
279                          * allow procs to switch back). */
280                         if (!__proc_is_mcp(p))
281                                 break;
282                         __core_request(p);
283                         break;
284                 default:
285                         break;
286         }
287         spin_unlock(&sched_lock);
288 }
289
290 /* Proc p just woke up (due to an event).  Our dumb ksched will just try to deal
291  * with its core desires. 
292  * TODO: this may get called multiple times per unblock */
293 void ksched_proc_unblocked(struct proc *p)
294 {
295         /* TODO: this now gets called when an _S unblocks.  schedule_scp() also gets
296          * called, so the process is on the _S runqueue.  Might merge the two in the
297          * future. */
298         poke_ksched(p, RES_CORES);
299 }
300
301 /* The calling cpu/core has nothing to do and plans to idle/halt.  This is an
302  * opportunity to pick the nature of that halting (low power state, etc), or
303  * provide some other work (_Ss on LL cores).  Note that interrupts are
304  * disabled, and if you return, the core will cpu_halt(). */
305 void cpu_bored(void)
306 {
307         bool new_proc = FALSE;
308         if (!management_core())
309                 return;
310         spin_lock(&sched_lock);
311         new_proc = __schedule_scp();
312         spin_unlock(&sched_lock);
313         /* if we just scheduled a proc, we need to manually restart it, instead of
314          * returning.  if we return, the core will halt. */
315         if (new_proc) {
316                 proc_restartcore();
317                 assert(0);
318         }
319         /* Could drop into the monitor if there are no processes at all.  For now,
320          * the 'call of the giraffe' suffices. */
321 }
322
323 /* Helper function to return a core to the idlemap.  It causes some more lock
324  * acquisitions (like in a for loop), but it's a little easier.  Plus, one day
325  * we might be able to do this without locks (for the putting).
326  *
327  * This is a trigger, telling us we have more cores.  We could/should make a
328  * scheduling decision (or at least plan to). */
329 void put_idle_core(uint32_t coreid)
330 {
331         spin_lock(&idle_lock);
332         idlecoremap[num_idlecores++] = coreid;
333         spin_unlock(&idle_lock);
334 }
335
336 /* Helper for put_idle and core_req. */
337 static void __put_idle_cores(uint32_t *pc_arr, uint32_t num)
338 {
339         spin_lock(&idle_lock);
340         for (int i = 0; i < num; i++)
341                 idlecoremap[num_idlecores++] = pc_arr[i];
342         spin_unlock(&idle_lock);
343 }
344
345 /* Bulk interface for put_idle */
346 void put_idle_cores(uint32_t *pc_arr, uint32_t num)
347 {
348         /* could trigger a sched decision here */
349         __put_idle_cores(pc_arr, num);
350 }
351
352 /* Available resources changed (plus or minus).  Some parts of the kernel may
353  * call this if a particular resource that is 'quantity-based' changes.  Things
354  * like available RAM to processes, bandwidth, etc.  Cores would probably be
355  * inappropriate, since we need to know which specific core is now free. */
356 void avail_res_changed(int res_type, long change)
357 {
358         printk("[kernel] ksched doesn't track any resources yet!\n");
359 }
360
361 /* Normally it'll be the max number of CG cores ever */
362 uint32_t max_vcores(struct proc *p)
363 {
364 #ifdef __CONFIG_DISABLE_SMT__
365         return num_cpus >> 1;
366 #else
367         return MAX(1, num_cpus - num_mgmtcores);
368 #endif /* __CONFIG_DISABLE_SMT__ */
369 }
370
371 /* Ghetto helper, just hands out up to 'amt_new' cores (no sense of locality or
372  * anything) */
373 static uint32_t get_idle_cores(struct proc *p, uint32_t *pc_arr,
374                                uint32_t amt_new)
375 {
376         uint32_t num_granted = 0;
377         spin_lock(&idle_lock);
378         for (int i = 0; i < num_idlecores && i < amt_new; i++) {
379                 /* grab the last one on the list */
380                 pc_arr[i] = idlecoremap[num_idlecores - 1];
381                 num_idlecores--;
382                 num_granted++;
383         }
384         spin_unlock(&idle_lock);
385         return num_granted;
386 }
387
388 /* This deals with a request for more cores.  The request is already stored in
389  * the proc's amt_wanted (it is compared to amt_granted). */
390 static void __core_request(struct proc *p)
391 {
392         uint32_t num_granted, amt_wanted, amt_granted;
393         uint32_t corelist[num_cpus];
394
395         /* TODO: consider copy-in for amt_wanted too. */
396         amt_wanted = p->procdata->res_req[RES_CORES].amt_wanted;
397         amt_granted = p->procinfo->res_grant[RES_CORES];
398
399         /* Help them out - if they ask for something impossible, give them 1 so they
400          * can make some progress. (this is racy). */
401         if (amt_wanted > p->procinfo->max_vcores) {
402                 p->procdata->res_req[RES_CORES].amt_wanted = 1;
403         }
404         /* if they are satisfied, we're done.  There's a slight chance they have
405          * cores, but they aren't running (sched gave them cores while they were
406          * yielding, and now we see them on the run queue). */
407         if (amt_wanted <= amt_granted)
408                 return;
409         /* Otherwise, see what they want, and try to give out as many as possible.
410          * Current models are simple - it's just a raw number of cores, and we just
411          * give out what we can. */
412         num_granted = get_idle_cores(p, corelist, amt_wanted - amt_granted);
413         /* Now, actually give them out */
414         if (num_granted) {
415                 /* give them the cores.  this will start up the extras if RUNNING_M. */
416                 spin_lock(&p->proc_lock);
417                 /* if they fail, it is because they are WAITING or DYING.  we could give
418                  * the cores to another proc or whatever.  for the current type of
419                  * ksched, we'll just put them back on the pile and return.  Note, the
420                  * ksched could check the states after locking, but it isn't necessary:
421                  * just need to check at some point in the ksched loop. */
422                 if (__proc_give_cores(p, corelist, num_granted)) {
423                         __put_idle_cores(corelist, num_granted);
424                 } else {
425                         /* at some point after giving cores, call proc_run_m() (harmless on
426                          * RUNNING_Ms).  You can give small groups of cores, then run them
427                          * (which is more efficient than interleaving runs with the gives
428                          * for bulk preempted processes). */
429                         __proc_run_m(p);
430                 }
431                 spin_unlock(&p->proc_lock);
432         }
433 }
434
435 /************** Debugging **************/
436 void sched_diag(void)
437 {
438         struct proc *p;
439         TAILQ_FOREACH(p, &runnable_scps, proc_link)
440                 printk("_S PID: %d\n", p->pid);
441         TAILQ_FOREACH(p, &all_mcps, proc_link)
442                 printk("MCP PID: %d\n", p->pid);
443         return;
444 }
445
446 void print_idlecoremap(void)
447 {
448         spin_lock(&idle_lock);
449         printk("There are %d idle cores.\n", num_idlecores);
450         for (int i = 0; i < num_idlecores; i++)
451                 printk("idlecoremap[%d] = %d\n", i, idlecoremap[i]);
452         spin_unlock(&idle_lock);
453 }
454
455 void print_resources(struct proc *p)
456 {
457         printk("--------------------\n");
458         printk("PID: %d\n", p->pid);
459         printk("--------------------\n");
460         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
461                 printk("Res type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
462                        p->procdata->res_req[i].amt_wanted, p->procinfo->res_grant[i]);
463 }
464
465 void print_all_resources(void)
466 {
467         /* Hash helper */
468         void __print_resources(void *item)
469         {
470                 print_resources((struct proc*)item);
471         }
472         spin_lock(&pid_hash_lock);
473         hash_for_each(pid_hash, __print_resources);
474         spin_unlock(&pid_hash_lock);
475 }