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 <fra_generic.h>
  60
  61 #include "aquosa/qres_lib.h"
  62 #include "aquosa/qsup_lib.h"
  63
  64 #include "aqcpu_contract.h"
  65
  66 UL_LOG_CUST(ulogd_fra_aqcpu);
  67 //ul_log_domain_t ulogd_fra_aqcpu = {UL_LOGL_MSG, "fra_aqcpu"};
  68
  69 static int aqcpu_initialized = 0;               /* initialization flag */
  70
  71 /*
  72  * Test whether Aquosa Cpu modue is initialized
  73  */
  74 static inline int aqcpu_is_initialized()
  75 {
  76         return (aqcpu_initialized == 1);
  77 }
  78
  79
  80
  81 static int aqcpu_create_vres(fres_vres_t *vres, void *priv)
  82 {
  83         aqcpu_params_t cpu_params;
  84         qres_sid_t sid;
  85         qos_rv rv;
  86
  87         /* get aqcpu params from contract */
  88         get_aqcpu_params(vres, &cpu_params);
  89         /* create cpu vres */
  90         rv = qres_create_server(&cpu_params, &sid);
  91         if (rv != QOS_OK) {
  92                 return qos_rv_int(rv);
  93         }
  94
  95         printf("Created AQCPU VRES(sid=%d period=%lld us, budget=%lld us)\n",
  96                         sid, cpu_params.P, cpu_params.Q);
  97         if ((vres->priv = malloc(sizeof(qres_sid_t)))) {
  98                 memcpy(vres->priv, &sid, sizeof(qres_sid_t));
  99         }
 100
 101         return 0;
 102 }
 103
 104 /*
 105  * aqcpu_cancel_vres(), cancels vres
 106  *
 107  * The thread bound to the vres are unbound, and so, detached from their
 108  * AQuoSA resource reservation servers and continue their execution according
 109  * to the standard Linux scheduler policies.
 110  *
 111  */
 112 static int aqcpu_cancel_vres(fres_vres_t *vres, void *priv)
 113 {
 114         qres_sid_t sid;
 115         qos_rv qrv;
 116
 117         if (vres->priv) {
 118                 errno = -EINVAL;
 119                 return -1;
 120         }
 121         memcpy(&sid, vres->priv, sizeof(qres_sid_t));
 122
 123         qrv = qres_destroy_server(sid);
 124         if (qrv != QOS_OK) {
 125                 return qos_rv_int(qrv);
 126         }
 127         printf("Canceled AQCPU VRES(sid=%d)\n",sid);
 128         free(vres->priv);
 129
 130         return 0;
 131 }
 132
 133 /* aqcpu_vres_change(), change some parameters of a vres
 134  *
 135  * In fact, since that AQuoSA call doesn't deal with _its_ Q_min (budget_min
 136  * for in FRSH semantic) parameter all the renegotiation will be accepted but
 137  * the new temporal behaviour is not guaranteed!
 138  * Obviously this is a bug and should/will be corrected in AQuoSA as soon as
 139  * possible.
 140  *
 141  */
 142 int aqcpu_change_vres(fres_vres_t *vres, void *priv)
 143 {
 144         aqcpu_params_t cpu_params;
 145         qres_sid_t sid;
 146         qos_rv qrv;
 147
 148         if (vres->priv) {
 149                 errno = -EINVAL;
 150                 return -1;
 151         }
 152         memcpy(&sid, vres->priv, sizeof(qres_sid_t));
 153
 154         /* get aqcpu params from contract */
 155         get_aqcpu_params(vres, &cpu_params);
 156
 157         /* set cpu params */
 158         qrv = qres_set_params(sid, &cpu_params);
 159
 160         ul_logmsg("AQCPU VRES(sid=%d) params changed(period=%lld us,"
 161                         "budget=%lld us)\n",sid, cpu_params.P,cpu_params.Q);
 162
 163         return 0;
 164 }
 165
 166 static struct fres_allocator aqcpu_allocator = {
 167         .res_type = FRSH_RT_PROCESSOR,
 168         .res_id = 0,  /* CPU ID 0 */
 169         .create_vres = aqcpu_create_vres,
 170         .cancel_vres = aqcpu_cancel_vres,
 171         .change_vres = aqcpu_change_vres,
 172         .priv = NULL
 173 };
 174
 175 /*
 176  * installed as an exit handler (with 'atexit()') by the initialization
 177  * code... For now it only calls the cleanup function of the AQuoSA
 178  * Framework
 179  */
 180 static inline void aqcpu_cleanup_wrapper() {
 181         qres_cleanup();
 182 }
 183
 184 /*
 185  * aqcpu_fra_init(), initialize FRSH for the calling process
 186  *
 187  * Must be called before starting using the framework.
 188  * No FRSH call will be successful if this routine is not invoked
 189  *
 190  * Note that no BACKGROUND is created and negotiated and the caller thread
 191  * is bound to no BACKGROUND vres, since no way is provided in order of
 192  * specifying the contract label and get back the vres id!
 193  *
 194  * Note also that, since in this implementation the threads/processes with
 195  * backgound contracts are left into the default Linux scheduler hands' and
 196  * not attached to any AQuoSA server, while we're violating what D-AC2v1
 197  * (pag. 14) says, we achieve exactly the same behaviour!!
 198  *
 199  * possible return values:
 200  *  FRSH_NO_ERROR
 201  *  FRSH_ERR_ALREADY_INITIALIZED
 202  *  FRSH_ERR_INTERNAL_ERROR (something, different from the previous case, gone wrong)
 203  */
 204 int aqcpu_fra_init(void)
 205 {
 206         qos_rv qrv;
 207         int rv;
 208
 209         if ((qrv = qres_init()) != QOS_OK) {
 210                 errno = -EPERM;
 211                 return -1;
 212         }
 213
 214         if ((rv = fra_register(&aqcpu_allocator))) {
 215                 qres_cleanup();
 216                 return rv;
 217         }
 218
 219         /* install the cleanup function of th AQuoSA framework as an exit
 220          * handler function (quite futile but, for now, it's sufficent) */
 221         if (atexit(aqcpu_cleanup_wrapper))
 222                 return(FRSH_ERR_INTERNAL_ERROR);
 223
 224         aqcpu_initialized = 1;
 225
 226         return 0;
 227 }
 228
 229 int aqcpu_fra_exit()
 230 {
 231         qos_rv rv;
 232
 233         rv = qres_cleanup();
 234         return qos_rv_int(rv);
 235 }
 236
 237 int fra_CPU_bind_thread
 238   (const fres_vres_t *vres,
 239    const fosa_thread_id_t thread)
 240 {
 241         qos_rv  qrv;
 242         qres_sid_t sid = *((qres_sid_t*)vres->priv);
 243
 244         if ((qrv = qres_attach_thread(sid, thread.linux_pid,
 245             thread.linux_tid)) != QOS_OK)
 246                 goto err;
 247
 248         return 0;
 249 err:
 250         return -1;
 251 }
 252
 253 int fra_CPU_unbind_thread(const fosa_thread_id_t thread)
 254 {
 255         qos_rv  qrv;
 256         qres_sid_t  sid;
 257
 258         if (qres_get_sid(thread.linux_pid, thread.linux_tid, &sid) != QOS_OK)
 259                 goto err;
 260
 261         if ((qrv = qres_detach_thread(sid, thread.linux_pid,
 262             thread.linux_tid)) != QOS_OK)
 263                 goto err;
 264
 265         return 0;
 266 err:
 267         return -1;
 268 }
 269
 270 int fra_CPU_get_usage
 271   (const fres_vres_t *vres,
 272    fosa_rel_time_t *spent)
 273 {
 274         qres_sid_t sid = *((qres_sid_t*)vres->priv);
 275         qres_time_t exec_budget;
 276         qos_rv rv;
 277
 278         if (!spent)
 279                 return FRSH_ERR_BAD_ARGUMENT;
 280
 281         rv = qres_get_exec_time(sid, &exec_budget, NULL);
 282         if (rv != QOS_OK) return EINVAL;
 283
 284         *spent = fosa_usec_to_rel_time(exec_budget);
 285
 286         return 0;
 287 }
 288
 289 int fra_CPU_get_job_usage
 290   (const fres_vres_t *vres,
 291    fosa_rel_time_t *spent)
 292 {
 293         qres_sid_t sid = *((qres_sid_t*)vres->priv);
 294         qres_params_t q_params;
 295         qres_time_t curr_budget;
 296         qos_rv rv;
 297
 298         if (!spent)
 299                 return FRSH_ERR_BAD_ARGUMENT;
 300
 301         rv = qres_get_params(sid, &q_params);
 302         if (rv != QOS_OK) return EINVAL;
 303         rv = qres_get_curr_budget(sid, &curr_budget);
 304         if (rv != QOS_OK) return EINVAL;
 305
 306         *spent = fosa_usec_to_rel_time(q_params.Q - curr_budget);
 307
 308         return 0;
 309 }
 310
 311 int fra_CPU_get_remaining_budget
 312   (const fres_vres_t *vres,
 313    fosa_rel_time_t *budget)
 314 {
 315         qres_sid_t sid = *((qres_sid_t*)vres->priv);
 316         qres_time_t curr_budget;
 317         qos_rv rv;
 318
 319         if (!budget)
 320                 return FRSH_ERR_BAD_ARGUMENT;
 321
 322         rv = qres_get_curr_budget(sid, &curr_budget);
 323         if (rv != QOS_OK) return EINVAL;
 324
 325         *budget = fosa_usec_to_rel_time(curr_budget);
 326
 327         return 0;
 328 }
 329
 330 int fra_CPU_set_spare_bandwidth(fres_vres_t *vres)
 331 {
 332         qres_sid_t fake_sid = (qres_sid_t) -1;
 333         aqcpu_params_t cpu_params;
 334         qos_rv rv;
 335
 336         /* get aqcpu params from contract */
 337         get_aqcpu_params(vres, &cpu_params);
 338
 339
 340         /* reserve CPU bandwidth for feedback */
 341         rv = qsup_reserve_spare(r2bw(cpu_params.Q, cpu_params.P));
 342         if (rv != QOS_OK) return qos_rv_int(rv);
 343
 344         printf("Created AQCPU spare (period=%lld us, budget=%lld us)\n",
 345                         cpu_params.P, cpu_params.Q);
 346         if ((vres->priv = malloc(sizeof(qres_sid_t)))) {
 347                 memcpy(vres->priv, &fake_sid, sizeof(qres_sid_t));
 348         }
 349
 350         return 0;
 351 }
 352
 353 int fra_CPU_get_desired_budget
 354   (fres_vres_t *vres,
 355    frsh_rel_time_t *p_budget_out)
 356 {
 357         qres_sid_t sid = *((qres_sid_t*)vres->priv);
 358         qres_params_t q_params;
 359         qos_rv rv;
 360
 361         if (!p_budget_out)
 362                 return FRSH_ERR_BAD_ARGUMENT;
 363
 364         rv = qres_get_params(sid, &q_params);
 365         if (rv != QOS_OK) return EINVAL;
 366
 367         *p_budget_out = fosa_usec_to_rel_time(q_params.Q);
 368
 369         return 0;
 370 }
 371
 372 int fra_CPU_set_desired_budget
 373   (fres_vres_t *vres,
 374    fosa_rel_time_t *p_budget_in)
 375 {
 376         qres_sid_t sid = *((qres_sid_t*)vres->priv);
 377         qres_params_t q_params;
 378         qos_rv rv;
 379
 380         if (!p_budget_in)
 381                 return FRSH_ERR_BAD_ARGUMENT;
 382
 383         rv = qres_get_params(sid, &q_params);
 384         if (rv != QOS_OK) return EINVAL;
 385
 386         q_params.Q = fosa_rel_time_to_usec(*p_budget_in);
 387
 388         rv = qres_set_params(sid, &q_params);
 389         if (rv != QOS_OK) return EINVAL;
 390
 391         return 0;
 392 }
 393
 394 int fra_CPU_get_actual_budget
 395   (fres_vres_t *vres,
 396    fosa_rel_time_t *budget)
 397 {
 398         qres_sid_t sid = *((qres_sid_t*)vres->priv);
 399         qres_time_t appr_budget;
 400         qos_rv rv;
 401
 402         if (!budget)
 403                 return FRSH_ERR_BAD_ARGUMENT;
 404
 405         rv = qres_get_appr_budget(sid, &appr_budget);
 406         if (rv != QOS_OK) return EINVAL;
 407
 408         *budget = fosa_usec_to_rel_time(appr_budget);
 409
 410         return 0;
 411 }
 412