add mpi and starpurm files to internal documentation

doc/doxygen_dev/dev/starpu_check_missing.sh

@@ -0,0 +1,65 @@
+#!/bin/bash
+# StarPU --- Runtime system for heterogeneous multicore architectures.
+#
+# Copyright (C) 2020       Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria
+#
+# StarPU is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; either version 2.1 of the License, or (at
+# your option) any later version.
+#
+# StarPU is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+#
+# See the GNU Lesser General Public License in COPYING.LGPL for more details.
+#
+
+stcolor=$(tput sgr0)
+redcolor=$(tput setaf 1)
+greencolor=$(tput setaf 2)
+
+dirname=$(realpath $(dirname $0))
+
+ok()
+{
+    type=$1
+    name=$2
+    echo "$type ${greencolor}${name}${stcolor} is in doxygen-config.cfg.in"
+}
+
+ko()
+{
+    type=$1
+    name=$2
+    #echo "$type ${redcolor}${name}${stcolor} is missing from doxygen-config.cfg.in"
+    echo $name
+}
+
+for d in src mpi/src starpurm/src
+do
+    cd $dirname/../../../$d
+    for f in $(find -name "*.h")
+    do
+	ff=$(echo $f | cut -b3-)
+	x=$(grep -c $ff $dirname/../doxygen-config.cfg.in)
+	if test "$x" == "0"
+	then
+	    ko file $d/$ff
+	#else
+	#    ok file $d/$ff
+	fi
+    done
+done
+
+cd $dirname/../../../build/doc/doxygen_dev/latex
+for f in $(find -name "*8h.tex")
+do
+    ff=$(basename $(echo $f | cut -b3-) ".tex")
+    x=$(grep -c $ff refman.tex)
+    if test "$x" == "0"
+    then
+	ko file $ff
+    fi
+done
+

doc/doxygen_dev/doxygen-config.cfg.in

@@ -99,7 +99,32 @@ INPUT                  = @top_srcdir@/doc/doxygen_dev/chapters         \
 			 @top_srcdir@/src/core/errorcheck.h \
 			 @top_srcdir@/src/core/progress_hook.h \
 			 @top_srcdir@/src/core/drivers.h \
-			 @top_srcdir@/src/core/workers.h
+			 @top_srcdir@/src/core/workers.h \
+			 @top_srcdir@/mpi/src/starpu_mpi_init.h \
+			 @top_srcdir@/mpi/src/starpu_mpi_datatype.h \
+			 @top_srcdir@/mpi/src/starpu_mpi_task_insert.h \
+			 @top_srcdir@/mpi/src/starpu_mpi_select_node.h \
+			 @top_srcdir@/mpi/src/starpu_mpi_fxt.h \
+			 @top_srcdir@/mpi/src/starpu_mpi_cache.h \
+			 @top_srcdir@/mpi/src/mpi/starpu_mpi_mpi_backend.h \
+			 @top_srcdir@/mpi/src/mpi/starpu_mpi_driver.h \
+			 @top_srcdir@/mpi/src/mpi/starpu_mpi_early_data.h \
+			 @top_srcdir@/mpi/src/mpi/starpu_mpi_comm.h \
+			 @top_srcdir@/mpi/src/mpi/starpu_mpi_tag.h \
+			 @top_srcdir@/mpi/src/mpi/starpu_mpi_mpi.h \
+			 @top_srcdir@/mpi/src/mpi/starpu_mpi_early_request.h \
+			 @top_srcdir@/mpi/src/mpi/starpu_mpi_sync_data.h \
+			 @top_srcdir@/mpi/src/load_balancer/policy/load_data_interface.h \
+			 @top_srcdir@/mpi/src/load_balancer/policy/load_balancer_policy.h \
+			 @top_srcdir@/mpi/src/load_balancer/policy/data_movements_interface.h \
+			 @top_srcdir@/mpi/src/nmad/starpu_mpi_nmad_unknown_datatype.h \
+			 @top_srcdir@/mpi/src/nmad/starpu_mpi_nmad_backend.h \
+			 @top_srcdir@/mpi/src/nmad/starpu_mpi_nmad.h \
+			 @top_srcdir@/mpi/src/starpu_mpi_stats.h \
+			 @top_srcdir@/mpi/src/starpu_mpi_private.h \
+			 @top_srcdir@/mpi/src/starpu_mpi_cache_stats.h \
+			 @top_srcdir@/starpurm/src/starpurm_private.h
+
 
 EXAMPLE_PATH           = @top_srcdir@/doc/doxygen_dev \
 		       	 @top_srcdir@/doc/doxygen/chapters

