frsh_memory_management.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 //frsh_memory_management.h
  59
  60 //==============================================
  61 //  ******** *******    ********  **      **
  62 //  **///// /**////**  **//////  /**     /**
  63 //  **      /**   /** /**        /**     /**
  64 //  ******* /*******  /********* /**********
  65 //  **////  /**///**  ////////** /**//////**
  66 //  **      /**  //**        /** /**     /**
  67 //  **      /**   //** ********  /**     /**
  68 //  //       //     // ////////   //      //
  69 //
  70 // FRSH(FRescor ScHeduler), pronounced "fresh"
  71 //==============================================
  72
  73 #ifndef _FRSH_MEMORY_MANAGEMENT_H_
  74 #define _FRSH_MEMORY_MANAGEMENT_H_
  75
  76 #include "frsh_fosa.h"
  77 #include "frsh_core_types.h"
  78
  79
  80 #define FRSH_MEMORY_MANAGEMENT_SUPPORTED 1
  81
  82 /**
  83  * @file frsh_memory_management.h
  84  **/
  85
  86 /**
  87  * @defgroup memmanagement Memory Management
  88  *
  89  * This module provides the types and the functions to add memory
  90  * management support to FRSH contracts.
  91  *
  92  * @{
  93  *
  94  **/
  95
  96 /**
  97  * frsh_contract_set_memory_reqs()
  98  *
  99  * This function specifies in the contract the minimum and maximum
 100  * memory needed by the application.
 101  *
 102  * @param[in] min_memory  Minimum needed memory in bytes.
 103  * @param[in] max_memory  Maximum needed memory in bytes.
 104  * @param  contract   Contract, in-out argument.
 105  *
 106  * @return 0 if no error \n
 107  *     FRSH_ERR_BAD_ARGUMENT if min_memory > max_memory
 108  *
 109  **/
 110 int frsh_contract_set_memory_reqs(size_t min_memory,
 111                                   size_t max_memory,
 112                                   frsh_contract_t *contract);
 113
 114 /**
 115  * frsh_contract_get_memory_reqs()
 116  *
 117  * This function gets the memory parameters from the contract.
 118  *
 119  * @param[in] contract Contract object
 120  * @param[out] min_memory  Placeholder for the minimum required
 121  *                         memory.
 122  * @param[out] max_memory  Placeholder for the maximum required
 123  *                         memory.
 124  *
 125  * @return 0 if no error \n
 126  *      FRSH_ERR_BAD_ARGUMENT if one of the pointers is NULL
 127  **/
 128 int frsh_contract_get_memory_reqs(const frsh_contract_t *contract,
 129                                   size_t *min_memory,
 130                                   size_t *max_memory);
 131
 132
 133 /**
 134  * frsh_vres_get_memory_info()
 135  *
 136  * This function gives us the runtime info of memory usage and
 137  * reservation.
 138  *
 139  * @param[in] vres_id Identifier of vres
 140  * @param[out] mem_allocated Memory currently allocated to the vres
 141  * @param[out] mem_budget Total pool of memory reserved for the vres
 142  *             (until next renegotiation).
 143  *
 144  * @return 0 if no error \n
 145  *      FRSH_ERR_BAD_ARGUMENT if one of the pointers is NULL
 146  **/
 147 int frsh_vres_get_memory_info(frsh_vres_id_t vres_id,
 148                               size_t *mem_allocated,
 149                               size_t *mem_budget);
 150
 151
 152 /**
 153  * frsh_vres_memalloc()
 154  *
 155  * This function reserves some memory from the memory to this virtual
 156  * resource.
 157  *
 158  * @param[in] vres_id Identifier of vres.
 159  * @param[in] Number of bytes
 160  * @param[out] Valid pointer for the allocation
 161  *
 162  * @return 0 if no error \n
 163  *      FRSH_ERR_BAD_ARGUMENT if the area pointer is NULL
 164  *      FRSH_ERR_OUT_OF_BUDGET if no budget is available
 165  **/
 166 int frsh_vres_malloc(frsh_vres_id_t vres_id,
 167                      size_t num_bytes,
 168                      void **area);
 169
 170 /**
 171  * frsh_vres_memfree()
 172  *
 173  * This function returns the previously allocated memory area for this
 174  * virtual_resource to the main memory.
 175  *
 176  * @param[in] vres_id Identifier of vres.
 177  * @param[in] area    Memory area to return
 178  *
 179  * @return 0 if no error \n
 180  *      FRSH_ERR_BAD_ARGUMENT if the area pointer is NULL
 181  **/
 182 int frsh_vres_memfree(frsh_vres_id_t vres_id,
 183                       void *area);
 184
 185
 186
 187
 188 /*@}*/
 189
 190 #endif      /* !FRSH_MEMORY_MANAGEMENT_H_ */