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 "aqcpu_contract.h"
  63
  64 UL_LOG_CUST(ulogd_fra_aqcpu);
  65 //ul_log_domain_t ulogd_fra_aqcpu = {UL_LOGL_MSG, "fra_aqcpu"};
  66
  67 static int aqcpu_initialized = 0;               /* initialization flag */
  68
  69 /*
  70  * Test whether Aquosa Cpu modue is initialized
  71  */
  72 static inline int aqcpu_is_initialized()
  73 {
  74         return (aqcpu_initialized == 1);
  75 }
  76
  77
  78
  79 static int aqcpu_create_vres(fres_vres_t *vres, void *priv)
  80 {
  81         aqcpu_params_t cpu_params;
  82         qres_sid_t sid;
  83         qos_rv rv;
  84
  85         /* get aqcpu params from contract */
  86         get_aqcpu_params(vres, &cpu_params);
  87         /* create cpu vres */
  88         rv = qres_create_server(&cpu_params, &sid);
  89         if (rv != QOS_OK) {
  90                 return qos_rv_int(rv);
  91         }
  92
  93         printf("Created AQCPU VRES(sid=%d period=%lld us, budget=%lld us)\n",
  94                         sid, cpu_params.P, cpu_params.Q);
  95         if ((vres->priv = malloc(sizeof(qres_sid_t)))) {
  96                 memcpy(vres->priv, &sid, sizeof(qres_sid_t));
  97         }
  98
  99         return 0;
 100 }
 101
 102 /*
 103  * aqcpu_cancel_vres(), cancels vres
 104  *
 105  * The thread bound to the vres are unbound, and so, detached from their
 106  * AQuoSA resource reservation servers and continue their execution according
 107  * to the standard Linux scheduler policies.
 108  *
 109  */
 110 static int aqcpu_cancel_vres(fres_vres_t *vres, void *priv)
 111 {
 112         qres_sid_t sid;
 113         qos_rv qrv;
 114
 115         if (vres->priv) {
 116                 errno = -EINVAL;
 117                 return -1;
 118         }
 119         memcpy(&sid, vres->priv, sizeof(qres_sid_t));
 120
 121         qrv = qres_destroy_server(sid);
 122         if (qrv != QOS_OK) {
 123                 return qos_rv_int(qrv);
 124         }
 125         printf("Canceled AQCPU VRES(sid=%d)\n",sid);
 126         free(vres->priv);
 127
 128         return 0;
 129 }
 130
 131 /* aqcpu_vres_change(), change some parameters of a vres
 132  *
 133  * In fact, since that AQuoSA call doesn't deal with _its_ Q_min (budget_min
 134  * for in FRSH semantic) parameter all the renegotiation will be accepted but
 135  * the new temporal behaviour is not guaranteed!
 136  * Obviously this is a bug and should/will be corrected in AQuoSA as soon as
 137  * possible.
 138  *
 139  */
 140 int aqcpu_change_vres(fres_vres_t *vres, void *priv)
 141 {
 142         aqcpu_params_t cpu_params;
 143         qres_sid_t sid;
 144         qos_rv qrv;
 145
 146         if (vres->priv) {
 147                 errno = -EINVAL;
 148                 return -1;
 149         }
 150         memcpy(&sid, vres->priv, sizeof(qres_sid_t));
 151
 152         /* get aqcpu params from contract */
 153         get_aqcpu_params(vres, &cpu_params);
 154
 155         /* set cpu params */
 156         qrv = qres_set_params(sid, &cpu_params);
 157
 158         ul_logmsg("AQCPU VRES(sid=%d) params changed(period=%lld us,"
 159                         "budget=%lld us)\n",sid, cpu_params.P,cpu_params.Q);
 160
 161         return 0;
 162 }
 163
 164 static struct fres_allocator aqcpu_allocator = {
 165         .res_type = FRSH_RT_PROCESSOR,
 166         .res_id = 0,  /* CPU ID 0 */
 167         .create_vres = aqcpu_create_vres,
 168         .cancel_vres = aqcpu_cancel_vres,
 169         .change_vres = aqcpu_change_vres,
 170         .priv = NULL
 171 };
 172
 173 /*
 174  * installed as an exit handler (with 'atexit()') by the initialization
 175  * code... For now it only calls the cleanup function of the AQuoSA
 176  * Framework
 177  */
 178 static inline void aqcpu_cleanup_wrapper() {
 179         qres_cleanup();
 180 }
 181
 182 /*
 183  * aqcpu_fra_init(), initialize FRSH for the calling process
 184  *
 185  * Must be called before starting using the framework.
 186  * No FRSH call will be successful if this routine is not invoked
 187  *
 188  * Note that no BACKGROUND is created and negotiated and the caller thread
 189  * is bound to no BACKGROUND vres, since no way is provided in order of
 190  * specifying the contract label and get back the vres id!
 191  *
 192  * Note also that, since in this implementation the threads/processes with
 193  * backgound contracts are left into the default Linux scheduler hands' and
 194  * not attached to any AQuoSA server, while we're violating what D-AC2v1
 195  * (pag. 14) says, we achieve exactly the same behaviour!!
 196  *
 197  * possible return values:
 198  *  FRSH_NO_ERROR
 199  *  FRSH_ERR_ALREADY_INITIALIZED
 200  *  FRSH_ERR_INTERNAL_ERROR (something, different from the previous case, gone wrong)
 201  */
 202 int aqcpu_fra_init(void)
 203 {
 204         qos_rv qrv;
 205         int rv;
 206
 207         if ((qrv = qres_init()) != QOS_OK) {
 208                 errno = -EPERM;
 209                 return -1;
 210         }
 211
 212         if ((rv = fra_register(&aqcpu_allocator))) {
 213                 qres_cleanup();
 214                 return rv;
 215         }
 216
 217         /* install the cleanup function of th AQuoSA framework as an exit
 218          * handler function (quite futile but, for now, it's sufficent) */
 219         if (atexit(aqcpu_cleanup_wrapper))
 220                 return(FRSH_ERR_INTERNAL_ERROR);
 221
 222         aqcpu_initialized = 1;
 223
 224         return 0;
 225 }
 226
 227 int aqcpu_fra_exit()
 228 {
 229         qos_rv rv;
 230
 231         rv = qres_cleanup();
 232         return qos_rv_int(rv);
 233 }