doc/doxygen: update doc

doc/doxygen/chapters/advanced_examples.doxy

@@ -453,7 +453,7 @@ to a less optimal solution. This increases even more computation time.
 
 StarPU provides the wrapper function <c>starpu_insert_task</c> to ease
 the creation and submission of tasks. See the definition of the
-functions in @ref{Insert Task}.
+functions in \ref Insert_Task.
 
 Here the implementation of the codelet:
 
@@ -683,9 +683,11 @@ starpu_data_unregister_submit(handle);
 Some kernels sometimes need temporary data to achieve the computations, i.e. a
 workspace. The application could allocate it at the start of the codelet
 function, and free it at the end, but that would be costly. It could also
-allocate one buffer per worker (similarly to @ref{Per-worker library
-initialization}), but that would make them systematic and permanent. A more
-optimized way is to use the SCRATCH data access mode, as examplified below,
+allocate one buffer per worker (similarly to \ref
+Per-worker_library_initialization), but that would make them
+systematic and permanent. A more  optimized way is to use the
+::STARPU_SCRATCH data access mode, as examplified below,
+
 which provides per-worker buffers without content consistency.
 
 \code{.c}
@@ -949,7 +951,7 @@ A full example may be found in <c>examples/basic_examples/multiformat.c</c>.
 
 \section Using_the_Driver_API Using the Driver API
 
-@pxref{Running drivers}
+\ref Running_drivers
 
 \code{.c}
 int ret;

doc/doxygen/chapters/api/fxt_support.doxy

@@ -8,6 +8,60 @@
 
 /*! \defgroup FxT_Support FxT Support
 
+\struct starpu_fxt_codelet_event
+\brief todo
+\ingroup FxT_Support
+\var starpu_fxt_codelet_event::symbol[256
+name of the codelet
+\var starpu_fxt_codelet_event::workerid
+\var starpu_fxt_codelet_event::archtype
+\var starpu_fxt_codelet_event::hash
+\var starpu_fxt_codelet_event::size
+\var starpu_fxt_codelet_event::time
+
+\struct starpu_fxt_options
+\brief todo
+\ingroup FxT_Support
+\var starpu_fxt_options::per_task_colour
+\var starpu_fxt_options::no_counter
+\var starpu_fxt_options::no_bus
+\var starpu_fxt_options::ninputfiles
+\var starpu_fxt_options::filenames
+\var starpu_fxt_options::out_paje_path
+\var starpu_fxt_options::distrib_time_path
+\var starpu_fxt_options::activity_path
+\var starpu_fxt_options::dag_path
+
+\var starpu_fxt_options::file_prefix
+In case we are going to gather multiple traces (e.g in the case of MPI
+processes), we may need to prefix the name of the containers.
+\var starpu_fxt_options::file_offset
+In case we are going to gather multiple traces (e.g in the case of MPI
+processes), we may need to prefix the name of the containers.
+\var starpu_fxt_options::file_rank
+In case we are going to gather multiple traces (e.g in the case of MPI
+processes), we may need to prefix the name of the containers.
+
+\var starpu_fxt_options::worker_names
+Output parameters
+\var starpu_fxt_options::worker_archtypes
+Output parameters
+\var starpu_fxt_options::nworkers
+Output parameters
+
+\var starpu_fxt_options::dumped_codelets
+In case we want to dump the list of codelets to an external tool
+\var starpu_fxt_options::dumped_codelets_count
+In case we want to dump the list of codelets to an external tool
+
+\fn void starpu_fxt_options_init(struct starpu_fxt_options *options)
+\ingroup FxT_Support
+todo
+
+\fn void starpu_fxt_generate_trace(struct starpu_fxt_options *options)
+\ingroup FxT_Support
+todo
+
 \fn void starpu_fxt_start_profiling(void)
 \ingroup FxT_Support
 Start recording the trace. The trace is by default started from

doc/doxygen/chapters/api/multiformat_data_interface.doxy

@@ -27,6 +27,7 @@
         pointer to a codelet which converts from CUDA to CPU
 
 \struct starpu_multiformat_interface
+\brief todo
 \ingroup Multiformat_Data_Interface
 \var starpu_multiformat_interface::id
 \var starpu_multiformat_interface::cpu_ptr

doc/doxygen/chapters/api/parallel_tasks.doxy

@@ -47,49 +47,5 @@ workers
 Initialise the barrier for the parallel task, and dispatch the task
 between the different combined workers.
 
-\struct starpu_machine_topology
-\ingroup Parallel_Tasks
-\var starpu_machine_topology::nworkers
-        Total number of workers.
-\var starpu_machine_topology::ncombinedworkers
-        Total number of combined workers.
-\var starpu_machine_topology::hwtopology
-        Topology as detected by hwloc. To maintain ABI compatibility
-	when hwloc is not available, the field is replaced with <c>void *dummy</c>
-\var starpu_machine_topology::nhwcpus
-        Total number of CPUs, as detected by the topology code. May be
-	different from the actual number of CPU workers.
-\var starpu_machine_topology::nhwcudagpus
-        Total number of CUDA devices, as detected. May be different
-	from the actual number of CUDA workers.
-\var starpu_machine_topology::nhwopenclgpus
-        Total number of OpenCL devices, as detected. May be different
-	from the actual number of OpenCL workers.
-\var starpu_machine_topology::ncpus
-        Actual number of CPU workers used by StarPU.
-\var starpu_machine_topology::ncudagpus
-        Actual number of CUDA workers used by StarPU.
-\var starpu_machine_topology::nopenclgpus
-        Actual number of OpenCL workers used by StarPU.
-\var starpu_machine_topology::workers_bindid
-        Indicates the successive cpu identifier that should be used to
-	bind the workers. It is either filled according to the user’s
-	explicit parameters (from starpu_conf()) or according to the
-	STARPU_WORKERS_CPUID environment variable. Otherwise, a
-	round-robin policy is used to distributed the workers over the cpus.
-\var starpu_machine_topology::workers_cuda_gpuid
-        Indicates the successive cuda identifier that should be used by
-	the CUDA driver. It is either filled according to the user’s
-	explicit parameters (from starpu_conf()) or according to the
-	STARPU_WORKERS_CUDAID environment variable. Otherwise, they are taken
-	in ID order.
-\var starpu_machine_topology::workers_opencl_gpuid
-        Indicates the successive OpenCL identifier that should be used
-        by the OpenCL driver. It is either filled according to the
-        user’s explicit parameters (from starpu_conf()) or according to
-        the STARPU_WORKERS_OPENCLID environment variable. Otherwise,
-        they are taken in ID order.
-
-
 */
 

