1 /**************************************************************************/
2 /* ---------------------------------------------------------------------- */
3 /* Copyright (C) 2006 - 2008 FRESCOR consortium partners: */
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 */
12 /* Thales Communication S.A. FRANCE */
13 /* Visual Tools S.A. SPAIN */
14 /* Rapita Systems Ltd UK */
17 /* See http://www.frescor.org for a link to partners' websites */
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. */
25 /* This file is part of AQCPU (Aquosa CPU) */
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. */
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 /**************************************************************************/
49 * @author Martin Molnar <molnam1@fel.cvut.cz>
50 * @date Wed Feb 18 16:21:01 2009
59 #include <fra_generic.h>
61 #include "aquosa/qres_lib.h"
62 #include "aquosa/qsup_lib.h"
64 #include "aqcpu_contract.h"
66 UL_LOG_CUST(ulogd_fra_aqcpu);
67 //ul_log_domain_t ulogd_fra_aqcpu = {UL_LOGL_MSG, "fra_aqcpu"};
69 static int aqcpu_initialized = 0; /* initialization flag */
72 * Test whether Aquosa Cpu modue is initialized
74 static inline int aqcpu_is_initialized()
76 return (aqcpu_initialized == 1);
81 static int aqcpu_create_vres(fres_vres_t *vres, void *priv)
83 aqcpu_params_t cpu_params;
92 /* get aqcpu params from contract */
93 get_aqcpu_params(vres, &cpu_params);
95 rv = qres_create_server(&cpu_params, &sid);
97 return qos_rv_int(rv);
100 printf("Created AQCPU VRES(sid=%d period=%lld us, budget=%lld us)\n",
101 sid, cpu_params.P, cpu_params.Q);
102 if ((vres->priv = malloc(sizeof(qres_sid_t)))) {
103 memcpy(vres->priv, &sid, sizeof(qres_sid_t));
110 * aqcpu_cancel_vres(), cancels vres
112 * The threads bound to the vres are unbound, and so, detached from their
113 * AQuoSA resource reservation server and continue their execution according
114 * to the standard Linux scheduler policies.
117 static int aqcpu_cancel_vres(fres_vres_t *vres, void *priv)
126 memcpy(&sid, vres->priv, sizeof(qres_sid_t));
128 qrv = qres_destroy_server(sid);
130 return qos_rv_int(qrv);
132 printf("Canceled AQCPU VRES(sid=%d)\n",sid);
138 /* aqcpu_vres_change(), change some parameters of a vres
140 * In fact, since that AQuoSA call doesn't deal with _its_ Q_min (budget_min
141 * for in FRSH semantic) parameter all the renegotiation will be accepted but
142 * the new temporal behaviour is not guaranteed!
143 * Obviously this is a bug and should/will be corrected in AQuoSA as soon as
148 int aqcpu_change_vres(fres_vres_t *vres, void *priv)
150 aqcpu_params_t cpu_params;
158 memcpy(&sid, vres->priv, sizeof(qres_sid_t));
160 /* get aqcpu params from contract */
161 get_aqcpu_params(vres, &cpu_params);
164 qrv = qres_set_params(sid, &cpu_params);
166 ul_logmsg("AQCPU VRES(sid=%d) params changed(period=%lld us,"
167 "budget=%lld us)\n",sid, cpu_params.P,cpu_params.Q);
173 * installed as an exit handler (with 'atexit()') by the initialization
174 * code... For now it only calls the cleanup function of the AQuoSA
177 static inline void aqcpu_cleanup_wrapper() {
187 return qos_rv_int(rv);
191 int fra_CPU_bind_thread
193 const fosa_thread_id_t thread)
196 qres_sid_t sid = *((qres_sid_t*)vres->priv);
198 if ((qrv = qres_attach_thread(sid, thread.linux_pid,
199 thread.linux_tid)) != QOS_OK)
208 int fra_CPU_unbind_thread(const fosa_thread_id_t thread)
213 if (qres_get_sid(thread.linux_pid, thread.linux_tid, &sid) != QOS_OK)
216 if ((qrv = qres_detach_thread(sid, thread.linux_pid,
217 thread.linux_tid)) != QOS_OK)
226 int fra_CPU_get_usage
227 (const fres_vres_t *vres,
228 fosa_rel_time_t *spent)
230 qres_sid_t sid = *((qres_sid_t*)vres->priv);
231 qres_time_t exec_budget;
235 return FRSH_ERR_BAD_ARGUMENT;
237 rv = qres_get_exec_time(sid, &exec_budget, NULL);
238 if (rv != QOS_OK) return EINVAL;
240 *spent = fosa_usec_to_rel_time(exec_budget);
246 int fra_CPU_get_job_usage
247 (const fres_vres_t *vres,
248 fosa_rel_time_t *spent)
250 qres_sid_t sid = *((qres_sid_t*)vres->priv);
251 qres_params_t q_params;
252 qres_time_t curr_budget;
256 return FRSH_ERR_BAD_ARGUMENT;
258 rv = qres_get_params(sid, &q_params);
259 if (rv != QOS_OK) return EINVAL;
260 rv = qres_get_curr_budget(sid, &curr_budget);
261 if (rv != QOS_OK) return EINVAL;
263 *spent = fosa_usec_to_rel_time(q_params.Q - curr_budget);
269 int fra_CPU_get_remaining_budget
270 (const fres_vres_t *vres,
271 fosa_rel_time_t *budget)
273 qres_sid_t sid = *((qres_sid_t*)vres->priv);
274 qres_time_t curr_budget;
278 return FRSH_ERR_BAD_ARGUMENT;
280 rv = qres_get_curr_budget(sid, &curr_budget);
281 if (rv != QOS_OK) return EINVAL;
283 *budget = fosa_usec_to_rel_time(curr_budget);
289 int fra_CPU_set_spare_bandwidth(fres_vres_t *vres)
291 qres_sid_t fake_sid = (qres_sid_t) -1;
292 aqcpu_params_t cpu_params;
295 /* get aqcpu params from contract */
296 get_aqcpu_params(vres, &cpu_params);
299 /* reserve CPU bandwidth for feedback */
300 rv = qsup_reserve_spare(r2bw(cpu_params.Q, cpu_params.P));
301 if (rv != QOS_OK) return qos_rv_int(rv);
303 printf("Created AQCPU spare (period=%lld us, budget=%lld us)\n",
304 cpu_params.P, cpu_params.Q);
305 if ((vres->priv = malloc(sizeof(qres_sid_t)))) {
306 memcpy(vres->priv, &fake_sid, sizeof(qres_sid_t));
313 int fra_CPU_get_desired_budget
315 frsh_rel_time_t *p_budget_out)
317 qres_sid_t sid = *((qres_sid_t*)vres->priv);
318 qres_params_t q_params;
322 return FRSH_ERR_BAD_ARGUMENT;
324 rv = qres_get_params(sid, &q_params);
325 if (rv != QOS_OK) return EINVAL;
327 *p_budget_out = fosa_usec_to_rel_time(q_params.Q);
333 int fra_CPU_set_desired_budget
335 fosa_rel_time_t *p_budget_in)
337 qres_sid_t sid = *((qres_sid_t*)vres->priv);
338 qres_params_t q_params;
342 return FRSH_ERR_BAD_ARGUMENT;
344 rv = qres_get_params(sid, &q_params);
345 if (rv != QOS_OK) return EINVAL;
347 q_params.Q = fosa_rel_time_to_usec(*p_budget_in);
349 rv = qres_set_params(sid, &q_params);
350 if (rv != QOS_OK) return EINVAL;
356 int fra_CPU_get_actual_budget
358 fosa_rel_time_t *budget)
360 qres_sid_t sid = *((qres_sid_t*)vres->priv);
361 qres_time_t appr_budget;
365 return FRSH_ERR_BAD_ARGUMENT;
367 rv = qres_get_appr_budget(sid, &appr_budget);
368 if (rv != QOS_OK) return EINVAL;
370 *budget = fosa_usec_to_rel_time(appr_budget);
375 static struct fres_allocator aqcpu_allocator = {
376 .res_type = FRSH_RT_PROCESSOR,
377 .res_id = 0, /* CPU ID 0 */
378 .create_vres = aqcpu_create_vres,
379 .cancel_vres = aqcpu_cancel_vres,
380 .change_vres = aqcpu_change_vres,
382 .bind_thread = fra_CPU_bind_thread,
383 .unbind_thread = fra_CPU_unbind_thread,
385 .vres_get_usage = fra_CPU_get_usage,
386 .vres_get_job_usage = fra_CPU_get_job_usage,
387 .vres_get_remaining_budget = fra_CPU_get_remaining_budget,
389 .set_spare_bandwidth = fra_CPU_set_spare_bandwidth,
390 .get_desired_budget = fra_CPU_get_desired_budget,
391 .set_desired_budget = fra_CPU_set_desired_budget,
392 .get_actual_budget = fra_CPU_get_actual_budget,
398 * aqcpu_fra_init(), initialize FRSH for the calling process
400 * Must be called before starting using the framework.
401 * No FRSH call will be successful if this routine is not invoked
403 * Note that no BACKGROUND is created and negotiated and the caller thread
404 * is bound to no BACKGROUND vres, since no way is provided in order of
405 * specifying the contract label and get back the vres id!
407 * Note also that, since in this implementation the threads/processes with
408 * backgound contracts are left into the default Linux scheduler hands' and
409 * not attached to any AQuoSA server, while we're violating what D-AC2v1
410 * (pag. 14) says, we achieve exactly the same behaviour!!
412 int aqcpu_fra_init(void)
417 if ((qrv = qres_init()) != QOS_OK) {
421 if ((rv = fra_register(&aqcpu_allocator))) {
426 /* install the cleanup function of th AQuoSA framework as an exit
427 * handler function (quite futile but, for now, it's sufficent) */
428 if (atexit(aqcpu_cleanup_wrapper))
429 return(FRSH_ERR_INTERNAL_ERROR);
431 aqcpu_initialized = 1;