Constants(3)

📦
version 4.0.2 · 3 versions
, in debian bookworm

🎀 Constants(3) 🎀

okay bestie, so this is the MPI page called Constants(3) and it's literally just the master key to every defined constant MPI has, like the whole vibe dictionary. it's LONG so buckle up 💖

🧚 DATA TYPES 🧚

heads up bestie: the Fortran types are only for Fortran programs and the C types are only for C programs. like, it is genuinely an error to use MPI_INT for a Fortran INTEGER. do not do it. no cap.

also, datatypes are of type MPI_Datatype in C, type INTEGER in Fortran, and Type(MPI_Datatype) in Fortran08. slay 🫶

💅 C DATATYPES

  • MPI_CHAR — char
  • MPI_SIGNED_CHAR — signed char
  • MPI_UNSIGNED_CHAR — unsigned char
  • MPI_BYTE — see the standard; like unsigned char
  • MPI_WCHAR — wide character (wchar_t)
  • MPI_SHORT — short
  • MPI_UNSIGNED_SHORT — unsigned short
  • MPI_INT — int
  • MPI_UNSIGNED — unsigned int
  • MPI_LONG — long
  • MPI_UNSIGNED_LONG — unsigned long
  • MPI_LONG_LONG_INT — long long
  • MPI_LONG_LONG — a synonym for MPI_LONG_LONG_INT
  • MPI_UNSIGNED_LONG_LONG — unsigned long long
  • MPI_FLOAT — float
  • MPI_DOUBLE — double
  • MPI_LONG_DOUBLE — long double (some systems may not implement this one, lowkey rude of them)
  • MPI_INT8_T — int8_t
  • MPI_INT16_T — int16_t
  • MPI_INT32_T — int32_t
  • MPI_INT64_T — int64_t
  • MPI_UINT8_T — uint8_t
  • MPI_UINT16_T — uint16_t
  • MPI_UINT32_T — uint32_t
  • MPI_UINT64_T — uint64_t
  • MPI_C_BOOL — _Bool
  • MPI_C_FLOAT_COMPLEX — float _Complex
  • MPI_C_COMPLEX — float _Complex
  • MPI_C_DOUBLE_COMPLEX — double _Complex
  • MPI_C_LONG_DOUBLE_COMPLEX — long double _Complex

the next lil squad are the datatypes for the MPI functions MPI_MAXLOC and MPI_MINLOC 💅

  • MPI_FLOAT_INT — struct { float, int }
  • MPI_LONG_INT — struct { long, int }
  • MPI_DOUBLE_INT — struct { double, int }
  • MPI_SHORT_INT — struct { short, int }
  • MPI_2INT — struct { int, int }
  • MPI_LONG_DOUBLE_INT — struct { long double, int }; this one is an optional type, and it may be set to MPI_DATATYPE_NULL

🦋 Special datatypes for C and Fortran

  • MPI_PACKED — for MPI_Pack and MPI_Unpack
  • MPI_UB — for MPI_Type_struct; an upper-bound indicator. Removed in MPI 3
  • MPI_LB — for MPI_Type_struct; a lower-bound indicator. Removed in MPI 3

🌸 FORTRAN DATATYPES

  • MPI_REAL — REAL
  • MPI_INTEGER — INTEGER
  • MPI_LOGICAL — LOGICAL
  • MPI_DOUBLE_PRECISION — DOUBLE PRECISION
  • MPI_COMPLEX — COMPLEX
  • MPI_DOUBLE_COMPLEX — complex*16 (or complex*32) where supported

the following datatypes are optional:

  • MPI_INTEGER1 — integer*1 if supported
  • MPI_INTEGER2 — integer*2 if supported
  • MPI_INTEGER4 — integer*4 if supported
  • MPI_INTEGER8 — integer*8 if supported
  • MPI_INTEGER16 — integer*16 if supported
  • MPI_REAL4 — real*4 if supported
  • MPI_REAL8 — real*8 if supported
  • MPI_REAL16 — real*16 if supported
  • MPI_COMPLEX8 — complex*8 if supported
  • MPI_COMPLEX16 — complex*16 if supported
  • MPI_COMPLEX32 — complex*32 if supported

