frsh_hierarchical_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
  56 //==============================================
  57 //  ******** *******    ********  **      **
  58 //  **///// /**////**  **//////  /**     /**
  59 //  **      /**   /** /**        /**     /**
  60 //  ******* /*******  /********* /**********
  61 //  **////  /**///**  ////////** /**//////**
  62 //  **      /**  //**        /** /**     /**
  63 //  **      /**   //** ********  /**     /**
  64 //  //       //     // ////////   //      //
  65 //
  66 // FRSH(FRescor ScHeduler), pronounced "fresh"
  67 //==============================================
  68 #ifndef         FRSH_HIERARCHICAL_TYPES_H_
  69 #define         FRSH_HIERARCHICAL_TYPES_H_
  70
  71 /**
  72  * @file frsh_hierarchical_types.h
  73  **/
  74
  75 #include <time.h>
  76
  77 FRSH_CPP_BEGIN_DECLS
  78
  79 /**
  80  * @addtogroup hierarchical
  81  *
  82  * @{
  83  **/
  84
  85 /** Scheduling policies **/
  86 typedef enum {FRSH_FP, FRSH_EDF, FRSH_TABLE_DRIVEN, FRSH_RR, FRSH_NONE}
  87     frsh_sched_policy_t;
  88
  89 #define FRSH_DEFAULT_SCHED_POLICY        FRSH_NONE
  90
  91 /**
  92  * Scheduling policy and parameters
  93  *
  94  * The params member is a pointer to one of the
  95  * following:
  96  *    FP:  int (priority)
  97  *    EDF: frsh_rel_time_t (deadline)
  98  *    RR:  none
  99  *    TABLE_DRIVEN : struct frsh_table_driven_params_t
 100  **/
 101 typedef struct {
 102   frsh_sched_policy_t    policy;
 103   void *                params;
 104 } frsh_sched_params_t;
 105
 106
 107 /**
 108  * Scheduling parameters for the table-driven policy
 109  * list of target windows
 110  **/
 111 typedef struct {
 112    frsh_rel_time_t   start;
 113    frsh_rel_time_t   end;
 114    frsh_rel_time_t   comp_time;
 115 } frsh_target_window_t;
 116
 117 /**
 118  * Container for a frsh_target_window array
 119  **/
 120 typedef struct {
 121   int size;
 122   frsh_target_window_t  table[FRSH_MAX_N_TARGET_WINDOWS];
 123 } frsh_table_driven_params_t;
 124
 125
 126 /**
 127  * Initialization information for a scheduling policy
 128  *
 129  * It shall be one of the following:
 130  *    FP:  none
 131  *    EDF: none
 132  *    RR: frsh_rel_time_t (slice duration)
 133  *    TABLE_DRIVEN : frsh_rel_time_t (schedule duration)
 134  **/
 135 typedef void * frsh_sched_init_info_t;
 136
 137 /*}*/
 138
 139 FRSH_CPP_END_DECLS
 140
 141 #endif      /* !FRSH_HIERARCHICAL_TYPES_H_ */