Ksched functions to provision cores
[akaros.git] / kern / include / schedule.h
1 /*
2  * Copyright (c) 2009 The Regents of the University of California
3  * Barret Rhoden <brho@cs.berkeley.edu>
4  * See LICENSE for details.
5  *
6  * Scheduling and dispatching.
7  */
8
9 #ifndef ROS_KERN_SCHEDULE_H
10 #define ROS_KERN_SCHEDULE_H
11
12 #include <ros/common.h>
13 #include <sys/queue.h>
14
15 struct proc;    /* process.h includes us, but we need pointers now */
16 TAILQ_HEAD(proc_list, proc);            /* Declares 'struct proc_list' */
17
18 /* The ksched maintains an internal array of these: the global pcore map */
19 struct sched_pcore {
20         TAILQ_ENTRY(sched_pcore)        next;                           /* on a proc's prov list */
21         struct proc                                     *prov_proc;                     /* who this is prov to */
22         struct proc                                     *alloc_proc;            /* who this is alloc to */
23 };
24 TAILQ_HEAD(sched_pcore_tailq, sched_pcore);
25
26 /* One of these embedded in every struct proc */
27 struct sched_proc_data {
28         TAILQ_ENTRY(proc)                       proc_link;                      /* tailq linkage */
29         struct proc_list                        *cur_list;                      /* which tailq we're on */
30         struct sched_pcore_tailq        prov_alloc_me;          /* prov cores alloced us */
31         struct sched_pcore_tailq        prov_not_alloc_me;      /* maybe alloc to others */
32         /* count of lists? */
33         /* other accounting info */
34 };
35
36 void schedule_init(void);
37
38 /************** Process management **************/
39 /* Tell the ksched about the process, which it will track cradle-to-grave */
40 void register_proc(struct proc *p);
41
42 /* Makes sure p is runnable.  Callers include event delivery, SCP yield, and new
43  * SCPs.  Will trigger the __sched_.cp_wakeup() callbacks. */
44 void proc_wakeup(struct proc *p);
45
46 /* The ksched starts the death process (lock ordering issue), which calls back
47  * to proc.c's __proc_destroy while holding the locks (or whatever) */
48 void proc_destroy(struct proc *p);
49
50 /* Changes the proc from an SCP to an MCP */
51 int proc_change_to_m(struct proc *p);
52
53 /************** Decision making **************/
54 /* Call the main scheduling algorithm.  Not clear yet if the main kernel will
55  * ever call this directly. */
56 void schedule(void);
57
58 /* Proc p's resource desires changed, or something in general that would lead to
59  * a new decision.  The process can directly poke the ksched via a syscall, so
60  * be careful of abuse. */
61 void poke_ksched(struct proc *p, int res_type);
62
63 /* Callbacks triggered from proc_wakeup() */
64 void __sched_mcp_wakeup(struct proc *p);
65 void __sched_scp_wakeup(struct proc *p);
66
67 /* The calling cpu/core has nothing to do and plans to idle/halt.  This is an
68  * opportunity to pick the nature of that halting (low power state, etc), or
69  * provide some other work (_Ss on LL cores). */
70 void cpu_bored(void);
71
72 /* Gets called when a pcore becomes idle (like in proc yield).  These are 'cg'
73  * cores, given to MCPs, that have been async returned to the ksched.  If the
74  * ksched preempts a core, this won't get called (unless it yielded first). */
75 void put_idle_core(struct proc *p, uint32_t coreid);
76 void put_idle_cores(struct proc *p, uint32_t *pc_arr, uint32_t num);
77
78 /* Available resources changed (plus or minus).  Some parts of the kernel may
79  * call this if a particular resource that is 'quantity-based' changes.  Things
80  * like available RAM to processes, bandwidth, etc.  Cores would probably be
81  * inappropriate, since we need to know which specific core is now free. */
82 void avail_res_changed(int res_type, long change);
83
84 /************** Proc's view of the world **************/
85 /* How many vcores p will think it can have */
86 uint32_t max_vcores(struct proc *p);
87
88 /************** Provisioning / Allocating *************/
89 /* This section is specific to a provisioning ksched.  Careful calling any of
90  * this from generic kernel code, since it might not be present in all kernel
91  * schedulers. */
92 void provision_core(struct proc *p, uint32_t pcoreid);
93
94 /************** Debugging **************/
95 void sched_diag(void);
96 void print_idlecoremap(void);
97 void print_resources(struct proc *p);
98 void print_all_resources(void);
99
100 #endif /* ROS_KERN_SCHEDULE_H */