and these are the datatypes for the MPI functions MPI_MAXLOC and MPI_MINLOC. in Fortran, these datatypes always consist of two elements of the same Fortran type:

  • MPI_2INTEGER — INTEGER,INTEGER
  • MPI_2REAL — REAL, REAL
  • MPI_2DOUBLE_PRECISION — DOUBLE PRECISION, DOUBLE PRECISION

💜 MPI Datatypes for MPI Types

  • MPI_AINT — datatype for an MPI_Aint
  • MPI_OFFSET — datatype for an MPI_Offset
  • MPI_COUNT — datatype for an MPI_Count

⭐ MPI DATATYPE COMBINER NAMES ⭐

  • MPI_COMBINER_NAMED — a named predefined datatype
  • MPI_COMBINER_DUP — MPI_TYPE_DUP
  • MPI_COMBINER_CONTIGUOUS — MPI_TYPE_CONTIGUOUS
  • MPI_COMBINER_VECTOR — MPI_TYPE_VECTOR
  • MPI_COMBINER_HVECTOR_INTEGER — Removed in MPI-3
  • MPI_COMBINER_HVECTOR — MPI_TYPE_CREATE_HVECTOR
  • MPI_COMBINER_INDEXED — MPI_TYPE_INDEXED
  • MPI_COMBINER_HINDEXED_INTEGER — Removed in MPI-3
  • MPI_COMBINER_HINDEXED — MPI_TYPE_CREATE_HINDEXED
  • MPI_COMBINER_INDEXED_BLOCK — MPI_TYPE_CREATE_INDEXED_BLOCK
  • MPI_COMBINER_STRUCT_INTEGER — Removed in MPI-3
  • MPI_COMBINER_STRUCT — MPI_TYPE_CREATE_STRUCT
  • MPI_COMBINER_SUBARRAY — MPI_TYPE_CREATE_SUBARRAY
  • MPI_COMBINER_DARRAY — MPI_TYPE_CREATE_DARRAY
  • MPI_COMBINER_F90_REAL — MPI_TYPE_CREATE_F90_REAL
  • MPI_COMBINER_F90_COMPLEX — MPI_TYPE_CREATE_F90_COMPLEX
  • MPI_COMBINER_F90_INTEGER — MPI_TYPE_CREATE_F90_INTEGER
  • MPI_COMBINER_RESIZED — MPI_TYPE_CREATE_RESIZED
  • MPI_COMBINER_HINDEXED_BLOCK — MPI_TYPE_CREATE_HINDEXED_BLOCK

🌈 MPI DATATYPE TYPE CLASSES 🌈

these are the MPI type classes used with routines that return Fortran types with a defined precision and range:

  • MPI_TYPECLASS_REAL — REAL
  • MPI_TYPECLASS_INTEGER — INTEGER
  • MPI_TYPECLASS_COMPLEX — COMPLEX

🦋 MPI DARRAY AND SUBARRAY VALUES 🦋

these values are used to create a datatype with the DARRAY and SUBARRAY constructors, iconic behaviour tbh:

  • MPI_ORDER_C — row-major order (as used by C)
  • MPI_ORDER_FORTRAN — column-major order (as used by Fortran)
  • MPI_DISTRIBUTE_BLOCK — block distribution
  • MPI_DISTRIBUTE_CYCLIC — cyclic distribution
  • MPI_DISTRIBUTE_NONE — this dimension is not distributed
  • MPI_DISTRIBUTE_DFLT_DARG — use the default distribution

💜 COMMUNICATORS 💜

communicators are of type MPI_Comm in C, INTEGER in Fortran, and Type(MPI_Comm) in Fortran08 💖

  • MPI_COMM_WORLD — contains all of the processes
  • MPI_COMM_SELF — contains only the calling process

