include/frsh_fna.h

   1 //----------------------------------------------------------------------
   2 //  Copyright (C) 2006 - 2007 by the FRESCOR consortium:
   3 //
   4 //    Universidad de Cantabria,              SPAIN
   5 //    University of York,                    UK
   6 //    Scuola Superiore Sant'Anna,            ITALY
   7 //    Kaiserslautern University,             GERMANY
   8 //    Univ. Politecnica  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
  17 //
  18 //        The 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 // This file is part of FNA (Frescor Network Adaptation)
  32 //
  33 // FNA is free software; you can redistribute it and/or modify it
  34 // under terms of the GNU General Public License as published by the
  35 // Free Software Foundation; either version 2, or (at your option) any
  36 // later version.  FNA is distributed in the hope that it will be
  37 // useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  38 // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  39 // General Public License for more details. You should have received a
  40 // copy of the GNU General Public License along with FNA; see file
  41 // COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,
  42 // Cambridge, MA 02139, USA.
  43 //
  44 // As a special exception, including FNA header files in a file,
  45 // instantiating FNA generics or templates, or linking other files
  46 // with FNA objects to produce an executable application, does not
  47 // by itself cause the resulting executable application to be covered
  48 // by the GNU General Public License. This exception does not
  49 // however invalidate any other reasons why the executable file might be
  50 // covered by the GNU Public License.
  51 // -----------------------------------------------------------------------
  52
  53 //==============================================
  54 //  ******** ****     **     **
  55 //  **///// /**/**   /**    ****
  56 //  **      /**//**  /**   **//**
  57 //  ******* /** //** /**  **  //**
  58 //  **////  /**  //**/** **********
  59 //  **      /**   //****/**//////**
  60 //  **      /**    //***/**     /**
  61 //  /       //      /// //      //
  62 //
  63 // FNA(Frescor Network Adaptation layer), pronounced "efe ene a"
  64 //==============================================================
  65
  66 #ifndef _FRSH_FNA_H_
  67 #define _FRSH_FNA_H_
  68
  69 #include "frsh.h" /* for frsh_resource_id_t, network_address_t, stream_id_t*/
  70 #include <time.h> /* for timespec */
  71 #include <stdbool.h> /* for bool */
  72 #include "fna_configuration.h"
  73
  74 #ifdef RTEP_FNA_ENABLED
  75    #include "rtep.h"
  76 #endif
  77
  78 /**
  79  * @defgroup frshfna FNA Public Interface
  80  *
  81  * FNA is a Network adaption layer that allows to plugin new
  82  * network protocols to the distributed module.
  83  *
  84  * It is divided in two parts:
  85  *  - FRSH_FNA: public types and functions for the FRSH API
  86  *  - FNA: private functions only used within FRSH.
  87  *
  88  **/
  89
  90 ////////////////////////////////////////////////////////////////////
  91 //          MAPPING FUNCTIONS
  92 ////////////////////////////////////////////////////////////////////
  93
  94 /**
  95  * @defgroup frshfnamap FNA Mapping Functions
  96  * @ingroup frshfna
  97  *
  98  * These functions are needed to map network specific types to FRSH types.
  99  * Instead of providing this mapping functions a static hardwired configuration
 100  * could be used.
 101  *
 102  * @{
 103  **/
 104
 105 /**
 106  * frsh_XXXX_map_network_address()
 107  *
 108  * To map a XXXX protocol network address into a FRSH address.
 109  * The protocol must keep this mapping consistent. Instead of using a function
 110  * a hardwired mapping could be used.
 111  *
 112  * @param[in] resource_id The network we are referring to (a protocol
 113  * could be able to handle several networks at the same time)
 114  * @param[in] in_address The network address we want to map to a frsh address
 115  * @param[out] out_address The FRSH abstract network address
 116  *
 117  * @return
 118  *   FNA_NO_ERROR: in this case it also means contract accepted \n
 119  *   FNA_ERR_INTERNAL_ERROR: protocol dependent internal errors \n
 120  *   FNA_ERR_NOT_INITIALIZED: if the protocol is not initialized \n
 121  *   FNA_ERR_RESOURCE_ID_INVALID: if we are not in charge of resource_id \n
 122  *   FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
 123  *
 124  **/
 125 #ifdef RTEP_FNA_ENABLED
 126 int frsh_rtep_map_network_address(const frsh_resource_id_t resource_id,
 127                                   const rtep_station_id_t in_address,
 128                                   frsh_network_address_t *out_address);
 129 #endif
 130
 131 /**
 132  * frsh_XXXX_map_stream_id()
 133  *
 134  * To map a XXXX protocol network stream, port, channel... into a FRSH stream.
 135  * The protocol must keep this mapping consistent. Instead of using a function
 136  * a hardwired mapping could be used.
 137  *
 138  * @param[in] resource_id The network we are referring to (a protocol
 139  * could be able to handle several networks at the same time)
 140  * @param[in] in_stream The network stream we want to map to a FRSH stream
 141  * @param[out] out_stream The FRSH abstract network stream
 142  *
 143  * @return
 144  *   FNA_NO_ERROR: in this case it also means contract accepted \n
 145  *   FNA_ERR_INTERNAL_ERROR: protocol dependent internal errors \n
 146  *   FNA_ERR_NOT_INITIALIZED: if the protocol is not initialized \n
 147  *   FNA_ERR_RESOURCE_ID_INVALID: if we are not in charge of resource_id \n
 148  *   FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
 149  *
 150  **/
 151 #ifdef RTEP_FNA_ENABLED
 152 int frsh_rtep_map_stream_id(const frsh_resource_id_t resource_id,
 153                             const rtep_channel_t in_stream,
 154                             frsh_stream_id_t *out_stream);
 155 #endif
 156
 157 /*@}*/
 158
 159 ///////////////////////////////////////////////////////////////////
 160 //           NEGOTIATION SERVICE PARAMETERS
 161 ///////////////////////////////////////////////////////////////////
 162 /**
 163  * @defgroup frshfnaserv FNA Negotiation Service Parameters
 164  * @ingroup frshfna
 165  *
 166  * These functions are needed to set/get the negotiation service parameters.
 167  *
 168  * @{
 169  **/
 170
 171 /**
 172  * frsh_XXXX_negotiation_messages__vres_renegotiate()
 173  *
 174  * This function allows the application to change the minimum period
 175  * of the negotiation messages sent through the network. It is similar
 176  * to the service thread but for the network messages. We do not provide
 177  * budget here because the size of the negotiation messages is fixed.
 178  *
 179  * This change is similar to a renegotiation so a schedulability test
 180  * must be done to see if the change can be accepted or not.
 181  *
 182  * @param[in] resource_id The network we are referring to (a protocol
 183  * could be able to handle several networks at the same time)
 184  * @param[in] period The new period for negotiation messages
 185  * @param[out] accepted If the change has been accepted or not
 186  *
 187  * @return
 188  *   FNA_NO_ERROR: in this case it also means contract accepted \n
 189  *   FNA_ERR_INTERNAL_ERROR: protocol dependent internal errors \n
 190  *   FNA_ERR_NOT_INITIALIZED: if the protocol is not initialized \n
 191  *   FNA_ERR_RESOURCE_ID_INVALID: if we are not in charge of resource_id \n
 192  *   FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
 193  *   FNA_ERR_REJECTED_CONTRACT : if the renegotiation fails \n
 194  *
 195  **/
 196 #ifdef RTEP_FNA_ENABLED
 197 int frsh_rtep_negotiation_messages_vres_renegotiate
 198       (const frsh_resource_id_t resource_id,
 199        const struct timespec *period);
 200 #endif
 201
 202 /**
 203  * frsh_XXXX_negotiation_messages_vres_get_period()
 204  *
 205  * This function gets the minimum period of the negotiation messages
 206  * sent through the network.
 207  *
 208  * @param[in] resource_id The network we are referring to (a protocol
 209  * could be able to handle several networks at the same time)
 210  * @param[out] period The period for negotiation messages
 211  *
 212  * @return
 213  *   FNA_NO_ERROR: in this case it also means contract accepted \n
 214  *   FNA_ERR_INTERNAL_ERROR: protocol dependent internal errors \n
 215  *   FNA_ERR_NOT_INITIALIZED: if the protocol is not initialized \n
 216  *   FNA_ERR_RESOURCE_ID_INVALID: if we are not in charge of resource_id \n
 217  *   FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
 218  *
 219  **/
 220 #ifdef RTEP_FNA_ENABLED
 221 int frsh_rtep_negotiation_messages_vres_get_period
 222       (const frsh_resource_id_t resource_id,
 223        struct timespec *period);
 224 #endif
 225
 226 /**
 227  * frsh_XXXX_service_thread_vres_renegotiate()
 228  *
 229  * This function allows the application to change the period and
 230  * budget of the service thread that makes the negotiations and
 231  * schedulability tests in a network.
 232  *
 233  * The service thread starts with a default budget and period that
 234  * should be configurable
 235  *
 236  * @param[in] resource_id The network we are referring to (a protocol
 237  * could be able to handle several networks at the same time)
 238  * @param[in] budget The new budget for the service thread
 239  * @param[in] period The new period for the service thread
 240  * @param[out] accepted If the negotiation has been accepted or not
 241  *
 242  * @return
 243  *   FNA_NO_ERROR: in this case it also means contract accepted \n
 244  *   FNA_ERR_INTERNAL_ERROR: protocol dependent internal errors \n
 245  *   FNA_ERR_NOT_INITIALIZED: if the protocol is not initialized \n
 246  *   FNA_ERR_RESOURCE_ID_INVALID: if we are not in charge of resource_id \n
 247  *   FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
 248  *
 249  **/
 250 #ifdef RTEP_FNA_ENABLED
 251 int frsh_rtep_service_thread_vres_renegotiate
 252    (const frsh_resource_id_t resource_id,
 253     const struct timespec *budget,
 254     const struct timespec *period,
 255     bool *accepted);
 256 #endif
 257
 258 /**
 259  * frsh_XXXX_service_thread_vres_get_budget_and_period()
 260  *
 261  * This function gets the budget and period of a service thread.
 262  *
 263  * @param[in] resource_id The network we are referring to (a protocol
 264  * could be able to handle several networks at the same time)
 265  * @param[out] budget The budget of the service thread
 266  * @param[out] period The period of the service thread
 267  *
 268  * @return
 269  *   FNA_NO_ERROR: in this case it also means contract accepted \n
 270  *   FNA_ERR_INTERNAL_ERROR: protocol dependent internal errors \n
 271  *   FNA_ERR_NOT_INITIALIZED: if the protocol is not initialized \n
 272  *   FNA_ERR_RESOURCE_ID_INVALID: if we are not in charge of resource_id \n
 273  *   FNA_ERR_BAD_ARGUMENT: if pointers are NULL \n
 274  *
 275  **/
 276 #ifdef RTEP_FNA_ENABLED
 277 int frsh_rtep_service_thread_vres_get_budget_and_period
 278       (const frsh_resource_id_t resource_id,
 279        struct timespec *budget,
 280        struct timespec *period);
 281 #endif
 282
 283 /*@}*/
 284
 285 #endif /* _FRSH_FNA_H_ */