include/fosa_opaque_types.h

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