Clean up and add additional comments

Signed-off-by: Jake Tronge <jtronge@lanl.gov>

Author: jtronge

.gitignore

@@ -230,8 +230,6 @@ ompi/mpi/fortran/use-mpi-f08/mod/mpi-f08-constants.h
 ompi/mpi/fortran/use-mpi-f08/mod/mpi-f08-interfaces.h
 ompi/mpi/fortran/use-mpi-f08/sizeof_f08.f90
 ompi/mpi/fortran/use-mpi-f08/sizeof_f08.h
-ompi/mpi/fortran/use-mpi-f08/profile/psizeof_f08.f90
-ompi/mpi/fortran/use-mpi-f08/profile/*.F90
 
 ompi/mpi/fortran/use-mpi-ignore-tkr/mpi-ignore-tkr-interfaces.h
 ompi/mpi/fortran/use-mpi-ignore-tkr/mpi-ignore-tkr-file-interfaces.h
@@ -549,7 +547,7 @@ docs/man
 ompi/mpi/bindings/ompi_bindings/compiler.py
 
 # Generated C Bindings
-ompi/mpi/c/ompi_*.c
+ompi/mpi/c/generated_*.c
 
 # Generated Fortran Bindings
 ompi/mpi/fortran/use-mpi-f08/*_generated.F90

ompi/Makefile.am

@@ -157,6 +157,16 @@ include_HEADERS =
 dist_ompidata_DATA =
 lib@OMPI_LIBMPI_NAME@_la_SOURCES += $(headers)
 
+# Python binding files
+EXTRA_DIST = \
+        mpi/bindings/bindings.py \
+        mpi/bindings/ompi_bindings/consts.py \
+        mpi/bindings/ompi_bindings/c.py \
+        mpi/bindings/ompi_bindings/c_type.py \
+        mpi/bindings/ompi_bindings/fortran.py \
+        mpi/bindings/ompi_bindings/fortran_type.py \
+        mpi/bindings/ompi_bindings/util.py
+
 # Conditionally install the header files
 
 if WANT_INSTALL_HEADERS

ompi/include/mpi.h.in

@@ -1389,7 +1389,6 @@ OMPI_DECLSPEC extern struct ompi_predefined_datatype_t ompi_mpi_ub;
 /*
  * MPI API
  */
-#ifndef OMPI_NO_MPI_PROTOTYPES
 OMPI_DECLSPEC  int MPI_Abort(MPI_Comm comm, int errorcode);
 OMPI_DECLSPEC  int MPI_Accumulate(const void *origin_addr, int origin_count, MPI_Datatype origin_datatype,
                                   int target_rank, MPI_Aint target_disp, int target_count,
@@ -3211,8 +3210,6 @@ OMPI_DECLSPEC  int PMPI_Type_ub(MPI_Datatype mtype, MPI_Aint *ub)
 #define MPI_Type_ub(...)  THIS_FUNCTION_WAS_REMOVED_IN_MPI30(MPI_Type_ub, MPI_Type_get_extent)
 #endif
 
-#endif /* OMPI_NO_MPI_PROTOTYPES */
-
 #if defined(c_plusplus) || defined(__cplusplus)
 }
 #endif

ompi/mpi/bindings/bindings.py

@@ -6,6 +6,11 @@
 # Additional copyrights may follow
 #
 # $HEADER$
+"""Main binding generation script.
+
+This script is used for generating the bindings for both C and Fortran. See the
+scripts in 'ompi_bindings/' for the bulk of the code.
+"""
 import argparse
 import os
 import sys
@@ -35,18 +40,18 @@ def main():
     parser_code.set_defaults(handler=lambda args, out: fortran.generate_code(args, out))
     # Handler for generating the Fortran interface files
     parser_interface = subparsers_fortran.add_parser('interface',
-                                                     help='generate Fortran interface specifcations')
+                                                     help='generate Fortran interface specifications')
     parser_interface.set_defaults(handler=lambda args, out: fortran.generate_interface(args, out))
 
     # C set up code
     parser_c = subparsers.add_parser('c', help='subcommand for generating C code')
     subparsers_c = parser_c.add_subparsers()
-    parser_header = subparsers_c.add_parser('header')
+    parser_header = subparsers_c.add_parser('header', help='generate header file from template files')
     parser_header.add_argument('file', nargs='+', help='list of template source files')
     parser_header.add_argument('--external', action='store_true', help='generate external mpi.h header file')
     parser_header.add_argument('--srcdir', help='source directory')
     parser_header.set_defaults(handler=lambda args, out: c.generate_header(args, out))
-    parser_gen = subparsers_c.add_parser('source')
+    parser_gen = subparsers_c.add_parser('source', help='generate source file from template file')
     # parser = argparse.ArgumentParser(description='C ABI binding generation code')
     parser_gen.add_argument('type', choices=('ompi', 'standard'),
                             help='generate the OMPI ABI functions or the standard ABI functions')

ompi/mpi/bindings/ompi_bindings/c.py

@@ -8,7 +8,11 @@
 # $HEADERS$
 #
 #
