Browse Source

note that starpu_wake_worker is only needed for simgrid or blocking driver modes

Samuel Thibault 8 years ago
parent
commit
260b84ada6
1 changed files with 4 additions and 3 deletions
  1. 4 3
      doc/doxygen/chapters/api/scheduling_policy.doxy

+ 4 - 3
doc/doxygen/chapters/api/scheduling_policy.doxy

@@ -70,8 +70,8 @@ For each task not going through the scheduler (because starpu_task::execute_on_a
         when doing work stealing), but it must acquire it again before taking
         when doing work stealing), but it must acquire it again before taking
         the decision whether to return a task or NULL, so the atomicity of
         the decision whether to return a task or NULL, so the atomicity of
         deciding to return NULL and making the worker actually sleep is
         deciding to return NULL and making the worker actually sleep is
-        preserved. Otherwise the worker might start sleeping while a task has
-        just been pushed for it.
+        preserved. Otherwise in simgrid or blocking driver mode the worker might start
+        sleeping while a task has just been pushed for it.
 
 
         If this method is defined as <c>NULL</c>, the worker will only execute
         If this method is defined as <c>NULL</c>, the worker will only execute
         tasks from its local queue. In this case, the push_task method should
         tasks from its local queue. In this case, the push_task method should
@@ -119,7 +119,8 @@ block and wake up all workers.
 
 
 \fn int starpu_wake_worker(int workerid)
 \fn int starpu_wake_worker(int workerid)
 \ingroup API_Scheduling_Policy
 \ingroup API_Scheduling_Policy
-This should be called by push functions to wake the potential workers that are
+In simgrid or blocking driver mode, 
+this should be called by push functions to wake the potential workers that are
 supposed to pick up the tasks which just have been pushed, otherwise they may
 supposed to pick up the tasks which just have been pushed, otherwise they may
 remain sleeping.
 remain sleeping.