🍓 KIND OF COMMUNICATOR FOR 'MPI_COMM_SPLIT_TYPE' 🍓

  • MPI_COMM_TYPE_SHARED — all processes that can share memory are grouped into the same communicator

👑 GROUPS 👑

groups are of type MPI_Group in C, INTEGER in Fortran, and Type(MPI_Group) in Fortran08 ✨

  • MPI_GROUP_EMPTY — a group containing no members

🔥 RESULTS OF THE COMPARE OPERATIONS ON GROUPS AND COMMUNICATORS 🔥

  • MPI_IDENT — identical
  • MPI_CONGRUENT — (only for MPI_COMM_COMPARE) the groups are identical
  • MPI_SIMILAR — same members, but in a different order
  • MPI_UNEQUAL — different

✨ COLLECTIVE OPERATIONS ✨

so the collective combination operations (like MPI_REDUCE, MPI_ALLREDUCE, MPI_REDUCE_SCATTER, and MPI_SCAN) all take a combination operation. this operation is of type MPI_Op in C and of type INTEGER in Fortran. and here are the predefined ones bestie:

  • MPI_MAX — return the maximum
  • MPI_MIN — return the minimum
  • MPI_SUM — return the sum
  • MPI_PROD — return the product
  • MPI_LAND — return the logical and
  • MPI_BAND — return the bitwise and
  • MPI_LOR — return the logical or
  • MPI_BOR — return the bitwise of
  • MPI_LXOR — return the logical exclusive or
  • MPI_BXOR — return the bitwise exclusive or
  • MPI_MINLOC — return the minimum and the location (actually, the value of the second element of the structure where the minimum of the first is found)
  • MPI_MAXLOC — return the maximum and the location
  • MPI_REPLACE — replace b with a
  • MPI_NO_OP — perform no operation

💀 NOTES ON COLLECTIVE OPERATIONS 💀

okay this part is the serious part, listen up.

the reduction functions (MPI_Op) do not return an error value. as a result, if the functions detect an error, all they can do is either call MPI_Abort or silently skip the problem 🙈. so if you change the error handler from MPI_ERRORS_ARE_FATAL to something else — for example, MPI_ERRORS_RETURN — then no error may be indicated.

the reason for this is the performance problems in ensuring that all collective routines return the same error value.

also, not all datatypes are valid for these functions. for example, MPI_COMPLEX is not valid for MPI_MAX and MPI_MIN. and on top of that, the MPI 1.1 standard did not include the C types MPI_CHAR and MPI_UNSIGNED_CHAR among the lists of arithmetic types for operations like MPI_SUM. however, since the C type char is an integer type (like short), it should have been included. the MPI Forum will probably include char and unsigned char as a clarification to MPI 1.1; until then, users are advised that MPI implementations may not accept MPI_CHAR and MPI_UNSIGNED_CHAR as valid datatypes for MPI_SUM, MPI_PROD, etc. MPICH does allow these datatypes.

🌟 PERMANENT KEY VALUES 🌟

these are the same in C and Fortran 💅

  • MPI_TAG_UB — largest tag value
  • MPI_HOST — rank of process that is host, if any
  • MPI_IO — rank of process that can do I/O
  • MPI_WTIME_IS_GLOBAL — has value 1 if MPI_WTIME is globally synchronized
  • MPI_UNIVERSE_SIZE — number of available processes. see the standard for a description of limitations on this value
  • MPI_LASTUSEDCODE — last used MPI error code (check - code or class?)
  • MPI_APPNUM — application number, starting from 0. see the standard for MPI_COMM_SPAWN_MULTIPLE and mpiexec for details

🫶 NULL OBJECTS 🫶