-"""MPI Standard ABI Generation.
+"""MPI C Binding Code.
+
+This file is used for generating C bindings, as well as bigcount interfaces,
+from individual *.c.in template files. This also currently includes unused ABI
+code, in preparation for the standard ABI.
 
 TEMPLATE SOURCE FILE ASSUMPTIONS:
 * Only one function per file

ompi/mpi/bindings/ompi_bindings/compiler.py.in

@@ -6,6 +6,7 @@
 # Additional copyrights may follow
 #
 # $HEADER$
+"""Compiler constants/capabilities discovered by configure."""
 
 # Check if we have support for TS 29113 (templated at configure time)
 HAVE_TS = '@OMPI_FORTRAN_HAVE_TS@' == '1'

ompi/mpi/bindings/ompi_bindings/consts.py

@@ -7,6 +7,7 @@
 #
 # $HEADER$
 #
+"""Constants used for generating bindings."""
 import re
 
 FORTRAN_ERROR_NAME = 'ierror'

ompi/mpi/bindings/ompi_bindings/fortran_type.py

@@ -7,7 +7,12 @@
 #
 # $HEADER$
 #
-"""Fortran type base class."""
+"""Fortran types and corresponding template code.
+
+All types used in the Fortran bindings are defined here as classes that derive
+from the FortranType base class. These are used for generating both Fortran and
+supporting C code for the mpi_f08 bindings.
+"""
 from abc import ABC, abstractmethod
 from ompi_bindings import compiler, consts, util
 

ompi/mpi/c/Makefile.am

@@ -41,6 +41,9 @@ endif
 
 headers = bindings.h
 
+#
+# Template/prototype source files used for generating MPI functions
+#
 prototype_sources = \
         abort.c.in \
         alltoallv.c.in \
@@ -88,10 +91,11 @@ ompi_HEADERS = $(headers)
 endif
 
 #
-# List of all C files that have profile versions
+# List of all C files that have profile versions (generated_*.c files were
+# generated from prototype_sources above).
 #
 interface_profile_sources = \
-        ompi_abort.c \
+        generated_abort.c \
         add_error_class.c \
         add_error_code.c \
         add_error_string.c \
@@ -102,22 +106,22 @@ interface_profile_sources = \
         iallgatherv.c \
         allgatherv_init.c \
         alloc_mem.c \
-        ompi_allreduce.c \
+        generated_allreduce.c \
         iallreduce.c \
         allreduce_init.c \
         alltoall.c \
         ialltoall.c \
         alltoall_init.c \
-        ompi_alltoallv.c \
+        generated_alltoallv.c \
         ialltoallv.c \
         alltoallv_init.c \
-        ompi_alltoallw.c \
+        generated_alltoallw.c \
         ialltoallw.c \
         alltoallw_init.c \
         attr_delete.c \
         attr_get.c \
         attr_put.c \
-        ompi_barrier.c \
+        generated_barrier.c \
         ibarrier.c \
         barrier_init.c \
         bcast.c \
@@ -153,8 +157,8 @@ interface_profile_sources = \
         comm_dup_with_info.c \
         comm_idup.c \
         comm_idup_with_info.c \
-        ompi_comm_f2c.c \
-        ompi_comm_free.c \
+        generated_comm_f2c.c \
+        generated_comm_free.c \
         comm_free_keyval.c \
         comm_get_attr.c \
         comm_get_errhandler.c \
@@ -163,7 +167,7 @@ interface_profile_sources = \
         comm_get_parent.c \
         comm_group.c \
         comm_join.c \
-        ompi_comm_rank.c \
+        generated_comm_rank.c \
         comm_remote_group.c \
         comm_remote_size.c \
         comm_set_attr.c \
@@ -174,11 +178,11 @@ interface_profile_sources = \
         dist_graph_neighbors_count.c \
         comm_set_errhandler.c \
         comm_set_name.c \
-        ompi_comm_size.c \
+        generated_comm_size.c \
         comm_spawn.c \
         comm_spawn_multiple.c \
-        ompi_comm_split.c \
-        ompi_comm_split_type.c \
+        generated_comm_split.c \
+        generated_comm_split_type.c \
         comm_test_inter.c \
         compare_and_swap.c \
         dims_create.c \
@@ -218,7 +222,7 @@ interface_profile_sources = \
         file_iwrite.c \
         file_iwrite_all.c \
         file_iwrite_shared.c \
-        ompi_file_open.c \
+        generated_file_open.c \
         file_preallocate.c \
         file_read_all_begin.c \
         file_read_all.c \
@@ -252,8 +256,8 @@ interface_profile_sources = \
         file_write_ordered.c \
         file_write_ordered_end.c \
         file_write_shared.c \
-        ompi_finalize.c \
-        ompi_finalized.c \
+        generated_finalize.c \
+        generated_finalized.c \
         free_mem.c \
         gather.c \
         igather.c \
@@ -266,8 +270,8 @@ interface_profile_sources = \
         get_elements.c \
         get_elements_x.c \
         get_accumulate.c \
-        ompi_get_library_version.c \
-        ompi_get_processor_name.c \
+        generated_get_library_version.c \
+        generated_get_processor_name.c \
         get_version.c \
         graph_create.c \
         graph_get.c \