doc/doxygen_dev/doxygen.cfg

@@ -1621,6 +1621,8 @@ PREDEFINED             = STARPU_USE_OPENCL=1 \
 			 STARPU_USE_SC_HYPERVISOR=1 \
 			 STARPU_SIMGRID=1 \
 			 STARPU_OPENMP=1 \
+			 STARPU_USE_MPI_MPI=1 \
+			 STARPU_USE_MPI_NMAD=1 \
                          __GCC__
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then

doc/doxygen_dev/refman.tex

@@ -76,7 +76,7 @@ Documentation License”.
 \chapter{File Index}
 \input{files}
 
-\chapter{File Documentation}
+\chapter{StarPU File Documentation}
 \input{barrier_8h}
 \input{barrier__counter_8h}
 \input{bound_8h}
@@ -158,6 +158,35 @@ Documentation License”.
 \input{timing_8h}
 \input{topology_8h}
 \input{utils_8h}
+\input{uthash_8h}
 \input{write__back_8h}
 
+\chapter{StarPU MPI File Documentation}
+\input{starpu__mpi__cache_8h}
+\input{starpu__mpi__driver_8h}
+\input{starpu__mpi__init_8h}
+\input{starpu__mpi__nmad__backend_8h}
+\input{starpu__mpi__stats_8h}
+\input{starpu__mpi__cache__stats_8h}
+\input{starpu__mpi__early__data_8h}
+\input{starpu__mpi__mpi_8h}
+\input{starpu__mpi__nmad__unknown__datatype_8h}
+\input{starpu__mpi__sync__data_8h}
+\input{starpu__mpi__comm_8h}
+\input{starpu__mpi__early__request_8h}
+\input{starpu__mpi__mpi__backend_8h}
+\input{starpu__mpi__private_8h}
+\input{starpu__mpi__tag_8h}
+\input{starpu__mpi__datatype_8h}
+\input{starpu__mpi__fxt_8h}
+\input{starpu__mpi__nmad_8h}
+\input{starpu__mpi__select__node_8h}
+\input{starpu__mpi__task__insert_8h}
+\input{load__balancer__policy_8h}
+\input{load__data__interface_8h}
+\input{data__movements__interface_8h}
+
+\chapter{StarPU Resource Manager File Documentation}
+\input{starpurm__private_8h}
+
 \end{document}

mpi/src/load_balancer/policy/data_movements_interface.h

@@ -16,6 +16,8 @@
 
 #include <starpu.h>
 
+/** @file */
+
 #ifndef __DATA_MOVEMENTS_INTERFACE_H
 #define __DATA_MOVEMENTS_INTERFACE_H
 

mpi/src/load_balancer/policy/load_balancer_policy.h

@@ -19,6 +19,8 @@
 
 #include <starpu_mpi_lb.h>
 
