frsh_hierarchical.h

   1 // -----------------------------------------------------------------------
   2 //  Copyright (C) 2006 - 2009 FRESCOR consortium partners:
   3 //
   4 //    Universidad de Cantabria,              SPAIN
   5 //    University of York,                    UK
   6 //    Scuola Superiore Sant'Anna,            ITALY
   7 //    Kaiserslautern University,             GERMANY
   8 //    Univ. Politécnica  Valencia,           SPAIN
   9 //    Czech Technical University in Prague,  CZECH REPUBLIC
  10 //    ENEA                                   SWEDEN
  11 //    Thales Communication S.A.              FRANCE
  12 //    Visual Tools S.A.                      SPAIN
  13 //    Rapita Systems Ltd                     UK
  14 //    Evidence                               ITALY
  15 //
  16 //    See http://www.frescor.org for a link to partners' websites
  17 //
  18 //           FRESCOR project (FP6/2005/IST/5-034026) is funded
  19 //        in part by the European Union Sixth Framework Programme
  20 //        The European Union is not liable of any use that may be
  21 //        made of this code.
  22 //
  23 //
  24 //  based on previous work (FSF) done in the FIRST project
  25 //
  26 //   Copyright (C) 2005  Mälardalen University, SWEDEN
  27 //                       Scuola Superiore S.Anna, ITALY
  28 //                       Universidad de Cantabria, SPAIN
  29 //                       University of York, UK
  30 //
  31 //   FSF API web pages: http://marte.unican.es/fsf/docs
  32 //                      http://shark.sssup.it/contrib/first/docs/
  33 //
  34 //   This file is part of FRSH (FRescor ScHeduler)
  35 //
  36 //  FRSH is free software; you can redistribute it and/or modify it
  37 //  under terms of the GNU General Public License as published by the
  38 //  Free Software Foundation; either version 2, or (at your option) any
  39 //  later version.  FRSH is distributed in the hope that it will be
  40 //  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  41 //  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  42 //  General Public License for more details. You should have received a
  43 //  copy of the GNU General Public License along with FRSH; see file
  44 //  COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,
  45 //  Cambridge, MA 02139, USA.
  46 //
  47 //  As a special exception, including FRSH header files in a file,
  48 //  instantiating FRSH generics or templates, or linking other files
  49 //  with FRSH objects to produce an executable application, does not
  50 //  by itself cause the resulting executable application to be covered
  51 //  by the GNU General Public License. This exception does not
  52 //  however invalidate any other reasons why the executable file might be
  53 //  covered by the GNU Public License.
  54 // -----------------------------------------------------------------------
  55 //frsh_hierarchical.h
  56
  57 //==============================================
  58 //  ******** *******    ********  **      **
  59 //  **///// /**////**  **//////  /**     /**
  60 //  **      /**   /** /**        /**     /**
  61 //  ******* /*******  /********* /**********
  62 //  **////  /**///**  ////////** /**//////**
  63 //  **      /**  //**        /** /**     /**
  64 //  **      /**   //** ********  /**     /**
  65 //  //       //     // ////////   //      //
  66 //
  67 // FRSH(FRescor ScHeduler), pronounced "fresh"
  68 //==============================================
  69 #ifndef _FRSH_HIERARCHICAL_H_
  70 #define _FRSH_HIERARCHICAL_H_
  71
  72 #include <time.h>
  73 #include "frsh_hierarchical_types.h"
  74 #include "frsh_core.h"
  75
  76 FRSH_CPP_BEGIN_DECLS
  77
  78 #define FRSH_HIERARCHICAL_MODULE_SUPPORTED       1
  79
  80 /**
  81  * @file frsh_hierarchical.h
  82  **/
  83
  84 /**
  85  * @defgroup hierarchical Hierarchical Scheduling Module
  86  *
  87  * This module includes the types and functions to use local
  88  * schedulers within vres allowing to attach more than one thread
  89  * to a vres and define an scheduling policy within.
  90  *
  91  * @{
  92  **/
  93
  94 /**
  95  * frsh_local_scheduler_init()
  96  *
  97  *  This call has the following effects:
  98  *    FP:  none \n
  99  *    EDF: none \n
 100  *    TABLE_DRIVEN :
 101  *       Records the schedule duration, and starts the
 102  *       schedule at the time of the call. After the
 103  *       schedule duration has elapsed, the schedule in
 104  *       the table is repeated.
 105  *
 106  *  @return 0 if no error \n
 107  *    FRSH_ERR_BAD_ARGUMENT : if the value of the vres argument is not in range,
 108  *      or info is NULL \n
 109  *    FRSH_ERR_NOT_SCHEDULED_CALLING_THREAD : if the calling thread is not
 110  *      scheduled under the FRSH \n
 111  *    FRSH_ERR_INVALID_SCHEDULER_REPLY : the scheduler is wrong or not
 112  *      running \n
 113  *    FRSH_ERR_NOT_CONTRACTED_VRES : if the vres of the calling thread
 114  *      has been cancelled or it is not valid
 115  **/
 116 int frsh_local_scheduler_init(
 117    frsh_vres_id_t       vres,
 118    frsh_sched_init_info_t info);
 119
 120
 121 /**
 122  * frsh_contract_set_sched_policy()
 123  *
 124  *  The operation updates the specified contract parameters object by
 125  *  setting its scheduling policy to the specified input parameter.
 126  *  The default policy is FRSH_NONE, which means that only one thread
 127  *  may be bound to the vres
 128  *
 129  *  @return 0 if no error \n
 130  *    FRSH_ERR_BAD_ARGUMENT : if sched_policy is not in range,
 131  *     or contract is NULL
 132  **/
 133 int frsh_contract_set_sched_policy
 134   (frsh_contract_t *contract,
 135    frsh_sched_policy_t         sched_policy);
 136
 137
 138 /**
 139  * frsh_contract_get_sched_policy()
 140  *
 141  * This operation obtains from the specified contract parameters
 142  * object its scheduling policy, and copies it to the place pointed to
 143  * by the corresponding input parameter.
 144  *
 145  *  @return 0 if no error \n
 146  *     FRSH_ERR_BAD_ARGUMENT : if sched_policy or contract are NULL
 147  **/
 148 int frsh_contract_get_sched_policy
 149   (const frsh_contract_t *contract,
 150    frsh_sched_policy_t              *sched_policy);
 151
 152
 153 /**
 154  * frsh_thread_create_local()
 155  *
 156  * This operation creates a thread and binds it to the specified
 157  * vres, which must have a policy different than FRSH_NONE. The new
 158  * thread is created with the arguments thread, attr, thread_code and
 159  * arg as they are defined for the pthread_create() POSIX function
 160  * call, and its local scheduling parameters are set to the value
 161  * stored in the variable pointed to by sched_params, which must be
 162  * compatible with the vres's scheduling policy. Then, the function
 163  * binds the created thread to the new vres. The attr /parameter is
 164  * overwritten as necessary to introduce the adequate scheduling
 165  * policy and priority, according to the preemption level given in the
 166  * contract and the frsh_priority_map() function defined by the user.
 167  *
 168  * @return 0 if no error \n
 169  *   FRSH_ERR_BAD_ARGUMENT : if the value of the vres argument is not in range,
 170  *     or sched_params is NULL \n
 171  *   FRSH_ERR_SCHED_POLICY_NOT_COMPATIBLE : if the scheduling policy
 172  *     in sched_params is not compatible to the vres's one \n
 173  *   FRSH_ERR_INTERNAL_ERROR : erroneous binding or malfunction of the FRSH
 174  *     main scheduler \n
 175  *   FRSH_ERR_NOT_CONTRACTED_VRES : if the referenced vres is not
 176  *     valid \n
 177  *   FRSH_ERR_VRES_WORKLOAD_NOT_COMPATIBLE: if the kind of workload
 178  *     of the vres is FRSH_OVERHEAD \n
 179  *   .
 180  *   It may also return any of  the errors that may be returned by the
 181  *   pthread_create()POSIX function call
 182  **/
 183 int frsh_thread_create_local(frsh_vres_id_t      vres,
 184                              frsh_sched_params_t   *sched_params,
 185                              frsh_thread_id_t             *thread,
 186                              frsh_thread_attr_t        *attr,
 187                              frsh_thread_code_t      thread_code,
 188                              void                  *arg);
 189
 190 /**
 191  * frsh_thread_bind_local()
 192  *
 193  * This operation associates a thread with a vres, which must have a
 194  * policy different than FRSH_NONE. The thread's local scheduling
 195  * parameters are set to the value stored in the variable pointed to
 196  * by sched_params, which must be compatible with the vres's
 197  * scheduling policy. After the call the thread starts consuming the
 198  * vres's budget and is executed according to the contract
 199  * established for that vres and to its scheduling policy. If the
 200  * thread was already bound to another vres, it is effectively
 201  * unbound from it and bound to the specified one.
 202  *
 203  * Implementation dependent issue: In order to allow the usage of
 204  * application defined schedulers, the given thread must not have the
 205  * scheduling policy SCHED_APP and at the same time be attached to an
 206  * application scheduler different than the frsh scheduler.
 207  *
 208  * @return 0 if no error \n
 209  *   FRSH_ERR_BAD_ARGUMENT : if the vres argument does not complain with
 210  *     the expected format or valid range, the given thread does not exist,
 211  *     or sched_params is NULL \n
 212  *   FRSH_ERR_SCHED_POLICY_NOT_COMPATIBLE : if the scheduling policy
 213  *     in sched_params is not compatible to the vres's one. \n
 214  *   FRSH_ERR_INTERNAL_ERROR : erroneous binding or malfunction of the FRSH
 215  *     main scheduler \n
 216  *   FRSH_ERR_UNKNOWN_APPSCHEDULED_THREAD : if the thread is attached to
 217  *     an application defined scheduler different than the frsh
 218  *     scheduler \n
 219  *   FRSH_ERR_NOT_CONTRACTED_VRES : if the referenced vres is not
 220  *     valid \n
 221  *   FRSH_ERR_VRES_WORKLOAD_NOT_COMPATIBLE: if the kind of workload
 222  *     of the vres is FRSH_OVERHEAD
 223  **/
 224 int frsh_thread_bind_local(frsh_vres_id_t      vres,
 225                            frsh_thread_id_t            thread,
 226                            frsh_sched_params_t  *sched_params);
 227
 228
 229 /**
 230  * frsh_thread_set_local_sched_params()
 231  *
 232  * This function changes the local scheduling parameters of the thread
 233  * to the value pointed to by sched_params. This value must be
 234  * compatible with the scheduling policy of the vres to which the
 235  * thread is bound.
 236  *
 237  * @return 0 if no error \n
 238  *   FRSH_ERR_BAD_ARGUMENT : if the given thread does not exist,
 239  *     or sched_params is NULL \n
 240  *   FRSH_ERR_SCHED_POLICY_NOT_COMPATIBLE : if the thread is already bound
 241  *     and the scheduling policy in sched_params is not compatible to the
 242  *     one of the thread's vres. \n
 243  *   FRSH_ERR_NOT_SCHEDULED_THREAD : if the given thread is not scheduled
 244  *     under FRSH \n
 245  *   FRSH_ERR_INTERNAL_ERROR : erroneous binding or malfunction of the FRSH
 246  *     main scheduler \n
 247  *   FRSH_ERR_UNKNOWN_APPSCHEDULED_THREAD : if the thread is attached to
 248  *     an application defined scheduler different than the frsh
 249  *     scheduler \n
 250  *   FRSH_ERR_NOT_CONTRACTED_VRES : if the thread is bound and its vres
 251  *     is not valid
 252  **/
 253 int frsh_thread_set_local_sched_params (frsh_thread_id_t thread,
 254                           const frsh_sched_params_t  *sched_params);
 255
 256 /**
 257  * frsh_thread_get_local_sched_params()
 258  *
 259  * This function stores the local scheduling parameters of the
 260  * specified thread in the variable pointed to by sched_params.
 261  *
 262  * @return 0 if no error \n
 263  *   FRSH_ERR_BAD_ARGUMENT : if sched_params is NULL or the thread does
 264  *      not exist \n
 265  *   FRSH_ERR_NOT_SCHEDULED_THREAD : if the given thread is not scheduled
 266  *      under FRSH
 267  **/
 268 int frsh_thread_get_local_sched_params(frsh_thread_id_t            thread,
 269                                        frsh_sched_params_t  *sched_params);
 270
 271 /*}*/
 272
 273 FRSH_CPP_END_DECLS
 274
 275 #endif // _FRSH_HIERARCHICAL_H_