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