Fixed race condition in allocator registration

[frescor/frsh.git] / fres / resalloc / fra_generic.h

diff --git a/fres/resalloc/fra_generic.h b/fres/resalloc/fra_generic.h
index cc05b9841bce1e8ba716c0022844a7a73f90ad92..650e3df6630bef6715dcd1def280b235a3e700d6 100644 (file)
--- a/fres/resalloc/fra_generic.h
+++ b/fres/resalloc/fra_generic.h
@@ -81,6 +81,26 @@ GAVL_CUST_NODE_INT_DEC(fres_vreses_nolock /* cust_prefix */,
 
 extern struct fres_vreses fres_vreses;
 
+struct fres_vres *
+fres_vreses_find_label(fres_block_label *label, fres_block_resource *res);
+
+/** Registry of all threads in an application that are bound to a VRES. */
+struct fres_threads_vres {
+        fosa_mutex_t mutex;     /**< Mutex for manipulation with vreses tree. If all allocators are executed from one executor, locking can be avoided. */
+        gavl_cust_root_field_t threads; /**< Container of all virtual resources */
+};
+
+GAVL_CUST_NODE_INT_DEC(fres_threads_vres_nolock        /* cust_prefix */,
+                      struct fres_threads_vres /* cust_root_t */,
+                      struct fres_thread_vres  /* cust_item_t */,
+                      fres_thread_vres_key_t   /* cust_key_t */,
+                      threads                  /* cust_root_node */,
+                      node                     /* cust_item_node */,
+                      thread_vres              /* cust_item_key */,
+                      fres_thread_vres_cmp     /* cust_cmp_fnc */)
+
+extern struct fres_threads_vres fres_threads_vres;
+
 
 /**
  * Structure describing FRES allocator. It is used as a parameter to
@@ -99,7 +119,7 @@ struct fres_allocator {
         * fres_vres::new.
         * 
         * @param vres VRES to create.
-        * @param priv
+        * @param priv User supplied pointer registered by fra_register()
         * 
         * @return Zero in case of success, nonzero error code on error.
         */
@@ -109,19 +129,32 @@ struct fres_allocator {
         * parameters in fres_vres::new. The currenlty allocated
         * parameters are in fres_vres::allocated. This function
         * should change the fres_vres::perceived to @a fres_vres::new
-        * at some point in time (depending on the kind of the change)
-        * as the fres_vres::allocated parameters will be freed after
-        * the return of this function.
+        * at some point in time (depending on the kind of the change).
+        * The fres_vres::allocated parameters will be freed after
+        * the return of this function and then fres_vres::allocated
+        * will be set to fres_vres::new.
         * 
         * @param vres VRES to change.
-        * @param priv
+        * @param priv User supplied pointer registered by fra_register()
         * 
         * @return Zero in case of success, nonzero error code on error.
         */
        int (*change_vres)(fres_vres_t *vres, void *priv);
+       /** 
+        * Cancel the CRES
+        * 
+        * @param cancel_vres VRES to cancel
+        * 
+        * @return Zero on succaess, non-zero error code on error.
+        */
+       int (*cancel_vres)(fres_vres_t *vres, void *priv);
        /*@}*/
+
        /** @name Full interface
-        * The allocator can influence the order of applying changes. */
+        * 
+        * Full interface provides a way for the allocator to
+        * influence the order of applying changes.
+        */
        /*@{*/
        /**
         * A more general (and more compilcated) allocator
@@ -136,7 +169,8 @@ struct fres_allocator {
         * fres_vres::perceived to @a fres_vres::new at some point in
         * time (depending on the kind of the change) as the
         * fres_vres::allocated parameters will be freed after the
-        * return of this function.
+        * return of this function. When the fres_vres::new contains
+        * no blocks, the VRES should be canceled.
         * 
         * @param vreses Array of pointers to VRESes.
         * @param length The number of elements in @a vreses.
@@ -147,14 +181,21 @@ struct fres_allocator {
        int (*apply_vres_changes)(fres_vres_t *vreses[], unsigned length, void *priv);
        /*@}*/
 
-       /** 
-        * 
-        * 
-        * @param cancel_vres 
-        * 
-        * @return 
-        */
-       int (*cancel_vres)(fres_vres_t *vres, void *priv);
+       /** @name Feedback module support */
+       /*@{*/
+       int (*set_spare_bandwidth)(fres_vres_t *vres);
+       int (*get_desired_budget)(fres_vres_t *vres, frsh_rel_time_t *p_budget_out);
+       int (*set_desired_budget)(fres_vres_t *vres_id, frsh_rel_time_t *p_budget_in);
+       int (*get_actual_budget)(fres_vres_t *vres_id, frsh_rel_time_t *budget);
+       /*@}*/
+
+       int (*bind_thread)(fres_vres_t *vres, fosa_thread_id_t thread);
+       int (*unbind_thread)(fosa_thread_id_t thread);
+
+       int (*vres_get_job_usage)(const fres_vres_t *vres, frsh_rel_time_t *spent);
+       int (*vres_get_remaining_budget)(const fres_vres_t *vres, frsh_rel_time_t *budget);
+       int (*vres_get_usage)(const fres_vres_t *vres, frsh_rel_time_t *spent);
+
        void *priv;             /**< Pointer to allocator's private data */
 
        /**
@@ -168,13 +209,26 @@ fres_resource_allocator fra_new(forb_orb orb,
                                forb_executor_t *executor,
                                struct fres_allocator *allocator);
 
-void fra_registry_init(forb_orb                   orb,
-                      fres_contract_broker fcb,
-                      forb_executor_t     *executor);
+int fra_registry_init(forb_orb            orb,
+                     fres_contract_broker fcb,
+                     forb_executor_t      *executor);
 int fra_register(struct fres_allocator *allocator);
 int fra_activate(frsh_resource_type_t res_type,
                 frsh_resource_id_t   res_id);
+struct fres_allocator *fra_get(frsh_resource_type_t res_type,
+                              frsh_resource_id_t   res_id);
 
 fres_vres_t *fra_get_vres(fres_contract_id_t *id);
 
+int fra_insert_thread_vres(const fosa_thread_id_t *id,
+                          int vres_type,
+                          fres_vres_t *vres);
+int fra_delete_thread_vres(const fosa_thread_id_t *id,
+                          int vres_type);
+fres_thread_vres_t *fra_get_thread_vres(const fosa_thread_id_t *id,
+                                       int vres_type);
+fres_vres_t *fra_get_vres_thread_vres(const fosa_thread_id_t *id,
+                                     int vres_type);
+
 #endif
+