the whole ✨nothing✨ collection, all the nulls you could ever need:

  • MPI_COMM_NULL — null communicator
  • MPI_OP_NULL — null operation
  • MPI_GROUP_NULL — null group
  • MPI_DATATYPE_NULL — null datatype
  • MPI_REQUEST_NULL — null request
  • MPI_ERRHANDLER_NULL — null error handler
  • MPI_WIN_NULL — null window handle
  • MPI_FILE_NULL — null file handle
  • MPI_INFO_NULL — null info handle
  • MPI_MESSAGE_NULL — null message handle
  • MPI_ARGV_NULL — empty ARGV value for spawn commands
  • MPI_ARGVS_NULL — empty ARGV array for spawn-multiple command
  • MPI_T_ENUM_NULL — null MPI_T enum
  • MPI_T_CVAR_HANDLE_NULL — null MPI_T control variable handle
  • MPI_T_PVAR_HANDLE_NULL — null MPI_T performance variable handle
  • MPI_T_PVAR_SESSION_NULL — null MPI_T performance variable session handle

✨ PREDEFINED CONSTANTS ✨

okay bestie these are the little built-in numbers and magic values that MPI hands you, and honestly? iconic. lowkey the glue of the whole thing 💅

  • MPI_MAX_PROCESSOR_NAME — the maximum length of a name that MPI_GET_PROCESSOR_NAME will hand back to you.
  • MPI_MAX_ERROR_STRING — the maximum length of the string returned by MPI_ERROR_STRING.
  • MPI_MAX_LIBRARY_VERSION_STRING — the maximum length of the string returned by MPI_GET_LIBRARY_VERSION_STRING ???
  • MPI_MAX_PORT_NAME — the maximum length of a port. yes, ports have a vibe limit too 🫶
  • MPI_MAX_OBJECT_NAME — the maximum length of an object (?)
  • MPI_MAX_INFO_KEY — the maximum length of an info key.
  • MPI_MAX_INFO_VAL — the maximum length of an info value.
  • MPI_UNDEFINED — used by many routines to indicate an undefined or unknown integer value. it's the "idk" of integers fr fr 💀
  • MPI_UNDEFINED_RANK — unknown rank.
  • MPI_KEYVAL_INVALID — a special keyval you can use to detect uninitialized keyvals. so you don't get got by a stale one 🙈
  • MPI_BSEND_OVERHEAD — add this to the size of a MPI_BSEND buffer for each outstanding message.
  • MPI_PROC_NULL — this rank may be used to send or receive from no-one. literally nobody. ghosted but on purpose 👻
  • MPI_ANY_SOURCE — in a receive, accept a message from anyone.
  • MPI_ANY_TAG — in a receive, accept a message with any tag value.
  • MPI_BOTTOM — may be used to indicate the bottom of the address space.
  • MPI_IN_PLACE — a special location for buffer in some collective communication routines.
  • MPI_VERSION — numeric value of MPI version (e.g., 3).
  • MPI_SUBVERSION — numeric value of MPI subversion (e.g., 1).

🌈 TOPOLOGY TYPES 🌈

  • MPI_CART — Cartesian grid.
  • MPI_GRAPH — general graph.
  • MPI_DIST_GRAPH — general distributed graph.

🦋 SPECIAL VALUES FOR DISTRIBUTED GRAPH 🦋

  • MPI_UNWEIGHTED — indicates that the edges are unweighted.
  • MPI_WEIGHTS_EMPTY — special address that indicates no array of weights information.

🎀 FILE MODES 🎀

the moment you open a file in MPI you gotta tell it how you wanna open it, and these are the lil flags for that 💖

  • MPI_MODE_RDONLY — read only.
  • MPI_MODE_RDWR — read and write.
  • MPI_MODE_WRONLY — write only.
  • MPI_MODE_CREATE — create the file if it does not exist.
  • MPI_MODE_EXCL — it is an error if creating a file that already exists. no doubles allowed, periodt.
  • MPI_MODE_DELETE_ON_CLOSE — delete the file on close. it's giving ghosting the filesystem ✨
  • MPI_MODE_UNIQUE_OPEN — the file will not be concurrently opened elsewhere.
  • MPI_MODE_APPEND — the initial position of all file pointers is at the end of the file.
  • MPI_MODE_SEQUENTIAL — file will only be accessed sequentially.

