1 //----------------------------------------------------------------------
2 // Copyright (C) 2006 - 2007 by the FRESCOR consortium:
4 // Universidad de Cantabria, SPAIN
5 // University of York, UK
6 // Scuola Superiore Sant'Anna, ITALY
7 // Kaiserslautern University, GERMANY
8 // Univ. Politecnica 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
18 // The 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 // This file is part of FOSA (Frsh Operating System Abstraction)
33 // FOSA is free software; you can redistribute it and/or modify it
34 // under terms of the GNU General Public License as published by the
35 // Free Software Foundation; either version 2, or (at your option) any
36 // later version. FOSA is distributed in the hope that it will be
37 // useful, but WITHOUT ANY WARRANTY; without even the implied warranty
38 // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
39 // General Public License for more details. You should have received a
40 // copy of the GNU General Public License along with FOSA; see file
41 // COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,
42 // Cambridge, MA 02139, USA.
44 // As a special exception, including FOSA header files in a file,
45 // instantiating FOSA generics or templates, or linking other files
46 // with FOSA objects to produce an executable application, does not
47 // by itself cause the resulting executable application to be covered
48 // by the GNU General Public License. This exception does not
49 // however invalidate any other reasons why the executable file might be
50 // covered by the GNU Public License.
51 // -----------------------------------------------------------------------
53 //==============================================
54 // ******** ****** ******** **********
55 // **///// /** ** **////// /** /**
56 // ** /** ** /** /** /**
57 // ******* /** ** /********* /**********
58 // **//// /** ** ////////** /**//////**
59 // ** /** ** /** /** /**
60 // ** /** ** ******** /** /**
61 // // /******/ //////// // //
63 // FOSA(Frescor Operating System Adaptation layer)
64 //================================================
66 // Implementation dependent definitions
68 #ifndef _FOSA_OPAQUE_TYPES_H_
69 #define _FOSA_OPAQUE_TYPES_H_
73 #include "fosa_cpp_macros.h"
75 /////////////////////// MARTE_OS /////////////////////////////
89 // typedef struct timespec fosa_rel_time_t;
90 // typedef struct timespec fosa_abs_time_t;
92 /* Thread and signals */
93 /**********************/
94 typedef pthread_t FOSA_THREAD_ID_T_OPAQUE;
95 typedef pthread_attr_t FOSA_THREAD_ATTR_T_OPAQUE;
97 typedef int FOSA_SIGNAL_T_OPAQUE;
98 /* Signal info is defined as a union in thread_and_signals */
100 #define FOSA_SIGNAL_MIN SIGRTMIN
101 #define FOSA_SIGNAL_MAX SIGRTMIN+0
103 #define FOSA_NULL_SIGNAL 0
105 /* Clocks and timers */
106 /**********************/
107 typedef clockid_t FOSA_CLOCK_ID_T_OPAQUE;
108 typedef timer_t FOSA_TIMER_ID_T_OPAQUE;
110 #define FOSA_SYSTEM_CLOCK_OPAQUE CLOCK_MONOTONIC
112 /* Mutex and conditional variables */
113 /***********************************/
114 typedef pthread_mutex_t FOSA_MUTEX_T_OPAQUE;
115 typedef pthread_cond_t FOSA_COND_T_OPAQUE;
118 /* Application defined Scheduling */
119 /**********************************/
121 posix_appsched_actions_t actions;
122 struct timespec *timeout_ptr;
123 struct timespec timeout;
127 } fosa_ads_actions_internal_t;
129 #define FOSA_ADS_ACTIONS_T_OPAQUE fosa_ads_actions_internal_t
133 #include "marte_non_local_jmp.h"
135 #define FOSA_LONG_JUMP_CONTEXT_T_OPAQUE struct { \
136 marte_nonlocaljmp_context_t marte_context; \
137 fosa_thread_id_t tid; \
143 /** Not enough memory available **/
144 #define FOSA_ENOMEM ENOMEM
146 /** Invalid parameter **/
147 #define FOSA_EINVAL EINVAL
149 /** Still pending information **/
150 #define FOSA_EAGAIN EAGAIN
152 /** FOSA ADS errors **/
154 #define EREJECT 201 /* (for linux_lib_arch) Appsched has rejected object */
157 #define FOSA_EREJECT EREJECT
158 #define FOSA_EMASKED -2
159 #define FOSA_EPOLICY -3
161 #define FOSA_ETIMEDOUT ETIMEDOUT
165 /////////////////////// End of MARTE_OS /////////////////////////////
168 /////////////////////// RT_LINUX ///////////////////////////
172 /* Very similar to MARTE_OS but I leave separate for clarity */
179 #include <rtl_timer.h>
183 // typedef struct timespec fosa_rel_time_t;
184 // typedef struct timespec fosa_abs_time_t;
187 /* Threads and signals */
188 /***********************/
189 #define FOSA_THREAD_ID_T_OPAQUE pthread_t
191 typedef pthread_attr_t FOSA_THREAD_ATTR_T_OPAQUE;
192 typedef int FOSA_SIGNAL_T_OPAQUE;
193 /* Signal info is defined as a union in fosa_types.h */
195 // The minimum and maximum signal numbers that may be used by the FRSH
197 #define FOSA_SIGNAL_MIN SIGRTMIN
198 #define FOSA_SIGNAL_MAX SIGRTMIN+0
199 #define FOSA_NULL_SIGNAL 0
201 /* Clocks and timers */
202 /*********************/
203 #define FOSA_CLOCK_ID_T_OPAQUE clockid_t
204 #define FOSA_TIMER_ID_T_OPAQUE timer_t
205 #define FOSA_SYSTEM_CLOCK_OPAQUE CLOCK_MONOTONIC
207 /* Mutex and cond vars */
208 /***********************/
209 typedef pthread_mutex_t FOSA_MUTEX_T_OPAQUE;
210 #define FOSA_COND_T_OPAQUE pthread_cond_t
215 /** Not enough memory available **/
216 #define FOSA_ENOMEM ENOMEM
217 /** Invalid parameter **/
218 #define FOSA_EINVAL EINVAL
219 /** Still pending information **/
220 #define FOSA_EAGAIN EAGAIN
222 /** FOSA ADS errors **/
223 #define FOSA_EREJECT EREJECT
224 #define FOSA_EMASKED -2
225 #define FOSA_EPOLICY -3
227 #define FOSA_ETIMEDOUT ETIMEDOUT
231 /////////////////////// End of RT_LINUX /////////////////////////////
234 ////////////////////////// OSE //////////////////////////////////////
240 // typedef struct timespec fosa_rel_time_t;
241 // typedef struct timespec fosa_abs_time_t;
244 /* Put OSE dependent includes and defines here */
250 /////////////////////// AQuoSA ///////////////////////////
263 // typedef struct timespec fosa_rel_time_t;
264 // typedef struct timespec fosa_abs_time_t;
267 /* Threads and signals */
268 /***********************/
270 pthread_t pthread_id;
273 } FOSA_THREAD_ID_T_OPAQUE;
276 typedef pthread_attr_t FOSA_THREAD_ATTR_T_OPAQUE;
277 typedef int FOSA_SIGNAL_T_OPAQUE;
280 // The minimum and maximum signal numbers that may be used by the FRSH
282 #define FOSA_SIGNAL_MIN SIGRTMIN
283 #define FOSA_SIGNAL_MAX SIGRTMIN+0
285 #define FOSA_NULL_SIGNAL 0
288 /* Clocks and signals */
289 /**********************/
290 #define FOSA_CLOCK_ID_T_OPAQUE clockid_t
291 #define FOSA_SYSTEM_CLOCK_OPAQUE CLOCK_MONOTONIC
292 #define FOSA_TIMER_ID_T_OPAQUE timer_t
296 /* Mutex and cond vars */
297 /***********************/
298 typedef pthread_mutex_t FOSA_MUTEX_T_OPAQUE;
299 #define FOSA_COND_T_OPAQUE pthread_cond_t
302 /* Application Defined Scheduling */
303 /**********************************/
304 /* hack to get AQuoSA sources compile without having none
305 * of the application level scheduler header files and symbols */
306 #define posix_appsched_actions_t int
307 #define FOSA_LONG_JUMP_CONTEXT_T_OPAQUE int
309 #define FOSA_ADS_ACTIONS_T_OPAQUE posix_appsched_actions_t
314 /** Not enough memory available **/
315 #define FOSA_ENOMEM ENOMEM
317 /** Invalid parameter **/
318 #define FOSA_EINVAL EINVAL
320 /** Still pending information **/
321 #define FOSA_EAGAIN EAGAIN
323 #define FOSA_EREJECT EREJECT
324 #define FOSA_EMASKED -2
325 #define FOSA_EPOLICY -3
327 #define FOSA_ETIMEDOUT ETIMEDOUT
331 ////////////////// END of AQuoSA //////////////////////
335 /////////////////////////////////// PARTIKLE ///////////////////////////////////////////
336 #if defined(PARTIKLE)
345 posix_appsched_actions_t actions;
346 struct timespec * timeout_ptr;
347 struct timespec timeout;
351 } fosa_ads_actions_internal_t;
353 typedef pthread_t FOSA_THREAD_ID_T_OPAQUE;
354 typedef pthread_attr_t FOSA_THREAD_ATTR_T_OPAQUE;
355 typedef int FOSA_SIGNAL_T_OPAQUE;
356 typedef fosa_ads_actions_internal_t FOSA_ADS_ACTIONS_T_OPAQUE;
357 typedef clockid_t FOSA_CLOCK_ID_T_OPAQUE;
358 typedef timer_t FOSA_TIMER_ID_T_OPAQUE;
359 typedef pthread_cond_t FOSA_COND_T_OPAQUE;
360 typedef pthread_mutex_t FOSA_MUTEX_T_OPAQUE;
361 typedef void * FOSA_LONG_JUMP_CONTEXT_T_OPAQUE;
364 enum _fosa_clocks_e {
365 FOSA_SYSTEM_CLOCK_OPAQUE = CLOCK_MONOTONIC
368 enum _fosa_signal_limits_e {
369 FOSA_SIGNAL_MIN = SIGRTMIN,
370 FOSA_SIGNAL_MAX = SIGRTMAX,
373 enum _fosa_errors_e {
374 FOSA_EINVAL = EINVAL,
375 FOSA_EAGAIN = EAGAIN,
376 FOSA_EREJECT = EREJECT,
377 FOSA_EMASKED = EMASKED,
378 FOSA_EPOLICY = EPOLICY,
379 FOSA_ETIMEDOUT = ETIMEDOUT,
380 FOSA_ENOMEM = ENOMEM,
384 /////////////////////////////////// PARTIKLE END //////////////////////////////////////
388 ////////////////////////// VIRTUAL TIME //////////////////////////////////////
393 // typedef struct timespec fosa_rel_time_t;
394 // typedef struct timespec fosa_abs_time_t;
398 #define FOSA_THREAD_ID_T_OPAQUE vt_posix_process_t
399 #define FOSA_THREAD_ATTR_T_OPAQUE fosa_thread_attr_t
400 #define FOSA_SIGNAL_T_OPAQUE int
402 #define FOSA_MUTEX_T_OPAQUE fosa_mutex_t
404 // The minimum and maximum signal numbers that may be used by the FRSH
406 #define FOSA_SIGNAL_MIN 8
407 #define FOSA_SIGNAL_MAX 31
409 // the min. and max. priority a fosa thread can have
410 #define FOSA_PRIORITY_MAX VT_PRIORITY_MIN - 1
411 #define FOSA_PRIORITY_MIN VT_PRIORITY_MAX
413 #define FOSA_NULL_SIGNAL 0
415 /* FOSA Errors and return values*/
417 /** Invalid parameter **/
418 #define FOSA_EINVAL -1
420 /** Not enough memory available **/
421 #define FOSA_ENOMEM -2
423 /** Still pending information **/
424 #define FOSA_EAGAIN -3
426 /** Mutex not available **/
427 #define FOSA_EBUSY -4
429 /** Cond var timedout **/
430 #define FOSA_ETIMEDOUT -5
432 /** FOSA ADS errors **/
433 #define FOSA_EREJECT -6
434 #define FOSA_EMASKED -7
437 /** Sched policy not correct */
438 #define FOSA_EPOLICY -8
440 /** the value given by thread_id is not valid for ADS */
441 #define FOSA_ESRCH -9
443 /** retval if no action performed **/
444 #define FOSA_NO_ACTION 0
446 #endif /* VIRTUAL_TIME */
447 //////////////////////////End of VIRTUAL TIME ///////////////////////////////////
450 ////////////////////////// DUMMY_OS //////////////////////////////////////
452 #if defined(DUMMY_OS)
454 /* With this define we make sure that we are truly POSIX and OSE */
455 /* independent at the FRSH code. */
456 /*****************************************************************/
460 // typedef struct timespec fosa_rel_time_t;
461 // typedef struct timespec fosa_abs_time_t;
463 /* Thread and signals */
464 /**********************/
465 typedef int FOSA_THREAD_ID_T_OPAQUE;
466 typedef int FOSA_THREAD_ATTR_T_OPAQUE;
468 typedef int FOSA_SIGNAL_T_OPAQUE;
469 typedef int FOSA_SIGNAL_INFO_T_OPAQUE;
471 /* Signal info is defined as a union in thread_and_signals */
473 #define FOSA_SIGNAL_MIN 42
474 #define FOSA_SIGNAL_MAX 44
476 #define FOSA_NULL_SIGNAL 0
478 /* Clocks and timers */
479 /**********************/
480 typedef int FOSA_CLOCK_ID_T_OPAQUE;
481 typedef int FOSA_TIMER_ID_T_OPAQUE;
483 #define FOSA_SYSTEM_CLOCK_OPAQUE 25
485 /* Mutex and conditional variables */
486 /***********************************/
487 typedef int FOSA_MUTEX_T_OPAQUE;
488 typedef int FOSA_COND_T_OPAQUE;
490 /* Application defined Scheduling */
491 /**********************************/
492 #define FOSA_ADS_ACTIONS_T_OPAQUE int
496 //////////////////////////End of DUMMY_OS ////////////////////////////////////
501 #endif // _FOSA_OPAQUE_TYPES_H_