]> rtime.felk.cvut.cz Git - frescor/frsh-include.git/blobdiff - frsh_spare_capacity.h
const
[frescor/frsh-include.git] / frsh_spare_capacity.h
index 6363fbff57b78398bd527362b9bc1737b7b4df4c..bed3edec7123bcbe2245d6e6ba8f3c9391685bc7 100644 (file)
@@ -77,6 +77,7 @@
 #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,
@@ -220,9 +248,9 @@ int frsh_contract_set_reclamation_params(frsh_contract_t   *contract,
  **/
 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,
@@ -230,7 +258,7 @@ int frsh_contract_get_reclamation_params
 
 
 /**
- * frsh_vres_get_stability_time()
+ * frsh_vres_get_remaining_stability_time()
  *
  * This operation returns the stability_time for the vres.
  *
@@ -245,8 +273,31 @@ int frsh_contract_get_reclamation_params
  *       is not valid \n
  * 
  **/
-int frsh_vres_get_stability_time(frsh_vres_id_t vres, 
-                                      struct timespec *stability_time);
+int frsh_vres_get_remaining_stability_time(frsh_vres_id_t vres, 
+                                      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()
@@ -294,7 +345,7 @@ int frsh_resource_get_total_weight
    (const frsh_resource_type_t resource_type,
     const frsh_resource_id_t resource_id,
     const int importance,
-    uint32_t *capacity);
+    uint32_t *total_weight);
 
 
 /**
@@ -309,10 +360,12 @@ int frsh_resource_get_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_