frsh_opaque_types.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_opaque_types.h
  59 //==============================================
  60 //  ******** *******    ********  **      **
  61 //  **///// /**////**  **//////  /**     /**
  62 //  **      /**   /** /**        /**     /**
  63 //  ******* /*******  /********* /**********
  64 //  **////  /**///**  ////////** /**//////**
  65 //  **      /**  //**        /** /**     /**
  66 //  **      /**   //** ********  /**     /**
  67 //  //       //     // ////////   //      //
  68 //
  69 // FRSH(FRescor ScHeduler), pronounced "fresh"
  70 //==============================================
  71
  72 // Implementation dependent definitions
  73 #ifndef _FRSH_OPAQUE_TYPES_H_
  74 #define _FRSH_OPAQUE_TYPES_H_
  75
  76 FRSH_CPP_BEGIN_DECLS
  77
  78 /**
  79  * @file frsh_opaque_types.h
  80  **/
  81
  82 /**
  83  * @defgroup opaque Opaque types
  84  *
  85  * This module specifies some #defines for privates types in the
  86  * interface.  In this way we warn the FRSH user never to access the internal
  87  * members of the types directly allowing us to change their internal
  88  * definitions to suit our needs.
  89  *
  90  * Note that in Ada the FRSH user would never be allowed to access the
  91  * members directly, however in C the compiler does not prevent this.
  92  * But this is the best we can do in this language.
  93  *
  94  * @{
  95  **/
  96
  97 /** frsh_contract_parameters_t **/
  98 #define FRSH_CONTRACT_T_OPAQUE struct { \
  99 \
 100   /** Processor Id or Network Id **/                          \
 101   frsh_resource_id_t   resource_id;                             \
 102 \
 103   /** Whether processor or network **/                        \
 104   frsh_resource_type_t resource_type;                           \
 105 \
 106   /** Printable name for the contract
 107      Unique within the local node               **/         \
 108   frsh_contract_label_t      contract_label;                        \
 109 \
 110   /** Minimum budget needed to perform a job.  With the energy
 111       module this will be an array **/              \
 112   struct timespec         budget_min;                         \
 113 \
 114   /** Maximum period that the system system can sustain **/   \
 115   struct timespec         period_max;                         \
 116 \
 117   /** Maximum budget that the vres can use
 118      (and would be happy to have).  With the energy module
 119      this will be an array **/              \
 120   struct timespec         budget_max;                         \
 121 \
 122   /** Minimum period for that
 123      the system can use (and would be happy to have) **/     \
 124   struct timespec         period_min;                         \
 125 \
 126   /** Set of discrete values for budget and period.  With the
 127       energy module this will be an array **/        \
 128   frsh_utilization_set_t   utilization_set;          \
 129 \
 130   /** Workload_type:  bounded, indeterminate, overhead **/    \
 131   frsh_workload_t          workload;                          \
 132 \
 133   /** Scheduling type:  Regular, background
 134      (in round-robin) or dummy             **/               \
 135   frsh_contract_type_t    contract_type;                      \
 136 \
 137   /** Whether delay equals period **/                         \
 138   bool                    d_equals_t;                         \
 139 \
 140   /** Deadline (will be ignored if d_equals_t is TRUE **/     \
 141   struct timespec         deadline;                           \
 142 \
 143   /** Signal parameters for the case of
 144       attempting to use too much budget       **/             \
 145   frsh_signal_t           budget_overrun_signal;          \
 146   frsh_signal_info_t      budget_overrun_siginfo;           \
 147 \
 148   /** Signal parameters for the case a deadline
 149      is missed **/                                           \
 150   frsh_signal_t           deadline_miss_signal;           \
 151   frsh_signal_info_t      deadline_miss_siginfo;            \
 152 \
 153   /** Wether the range of period and budget is specified
 154       in a continuous way (max-min) or as a set of
 155       discrete values                                    **/  \
 156   frsh_granularity_t       granularity;                       \
 157 \
 158   /** Non-cooperative parameter for fair capacity
 159       distribution                                **/         \
 160   int                     importance;                \
 161 \
 162   /** Cooperative parameter for fair capacity
 163       distribution **/                                        \
 164   int                     weight;                   \
 165 \
 166   /** If > 0 it describes a duration for which
 167       the allocated budget and capacity will be
 168       maintained across negotiations  and will
 169       not be affected for dynamic spare capacity    **/       \
 170   struct timespec         stability_time;  \
 171 \
 172   /** Low level parameter related with the elegibility
 173       preempt other threads                            **/    \
 174   frsh_preemption_level_t  preemption_level;                  \
 175 \
 176   /** Set of critical sections that the vres executes
 177       besides the normal budget                        **/   \
 178   frsh_csects_group_t critical_sections;                 \
 179 \
 180   /** Internal scheduling policy within the vres for
 181       hierarchical scheduling systems                  **/    \
 182   frsh_sched_policy_t      policy;                            \
 183 \
 184   /** Protocol info for distributed systems.  We store it
 185       as a pointer+size.  It's internal meaning is imple-
 186       mentation dependent.                              **/    \
 187   frsh_protocol_info_t    protocol_info; \
 188   frsh_endpoint_queueing_info_t    queueing_info; \
 189 \
 190   /** Maximum loss rate
 191       Percentage of packet loss in the network that is
 192       tolerated by the application **/                       \
 193 int                     max_loss_rate; \
 194 \
 195  /** Minimum memory size to be reserved **/ \
 196 size_t                  minimum_memory; \
 197 \
 198 /** Maximum memory size to be reserved  **/ \
 199 size_t                  maximum_memory; \
 200 }
 201
 202
 203 typedef int FRSH_SYNCHOBJ_HANDLE_T_OPAQUE;
 204
 205 typedef int FRSH_SHAREDOBJ_HANDLE_T_OPAQUE;
 206
 207 /**
 208  * Critical section data
 209  * - comon parameters
 210  *     op_kind;     // kind of operation (READ or WRITE)
 211  *     obj_handle;  // handle to shared object
 212  *     wcet;        // Execution time
 213  *     blocking;    // Blocking time (execution time + protection overheads)
 214  * - attributes used only for protected shared objects
 215  *     op;          // pointer to the operation
 216  * - attributes used only for protected write operations
 217  *     areas;       // memory areas to be protected
 218  *
 219  **/
 220 #define FRSH_CSECT_T_OPAQUE struct { \
 221   frsh_csect_op_kind_t op_kind;                 \
 222   frsh_sharedobj_handle_t obj_handle;               \
 223   struct timespec wcet;                              \
 224   struct timespec blocking;                              \
 225   frsh_csect_op_t op;                           \
 226   frsh_memory_areas_t areas;                         \
 227   frsh_memory_areas_t storage;                         \
 228 }
 229
 230
 231 //opaque types for frsh endpoints
 232 typedef int FRSH_SEND_ENDPOINT_T_OPAQUE;
 233
 234 typedef int FRSH_RECEIVE_ENDPOINT_T_OPAQUE;
 235
 236 /*@}*/
 237
 238 FRSH_CPP_END_DECLS
 239
 240 #endif // _FRSH_OPAQUE_TYPES_H_