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