Browse Source

add doc for the prev commit

Andra Hugo 12 years ago
parent
commit
572e0e571d

+ 6 - 0
doc/doxygen/chapters/api/scheduling_contexts.doxy

@@ -129,6 +129,12 @@ blocked)
 \ingroup API_Scheduling_Contexts
 \ingroup API_Scheduling_Contexts
 Return 1 if the worker belongs to the context and 0 otherwise
 Return 1 if the worker belongs to the context and 0 otherwise
 
 
+\fn unsigned starpu_sched_ctx_worker_get_id(unsigned sched_ctx_id)
+\ingroup API_Scheduling_Contexts
+Return the workerid if the worker belongs to the context and -1 otherwise.
+If the thread calling this function is not a worker the function returns -1
+as it calls the function \ref starpu_worker_get_id()
+
 \fn unsigned starpu_sched_ctx_overlapping_ctxs_on_worker(int workerid)
 \fn unsigned starpu_sched_ctx_overlapping_ctxs_on_worker(int workerid)
 \ingroup API_Scheduling_Contexts
 \ingroup API_Scheduling_Contexts
 Check if a worker is shared between several contexts
 Check if a worker is shared between several contexts

+ 5 - 0
doc/doxygen/chapters/api/scheduling_policy.doxy

@@ -162,4 +162,9 @@ Whether \ref STARPU_PREFETCH was set
 \ingroup API_Scheduling_Policy
 \ingroup API_Scheduling_Policy
 Prefetch data for a given task on a given node
 Prefetch data for a given task on a given node
 
 
+\fn void starpu_sched_ctx_worker_shares_tasks_lists (int workerid, int sched_ctx_id)
+\ingroup API_Scheduling_Policy
+The scheduling policies indicates if the worker may pop tasks from the list of other workers
+or if there is a central list with task for all the workers
+
 */
 */

+ 8 - 1
doc/doxygen/chapters/environment_variables.doxy

@@ -599,8 +599,15 @@ the speed of the other contexts, but only by the the value that a context should
 By default the values of the speed of the workers is printed during the execution
 By default the values of the speed of the workers is printed during the execution
 of the application. If the value 1 is given to this environment variable this printing
 of the application. If the value 1 is given to this environment variable this printing
 is not done.
 is not done.
-
 </dd>
 </dd>
 
 
+<dt>SC_HYPERVISOR_LAZY_RESIZE</dt>
+<dd>
+\anchor SC_HYPERVISOR_LAZY_RESIZE
+\addindex __env__SC_HYPERVISOR_LAZY_RESIZE
+By default the hypervisor resizes the contexts in a lazy way, that is workers are firstly added to a new context
+before removing them from the previous one. Once this workers are clearly taken into account 
+into the new context (a task was poped there) we remove them from the previous one. However if the application
+would like that the change in the distribution of workers should change right away this variable should be set to 0
 </dl>
 </dl>
 */
 */