@@ -308,17 +312,17 @@ interface_profile_sources = \
         info_get_string.c \
         info_get_valuelen.c \
         info_set.c \
-        ompi_init.c \
+        generated_init.c \
         init_thread.c \
-        ompi_initialized.c \
+        generated_initialized.c \
         intercomm_create.c \
         intercomm_create_from_groups.c \
         intercomm_merge.c \
         iprobe.c \
-        ompi_irecv.c \
+        generated_irecv.c \
         irsend.c \
         is_thread_main.c \
-        ompi_isend.c \
+        generated_isend.c \
         isendrecv.c \
         isendrecv_replace.c \
         issend.c \
@@ -366,7 +370,7 @@ interface_profile_sources = \
         query_thread.c \
         raccumulate.c \
         recv_init.c \
-        ompi_recv.c \
+        generated_recv.c \
         reduce.c \
         ireduce.c \
         reduce_init.c \
@@ -470,12 +474,12 @@ interface_profile_sources = \
         unpack.c \
         unpublish_name.c \
         wait.c \
-        ompi_waitall.c \
+        generated_waitall.c \
         waitany.c \
-        ompi_waitsome.c \
-        ompi_wtime.c \
+        generated_waitsome.c \
+        generated_wtime.c \
         wtick.c \
-        ompi_accumulate.c \
+        generated_accumulate.c \
         get.c \
         put.c \
         win_allocate.c \
@@ -516,7 +520,7 @@ interface_profile_sources = \
         win_test.c \
         win_unlock.c \
         win_unlock_all.c \
-        ompi_send.c \
+        generated_send.c \
         win_wait.c
 
 # The following functions were removed from the MPI standard, but are
@@ -543,7 +547,7 @@ libmpi_c_noprofile_la_CPPFLAGS = -DOMPI_BUILD_MPI_PROFILING=0
 
 # ABI generation rules
 if OMPI_GENERATE_BINDINGS
-ompi_%.c: %.c.in
+generated_%.c: %.c.in
 	$(PYTHON) $(top_srcdir)/ompi/mpi/bindings/bindings.py \
 	    --builddir $(abs_top_builddir) \
 	    --srcdir $(abs_top_srcdir) \
@@ -553,6 +557,6 @@ ompi_%.c: %.c.in
 	    ompi \
 	    $<
 
-distclean-local:
-	-rm -rf ompi_*.c
+# Delete generated files on maintainer-clean
+MAINTAINERCLEANFILES = generated_*.c
 endif

ompi/mpi/fortran/use-mpi-f08/Makefile.am

@@ -500,18 +500,10 @@ mpi_api_files = \
         win_wait_f08.F90 \
         api_f08_generated.F90
 
-# JMS Somehow this variable substitution isn't quite working, and I
-# don't have time to figure it out.  So just wholesale copy the file
-# list.  :-(
-#pmpi_api_files = $(mpi_api_files:%=p%)
-
 lib@OMPI_LIBMPI_NAME@_usempif08_la_SOURCES = \
         $(mpi_api_files) \
         mpi-f08.F90
 
-# These are generated; do not ship them
-# nodist_lib@OMPI_LIBMPI_NAME@_usempif08_la_SOURCES =
-
 if BUILD_FORTRAN_SIZEOF
 SIZEOF_H = sizeof_f08.h
 lib@OMPI_LIBMPI_NAME@_usempif08_la_SOURCES += \
@@ -539,9 +531,10 @@ lib@OMPI_LIBMPI_NAME@_usempif08_la_LIBADD = \
         $(top_builddir)/ompi/lib@OMPI_LIBMPI_NAME@.la \
         mod/libusempif08_internal_modules.la \
         base/libusempif08_ccode.la
+
 #
-# I'm not sure why, but the profile library is not getting built before this
-# library even when listed in LIBADD, so adding it here as a dependency.
+# Make sure to build the profile library before this library, since adding it
+# to LIBADD doesn't enforce any ordering
 #
 lib@OMPI_LIBMPI_NAME@_usempif08_la_DEPENDENCIES = \
         $(module_sentinel_files) \
@@ -574,17 +567,13 @@ lib@OMPI_LIBMPI_NAME@_usempif08_profile_la_FCFLAGS = \
 
 # Include script and template files for ABI generation from a distribution
 # tarball
-EXTRA_DIST = \
-        generate_bindings.py \
-        interface.in
+EXTRA_DIST = interface.in
 
 #
 # Generate the Fortran bindings and C wrapper functions for bindings with a
 # *.in template.
 #
 
-DISTCLEANFILES = api_f08_generated.F90
-
 if OMPI_GENERATE_BINDINGS
 api_f08_generated.F90: interface.in
 	$(PYTHON) $(top_srcdir)/ompi/mpi/bindings/bindings.py \
@@ -595,6 +584,9 @@ api_f08_generated.F90: interface.in
 	    --template $(abs_srcdir)/$< \
 	    code \
 	    fortran
+
+# Delete generated file on maintainer-clean
+MAINTAINERCLEANFILES = api_f08_generated.F90
 endif
 
 ###########################################################################