Skip to content

mark _x functions for deprecation #13349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 31, 2025
+58 −19
Merged

mark _x functions for deprecation #13349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/man-openmpi/man3/MPI_Get_elements.3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,12 @@ number of elements in the probed message. Note that the two functions
:ref:`MPI_Get_count` and :ref:`MPI_Get_elements` return the same values when they are
used with primitive data types.

NOTES
-----

Note that :ref:`MPI_Get_elements_x` is *deprecated* as of MPI-4.1. Please use
the big count version of :ref:`MPI_Get_elements` instead.


ERRORS
------
Expand Down
2 changes: 2 additions & 0 deletions docs/man-openmpi/man3/MPI_Status_set_elements.3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ that does not logically belong in status. Furthermore, modifying the
values in a status set internally by MPI, such as :ref:`MPI_Recv`, may lead to
unpredictable results and is strongly discouraged.

Note that :ref:`MPI_Status_set_elements_x` is *deprecated* as of MPI-4.1. Please use
the big count version of :ref:`MPI_Status_set_elements` instead.

ERRORS
------
Expand Down
7 changes: 5 additions & 2 deletions docs/man-openmpi/man3/MPI_Type_get_extent.3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,15 @@ parameter is too small to hold the output value), it is set to
MPI_UNDEFINED.


NOTE
----
NOTES
-----

Use of :ref:`MPI_Type_get_extent` is strongly recommended over the legacy MPI-1
functions :ref:`MPI_Type_extent` and :ref:`MPI_Type_lb`.

Note that :ref:`MPI_Type_get_extent_x` is *deprecated* as of MPI-4.1. Please use
the big count version of :ref:`MPI_Type_get_extent` instead.


ERRORS
------
Expand Down
5 changes: 5 additions & 0 deletions docs/man-openmpi/man3/MPI_Type_get_true_extent.3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ hold a data type, uncompressed.
See section 4.1.8 of the MPI-3 standard for more detailed definitions of these
parameters in relation to the typemap.

NOTE
----

Note that :ref:`MPI_Type_get_true_extent_x` is *deprecated* as of MPI-4.1. Please use
the big count version of :ref:`MPI_Type_get_true_extent` instead.

ERRORS
------
Expand Down
6 changes: 6 additions & 0 deletions docs/man-openmpi/man3/MPI_Type_size.3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ multiplicity. For either function, if the *size* parameter cannot
express the value to be returned (e.g., if the parameter is too small to
hold the output value), it is set to MPI_UNDEFINED.

NOTE
----

Note that :ref:`MPI_Type_size_x` is *deprecated* as of MPI-4.1. Please use
the big count version of :ref:`MPI_Type_size` instead.


ERRORS
------
Expand Down
51 changes: 34 additions & 17 deletions ompi/include/mpi.h.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
* Copyright (c) 2021-2022 Amazon.com, Inc. or its affiliates. All Rights
* reserved.
* Copyright (c) 2021 Bull S.A.S. All rights reserved.
* Copyright (c) 2018-2022 Triad National Security, LLC. All rights
* Copyright (c) 2018-2025 Triad National Security, LLC. All rights
* reserved.
* Copyright (c) 2025 Advanced Micro Devices, Inc. All rights reserved
* Copyright (c) 2025 Jeffrey M. Squyres. All rights reserved.
Expand Down Expand Up @@ -385,10 +385,16 @@

#if MPI_VERSION >= 4
# define __mpi_interface_deprecated_in_mpi40__(msg) __mpi_interface_deprecated__(msg)
#if MPI_SUBVERSION == 1 || MPI_VERSION > 4
# define __mpi_interface_deprecated_in_mpi41__(msg) __mpi_interface_deprecated__(msg)
#endif
#else
# define __mpi_interface_deprecated_in_mpi40__(msg)
# define __mpi_interface_deprecated_in_mpi41__(msg)
#endif