🌸 FILE DISPLACEMENT 🌸

  • MPI_DISPLACEMENT_CURRENT — use with files opened with mode MPI_MODE_SEQUENTIAL in calls to MPI_FILE_SET_VIEW.

⭐ FILE POSITIONING ⭐

  • MPI_SEEK_SET — set the pointer to offset.
  • MPI_SEEK_CUR — set the pointer to the current position plus offset.
  • MPI_SEEK_END — set the pointer to the end of the file plus offset.

👑 WINDOW ATTRIBUTES 👑

  • MPI_WIN_BASE — window base address.
  • MPI_WIN_SIZE — window size, in bytes.
  • MPI_WIN_DISP_UNIT — displacement unit associated with the window.
  • MPI_WIN_CREATE_FLAVOR — how the window was created.
  • MPI_WIN_MODEL — memory model for window.

💜 WINDOW FLAVORS 💜

  • MPI_WIN_FLAVOR_CREATE — window was created with MPI_WIN_CREATE.
  • MPI_WIN_FLAVOR_ALLOCATE — window was created with MPI_WIN_ALLOCATE.
  • MPI_WIN_FLAVOR_DYNAMIC — window was created with MPI_WIN_CREATE_DYNAMIC.
  • MPI_WIN_FLAVOR_SHARED — window was created with MPI_WIN_ALLOCATE_SHARED.

🧚 WINDOW MEMORY MODEL 🧚

  • MPI_WIN_SEPARATE — separate public and private copies of window memory.
  • MPI_WIN_UNIFIED — the public and private copies are identical (by which we mean that updates are eventually observed without additional RMA operations).

🔥 WINDOW LOCK TYPES 🔥

  • MPI_LOCK_EXCLUSIVE — only one process at a time will execute accesses within the lock. main character energy, nobody else gets in 💅
  • MPI_LOCK_SHARED — not exclusive; multiple processes may execute accesses within the lock. share the spotlight besties 🫶

🌟 WINDOW ASSERTIONS 🌟

see section 11.5 in MPI 3.1 for a detailed description of each of these assertion values. fr, go read it if you want the deep lore.
  • MPI_MODE_NOCHECK — the matching calls to MPI_WIN_POST or MPI_WIN_START have already completed, or no process holds or will attempt to acquire, a conflicting lock.
  • MPI_MODE_NOSTORE — the local window has not been updated by stores since the last synchronization.
  • MPI_MODE_NOPUT — the local window will not be updated by put or accumulate until the next synchronization.
  • MPI_MODE_NOPRECEDE — the fence does not complete any locally issued RMA calls.
  • MPI_MODE_NOSUCCEED — the fence does not start any locally issued RMA calls.

🍓 PREDEFINED INFO OBJECT 🍓

  • MPI_INFO_ENV — contains the execution environment.

💀 MPI STATUS 💀

the MPI_Status datatype is a structure in C. the three elements for use by programmers are:

  • MPI_SOURCE — who sent the message.
  • MPI_TAG — what tag the message was sent with.
  • MPI_ERROR — any error return (only when the error returned by the routine has error class MPI_ERR_IN_STATUS).

and then the two iconic little shortcuts:

  • MPI_STATUS_IGNORE — ignore a single MPI_Status argument.
  • MPI_STATUSES_IGNORE — ignore an array of MPI_Status.

🙈 SPECIAL VALUE FOR ERROR CODES ARRAY 🙈

  • MPI_ERRCODES_IGNORE — ignore an array of error codes.

✨ MPI_T CONSTANTS ✨

okay this section is a lot but every single one matters bestie, no skimming 🎀

verbosity levels

  • MPI_T_VERBOSITY_USER_BASIC — basic information of interest to users.
  • MPI_T_VERBOSITY_USER_DETAIL — detailed information of interest to users.
  • MPI_T_VERBOSITY_USER_ALL — all remaining information of interest to users.
  • MPI_T_VERBOSITY_TUNER_BASIC — basic information required for tuning.
  • MPI_T_VERBOSITY_TUNER_DETAIL — detailed information required for tuning.
  • MPI_T_VERBOSITY_TUNER_ALL — all remaining information required for tuning.
  • MPI_T_VERBOSITY_MPIDEV_BASIC — basic information for MPI implementors.
  • MPI_T_VERBOSITY_MPIDEV_DETAIL — detailed information for MPI implementors.
  • MPI_T_VERBOSITY_MPIDEV_ALL — all remaining information for MPI implementors.

