浏览代码

doc: add missing data types and missing fields for already documented struct data types

Nathalie Furmento 13 年之前
父节点
当前提交
3cceea6331
共有 1 个文件被更改,包括 63 次插入1 次删除
  1. 63 1
      doc/chapters/basic-api.texi

+ 63 - 1
doc/chapters/basic-api.texi

@@ -1044,6 +1044,10 @@ This partitions a 3D matrix along the X axis.
 
 
 This section describes the interface to manipulate codelets and tasks.
 This section describes the interface to manipulate codelets and tasks.
 
 
+@deftp {Data Type} {enum starpu_codelet_type}
+todo
+@end deftp
+
 @deftp {Data Type} {struct starpu_codelet}
 @deftp {Data Type} {struct starpu_codelet}
 The codelet structure describes a kernel that is possibly implemented on various
 The codelet structure describes a kernel that is possibly implemented on various
 targets. For compatibility, make sure to initialize the whole structure to zero.
 targets. For compatibility, make sure to initialize the whole structure to zero.
@@ -1057,6 +1061,16 @@ indicates that it is only available on Cell SPUs. If the field is
 unset, its value will be automatically set based on the availability
 unset, its value will be automatically set based on the availability
 of the @code{XXX_funcs} fields defined below.
 of the @code{XXX_funcs} fields defined below.
 
 
+@item @code{can_execute} (optional)
+todo
+
+@item @code{type}
+@code{enum starpu_codelet_type}
+todo
+
+@item @code{max_parallelism} (optional)
+todo
+
 @item @code{cpu_func} (optional)
 @item @code{cpu_func} (optional)
 This field has been made deprecated. One should use instead the
 This field has been made deprecated. One should use instead the
 @code{cpu_funcs} field.
 @code{cpu_funcs} field.
@@ -1140,9 +1154,20 @@ involved in the parallel execution.
 
 
 TODO
 TODO
 
 
+@item @code{per_worker_stats} (optional)
+todo
+
+@item @code{name} (optional)
+todo
+
+
 @end table
 @end table
 @end deftp
 @end deftp
 
 
+@deftp {Data Type} {enum starpu_task_status}
+todo
+@end deftp
+
 @deftp {Data Type} {struct starpu_task}
 @deftp {Data Type} {struct starpu_task}
 The @code{starpu_task} structure describes a task that can be offloaded on the various
 The @code{starpu_task} structure describes a task that can be offloaded on the various
 processing units managed by StarPU. It instantiates a codelet. It can either be
 processing units managed by StarPU. It instantiates a codelet. It can either be
@@ -1174,6 +1199,9 @@ of entries in this array must be specified in the @code{nbuffers} field of the
 If unsufficient, this value can be set with the @code{--enable-maxbuffers}
 If unsufficient, this value can be set with the @code{--enable-maxbuffers}
 option when configuring StarPU.
 option when configuring StarPU.
 
 
+@item @code{interfaces}
+todo
+
 @item @code{cl_arg} (optional; default: @code{NULL})
 @item @code{cl_arg} (optional; default: @code{NULL})
 This pointer is passed to the codelet through the second argument
 This pointer is passed to the codelet through the second argument
 of the codelet implementation (e.g. @code{cpu_func} or @code{cuda_func}).
 of the codelet implementation (e.g. @code{cpu_func} or @code{cuda_func}).
@@ -1237,6 +1265,9 @@ which is the identifier of the worker that should process this task (as
 returned by @code{starpu_worker_get_id}). This field is ignored if
 returned by @code{starpu_worker_get_id}). This field is ignored if
 @code{execute_on_a_specific_worker} field is set to 0.
 @code{execute_on_a_specific_worker} field is set to 0.
 
 
+@item @code{bundle} (optional)
+todo
+
 @item @code{detach} (optional) (default: @code{1})
 @item @code{detach} (optional) (default: @code{1})
 If this flag is set, it is not possible to synchronize with the task
 If this flag is set, it is not possible to synchronize with the task
 by the means of @code{starpu_task_wait} later on. Internal data structures
 by the means of @code{starpu_task_wait} later on. Internal data structures
@@ -1251,10 +1282,36 @@ allocated data structures will not be freed until @code{starpu_task_destroy} is
 called explicitly. Setting this flag for a statically allocated task structure
 called explicitly. Setting this flag for a statically allocated task structure
 will result in undefined behaviour.
 will result in undefined behaviour.
 
 
+@item @code{regenerate} (optional)
+todo
+
+@item @code{status} (optional)
+@code{enum starpu_task_status} todo
+
+@item @code{profiling_info} (optional)
+@code{struct starpu_task_profiling_info *} todo
+
 @item @code{predicted} (output field)
 @item @code{predicted} (output field)
 Predicted duration of the task. This field is only set if the scheduling
 Predicted duration of the task. This field is only set if the scheduling
 strategy used performance models.
 strategy used performance models.
 
 
+@item @code{predicted_transfer} (optional)
+todo
+
+@item @code{prev}
+todo
+
+@item @code{next}
+todo
+
+@item @code{mf_skip}
+todo
+
+@item @code{starpu_private}
+todo
+
+@item @code{magic}
+todo
 @end table
 @end table
 @end deftp
 @end deftp
 
 
@@ -1481,6 +1538,10 @@ OpenCL types range within STARPU_OPENCL_DEFAULT (GPU number 0), STARPU_OPENCL_DE
 @end table
 @end table
 @end deftp
 @end deftp
 
 
+@deftp {Data Type} {enum starpu_perfmodel_type}
+todo (see below)
+@end deftp
+
 @deftp {Data Type} {struct starpu_perfmodel}
 @deftp {Data Type} {struct starpu_perfmodel}
 contains all information about a performance model. At least the
 contains all information about a performance model. At least the
 @code{type} and @code{symbol} fields have to be filled when defining a
 @code{type} and @code{symbol} fields have to be filled when defining a
@@ -1488,7 +1549,8 @@ performance model for a codelet. If not provided, other fields have to be zero.
 
 
 @table @asis
 @table @asis
 @item @code{type}
 @item @code{type}
-is the type of performance model. @code{STARPU_HISTORY_BASED},
+is the type of performance model @code{enum starpu_perfmodel_type}:
+@code{STARPU_HISTORY_BASED},
 @code{STARPU_REGRESSION_BASED}, @code{STARPU_NL_REGRESSION_BASED}: No
 @code{STARPU_REGRESSION_BASED}, @code{STARPU_NL_REGRESSION_BASED}: No
 other fields needs to be provided, this is purely history-based. @code{STARPU_PER_ARCH}:
 other fields needs to be provided, this is purely history-based. @code{STARPU_PER_ARCH}:
 @code{per_arch} has to be filled with functions which return the cost in
 @code{per_arch} has to be filled with functions which return the cost in