doc/doxygen/chapters/api/scheduling_context_hypervisor.doxy

@@ -88,6 +88,20 @@ are actually taken into account in that context.
         If the value corresponding to a worker is 1, this one is taken
 	into account in the new context if 0 not yet
 
+\struct sc_hypervisor_policy_task_pool
+\brief task wrapper linked list
+\ingroup Scheduling_Context_Hypervisor
+\var sc_hypervisor_policy_task_pool::cl
+Which codelet has been executed
+\var sc_hypervisor_policy_task_pool::footprint
+Task footprint key
+\var sc_hypervisor_policy_task_pool::sched_ctx_id
+Context the task belongs to
+\var sc_hypervisor_policy_task_pool::n
+Number of tasks of this kind
+\var sc_hypervisor_policy_task_pool::next
+Other task kinds
+
 @name Managing the hypervisor
 \ingroup Scheduling_Context_Hypervisor
 

doc/doxygen/chapters/api/scheduling_contexts.doxy

@@ -171,6 +171,12 @@ policy of the given scheduler context.
 @name Scheduling Context Worker Collection
 \ingroup Scheduling_Contexts
 
+\struct starpu_sched_ctx_iterator
+\ingroup Scheduling_Contexts
+\brief todo
+\var starpu_sched_ctx_iterator::cursor
+todo
+
 \struct starpu_worker_collection
 \ingroup Scheduling_Contexts
 \brief A scheduling context manages a collection of workers that can
@@ -185,17 +191,19 @@ structures(like tree) implementations are foreseen.
 \var starpu_worker_collection::type
         The type of structure (currently STARPU_WORKER_LIST is the only one available)
 \var starpu_worker_collection::has_next
-        Checks if there is a next worker
+        Checks if there is another element in collection
 \var starpu_worker_collection::get_next
-        Gets the next worker
+        return the next element in the collection
 \var starpu_worker_collection::add
-        Adds a worker to the collection
+        add a new element in the collection
 \var starpu_worker_collection::remove
-        Removes a worker from the collection
+        remove an element from the collection
 \var starpu_worker_collection::init
         Initialize the collection
 \var starpu_worker_collection::deinit
         Deinitialize the colection
+\var starpu_worker_collection::init_iterator
+        Initialize the cursor if there is one
 
 \fn struct starpu_worker_collection* starpu_sched_ctx_create_worker_collection(unsigned sched_ctx_id, enum starpu_worker_collection_type type)
 \ingroup Scheduling_Contexts

doc/doxygen/chapters/api/scheduling_policy.doxy

@@ -163,5 +163,12 @@ Returns expected power consumption in J
 \ingroup Scheduling_Policy
 Returns expected conversion time in ms (multiformat interface only)
 
+\fn int starpu_get_prefetch_flag(void)
+\ingroup Scheduling_Policy
+Whether STARPU_PREFETCH was set
+
+\fn int starpu_prefetch_task_input_on_node(struct starpu_task *task, unsigned node)
+\ingroup Scheduling_Policy
+Prefetch data for a given task on a given node
 
 */