Skip to content

ABI: Changes to Fortran-related get/set routines #7942

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

Open
dalcinl wants to merge 2 commits into
base: main
Choose a base branch
from
+127 −108
Open

ABI: Changes to Fortran-related get/set routines #7942

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f36b57
bindings/c/abi: Refactor bindings generation for Fortran APIs
dalcinl Sep 1, 2026
859a7c9
bindings/c/abi: Implement Fortran get/set booleans with the C preproc…
dalcinl Sep 1, 2026
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
90 changes: 4 additions & 86 deletions src/binding/c/abi_api.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,95 +2,11 @@

MPI_Abi_get_fortran_booleans:
.desc: Get the size of Fortran logical type and the .TRUE. and .FALSE. value
{
MPI_Datatype type = MPI_LOGICAL;
MPIR_DATATYPE_REPLACE_BUILTIN(type);
if (type == MPI_DATATYPE_NULL) {
*is_set = 0;
/* do we leave other outputs unset? */
} else {
*is_set = 1;
int exp_logical_size = MPIR_Datatype_get_basic_size(type);
if (logical_size != exp_logical_size) {
MPIR_ERR_SETANDJUMP1(mpi_errno, MPI_ERR_ABI, "**logical_size_wrong", "**logical_size_wrong %d", exp_logical_size);
}
switch(logical_size) {
case 1:
*(int8_t *) logical_true = MPIR_fortran_true;
*(int8_t *) logical_false = MPIR_fortran_false;
break;
case 2:
*(int16_t *) logical_true = MPIR_fortran_true;
*(int16_t *) logical_false = MPIR_fortran_false;
break;
case 4:
*(int32_t *) logical_true = MPIR_fortran_true;
*(int32_t *) logical_false = MPIR_fortran_false;
break;
case 8:
*(int64_t *) logical_true = MPIR_fortran_true;
*(int64_t *) logical_false = MPIR_fortran_false;
break;
default:
MPIR_ERR_SETANDJUMP1(mpi_errno, MPI_ERR_ABI, "**logical_size_unexp", "**logical_size_unexp %d", logical_size);
}
}
}
.seealso: MPI_Abi_set_fortran_booleans