binding targets

  • MPI_T_BIND_NO_OBJECT — applies globally to entire MPI process.
  • MPI_T_BIND_MPI_COMM — MPI communicators.
  • MPI_T_BIND_MPI_DATATYPE — MPI datatypes.
  • MPI_T_BIND_MPI_ERRHANDLER — MPI error handlers.
  • MPI_T_BIND_MPI_FILE — MPI file handles.
  • MPI_T_BIND_MPI_GROUP — MPI groups.
  • MPI_T_BIND_MPI_OP — MPI reduction operators.
  • MPI_T_BIND_MPI_REQUEST — MPI requests.
  • MPI_T_BIND_MPI_WIN — MPI windows for one-sided communication.
  • MPI_T_BIND_MPI_MESSAGE — MPI message object.
  • MPI_T_BIND_MPI_INFO — MPI info object.

scopes

  • MPI_T_SCOPE_CONSTANT — read-only, value is constant.
  • MPI_T_SCOPE_READONLY — read-only, cannot be written, but can change.
  • MPI_T_SCOPE_LOCAL — may be writeable, writing is a local operation.
  • MPI_T_SCOPE_GROUP — may be writeable, must be done to a group of processes, all processes in a group must be set to consistent values.
  • MPI_T_SCOPE_GROUP_EQ — may be writeable, must be done to a group of processes, all processes in a group must be set to the same value.
  • MPI_T_SCOPE_ALL — may be writeable, must be done to all processes, all connected processes must be set to consistent values.
  • MPI_T_SCOPE_ALL_EQ — may be writeable, must be done to all processes, all connected processes must be set to the same value.

pvar classes

  • MPI_T_PVAR_CLASS_STATE — set of discrete states (MPI_INT).
  • MPI_T_PVAR_CLASS_LEVEL — utilization level of a resource.
  • MPI_T_PVAR_CLASS_SIZE — size of a resource.
  • MPI_T_PVAR_CLASS_PERCENTAGE — percentage utilization of a resource.
  • MPI_T_PVAR_CLASS_HIGHWATERMARK — high watermark of a resource.
  • MPI_T_PVAR_CLASS_LOWWATERMARK — low watermark of a resource.
  • MPI_T_PVAR_CLASS_COUNTER — number of occurrences of an event.
  • MPI_T_PVAR_CLASS_AGGREGATE — aggregate value over an event (e.g., sum of all memory allocations).
  • MPI_T_PVAR_CLASS_TIMER — aggretate time spent executing event.
  • MPI_T_PVAR_CLASS_GENERIC — used for any other time of performance variable.

🌈 THREAD LEVELS 🌈

  • MPI_THREAD_SINGLE — only one thread executes.
  • MPI_THREAD_FUNNELED — only the main thread makes MPI calls.
  • MPI_THREAD_SERIALIZED — only one thread at a time makes MPI calls.
  • MPI_THREAD_MULTIPLE — multiple threads may make MPI calls.

🎀 SPECIAL MPI TYPES AND FUNCTIONS 🎀

  • MPI_Aint — C type that holds any valid address.
  • MPI_Count — C type that holds any valid count.
  • MPI_Offset — C type that holds any valid file offset.
  • MPI_Handler_function — C function for handling errors (see MPI_Errhandler_create).
  • MPI_User_function — C function to combine values (see collective operations and MPI_Op_create).
  • MPI_Copy_function — function to copy attributes (see MPI_Keyval_create).
  • MPI_Delete_function — function to delete attributes (see MPI_Keyval_create).
  • MPI_ERRORS_ARE_FATAL — error handler that forces exit on error.
  • MPI_ERRORS_RETURN — error handler that returns error codes (as value of MPI routine in C and through last argument in Fortran).
  • MPI_ERRORS_ABORT — error handler that forces exit on error (only aborts local process if the error handler is invoked on a session).

