fres/contract/contract_func.c

   1 /**************************************************************************/
   2 /* ---------------------------------------------------------------------- */
   3 /* Copyright (C) 2006 - 2008 FRESCOR consortium partners:                 */
   4 /*                                                                        */
   5 /*   Universidad de Cantabria,              SPAIN                         */
   6 /*   University of York,                    UK                            */
   7 /*   Scuola Superiore Sant'Anna,            ITALY                         */
   8 /*   Kaiserslautern University,             GERMANY                       */
   9 /*   Univ. Politécnica  Valencia,           SPAIN                        */
  10 /*   Czech Technical University in Prague,  CZECH REPUBLIC                */
  11 /*   ENEA                                   SWEDEN                        */
  12 /*   Thales Communication S.A.              FRANCE                        */
  13 /*   Visual Tools S.A.                      SPAIN                         */
  14 /*   Rapita Systems Ltd                     UK                            */
  15 /*   Evidence                               ITALY                         */
  16 /*                                                                        */
  17 /*   See http://www.frescor.org for a link to partners' websites          */
  18 /*                                                                        */
  19 /*          FRESCOR project (FP6/2005/IST/5-034026) is funded             */
  20 /*       in part by the European Union Sixth Framework Programme          */
  21 /*       The European Union is not liable of any use that may be          */
  22 /*       made of this code.                                               */
  23 /*                                                                        */
  24 /*                                                                        */
  25 /*  This file is part of FRSH (FRescor ScHeduler)                         */
  26 /*                                                                        */
  27 /* FRSH is free software; you can redistribute it and/or modify it        */
  28 /* under terms of the GNU General Public License as published by the      */
  29 /* Free Software Foundation; either version 2, or (at your option) any    */
  30 /* later version.  FRSH is distributed in the hope that it will be        */
  31 /* useful, but WITHOUT ANY WARRANTY; without even the implied warranty    */
  32 /* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU    */
  33 /* General Public License for more details. You should have received a    */
  34 /* copy of the GNU General Public License along with FRSH; see file       */
  35 /* COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,  */
  36 /* Cambridge, MA 02139, USA.                                              */
  37 /*                                                                        */
  38 /* As a special exception, including FRSH header files in a file,         */
  39 /* instantiating FRSH generics or templates, or linking other files       */
  40 /* with FRSH objects to produce an executable application, does not       */
  41 /* by itself cause the resulting executable application to be covered     */
  42 /* by the GNU General Public License. This exception does not             */
  43 /* however invalidate any other reasons why the executable file might be  */
  44 /* covered by the GNU Public License.                                     */
  45 /**************************************************************************/
  46
  47 /**
  48  * @file   contract_func.c
  49  * @author Michal Sojka <sojkam1@fel.cvut.cz>
  50  * @date   Wed Feb 18 15:35:25 2009
  51  *
  52  * @brief  Helper contract manipulation functions
  53  *
  54  *
  55  */
  56
  57
  58 #include <fres_contract.h>
  59
  60 /**
  61  * Convenience function to retrieve a deadline from contract.
  62  *
  63  * Deadline in contract can be specified directly as a interval or
  64  * indirectly through contract period (d_equals_t). This functions
  65  * retrieves the deadline from the correct field.
  66  *
  67  * @param[in] contract
  68  * @param[out] deadline Where to store the deadline.
  69  *
  70  * @return True if the contract specifies the deadline, false if not.
  71  */
  72 bool
  73 fres_contract_get_deadline(const frsh_contract_t *contract,
  74                            frsh_rel_time_t       *deadline)
  75 {
  76         fres_block_timing_reqs *timing;
  77         bool has_deadline = false;
  78
  79         if (!contract || !deadline) {
  80                 goto error;
  81         }
  82
  83         timing = fres_contract_get_timing_reqs(*contract);
  84         if (timing) {
  85                 if (timing->d_equals_t) {
  86                         fres_block_basic *basic;
  87                         basic = fres_contract_get_basic(*contract);
  88                         *deadline = basic->period;
  89                 } else {
  90                         *deadline = timing->deadline;
  91                 }
  92                 has_deadline = true;
  93         }
  94 error:
  95         return has_deadline;
  96 }
  97
  98 /**
  99  * Convenience function to retrieve budget from a contract.
 100  *
 101  * @param[in] contract
 102  * @param[out] budget Where to store the deadline.
 103  *
 104  * @return True if the contract specifies the budget, false if not.
 105  */
 106 bool
 107 fres_contract_get_budget(const frsh_contract_t *contract,
 108                          frsh_rel_time_t       *budget)
 109 {
 110         fres_block_basic *basic;
 111         basic = fres_contract_get_basic(*contract);
 112         if (basic)
 113                 *budget = basic->budget;
 114         return basic != NULL;
 115 }
 116
 117 /**
 118  * Convenience function to retrieve period from a contract.
 119  *
 120  * @param[in] contract
 121  * @param[out] period Where to store the deadline.
 122  *
 123  * @return True if the contract specifies the period, false if not.
 124  */
 125 bool
 126 fres_contract_get_period(const frsh_contract_t *contract,
 127                          frsh_rel_time_t       *period)
 128 {
 129         fres_block_basic *basic;
 130         basic = fres_contract_get_basic(*contract);
 131         if (basic)
 132                 *period = basic->period;
 133         return basic != NULL;
 134 }
 135
 136 frsh_contract_type_t
 137 fres_contract_get_type(const frsh_contract_t *contract)
 138 {
 139         fres_block_basic *basic;
 140         basic = fres_contract_get_basic(*contract);
 141         if (basic)
 142                 return basic->contract_type;
 143         else
 144                 return FRSH_CT_DUMMY;
 145
 146 }