frsh_configuration_parameters.h

   1 // -----------------------------------------------------------------------
   2 //  Copyright (C) 2006 - 2007 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 API
  35 //
  36 //  FRSH API is free software; you can  redistribute it and/or  modify
  37 //  it under the terms of  the GNU General Public License as published by
  38 //  the Free Software Foundation;  either  version 2, or (at  your option)
  39 //  any later version.
  40 //
  41 //  FRSH API  is distributed  in  the hope  that  it  will  be useful,  but
  42 //  WITHOUT  ANY  WARRANTY;     without  even the   implied   warranty  of
  43 //  MERCHANTABILITY  or  FITNESS FOR  A  PARTICULAR PURPOSE. See  the  GNU
  44 //  General Public License for more details.
  45 //
  46 //  You should have  received a  copy of  the  GNU  General Public License
  47 //  distributed  with  FRSH API;  see file COPYING.   If not,  write to the
  48 //  Free Software  Foundation,  59 Temple Place  -  Suite 330,  Boston, MA
  49 //  02111-1307, USA.
  50 //
  51 //  As a special exception, if you include this header file into source
  52 //  files to be compiled, this header file does not by itself cause
  53 //  the resulting executable to be covered by the GNU General Public
  54 //  License.  This exception does not however invalidate any other
  55 //  reasons why the executable file might be covered by the GNU General
  56 //  Public License.
  57 // -----------------------------------------------------------------------
  58 //frsh_configuration_parameters.h
  59 //==============================================
  60 //  ******** *******    ********  **      **
  61 //  **///// /**////**  **//////  /**     /**
  62 //  **      /**   /** /**        /**     /**
  63 //  ******* /*******  /********* /**********
  64 //  **////  /**///**  ////////** /**//////**
  65 //  **      /**  //**        /** /**     /**
  66 //  **      /**   //** ********  /**     /**
  67 //  //       //     // ////////   //      //
  68 //
  69 // FRSH(FRescor ScHeduler), pronounced "fresh"
  70 //==============================================
  71 #ifndef _FRSH_CONFIGURATION_PARAMETERS_H_
  72 #define _FRSH_CONFIGURATION_PARAMETERS_H_
  73
  74 #include <unistd.h>
  75
  76 /**
  77  * @file frsh_configuration_parameters.h
  78  *
  79  * This file contains parameters that govern the capabilities of the
  80  * FRescor ScHeduler.  They must be in concordance with the respective
  81  * OS configuration.
  82  **/
  83
  84
  85 /**
  86  * @defgroup config Configuration Parameters
  87  *
  88  * Here we define global parameters that will have an important
  89  * influence on FRSH behaviour.  They must also be coherent with the
  90  * respective values in the underlaying OS.
  91  *
  92  * @{
  93  **/
  94
  95
  96 /**
  97  * This symbol specifies whether the scheduler will make a
  98  * schedulability test of the requested contract or not
  99  **/
 100 #define FRSH_ADMISSION_TEST_IS_ENABLED        true
 101
 102 /**
 103  * This symbol specifies whether the service thread will try to
 104  * assign automatically the priorities of each vres
 105  **/
 106 #define FRSH_AUTOMATIC_PRIO_ASSIGN_ENABLE true
 107
 108 #define FRSH_DISTRIBUTED_MODULE_SUPPORTED false
 109
 110 /**
 111  * @defgroup internal Array size for memory optimization
 112  * @ingroup config
 113  *
 114  * Tune these values for optimizing the amount of memory used by the
 115  * implementation
 116  *
 117  * @{
 118  **/
 119
 120 /** Maximum number of accepted contracts (vres) **/
 121 #define FRSH_MAX_N_VRES                    125
 122
 123
 124 /** Maximum number of threads that may be scheduled by the framework **/
 125 #define FRSH_MAX_N_THREADS                    25
 126
 127
 128 /**
 129  * Maximum number of critical sections that can be stored in a
 130  * contract parameters object
 131  **/
 132 #define FRSH_MAX_N_CRITICAL_SECTIONS          25
 133
 134 /**
 135  * Maximum number of memory areas that can be specified for a
 136  * wite operation in a critical section
 137  **/
 138 #define FRSH_MAX_N_MEMORY_AREAS               4
 139
 140 /**
 141  * Maximum number of utilization values (pairs of budget and period)
 142  * that can be stored in a contract parameters object
 143  **/
 144 #define FRSH_MAX_N_UTILIZATION_VALUES         5
 145
 146
 147 /**
 148  * Maximum number of synchronization objects
 149  **/
 150 #define FRSH_MAX_N_SYNCH_OBJECTS              5
 151
 152
 153 /** Maximum number of shared objects **/
 154 #define FRSH_MAX_N_SHARED_OBJECTS             100
 155
 156 /** Maximum number of send and receive endpoints in a single node **/
 157 #define FRSH_MAX_N_ENDPOINTS 10
 158
 159 /*@}*/
 160
 161 /**
 162  * @defgroup schedandservice Scheduler and Service thread parameters
 163  * @ingroup config
 164  *
 165  * The current implementation in MaRTE OS uses the Application-Defined
 166  * Scheduling Interface (proposed to the POSIX standardization
 167  * committee), to create a fixed-priority-based scheduler that
 168  * operates under the rules of the FIRST scheduling framework.
 169  *
 170  * In this implementation there are two special threads:
 171  *   - The application scheduler thread, that
 172  *     implements the scheduler
 173  *
 174  *   - The service thread, that is in charge of
 175  *     negotiating and renegotiating contracts
 176  *     concurrently with the application
 177  *
 178  * The following symbols are necessary to adapt the application to the
 179  * underlying fixed priority scheduler
 180  *
 181  * @{
 182  **/
 183
 184 /**
 185  * Priority assigned to the application scheduler; it should be above
 186  * the priorities of the application threads and of the service
 187  * thread, and it should be at least 1 level below the maximum of the
 188  *  system
 189  **/
 190 #define FRSH_SCHEDULER_PRIORITY               29   //104
 191
 192 /**
 193  * Real-time signal number reserved for the application scheduler to
 194  * manage its timers.
 195  **/
 196 #define FRSH_SCHEDULER_SIGNAL                 FRSH_SIGNAL_MIN
 197
 198
 199 /**
 200  * The highest priority that can be assigned to an application thread,
 201  * it should be defined as one level less than the
 202  * FRSH_SCHEDULER_PRIORITY
 203  **/
 204 #define FRSH_HIGHEST_THREAD_PRIORITY  (FRSH_SCHEDULER_PRIORITY-1)
 205
 206
 207 /**
 208  * The lowest priority that can be assigned to an application thread,
 209  * it should be at least 1 level above the minimum of the system
 210  **/
 211 #define FRSH_LOWEST_THREAD_PRIORITY           5
 212
 213 /**
 214  * Each call to the functions that negotiate or renegotiate a contract
 215  * or that change the quality and importance generates a request for
 216  * the service thread that we call a service job.  This job will be
 217  * pending in a queue until executed by the service thread.  The
 218  * following symbol represents the maximum number of requests that can
 219  * be simultaneously queued.
 220  **/
 221 #define FRSH_MAX_N_SERVICE_JOBS  FRSH_MAX_N_VRES * 2
 222
 223
 224 /**
 225  * In order to bound the background activity of the scheduler (i.e.,
 226  * the admission tests necessary for the negotiation and
 227  * re-negotiation of contracts), a service thread has been defined. It
 228  * runs at a given priority level and has a budget and period
 229  * assigned.
 230  *
 231  **/
 232
 233 /** Initial period of the service thread (timespec) **/
 234 #define FRSH_SERVICE_THREAD_PERIOD  {5,0}
 235
 236 /** Initial budget of the service thread (timespec) **/
 237 #define FRSH_SERVICE_THREAD_BUDGET  {0,1000000}
 238
 239 /**
 240  * Initial priority of the service thread, it has to be lower than the
 241  * FRSH_SCHEDULER_PRIORITY, and is set according to its period and the
 242  * expected response times for reconfiguration or tunning of the
 243  * system.
 244  **/
 245 #define FRSH_SERVICE_THREAD_PRIORITY          (FRSH_LOWEST_THREAD_PRIORITY+1) //3 3    //3 1
 246
 247
 248 /*@}*/
 249
 250
 251 /**
 252  * @defgroup miscconfig Miscellaneous Config parameters
 253  * @ingroup config
 254  *
 255  * @{
 256  **/
 257
 258 /**
 259  * Maximum number of vres that can be simultaneusly waiting for
 260  * being signaled in a synchronization object
 261  **/
 262 #define FRSH_MAX_N_VRES_IN_SYNCH_OBJECT    4
 263
 264
 265 /**
 266  * Maximum number of events that can be pending to be signaled in a
 267  * synchronization object
 268  **/
 269 #define FRSH_MAX_N_EVENTS_IN_SYNCH_OBJECT    100
 270
 271 /**
 272  * Maximum number of pending replenishments in each sporadic server
 273  **/
 274 #define FRSH_MAX_N_PENDING_REPLENISHMENTS     25   //250
 275
 276
 277 /**
 278  * Maximum number of target windows in a table driven schedule
 279  **/
 280 #define FRSH_MAX_N_TARGET_WINDOWS             100
 281
 282 /**
 283  * The cpu time given by the round robin scheduler
 284  * to the threads in the background (timespec)
 285  **/
 286 #define FRSH_RR_SLICE_CPU_TIME               {0,100000000}  //3  0.1 sec
 287
 288 /**
 289  * This function must be supplied by the user to map the preemption
 290  * level values given in the contracts for the vres, to priority
 291  * values in the range that is allowed by the present implementation
 292  * for application threads. The value returned by the function must
 293  * fit in the interval defined by the constants:
 294  * [FRSH_LOWEST_THREAD_PRIORITY, FRSH_HIGHEST_THREAD_PRIORITY]
 295  **/
 296 int frsh_priority_map (unsigned long plevel);
 297
 298 /**
 299  * This symbol specifies the maximum number of chars that are stored
 300  * of a given shared_object_id, so this is the maximum length used
 301  * in comparisons
 302  **/
 303 #define FRSH_MAX_SIZE_SHARED_OBJ_LABEL           15
 304
 305
 306 /** Maximum number of networks accesible from a node **/
 307 #define FRSH_MAX_N_NETWORK_IDS                1
 308
 309 /**
 310  * Maximum number of vres that can be given in a vres list
 311  * to the group negotiation/cancellation primitive
 312  **/
 313 #define FRSH_MAX_N_VRES_VALUES              10
 314
 315 /**
 316  * Maximum number of contracts that can be given in a contracts list
 317  * to the group negotiation/cancellation primitive
 318  **/
 319 #define FRSH_MAX_N_CONTRACT_VALUES              10
 320
 321 /**
 322  * Default overheads of shared object protection mechanisms
 323  * These values should be calibrated on each specific execution platform
 324  */
 325
 326 // fixed overhead for saving the environment and subsequently
 327 // aborting a critical section; units in nanoseconds
 328
 329 #define FRSH_SO_FIXED_ABORT_OVHD        0
 330
 331
 332 // fixed overhead for copying a memory area, in nanoseconds
 333
 334 #define FRSH_SO_FIXED_AREA_OVHD         0
 335
 336
 337 // variable overhead for copying a memory area; units in nanoseconds per kbyte
 338
 339 #define FRSH_SO_NANOS_PER_KB            0
 340
 341
 342 /*@}*/
 343
 344 /*@}*/
 345
 346 #endif /* _FRSH_CONFIGURATION_PARAMETERS_H_ */
 347