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
147 int aqcpu_change_vres(fres_vres_t *vres, void *priv)
149 aqcpu_params_t cpu_params;
157 memcpy(&sid, vres->priv, sizeof(qres_sid_t));
159 /* get aqcpu params from contract */
160 get_aqcpu_params(vres, &cpu_params);
163 qrv = qres_set_params(sid, &cpu_params);
165 ul_logmsg("AQCPU VRES(sid=%d) params changed(period=%lld us,"
166 "budget=%lld us)\n",sid, cpu_params.P,cpu_params.Q);
171 static struct fres_allocator aqcpu_allocator = {
172 .res_type = FRSH_RT_PROCESSOR,
173 .res_id = 0, /* CPU ID 0 */
174 .create_vres = aqcpu_create_vres,
175 .cancel_vres = aqcpu_cancel_vres,
176 .change_vres = aqcpu_change_vres,
181 * installed as an exit handler (with 'atexit()') by the initialization
182 * code... For now it only calls the cleanup function of the AQuoSA
185 static inline void aqcpu_cleanup_wrapper() {
190 * aqcpu_fra_init(), initialize FRSH for the calling process
192 * Must be called before starting using the framework.
193 * No FRSH call will be successful if this routine is not invoked
195 * Note that no BACKGROUND is created and negotiated and the caller thread
196 * is bound to no BACKGROUND vres, since no way is provided in order of
197 * specifying the contract label and get back the vres id!
199 * Note also that, since in this implementation the threads/processes with
200 * backgound contracts are left into the default Linux scheduler hands' and
201 * not attached to any AQuoSA server, while we're violating what D-AC2v1
202 * (pag. 14) says, we achieve exactly the same behaviour!!
204 int aqcpu_fra_init(void)
209 if ((qrv = qres_init()) != QOS_OK) {
213 if ((rv = fra_register(&aqcpu_allocator))) {
218 /* install the cleanup function of th AQuoSA framework as an exit
219 * handler function (quite futile but, for now, it's sufficent) */
220 if (atexit(aqcpu_cleanup_wrapper))
221 return(FRSH_ERR_INTERNAL_ERROR);
223 aqcpu_initialized = 1;
233 return qos_rv_int(rv);
236 int fra_CPU_bind_thread
237 (const fres_vres_t *vres,
238 const fosa_thread_id_t thread)
241 qres_sid_t sid = *((qres_sid_t*)vres->priv);
243 if ((qrv = qres_attach_thread(sid, thread.linux_pid,
244 thread.linux_tid)) != QOS_OK)
252 int fra_CPU_unbind_thread(const fosa_thread_id_t thread)
257 if (qres_get_sid(thread.linux_pid, thread.linux_tid, &sid) != QOS_OK)
260 if ((qrv = qres_detach_thread(sid, thread.linux_pid,
261 thread.linux_tid)) != QOS_OK)
269 int fra_CPU_get_usage
270 (const fres_vres_t *vres,
271 fosa_rel_time_t *spent)
273 qres_sid_t sid = *((qres_sid_t*)vres->priv);
274 qres_time_t exec_budget;
278 return FRSH_ERR_BAD_ARGUMENT;
280 rv = qres_get_exec_time(sid, &exec_budget, NULL);
281 if (rv != QOS_OK) return EINVAL;
283 *spent = fosa_usec_to_rel_time(exec_budget);
288 int fra_CPU_get_job_usage
289 (const fres_vres_t *vres,
290 fosa_rel_time_t *spent)
292 qres_sid_t sid = *((qres_sid_t*)vres->priv);
293 qres_params_t q_params;
294 qres_time_t curr_budget;
298 return FRSH_ERR_BAD_ARGUMENT;
300 rv = qres_get_params(sid, &q_params);
301 if (rv != QOS_OK) return EINVAL;
302 rv = qres_get_curr_budget(sid, &curr_budget);
303 if (rv != QOS_OK) return EINVAL;
305 *spent = fosa_usec_to_rel_time(q_params.Q - curr_budget);
310 int fra_CPU_get_remaining_budget
311 (const fres_vres_t *vres,
312 fosa_rel_time_t *budget)
314 qres_sid_t sid = *((qres_sid_t*)vres->priv);
315 qres_time_t curr_budget;
319 return FRSH_ERR_BAD_ARGUMENT;
321 rv = qres_get_curr_budget(sid, &curr_budget);
322 if (rv != QOS_OK) return EINVAL;
324 *budget = fosa_usec_to_rel_time(curr_budget);
329 int fra_CPU_set_spare_bandwidth(fres_vres_t *vres)
331 qres_sid_t fake_sid = (qres_sid_t) -1;
332 aqcpu_params_t cpu_params;
335 /* get aqcpu params from contract */
336 get_aqcpu_params(vres, &cpu_params);
339 /* reserve CPU bandwidth for feedback */
340 rv = qsup_reserve_spare(r2bw(cpu_params.Q, cpu_params.P));
341 if (rv != QOS_OK) return qos_rv_int(rv);
343 printf("Created AQCPU spare (period=%lld us, budget=%lld us)\n",
344 cpu_params.P, cpu_params.Q);
345 if ((vres->priv = malloc(sizeof(qres_sid_t)))) {
346 memcpy(vres->priv, &fake_sid, sizeof(qres_sid_t));
352 int fra_CPU_get_desired_budget
354 frsh_rel_time_t *p_budget_out)
356 qres_sid_t sid = *((qres_sid_t*)vres->priv);
357 qres_params_t q_params;
361 return FRSH_ERR_BAD_ARGUMENT;
363 rv = qres_get_params(sid, &q_params);
364 if (rv != QOS_OK) return EINVAL;
366 *p_budget_out = fosa_usec_to_rel_time(q_params.Q);
371 int fra_CPU_set_desired_budget
373 fosa_rel_time_t *p_budget_in)
375 qres_sid_t sid = *((qres_sid_t*)vres->priv);
376 qres_params_t q_params;
380 return FRSH_ERR_BAD_ARGUMENT;
382 rv = qres_get_params(sid, &q_params);
383 if (rv != QOS_OK) return EINVAL;
385 q_params.Q = fosa_rel_time_to_usec(*p_budget_in);
387 rv = qres_set_params(sid, &q_params);
388 if (rv != QOS_OK) return EINVAL;
393 int fra_CPU_get_actual_budget
395 fosa_rel_time_t *budget)
397 qres_sid_t sid = *((qres_sid_t*)vres->priv);
398 qres_time_t appr_budget;
402 return FRSH_ERR_BAD_ARGUMENT;
404 rv = qres_get_appr_budget(sid, &appr_budget);
405 if (rv != QOS_OK) return EINVAL;
407 *budget = fosa_usec_to_rel_time(appr_budget);