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