|
@@ -147,41 +147,25 @@ hint given to the scheduler as there is no guarantee that they will be
|
|
|
executed on the same worker.
|
|
|
@end deftp
|
|
|
|
|
|
-@deftypefun void starpu_task_bundle_init ({starpu_task_bundle_t *}@var{bundle})
|
|
|
-Initialize a task bundle
|
|
|
-@end deftypefun
|
|
|
-
|
|
|
-@deftypefun void starpu_task_bundle_deinit (starpu_task_bundle_t @var{bundle})
|
|
|
-Deinitialize a bundle.
|
|
|
+@deftypefun void starpu_task_bundle_create ({starpu_task_bundle_t *}@var{bundle})
|
|
|
+Factory function creating and initializing @var{bundle}, when the call returns, memory needed is allocated and @var{bundle} is ready to use.
|
|
|
@end deftypefun
|
|
|
|
|
|
@deftypefun int starpu_task_bundle_insert (starpu_task_bundle_t @var{bundle}, {struct starpu_task *}@var{task})
|
|
|
-Insert a task into a bundle.
|
|
|
+Insert @var{task} in @var{bundle}. Until @var{task} is removed from @var{bundle} its expected length and data transfer time will be considered along those of the other tasks of @var{bundle}.
|
|
|
+This function mustn't be called if @var{bundle} is already closed and/or @var{task} is already submitted.
|
|
|
@end deftypefun
|
|
|
|
|
|
@deftypefun int starpu_task_bundle_remove (starpu_task_bundle_t @var{bundle}, {struct starpu_task *}@var{task})
|
|
|
-Remove a task from a bundle. This method must be called with
|
|
|
-bundle->mutex hold. This function returns 0 if the task was found,
|
|
|
--ENOENT if the element was not found, 1 if the element is found and if
|
|
|
-the list was deinitialized because it became empty.
|
|
|
+Remove @var{task} from @var{bundle}.
|
|
|
+Of course @var{task} must have been previously inserted @var{bundle}.
|
|
|
+This function mustn't be called if @var{bundle} is already closed and/or @var{task} is already submitted. Doing so would result in undefined behaviour.
|
|
|
@end deftypefun
|
|
|
|
|
|
@deftypefun void starpu_task_bundle_close (starpu_task_bundle_t @var{bundle});
|
|
|
-Close a bundle. No task can be added to a closed bundle. A closed
|
|
|
-bundle automatically gets deinitialized when it becomes empty.
|
|
|
-@end deftypefun
|
|
|
-
|
|
|
-@deftypefun double starpu_task_bundle_expected_length (starpu_task_bundle_t @var{bundle}, {enum starpu_perf_archtype} @var{arch}, unsigned @var{nimpl})
|
|
|
-Return the expected duration of the entire task bundle in µs.
|
|
|
+Inform the runtime that the user won't modify @var{bundle} anymore, it means no more inserting or removing task. Thus the runtime can destroy it when possible.
|
|
|
@end deftypefun
|
|
|
|
|
|
-@deftypefun double starpu_task_bundle_expected_data_transfer_time (starpu_task_bundle_t @var{bundle}, unsigned {memory_node})
|
|
|
-Return the time (in µs) expected to transfer all data used within the bundle
|
|
|
-@end deftypefun
|
|
|
-
|
|
|
-@deftypefun double starpu_task_bundle_expected_power (starpu_task_bundle_t @var{bundle}, {enum starpu_perf_archtype} @var{arch}, unsigned @var{nimpl})
|
|
|
-Return the expected power consumption of the entire task bundle in J.
|
|
|
-@end deftypefun
|
|
|
|
|
|
@node Task Lists
|
|
|
@section Task Lists
|