]> rtime.felk.cvut.cz Git - frescor/fosa.git/blobdiff - include/fosa_opaque_types.h
FOSA-PaRTiKle implementation
[frescor/fosa.git] / include / fosa_opaque_types.h
index b587c91287cdc83bddbe4cf70db225a1be43c3d0..21af0c0298f83661aeae298cf723437d3ea6e658 100644 (file)
 
 #include <stdbool.h>
 
-/////////////////////// RT_LINUX, MARTE_OS & AQuoSA ///////////////////////////
+///////////////////////  MARTE_OS /////////////////////////////
 
-#if defined(RT_LINUX) || defined(MARTE_OS) || defined(AQuoSA)
+#ifdef MARTE_OS
 
-#ifdef AQuoSA
-#define __USE_UNIX98
-#endif // AQuoSA
 #include <pthread.h>
 #include <signal.h>
 #include <time.h>
 #include <sched.h>
+#include <errno.h>
 
-#ifdef RT_LINUX
-#include <rtl_timer.h>
-#endif // RT_LINUX
+/* Time */
+/********/
+// typedef struct timespec fosa_rel_time_t;
+// typedef struct timespec fosa_abs_time_t;
 
-#define    FOSA_CLOCK_ID_T_OPAQUE    clockid_t
-#define    FOSA_SYSTEM_CLOCK_OPAQUE  CLOCK_MONOTONIC
+/* Thread and signals */
+/**********************/
+typedef pthread_t FOSA_THREAD_ID_T_OPAQUE;
+typedef pthread_attr_t FOSA_THREAD_ATTR_T_OPAQUE;
 
-#define    FOSA_TIMER_ID_T_OPAQUE    timer_t
+typedef int FOSA_SIGNAL_T_OPAQUE;
+/* Signal info is defined as a union in thread_and_signals */
 
-#define    FOSA_COND_T_OPAQUE        pthread_cond_t
+#define FOSA_SIGNAL_MIN       SIGRTMIN
+#define FOSA_SIGNAL_MAX       SIGRTMIN+0
 
-/*********
- *  ADS
- *********/
+#define FOSA_NULL_SIGNAL 0
 
-#ifdef MARTE_OS
+/* Clocks and timers */
+/**********************/
+typedef clockid_t FOSA_CLOCK_ID_T_OPAQUE;
+typedef timer_t FOSA_TIMER_ID_T_OPAQUE;
+
+#define FOSA_SYSTEM_CLOCK_OPAQUE  CLOCK_MONOTONIC
+
+/* Mutex and conditional variables */
+/***********************************/
+typedef pthread_mutex_t FOSA_MUTEX_T_OPAQUE;
+typedef pthread_cond_t FOSA_COND_T_OPAQUE;
+
+
+/* Application defined Scheduling */
+/**********************************/
 typedef struct {
     posix_appsched_actions_t actions;
-    struct timespec * timeout_ptr;
+    struct timespec *timeout_ptr;
     struct timespec timeout;
     bool rejected;
     bool suspended;
     bool activated;
 } fosa_ads_actions_internal_t;
 
-
 #define FOSA_ADS_ACTIONS_T_OPAQUE fosa_ads_actions_internal_t
 
-///////////////////
-// Long jumps
-///////////////////
-
+/* Local jump */
+/**************/
 #include "marte_non_local_jmp.h"
 
 #define FOSA_LONG_JUMP_CONTEXT_T_OPAQUE  struct { \
   marte_nonlocaljmp_context_t marte_context;      \
-  frsh_thread_id_t tid;                            \
+  fosa_thread_id_t tid;                            \
 }
 
-#else // MARTE_OS
 
