frsh_fosa_opaque.h

   1 // -----------------------------------------------------------------------
   2 //  Copyright (C) 2006 - 2007 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 FRSH API
  35 //
  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)
  39 //  any later version.
  40 //
  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.
  45 //
  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
  49 //  02111-1307, USA.
  50 //
  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
  56 //  Public License.
  57 // -----------------------------------------------------------------------
  58 //frsh_core_types.h
  59 //========================================================================================
  60 //  ******** *******    ********  **      **    ********  ******    ********  **********
  61 //  **///// /**////**  **//////  /**     /**    **///// /**    **  **//////  /**     /**
  62 //  **      /**   /** /**        /**     /**    **      /**    ** /**        /**     /**
  63 //  ******* /*******  /********* /**********    ******* /**    ** /********* /**********
  64 //  **////  /**///**  ////////** /**//////**    **////  /**    ** ////////** /**//////**
  65 //  **      /**  //**        /** /**     /**    **      /**    **        /** /**     /**
  66 //  **      /**   //** ********  /**     /**    **      /**    **  ********  /**     /**
  67 //  //       //     // ////////   //      //    //       /******/  ////////   //      //
  68 //
  69 // FRSH(FRescor ScHeduler), pronounced "fresh" FOSA(Frescor Oper System Adaptation layer)
  70 //========================================================================================
  71
  72 #ifndef         FRSH_FOSA_OPAQUE_H_
  73 #define         FRSH_FOSA_OPAQUE_H_
  74
  75 /**
  76  * @file frsh_fosa_opaque.h
  77  **/
  78
  79
  80 /**
  81  * \addtogroup frshfosa
  82  *
  83  * @{
  84  **/
  85
  86
  87 /////////////////////MaRTE OS, RT_LINUX & AQuoSA  //////////////////////
  88
  89 #if defined(MARTE_OS) || defined(RT_LINUX) || defined(AQuoSA)
  90
  91 #include <pthread.h>
  92 #include <signal.h>
  93 #include <errno.h>
  94 #include <time.h>
  95 #include <stdbool.h>
  96
  97 #ifdef AQuoSA
  98
  99 typedef struct {
 100         pthread_t pthread_id;
 101         pid_t linux_pid;
 102         pid_t linux_tid;
 103 } FOSA_THREAD_ID_T_OPAQUE;
 104
 105 #else   /* !AQuoSA, MARTE_OS, RT_LINUX */
 106
 107 typedef pthread_t FOSA_THREAD_ID_T_OPAQUE;
 108
 109 #endif  /* AQuoSA */
 110
 111 typedef pthread_attr_t FOSA_THREAD_ATTR_T_OPAQUE;
 112
 113 typedef int FOSA_SIGNAL_T_OPAQUE;
 114
 115
 116 typedef pthread_mutex_t FOSA_MUTEX_T_OPAQUE;
 117
 118 // The minimum and maximum signal numbers that may be used by the FRSH
 119 // implementation
 120 #define FOSA_SIGNAL_MIN       SIGRTMIN
 121 #define FOSA_SIGNAL_MAX       SIGRTMIN+0
 122
 123 #define FOSA_NULL_SIGNAL 0
 124
 125 /* FOSA Errors */
 126
 127 /* #include <error.h> */
 128
 129 /** Not enough memory available **/
 130 #define FOSA_ENOMEM   ENOMEM
 131
 132 /** Invalid parameter **/
 133 #define FOSA_EINVAL   EINVAL
 134
 135 /** Still pending information **/
 136 #define FOSA_EAGAIN   EAGAIN
 137
 138 /** FOSA ADS errors **/
 139 #define FOSA_EREJECT   EREJECT
 140 #define FOSA_EMASKED   -2
 141 #define FOSA_EPOLICY   -3
 142
 143
 144
 145 #endif /* MARTE_OS || RT_LINUX || AQuoSA */
 146
 147 //////////////////End of MaRTE OS, RT_LINUX & AQuoSA  ///////////////////
 148
 149 ////////////////////////// VIRTUAL TIME    //////////////////////////////////////
 150
 151 #if defined(VIRTUAL_TIME)
 152 #include <fosa_vt.h>
 153
 154 #define FOSA_THREAD_ID_T_OPAQUE   vt_posix_process_t
 155
 156 #define FOSA_THREAD_ATTR_T_OPAQUE fosa_thread_attr_t
 157
 158 #define FOSA_SIGNAL_T_OPAQUE      int
 159
 160 #define FOSA_MUTEX_T_OPAQUE fosa_mutex_t
 161
 162 // The minimum and maximum signal numbers that may be used by the FRSH
 163 // implementation
 164 #define FOSA_SIGNAL_MIN       8
 165 #define FOSA_SIGNAL_MAX       31
 166
 167 // the min. and max. priority a fosa thread can have
 168 #define FOSA_PRIORITY_MAX VT_PRIORITY_MIN - 1
 169 #define FOSA_PRIORITY_MIN VT_PRIORITY_MAX
 170
 171 #define FOSA_NULL_SIGNAL        0
 172
 173 /* FOSA Errors and return values*/
 174
 175 /** Invalid parameter **/
 176 #define FOSA_EINVAL   -1
 177
 178 /** Not enough memory available **/
 179 #define FOSA_ENOMEM   -2
 180
 181 /** Still pending information **/
 182 #define FOSA_EAGAIN   -3
 183
 184 /** Mutex not available **/
 185 #define FOSA_EBUSY         -4
 186
 187 /** Cond var timedout **/
 188 #define FOSA_ETIMEDOUT  -5
 189
 190 /** FOSA ADS errors **/
 191 #define FOSA_EREJECT   -6
 192 #define FOSA_EMASKED   -7
 193
 194
 195 /** Sched policy not correct */
 196 #define FOSA_EPOLICY    -8
 197
 198 /** the value given by thread_id is not valid for ADS */
 199 #define FOSA_ESRCH              -9
 200
 201 /** retval if no action performed **/
 202 #define FOSA_NO_ACTION  0
 203
 204 #endif /* VIRTUAL_TIME */
 205 //////////////////////////End of VIRTUAL TIME ///////////////////////////////////
 206
 207 ////////////////////////// OSE    //////////////////////////////////////
 208
 209 #if defined(OSE)
 210
 211 /* Put OSE dependent includes and defines here */
 212
 213 #endif /* OSE */
 214 //////////////////////////End of OSE ////////////////////////////////////
 215
 216 ////////////////////////// DUMMY_OS    //////////////////////////////////////
 217
 218 #if defined(DUMMY_OS)
 219
 220 /* With this define we make sure that we are truly POSIX and OSE */
 221 /* independent at the FRSH code.                                 */
 222 /*****************************************************************/
 223
 224 #define FOSA_THREAD_ID_T_OPAQUE   int
 225
 226 #define FOSA_THREAD_ATTR_T_OPAQUE int
 227
 228 #define FOSA_SIGNAL_T_OPAQUE      int
 229
 230 #define FRSH_SIGNAL_INFO_T_OPAQUE int
 231
 232 #define FOSA_MUTEX_T_OPAQUE int
 233
 234 // The minimum and maximum signal numbers that may be used by the FRSH
 235 // implementation
 236 #define FOSA_SIGNAL_MIN       42
 237 #define FOSA_SIGNAL_MAX       42
 238
 239 #define FOSA_NULL_SIGNAL 0
 240
 241 /* FOSA Errors */
 242
 243 /* #include <error.h> */
 244
 245 /** Not enough memory available **/
 246 #define FOSA_ENOMEM   -1
 247
 248 /** Invalid parameter **/
 249 #define FOSA_EINVAL   -2
 250
 251 /** Still pending information **/
 252 #define FOSA_EAGAIN   -3
 253
 254 /** FOSA ADS errors **/
 255 #define FOSA_EREJECT   -4
 256 #define FOSA_EMASKED   -5
 257
 258 #define FOSA_EPOLICY -6
 259
 260 #endif /* DUMMY */
 261 //////////////////////////End of DUMMY_OS ////////////////////////////////////
 262
 263
 264
 265
 266
 267
 268 #endif      /* !FRSH_FOSA_OPAQUE_H_ */