doc: rename Scheduling_Context_Hypervisor to SC_Hypervisor

doc/doxygen/chapters/api/sc_hypervisor/sc_hypervisor.doxy

@@ -6,10 +6,10 @@
  * See the file version.doxy for copying conditions.
  */
 
-/*! \defgroup API_Scheduling_Context_Hypervisor Scheduling Context Hypervisor - Building a new resizing policy
+/*! \defgroup API_SC_Hypervisor Scheduling Context Hypervisor - Building a new resizing policy
 
 \struct sc_hypervisor_policy
-\ingroup API_Scheduling_Context_Hypervisor
+\ingroup API_SC_Hypervisor
 This structure contains all the methods that implement a hypervisor resizing policy.
 \var sc_hypervisor_policy::name
         Indicates the name of the policy, if there is not a custom policy, the policy corresponding to this name will be used by the hypervisor
@@ -37,7 +37,7 @@ This structure contains all the methods that implement a hypervisor resizing pol
 	The hypervisor takes a decision when a certain ctx was deleted
 
 \struct sc_hypervisor_policy_config
-\ingroup API_Scheduling_Context_Hypervisor
+\ingroup API_SC_Hypervisor
 This structure contains all configuration information of a
 context. It contains configuration information for each context, which
 can be used to construct new resize strategies.
@@ -65,7 +65,7 @@ can be used to construct new resize strategies.
         todo
 
 \struct sc_hypervisor_wrapper
-\ingroup API_Scheduling_Context_Hypervisor
+\ingroup API_SC_Hypervisor
 This structure is a wrapper of the contexts available in StarPU
 and contains all information about a context obtained by incrementing
 the performance counters.
@@ -120,7 +120,7 @@ the performance counters.
 	The number of ready tasks in a context
 
 \struct sc_hypervisor_resize_ack
-\ingroup API_Scheduling_Context_Hypervisor
+\ingroup API_SC_Hypervisor
 This structures checks if the workers moved to another context
 are actually taken into account in that context.
 \var sc_hypervisor_resize_ack::receiver_sched_ctx
@@ -135,7 +135,7 @@ are actually taken into account in that context.
 
 \struct sc_hypervisor_policy_task_pool
 task wrapper linked list
-\ingroup API_Scheduling_Context_Hypervisor
+\ingroup API_SC_Hypervisor
 \var sc_hypervisor_policy_task_pool::cl
 Which codelet has been executed
 \var sc_hypervisor_policy_task_pool::footprint
@@ -150,48 +150,48 @@ The quantity of data(in bytes) needed by the task to execute
 Other task kinds
 
 \fn void sc_hypervisor_post_resize_request(unsigned sched_ctx, int task_tag)
-\ingroup API_Scheduling_Context_Hypervisor
+\ingroup API_SC_Hypervisor
 Requires resizing the context \p sched_ctx whenever a task tagged with the id \p task_tag
 finished executing 
 
 \fn unsigned sc_hypervisor_get_size_req(unsigned **sched_ctxs, int* nsched_ctxs, int **workers, int *nworkers)
-\ingroup API_Scheduling_Context_Hypervisor
+\ingroup API_SC_Hypervisor
 Check if there are pending demands of resizing
 
 \fn void sc_hypervisor_save_size_req(unsigned *sched_ctxs, int nsched_ctxs, int *workers, int nworkers)
-\ingroup API_Scheduling_Context_Hypervisor
+\ingroup API_SC_Hypervisor
 Save a demand of resizing
 
 \fn void sc_hypervisor_free_size_req(void)
-\ingroup API_Scheduling_Context_Hypervisor
+\ingroup API_SC_Hypervisor
 Clear the list of pending demands of resizing
 
 \fn unsigned sc_hypervisor_can_resize(unsigned sched_ctx)
-\ingroup API_Scheduling_Context_Hypervisor
+\ingroup API_SC_Hypervisor
 Check out if a context can be resized
 
 \fn struct sc_hypervisor_policy_config *sc_hypervisor_get_config(unsigned sched_ctx)
-\ingroup API_Scheduling_Context_Hypervisor
+\ingroup API_SC_Hypervisor
 Returns the configuration structure of a context
 
 \fn void sc_hypervisor_set_config(unsigned sched_ctx, void *config)
-\ingroup API_Scheduling_Context_Hypervisor
+\ingroup API_SC_Hypervisor
 Set a certain configuration to a contexts
 
 \fn unsigned *sc_hypervisor_get_sched_ctxs()
-\ingroup API_Scheduling_Context_Hypervisor
+\ingroup API_SC_Hypervisor
     Gets the contexts managed by the hypervisor
 
 \fn int sc_hypervisor_get_nsched_ctxs()
-\ingroup API_Scheduling_Context_Hypervisor
+\ingroup API_SC_Hypervisor
     Gets the number of contexts managed by the hypervisor
 
 \fn struct sc_hypervisor_wrapper *sc_hypervisor_get_wrapper(unsigned sched_ctx)
-\ingroup API_Scheduling_Context_Hypervisor
+\ingroup API_SC_Hypervisor
     Returns the wrapper corresponding the context \p sched_ctx
 
 \fn double sc_hypervisor_get_elapsed_flops_per_sched_ctx(struct sc_hypervisor_wrapper *sc_w)
-\ingroup API_Scheduling_Context_Hypervisor
+\ingroup API_SC_Hypervisor
     Returns the flops of a context elapsed from the last resize
 
 

doc/doxygen/chapters/api/sc_hypervisor/sc_hypervisor_usage.doxy

@@ -6,10 +6,10 @@
  * See the file version.doxy for copying conditions.
  */
 
