frsh.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
  59 //==============================================
  60 //  ******** *******    ********  **      **
  61 //  **///// /**////**  **//////  /**     /**
  62 //  **      /**   /** /**        /**     /**
  63 //  ******* /*******  /********* /**********
  64 //  **////  /**///**  ////////** /**//////**
  65 //  **      /**  //**        /** /**     /**
  66 //  **      /**   //** ********  /**     /**
  67 //  //       //     // ////////   //      //
  68 //
  69 // FRSH(FRescor ScHeduler), pronounced "fresh"
  70 //==============================================
  71 #ifndef _FRSH_H_
  72 #define _FRSH_H_
  73
  74 /**
  75  * @file frsh.h
  76  *
  77  * Intended to be used by API clients to get the interface
  78  * requirements.
  79  *
  80  * It is also used by the library files to enforce the interface
  81  * headings.
  82  *
  83  * However it is NOT used by any of the FRSH include files to avoid
  84  * having include deadlocks.
  85  **/
  86
  87 #include "fosa.h"
  88
  89 #include "frsh_cpp_macros.h"
  90
  91 #include "frsh_configuration_parameters.h"
  92
  93 /* We include all the types because they are needed for the
  94    frsh_contract_parameters_t */
  95
  96 #include "frsh_core_types.h"
  97 #include "frsh_shared_objects_types.h"
  98 #include "frsh_spare_capacity_types.h"
  99 #include "frsh_hierarchical_types.h"
 100 #include "frsh_distributed_types.h"
 101 #include "frsh_implementation_specific_types.h"
 102
 103 #include "frsh_core.h"
 104 #include "frsh_thread_attrs.h"
 105 #include "frsh_time.h"
 106 #include "frsh_implementation_specific.h"
 107
 108 // Configure these modules by commenting out the appropiate lines
 109
 110 #include "frsh_hierarchical.h"                 //
 111 #include "frsh_shared_objects.h"
 112 #include "frsh_dynamic_reclaiming.h"           //
 113 #include "frsh_spare_capacity.h"
 114 #include "frsh_distributed.h"                  //
 115 #include "frsh_feedback_control.h"
 116 #include "frsh_memory_management.h"
 117 #include "frsh_energy_management.h"
 118
 119 #include "frsh_debug_and_trace.h"
 120
 121 #ifndef FRSH_HIERARCHICAL_MODULE_SUPPORTED
 122     #define FRSH_HIERARCHICAL_MODULE_SUPPORTED        0
 123
 124 #endif  //FRSH_HIERARCHICAL_MODULE_SUPPORTED
 125
 126 #ifndef FRSH_SHARED_OBJECTS_MODULE_SUPPORTED
 127     #define FRSH_SHARED_OBJECTS_MODULE_SUPPORTED      0
 128 #endif  //FRSH_SHARED_OBJECTS_MODULE_SUPPORTED
 129
 130 #ifndef FRSH_DYNAMIC_RECLAIMING_MODULE_SUPPORTED
 131     #define FRSH_DYNAMIC_RECLAIMING_MODULE_SUPPORTED  0
 132 #endif  //FRSH_DYNAMIC_RECLAIMING_MODULE_SUPPORTED
 133
 134 #ifndef FRSH_SPARE_CAPACITY_MODULE_SUPPORTED
 135     #define FRSH_SPARE_CAPACITY_MODULE_SUPPORTED      0
 136
 137     //Return warnings if spare_capacity module is not included:
 138
 139     #define frsh_set_contract_reclamation_parameters  \
 140       (contract, budget_max, period_min, granularity,\
 141        utilization_set, quality,  importance)        \
 142        ( FRSH_WRN_MODULE_NOT SUPPORTED )
 143
 144     #define frsh_get_contract_reclamation_parameters  \
 145       (contract, budget_max, period_min, granularity,\
 146        utilization_set, quality, importance)         \
 147        ( FRSH_WRN_MODULE_NOT SUPPORTED )
 148
 149     #define frsh_request_change_quality_and_importance\
 150       (server, new_importance, new_quality)          \
 151        ( FRSH_WRN_MODULE_NOT SUPPORTED )
 152
 153     #define frsh_get_total_quality (server,total_quality)\
 154        ( FRSH_WRN_MODULE_NOT SUPPORTED )
 155
 156 #endif  //FRSH_SPARE_CAPACITY_MODULE_SUPPORTED
 157
 158 #endif // _FRSH_H_