💜 MPI ATTRIBUTE DEFAULT FUNCTIONS 💜

  • MPI_COMM_NULL_COPY_FN — predefined attribute copy function for communicators.
  • MPI_COMM_NULL_DELETE_FN — predefined attribute delete function for communicators.
  • MPI_COMM_DUP_FN — predefined attribute duplicate function for communicators.
  • MPI_WIN_NULL_COPY_FN — predefined attribute copy function for windows.
  • MPI_WIN_NULL_DELETE_FN — predefined attribute delete function for windows.
  • MPI_WIN_DUP_FN — predefined attribute duplicate function for windows.
  • MPI_TYPE_NULL_COPY_FN — predefined attribute copy function for datatypes.
  • MPI_TYPE_NULL_DELETE_FN — predefined attribute delete function for datatypes.
  • MPI_TYPE_DUP_FN — predefined attribute duplicate function for datatypes.

🧚 MPI-1 ATTRIBUTE DEFAULT FUNCTIONS 🧚

  • MPI_NULL_COPY_FN — predefined copy function.
  • MPI_NULL_DELETE_FN — predefined delete function.
  • MPI_DUP_FN — predefined duplication function.

💀 MPI ERROR CLASSES 💀

okay bestie, this is the big one — every single error class MPI can throw at you. when a call goes wrong, this is the value it hands back. memorize the vibes, not the list, and you're golden ✨

  • MPI_SUCCESS — the good one 🎀 successful return code, no drama, no notes
  • MPI_ERR_BUFFER — that buffer pointer is invalid, hun
  • MPI_ERR_COUNT — the count argument? invalid, bestie
  • MPI_ERR_TYPE — invalid datatype argument
  • MPI_ERR_TAG — invalid tag argument
  • MPI_ERR_COMM — invalid communicator
  • MPI_ERR_RANK — invalid rank
  • MPI_ERR_ROOT — invalid root
  • MPI_ERR_GROUP — a null group got passed to a function 😭
  • MPI_ERR_OP — invalid operation
  • MPI_ERR_TOPOLOGY — invalid topology
  • MPI_ERR_DIMS — illegal dimension argument
  • MPI_ERR_ARG — invalid argument
  • MPI_ERR_UNKNOWN — unknown error, the mystery box of errors 🫣
  • MPI_ERR_TRUNCATE — message got truncated on receive, oop
  • MPI_ERR_OTHER — some other error; use Error_string to find out what
  • MPI_ERR_INTERN — internal error code (not your fault, fr fr)
  • MPI_ERR_IN_STATUS — go look in the status for the actual error value
  • MPI_ERR_PENDING — pending request, it's still cooking ⏳
  • MPI_ERR_REQUEST — invalid mpi_request handle
  • MPI_ERR_ACCESS — permission denied 💅
  • MPI_ERR_AMODE — something's up with the amode you passed to MPI_FILE_OPEN
  • MPI_ERR_BAD_FILE — invalid file name (like, the path name is too long, bestie)
  • MPI_ERR_CONVERSION — an error happened inside a user supplied data conversion function
  • MPI_ERR_DUP_DATAREP — the conversion functions could not be registered because a data representation identifier that was already defined got passed to MPI_REGISTER_DATAREP 🙈
  • MPI_ERR_FILE_EXISTS — file exists already
  • MPI_ERR_FILE_IN_USE — file operation could not be completed, because the file is currently open by some process
  • MPI_ERR_FILE — invalid file handle
  • MPI_ERR_IO — some other I/O error
  • MPI_ERR_NO_SPACE — not enough space
  • MPI_ERR_NO_SUCH_FILE — file does not exist
  • MPI_ERR_READ_ONLY — read-only file or file system
  • MPI_ERR_UNSUPPORTED_DATAREP — unsupported datarep got passed to MPI_FILE_SET_VIEW
  • MPI_ERR_INFO — invalid info argument
  • MPI_ERR_INFO_KEY — key is longer than MPI_MAX_INFO_KEY
  • MPI_ERR_INFO_VALUE — value is longer than MPI_MAX_INFO_VAL
  • MPI_ERR_INFO_NOKEY — invalid key passed to MPI_INFO_DELETE
  • MPI_ERR_NAME — invalid service name passed to MPI_LOOKUP_NAME
  • MPI_ERR_NO_MEM — Alloc_mem could not allocate memory 😭
  • MPI_ERR_NOT_SAME — collective argument isn't identical on all processes, or collective routines got called in a different order by different processes
  • MPI_ERR_PORT — invalid port name passed to MPI_COMM_CONNECT
  • MPI_ERR_QUOTA — quota exceeded
  • MPI_ERR_SERVICE — invalid service name passed to MPI_UNPUBLISH_NAME
  • MPI_ERR_SPAWN — error in spawning processes
  • MPI_ERR_UNSUPPORTED_OPERATION — unsupported operation, like seeking on a file that only supports sequential access
  • MPI_ERR_WIN — invalid win argument
  • MPI_ERR_BASE — invalid base passed to MPI_FREE_MEM
  • MPI_ERR_LOCKTYPE — invalid locktype argument
  • MPI_ERR_KEYVAL — erroneous attribute key
  • MPI_ERR_RMA_CONFLICT — conflicting accesses to window
  • MPI_ERR_RMA_SYNC — wrong synchronization of RMA calls
  • MPI_ERR_SIZE — invalid size argument
  • MPI_ERR_DISP — invalid disp argument
  • MPI_ERR_ASSERT — invalid assert argument
  • MPI_ERR_RMA_RANGE — target memory is not part of the window (and if the window was created with MPI_WIN_CREATE_DYNAMIC, then the target memory is not attached)
  • MPI_ERR_RMA_ATTACH — memory cannot be attached (like, because of resource exhaustion)
  • MPI_ERR_RMA_SHARED — memory cannot be shared (like, some process in the group of the specified communicator cannot expose shared memory)
  • MPI_ERR_RMA_FLAVOR — the passed window has the wrong flavor for the function that got called
  • MPI_ERR_LASTCODE — last error code, always at the end, periodt