+/* FOSA errors */
+/***************/
+/** Not enough memory available **/
+#define FOSA_ENOMEM   ENOMEM
+
+/** Invalid parameter **/
+#define FOSA_EINVAL   EINVAL
+
+/** Still pending information **/
+#define FOSA_EAGAIN   EAGAIN
+
+/** FOSA ADS errors **/
+#ifdef MARTE_OS
+#define EREJECT   201 /* (for linux_lib_arch) Appsched has rejected object */
+#endif
+
+#define FOSA_EREJECT   EREJECT
+#define FOSA_EMASKED   -2
+#define FOSA_EPOLICY   -3
+
+#define FOSA_ETIMEDOUT ETIMEDOUT
+
+#endif
+
+///////////////////////  End of MARTE_OS  /////////////////////////////
+
+
+/////////////////////// RT_LINUX ///////////////////////////
+
+#ifdef RT_LINUX
+
+/* Very similar to MARTE_OS but I leave separate for clarity */
+
+#include <pthread.h>
+#include <signal.h>
+#include <time.h>
+#include <sched.h>
+#include <errno.h>
+#include <rtl_timer.h>
+
+/* Time */
+/********/
+// typedef struct timespec fosa_rel_time_t;
+// typedef struct timespec fosa_abs_time_t;
+
+
+/* Threads and signals */
+/***********************/
+#define    FOSA_THREAD_ID_T_OPAQUE pthread_t
+
+typedef pthread_attr_t FOSA_THREAD_ATTR_T_OPAQUE;
+typedef int FOSA_SIGNAL_T_OPAQUE;
+/* Signal info is defined as a union in fosa_types.h */
+
+// The minimum and maximum signal numbers that may be used by the FRSH
+// implementation
+#define FOSA_SIGNAL_MIN       SIGRTMIN
+#define FOSA_SIGNAL_MAX       SIGRTMIN+0
+#define FOSA_NULL_SIGNAL 0
+
+/* Clocks and timers */
+/*********************/
+#define    FOSA_CLOCK_ID_T_OPAQUE    clockid_t
+#define    FOSA_TIMER_ID_T_OPAQUE    timer_t
+#define    FOSA_SYSTEM_CLOCK_OPAQUE  CLOCK_MONOTONIC
+
+/* Mutex and cond vars */
+/***********************/
+typedef pthread_mutex_t FOSA_MUTEX_T_OPAQUE;
+#define    FOSA_COND_T_OPAQUE        pthread_cond_t
+
+
+/* FOSA Errors */
+/***************/
+/** Not enough memory available **/
+#define FOSA_ENOMEM   ENOMEM
+/** Invalid parameter **/
+#define FOSA_EINVAL   EINVAL
+/** Still pending information **/
+#define FOSA_EAGAIN   EAGAIN
+
+/** FOSA ADS errors **/
+#define FOSA_EREJECT   EREJECT
+#define FOSA_EMASKED   -2
+#define FOSA_EPOLICY   -3
+
+#define FOSA_ETIMEDOUT ETIMEDOUT
+
+#endif
+
+///////////////////////  End of RT_LINUX  /////////////////////////////
+
+
+////////////////////////// OSE    //////////////////////////////////////
+
+#ifdef OSE
+
+/* Time */
+/********/
+// typedef struct timespec fosa_rel_time_t;
+// typedef struct timespec fosa_abs_time_t;
+
+
+/* Put OSE dependent includes and defines here */
+
+#endif /* OSE */
+
+
+
+/////////////////////// AQuoSA ///////////////////////////
+
+#ifdef AQuoSA
+
+#define __USE_UNIX98
+
+#include <pthread.h>
+#include <signal.h>
+#include <errno.h>
+#include <time.h>
+
+/* Time */
+/********/
+// typedef struct timespec fosa_rel_time_t;
+// typedef struct timespec fosa_abs_time_t;
+
+
+/* Threads and signals */
+/***********************/
+typedef struct {
+       pthread_t pthread_id;
+       pid_t linux_pid;
+       pid_t linux_tid;
+} FOSA_THREAD_ID_T_OPAQUE;
+
+
+typedef pthread_attr_t FOSA_THREAD_ATTR_T_OPAQUE;
+typedef int FOSA_SIGNAL_T_OPAQUE;
+
+
+// The minimum and maximum signal numbers that may be used by the FRSH
+// implementation
+#define FOSA_SIGNAL_MIN       SIGRTMIN
+#define FOSA_SIGNAL_MAX       SIGRTMIN+0
+
+#define FOSA_NULL_SIGNAL 0
+
+
+/* Clocks and signals */
+/**********************/
+#define    FOSA_CLOCK_ID_T_OPAQUE    clockid_t
+#define    FOSA_SYSTEM_CLOCK_OPAQUE  CLOCK_MONOTONIC
+#define    FOSA_TIMER_ID_T_OPAQUE    timer_t
+
+
+
+/* Mutex and cond vars */
+/***********************/
+typedef pthread_mutex_t FOSA_MUTEX_T_OPAQUE;
+#define    FOSA_COND_T_OPAQUE        pthread_cond_t
+
+
+/* Application Defined Scheduling */
+/**********************************/
 /* hack to get AQuoSA sources compile without having none
  * of the application level scheduler header files and symbols */
