comment remaining StarPU-RM routines

doc/doxygen/chapters/api/interoperability.doxy

@@ -102,7 +102,7 @@ more workers, up to the number of StarPU worker threads initialized.
 \ingroup API_Interop_Support
 
 Extend StarPU's default scheduling context to execute tasks on the
-additional logical units selected in \c mask. Logical units for which no
+additional logical units selected in \c mask. Logical units of \c mask for which no
 StarPU worker is initialized are silently ignored.
 
 \fn starpurm_drs_ret_t starpurm_assign_all_cpus_to_starpu(starpurm_drs_desc_t *spd)
@@ -114,75 +114,84 @@ available logical units for which a StarPU worker has been initialized.
 
 \fn starpurm_drs_ret_t starpurm_withdraw_cpu_from_starpu(starpurm_drs_desc_t *spd, int cpuid)
 \ingroup API_Interop_Support
-TODO.
+
+Shrink StarPU's default scheduling context so as to not execute tasks on worker
+corresponding to logical unit \c cpuid. If StarPU does not have a worker
+thread initialized for logical unit \c cpuid, do nothing.
 
 \fn starpurm_drs_ret_t starpurm_withdraw_cpus_from_starpu(starpurm_drs_desc_t *spd, int ncpus)
 \ingroup API_Interop_Support
-TODO.
+
+Shrink StarPU's default scheduling context to execute tasks on \c ncpus
+less workers.
 
 \fn starpurm_drs_ret_t starpurm_withdraw_cpu_mask_from_starpu(starpurm_drs_desc_t *spd, const hwloc_cpuset_t mask)
 \ingroup API_Interop_Support
-TODO.
+
+Shrink StarPU's default scheduling context so as to not execute tasks on the
+logical units selected in \c mask. Logical units of \c mask for which no
+StarPU worker is initialized are silently ignored.
 
 \fn starpurm_drs_ret_t starpurm_withdraw_all_cpus_from_starpu(starpurm_drs_desc_t *spd)
 \ingroup API_Interop_Support
-TODO.
+Shrink StarPU's default scheduling context so as to remove all logical units.
 
 \fn starpurm_drs_ret_t starpurm_lend(starpurm_drs_desc_t *spd)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_assign_all_cpus_to_starpu.
 
 \fn starpurm_drs_ret_t starpurm_lend_cpu(starpurm_drs_desc_t *spd, int cpuid)
 \ingroup API_Interop_Support
-TODO.
+
+Synonym for \ref starpurm_assign_cpu_to_starpu.
 
 \fn starpurm_drs_ret_t starpurm_lend_cpus(starpurm_drs_desc_t *spd, int ncpus)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_assign_cpus_to_starpu.
 
 \fn starpurm_drs_ret_t starpurm_lend_cpu_mask(starpurm_drs_desc_t *spd, const hwloc_cpuset_t mask)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_assign_cpu_mask_to_starpu.
 
 \fn starpurm_drs_ret_t starpurm_reclaim(starpurm_drs_desc_t *spd)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_withdraw_all_cpus_from_starpu.
 
 \fn starpurm_drs_ret_t starpurm_reclaim_cpu(starpurm_drs_desc_t *spd, int cpuid)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_withdraw_cpu_from_starpu.
 
 \fn starpurm_drs_ret_t starpurm_reclaim_cpus(starpurm_drs_desc_t *spd, int ncpus)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_withdraw_cpus_from_starpu.
 
 \fn starpurm_drs_ret_t starpurm_reclaim_cpu_mask(starpurm_drs_desc_t *spd, const hwloc_cpuset_t mask)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_withdraw_cpu_mask_from_starpu.
 
 \fn starpurm_drs_ret_t starpurm_acquire(starpurm_drs_desc_t *spd)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_withdraw_all_cpus_from_starpu.
 
 \fn starpurm_drs_ret_t starpurm_acquire_cpu(starpurm_drs_desc_t *spd, int cpuid)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_withdraw_cpu_from_starpu.
 
 \fn starpurm_drs_ret_t starpurm_acquire_cpus(starpurm_drs_desc_t *spd, int ncpus)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_withdraw_cpus_from_starpu.
 
 \fn starpurm_drs_ret_t starpurm_acquire_cpu_mask(starpurm_drs_desc_t *spd, const hwloc_cpuset_t mask)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_withdraw_cpu_mask_from_starpu.
 
 \fn starpurm_drs_ret_t starpurm_return_all(starpurm_drs_desc_t *spd)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_assign_all_cpus_to_starpu.
 
 \fn starpurm_drs_ret_t starpurm_return_cpu(starpurm_drs_desc_t *spd, int cpuid)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_assign_cpu_to_starpu.
 
 
 @name Devices
