include/fosa_opaque_types.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 FOSA (Frsh Operating System Adaption)
  35 //
  36 //  FOSA 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.  FOSA 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 FOSA; 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 FOSA header files in a file,
  48 //  instantiating FOSA generics or templates, or linking other files
  49 //  with FOSA 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 //fosa_opaque_types.h
  56 //==============================================
  57 //  ********  ******    ********  **********
  58 //  **///// /**    **  **//////  /**     /**
  59 //  **      /**    ** /**        /**     /**
  60 //  ******* /**    ** /********* /**********
  61 //  **////  /**    ** ////////** /**//////**
  62 //  **      /**    **        /** /**     /**
  63 //  **      /**    **  ********  /**     /**
  64 //  //       /******/  ////////   //      //
  65 //
  66 // FOSA(Frescor Operating System Adaptation layer)
  67 //================================================
  68
  69 // Implementation dependent definitions
  70
  71 #ifndef _FOSA_OPAQUE_TYPES_H_
  72 #define _FOSA_OPAQUE_TYPES_H_
  73
  74 #include <stdbool.h>
  75
  76 #include "fosa_cpp_macros.h"
  77 #include "fosa_opaque_types_time.h"
  78
  79 ///////////////////////  MARTE_OS /////////////////////////////
  80
  81 #ifdef MARTE_OS
  82
  83 #include <pthread.h>
  84 #include <signal.h>
  85 #include <time.h>
  86 #include <sched.h>
  87 #include <errno.h>
  88
  89 FOSA_CPP_BEGIN_DECLS
  90
  91
  92 /* Thread and signals */
  93 /**********************/
  94 typedef pthread_t FOSA_THREAD_ID_T_OPAQUE;
  95 typedef pthread_attr_t FOSA_THREAD_ATTR_T_OPAQUE;
  96
  97 typedef int FOSA_SIGNAL_T_OPAQUE;
  98 /* Signal info is defined as a union in thread_and_signals */
  99
 100 #define FOSA_SIGNAL_MIN       SIGRTMIN
 101 #define FOSA_SIGNAL_MAX       SIGRTMIN+0
 102
 103 #define FOSA_NULL_SIGNAL 0
 104
 105 /* Clocks and timers */
 106 /**********************/
 107 typedef clockid_t FOSA_CLOCK_ID_T_OPAQUE;
 108 typedef timer_t FOSA_TIMER_ID_T_OPAQUE;
 109
 110 #define FOSA_SYSTEM_CLOCK_OPAQUE  CLOCK_MONOTONIC
 111
 112 /* Mutex and conditional variables */
 113 /***********************************/
 114 typedef pthread_mutex_t FOSA_MUTEX_T_OPAQUE;
 115 typedef pthread_cond_t FOSA_COND_T_OPAQUE;
 116
 117
 118 /* Application defined Scheduling */
 119 /**********************************/
 120 #define FOSA_ADS_ACTIONS_T_OPAQUE  struct \
 121 { \
 122     posix_appsched_actions_t actions; \
 123     struct timespec *timeout_ptr; \
 124     struct timespec timeout; \
 125     bool rejected; \
 126     bool suspended; \
 127     bool activated; \
 128 }
 129
 130
 131 /* Local jump */
 132 /**************/
 133 #include "misc/marte_non_local_jmp.h"
 134
 135 #define FOSA_LONG_JUMP_CONTEXT_T_OPAQUE  struct { \
 136   marte_nonlocaljmp_context_t marte_context;      \
 137   fosa_thread_id_t tid;                            \
 138 }
 139
 140
 141 /* Group clocks */
 142 /****************/
 143 typedef marte_thread_set_t FOSA_THREAD_SET_ID_T_OPAQUE;
 144
 145 #define FOSA_NULL_THREAD_SET_ID_OPAQUE 0 /* In MaRTE-OS thread_set_t are
 146                                      * pointers */
 147
 148 /* FOSA errors */
 149 /***************/
 150 /** Not enough memory available **/
 151 #define FOSA_ENOMEM   ENOMEM
 152
 153 /** Invalid parameter **/
 154 #define FOSA_EINVAL   EINVAL
 155
 156 /** Still pending information **/
 157 #define FOSA_EAGAIN   EAGAIN
 158
 159 /** FOSA ADS errors **/
 160 #ifdef MARTE_OS
 161 #define EREJECT   201 /* (for linux_lib_arch) Appsched has rejected object */
 162 #endif
 163
 164 #define FOSA_EREJECT   EREJECT
 165 #define FOSA_EMASKED   -2
 166 #define FOSA_EPOLICY   -3
 167
 168 #define FOSA_ETIMEDOUT ETIMEDOUT
 169
 170 /* Not found in search (non existing thread, thread_set...) */
 171 #define FOSA_ESRCH   ESRCH
 172 #define FOSA_ENOTSUP ENOTSUP
 173
 174 #endif
 175
 176 ///////////////////////  End of MARTE_OS  /////////////////////////////
 177
 178
 179 /////////////////////// RT_LINUX ///////////////////////////
 180
 181 #ifdef RT_LINUX
 182
 183 /* Very similar to MARTE_OS but I leave separate for clarity */
 184
 185 #include <pthread.h>
 186 #include <signal.h>
 187 #include <time.h>
 188 #include <sched.h>
 189 #include <errno.h>
 190 #include <rtl_timer.h>
 191
 192
 193 /* Threads and signals */
 194 /***********************/
 195 #define    FOSA_THREAD_ID_T_OPAQUE pthread_t
 196
 197 typedef pthread_attr_t FOSA_THREAD_ATTR_T_OPAQUE;
 198 typedef int FOSA_SIGNAL_T_OPAQUE;
 199 /* Signal info is defined as a union in fosa_types.h */
 200
 201 // The minimum and maximum signal numbers that may be used by the FRSH
 202 // implementation
 203 #define FOSA_SIGNAL_MIN       SIGRTMIN
 204 #define FOSA_SIGNAL_MAX       SIGRTMIN+0
 205 #define FOSA_NULL_SIGNAL 0
 206
 207 /* Clocks and timers */
 208 /*********************/
 209 #define    FOSA_CLOCK_ID_T_OPAQUE    clockid_t
 210 #define    FOSA_TIMER_ID_T_OPAQUE    timer_t
 211 #define    FOSA_SYSTEM_CLOCK_OPAQUE  CLOCK_MONOTONIC
 212
 213 /* Mutex and cond vars */
 214 /***********************/
 215 typedef pthread_mutex_t FOSA_MUTEX_T_OPAQUE;
 216 #define    FOSA_COND_T_OPAQUE        pthread_cond_t
 217
 218 /* Thread groups */
 219 /*****************/
 220 typedef int FOSA_THREAD_SET_ID_T_OPAQUE
 221
 222 /* FOSA Errors */
 223 /***************/
 224 /** Not enough memory available **/
 225 #define FOSA_ENOMEM   ENOMEM
 226 /** Invalid parameter **/
 227 #define FOSA_EINVAL   EINVAL
 228 /** Still pending information **/
 229 #define FOSA_EAGAIN   EAGAIN
 230
 231 /** FOSA ADS errors **/
 232 #define FOSA_EREJECT   EREJECT
 233 #define FOSA_EMASKED   -2
 234 #define FOSA_EPOLICY   -3
 235
 236 #define FOSA_ETIMEDOUT ETIMEDOUT
 237
 238 #endif
 239
 240 ///////////////////////  End of RT_LINUX  /////////////////////////////
 241
 242
 243 ////////////////////////// OSE    //////////////////////////////////////
 244
 245 #ifdef OSE
 246
 247
 248
 249 /* Put OSE dependent includes and defines here */
 250
 251 #endif /* OSE */
 252
 253
 254
 255 /////////////////////// AQuoSA ///////////////////////////
 256
 257 #ifdef AQuoSA
 258
 259 #include <unistd.h>
 260 #include <linux/unistd.h>
 261
 262 #ifndef _XOPEN_SOURCE
 263 #define _XOPEN_SOURCE 500
 264 #endif
 265 #ifndef __USE_UNIX98
 266 #define __USE_UNIX98
 267 #endif
 268 #include <pthread.h>
 269
 270 #include <signal.h>
 271 #include <setjmp.h>
 272 #include <errno.h>
 273 #include <time.h>
 274
 275 FOSA_CPP_BEGIN_DECLS
 276
 277 /* Local Jump */
 278 /**************/
 279 typedef sigjmp_buf FOSA_LONG_JUMP_CONTEXT_T_OPAQUE;
 280
 281
 282 /* Threads and signals */
 283 /***********************/
 284 typedef struct {
 285         pthread_t pthread_id;
 286         pid_t linux_pid;
 287         pid_t linux_tid;
 288 } FOSA_THREAD_ID_T_OPAQUE;
 289
 290
 291 typedef pthread_attr_t FOSA_THREAD_ATTR_T_OPAQUE;
 292 typedef int FOSA_SIGNAL_T_OPAQUE;
 293
 294
 295 // The minimum and maximum signal numbers that may be used by the FRSH
 296 // implementation
 297 #define FOSA_SIGNAL_MIN       SIGRTMIN
 298 #define FOSA_SIGNAL_MAX       SIGRTMIN+0
 299
 300 #define FOSA_NULL_SIGNAL 0
 301
 302
 303 /* Thread groups */
 304 /*****************/
 305 typedef int FOSA_THREAD_SET_ID_T_OPAQUE;
 306
 307 /* Clocks and signals */
 308 /**********************/
 309 #define    FOSA_CLOCK_ID_T_OPAQUE    clockid_t
 310 #define    FOSA_SYSTEM_CLOCK_OPAQUE  CLOCK_MONOTONIC
 311 #define    FOSA_TIMER_ID_T_OPAQUE    timer_t
 312
 313
 314
 315 /* Mutex and cond vars */
 316 /***********************/
 317 typedef pthread_mutex_t FOSA_MUTEX_T_OPAQUE;
 318 #define    FOSA_COND_T_OPAQUE        pthread_cond_t
 319
 320
 321 /* Application Defined Scheduling */
 322 /**********************************/
 323 /* hack to get AQuoSA sources compile without having none
 324  * of the application level scheduler header files and symbols */
 325 #define posix_appsched_actions_t int
 326
 327 #define FOSA_ADS_ACTIONS_T_OPAQUE posix_appsched_actions_t
 328
 329
 330 /* FOSA Errors */
 331
 332 /** Not enough memory available **/
 333 #define FOSA_ENOMEM   ENOMEM
 334
 335 /** Invalid parameter **/
 336 #define FOSA_EINVAL   EINVAL
 337
 338 /** Still pending information **/
 339 #define FOSA_EAGAIN   EAGAIN
 340
 341 #define FOSA_EREJECT   EREJECT
 342 #define FOSA_EMASKED   -2
 343 #define FOSA_EPOLICY   -3
 344
 345 #define FOSA_ETIMEDOUT ETIMEDOUT
 346
 347
 348 #endif
 349 ////////////////// END of AQuoSA //////////////////////
 350
 351
 352
 353 ///////////////////////////////// PARTIKLE /////////////////////////////////////
 354 #if defined(PARTIKLE)
 355
 356 #include <pthread.h>
 357 #include <signal.h>
 358 #include <time.h>
 359 #include <sched.h>
 360 #include <stdlib.h>
 361 #include <setjmp.h>
 362 #include <limits.h>
 363
 364 typedef struct {
 365     posix_appsched_actions_t actions;
 366     struct timespec * timeout_ptr;
 367     struct timespec timeout;
 368     bool rejected;
 369     bool suspended;
 370     bool activated;
 371 } FOSA_ADS_ACTIONS_T_OPAQUE;
 372
 373
 374 typedef pthread_t                   FOSA_THREAD_ID_T_OPAQUE;
 375 typedef pthread_attr_t              FOSA_THREAD_ATTR_T_OPAQUE;
 376 typedef int                         FOSA_SIGNAL_T_OPAQUE;
 377 typedef clockid_t                   FOSA_CLOCK_ID_T_OPAQUE;
 378 typedef timer_t                     FOSA_TIMER_ID_T_OPAQUE;
 379 typedef pthread_cond_t              FOSA_COND_T_OPAQUE;
 380 typedef pthread_mutex_t             FOSA_MUTEX_T_OPAQUE;
 381 typedef unsigned long               FOSA_LONG_JUMP_CONTEXT_T_OPAQUE [32];
 382 typedef group_clock_t               FOSA_THREAD_SET_ID_T_OPAQUE;
 383
 384 #define FOSA_NULL_THREAD_SET_ID_OPAQUE 0x0;
 385
 386 enum _fosa_clocks_e {
 387   FOSA_SYSTEM_CLOCK_OPAQUE = CLOCK_MONOTONIC
 388 };
 389
 390 #define LONGJMP_NSIG 3
 391
 392 #if LONGJMP_NSIG > (RTSIG_MAX - 1)
 393 #   error LONGJMP_NSIG too big (LONGJMP_NSIG > RTSIG_MAX - 1)
 394 #endif
 395
 396 enum _fosa_signal_limits_e {
 397   LONGJMP_FIRSTSIG = SIGRTMAX - LONGJMP_NSIG + 1,
 398   FOSA_SIGNAL_MAX = LONGJMP_FIRSTSIG - 1,
 399   FOSA_SIGNAL_MIN = SIGRTMIN,
 400   FOSA_NULL_SIGNAL = -1,
 401 };
 402
 403
 404 enum _fosa_errors_e {
 405   FOSA_EINVAL = EINVAL,
 406   FOSA_EAGAIN = EAGAIN,
 407   FOSA_EREJECT = EREJECT,
 408   FOSA_EMASKED = EMASKED,
 409   FOSA_EPOLICY = EPOLICY,
 410   FOSA_ETIMEDOUT = ETIMEDOUT,
 411   FOSA_ENOMEM = ENOMEM,
 412 };
 413
 414
 415 #endif
 416 /////////////////////////////// PARTIKLE  END //////////////////////////////////
 417
 418
 419
 420 ////////////////////////// VIRTUAL TIME    //////////////////////////////////////
 421 #ifdef VIRTUAL_TIME
 422
 423 /* Time */
 424 /********/
 425 // typedef struct timespec fosa_rel_time_t;
 426 // typedef struct timespec fosa_abs_time_t;
 427
 428 #include <fosa_vt.h>
 429
 430 #define FOSA_THREAD_ID_T_OPAQUE   vt_posix_process_t
 431 #define FOSA_THREAD_ATTR_T_OPAQUE fosa_thread_attr_t
 432 #define FOSA_SIGNAL_T_OPAQUE      int
 433
 434 #define FOSA_MUTEX_T_OPAQUE fosa_mutex_t
 435
 436 // The minimum and maximum signal numbers that may be used by the FRSH
 437 // implementation
 438 #define FOSA_SIGNAL_MIN       8
 439 #define FOSA_SIGNAL_MAX       31
 440
 441 // the min. and max. priority a fosa thread can have
 442 #define FOSA_PRIORITY_MAX VT_PRIORITY_MIN - 1
 443 #define FOSA_PRIORITY_MIN VT_PRIORITY_MAX
 444
 445 #define FOSA_NULL_SIGNAL        0
 446
 447 /* FOSA Errors and return values*/
 448
 449 /** Invalid parameter **/
 450 #define FOSA_EINVAL   -1
 451
 452 /** Not enough memory available **/
 453 #define FOSA_ENOMEM   -2
 454
 455 /** Still pending information **/
 456 #define FOSA_EAGAIN   -3
 457
 458 /** Mutex not available **/
 459 #define FOSA_EBUSY         -4
 460
 461 /** Cond var timedout **/
 462 #define FOSA_ETIMEDOUT  -5
 463
 464 /** FOSA ADS errors **/
 465 #define FOSA_EREJECT   -6
 466 #define FOSA_EMASKED   -7
 467
 468
 469 /** Sched policy not correct */
 470 #define FOSA_EPOLICY    -8
 471
 472 /** the value given by thread_id is not valid for ADS */
 473 #define FOSA_ESRCH              -9
 474
 475 /** retval if no action performed **/
 476 #define FOSA_NO_ACTION  0
 477
 478 #endif /* VIRTUAL_TIME */
 479 //////////////////////////End of VIRTUAL TIME ///////////////////////////////////
 480
 481
 482 ////////////////////////// DUMMY_OS    //////////////////////////////////////
 483
 484 #if defined(DUMMY_OS)
 485
 486 /* With this define we make sure that we are truly POSIX and OSE */
 487 /* independent at the FRSH code.                                 */
 488 /*****************************************************************/
 489
 490 /* Time */
 491 /********/
 492 // typedef struct timespec fosa_rel_time_t;
 493 // typedef struct timespec fosa_abs_time_t;
 494
 495 /* Thread and signals */
 496 /**********************/
 497 typedef int FOSA_THREAD_ID_T_OPAQUE;
 498 typedef int FOSA_THREAD_ATTR_T_OPAQUE;
 499
 500 typedef int FOSA_SIGNAL_T_OPAQUE;
 501 typedef int FOSA_SIGNAL_INFO_T_OPAQUE;
 502
 503 /* Signal info is defined as a union in thread_and_signals */
 504
 505 #define FOSA_SIGNAL_MIN     42
 506 #define FOSA_SIGNAL_MAX     44
 507
 508 #define FOSA_NULL_SIGNAL 0
 509
 510 /* Clocks and timers */
 511 /**********************/
 512 typedef int FOSA_CLOCK_ID_T_OPAQUE;
 513 typedef int FOSA_TIMER_ID_T_OPAQUE;
 514
 515 #define FOSA_SYSTEM_CLOCK_OPAQUE  25
 516
 517 /* Mutex and conditional variables */
 518 /***********************************/
 519 typedef int FOSA_MUTEX_T_OPAQUE;
 520 typedef int FOSA_COND_T_OPAQUE;
 521
 522 /* Application defined Scheduling */
 523 /**********************************/
 524 #define FOSA_ADS_ACTIONS_T_OPAQUE  int
 525
 526
 527 #endif /* DUMMY */
 528 //////////////////////////End of DUMMY_OS ////////////////////////////////////
 529
 530 FOSA_CPP_END_DECLS
 531
 532
 533 #endif // _FOSA_OPAQUE_TYPES_H_