MPI_Abi_get_fortran_info:
.desc: Return an info object that provides information related to the Fortran ABI
.seealso: MPI_Abi_get_info
{
if (MPIR_Internal_types[MPI_INTEGER & 0xff].internal_type == MPI_DATATYPE_NULL) {
*info = MPI_INFO_NULL;
} else {
MPIR_Info *info_ptr;
mpi_errno = MPIR_Info_alloc(&info_ptr);
MPIR_ERR_CHECK(mpi_errno);

MPI_Datatype type;
char str[8];
#define PUSH_TYPE_INFO(type_, keyname) \
do { \
type = type_; \
MPIR_DATATYPE_REPLACE_BUILTIN(type); \
snprintf(str, sizeof(str), "%d", MPIR_Datatype_get_basic_size(type)); \
MPIR_Info_push(info_ptr, keyname, str); \
} while (0)
PUSH_TYPE_INFO(MPI_LOGICAL, "mpi_logical_size");
PUSH_TYPE_INFO(MPI_INTEGER, "mpi_integer_size");
PUSH_TYPE_INFO(MPI_REAL, "mpi_real_size");
PUSH_TYPE_INFO(MPI_DOUBLE_PRECISION, "mpi_double_precision_size");
#undef PUSH_TYPE_INFO
#define PUSH_TYPE_INFO(type_, keyname) \
do { \
type = type_; \
MPIR_DATATYPE_REPLACE_BUILTIN(type); \
MPIR_Info_push(info_ptr, keyname, type != MPI_DATATYPE_NULL ? "true" : "false"); \
} while (0)
PUSH_TYPE_INFO(MPI_LOGICAL1, "mpi_logical1_supported");
PUSH_TYPE_INFO(MPI_LOGICAL2, "mpi_logical2_supported");
PUSH_TYPE_INFO(MPI_LOGICAL4, "mpi_logical4_supported");
PUSH_TYPE_INFO(MPI_LOGICAL8, "mpi_logical8_supported");
PUSH_TYPE_INFO(MPI_LOGICAL16, "mpi_logical16_supported");
PUSH_TYPE_INFO(MPI_INTEGER1, "mpi_integer1_supported");
PUSH_TYPE_INFO(MPI_INTEGER2, "mpi_integer2_supported");
PUSH_TYPE_INFO(MPI_INTEGER4, "mpi_integer4_supported");
PUSH_TYPE_INFO(MPI_INTEGER8, "mpi_integer8_supported");
PUSH_TYPE_INFO(MPI_INTEGER16, "mpi_integer16_supported");
PUSH_TYPE_INFO(MPI_REAL2, "mpi_real2_supported");
PUSH_TYPE_INFO(MPI_REAL4, "mpi_real4_supported");
PUSH_TYPE_INFO(MPI_REAL8, "mpi_real8_supported");
PUSH_TYPE_INFO(MPI_REAL16, "mpi_real16_supported");
PUSH_TYPE_INFO(MPI_COMPLEX4, "mpi_complex4_supported");
PUSH_TYPE_INFO(MPI_COMPLEX8, "mpi_complex8_supported");
PUSH_TYPE_INFO(MPI_COMPLEX16, "mpi_complex16_supported");
PUSH_TYPE_INFO(MPI_COMPLEX32, "mpi_complex32_supported");
PUSH_TYPE_INFO(MPI_DOUBLE_COMPLEX, "mpi_double_complex_supported");
#undef PUSH_TYPE_INFO
*info = info_ptr->handle;
}
}
.seealso: MPI_Abi_set_fortran_info

MPI_Abi_get_info:
.desc: Return an info object that provides information related to the ABI
Expand Down Expand Up @@ -133,9 +49,11 @@ MPI_Abi_get_version:

MPI_Abi_set_fortran_booleans:
.desc: Set Fortran logical type size and the value for .TRUE. and .FALSE.
.seealso: MPI_Abi_get_fortran_booleans

MPI_Abi_set_fortran_info:
.desc: Set Fortran datatype sizes and whether optional Fortran types are supported
.seealso: MPI_Abi_get_fortran_info

