Synopsis

int MPI_Get_hw_resource_info(MPI_Info *hw_info)

Output Parameters

hw_info

info object created (handle)

Description

MPI_Get_hw_resource_info is a local procedure that returns an info object containing hardware platform information for the calling MPI process. The info object stores (key, value) pairs where each key is a hardware resource type name and its value is true if the process is restricted to a single instance of that resource type, false otherwise. The order of keys in hw_info is unspecified, and subsequent calls may return different information if the process is relocated or has its hardware restrictions changed. The user is responsible for freeing hw_info via MPI_INFO_FREE.

The returned information may reflect virtualized hardware resources and may be restricted by access permissions or other constraints. Keys have a Uniform Resource Identifier format where the key provider mpi:// is reserved for exclusive use by the MPI standard; users are recommended to be cautious when comparing keys from different providers as the same hardware resource may be listed under different names, and keys returned by this procedure may be used in MPI_COMM_SPLIT_TYPE with split_type value MPI_COMM_TYPE_HW_GUIDED or MPI_COMM_TYPE_RESOURCE_GUIDED as key values for info key mpi_hw_resource_type.

Thread and Interrupt Safety

This routine is thread-safe. This means that this routine may be safely used by multiple threads without the need for any user-provided thread locks. However, the routine is not interrupt safe. Typically, this is due to the use of memory allocation routines such as 'malloc' or other non-MPICH runtime routines that are themselves not interrupt-safe.

Notes for Fortran

All MPI routines in Fortran (except for 'MPI_WTIME' and 'MPI_WTICK') have an additional argument 'ierr' at the end of the argument list. 'ierr' is an integer and has the same meaning as the return value of the routine in C. In Fortran, MPI routines are subroutines, and are invoked with the 'call' statement.

All MPI objects (e.g., 'MPI_Datatype', 'MPI_Comm') are of type 'INTEGER' in Fortran.

Errors

All MPI routines (except 'MPI_Wtime' and 'MPI_Wtick') return an error value; C routines as the value of the function and Fortran routines in the last argument. Before the value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job. The error handler may be changed with 'MPI_Comm_set_errhandler' (for communicators), 'MPI_File_set_errhandler' (for files), and 'MPI_Win_set_errhandler' (for RMA windows). The MPI-1 routine 'MPI_Errhandler_set' may be used but its use is deprecated. The predefined error handler 'MPI_ERRORS_RETURN' may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error; however, MPI implementations will attempt to continue whenever possible.

  • MPI_SUCCESS - No error; MPI routine completed successfully.

  • MPI_ERR_ARG - Invalid argument. Some argument is invalid and is not identified by a specific error class (e.g., 'MPI_ERR_RANK').

  • MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.