+/** @file */
+
 #ifdef __cplusplus
 extern "C"
 {

mpi/src/load_balancer/policy/load_data_interface.h

@@ -16,6 +16,8 @@
 
 #include <starpu.h>
 
+/** @file */
+
 #ifndef __LOAD_DATA_INTERFACE_H
 #define __LOAD_DATA_INTERFACE_H
 

mpi/src/mpi/starpu_mpi_comm.h

@@ -25,6 +25,8 @@
 
 #include <mpi/starpu_mpi_mpi_backend.h>
 
+/** @file */
+
 #ifdef __cplusplus
 extern "C"
 {

mpi/src/mpi/starpu_mpi_driver.h

@@ -19,6 +19,8 @@
 
 #include <starpu.h>
 
+/** @file */
+
 #ifdef STARPU_USE_MPI_MPI
 
 #ifdef __cplusplus

mpi/src/mpi/starpu_mpi_early_data.h

@@ -25,6 +25,8 @@
 #include <common/uthash.h>
 #include <starpu_mpi_private.h>
 
+/** @file */
+
 #ifdef STARPU_USE_MPI_MPI
 
 #ifdef __cplusplus

mpi/src/mpi/starpu_mpi_early_request.h

@@ -23,6 +23,8 @@
 #include <common/config.h>
 #include <common/list.h>
 
+/** @file */
+
 #ifdef STARPU_USE_MPI_MPI
 
 #ifdef __cplusplus

mpi/src/mpi/starpu_mpi_mpi.h

@@ -23,6 +23,8 @@
 #include <common/config.h>
 #include <common/list.h>
 
+/** @file */
+
 #ifdef STARPU_USE_MPI_MPI
 
 #ifdef __cplusplus

mpi/src/mpi/starpu_mpi_mpi_backend.h

@@ -20,6 +20,8 @@
 #include <common/config.h>
 #include <common/uthash.h>
 
+/** @file */
+
 #ifdef __cplusplus
 extern "C"
 {

mpi/src/mpi/starpu_mpi_sync_data.h

@@ -23,6 +23,8 @@
 #include <common/config.h>
 #include <common/list.h>
 
+/** @file */
+
 #ifdef STARPU_USE_MPI_MPI
 
 #ifdef __cplusplus

mpi/src/mpi/starpu_mpi_tag.h

@@ -21,6 +21,8 @@
 #include <stdlib.h>
 #include <mpi.h>
 
+/** @file */
+
 #ifdef STARPU_USE_MPI_MPI
 
 #ifdef __cplusplus

mpi/src/nmad/starpu_mpi_nmad.h

@@ -23,6 +23,8 @@
 #include <common/config.h>
 #include <common/list.h>
 
+/** @file */
+
 #ifdef STARPU_USE_MPI_NMAD
 
 #ifdef __cplusplus

mpi/src/nmad/starpu_mpi_nmad_backend.h

@@ -19,6 +19,8 @@
 
 #include <common/config.h>
 
+/** @file */
+
 #ifdef __cplusplus
 extern "C"
 {

mpi/src/nmad/starpu_mpi_nmad_unknown_datatype.h

@@ -19,6 +19,8 @@
 
 #include <common/config.h>
 
+/** @file */
+
 #ifdef __cplusplus
 extern "C"
 {

mpi/src/starpu_mpi_cache.h

@@ -21,6 +21,8 @@
 #include <stdlib.h>
 #include <mpi.h>
 
+/** @file */
+
 #ifdef __cplusplus
 extern "C"
 {

mpi/src/starpu_mpi_cache_stats.h

@@ -21,6 +21,8 @@
 #include <stdlib.h>
 #include <mpi.h>
 
+/** @file */
+
 #ifdef __cplusplus
 extern "C"
 {

mpi/src/starpu_mpi_datatype.h

@@ -20,6 +20,8 @@
 #include <starpu_mpi.h>
 #include <starpu_mpi_private.h>
 
+/** @file */
+
 #ifdef __cplusplus
 extern "C"
 {

mpi/src/starpu_mpi_fxt.h

@@ -22,6 +22,8 @@
 #include <common/config.h>
 #include <common/fxt.h>
 
+/** @file */
+
 #ifdef __cplusplus
 extern "C"
 {

mpi/src/starpu_mpi_init.h

@@ -20,6 +20,8 @@
 #include <starpu.h>
 #include <starpu_mpi.h>
 
+/** @file */
+
 #ifdef __cplusplus
 extern "C"
 {

mpi/src/starpu_mpi_private.h

@@ -27,6 +27,8 @@
 #include <common/starpu_spinlock.h>
 #include <core/simgrid.h>
 
+/** @file */
+
 #ifdef __cplusplus
 extern "C"
 {

mpi/src/starpu_mpi_select_node.h

@@ -19,6 +19,8 @@
 
 #include <mpi.h>
 
+/** @file */
+
 #ifdef __cplusplus
 extern "C"
 {

mpi/src/starpu_mpi_stats.h

@@ -21,6 +21,8 @@
 #include <stdlib.h>
 #include <mpi.h>
 
+/** @file */
+
 #ifdef __cplusplus
 extern "C"
 {

mpi/src/starpu_mpi_task_insert.h

@@ -17,6 +17,8 @@
 #ifndef __STARPU_MPI_TASK_INSERT_H__
 #define __STARPU_MPI_TASK_INSERT_H__
 
+/** @file */
+
 #ifdef __cplusplus
 extern "C"
 {

src/common/list.h

@@ -18,6 +18,8 @@
 #ifndef __LIST_H__
 #define __LIST_H__
 
+/** @file */
+
 #include <starpu_util.h>
 
 /** @remarks list how-to

src/common/uthash.h

@@ -24,6 +24,8 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #ifndef UTHASH_H
 #define UTHASH_H 
 
+/** @file */
+
 #include <string.h>   /* memcmp,strlen */
 #include <stddef.h>   /* ptrdiff_t */
 

starpurm/src/starpurm_private.h

@@ -17,7 +17,10 @@
 #ifndef __STARPURM_PRIVATE_H
 #define __STARPURM_PRIVATE_H
 
-enum e_state {
+/** @file */
+
+enum e_state
+{
 	state_uninitialized = 0,
 	state_init
 };