MPI_Comm_toint:
.return: INTEGER
Expand Down
145 changes: 123 additions & 22 deletions src/mpi/datatype/typeutil.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -501,14 +501,53 @@ void MPIR_Datatype_get_flattened(MPI_Datatype type, void **flattened, int *flatt
*/
#if !defined(F77_TRUE_VALUE_SET)
bool MPIR_fortran_booleans_is_set = false;
MPICH_API_PUBLIC int MPIR_fortran_true = 1;
MPICH_API_PUBLIC int MPIR_fortran_false = 0;
int MPIR_fortran_true = 1;
int MPIR_fortran_false = 0;
#else
bool MPIR_fortran_booleans_is_set = true;
MPICH_API_PUBLIC int MPIR_fortran_true = F77_TRUE_VALUE;
MPICH_API_PUBLIC int MPIR_fortran_false = F77_FALSE_VALUE;
int MPIR_fortran_true = F77_TRUE_VALUE;
int MPIR_fortran_false = F77_FALSE_VALUE;
#endif

int MPIR_Abi_get_fortran_booleans_impl(int logical_size, void *logical_true, void *logical_false,
int *is_set)
{
int mpi_errno = MPI_SUCCESS;

if (!MPIR_fortran_booleans_is_set) {
*is_set = 0;
/* we leave other outputs unset */
goto fn_exit;
}

*is_set = 1;
switch (logical_size) {
#define GET_FORTRAN_BOOLEANS(intN_t) \
case sizeof(intN_t): { \
intN_t true_value = (intN_t) MPIR_fortran_true; \
intN_t false_value = (intN_t) MPIR_fortran_false; \
(void) memcpy(logical_true, &true_value, sizeof(intN_t)); \
(void) memcpy(logical_false, &false_value, sizeof(intN_t)); \

@hzhou hzhou Sep 1, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wait. We need consider endian to use memcpy

@dalcinl dalcinl Sep 1, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean? The C compiler and the Fortran compiler would use the same endianness. The use of memcpy here preserves endianness. I'm using memcpy to avoid alignment issues, in case the user is trying to get/set the booleans from unaligned memory (e.g. members of a packed struct or something like that, or even maybe a byte array).

Am I missing something obvious?

} break
GET_FORTRAN_BOOLEANS(int8_t);
GET_FORTRAN_BOOLEANS(int16_t);
GET_FORTRAN_BOOLEANS(int32_t);
GET_FORTRAN_BOOLEANS(int64_t);
#if defined(MPIR_INT128_CTYPE)
GET_FORTRAN_BOOLEANS(MPIR_INT128_CTYPE);
#endif
#undef GET_FORTRAN_BOOLEANS
default:
MPIR_ERR_SETANDJUMP1(mpi_errno, MPI_ERR_ARG, "**logical_size_unexp",
"**logical_size_unexp %d", logical_size);
}

fn_exit:
return mpi_errno;
fn_fail:
goto fn_exit;
}

int MPIR_Abi_set_fortran_booleans_impl(int logical_size, void *logical_true, void *logical_false)
{
int mpi_errno = MPI_SUCCESS;
Expand All @@ -520,24 +559,24 @@ int MPIR_Abi_set_fortran_booleans_impl(int logical_size, void *logical_true, voi

MPIR_fortran_booleans_is_set = true;
switch (logical_size) {
case 1:
MPIR_fortran_true = *(int8_t *) logical_true;
MPIR_fortran_false = *(int8_t *) logical_false;
break;
case 2:
MPIR_fortran_true = *(int16_t *) logical_true;
MPIR_fortran_false = *(int16_t *) logical_false;
break;
case 4:
MPIR_fortran_true = *(int32_t *) logical_true;
MPIR_fortran_false = *(int32_t *) logical_false;
break;
case 8:
MPIR_fortran_true = *(int64_t *) logical_true;
MPIR_fortran_false = *(int64_t *) logical_false;
break;
#define SET_FORTRAN_BOOLEANS(intN_t) \
case sizeof(intN_t): { \
intN_t true_value, false_value; \
(void) memcpy(&true_value, logical_true, sizeof(intN_t)); \
(void) memcpy(&false_value, logical_false, sizeof(intN_t)); \
MPIR_fortran_true = (int) true_value; \
MPIR_fortran_false = (int) false_value; \
} break
SET_FORTRAN_BOOLEANS(int8_t);
SET_FORTRAN_BOOLEANS(int16_t);
SET_FORTRAN_BOOLEANS(int32_t);
SET_FORTRAN_BOOLEANS(int64_t);
#if defined(MPIR_INT128_CTYPE)
SET_FORTRAN_BOOLEANS(MPIR_INT128_CTYPE);
#endif
#undef SET_FORTRAN_BOOLEANS
default:
MPIR_ERR_SETANDJUMP1(mpi_errno, MPI_ERR_ABI, "**logical_size_unexp",
MPIR_ERR_SETANDJUMP1(mpi_errno, MPI_ERR_ARG, "**logical_size_unexp",
"**logical_size_unexp %d", logical_size);
}

Expand All @@ -547,11 +586,73 @@ int MPIR_Abi_set_fortran_booleans_impl(int logical_size, void *logical_true, voi
goto fn_exit;
}

#define MPIR_ABI_FORTRAN_IS_SET (MPIR_Internal_types[MPI_INTEGER & 0xff].internal_type != MPI_DATATYPE_NULL)

int MPIR_Abi_get_fortran_info_impl(MPIR_Info ** info)
{
int mpi_errno = MPI_SUCCESS;

if (!MPIR_ABI_FORTRAN_IS_SET) {
*info = NULL;
goto fn_exit;
}

MPIR_Info *info_ptr;
mpi_errno = MPIR_Info_alloc(&info_ptr);
MPIR_ERR_CHECK(mpi_errno);

MPI_Datatype type;
char str[8];
#define PUSH_TYPE_INFO(type_, keyname) \
do { \
type = type_; \
MPIR_DATATYPE_REPLACE_BUILTIN(type); \
snprintf(str, sizeof(str), "%d", MPIR_Datatype_get_basic_size(type)); \
MPIR_Info_push(info_ptr, keyname, str); \
} while (0)
PUSH_TYPE_INFO(MPI_LOGICAL, "mpi_logical_size");
PUSH_TYPE_INFO(MPI_INTEGER, "mpi_integer_size");
PUSH_TYPE_INFO(MPI_REAL, "mpi_real_size");
PUSH_TYPE_INFO(MPI_DOUBLE_PRECISION, "mpi_double_precision_size");
#undef PUSH_TYPE_INFO
#define PUSH_TYPE_INFO(type_, keyname) \
do { \
type = type_; \
MPIR_DATATYPE_REPLACE_BUILTIN(type); \
MPIR_Info_push(info_ptr, keyname, type != MPI_DATATYPE_NULL ? "true" : "false"); \
} while (0)
PUSH_TYPE_INFO(MPI_LOGICAL1, "mpi_logical1_supported");
PUSH_TYPE_INFO(MPI_LOGICAL2, "mpi_logical2_supported");
PUSH_TYPE_INFO(MPI_LOGICAL4, "mpi_logical4_supported");
PUSH_TYPE_INFO(MPI_LOGICAL8, "mpi_logical8_supported");
PUSH_TYPE_INFO(MPI_LOGICAL16, "mpi_logical16_supported");
PUSH_TYPE_INFO(MPI_INTEGER1, "mpi_integer1_supported");
PUSH_TYPE_INFO(MPI_INTEGER2, "mpi_integer2_supported");
PUSH_TYPE_INFO(MPI_INTEGER4, "mpi_integer4_supported");
PUSH_TYPE_INFO(MPI_INTEGER8, "mpi_integer8_supported");
PUSH_TYPE_INFO(MPI_INTEGER16, "mpi_integer16_supported");
PUSH_TYPE_INFO(MPI_REAL2, "mpi_real2_supported");
PUSH_TYPE_INFO(MPI_REAL4, "mpi_real4_supported");
PUSH_TYPE_INFO(MPI_REAL8, "mpi_real8_supported");
PUSH_TYPE_INFO(MPI_REAL16, "mpi_real16_supported");
PUSH_TYPE_INFO(MPI_COMPLEX4, "mpi_complex4_supported");
PUSH_TYPE_INFO(MPI_COMPLEX8, "mpi_complex8_supported");
PUSH_TYPE_INFO(MPI_COMPLEX16, "mpi_complex16_supported");
PUSH_TYPE_INFO(MPI_COMPLEX32, "mpi_complex32_supported");
PUSH_TYPE_INFO(MPI_DOUBLE_COMPLEX, "mpi_double_complex_supported");
#undef PUSH_TYPE_INFO
*info = info_ptr;

fn_exit:
return mpi_errno;
fn_fail:
goto fn_exit;
}

int MPIR_Abi_set_fortran_info_impl(MPIR_Info * info)
{
int mpi_errno = MPI_SUCCESS;

#define MPIR_ABI_FORTRAN_IS_SET (MPIR_Internal_types[MPI_INTEGER & 0xff].internal_type != MPI_DATATYPE_NULL)
if (MPIR_ABI_FORTRAN_IS_SET) {
return MPI_ERR_ABI;
}
Expand Down