1 // -----------------------------------------------------------------------
2 // Copyright (C) 2006 - 2007 FRESCOR consortium partners:
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
11 // Thales Communication S.A. FRANCE
12 // Visual Tools S.A. SPAIN
13 // Rapita Systems Ltd UK
16 // See http://www.frescor.org for a link to partners' websites
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
24 // based on previous work (FSF) done in the FIRST project
26 // Copyright (C) 2005 Mälardalen University, SWEDEN
27 // Scuola Superiore S.Anna, ITALY
28 // Universidad de Cantabria, SPAIN
29 // University of York, UK
31 // FSF API web pages: http://marte.unican.es/fsf/docs
32 // http://shark.sssup.it/contrib/first/docs/
34 // This file is part of FRSH API
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)
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.
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
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
57 // -----------------------------------------------------------------------
58 //frsh_configuration_parameters.h
59 //==============================================
60 // ******** ******* ******** ** **
61 // **///// /**////** **////// /** /**
62 // ** /** /** /** /** /**
63 // ******* /******* /********* /**********
64 // **//// /**///** ////////** /**//////**
65 // ** /** //** /** /** /**
66 // ** /** //** ******** /** /**
67 // // // // //////// // //
69 // FRSH(FRescor ScHeduler), pronounced "fresh"
70 //==============================================
71 #ifndef _FRSH_CONFIGURATION_PARAMETERS_H_
72 #define _FRSH_CONFIGURATION_PARAMETERS_H_
77 * @file frsh_configuration_parameters.h
79 * This file contains parameters that govern the capabilities of the
80 * FRescor ScHeduler. They must be in concordance with the respective
86 * @defgroup config Configuration Parameters
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.
97 * This symbol specifies whether the scheduler will make a
98 * schedulability test of the requested contract or not
100 #define FRSH_ADMISSION_TEST_IS_ENABLED true
103 * This symbol specifies whether the service thread will try to
104 * assign automatically the priorities of each vres
106 #define FRSH_AUTOMATIC_PRIO_ASSIGN_ENABLE true
108 #define FRSH_DISTRIBUTED_MODULE_SUPPORTED false
111 /** This defines 1 resource_id value for systems that have only one
112 resource of a kind. **/
113 #define FRSH_RESOURCE_ID_DEFAULT 0
114 #define FRSH_CPU_ID_DEFAULT 1
115 #define FRSH_NETWORK_ID_DEFAULT 0
118 * @defgroup internal Array size for memory optimization
121 * Tune these values for optimizing the amount of memory used by the
127 /** Maximum number of accepted contracts (vres) **/
128 #define FRSH_MAX_N_VRES 125
131 /** Maximum number of threads that may be scheduled by the framework **/
132 #define FRSH_MAX_N_THREADS 25
136 * Maximum number of critical sections that can be stored in a
137 * contract parameters object
139 #define FRSH_MAX_N_CRITICAL_SECTIONS 25
142 * Maximum number of memory areas that can be specified for a
143 * wite operation in a critical section
145 #define FRSH_MAX_N_MEMORY_AREAS 4
148 * Maximum number of utilization values (pairs of budget and period)
149 * that can be stored in a contract parameters object
151 #define FRSH_MAX_N_UTILIZATION_VALUES 5
155 * Maximum number of synchronization objects
157 #define FRSH_MAX_N_SYNCH_OBJECTS 5
160 /** Maximum number of shared objects **/
161 #define FRSH_MAX_N_SHARED_OBJECTS 100
163 /** Maximum number of send and receive endpoints in a single node **/
164 #define FRSH_MAX_N_ENDPOINTS 10
169 * @defgroup schedandservice Scheduler and Service thread parameters
172 * The current implementation in MaRTE OS uses the Application-Defined
173 * Scheduling Interface (proposed to the POSIX standardization
174 * committee), to create a fixed-priority-based scheduler that
175 * operates under the rules of the FIRST scheduling framework.
177 * In this implementation there are two special threads:
178 * - The application scheduler thread, that
179 * implements the scheduler
181 * - The service thread, that is in charge of
182 * negotiating and renegotiating contracts
183 * concurrently with the application
185 * The following symbols are necessary to adapt the application to the
186 * underlying fixed priority scheduler
192 * Priority assigned to the application scheduler; it should be above
193 * the priorities of the application threads and of the service
194 * thread, and it should be at least 1 level below the maximum of the
197 #define FRSH_SCHEDULER_PRIORITY (fosa_get_priority_max() - FOSA_ADS_SCHEDULER_PRIO_DIFF)
200 * Real-time signal number reserved for the application scheduler to
203 #define FRSH_SCHEDULER_SIGNAL FRSH_SIGNAL_MIN
207 * The highest priority that can be assigned to an application thread,
208 * it should be defined as one level less than the
209 * FRSH_SCHEDULER_PRIORITY
211 #define FRSH_HIGHEST_THREAD_PRIORITY (FRSH_SCHEDULER_PRIORITY-1)
215 * The lowest priority that can be assigned to an application thread,
216 * it should be at least 1 level above the minimum of the system
218 #define FRSH_LOWEST_THREAD_PRIORITY ( fosa_get_priority_min() + 4)
221 * Each call to the functions that negotiate or renegotiate a contract
222 * or that change the quality and importance generates a request for
223 * the service thread that we call a service job. This job will be
224 * pending in a queue until executed by the service thread. The
225 * following symbol represents the maximum number of requests that can
226 * be simultaneously queued.
228 #define FRSH_MAX_N_SERVICE_JOBS (FRSH_MAX_N_VRES * 2)
232 * In order to bound the background activity of the scheduler (i.e.,
233 * the admission tests necessary for the negotiation and
234 * re-negotiation of contracts), a service thread has been defined. It
235 * runs at a given priority level and has a budget and period
240 /** Initial period of the service thread (timespec) **/
241 #define FRSH_SERVICE_THREAD_PERIOD {5,0}
243 /** Initial budget of the service thread (timespec) **/
244 #define FRSH_SERVICE_THREAD_BUDGET {0,1000000}
247 * Initial priority of the service thread, it has to be lower than the
248 * FRSH_SCHEDULER_PRIORITY, and is set according to its period and the
249 * expected response times for reconfiguration or tunning of the
252 #define FRSH_SERVICE_THREAD_PRIORITY (FRSH_LOWEST_THREAD_PRIORITY+1) //3 3 //3 1
259 * @defgroup miscconfig Miscellaneous Config parameters
266 * Maximum number of vres that can be simultaneusly waiting for
267 * being signaled in a synchronization object
269 #define FRSH_MAX_N_VRES_IN_SYNCH_OBJECT 4
273 * Maximum number of events that can be pending to be signaled in a
274 * synchronization object
276 #define FRSH_MAX_N_EVENTS_IN_SYNCH_OBJECT 100
279 * Maximum number of pending replenishments in each sporadic server
281 #define FRSH_MAX_N_PENDING_REPLENISHMENTS 25 //250
285 * Maximum number of target windows in a table driven schedule
287 #define FRSH_MAX_N_TARGET_WINDOWS 100
290 * The cpu time given by the round robin scheduler
291 * to the threads in the background (timespec)
293 #define FRSH_RR_SLICE_CPU_TIME {0,100000000} //3 0.1 sec
296 * This function must be supplied by the user to map the preemption
297 * level values given in the contracts for the vres, to priority
298 * values in the range that is allowed by the present implementation
299 * for application threads. The value returned by the function must
300 * fit in the interval defined by the constants:
301 * [FRSH_LOWEST_THREAD_PRIORITY, FRSH_HIGHEST_THREAD_PRIORITY]
303 int frsh_priority_map (unsigned long plevel);
306 * This symbol specifies the maximum number of chars that are stored
307 * of a given shared_object_id, so this is the maximum length used
310 #define FRSH_MAX_SIZE_SHARED_OBJ_LABEL 15
313 /** Maximum number of networks accesible from a node **/
314 #define FRSH_MAX_N_NETWORK_IDS 1
317 * Maximum number of vres that can be given in a vres list
318 * to the group negotiation/cancellation primitive
320 #define FRSH_MAX_N_VRES_VALUES 10
323 * Maximum number of contracts that can be given in a contracts list
324 * to the group negotiation/cancellation primitive
326 #define FRSH_MAX_N_CONTRACT_VALUES 10
329 * Default overheads of shared object protection mechanisms
330 * These values should be calibrated on each specific execution platform
333 // fixed overhead for saving the environment and subsequently
334 // aborting a critical section; units in nanoseconds
336 #define FRSH_SO_FIXED_ABORT_OVHD 0
339 // fixed overhead for copying a memory area, in nanoseconds
341 #define FRSH_SO_FIXED_AREA_OVHD 0
344 // variable overhead for copying a memory area; units in nanoseconds per kbyte
346 #define FRSH_SO_NANOS_PER_KB 0
353 #endif /* _FRSH_CONFIGURATION_PARAMETERS_H_ */