Proc refcnting wrappers
[akaros.git] / kern / src / resource.c
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  * Kernel resource management.
7  */
8
9 #ifdef __IVY__
10 #pragma nosharc
11 #endif
12
13 #include <resource.h>
14 #include <process.h>
15 #include <smp.h>
16 #include <stdio.h>
17 #include <assert.h>
18 #include <schedule.h>
19 #include <hashtable.h>
20
21 /* This deals with a request for more cores.  The request is already stored in
22  * the proc's amt_wanted (it is compared to amt_granted). 
23  *
24  * It doesn't take the amount requested directly to avoid a race (or holding the
25  * proc_lock across the call), and allowing it to be called in other situations,
26  * such as if there was not a new request, but it's time to look at the
27  * difference between amt_wanted and amt_granted (maybe on a timer interrupt).
28  *
29  * Will return either the number actually granted or an error code.  This will
30  * not decrease the actual amount of cores (e.g. from 5 to 2), but it will
31  * transition a process from _M to _S (amt_wanted == 0).
32  *
33  * This needs a consumable/edible reference of p, in case it doesn't return.
34  *
35  * TODO: this is a giant function.  need to split it up a bit, probably move the
36  * guts to process.c and have functions to call for the brains.
37  */
38 ssize_t core_request(struct proc *p)
39 {
40         size_t num_granted;
41         ssize_t amt_new;
42         uint32_t corelist[MAX_NUM_CPUS];
43         bool need_to_idle = FALSE;
44         bool self_ipi_pending = FALSE;
45
46         /* There are a few things broken for now if you don't have a current_tf */
47         assert(current_tf);
48         spin_lock(&p->proc_lock);
49         if (p->state == PROC_DYING) {
50                 return -EFAIL;
51                 spin_unlock(&p->proc_lock);
52         }
53         /* check to see if this is a full deallocation.  for cores, it's a
54          * transition from _M to _S.  Will be issues with handling this async. */
55         if (!p->resources[RES_CORES].amt_wanted) {
56                 assert(p->state == PROC_RUNNING_M); // TODO: (ACR) async core req
57                 /* save the context, to be restarted in _S mode */
58                 p->env_tf = *current_tf;
59                 current_tf = 0;                 /* Make sure it isn't used in the future */
60                 env_push_ancillary_state(p); // TODO: (HSS)
61                 /* sending death, since it's not our job to save contexts or anything in
62                  * this case.  also, if this returns true, we will not return down
63                  * below, and need to eat the reference to p */
64                 self_ipi_pending = __proc_take_allcores(p, __death, 0, 0, 0);
65                 __proc_set_state(p, PROC_RUNNABLE_S);
66                 schedule_proc(p);
67                 spin_unlock(&p->proc_lock);
68                 __proc_kmsg_pending(p, self_ipi_pending);
69                 return 0;
70         }
71         /* Fail if we can never handle this amount (based on how many we told the
72          * process it can get). */
73         if (p->resources[RES_CORES].amt_wanted > p->procinfo->max_vcores) {
74                 spin_unlock(&p->proc_lock);
75                 return -EFAIL;
76         }
77         /* otherwise, see how many new cores are wanted */
78         amt_new = p->resources[RES_CORES].amt_wanted -
79                   p->resources[RES_CORES].amt_granted;
80         if (amt_new < 0) {
81                 p->resources[RES_CORES].amt_wanted = p->resources[RES_CORES].amt_granted;
82                 spin_unlock(&p->proc_lock);
83                 return -EINVAL;
84         } else if (amt_new == 0) {
85                 spin_unlock(&p->proc_lock);
86                 return 0;
87         }
88         // else, we try to handle the request
89
90         /* TODO: someone needs to decide if the process gets the resources.
91          * we just check to see if they are available and give them out.  This
92          * should call out to the scheduler or some other *smart* function.  You
93          * could also imagine just putting it on the scheduler's queue and letting
94          * that do the core request */
95         spin_lock(&idle_lock);
96         if (num_idlecores >= amt_new) {
97                 for (int i = 0; i < amt_new; i++) {
98                         // grab the last one on the list
99                         corelist[i] = idlecoremap[num_idlecores-1];
100                         num_idlecores--;
101                 }
102                 num_granted = amt_new;
103         } else {
104                 /* In this case, you might want to preempt or do other fun things... */
105                 num_granted = 0;
106         }
107         spin_unlock(&idle_lock);
108
109         // Now, actually give them out
110         if (num_granted) {
111                 switch (p->state) {
112                         case (PROC_RUNNING_S):
113                                 // issue with if we're async or not (need to preempt it)
114                                 // either of these should trip it. TODO: (ACR) async core req
115                                 // TODO: relies on vcore0 being the caller (VC#)
116                                 // TODO: do this in process.c and use this line:
117                                 //if ((current != p) || (get_pcoreid(p, 0) != core_id()))
118                                 if ((current != p) || (p->procinfo->vcoremap[0].pcoreid != core_id()))
119                                         panic("We don't handle async RUNNING_S core requests yet.");
120                                 /* save the tf so userspace can restart it.  Like in __notify,
121                                  * this assumes a user tf is the same as a kernel tf.  We save
122                                  * it in the preempt slot so that we can also save the silly
123                                  * state. */
124                                 struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[0];
125                                 vcpd->preempt_tf = *current_tf;
126                                 save_fp_state(&vcpd->preempt_anc);
127                                 __seq_start_write(&vcpd->preempt_tf_valid);
128                                 /* If we remove this, vcore0 will start where the _S left off */
129                                 vcpd->notif_pending = TRUE;
130                                 assert(vcpd->notif_enabled);
131                                 /* in the async case, we'll need to remotely stop and bundle
132                                  * vcore0's TF.  this is already done for the sync case (local
133                                  * syscall). */
134                                 /* this process no longer runs on its old location (which is
135                                  * this core, for now, since we don't handle async calls) */
136                                 __seq_start_write(&p->procinfo->coremap_seqctr);
137                                 // TODO: (VC#) might need to adjust num_vcores
138                                 // TODO: (ACR) will need to unmap remotely (receive-side)
139                                 __unmap_vcore(p, 0);
140                                 __seq_end_write(&p->procinfo->coremap_seqctr);
141                                 // will need to give up this core / idle later (sync)
142                                 need_to_idle = TRUE;
143                                 // change to runnable_m (it's TF is already saved)
144                                 __proc_set_state(p, PROC_RUNNABLE_M);
145                                 break;
146                         case (PROC_RUNNABLE_S):
147                                 /* Issues: being on the runnable_list, proc_set_state not liking
148                                  * it, and not clearly thinking through how this would happen.
149                                  * Perhaps an async call that gets serviced after you're
150                                  * descheduled? */
151                                 panic("Not supporting RUNNABLE_S -> RUNNABLE_M yet.\n");
152                                 break;
153                         case (PROC_DYING):
154                                 warn("Dying, core request coming from %d\n", core_id());
155                         default:
156                                 break;
157                 }
158                 /* give them the cores.  this will start up the extras if RUNNING_M. */
159                 self_ipi_pending = __proc_give_cores(p, corelist, num_granted);
160                 spin_unlock(&p->proc_lock);
161                 // TODO: (RMS) think about this, esp when its called from a scheduler
162                 __proc_kmsg_pending(p, self_ipi_pending);
163                 /* if there's a race on state (like DEATH), it'll get handled by
164                  * proc_run or proc_destroy */
165                 if (p->state == PROC_RUNNABLE_M)
166                         proc_run(p);
167                 /* if we are moving to a partitionable core from a RUNNING_S on a
168                  * management core, the kernel needs to do something else on this core
169                  * (just like in proc_destroy).  it also needs to decref, to consume the
170                  * reference that came into this function (since we don't return).  */
171                 if (need_to_idle) {
172                         proc_decref(p);
173                         abandon_core();
174                         smp_idle();
175                 }
176         } else { // nothing granted, just return
177                 spin_unlock(&p->proc_lock);
178         }
179         return num_granted;
180 }
181
182 error_t resource_req(struct proc *p, int type, size_t amt_wanted,
183                      size_t amt_wanted_min, uint32_t flags)
184 {
185         error_t retval;
186         printd("Received request for type: %d, amt_wanted: %d, amt_wanted_min: %d, "
187                "flag: %d\n", type, amt_wanted, amt_wanted_min, flags);
188         if (flags & REQ_ASYNC)
189                 // We have no sense of time yet, or of half-filling requests
190                 printk("[kernel] Async requests treated synchronously for now.\n");
191
192         /* set the desired resource amount in the process's resource list. */
193         spin_lock(&p->proc_lock);
194         size_t old_amount = p->resources[type].amt_wanted;
195         p->resources[type].amt_wanted = amt_wanted;
196         p->resources[type].amt_wanted_min = MIN(amt_wanted_min, amt_wanted);
197         p->resources[type].flags = flags;
198         spin_unlock(&p->proc_lock);
199
200         switch (type) {
201                 case RES_CORES:
202                         retval = core_request(p);
203                         // i don't like this retval hackery
204                         if (retval < 0) {
205                                 set_errno(-retval);
206                                 return -1;
207                         }
208                         else
209                                 return 0;
210                         break;
211                 case RES_MEMORY:
212                         // not clear if we should be in RUNNABLE_M or not
213                         printk("[kernel] Memory requests are not implemented.\n");
214                         return -EFAIL;
215                         break;
216                 case RES_APPLE_PIES:
217                         printk("You can have all the apple pies you want.\n");
218                         break;
219                 default:
220                         printk("[kernel] Unknown resource!  No oranges for you!\n");
221                         return -EINVAL;
222         }
223         return 0;
224 }
225
226 void print_resources(struct proc *p)
227 {
228         printk("--------------------\n");
229         printk("PID: %d\n", p->pid);
230         printk("--------------------\n");
231         for (int i = 0; i < MAX_NUM_RESOURCES; i++)
232                 printk("Res type: %02d, amt wanted: %08d, amt granted: %08d\n", i,
233                        p->resources[i].amt_wanted, p->resources[i].amt_granted);
234 }
235
236 void print_all_resources(void)
237 {
238         spin_lock(&pid_hash_lock);
239         if (hashtable_count(pid_hash)) {
240                 hashtable_itr_t *phtable_i = hashtable_iterator(pid_hash);
241                 do {
242                         print_resources(hashtable_iterator_value(phtable_i));
243                 } while (hashtable_iterator_advance(phtable_i));
244         }
245         spin_unlock(&pid_hash_lock);
246 }