]> rtime.felk.cvut.cz Git - frescor/frsh.git/blob - resources/cpu_aquosa/lib/aqcpu_fra.c
Ensure that logdomains of different resources and managers are registered.
[frescor/frsh.git] / resources / cpu_aquosa / lib / aqcpu_fra.c
1 /**************************************************************************/
2 /* ---------------------------------------------------------------------- */
3 /* Copyright (C) 2006 - 2008 FRESCOR consortium partners:                 */
4 /*                                                                        */
5 /*   Universidad de Cantabria,              SPAIN                         */
6 /*   University of York,                    UK                            */
7 /*   Scuola Superiore Sant'Anna,            ITALY                         */
8 /*   Kaiserslautern University,             GERMANY                       */
9 /*   Univ. Politécnica  Valencia,           SPAIN                        */
10 /*   Czech Technical University in Prague,  CZECH REPUBLIC                */
11 /*   ENEA                                   SWEDEN                        */
12 /*   Thales Communication S.A.              FRANCE                        */
13 /*   Visual Tools S.A.                      SPAIN                         */
14 /*   Rapita Systems Ltd                     UK                            */
15 /*   Evidence                               ITALY                         */
16 /*                                                                        */
17 /*   See http://www.frescor.org for a link to partners' websites          */
18 /*                                                                        */
19 /*          FRESCOR project (FP6/2005/IST/5-034026) is funded             */
20 /*       in part by the European Union Sixth Framework Programme          */
21 /*       The European Union is not liable of any use that may be          */
22 /*       made of this code.                                               */
23 /*                                                                        */
24 /*                                                                        */
25 /*  This file is part of AQCPU (Aquosa CPU)                               */
26 /*                                                                        */
27 /* FWP is free software; you can redistribute it and/or modify it         */
28 /* under terms of the GNU General Public License as published by the      */
29 /* Free Software Foundation; either version 2, or (at your option) any    */
30 /* later version.  FWP is distributed in the hope that it will be         */
31 /* useful, but WITHOUT ANY WARRANTY; without even the implied warranty    */
32 /* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU    */
33 /* General Public License for more details. You should have received a    */
34 /* copy of the GNU General Public License along with FWP; see file        */
35 /* COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,  */
36 /* Cambridge, MA 02139, USA.                                              */
37 /*                                                                        */
38 /* As a special exception, including AQCPU header files in a file,        */
39 /* instantiating FWP generics or templates, or linking other files        */
40 /* with FWP objects to produce an executable application, does not        */
41 /* by itself cause the resulting executable application to be covered     */
42 /* by the GNU General Public License. This exception does not             */
43 /* however invalidate any other reasons why the executable file might be  */
44 /* covered by the GNU Public License.                                     */
45 /**************************************************************************/
46
47 /**
48  * @file   aqcpu_fra.c
49  * @author Martin Molnar <molnam1@fel.cvut.cz>
50  * @date   Wed Feb 18 16:21:01 2009
51  * 
52  * @brief  
53  * 
54  * 
55  */
56
57
58 #include <ul_log.h>
59 #include <ul_logreg.h>
60 #include <fra_generic.h>
61
62 #include "aquosa/qres_lib.h"
63 #include "aquosa/qsup_lib.h"
64
65 #include "aqcpu_contract.h"
66
67 UL_LOG_CUST(ulogd_fra_aqcpu);
68 ul_log_domain_t ulogd_fra_aqcpu = {UL_LOGL_MSG, "fra_aqcpu"};
69 UL_LOGREG_SINGLE_DOMAIN_INIT_FUNCTION(fra_aqcpu_logreg_domains, ulogd_fra_aqcpu);
70
71 static int aqcpu_initialized = 0;               /* initialization flag */
72
73 /*
74  * Test whether Aquosa Cpu modue is initialized 
75  */
76 static inline int aqcpu_is_initialized()
77 {
78         return (aqcpu_initialized == 1);
79 }
80
81
82
83 static int aqcpu_create_vres(fres_vres_t *vres, void *priv)
84 {
85         aqcpu_params_t cpu_params;
86         qres_sid_t sid;
87         qos_rv rv;
88
89         if (vres->priv) {
90                 errno = -EINVAL;
91                 return -1;
92         }
93
94         /* get aqcpu params from contract */
95         get_aqcpu_params(vres, &cpu_params);
96         /* create cpu vres */
97         rv = qres_create_server(&cpu_params, &sid);
98         if (rv != QOS_OK) {
99                 return qos_rv_int(rv);  
100         }
101         
102         printf("Created AQCPU VRES(sid=%d period=%lld us, budget=%lld us)\n",
103                         sid, cpu_params.P, cpu_params.Q);
104         if ((vres->priv = malloc(sizeof(qres_sid_t)))) {
105                 memcpy(vres->priv, &sid, sizeof(qres_sid_t));
106         }
107         
108         return 0;
109 }
110
111 /*
112  * aqcpu_cancel_vres(), cancels vres 
113  *
114  * The threads bound to the vres are unbound, and so, detached from their
115  * AQuoSA resource reservation server and continue their execution according
116  * to the standard Linux scheduler policies.
117  *
118  */
119 static int aqcpu_cancel_vres(fres_vres_t *vres, void *priv)
120 {
121         qres_sid_t sid;
122         qos_rv qrv;
123         
124         if (!vres->priv) {
125                 errno = -EINVAL;
126                 return -1;
127         }
128         memcpy(&sid, vres->priv, sizeof(qres_sid_t));
129         
130         qrv = qres_destroy_server(sid);
131         if (qrv != QOS_OK) {
132                 return qos_rv_int(qrv);
133         }
134         printf("Canceled AQCPU VRES(sid=%d)\n",sid);
135         free(vres->priv);
136
137         return 0;
138 }
139
140 /* aqcpu_vres_change(), change some parameters of a vres
141  *
142  * In fact, since that AQuoSA call doesn't deal with _its_ Q_min (budget_min
143  * for in FRSH semantic) parameter all the renegotiation will be accepted but
144  * the new temporal behaviour is not guaranteed!
145  * Obviously this is a bug and should/will be corrected in AQuoSA as soon as
146  * possible.
147  *
148  */
149 static
150 int aqcpu_change_vres(fres_vres_t *vres, void *priv)
151 {
152         aqcpu_params_t cpu_params;
153         qres_sid_t sid;
154         qos_rv qrv;
155         
156         if (!vres->priv) {
157                 errno = -EINVAL;
158                 return -1;
159         }
160         memcpy(&sid, vres->priv, sizeof(qres_sid_t));
161         
162         /* get aqcpu params from contract */
163         get_aqcpu_params(vres, &cpu_params);
164         
165         /* set cpu params */
166         qrv = qres_set_params(sid, &cpu_params);
167         
168         ul_logmsg("AQCPU VRES(sid=%d) params changed(period=%lld us,"
169                         "budget=%lld us)\n",sid, cpu_params.P,cpu_params.Q);
170
171         return 0;
172 }
173
174 /*
175  * installed as an exit handler (with 'atexit()') by the initialization
176  * code... For now it only calls the cleanup function of the AQuoSA
177  * Framework
178  */
179 static inline void aqcpu_cleanup_wrapper() {
180         qres_cleanup();
181 }
182
183 static
184 int aqcpu_fra_exit()
185 {
186         qos_rv rv;
187
188         rv = qres_cleanup();
189         return qos_rv_int(rv);
190 }
191
192 static
193 int fra_CPU_bind_thread
194   (fres_vres_t *vres,
195    const fosa_thread_id_t thread)
196 {
197         qos_rv  qrv;
198         qres_sid_t sid = *((qres_sid_t*)vres->priv);
199
200         if ((qrv = qres_attach_thread(sid, thread.linux_pid,
201             thread.linux_tid)) != QOS_OK)
202                 goto err;
203
204         return 0;
205 err:
206         return -1;
207 }
208
209 static
210 int fra_CPU_unbind_thread(const fosa_thread_id_t thread)
211 {
212         qos_rv  qrv;
213         qres_sid_t  sid;
214
215         if (qres_get_sid(thread.linux_pid, thread.linux_tid, &sid) != QOS_OK)
216                 goto err;
217
218         if ((qrv = qres_detach_thread(sid, thread.linux_pid,
219             thread.linux_tid)) != QOS_OK)
220                 goto err;
221
222         return 0;
223 err:
224         return -1;
225 }
226
227 static
228 int fra_CPU_get_usage
229   (const fres_vres_t *vres,
230    fosa_rel_time_t *spent)
231 {
232         qres_sid_t sid = *((qres_sid_t*)vres->priv);
233         qres_time_t exec_budget;
234         qos_rv rv;
235
236         if (!spent)
237                 return FRSH_ERR_BAD_ARGUMENT;
238
239         rv = qres_get_exec_time(sid, &exec_budget, NULL);
240         if (rv != QOS_OK) return EINVAL;
241
242         *spent = fosa_usec_to_rel_time(exec_budget);
243
244         return 0;
245 }
246
247 static
248 int fra_CPU_get_job_usage
249   (const fres_vres_t *vres,
250    fosa_rel_time_t *spent)
251 {
252         qres_sid_t sid = *((qres_sid_t*)vres->priv);
253         qres_params_t q_params;
254         qres_time_t curr_budget;
255         qos_rv rv;
256
257         if (!spent)
258                 return FRSH_ERR_BAD_ARGUMENT;
259
260         rv = qres_get_params(sid, &q_params);
261         if (rv != QOS_OK) return EINVAL;
262         rv = qres_get_curr_budget(sid, &curr_budget);
263         if (rv != QOS_OK) return EINVAL;
264
265         *spent = fosa_usec_to_rel_time(q_params.Q - curr_budget);
266
267         return 0;
268 }
269
270 static
271 int fra_CPU_get_remaining_budget
272   (const fres_vres_t *vres,
273    fosa_rel_time_t *budget)
274 {
275         qres_sid_t sid = *((qres_sid_t*)vres->priv);
276         qres_time_t curr_budget;
277         qos_rv rv;
278
279         if (!budget)
280                 return FRSH_ERR_BAD_ARGUMENT;
281
282         rv = qres_get_curr_budget(sid, &curr_budget);
283         if (rv != QOS_OK) return EINVAL;
284
285         *budget = fosa_usec_to_rel_time(curr_budget);
286
287         return 0;
288 }
289
290 static
291 int fra_CPU_set_spare_bandwidth(fres_vres_t *vres)
292 {
293         qres_sid_t fake_sid = (qres_sid_t) -1;
294         aqcpu_params_t cpu_params;
295         qos_rv rv;
296
297         /* get aqcpu params from contract */
298         get_aqcpu_params(vres, &cpu_params);
299
300         
301         /* reserve CPU bandwidth for feedback */
302         rv = qsup_reserve_spare(r2bw(cpu_params.Q, cpu_params.P));
303         if (rv != QOS_OK) return qos_rv_int(rv);
304
305         printf("Created AQCPU spare (period=%lld us, budget=%lld us)\n",
306                         cpu_params.P, cpu_params.Q);
307         if ((vres->priv = malloc(sizeof(qres_sid_t)))) {
308                 memcpy(vres->priv, &fake_sid, sizeof(qres_sid_t));
309         }
310
311         return 0;
312 }
313
314 static
315 int fra_CPU_get_desired_budget
316   (fres_vres_t *vres,
317    frsh_rel_time_t *p_budget_out)
318 {
319         qres_sid_t sid = *((qres_sid_t*)vres->priv);
320         qres_params_t q_params;
321         qos_rv rv;
322
323         if (!p_budget_out)
324                 return FRSH_ERR_BAD_ARGUMENT;
325
326         rv = qres_get_params(sid, &q_params);
327         if (rv != QOS_OK) return EINVAL;
328
329         *p_budget_out = fosa_usec_to_rel_time(q_params.Q);
330
331         return 0;
332 }
333
334 static
335 int fra_CPU_set_desired_budget
336   (fres_vres_t *vres,
337    fosa_rel_time_t *p_budget_in)
338 {
339         qres_sid_t sid = *((qres_sid_t*)vres->priv);
340         qres_params_t q_params;
341         qos_rv rv;
342
343         if (!p_budget_in)
344                 return FRSH_ERR_BAD_ARGUMENT;
345
346         rv = qres_get_params(sid, &q_params);
347         if (rv != QOS_OK) return EINVAL;
348
349         q_params.Q = fosa_rel_time_to_usec(*p_budget_in);
350
351         rv = qres_set_params(sid, &q_params);
352         if (rv != QOS_OK) return EINVAL;
353
354         return 0;
355 }
356
357 static
358 int fra_CPU_get_actual_budget
359   (fres_vres_t *vres,
360    fosa_rel_time_t *budget)
361 {
362         qres_sid_t sid = *((qres_sid_t*)vres->priv);
363         qres_time_t appr_budget;
364         qos_rv rv;
365
366         if (!budget)
367                 return FRSH_ERR_BAD_ARGUMENT;
368
369         rv = qres_get_appr_budget(sid, &appr_budget);
370         if (rv != QOS_OK) return EINVAL;
371
372         *budget = fosa_usec_to_rel_time(appr_budget);
373
374         return 0;
375 }
376
377 int aqcpu_fra_activate(forb_orb orb)
378 {
379         qos_rv qrv;
380         if ((qrv = qres_init()) != QOS_OK) {
381                 if (qrv == QOS_E_MISSING_COMPONENT) {
382                         return FRES_ERR_KERNEL_SUPPORT_MISSING;
383                 } else
384                         return FRSH_ERR_INTERNAL_ERROR;
385         }
386
387         /* install the cleanup function of th AQuoSA framework as an exit
388          * handler function (quite futile but, for now, it's sufficent) */
389         if (atexit(aqcpu_cleanup_wrapper)) {
390                 qres_cleanup();
391                 return(FRSH_ERR_INTERNAL_ERROR);
392         }
393
394         aqcpu_initialized = 1;
395
396         return 0;
397 }
398
399 static struct fres_allocator aqcpu_allocator = {
400         .res_type = FRSH_RT_PROCESSOR,
401         .res_id = 0,  /* CPU ID 0 */
402         .create_vres = aqcpu_create_vres,
403         .cancel_vres = aqcpu_cancel_vres,
404         .change_vres = aqcpu_change_vres,
405
406         .bind_thread = fra_CPU_bind_thread,
407         .unbind_thread = fra_CPU_unbind_thread,
408
409         .vres_get_usage = fra_CPU_get_usage,
410         .vres_get_job_usage = fra_CPU_get_job_usage,
411         .vres_get_remaining_budget = fra_CPU_get_remaining_budget,
412
413         .set_spare_bandwidth = fra_CPU_set_spare_bandwidth,
414         .get_desired_budget = fra_CPU_get_desired_budget,
415         .set_desired_budget = fra_CPU_set_desired_budget,
416         .get_actual_budget = fra_CPU_get_actual_budget,
417
418         .activate_callback = aqcpu_fra_activate,
419         
420         .priv = NULL
421 };
422
423 /*
424  * aqcpu_fra_init(), initialize FRSH for the calling process
425  *
426  * Must be called before starting using the framework.
427  * No FRSH call will be successful if this routine is not invoked
428  *
429  * Note that no BACKGROUND is created and negotiated and the caller thread
430  * is bound to no BACKGROUND vres, since no way is provided in order of
431  * specifying the contract label and get back the vres id!
432  *
433  * Note also that, since in this implementation the threads/processes with
434  * backgound contracts are left into the default Linux scheduler hands' and
435  * not attached to any AQuoSA server, while we're violating what D-AC2v1
436  * (pag. 14) says, we achieve exactly the same behaviour!!
437  */
438 int aqcpu_fra_init(void)
439 {
440         int rv;
441
442         if ((rv = fra_register(&aqcpu_allocator))) {
443                 return rv;
444         }
445         
446         return 0;
447 }