frsh_core_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_core_types.h
  59 //==============================================
  60 //  ******** *******    ********  **      **
  61 //  **///// /**////**  **//////  /**     /**
  62 //  **      /**   /** /**        /**     /**
  63 //  ******* /*******  /********* /**********
  64 //  **////  /**///**  ////////** /**//////**
  65 //  **      /**  //**        /** /**     /**
  66 //  **      /**   //** ********  /**     /**
  67 //  //       //     // ////////   //      //
  68 //
  69 // FRSH(FRescor ScHeduler), pronounced "fresh"
  70 //==============================================
  71
  72
  73 #ifndef   FRSH_CORE_TYPES_H_
  74 #define   FRSH_CORE_TYPES_H_
  75
  76 #include <stdbool.h>
  77 #include "frsh_configuration_parameters.h"
  78 #include "frsh_opaque_types.h"
  79 #include "frsh_shared_objects_types.h"
  80 #include "frsh_spare_capacity_types.h"
  81
  82 #include "frsh_implementation_specific_types.h"
  83 #include "frsh_hierarchical_types.h"
  84 #include "frsh_distributed_types.h"
  85 #include "frsh_error.h"
  86
  87 /**
  88  * @file frsh_core_types.h
  89  **/
  90
  91
  92 /**
  93  * \addtogroup core
  94  **/
  95 /*@{*/
  96
  97
  98 /** identifier of a frsh thread **/
  99 typedef fosa_thread_id_t frsh_thread_id_t;
 100
 101
 102 /** thread attributes object **/
 103 typedef fosa_thread_attr_t frsh_thread_attr_t;
 104
 105 /**
 106  *  The type references a function that may become a thread's
 107  *  code
 108  **/
 109 typedef fosa_thread_code_t frsh_thread_code_t;
 110
 111
 112 /** signal number; it is an integer type **/
 113 typedef fosa_signal_t frsh_signal_t;
 114
 115 #define FRSH_NULL_SIGNAL      FOSA_NULL_SIGNAL
 116
 117
 118 #define FRSH_SIGNAL_MIN       FOSA_SIGNAL_MIN
 119 #define FRSH_SIGNAL_MAX       FOSA_SIGNAL_MAX
 120
 121
 122 typedef fosa_signal_info_t frsh_signal_info_t;
 123
 124 /* Temporary placement */
 125 typedef struct timespec frsh_rel_time_t;
 126 typedef struct timespec frsh_abs_time_t;
 127
 128
 129 /** Kind of workload expected in vres: bounded or indeterminate **/
 130 typedef enum {
 131     FRSH_WT_BOUNDED       = 0,
 132     FRSH_WT_INDETERMINATE = 1
 133 } frsh_workload_t;
 134
 135 #define FRSH_NULL_DEADLINE     (struct timespec *)NULL
 136 // #define FRSH_NULL_SIGNAL       0 /* Defined at frsh_adaption.h */
 137
 138 /** Negotiation status: In_progress, rejected, admitted, not_requested **/
 139 typedef enum {FRSH_RS_IN_PROGRESS,
 140               FRSH_RS_REJECTED,
 141               FRSH_RS_ADMITTED,
 142               FRSH_RS_NOT_REQUESTED} frsh_renegotiation_status_t;
 143
 144
 145
 146 /**
 147  *  Vres Id type, that identifies a vres created to manage a given
 148  *  contract
 149  **/
 150 typedef unsigned int      frsh_vres_id_t;             // => 0
 151
 152 /** Contract ressource type:  processor, network, memory **/
 153 typedef enum {
 154     FRSH_RT_PROCESSOR = 0,
 155     FRSH_RT_NETWORK   = 1,
 156     FRSH_RT_MEMORY    = 2,
 157     FRSH_RT_DISK      = 3
 158 } frsh_resource_type_t;
 159
 160 /** Ressource Id: processor_id or network_id **/
 161 /**********************************************/
 162 typedef unsigned int frsh_resource_id_t;
 163
 164 /** Kind of contract: regular, background or dummy **/
 165 typedef enum {
 166         FRSH_CT_REGULAR    = 0,
 167         FRSH_CT_BACKGROUND = 1,
 168         FRSH_CT_DUMMY      = 2
 169 } frsh_contract_type_t;
 170
 171 // The name of this constant has been updated to have the FRSH_ prefix
 172 typedef char frsh_contract_label_t[FRSH_CONTRACT_LABEL_MAXLENGTH + 1];
 173
 174 /**
 175  *  Contract parameters type; it is an opaque type (i.e. the internal
 176  *  structure of this data type is implementation dependent). The user
 177  *  can access and modify the parameters of a contract only with the
 178  *  proper functions, and should never access the data directly.
 179  **/
 180 typedef FRSH_CONTRACT_T_OPAQUE  frsh_contract_t;
 181
 182
 183 /** List of vres **/
 184 typedef  struct {
 185   int             size;
 186   frsh_vres_id_t  vres[FRSH_MAX_N_VRES];
 187 } frsh_vres_group_t;
 188
 189 /** List of contracts to negotiate **/
 190 typedef struct {
 191     int  size;
 192     frsh_contract_t*  contracts[FRSH_MAX_N_VRES];
 193 } frsh_contracts_group_t;
 194
 195 typedef struct {
 196     int size;
 197     frsh_contract_label_t contract_labels[FRSH_MAX_N_VRES];
 198 } frsh_contract_labels_group_t;
 199
 200
 201 /**
 202  * An abstract synchronization object is defined by the application.
 203  * This object can be used by an application to wait for an event to
 204  * arrive by invoking the frsh_sychobj_wait() operation.  It
 205  * can also be used to signal the event either causing a waiting
 206  * vres to wake up, or the event to be queued if no vres is
 207  * waiting for it.
 208  **/
 209 typedef FRSH_SYNCHOBJ_HANDLE_T_OPAQUE frsh_synchobj_handle_t;
 210
 211
 212 /*@}*/
 213
 214
 215 #endif   /* !FRSH_CORE_TYPES_H_ */