frsh_spare_capacity_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_spare_capacity_types.h
  56 //==============================================
  57 //  ******** *******    ********  **      **
  58 //  **///// /**////**  **//////  /**     /**
  59 //  **      /**   /** /**        /**     /**
  60 //  ******* /*******  /********* /**********
  61 //  **////  /**///**  ////////** /**//////**
  62 //  **      /**  //**        /** /**     /**
  63 //  **      /**   //** ********  /**     /**
  64 //  //       //     // ////////   //      //
  65 //
  66 // FRSH(FRescor ScHeduler), pronounced "fresh"
  67 //==============================================
  68
  69 #ifndef         FRSH_SPARE_CAPACITY_TYPES_H_
  70 #define         FRSH_SPARE_CAPACITY_TYPES_H_
  71
  72 #include <time.h>
  73
  74 FRSH_CPP_BEGIN_DECLS
  75
  76 /**
  77  * @file frsh_spare_capacity_types.h
  78  **/
  79
  80 /**
  81  * @addtogroup sparecapacity
  82  *
  83  * @{
  84  **/
  85
  86 /*************************/
  87 /* D E F I N I T I O N S */
  88 /*************************/
  89
  90 /** Granularity of spare capacity requirements: continuous or discrete **/
  91 typedef enum {FRSH_GR_CONTINUOUS, FRSH_GR_DISCRETE} frsh_granularity_t;
  92
  93 /** Utilization (C, T, and D) **/
  94 typedef struct {
  95     frsh_rel_time_t    budget;    // Execution time
  96     frsh_rel_time_t    period;    // Period
  97     frsh_rel_time_t    deadline;  // Deadline
  98 } frsh_utilization_t;
  99
 100 /** List of utilization values **/
 101 typedef struct {
 102     int                      size; // = 0
 103     frsh_utilization_t utilizations[FRSH_MAX_N_UTILIZATION_VALUES];
 104 } frsh_utilization_set_t;
 105
 106 // Constants for assigning default values
 107 #define FRSH_DEFAULT_GRANULARITY         FRSH_GR_CONTINUOUS
 108 #define FRSH_DEFAULT_WEIGHT              1 // Cannot be zero with fsa_response_time
 109 #define FRSH_DEFAULT_IMPORTANCE          1
 110
 111 // Constants for omitting the assignment of values to specific
 112 // arguments in calls to initialization functions
 113 #define FRSH_NULL_UTILIZATION_SET     \
 114    (frsh_utilization_set_t *)NULL
 115
 116 /*@}*/
 117
 118 FRSH_CPP_END_DECLS
 119
 120
 121 #endif      /* !FRSH_SPARE_CAPACITY_TYPES_H_ */