@@ -190,107 +199,126 @@ TODO.
 
 \fn int starpurm_get_device_type_id(const char *type_str)
 \ingroup API_Interop_Support
-TODO.
+Return the device type ID constant associated to the device type name.
+Valid names for \c type_str are:
+- \c "cpu": regular CPU unit;
+- \c "opencl": OpenCL device unit;
+- \c "cuda": nVidia CUDA device unit;
+- \c "mic": Intel KNC type device unit.
 
 \fn const char *starpurm_get_device_type_name(int type_id)
 \ingroup API_Interop_Support
-TODO.
+Return the device type name associated to the device type ID constant.
 
 \fn int starpurm_get_nb_devices_by_type(int type_id)
 \ingroup API_Interop_Support
-TODO.
+Return the number of initialized StarPU worker for the device type \c type_id.
 
 \fn int starpurm_get_device_id(int type_id, int device_rank)
 \ingroup API_Interop_Support
-TODO.
+Return the unique ID assigned to the \c device_rank nth device of type
+\c type_id.
 
 \fn starpurm_drs_ret_t starpurm_assign_device_to_starpu(starpurm_drs_desc_t *spd, int type_id, int unit_rank)
 \ingroup API_Interop_Support
-TODO.
+Extend StarPU's default scheduling context to use \c unit_rank nth
+device of type \c type_id.
 
 \fn starpurm_drs_ret_t starpurm_assign_devices_to_starpu(starpurm_drs_desc_t *spd, int type_id, int ndevices)
 \ingroup API_Interop_Support
-TODO.
+Extend StarPU's default scheduling context to use \c ndevices more
+devices of type \c type_id, up to the number of StarPU workers
+initialized for such device type.
 
 \fn starpurm_drs_ret_t starpurm_assign_device_mask_to_starpu(starpurm_drs_desc_t *spd, const hwloc_cpuset_t mask)
 \ingroup API_Interop_Support
-TODO.
+Extend StarPU's default scheduling context to use additional devices as
+designated by their corresponding StarPU worker thread(s) CPU-set \c mask.
 
 \fn starpurm_drs_ret_t starpurm_assign_all_devices_to_starpu(starpurm_drs_desc_t *spd, int type_id)
 \ingroup API_Interop_Support
-TODO.
+Extend StarPU's default scheduling context to use all devices of type \c
+type_id for which it has a worker thread initialized.
 
 \fn starpurm_drs_ret_t starpurm_withdraw_device_from_starpu(starpurm_drs_desc_t *spd, int type_id, int unit_rank)
 \ingroup API_Interop_Support
-TODO.
+
+Shrink StarPU's default scheduling context to not use \c unit_rank nth
+device of type \c type_id.
 
 \fn starpurm_drs_ret_t starpurm_withdraw_devices_from_starpu(starpurm_drs_desc_t *spd, int type_id, int ndevices)
 \ingroup API_Interop_Support
-TODO.
+
+Shrink StarPU's default scheduling context to use \c ndevices less
+devices of type \c type_id.
 
 \fn starpurm_drs_ret_t starpurm_withdraw_device_mask_from_starpu(starpurm_drs_desc_t *spd, const hwloc_cpuset_t mask)
 \ingroup API_Interop_Support
-TODO.
+
+Shrink StarPU's default scheduling context to not use devices
+designated by their corresponding StarPU worker thread(s) CPU-set \c mask.
 
 \fn starpurm_drs_ret_t starpurm_withdraw_all_devices_from_starpu(starpurm_drs_desc_t *spd, int type_id)
 \ingroup API_Interop_Support
