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 /**
 104  * @defgroup internal Array size for memory optimization
 105  * @ingroup config
 106  *
 107  * Tune these values for optimizing the amount of memory used by the
 108  * implementation
 109  *
 110  * @{
 111  **/
 112
 113 /** Maximum number of accepted contracts (vres) **/
 114 #define FRSH_MAX_N_VRES                    125
 115
 116
 117 /** Maximum number of threads that may be scheduled by the framework **/
 118 #define FRSH_MAX_N_THREADS                    25
 119
 120
 121 /**
 122  * Maximum number of critical sections that can be stored in a
 123  * contract parameters object
 124  **/
 125 #define FRSH_MAX_N_CRITICAL_SECTIONS          25
 126
 127 /**
 128  * Maximum number of memory areas that can be specified for a
 129  * wite operation in a critical section
 130  **/
 131 #define FRSH_MAX_N_MEMORY_AREAS               4
 132
 133 /**
 134  * Maximum number of utilization values (pairs of budget and period)
 135  * that can be stored in a contract parameters object
 136  **/
 137 #define FRSH_MAX_N_UTILIZATION_VALUES         5
 138
 139
 140 /**
 141  * Maximum number of synchronization objects
 142  **/
 143 #define FRSH_MAX_N_SYNCH_OBJECTS              5
 144
 145
 146 /** Maximum number of shared objects **/
 147 #define FRSH_MAX_N_SHARED_OBJECTS             100
 148
 149 /*@}*/
 150
 151 /**
 152  * @defgroup schedandservice Scheduler and Service thread parameters
 153  * @ingroup config
 154  *
 155  * The current implementation in MaRTE OS uses the Application-Defined
 156  * Scheduling Interface (proposed to the POSIX standardization
 157  * committee), to create a fixed-priority-based scheduler that
 158  * operates under the rules of the FIRST scheduling framework.
 159  *
 160  * In this implementation there are two special threads:
 161  *   - The application scheduler thread, that
 162  *     implements the scheduler
 163  *
 164  *   - The service thread, that is in charge of
 165  *     negotiating and renegotiating contracts
 166  *     concurrently with the application
 167  *
 168  * The following symbols are necessary to adapt the application to the
 169  * underlying fixed priority scheduler
 170  *
 171  * @{
 172  **/
 173
 174 /**
 175  * Priority assigned to the application scheduler; it should be above
 176  * the priorities of the application threads and of the service
 177  * thread, and it should be at least 1 level below the maximum of the
 178  *  system
 179  **/
 180 #define FRSH_SCHEDULER_PRIORITY               29   //104
 181
 182 /**
 183  * Real-time signal number reserved for the application scheduler to
 184  * manage its timers.
 185  **/
 186 #define FRSH_SCHEDULER_SIGNAL                 SIGRTMIN
 187
 188
 189 /**
 190  * The highest priority that can be assigned to an application thread,
 191  * it should be defined as one level less than the
 192  * FRSH_SCHEDULER_PRIORITY
 193  **/
 194 #define FRSH_HIGHEST_THREAD_PRIORITY  FRSH_SCHEDULER_PRIORITY-1
 195
 196
 197 /**
 198  * The lowest priority that can be assigned to an application thread,
 199  * it should be at least 1 level above the minimum of the system
 200  **/
 201 #define FRSH_LOWEST_THREAD_PRIORITY           3
 202
 203 /**
 204  * Each call to the functions that negotiate or renegotiate a contract
 205  * or that change the quality and importance generates a request for
 206  * the service thread that we call a service job.  This job will be
 207  * pending in a queue until executed by the service thread.  The
 208  * following symbol represents the maximum number of requests that can
 209  * be simultaneously queued.
 210  **/
 211 #define FRSH_MAX_N_SERVICE_JOBS  FRSH_MAX_N_VRES * 2
 212
 213
 214 /**
 215  * In order to bound the background activity of the scheduler (i.e.,
 216  * the admission tests necessary for the negotiation and
 217  * re-negotiation of contracts), a service thread has been defined. It
 218  * runs at a given priority level and has a budget and period
 219  * assigned.
 220  *
 221  **/
 222
 223 /** Initial period of the service thread (timespec) **/
 224 #define FRSH_SERVICE_THREAD_PERIOD  {0,10000000}  //    0.01 seg
 225                                 // {0,100000000}  //0.1 seg
 226                                 // {0,10000000}   //3.1 0.01
 227
 228 /** Initial budget of the service thread (timespec) **/
 229 #define FRSH_SERVICE_THREAD_BUDGET  {0,1000000}   //     0.001 seg
 230                                 // {0,10000000}   //0.01 seg
 231                                 // {0,1000000}    //3.1 0.001
 232
 233
 234 /**
 235  * Initial priority of the service thread, it has to be lower than the
 236  * FRSH_SCHEDULER_PRIORITY, and is set according to its period and the
 237  * expected response times for reconfiguration or tunning of the
 238  * system.
 239  **/
 240 #define FRSH_SERVICE_THREAD_PRIORITY          FRSH_LOWEST_THREAD_PRIORITY+1 //3 3    //3 1
 241
 242
 243 /*@}*/
 244
 245
 246 /**
 247  * @defgroup miscconfig Miscellaneous Config parameters
 248  * @ingroup config
 249  *
 250  * @{
 251  **/
 252
 253 /**
 254  * Maximum number of vres that can be simultaneusly waiting for
 255  * being signaled in a synchronization object
 256  **/
 257 #define FRSH_MAX_N_VRES_IN_SYNCH_OBJECT    4
 258
 259
 260 /**
 261  * Maximum number of events that can be pending to be signaled in a
 262  * synchronization object
 263  **/
 264 #define FRSH_MAX_N_EVENTS_IN_SYNCH_OBJECT    100
 265
 266 /**
 267  * Maximum number of pending replenishments in each sporadic server
 268  **/
 269 #define FRSH_MAX_N_PENDING_REPLENISHMENTS     25   //250
 270
 271
 272 /**
 273  * Maximum number of target windows in a table driven schedule
 274  **/
 275 #define FRSH_MAX_N_TARGET_WINDOWS             100
 276
 277 /**
 278  * The cpu time given by the round robin scheduler
 279  * to the threads in the background (timespec)
 280  **/
 281 #define FRSH_RR_SLICE_CPU_TIME               {0,100000000}  //3  0.1 sec
 282
 283 /**
 284  * This function must be supplied by the user to map the preemption
 285  * level values given in the contracts for the vres, to priority
 286  * values in the range that is allowed by the present implementation
 287  * for application threads. The value returned by the function must
 288  * fit in the interval defined by the constants:
 289  * [FRSH_LOWEST_THREAD_PRIORITY, FRSH_HIGHEST_THREAD_PRIORITY]
 290  **/
 291 int frsh_priority_map (unsigned long plevel);
 292
 293 /**
 294  * This symbol specifies the maximum number of chars that are stored
 295  * of a given shared_object_id, so this is the maximum length used
 296  * in comparissons
 297  **/
 298 #define FRSH_MAX_SIZE_SHARED_OBJ_ID           65
 299
 300
 301 /** Maximum number of networks accesible from a node **/
 302 #define FRSH_MAX_N_NETWORK_IDS                1
 303
 304 /**
 305  * Maximum number of vres that can be given in a vres list
 306  * to the group negotiation/cancellation primitive
 307  **/
 308 #define FRSH_MAX_N_VRES_VALUES              10
 309
 310 /**
 311  * Maximum number of contracts that can be given in a contracts list
 312  * to the group negotiation/cancellation primitive
 313  **/
 314 #define FRSH_MAX_N_CONTRACT_VALUES              10
 315
 316 /*@}*/
 317
 318 /*@}*/
 319
 320 #endif /* _FRSH_CONFIGURATION_PARAMETERS_H_ */
 321