-#ifdef AQuoSA
 #define posix_appsched_actions_t int
 #define FOSA_LONG_JUMP_CONTEXT_T_OPAQUE int
-#endif // AQuoSA
 
 #define FOSA_ADS_ACTIONS_T_OPAQUE posix_appsched_actions_t
-#endif // MARTE_OS
 
 
+/* FOSA Errors */
+
+/** Not enough memory available **/
+#define FOSA_ENOMEM   ENOMEM
+
+/** Invalid parameter **/
+#define FOSA_EINVAL   EINVAL
+
+/** Still pending information **/
+#define FOSA_EAGAIN   EAGAIN
+
+#define FOSA_EREJECT   EREJECT
+#define FOSA_EMASKED   -2
+#define FOSA_EPOLICY   -3
+
+#define FOSA_ETIMEDOUT ETIMEDOUT
+
+
+#endif 
+////////////////// END of AQuoSA //////////////////////
+
+
+
+/////////////////////////////////// PARTIKLE ///////////////////////////////////////////
+#if defined(PARTIKLE)
+
+#include <pthread.h>
+#include <signal.h>
+#include <time.h>
+#include <sched.h>
+#include <stdlib.h>
+
+typedef struct {
+    posix_appsched_actions_t actions;
+    struct timespec * timeout_ptr;
+    struct timespec timeout;
+    bool rejected;
+    bool suspended;
+    bool activated;
+} fosa_ads_actions_internal_t;
+
+typedef pthread_t                   FOSA_THREAD_ID_T_OPAQUE;
+typedef pthread_attr_t              FOSA_THREAD_ATTR_T_OPAQUE;
+typedef int                         FOSA_SIGNAL_T_OPAQUE;
+typedef fosa_ads_actions_internal_t FOSA_ADS_ACTIONS_T_OPAQUE;
+typedef clockid_t                   FOSA_CLOCK_ID_T_OPAQUE;
+typedef timer_t                     FOSA_TIMER_ID_T_OPAQUE;
+typedef pthread_cond_t              FOSA_COND_T_OPAQUE;
+typedef pthread_mutex_t             FOSA_MUTEX_T_OPAQUE;
+typedef void *                      FOSA_LONG_JUMP_CONTEXT_T_OPAQUE;
+
+
+enum _fosa_clocks_e {
+  FOSA_SYSTEM_CLOCK_OPAQUE = CLOCK_MONOTONIC
+};
+
+enum _fosa_signal_limits_e {
+  FOSA_SIGNAL_MIN = SIGRTMIN,
+  FOSA_SIGNAL_MAX = SIGRTMAX,
+};
+
+enum _fosa_errors_e {
+  FOSA_EINVAL = EINVAL,
+  FOSA_EAGAIN = EAGAIN,
+  FOSA_EREJECT = EREJECT,
+  FOSA_EMASKED = EMASKED,
+  FOSA_EPOLICY = EPOLICY, 
+  FOSA_ETIMEDOUT = ETIMEDOUT,
+  FOSA_ENOMEM = ENOMEM,
+};
+
+#endif
+/////////////////////////////////// PARTIKLE  END //////////////////////////////////////
+
+
+
+////////////////////////// VIRTUAL TIME    //////////////////////////////////////
+#ifdef VIRTUAL_TIME
+
+/* Time */
+/********/
+// typedef struct timespec fosa_rel_time_t;
+// typedef struct timespec fosa_abs_time_t;
+
+#include <fosa_vt.h>
 