✨ ERROR CODES FOR MPI_T ✨

these ones are the tool-interface edition, for when you're poking at MPI's guts with MPI_T calls 🧚

  • MPI_T_ERR_MEMORY — out of memory
  • MPI_T_ERR_NOT_INITIALIZED — interface not initialized
  • MPI_T_ERR_CANNOT_INIT — interface is not in the state where it can be initialized
  • MPI_T_ERR_INVALID_INDEX — the index is invalid or has been deleted
  • MPI_T_ERR_INVALID_HANDLE — the handle is invalid
  • MPI_T_ERR_OUT_OF_HANDLES — no more handles available
  • MPI_T_ERR_OUT_OF_SESSIONS — no more sessions available
  • MPI_T_ERR_INVALID_SESSION — the session argument is not valid
  • MPI_T_ERR_CVAR_SET_NOT_NOW — the cvar cannot be set at this moment
  • MPI_T_ERR_CVAR_SET_NEVER — the cvar cannot be set until the end of execution
  • MPI_T_ERR_PVAR_NO_STARTSTOP — the pvar can't be started or stopped
  • MPI_T_ERR_PVAR_NO_WRITE — the pvar can't be written or reset
  • MPI_T_ERR_PVAR_NO_ATOMIC — the pvar can't be R/W atomically
  • MPI_T_ERR_INVALID_NAME — name doesn't match
  • MPI_T_ERR_INVALID — invalid use of the interface, or bad parameter value(s)

and that's the whole constants list, bestie — you made it to the end of part 3 of 3 🫶 this page is from the Constants(3) manpage, dated 2/21/2022, and it was absolutely giving "reference material that ate" 💅 go forth and pass the right constants, you icon 👑🌸

📦 where this page comes from