-/*! \defgroup API_Scheduling_Context_Hypervisor_usage Scheduling Context Hypervisor - Regular usage
+/*! \defgroup API_SC_Hypervisor_usage Scheduling Context Hypervisor - Regular usage
 
 \fn void *sc_hypervisor_init(struct sc_hypervisor_policy *policy)
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 There is a single hypervisor that is in charge of resizing contexts
 and the resizing strategy is chosen at the initialization of the
 hypervisor. A single resize can be done at a time.
@@ -29,14 +29,14 @@ certain conditions trigger the resizing process (there is no
 additional thread assigned to the hypervisor).
 
 \fn void sc_hypervisor_shutdown(void)
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 The hypervisor and all information concerning it is cleaned. There is
 no synchronization between this function and starpu_shutdown(). Thus,
 this should be called after starpu_shutdown(), because the performance
 counters will still need allocated callback functions.
 
 \fn void sc_hypervisor_register_ctx(unsigned sched_ctx, double total_flops)
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 Scheduling Contexts that have to be resized by the hypervisor must be
 first registered to the hypervisor. 
 This function registers the context to the hypervisor, and indicate the number of
@@ -44,66 +44,66 @@ flops the context will execute (used for Gflops rate based strategy
 or any other custom strategy needing it, for the others we can pass 0.0)
 
 \fn void sc_hypervisor_unregister_ctx(unsigned sched_ctx)
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 Whenever we want to exclude
 contexts from the resizing process we have to unregister them from the
 hypervisor.
 
 \fn void sc_hypervisor_resize_ctxs(int *sched_ctxs, int nsched_ctxs , int *workers, int nworkers)
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 Requires reconsidering the distribution of ressources over the indicated scheduling contexts 
 
 \fn void sc_hypervisor_stop_resize(unsigned sched_ctx)
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 The user can totally forbid the resizing of a certain context or can
 then change his mind and allow it (in this case the resizing is
 managed by the hypervisor, that can forbid it or allow it)
 
 \fn void sc_hypervisor_start_resize(unsigned sched_ctx)
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 Allow resizing of a context. The user can then provide information to
 the hypervisor concerning the conditions of resizing.
 
 \fn char *sc_hypervisor_get_policy();
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 Returns the name of the resizing policy the hypervisor uses
 
 \fn void sc_hypervisor_add_workers_to_sched_ctx(int* workers_to_add, unsigned nworkers_to_add, unsigned sched_ctx)
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 Ask the hypervisor to add workers to a sched_ctx 
 
 \fn void sc_hypervisor_remove_workers_from_sched_ctx(int* workers_to_remove, unsigned nworkers_to_remove, unsigned sched_ctx, unsigned now)
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 Ask the hypervisor to remove workers from a sched_ctx 
 
 \fn void sc_hypervisor_move_workers(unsigned sender_sched_ctx, unsigned receiver_sched_ctx, int *workers_to_move, unsigned nworkers_to_move, unsigned now)
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 Moves workers from one context to another
    
 \fn void sc_hypervisor_size_ctxs(unsigned *sched_ctxs, int nsched_ctxs, int *workers, int nworkers)
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 Ask the hypervisor to chose a distribution of workers in the required contexts
    
 
 \fn void sc_hypervisor_set_type_of_task(struct starpu_codelet *cl, unsigned sched_ctx, uint32_t footprint, size_t data_size)
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 Indicate the types of tasks a context will execute in order to better decide the sizing of ctxs
 
 \fn void sc_hypervisor_update_diff_total_flops(unsigned sched_ctx, double diff_total_flops)
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 Change dynamically the total number of flops of a context, move the deadline of the finishing time of the context
 
 \fn void sc_hypervisor_update_diff_elapsed_flops(unsigned sched_ctx, double diff_task_flops)
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 Change dynamically the number of the elapsed flops in a context, modify the past in order to better compute the speed 
 
 \fn void sc_hypervisor_ctl(unsigned sched_ctx, ...)
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 Inputs conditions to the context sched_ctx with the following
 arguments. The argument list must be zero-terminated.
 
 \def SC_HYPERVISOR_MAX_IDLE
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 This macro is used when calling sc_hypervisor_ctl() and must be
 followed by 3 arguments: an array of int for the workerids to apply
 the condition, an int to indicate the size of the array, and a double
@@ -111,7 +111,7 @@ value indicating the maximum idle time allowed for a worker before the
 resizing process should be triggered
 
 \def SC_HYPERVISOR_PRIORITY
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 This macro is used when calling sc_hypervisor_ctl() and must be
 followed by 3 arguments: an array of int for the workerids to apply
 the condition, an int to indicate the size of the array, and an int
@@ -119,20 +119,20 @@ value indicating the priority of the workers previously mentioned. The
 workers with the smallest priority are moved the first.
 
 \def SC_HYPERVISOR_MIN_WORKERS
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 This macro is used when calling sc_hypervisor_ctl() and must be
 followed by 1 argument(int) indicating the minimum number of workers a
 context should have, underneath this limit the context cannot execute.
 
 \def SC_HYPERVISOR_MAX_WORKERS
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 This macro is used when calling sc_hypervisor_ctl() and must be
 followed by 1 argument(int) indicating the maximum number of workers a
 context should have, above this limit the context would not be able to
 scale
 
 \def SC_HYPERVISOR_GRANULARITY
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 This macro is used when calling sc_hypervisor_ctl() and must be
 followed by 1 argument(int) indicating the granularity of the resizing
 process (the number of workers should be moved from the context once
@@ -141,14 +141,14 @@ strategy (see \ref ResizingStrategies), the number of workers that have to
 be moved is calculated by the strategy.
 
 \def SC_HYPERVISOR_FIXED_WORKERS
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 This macro is used when calling sc_hypervisor_ctl() and must be
 followed by 2 arguments: an array of int for the workerids to apply
 the condition and an int to indicate the size of the array. These
 workers are not allowed to be moved from the context.
 
 \def SC_HYPERVISOR_MIN_TASKS
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 This macro is used when calling sc_hypervisor_ctl() and must be
 followed by 1 argument (int) that indicated the minimum number of
 tasks that have to be executed before the context could be resized.
@@ -157,34 +157,34 @@ ResizingStrategies) where the user indicates exactly when the resize
 should be done.
 
 \def SC_HYPERVISOR_NEW_WORKERS_MAX_IDLE
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 This macro is used when calling sc_hypervisor_ctl() and must be
 followed by 1 argument, a double value indicating the maximum idle
 time allowed for workers that have just been moved from other contexts
 in the current context.
 
 \def SC_HYPERVISOR_TIME_TO_APPLY
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 This macro is used when calling sc_hypervisor_ctl() and must be
 followed by 1 argument (int) indicating the tag an executed task
 should have such that this configuration should be taken into account.
 
 
 \def SC_HYPERVISOR_ISPEED_W_SAMPLE
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 This macro is used when calling sc_hypervisor_ctl() and must be
 followed by 1 argument, a double, that indicates the number of flops
 needed to be executed before computing the speed of a worker
 
 \def SC_HYPERVISOR_ISPEED_CTX_SAMPLE
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 This macro is used when calling sc_hypervisor_ctl() and must be
 followed by 1 argument, a double, that indicates the number of flops
 needed to be executed before computing the speed of a context
 
 
 \def SC_HYPERVISOR_NULL
-\ingroup API_Scheduling_Context_Hypervisor_usage
+\ingroup API_SC_Hypervisor_usage
 This macro is used when calling sc_hypervisor_ctl() and must be
 followed by 1 arguments
 

doc/doxygen/refman.tex

@@ -224,8 +224,8 @@ Documentation License”.
 \input{group__API__StarPUTop__Interface}
 \input{group__API__Scheduling__Contexts}
 \input{group__API__Scheduling__Policy}
-\input{group__API__Scheduling__Context__Hypervisor__usage}
-\input{group__API__Scheduling__Context__Hypervisor}
+\input{group__API__SC__Hypervisor__usage}
+\input{group__API__SC__Hypervisor}
 
 \chapter{File Index}
 \input{files}