mpi.h.in: delete removed MPI1 functions/datatypes (API change!)

This commit DELETES the removed MPI1 functions and datatypes from
both the mpi.h header and from the library (they were deleted from the
MPI standard in MPI-3.0).

WARNING: This changes the MPI API in a non-backwards compatible way.
         This also removes the configure option that was added in Open
         MPI v4.0.x, requiring users to change their apps if they are
         using any of these almost 20 year old APIs.

This commit removes the following MPI1 removed functions and datatypes:

         MPI_Address
         MPI_Errhandler_create
         MPI_Errhandler_get
         MPI_Errhandler_set
         MPI_Type_extent
         MPI_Type_hindexed
         MPI_Type_hvector
         MPI_Type_struct
         MPI_Type_UB
         MPI_Type_LB

Signed-off-by: Geoffrey Paulsen <[email protected]>

Author: gpaulsen

config/ompi_config_files.m4

@@ -36,7 +36,6 @@ AC_DEFUN([OMPI_CONFIG_FILES],[
         ompi/mpi/fortran/use-mpi-ignore-tkr/Makefile
         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
-        ompi/mpi/fortran/use-mpi-ignore-tkr/mpi-ignore-tkr-removed-interfaces.h
         ompi/mpi/fortran/use-mpi-f08/Makefile
         ompi/mpi/fortran/use-mpi-f08/bindings/Makefile
         ompi/mpi/fortran/use-mpi-f08/mod/Makefile

ompi/datatype/ompi_datatype_args.c

@@ -841,25 +841,19 @@ ompi_datatype_t* ompi_datatype_get_single_predefined_type_from_args( ompi_dataty
                 return NULL;
             }
         }
-#if OMPI_ENABLE_MPI1_COMPAT
-        if (current_predef != MPI_LB && current_predef != MPI_UB) {
-#endif
-            if( NULL == predef ) {  /* This is the first iteration */
-                predef = current_predef;
-            } else {
-                /**
-                 *  What exactly should we consider as identical types?
-                 *  If they are the same MPI level type, or if they map
-                 *  to the same OPAL datatype? In other words, MPI_FLOAT
-                 *  and MPI_REAL4 are they identical?
-                 */
-                if( predef != current_predef ) {
-                    return NULL;
-                }
+        if( NULL == predef ) {  /* This is the first iteration */
+            predef = current_predef;
+        } else {
+            /**
+             *  What exactly should we consider as identical types?
+             *  If they are the same MPI level type, or if they map
+             *  to the same OPAL datatype? In other words, MPI_FLOAT
+             *  and MPI_REAL4 are they identical?
+             */
+            if( predef != current_predef ) {
+                return NULL;
             }
-#if OMPI_ENABLE_MPI1_COMPAT
         }
-#endif
     }
     return predef;
 }

ompi/include/mpi.h.in

@@ -137,9 +137,6 @@
 /* Whether we have FORTRAN REAL*8 or not */
 #undef OMPI_HAVE_FORTRAN_REAL8
 
-/* Whether in include MPI-1 compatibility */
-#undef OMPI_ENABLE_MPI1_COMPAT
-
 /* Whether we have float _Complex  or not */
 #undef HAVE_FLOAT__COMPLEX
 
@@ -280,50 +277,6 @@
 #                    define __mpi_interface_deprecated__(msg) __attribute__((__deprecated__))
 #                endif
 #            endif
-#        endif
-
-         /* For MPI removed APIs, there is no generally portable way to cause
-          * the C compiler to error with a nice message, on the _usage_ of
-          * one of these symbols.  We've gone with tiered appraoch:
-          *
-          * If the user configured with --enable-mpi1-compatibility,
-          * just emit a compiletime warning (via the deprecation function
-          * attribute) that they're using an MPI1 removed function.
-          *
-          * Otherwise, we'd like to issue a fatal error directing the user
-          * that they've used an MPI1 removed function.  If the user's
-          * compiler supports C11 _Static_assert feature, we #define
-          * the MPI routines to instead be a call to _Static_assert
-          * with an appropreate message suggesting the new MPI3 equivalent.
-          *
-          * Otherwise, if the user's compiler supports the error function
-          * attribute, define the MPI routines with that error attribute.
-          * This is supported by most modern GNU compilers.
-          *
-          * Finally if the compiler doesn't support any of those, just
-          * Don't declare those MPI routines at all in mpi.h
-          *
-          * Don't do MACRO magic for building Profiling library as it
-          * interferes with the above.
-          */
-#        if (OMPI_ENABLE_MPI1_COMPAT || OMPI_BUILDING)
-#            define OMPI_OMIT_MPI1_COMPAT_DECLS 0
-#            define OMPI_REMOVED_USE_STATIC_ASSERT 0
-#            define __mpi_interface_removed__(func, newfunc) __mpi_interface_deprecated__(#func " was removed in MPI-3.0.  Use " #newfunc " instead.  continuing...")
-#        elif (__STDC_VERSION__ >= 201112L)
-#            define OMPI_OMIT_MPI1_COMPAT_DECLS 1
-#            define OMPI_REMOVED_USE_STATIC_ASSERT 1
-// This macro definition may show up in compiler output.  So we both
-// outdent it back to column 0 and give it a user-friendly name to
-// help users grok what we are trying to tell them here.
-#define THIS_SYMBOL_WAS_REMOVED_IN_MPI30(func, newfunc) _Static_assert(0, #func " was removed in MPI-3.0.  Use " #newfunc " instead.")
-#        elif OPAL_HAVE_ATTRIBUTE_ERROR
-#            define OMPI_OMIT_MPI1_COMPAT_DECLS 0
-#            define OMPI_REMOVED_USE_STATIC_ASSERT 0
-#            define __mpi_interface_removed__(func, newfunc) __attribute__((__error__(#func " was removed in MPI-3.0.  Use " #newfunc " instead.")))
-#        else
-#            define OMPI_OMIT_MPI1_COMPAT_DECLS 1
-#            define OMPI_REMOVED_USE_STATIC_ASSERT 0
 #        endif
 #    endif
 #endif
@@ -337,22 +290,6 @@
 #    define __mpi_interface_deprecated__(msg)
 #endif
 
-#if !defined(__mpi_interface_removed__)
-#    define __mpi_interface_removed__(A,B)
-#endif
-
-#if !defined(THIS_SYMBOL_WAS_REMOVED_IN_MPI30)
-#    define THIS_SYMBOL_WAS_REMOVED_IN_MPI30(func, newfunc)
-#endif
-
-#if !defined(OMPI_REMOVED_USE_STATIC_ASSERT)
-#    define OMPI_REMOVED_USE_STATIC_ASSERT 0
-#endif
-
-#if !defined(OMPI_OMIT_MPI1_COMPAT_DECLS)
-#    define OMPI_OMIT_MPI1_COMPAT_DECLS !OMPI_ENABLE_MPI1_COMPAT
-#endif
-
 /*
  * To accomodate programs written for MPI implementations that use a
  * straight ROMIO import
@@ -1053,33 +990,6 @@ OMPI_DECLSPEC extern struct ompi_predefined_info_t ompi_mpi_info_env;
 OMPI_DECLSPEC extern MPI_Fint *MPI_F_STATUS_IGNORE;
 OMPI_DECLSPEC extern MPI_Fint *MPI_F_STATUSES_IGNORE;
 
-/*
- * Removed datatypes.  These datatypes are only available if Open MPI
- * was configured with --enable-mpi1-compatibility.
- *
- * These datatypes were formally removed from the MPI specification
- * and should no longer be used in MPI applications.
- */
-#if (OMPI_ENABLE_MPI1_COMPAT || OMPI_BUILDING)
-#    define MPI_UB OMPI_PREDEFINED_GLOBAL(MPI_Datatype, ompi_mpi_ub)
-#    define MPI_LB OMPI_PREDEFINED_GLOBAL(MPI_Datatype, ompi_mpi_lb)
-
-OMPI_DECLSPEC extern struct ompi_predefined_datatype_t ompi_mpi_lb;
-OMPI_DECLSPEC extern struct ompi_predefined_datatype_t ompi_mpi_ub;
-
-#else
-/* If not building or configured --enable-mpi1-compatibility, then
- * we don't want these datatypes, instead we define MPI_UB and
- * MPI_LB to our Static Assert message if the compiler supports
- * that staticly assert with a nice message.
- */
-#    if (OMPI_REMOVED_USE_STATIC_ASSERT)
-#        define MPI_UB THIS_SYMBOL_WAS_REMOVED_IN_MPI30(MPI_UB, MPI_Type_create_resized);
-#        define MPI_LB THIS_SYMBOL_WAS_REMOVED_IN_MPI30(MPI_LB, MPI_Type_create_resized);
-#    endif /* OMPI_REMOVED_USE_STATIC_ASSERT */
-#endif /* Removed datatypes */
-
-
 /*
  * MPI predefined handles
  */
@@ -2730,98 +2640,6 @@ OMPI_DECLSPEC int OMPI_C_MPI_NULL_DELETE_FN( MPI_Comm comm, int comm_keyval,
                                              void* extra_state )
             __mpi_interface_deprecated__("MPI_NULL_DELETE_FN was deprecated in MPI-2.0; use MPI_COMM_NULL_DELETE_FN instead.");
 
-#if !OMPI_OMIT_MPI1_COMPAT_DECLS
-/*
- * Removed typedefs.  These typedefs are only available if Open MPI
- * was configured with --enable-mpi1-compatibility.
- *
- * These typedefs were formally removed from the MPI specification
- * and should no longer be used in MPI applications.
- *
- * Even though MPI_Handler_function is removed, we do not use the
- * attributes marking it as such, because otherwise the compiler
- * will warn for all the functions that are declared using them
- * (e.g., MPI_Errhandler_create).
- */
-typedef void (MPI_Handler_function)(MPI_Comm *, int *, ...);
-/* MPI_Handler_function was removed in MPI-3.0; use MPI_Comm_use_errhandler_function instead. */
-
-/*
- * Removed prototypes.  These prototypes are only available if Open
- * MPI was configured with --enable-mpi1-compatibility.
- *
- * These functions were formally removed from the MPI specification
- * and should no longer be used in MPI applications.
- */
-OMPI_DECLSPEC  int MPI_Address(void *location, MPI_Aint *address)
-                   __mpi_interface_removed__(MPI_Address, MPI_Get_address);
-OMPI_DECLSPEC  int PMPI_Address(void *location, MPI_Aint *address)
-                   __mpi_interface_removed__(PMPI_Address, PMPI_Get_address);
-OMPI_DECLSPEC  int MPI_Errhandler_create(MPI_Handler_function *function,
-                                         MPI_Errhandler *errhandler)
-                   __mpi_interface_removed__(MPI_Errhandler_create, MPI_Comm_create_errhandler);
-OMPI_DECLSPEC  int PMPI_Errhandler_create(MPI_Handler_function *function,
-                                          MPI_Errhandler *errhandler)
-                   __mpi_interface_removed__(PMPI_Errhandler_create, PMPI_Comm_create_errhandler);
-OMPI_DECLSPEC  int MPI_Errhandler_get(MPI_Comm comm, MPI_Errhandler *errhandler)
-                   __mpi_interface_removed__(MPI_Errhandler_get, MPI_Comm_get_errhandler);
-OMPI_DECLSPEC  int PMPI_Errhandler_get(MPI_Comm comm, MPI_Errhandler *errhandler)
-                   __mpi_interface_removed__(PMPI_Errhandler_get, PMPI_Comm_get_errhandler);
-OMPI_DECLSPEC  int MPI_Errhandler_set(MPI_Comm comm, MPI_Errhandler errhandler)
-                   __mpi_interface_removed__(MPI_Errhandler_set, MPI_Comm_set_errhandler);
-OMPI_DECLSPEC  int PMPI_Errhandler_set(MPI_Comm comm, MPI_Errhandler errhandler)
-                   __mpi_interface_removed__(PMPI_Errhandler_set, PMPI_Comm_set_errhandler);
-OMPI_DECLSPEC  int MPI_Type_extent(MPI_Datatype type, MPI_Aint *extent)
-                   __mpi_interface_removed__(MPI_Type_extent, MPI_Type_get_extent);
-OMPI_DECLSPEC  int PMPI_Type_extent(MPI_Datatype type, MPI_Aint *extent)
-                   __mpi_interface_removed__(PMPI_Type_extent, PMPI_Type_get_extent);
-OMPI_DECLSPEC  int MPI_Type_hindexed(int count, int array_of_blocklengths[],
-                                     MPI_Aint array_of_displacements[],
-                                     MPI_Datatype oldtype, MPI_Datatype *newtype)
-                   __mpi_interface_removed__(MPI_Type_hindexed, MPI_Type_create_hindexed);
-OMPI_DECLSPEC  int PMPI_Type_hindexed(int count, int array_of_blocklengths[],
-                                      MPI_Aint array_of_displacements[],
-                                      MPI_Datatype oldtype, MPI_Datatype *newtype)
-                   __mpi_interface_removed__(PMPI_Type_hindexed, PMPI_Type_create_hindexed);
-OMPI_DECLSPEC  int MPI_Type_hvector(int count, int blocklength, MPI_Aint stride,
-                                    MPI_Datatype oldtype, MPI_Datatype *newtype)
-                   __mpi_interface_removed__(MPI_Type_hvector, MPI_Type_create_hvector);
-OMPI_DECLSPEC  int PMPI_Type_hvector(int count, int blocklength, MPI_Aint stride,
-                                     MPI_Datatype oldtype, MPI_Datatype *newtype)
-                   __mpi_interface_removed__(PMPI_Type_hvector, PMPI_Type_create_hvector);
-OMPI_DECLSPEC  int MPI_Type_lb(MPI_Datatype type, MPI_Aint *lb)
-                   __mpi_interface_removed__(MPI_Type_lb, MPI_Type_get_extent);
-OMPI_DECLSPEC  int PMPI_Type_lb(MPI_Datatype type, MPI_Aint *lb)
-                   __mpi_interface_removed__(PMPI_Type_lb, PMPI_Type_get_extent);
-OMPI_DECLSPEC  int MPI_Type_struct(int count, int array_of_blocklengths[],
-                                   MPI_Aint array_of_displacements[],
-                                   MPI_Datatype array_of_types[],
-                                   MPI_Datatype *newtype)
-                   __mpi_interface_removed__(MPI_Type_struct, MPI_Type_create_struct);
-OMPI_DECLSPEC  int PMPI_Type_struct(int count, int array_of_blocklengths[],
-                                    MPI_Aint array_of_displacements[],
-                                    MPI_Datatype array_of_types[],
-                                    MPI_Datatype *newtype)
-                   __mpi_interface_removed__(PMPI_Type_struct, PMPI_Type_create_struct);
-OMPI_DECLSPEC  int MPI_Type_ub(MPI_Datatype mtype, MPI_Aint *ub)
-                   __mpi_interface_removed__(MPI_Type_ub, MPI_Type_get_extent);
-OMPI_DECLSPEC  int PMPI_Type_ub(MPI_Datatype mtype, MPI_Aint *ub)
-                   __mpi_interface_removed__(PMPI_Type_ub, PMPI_Type_get_extent);
-#endif /* !OMPI_OMIT_MPI1_COMPAT_DECLS */
-
-#if OMPI_REMOVED_USE_STATIC_ASSERT
-#define MPI_Address(...)  THIS_SYMBOL_WAS_REMOVED_IN_MPI30(MPI_Address, MPI_Get_address)
-#define MPI_Errhandler_create(...)  THIS_SYMBOL_WAS_REMOVED_IN_MPI30(MPI_Errhandler_create, MPI_Comm_create_errhandler)
-#define MPI_Errhandler_get(...)  THIS_SYMBOL_WAS_REMOVED_IN_MPI30(MPI_Errhandler_get, MPI_Comm_get_errhandler)
-#define MPI_Errhandler_set(...)  THIS_SYMBOL_WAS_REMOVED_IN_MPI30(MPI_Errhandler_set, MPI_Comm_set_errhandler)
-#define MPI_Type_extent(...)  THIS_SYMBOL_WAS_REMOVED_IN_MPI30(MPI_Type_extent, MPI_Type_get_extent)
-#define MPI_Type_hindexed(...)  THIS_SYMBOL_WAS_REMOVED_IN_MPI30(MPI_Type_hindexed, MPI_Type_create_hindexed)
-#define MPI_Type_hvector(...)  THIS_SYMBOL_WAS_REMOVED_IN_MPI30(MPI_Type_hvector, MPI_Type_create_hvector)
-#define MPI_Type_lb(...)  THIS_SYMBOL_WAS_REMOVED_IN_MPI30(MPI_Type_lb, MPI_Type_get_extent)
-#define MPI_Type_struct(...)  THIS_SYMBOL_WAS_REMOVED_IN_MPI30(MPI_Type_struct, MPI_Type_create_struct)
-#define MPI_Type_ub(...)  THIS_SYMBOL_WAS_REMOVED_IN_MPI30(MPI_Type_ub, MPI_Type_get_extent)
-#endif
-
 #if defined(c_plusplus) || defined(__cplusplus)
 }
 #endif

ompi/mpi/c/Makefile.am

@@ -437,20 +437,6 @@ libmpi_c_mpi_la_SOURCES = \
         win_wait.c
 
 
-if OMPI_ENABLE_MPI1_COMPAT
-libmpi_c_mpi_la_SOURCES += \
-        address.c \
-        errhandler_create.c \
-        errhandler_get.c \
-        errhandler_set.c \
-        type_extent.c \
-        type_hindexed.c \
-        type_hvector.c \
-        type_lb.c \
-        type_struct.c \
-        type_ub.c
-endif
-
 # Conditionally install the header files
 
 if WANT_INSTALL_HEADERS