|
@@ -140,61 +140,46 @@ the format.
|
|
|
@node Task Bundles
|
|
|
@section Task Bundles
|
|
|
|
|
|
-@deftp {DataType} {struct starpu_task_bundle_entry}
|
|
|
-TODO
|
|
|
-@end deftp
|
|
|
-
|
|
|
-@deftp {DataType} {struct starpu_task_bundle}
|
|
|
-The task bundle structure describes a list of tasks that should be
|
|
|
-scheduled together whenever possible. The different fields are:
|
|
|
-@table @asis
|
|
|
-@item @code{mutex}
|
|
|
-Mutex protecting the bundle
|
|
|
-@item @code{int previous_workerid}
|
|
|
-last worker previously assigned a task from the bundle (-1 if none)
|
|
|
-@item @code{struct starpu_task_bundle_entry *list}
|
|
|
-list of tasks
|
|
|
-@item @code{int destroy}
|
|
|
-If this flag is set, the bundle structure is automatically free'd when the bundle is deinitialized.
|
|
|
-@item @code{int closed}
|
|
|
-Is the bundle closed ?
|
|
|
-@end table
|
|
|
+@deftp starpu_task_bundle_t
|
|
|
+Opaque structure describing a list of tasks that should be scheduled
|
|
|
+on the same worker whenever it's possible. It must be considered as a
|
|
|
+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 ({struct starpu_task_bundle *}@var{bundle})
|
|
|
+@deftypefun void starpu_task_bundle_init ({starpu_task_bundle_t *}@var{bundle})
|
|
|
Initialize a task bundle
|
|
|
@end deftypefun
|
|
|
|
|
|
-@deftypefun void starpu_task_bundle_deinit ({struct starpu_task_bundle *}@var{bundle})
|
|
|
-Deinitialize a bundle. In case the destroy flag is set, the bundle
|
|
|
-structure is freed too.
|
|
|
+@deftypefun void starpu_task_bundle_deinit (starpu_task_bundle_t @var{bundle})
|
|
|
+Deinitialize a bundle.
|
|
|
@end deftypefun
|
|
|
|
|
|
-@deftypefun int starpu_task_bundle_insert ({struct starpu_task_bundle *}@var{bundle}, {struct starpu_task *}@var{task})
|
|
|
+@deftypefun int starpu_task_bundle_insert (starpu_task_bundle_t @var{bundle}, {struct starpu_task *}@var{task})
|
|
|
Insert a task into a bundle.
|
|
|
@end deftypefun
|
|
|
|
|
|
-@deftypefun int starpu_task_bundle_remove ({struct starpu_task_bundle *}@var{bundle}, {struct starpu_task *}@var{task})
|
|
|
+@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.
|
|
|
@end deftypefun
|
|
|
|
|
|
-@deftypefun void starpu_task_bundle_close ({struct starpu_task_bundle *}@var{bundle});
|
|
|
+@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 ({struct starpu_task_bundle *}@var{bundle}, {enum starpu_perf_archtype} @var{arch}, unsigned @var{nimpl})
|
|
|
+@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.
|
|
|
@end deftypefun
|
|
|
|
|
|
-@deftypefun double starpu_task_bundle_expected_data_transfer_time ({struct starpu_task_bundle *}@var{bundle}, unsigned {memory_node})
|
|
|
+@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 ({struct starpu_task_bundle *}@var{bundle}, {enum starpu_perf_archtype} @var{arch}, unsigned @var{nimpl})
|
|
|
+@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
|
|
|
|