-TODO.
+
+Shrink StarPU's default scheduling context to use no devices of type \c
+type_id.
 
 \fn starpurm_drs_ret_t starpurm_lend_device(starpurm_drs_desc_t *spd, int type_id, int unit_rank)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_assign_device_to_starpu.
 
 \fn starpurm_drs_ret_t starpurm_lend_devices(starpurm_drs_desc_t *spd, int type_id, int ndevices)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_assign_devices_to_starpu.
 
 \fn starpurm_drs_ret_t starpurm_lend_device_mask(starpurm_drs_desc_t *spd, const hwloc_cpuset_t mask)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_assign_device_mask_to_starpu.
 
 \fn starpurm_drs_ret_t starpurm_lend_all_devices(starpurm_drs_desc_t *spd, int type_id)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_assign_all_devices_to_starpu.
 
 \fn starpurm_drs_ret_t starpurm_reclaim_device(starpurm_drs_desc_t *spd, int type_id, int unit_rank)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_withdraw_device_from_starpu.
 
 \fn starpurm_drs_ret_t starpurm_reclaim_devices(starpurm_drs_desc_t *spd, int type_id, int ndevices)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_withdraw_devices_from_starpu.
 
 \fn starpurm_drs_ret_t starpurm_reclaim_device_mask(starpurm_drs_desc_t *spd, const hwloc_cpuset_t mask)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_withdraw_device_mask_from_starpu.
 
 \fn starpurm_drs_ret_t starpurm_reclaim_all_devices(starpurm_drs_desc_t *spd, int type_id)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_withdraw_all_devices_from_starpu.
 
 \fn starpurm_drs_ret_t starpurm_acquire_device(starpurm_drs_desc_t *spd, int type_id, int unit_rank)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_withdraw_device_from_starpu.
 
 \fn starpurm_drs_ret_t starpurm_acquire_devices(starpurm_drs_desc_t *spd, int type_id, int ndevices)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_withdraw_devices_from_starpu.
 
 \fn starpurm_drs_ret_t starpurm_acquire_device_mask(starpurm_drs_desc_t *spd, const hwloc_cpuset_t mask)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_withdraw_device_mask_from_starpu.
 
 \fn starpurm_drs_ret_t starpurm_acquire_all_devices(starpurm_drs_desc_t *spd, int type_id)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_withdraw_all_devices_from_starpu.
 
 \fn starpurm_drs_ret_t starpurm_return_all_devices(starpurm_drs_desc_t *spd, int type_id)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_assign_all_devices_to_starpu.
 
 \fn starpurm_drs_ret_t starpurm_return_device(starpurm_drs_desc_t *spd, int type_id, int unit_rank)
 \ingroup API_Interop_Support
-TODO.
+Synonym for \ref starpurm_assign_device_to_starpu.
 
 
 @name CpusetsQueries
@@ -298,26 +326,33 @@ TODO.
 
 \fn hwloc_cpuset_t starpurm_get_device_worker_cpuset(int type_id, int unit_rank)
 \ingroup API_Interop_Support
-TODO.
+Return the CPU-set of the StarPU worker associated to the \c unit_rank
+nth unit of type \c type_id.
 
 \fn hwloc_cpuset_t starpurm_get_global_cpuset(void)
 \ingroup API_Interop_Support
-TODO.
+Return the cumulated CPU-set of all StarPU worker threads.
 
 \fn hwloc_cpuset_t starpurm_get_selected_cpuset(void)
 \ingroup API_Interop_Support
-TODO.
+
+Return the CPU-set of the StarPU worker threads currently selected in
+the default StarPU's scheduling context.
 
 \fn hwloc_cpuset_t starpurm_get_all_cpu_workers_cpuset(void)
 \ingroup API_Interop_Support
-TODO.
+
+Return the cumulated CPU-set of all CPU StarPU worker threads.
 
 \fn hwloc_cpuset_t starpurm_get_all_device_workers_cpuset(void)
 \ingroup API_Interop_Support
-TODO.
+
+Return the cumulated CPU-set of all "non-CPU" StarPU worker threads.
 
 \fn hwloc_cpuset_t starpurm_get_all_device_workers_cpuset_by_type(int typeid)
 \ingroup API_Interop_Support
-TODO.
+
+Return the cumulated CPU-set of all StarPU worker threads for devices of
+type \c typeid.
 
 */