-#endif //  defined(RT_LINUX) || defined(MARTE_OS) || defined(AQuoSA)
+#define FOSA_THREAD_ID_T_OPAQUE   vt_posix_process_t
+#define FOSA_THREAD_ATTR_T_OPAQUE fosa_thread_attr_t
+#define FOSA_SIGNAL_T_OPAQUE      int
 
+#define FOSA_MUTEX_T_OPAQUE fosa_mutex_t
 
-////////////////// END OF RT_LINUX, MARTE_OS and AQuoSA //////////////////////
+// The minimum and maximum signal numbers that may be used by the FRSH
+// implementation
+#define FOSA_SIGNAL_MIN       8
+#define FOSA_SIGNAL_MAX       31
+
+// the min. and max. priority a fosa thread can have
+#define FOSA_PRIORITY_MAX VT_PRIORITY_MIN - 1
+#define FOSA_PRIORITY_MIN VT_PRIORITY_MAX
+
+#define FOSA_NULL_SIGNAL       0
+
+/* FOSA Errors and return values*/
+
+/** Invalid parameter **/
+#define FOSA_EINVAL   -1
+
+/** Not enough memory available **/
+#define FOSA_ENOMEM   -2
+
+/** Still pending information **/
+#define FOSA_EAGAIN   -3
+
+/** Mutex not available **/
+#define FOSA_EBUSY        -4
+
+/** Cond var timedout **/
+#define FOSA_ETIMEDOUT -5
+
+/** FOSA ADS errors **/
+#define FOSA_EREJECT   -6
+#define FOSA_EMASKED   -7
+
+
+/** Sched policy not correct */
+#define FOSA_EPOLICY   -8
+
+/** the value given by thread_id is not valid for ADS */
+#define FOSA_ESRCH             -9
+
+/** retval if no action performed **/
+#define FOSA_NO_ACTION 0
+
+#endif /* VIRTUAL_TIME */
+//////////////////////////End of VIRTUAL TIME ///////////////////////////////////
 
 
 ////////////////////////// DUMMY_OS    //////////////////////////////////////
@@ -149,21 +451,41 @@ typedef struct {
 /* independent at the FRSH code.                                 */
 /*****************************************************************/
 
-#define    FOSA_CLOCK_ID_T_OPAQUE    int
-#define    FOSA_SYSTEM_CLOCK_OPAQUE  42
+/* Time */
+/********/
+// typedef struct timespec fosa_rel_time_t;
+// typedef struct timespec fosa_abs_time_t;
 
-#define    FOSA_TIMER_ID_T_OPAQUE    int
+/* Thread and signals */
+/**********************/
+typedef int FOSA_THREAD_ID_T_OPAQUE;
+typedef int FOSA_THREAD_ATTR_T_OPAQUE;
 
-#define    FOSA_COND_T_OPAQUE        int
+typedef int FOSA_SIGNAL_T_OPAQUE;
+typedef int FOSA_SIGNAL_INFO_T_OPAQUE;
 
+/* Signal info is defined as a union in thread_and_signals */
 
-/*********
- *  ADS
- *********/
+#define FOSA_SIGNAL_MIN     42
+#define FOSA_SIGNAL_MAX     44
 
-#define FOSA_ADS_ACTIONS_T_OPAQUE  int
+#define FOSA_NULL_SIGNAL 0
+
+/* Clocks and timers */
+/**********************/
+typedef int FOSA_CLOCK_ID_T_OPAQUE;
+typedef int FOSA_TIMER_ID_T_OPAQUE;
 
+#define FOSA_SYSTEM_CLOCK_OPAQUE  25
 
+/* Mutex and conditional variables */
+/***********************************/
+typedef int FOSA_MUTEX_T_OPAQUE;
+typedef int FOSA_COND_T_OPAQUE;
+
+/* Application defined Scheduling */
+/**********************************/
+#define FOSA_ADS_ACTIONS_T_OPAQUE  int
 
 
 #endif /* DUMMY */