src/fosa/include/fosa_opaque_types_marte.h

   1 // -----------------------------------------------------------------------
   2 //  Copyright (C) 2006 - 2009 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 #include <pthread.h>
  82 #include <signal.h>
  83 #include <time.h>
  84 #include <sched.h>
  85 #include <errno.h>
  86
  87 FOSA_CPP_BEGIN_DECLS
  88
  89
  90 /* Thread and signals */
  91 /**********************/
  92 typedef pthread_t FOSA_THREAD_ID_T_OPAQUE;
  93 typedef pthread_attr_t FOSA_THREAD_ATTR_T_OPAQUE;
  94
  95 typedef int FOSA_SIGNAL_T_OPAQUE;
  96 /* Signal info is defined as a union in thread_and_signals */
  97
  98 #define FOSA_SIGNAL_MIN       SIGRTMIN
  99 #define FOSA_SIGNAL_MAX       SIGRTMIN+0
 100
 101 #define FOSA_NULL_SIGNAL 0
 102
 103 /* Clocks and timers */
 104 /**********************/
 105 typedef clockid_t FOSA_CLOCK_ID_T_OPAQUE;
 106 typedef timer_t FOSA_TIMER_ID_T_OPAQUE;
 107
 108 #define FOSA_SYSTEM_CLOCK_OPAQUE  CLOCK_MONOTONIC
 109
 110 /* Mutex and conditional variables */
 111 /***********************************/
 112 typedef pthread_mutex_t FOSA_MUTEX_T_OPAQUE;
 113 typedef pthread_cond_t FOSA_COND_T_OPAQUE;
 114
 115
 116 /* Application defined Scheduling */
 117 /**********************************/
 118 #define FOSA_ADS_ACTIONS_T_OPAQUE  struct \
 119 { \
 120     posix_appsched_actions_t actions; \
 121     struct timespec *timeout_ptr; \
 122     struct timespec timeout; \
 123     bool rejected; \
 124     bool suspended; \
 125     bool activated; \
 126 }
 127
 128
 129 /* Local jump */
 130 /**************/
 131 #include "misc/marte_non_local_jmp.h"
 132
 133 #define FOSA_LONG_JUMP_CONTEXT_T_OPAQUE  struct { \
 134   marte_nonlocaljmp_context_t marte_context;      \
 135   fosa_thread_id_t tid;                            \
 136 }
 137
 138
 139 /* Group clocks */
 140 /****************/
 141 typedef marte_thread_set_t FOSA_THREAD_SET_ID_T_OPAQUE;
 142
 143 #define FOSA_NULL_THREAD_SET_ID_OPAQUE 0 /* In MaRTE-OS thread_set_t are
 144                                      * pointers */
 145
 146 /* FOSA errors */
 147 /***************/
 148 /** Not enough memory available **/
 149 #define FOSA_ENOMEM   ENOMEM
 150
 151 /** Invalid parameter **/
 152 #define FOSA_EINVAL   EINVAL
 153
 154 /** Still pending information **/
 155 #define FOSA_EAGAIN   EAGAIN
 156
 157 /** FOSA ADS errors **/
 158 #ifdef MARTE_OS
 159 #define EREJECT   201 /* (for linux_lib_arch) Appsched has rejected object */
 160 #endif
 161
 162 #define FOSA_EREJECT   EREJECT
 163 #define FOSA_EMASKED   -2
 164 #define FOSA_EPOLICY   -3
 165
 166 #define FOSA_ETIMEDOUT ETIMEDOUT
 167
 168 /* Not found in search (non existing thread, thread_set...) */
 169 #define FOSA_ESRCH   ESRCH
 170 #define FOSA_ENOTSUP ENOTSUP
 171
 172 #endif
 173
 174 ///////////////////////  End of MARTE_OS  /////////////////////////////
 175
 176
 177
 178 FOSA_CPP_END_DECLS
 179
 180
 181 #endif // _FOSA_OPAQUE_TYPES_H_