frsh_configuration_parameters.h

   1 // -----------------------------------------------------------------------
   2 //  Copyright (C) 2006 - 2008 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_configuration_parameters.h
  56 //==============================================
  57 //  ******** *******    ********  **      **
  58 //  **///// /**////**  **//////  /**     /**
  59 //  **      /**   /** /**        /**     /**
  60 //  ******* /*******  /********* /**********
  61 //  **////  /**///**  ////////** /**//////**
  62 //  **      /**  //**        /** /**     /**
  63 //  **      /**   //** ********  /**     /**
  64 //  //       //     // ////////   //      //
  65 //
  66 // FRSH(FRescor ScHeduler), pronounced "fresh"
  67 //==============================================
  68 #ifndef _FRSH_CONFIGURATION_PARAMETERS_H_
  69 #define _FRSH_CONFIGURATION_PARAMETERS_H_
  70
  71 #include <unistd.h>
  72 #include <frsh_cpp_macros.h>
  73
  74 FRSH_CPP_BEGIN_DECLS
  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 #ifdef ENABLE_FRSH_DISTRIBUTED_MODULE
 109 #define FRSH_DISTRIBUTED_MODULE_SUPPORTED true
 110 #else
 111 #define FRSH_DISTRIBUTED_MODULE_SUPPORTED false
 112 #endif
 113
 114 /** This defines 1 resource_id value for systems that have only one
 115     resource of a kind. **/
 116 #define FRSH_RESOURCE_ID_DEFAULT 0
 117 #define FRSH_CPU_ID_DEFAULT 0
 118 #define FRSH_NETWORK_ID_DEFAULT 0
 119
 120 /**
 121  * @defgroup internal Array size for memory optimization
 122  * @ingroup config
 123  *
 124  * Tune these values for optimizing the amount of memory used by the
 125  * implementation
 126  *
 127  * @{
 128  **/
 129
 130 /** Maximum number of accepted contracts (vres) **/
 131 #define FRSH_MAX_N_VRES                    100
 132
 133 /** Maximum number of threads that may be scheduled by the framework **/
 134 #define FRSH_MAX_N_THREADS                    25
 135
 136 /**
 137  * Maximum number of critical sections that can be stored in a
 138  * contract parameters object
 139  **/
 140 #define FRSH_MAX_N_CRITICAL_SECTIONS          10
 141
 142 /**
 143  * Maximum number of memory areas that can be specified for a
 144  * wite operation in a critical section
 145  **/
 146 #define FRSH_MAX_N_MEMORY_AREAS               4
 147
 148 /**
 149  * Maximum number of utilization values (pairs of budget and period)
 150  * that can be stored in a contract parameters object
 151  **/
 152 #define FRSH_MAX_N_UTILIZATION_VALUES         5
 153
 154 /** Number of importance levels for spare capacity allocation **/
 155 #define FRSH_N_IMPORTANCE_LEVELS     5
 156
 157 /**
 158  * Maximum number of synchronization objects
 159  **/
 160 #define FRSH_MAX_N_SYNCH_OBJECTS              5
 161
 162 /** Maximum number of shared objects **/
 163 #define FRSH_MAX_N_SHARED_OBJECTS             100
 164
 165 /** Maximum number of send and receive endpoints in a single node **/
 166 #define FRSH_MAX_N_ENDPOINTS 10
 167
 168 /** Maximum number of chars for a contract label **/
 169 #define FRSH_CONTRACT_LABEL_MAXLENGTH 15
 170
 171 /*@}*/
 172
 173 /**
 174  * @defgroup schedandservice Scheduler and Service thread parameters
 175  * @ingroup config
 176  *
 177  * The current implementation in MaRTE OS uses the Application-Defined
 178  * Scheduling Interface (proposed to the POSIX standardization
 179  * committee), to create a fixed-priority-based scheduler that
 180  * operates under the rules of the FIRST scheduling framework.
 181  *
 182  * In this implementation there are two special threads:
 183  *   - The application scheduler thread, that
 184  *     implements the scheduler
 185  *
 186  *   - The service thread, that is in charge of
 187  *     negotiating and renegotiating contracts
 188  *     concurrently with the application
 189  *
 190  * The following symbols are necessary to adapt the application to the
 191  * underlying fixed priority scheduler
 192  *
 193  * @{
 194  **/
 195
 196 /**
 197  * Priority assigned to the application scheduler; it should be above
 198  * the priorities of the application threads and of the service
 199  * thread, and it should be at least 1 level below the maximum of the
 200  *  system
 201  **/
 202 #define FRSH_SCHEDULER_PRIORITY       (fosa_get_priority_max() -  FOSA_ADS_SCHEDULER_PRIO_DIFF)
 203
 204 /**
 205  * Real-time signal number reserved for the application scheduler to
 206  * manage its timers.
 207  **/
 208 #define FRSH_SCHEDULER_SIGNAL                 FRSH_SIGNAL_MIN
 209
 210
 211
 212 /**
 213  * The highest priority that can be assigned to an application thread,
 214  * it should be defined as one level less than the
 215  * FRSH_SCHEDULER_PRIORITY
 216  **/
 217 #define FRSH_HIGHEST_THREAD_PRIORITY  (FRSH_SCHEDULER_PRIORITY-1)
 218
 219
 220 /**
 221  * The lowest priority that can be assigned to an application thread,
 222  * it should be at least 1 level above the minimum of the system
 223  **/
 224 #define FRSH_LOWEST_THREAD_PRIORITY    ( fosa_get_priority_min() + 4)
 225
 226 /**
 227  * Each call to the functions that negotiate or renegotiate a contract
 228  * or that change the quality and importance generates a request for
 229  * the service thread that we call a service job.  This job will be
 230  * pending in a queue until executed by the service thread.  The
 231  * following symbol represents the maximum number of requests that can
 232  * be simultaneously queued.
 233  **/
 234 #define FRSH_MAX_N_SERVICE_JOBS  (FRSH_MAX_N_VRES * 2)
 235
 236
 237 /**
 238  * In order to bound the background activity of the scheduler (i.e.,
 239  * the admission tests necessary for the negotiation and
 240  * re-negotiation of contracts), a service thread has been defined. It
 241  * runs at a given priority level and has a budget and period
 242  * assigned.
 243  *
 244  **/
 245
 246 /** Initial period of the service thread (timespec) **/
 247 #define FRSH_SERVICE_THREAD_PERIOD_USECS 5000000 /* 500 msecs */
 248
 249 /** Initial budget of the service thread (timespec) **/
 250 #define FRSH_SERVICE_THREAD_BUDGET_USECS 1000 /* 1 msec */
 251
 252 /**
 253  * Initial priority of the service thread, it has to be lower than the
 254  * FRSH_SCHEDULER_PRIORITY, and is set according to its period and the
 255  * expected response times for reconfiguration or tunning of the
 256  * system.
 257  **/
 258 //#define FRSH_SERVICE_THREAD_PRIORITY          (FRSH_LOWEST_THREAD_PRIORITY+1)
 259 #define FRSH_SERVICE_THREAD_PRIORITY          0
 260
 261
 262 /*@}*/
 263
 264
 265 /**
 266  * @defgroup miscconfig Miscellaneous Config parameters
 267  * @ingroup config
 268  *
 269  * @{
 270  **/
 271
 272 /**
 273  * Maximum number of vres that can be simultaneusly waiting for
 274  * being signaled in a synchronization object
 275  **/
 276 #define FRSH_MAX_N_VRES_IN_SYNCH_OBJECT    4
 277
 278
 279 /**
 280  * Maximum number of events that can be pending to be signaled in a
 281  * synchronization object
 282  **/
 283 #define FRSH_MAX_N_EVENTS_IN_SYNCH_OBJECT    100
 284
 285 /**
 286  * Maximum number of pending replenishments in each sporadic server
 287  **/
 288 #define FRSH_MAX_N_PENDING_REPLENISHMENTS     25   //250
 289
 290
 291 /**
 292  * Maximum number of target windows in a table driven schedule
 293  **/
 294 #define FRSH_MAX_N_TARGET_WINDOWS             100
 295
 296 /**
 297  * The cpu time given by the round robin scheduler
 298  * to the threads in the background (timespec)
 299  **/
 300 #define FRSH_RR_SLICE_CPU_TIME_USECS 100000 // 0.1 sec
 301
 302 /**
 303  * This function must be supplied by the user to map the preemption
 304  * level values given in the contracts for the vres, to priority
 305  * values in the range that is allowed by the present implementation
 306  * for application threads. The value returned by the function must
 307  * fit in the interval defined by the constants:
 308  * [FRSH_LOWEST_THREAD_PRIORITY, FRSH_HIGHEST_THREAD_PRIORITY]
 309  **/
 310 int frsh_priority_map (unsigned long plevel);
 311
 312 /**
 313  * This symbol specifies the maximum number of chars that are stored
 314  * of a given shared_object_id, so this is the maximum length used
 315  * in comparisons
 316  **/
 317 #define FRSH_MAX_SIZE_SHARED_OBJ_LABEL           15
 318
 319
 320 /** Maximum number of networks accesible from a node **/
 321 #define FRSH_MAX_N_NETWORK_IDS                1
 322
 323 /**
 324  * Maximum number of groups allocated at the same time
 325  **/
 326 #define FRSH_MAX_N_GROUPS  3
 327
 328 /**
 329  * Maximum number of groups operations (neg, reneg, cancel) per group
 330  **/
 331 #define FRSH_MAX_GROUP_OPS  3
 332
 333 /**
 334  * Default overheads of shared object protection mechanisms
 335  * These values should be calibrated on each specific execution platform
 336  */
 337
 338 // fixed overhead for saving the environment and subsequently
 339 // aborting a critical section; units in nanoseconds
 340
 341 #define FRSH_SO_FIXED_ABORT_OVHD        0
 342
 343
 344 // fixed overhead for copying a memory area, in nanoseconds
 345
 346 #define FRSH_SO_FIXED_AREA_OVHD         0
 347
 348
 349 // variable overhead for copying a memory area; units in nanoseconds per kbyte
 350
 351 #define FRSH_SO_NANOS_PER_KB            0
 352
 353
 354 /* Default memory pool's size in Kbytes */
 355 #define FRSH_DYNAMIC_MEMORY_POOL_SIZE 6670
 356
 357 /*@}*/
 358
 359 /*@}*/
 360
 361 FRSH_CPP_END_DECLS
 362
 363 #endif /* _FRSH_CONFIGURATION_PARAMETERS_H_ */
 364