// -----------------------------------------------------------------------
-// Copyright (C) 2006 - 2007 FRESCOR consortium partners:
+// Copyright (C) 2006 - 2008 FRESCOR consortium partners:
//
// Universidad de Cantabria, SPAIN
// University of York, UK
// Visual Tools S.A. SPAIN
// Rapita Systems Ltd UK
// Evidence ITALY
-//
+//
// See http://www.frescor.org for a link to partners' websites
//
// FRESCOR project (FP6/2005/IST/5-034026) is funded
//
//
// based on previous work (FSF) done in the FIRST project
-//
+//
// Copyright (C) 2005 Mälardalen University, SWEDEN
// Scuola Superiore S.Anna, ITALY
// Universidad de Cantabria, SPAIN
// FSF API web pages: http://marte.unican.es/fsf/docs
// http://shark.sssup.it/contrib/first/docs/
//
-// This file is part of FRSH API
-//
-// FRSH API is free software; you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation; either version 2, or (at your option)
-// any later version.
-//
-// FRSH API is distributed in the hope that it will be useful, but
-// WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-// General Public License for more details.
+// This file is part of FRSH (FRescor ScHeduler)
//
-// You should have received a copy of the GNU General Public License
-// distributed with FRSH API; see file COPYING. If not, write to the
-// Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-// 02111-1307, USA.
+// FRSH is free software; you can redistribute it and/or modify it
+// under terms of the GNU General Public License as published by the
+// Free Software Foundation; either version 2, or (at your option) any
+// later version. FRSH is distributed in the hope that it will be
+// useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+// of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+// General Public License for more details. You should have received a
+// copy of the GNU General Public License along with FRSH; see file
+// COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,
+// Cambridge, MA 02139, USA.
//
-// As a special exception, if you include this header file into source
-// files to be compiled, this header file does not by itself cause
-// the resulting executable to be covered by the GNU General Public
-// License. This exception does not however invalidate any other
-// reasons why the executable file might be covered by the GNU General
-// Public License.
+// As a special exception, including FRSH header files in a file,
+// instantiating FRSH generics or templates, or linking other files
+// with FRSH objects to produce an executable application, does not
+// by itself cause the resulting executable application to be covered
+// by the GNU General Public License. This exception does not
+// however invalidate any other reasons why the executable file might be
+// covered by the GNU Public License.
// -----------------------------------------------------------------------
//frsh_spare_capacity.h
//==============================================
#include "frsh_core_types.h"
#include "frsh_core.h"
+FRSH_CPP_BEGIN_DECLS
/**
* @file frsh_spare_capacity.h
* There are no specific negotiation calls because the algorithms used
* in the core module take already these min-max ranges into account.
*
+ * An operation is available for applications to ask for a stability
+ * period of a specified length. The framework will then return the
+ * total capacity (execution time budget and virtual resource period)
+ * that the application is guaranteed to receive in this stability
+ * period. The rationale for this service is that jobs may span a
+ * number of virtual resource periods, and need to have a guaranteed
+ * amount of capacity before they can choose a higher quality (longer
+ * execution time) method, when multiple methods are available. Also
+ * applications may require that the capacity provided to them and
+ * hence the quality of results produced remains consistent for a
+ * period of time, so that consistent behaviour is provided for the
+ * user (e.g. multimedia applications).
+ *
+ * Requesting a new stability period has the effect of cancelling any
+ * previous one. So a subsequent request for stability up to the same
+ * point in time could return a lower total capacity, if spare capacity
+ * re-allocation is in progress due to the admission of a new
+ * application. If a stability period expires without having explicitly
+ * set a new one, the system may decide to perform a reallocation of
+ * spare resources at that point, or may defer this decision to some
+ * future point in time when it is appropriate. In both cases, a new
+ * stability period will start when the new spare capacity assignment
+ * is in effect.
+ *
+ *
* NOTE: When we talk here about "spare capacity" we mean STATIC extra
* capacity at NEGOTIATION TIME. This is the minimum capacity
* that the vres will get based on contract negotiation.
* awakening and replenishment periods.
* @param granularity FRSH_CONTINUOUS: Use min-max values,
* FRSH_DISCRETE: Use utilization_set.
- * @param utilization_set A structure of discrete pairs (budget,period)
+ * @param utilization_set A structure of discrete triples (budget,
+ * period, deadline)
* @param importance non-cooperative urgency indicator. Vres with
* higher importance will get all spare capacity des
* @param weight cooperative urgency indicator. At equal
* importance, spare capacity will be distributed
* proportionally to weight levels.
*
+ *
* @return 0 if successful \n
* FRSH_ERR_BAD_ARGUMENT : if contract is NULL \b or \n
* (budget_max value is grater than period_max or smaller than budget_min) \b or \n
*
**/
int frsh_contract_set_reclamation_params(frsh_contract_t *contract,
- const struct timespec *stability_time,
- const struct timespec *budget_max,
- const struct timespec *period_min,
+ const frsh_rel_time_t *stability_time,
+ const frsh_rel_time_t *budget_max,
+ const frsh_rel_time_t *period_min,
frsh_granularity_t granularity,
const frsh_utilization_set_t *utilization_set,
int importance,
**/
int frsh_contract_get_reclamation_params
(const frsh_contract_t *contract,
- struct timespec *stability_time,
- struct timespec *budget_max,
- struct timespec *period_min,
+ frsh_rel_time_t *stability_time,
+ frsh_rel_time_t *budget_max,
+ frsh_rel_time_t *period_min,
frsh_granularity_t *granularity,
frsh_utilization_set_t *utilization_set,
int *importance,
*
**/
int frsh_vres_get_remaining_stability_time(frsh_vres_id_t vres,
- struct timespec *stability_time);
+ frsh_rel_time_t *stability_time);
+
+
+/**
+ * frsh_vres_set_stability_time:
+ *
+ * Dynamically set the stability time for a given virtual resource to
+ * the specified interval. This operation sets a new value for the
+ * stability time associated with the virtual resource. As a result of
+ * this call the system may change the allocation of resources to the
+ * current virtual resource. Regardless of whether the resources are
+ * reallocated or not, the call resets the stability period so that
+ * the level of resources allocated to the virtual resource is kept
+ * stable for at least the duration of the requested interval. The
+ * possibly new values of budget and period are returned in the
+ * corresponding parameters
+ */
+
+int frsh_vres_set_stability_time
+ (frsh_vres_id_t vres,
+ const frsh_rel_time_t *stability_time,
+ frsh_rel_time_t *budget,
+ frsh_rel_time_t *period);
+
/**
* frsh_resource_get_capacity()
(const frsh_resource_type_t resource_type,
const frsh_resource_id_t resource_id,
const int importance,
- uint32_t *capacity);
+ uint32_t *total_weight);
/**
*
**/
int frsh_vres_decrease_capacity(frsh_vres_id_t vres,
- struct timespec new_budget,
- struct timespec new_period);
+ frsh_rel_time_t new_budget,
+ frsh_rel_time_t new_period);
/*@}*/
+FRSH_CPP_END_DECLS
+
#endif // _FRSH_SPARE_CAPACITY_H_
projects / frescor / frsh-include.git / blobdiff