#if !defined(OMPI_REMOVED_USE_STATIC_ASSERT)
# define OMPI_REMOVED_USE_STATIC_ASSERT 0
#endif
Expand Down Expand Up @@ -1883,7 +1889,6 @@ OMPI_DECLSPEC int MPI_Get_count(const MPI_Status *status, MPI_Datatype datatype
OMPI_DECLSPEC int MPI_Get_count_c(const MPI_Status *status, MPI_Datatype datatype, MPI_Count *count);
OMPI_DECLSPEC int MPI_Get_elements(const MPI_Status *status, MPI_Datatype datatype, int *count);
OMPI_DECLSPEC int MPI_Get_elements_c(const MPI_Status *status, MPI_Datatype datatype, MPI_Count *count);
OMPI_DECLSPEC int MPI_Get_elements_x(const MPI_Status *status, MPI_Datatype datatype, MPI_Count *count);
OMPI_DECLSPEC int MPI_Get(void *origin_addr, int origin_count,
MPI_Datatype origin_datatype, int target_rank,
MPI_Aint target_disp, int target_count,
Expand Down Expand Up @@ -2375,8 +2380,6 @@ OMPI_DECLSPEC int MPI_Status_set_elements(MPI_Status *status, MPI_Datatype data
int count);
OMPI_DECLSPEC int MPI_Status_set_elements_c(MPI_Status *status, MPI_Datatype datatype,
MPI_Count count);
OMPI_DECLSPEC int MPI_Status_set_elements_x(MPI_Status *status, MPI_Datatype datatype,
MPI_Count count);
OMPI_DECLSPEC int MPI_Testall(int count, MPI_Request array_of_requests[], int *flag,
MPI_Status array_of_statuses[]);
OMPI_DECLSPEC int MPI_Testany(int count, MPI_Request array_of_requests[], int *index,
Expand Down Expand Up @@ -2486,16 +2489,12 @@ OMPI_DECLSPEC int MPI_Type_get_extent(MPI_Datatype type, MPI_Aint *lb,
MPI_Aint *extent);
OMPI_DECLSPEC int MPI_Type_get_extent_c(MPI_Datatype type, MPI_Count *lb,
MPI_Count *extent);
OMPI_DECLSPEC int MPI_Type_get_extent_x(MPI_Datatype type, MPI_Count *lb,
MPI_Count *extent);
OMPI_DECLSPEC int MPI_Type_get_name(MPI_Datatype type, char *type_name,
int *resultlen);
OMPI_DECLSPEC int MPI_Type_get_true_extent(MPI_Datatype datatype, MPI_Aint *true_lb,
MPI_Aint *true_extent);
OMPI_DECLSPEC int MPI_Type_get_true_extent_c(MPI_Datatype datatype, MPI_Count *true_lb,
MPI_Count *true_extent);
OMPI_DECLSPEC int MPI_Type_get_true_extent_x(MPI_Datatype datatype, MPI_Count *true_lb,
MPI_Count *true_extent);
OMPI_DECLSPEC int MPI_Type_indexed(int count, const int array_of_blocklengths[],
const int array_of_displacements[],
MPI_Datatype oldtype, MPI_Datatype *newtype);
Expand All @@ -2508,7 +2507,6 @@ OMPI_DECLSPEC int MPI_Type_set_attr(MPI_Datatype type, int type_keyval,
OMPI_DECLSPEC int MPI_Type_set_name(MPI_Datatype type, const char *type_name);
OMPI_DECLSPEC int MPI_Type_size(MPI_Datatype type, int *size);
OMPI_DECLSPEC int MPI_Type_size_c(MPI_Datatype type, MPI_Count *size);
OMPI_DECLSPEC int MPI_Type_size_x(MPI_Datatype type, MPI_Count *size);
OMPI_DECLSPEC int MPI_Type_vector(int count, int blocklength, int stride,
MPI_Datatype oldtype, MPI_Datatype *newtype);
OMPI_DECLSPEC int MPI_Type_vector_c(MPI_Count count, MPI_Count blocklength, MPI_Count stride,
Expand Down Expand Up @@ -3042,7 +3040,6 @@ OMPI_DECLSPEC int PMPI_Get_count(const MPI_Status *status, MPI_Datatype datatyp
OMPI_DECLSPEC int PMPI_Get_count_c(const MPI_Status *status, MPI_Datatype datatype, MPI_Count *count);
OMPI_DECLSPEC int PMPI_Get_elements(const MPI_Status *status, MPI_Datatype datatype, int *count);
OMPI_DECLSPEC int PMPI_Get_elements_c(const MPI_Status *status, MPI_Datatype datatype, MPI_Count *count);
OMPI_DECLSPEC int PMPI_Get_elements_x(const MPI_Status *status, MPI_Datatype datatype, MPI_Count *count);
OMPI_DECLSPEC int PMPI_Get(void *origin_addr, int origin_count,
MPI_Datatype origin_datatype, int target_rank,
MPI_Aint target_disp, int target_count,
Expand Down Expand Up @@ -3534,8 +3531,6 @@ OMPI_DECLSPEC int PMPI_Status_set_elements(MPI_Status *status, MPI_Datatype dat
int count);
OMPI_DECLSPEC int PMPI_Status_set_elements_c(MPI_Status *status, MPI_Datatype datatype,
MPI_Count count);
OMPI_DECLSPEC int PMPI_Status_set_elements_x(MPI_Status *status, MPI_Datatype datatype,
MPI_Count count);
OMPI_DECLSPEC int PMPI_Testall(int count, MPI_Request array_of_requests[], int *flag,
MPI_Status array_of_statuses[]);
OMPI_DECLSPEC int PMPI_Testany(int count, MPI_Request array_of_requests[], int *index,
Expand Down Expand Up @@ -3645,16 +3640,12 @@ OMPI_DECLSPEC int PMPI_Type_get_extent(MPI_Datatype type, MPI_Aint *lb,
MPI_Aint *extent);
OMPI_DECLSPEC int PMPI_Type_get_extent_c(MPI_Datatype type, MPI_Count *lb,
MPI_Count *extent);
OMPI_DECLSPEC int PMPI_Type_get_extent_x(MPI_Datatype type, MPI_Count *lb,
MPI_Count *extent);
OMPI_DECLSPEC int PMPI_Type_get_name(MPI_Datatype type, char *type_name,
int *resultlen);
OMPI_DECLSPEC int PMPI_Type_get_true_extent(MPI_Datatype datatype, MPI_Aint *true_lb,
MPI_Aint *true_extent);
OMPI_DECLSPEC int PMPI_Type_get_true_extent_c(MPI_Datatype datatype, MPI_Count *true_lb,
MPI_Count *true_extent);
OMPI_DECLSPEC int PMPI_Type_get_true_extent_x(MPI_Datatype datatype, MPI_Count *true_lb,
MPI_Count *true_extent);
OMPI_DECLSPEC int PMPI_Type_indexed(int count, const int array_of_blocklengths[],
const int array_of_displacements[],
MPI_Datatype oldtype, MPI_Datatype *newtype);
Expand All @@ -3667,7 +3658,6 @@ OMPI_DECLSPEC int PMPI_Type_set_attr(MPI_Datatype type, int type_keyval,
OMPI_DECLSPEC int PMPI_Type_set_name(MPI_Datatype type, const char *type_name);
OMPI_DECLSPEC int PMPI_Type_size(MPI_Datatype type, int *size);
OMPI_DECLSPEC int PMPI_Type_size_c(MPI_Datatype type, MPI_Count *size);
OMPI_DECLSPEC int PMPI_Type_size_x(MPI_Datatype type, MPI_Count *size);
OMPI_DECLSPEC int PMPI_Type_vector(int count, int blocklength, int stride,
MPI_Datatype oldtype, MPI_Datatype *newtype);
OMPI_DECLSPEC int PMPI_Type_vector_c(MPI_Count count, MPI_Count blocklength, MPI_Count stride,
Expand Down Expand Up @@ -3912,6 +3902,33 @@ OMPI_DECLSPEC int MPI_Info_get_valuelen(MPI_Info info, const char *key, int *va
OMPI_DECLSPEC int PMPI_Info_get_valuelen(MPI_Info info, const char *key, int *valuelen,
int *flag)
__mpi_interface_deprecated_in_mpi40__("PMPI_Info_get_valuelen was deprecated in MPI-4.0; use PMPI_Info_get_string instead");
OMPI_DECLSPEC int MPI_Get_elements_x(const MPI_Status *status, MPI_Datatype datatype, MPI_Count *count)
__mpi_interface_deprecated_in_mpi41__("MPI_Get_elements_x was deprecated in MPI-4.1; use MPI_Get_elements_c instead");
OMPI_DECLSPEC int PMPI_Get_elements_x(const MPI_Status *status, MPI_Datatype datatype, MPI_Count *count)
__mpi_interface_deprecated_in_mpi41__("PMPI_Get_elements_x was deprecated in MPI-4.1; use PMPI_Get_elements_c instead");
OMPI_DECLSPEC int MPI_Status_set_elements_x(MPI_Status *status, MPI_Datatype datatype,
MPI_Count count)
__mpi_interface_deprecated_in_mpi41__("MPI_Status_set_elements_x was deprecated in MPI-4.1; use MPI_Status_set_elements_c instead");
OMPI_DECLSPEC int PMPI_Status_set_elements_x(MPI_Status *status, MPI_Datatype datatype,
MPI_Count count)
__mpi_interface_deprecated_in_mpi41__("PMPI_Status_set_elements_x was deprecated in MPI-4.1; use PMPI_Status_set_elements_c instead");
OMPI_DECLSPEC int MPI_Type_get_extent_x(MPI_Datatype type, MPI_Count *lb,
MPI_Count *extent)
__mpi_interface_deprecated_in_mpi41__("MPI_Type_get_extent_x was deprecated in MPI-4.1; use MPI_Type_get_extent_c instead");
OMPI_DECLSPEC int PMPI_Type_get_extent_x(MPI_Datatype type, MPI_Count *lb,
MPI_Count *extent)
__mpi_interface_deprecated_in_mpi41__("PMPI_Type_get_extent_x was deprecated in MPI-4.1; use PMPI_Type_get_extent_c instead");
OMPI_DECLSPEC int MPI_Type_get_true_extent_x(MPI_Datatype datatype, MPI_Count *true_lb,
MPI_Count *true_extent)
__mpi_interface_deprecated_in_mpi41__("MPI_Type_get_true_extent_x was deprecated in MPI-4.1; use MPI_Type_get_true_extent_c instead");
OMPI_DECLSPEC int PMPI_Type_get_true_extent_x(MPI_Datatype datatype, MPI_Count *true_lb,
MPI_Count *true_extent)
__mpi_interface_deprecated_in_mpi41__("PMPI_Type_get_true_extent_x was deprecated in MPI-4.1; use PMPI_Type_get_true_extent_c instead");
OMPI_DECLSPEC int MPI_Type_size_x(MPI_Datatype type, MPI_Count *size)
__mpi_interface_deprecated_in_mpi41__("MPI_Type_size_x was deprecated in MPI-4.1; use MPI_Type_size_c instead");
OMPI_DECLSPEC int PMPI_Type_size_x(MPI_Datatype type, MPI_Count *size)
__mpi_interface_deprecated_in_mpi41__("MPI_Type_size_x was deprecated in MPI-4.1; use MPI_Type_size_c instead");


OMPI_DECLSPEC int MPI_T_event_get_num (int *num_events);
OMPI_DECLSPEC int MPI_T_event_get_info (int event_index, char *name, int *name_len,
Expand Down
Loading