Blame doc/mansrc/mpiconsts.txt

Packit Service c5cf8c
This file contains the raw material for a file of the MPI defined
Packit Service c5cf8c
constants
Packit Service c5cf8c
Packit Service c5cf8c
The data could be organized to look like an enum - or add something to
Packit Service c5cf8c
doctext that say "make each value in a list into an index entry to the
Packit Service c5cf8c
same page.
Packit Service c5cf8c
Packit Service c5cf8c
Doctext could also use a way to include an index to the corresponding
Packit Service c5cf8c
page in the standard, perhaps by using an *input* index file (generated,
Packit Service c5cf8c
perhaps, from the index entries in the LaTeX for the definition index entry).
Packit Service c5cf8c
Packit Service c5cf8c
Needs to be updated for MPI-2 and MPI-3
Packit Service c5cf8c
Packit Service c5cf8c
/*N Datatypes
Packit Service c5cf8c
   Data types:
Packit Service c5cf8c
   Note that the Fortran types should only be used in Fortran programs,
Packit Service c5cf8c
   and the C types should only be used in C programs.  For example,
Packit Service c5cf8c
   it is in error to use 'MPI_INT' for a Fortran INTEGER.
Packit Service c5cf8c
   Datatypes are of type 'MPI_Datatype' in C, type 'INTEGER' in Fortran,
Packit Service c5cf8c
   and 'Type(MPI_Datatype)' in Fortran08
Packit Service c5cf8c
N*/
Packit Service c5cf8c
Packit Service c5cf8c
We may want to enlarge on some of these.  For example, the description of
Packit Service c5cf8c
communicators could include information from the standard, and/or links to the
Packit Service c5cf8c
standard.
Packit Service c5cf8c
Packit Service c5cf8c
/*D
Packit Service c5cf8c
   Constants - Meaning of MPI''s defined constants
Packit Service c5cf8c
Packit Service c5cf8c
.N Datatypes
Packit Service c5cf8c
Packit Service c5cf8c
   C datatypes:
Packit Service c5cf8c
+I  MPI_CHAR - char
Packit Service c5cf8c
.  MPI_SIGNED_CHAR - signed char
Packit Service c5cf8c
.  MPI_UNSIGNED_CHAR - unsigned char
Packit Service c5cf8c
.  MPI_BYTE - See standard; like unsigned char
Packit Service c5cf8c
.  MPI_WCHAR - wide character (wchar_t)
Packit Service c5cf8c
.  MPI_SHORT - short
Packit Service c5cf8c
.  MPI_UNSIGNED_SHORT - unsigned short
Packit Service c5cf8c
.  MPI_INT   - int
Packit Service c5cf8c
.  MPI_UNSIGNED - unsigned int
Packit Service c5cf8c
.  MPI_LONG - long
Packit Service c5cf8c
.  MPI_UNSIGNED_LONG - unsigned long
Packit Service c5cf8c
.  MPI_LONG_LONG_INT - long long
Packit Service c5cf8c
.  MPI_LONG_LONG - synonyn for 'MPI_LONG_LONG_INT'
Packit Service c5cf8c
.  MPI_UNSIGNED_LONG_LONG - unsigned long long
Packit Service c5cf8c
.  MPI_FLOAT - float
Packit Service c5cf8c
.  MPI_DOUBLE - double
Packit Service c5cf8c
.  MPI_LONG_DOUBLE  - long double (some systems may not implement this)
Packit Service c5cf8c
.  MPI_INT8_T  - int8_t
Packit Service c5cf8c
.  MPI_INT16_T - int16_t
Packit Service c5cf8c
.  MPI_INT32_T - int32_t
Packit Service c5cf8c
.  MPI_INT64_T - int64_t
Packit Service c5cf8c
.  MPI_UINT8_T  - uint8_t
Packit Service c5cf8c
.  MPI_UINT16_T - uint16_t
Packit Service c5cf8c
.  MPI_UINT32_T - uint32_t
Packit Service c5cf8c
.  MPI_UINT64_T - uint64_t
Packit Service c5cf8c
.  MPI_C_BOOL -  _Bool
Packit Service c5cf8c
.  MPI_C_FLOAT_COMPLEX - float _Complex
Packit Service c5cf8c
.  MPI_C_COMPLEX - float _Complex
Packit Service c5cf8c
.  MPI_C_DOUBLE_COMPLEX - double _Complex
Packit Service c5cf8c
-  MPI_C_LONG_DOUBLE_COMPLEX - long double _Complex
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
   The following are datatypes for the MPI functions 'MPI_MAXLOC' and
Packit Service c5cf8c
   'MPI_MINLOC'.
Packit Service c5cf8c
+I  MPI_FLOAT_INT - 'struct { float, int }'
Packit Service c5cf8c
.  MPI_LONG_INT  - 'struct { long, int }'
Packit Service c5cf8c
.  MPI_DOUBLE_INT - 'struct { double, int }'
Packit Service c5cf8c
.  MPI_SHORT_INT  - 'struct { short, int }'
Packit Service c5cf8c
.  MPI_2INT       - 'struct { int, int }'
Packit Service c5cf8c
-  MPI_LONG_DOUBLE_INT - 'struct { long double, int }'; this
Packit Service c5cf8c
  is an `optional` type, and may be set to 'MPI_DATATYPE_NULL'
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
   Special datatypes for C and Fortran
Packit Service c5cf8c
+I MPI_PACKED - For 'MPI_Pack' and 'MPI_Unpack'
Packit Service c5cf8c
. MPI_UB - For 'MPI_Type_struct'; an upper-bound indicator.  Removed in MPI 3
Packit Service c5cf8c
- MPI_LB - For 'MPI_Type_struct'; a lower-bound indicator. Removed in MPI 3
Packit Service c5cf8c
Packit Service c5cf8c
  Fortran datatypes:
Packit Service c5cf8c
+I MPI_REAL - 'REAL'
Packit Service c5cf8c
. MPI_INTEGER - 'INTEGER'
Packit Service c5cf8c
. MPI_LOGICAL - 'LOGICAL'
Packit Service c5cf8c
. MPI_DOUBLE_PRECISION - 'DOUBLE PRECISION'
Packit Service c5cf8c
. MPI_COMPLEX - 'COMPLEX'
Packit Service c5cf8c
- MPI_DOUBLE_COMPLEX - 'complex*16' (or 'complex*32') where supported.
Packit Service c5cf8c
Packit Service c5cf8c
  The following datatypes are optional
Packit Service c5cf8c
+I MPI_INTEGER1  - 'integer*1' if supported
Packit Service c5cf8c
. MPI_INTEGER2  - 'integer*2' if supported
Packit Service c5cf8c
. MPI_INTEGER4  - 'integer*4' if supported
Packit Service c5cf8c
. MPI_INTEGER8  - 'integer*8' if supported
Packit Service c5cf8c
. MPI_INTEGER16 - 'integer*16' if supported
Packit Service c5cf8c
. MPI_REAL4     - 'real*4' if supported
Packit Service c5cf8c
- MPI_REAL8     - 'real*8' if supported
Packit Service c5cf8c
. MPI_REAL16    - 'real*16' if supported
Packit Service c5cf8c
. MPI_COMPLEX8  - 'complex*8' if supported
Packit Service c5cf8c
. MPI_COMPLEX16 - 'complex*16' if supported
Packit Service c5cf8c
- MPI_COMPLEX32 - 'complex*32' if supported
Packit Service c5cf8c
Packit Service c5cf8c
   The following are datatypes for the MPI functions 'MPI_MAXLOC' and
Packit Service c5cf8c
   'MPI_MINLOC'.  In Fortran, these datatype always consist of
Packit Service c5cf8c
   two elements of the same Fortran type.
Packit Service c5cf8c
+I MPI_2INTEGER - 'INTEGER,INTEGER'
Packit Service c5cf8c
. MPI_2REAL    - 'REAL, REAL'
Packit Service c5cf8c
- MPI_2DOUBLE_PRECISION - 'DOUBLE PRECISION, DOUBLE PRECISION'
Packit Service c5cf8c
Packit Service c5cf8c
 MPI Datatypes for MPI Types
Packit Service c5cf8c
+I MPI_AINT - Datatype for an 'MPI_Aint'
Packit Service c5cf8c
. MPI_OFFSET - Datatype for an 'MPI_Offset'
Packit Service c5cf8c
- MPI_COUNT - Datatype for an 'MPI_Count'
Packit Service c5cf8c
Packit Service c5cf8c
 MPI Datatype Combiner Names:
Packit Service c5cf8c
+I MPI_COMBINER_NAMED            - a named predefined datatype
Packit Service c5cf8c
. MPI_COMBINER_DUP              - MPI_TYPE_DUP
Packit Service c5cf8c
. MPI_COMBINER_CONTIGUOUS       - MPI_TYPE_CONTIGUOUS
Packit Service c5cf8c
. MPI_COMBINER_VECTOR           - MPI_TYPE_VECTOR
Packit Service c5cf8c
. MPI_COMBINER_HVECTOR_INTEGER  - Removed in MPI-3
Packit Service c5cf8c
. MPI_COMBINER_HVECTOR          - MPI_TYPE_CREATE_HVECTOR
Packit Service c5cf8c
. MPI_COMBINER_INDEXED          - MPI_TYPE_INDEXED
Packit Service c5cf8c
. MPI_COMBINER_HINDEXED_INTEGER - Removed in MPI-3
Packit Service c5cf8c
. MPI_COMBINER_HINDEXED         - MPI_TYPE_CREATE_HINDEXED
Packit Service c5cf8c
. MPI_COMBINER_INDEXED_BLOCK    - MPI_TYPE_CREATE_INDEXED_BLOCK
Packit Service c5cf8c
. MPI_COMBINER_STRUCT_INTEGER   - Removed in MPI-3
Packit Service c5cf8c
. MPI_COMBINER_STRUCT           - MPI_TYPE_CREATE_STRUCT
Packit Service c5cf8c
. MPI_COMBINER_SUBARRAY         - MPI_TYPE_CREATE_SUBARRAY
Packit Service c5cf8c
. MPI_COMBINER_DARRAY           - MPI_TYPE_CREATE_DARRAY
Packit Service c5cf8c
. MPI_COMBINER_F90_REAL         - MPI_TYPE_CREATE_F90_REAL
Packit Service c5cf8c
. MPI_COMBINER_F90_COMPLEX      - MPI_TYPE_CREATE_F90_COMPLEX
Packit Service c5cf8c
. MPI_COMBINER_F90_INTEGER      - MPI_TYPE_CREATE_F90_INTEGER
Packit Service c5cf8c
. MPI_COMBINER_RESIZED          - MPI_TYPE_CREATE_RESIZED
Packit Service c5cf8c
- MPI_COMBINER_HINDEXED_BLOCK   - MPI_TYPE_CREATE_HINDEXED_BLOCK
Packit Service c5cf8c
Packit Service c5cf8c
 MPI Datatype Type Classes:
Packit Service c5cf8c
 MPI Type classes used with routines to return Fortran types with defined
Packit Service c5cf8c
 precision and range
Packit Service c5cf8c
+I MPI_TYPECLASS_REAL    - 'REAL'
Packit Service c5cf8c
. MPI_TYPECLASS_INTEGER - 'INTEGER'
Packit Service c5cf8c
- MPI_TYPECLASS_COMPLEX - 'COMPLEX'
Packit Service c5cf8c
Packit Service c5cf8c
 MPI Darray and Subarray Values:
Packit Service c5cf8c
 These values are used to create a datatype with the 'DARRAY' and 'SUBARRAY'
Packit Service c5cf8c
 constructors.
Packit Service c5cf8c
+I MPI_ORDER_C              - Row-major order (as used by C)
Packit Service c5cf8c
. MPI_ORDER_FORTRAN        - Column-major order (as used by Fortran)
Packit Service c5cf8c
. MPI_DISTRIBUTE_BLOCK     - Block distribution
Packit Service c5cf8c
. MPI_DISTRIBUTE_CYCLIC    - Cyclic distribution
Packit Service c5cf8c
. MPI_DISTRIBUTE_NONE      - This dimension is not distributed
Packit Service c5cf8c
- MPI_DISTRIBUTE_DFLT_DARG - Use the default distribution
Packit Service c5cf8c
Packit Service c5cf8c
 Communicators:
Packit Service c5cf8c
 Communicators are of type 'MPI_Comm' in C, 'INTEGER' in Fortran, and
Packit Service c5cf8c
 'Type(MPI_Comm)' in Fortran08
Packit Service c5cf8c
+I MPI_COMM_WORLD - Contains all of the processes
Packit Service c5cf8c
- MPI_COMM_SELF - Contains only the calling process
Packit Service c5cf8c
Packit Service c5cf8c
 Kind of communicator for 'MPI_COMM_SPLIT_TYPE':
Packit Service c5cf8c
.I MPI_COMM_TYPE_SHARED - All processes that can share memory are grouped into
Packit Service c5cf8c
 the same communicator.
Packit Service c5cf8c
Packit Service c5cf8c
 Groups:
Packit Service c5cf8c
 Groups are of type 'MPI_Group' in C, 'INTEGER' in Fortran,
Packit Service c5cf8c
 and 'Type(MPI_Group)' in Fortran08
Packit Service c5cf8c
Packit Service c5cf8c
.I MPI_GROUP_EMPTY - A group containing no members.
Packit Service c5cf8c
Packit Service c5cf8c
   Results of the compare operations on groups and communicators:
Packit Service c5cf8c
+I  MPI_IDENT - Identical
Packit Service c5cf8c
.  MPI_CONGRUENT  - (only for 'MPI_COMM_COMPARE') The groups are identical
Packit Service c5cf8c
.  MPI_SIMILAR - Same members, but in a different order
Packit Service c5cf8c
-  MPI_UNEQUAL - Different
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
 Collective operations:
Packit Service c5cf8c
 The collective combination operations (e.g., 'MPI_REDUCE', 'MPI_ALLREDUCE',
Packit Service c5cf8c
 'MPI_REDUCE_SCATTER', and 'MPI_SCAN') take a combination operation.
Packit Service c5cf8c
 This operation is of type 'MPI_Op' in C and of type 'INTEGER' in Fortran.
Packit Service c5cf8c
 The predefined operations are
Packit Service c5cf8c
Packit Service c5cf8c
+I  MPI_MAX - return the maximum
Packit Service c5cf8c
.  MPI_MIN - return the minumum
Packit Service c5cf8c
.  MPI_SUM - return the sum
Packit Service c5cf8c
.  MPI_PROD - return the product
Packit Service c5cf8c
.  MPI_LAND - return the logical and
Packit Service c5cf8c
.  MPI_BAND - return the bitwise and
Packit Service c5cf8c
.  MPI_LOR - return the logical or
Packit Service c5cf8c
.  MPI_BOR - return the bitwise of
Packit Service c5cf8c
.  MPI_LXOR - return the logical exclusive or
Packit Service c5cf8c
.  MPI_BXOR - return the bitwise exclusive or
Packit Service c5cf8c
.  MPI_MINLOC - return the minimum and the location (actually, the value of
Packit Service c5cf8c
                the second element of the structure where the minimum of
Packit Service c5cf8c
                the first is found)
Packit Service c5cf8c
.  MPI_MAXLOC - return the maximum and the location
Packit Service c5cf8c
.  MPI_REPLACE - replace b with a
Packit Service c5cf8c
-  MPI_NO_OP - perform no operation
Packit Service c5cf8c
Packit Service c5cf8c
Notes on collective operations:
Packit Service c5cf8c
Packit Service c5cf8c
The reduction functions ('MPI_Op') do not return an error value.  As a result,
Packit Service c5cf8c
if the functions detect an error, all they can do is either call 'MPI_Abort'
Packit Service c5cf8c
or silently skip the problem.  Thus, if you change the error handler from
Packit Service c5cf8c
'MPI_ERRORS_ARE_FATAL' to something else, for example, 'MPI_ERRORS_RETURN',
Packit Service c5cf8c
then no error may be indicated.
Packit Service c5cf8c
Packit Service c5cf8c
The reason for this is the performance problems in ensuring that
Packit Service c5cf8c
all collective routines return the same error value.
Packit Service c5cf8c
Packit Service c5cf8c
Note that not all datatypes are valid for these functions.  For example,
Packit Service c5cf8c
'MPI_COMPLEX' is not valid for 'MPI_MAX' and 'MPI_MIN'.  In addition, the MPI
Packit Service c5cf8c
1.1 standard did not include the C types 'MPI_CHAR' and 'MPI_UNSIGNED_CHAR'
Packit Service c5cf8c
among the lists of arithmetic types for operations like 'MPI_SUM'.  However,
Packit Service c5cf8c
since the C type 'char' is an integer type (like 'short'), it should have been
Packit Service c5cf8c
included.  The MPI Forum will probably include 'char' and 'unsigned char'
Packit Service c5cf8c
as a clarification to MPI 1.1; until then, users are advised that MPI
Packit Service c5cf8c
implementations may not accept 'MPI_CHAR' and 'MPI_UNSIGNED_CHAR' as valid
Packit Service c5cf8c
datatypes for 'MPI_SUM', 'MPI_PROD', etc.  MPICH does allow these datatypes.
Packit Service c5cf8c
Packit Service c5cf8c
 Permanent key values:
Packit Service c5cf8c
 These are the same in C and Fortran
Packit Service c5cf8c
Packit Service c5cf8c
+I MPI_TAG_UB - Largest tag value
Packit Service c5cf8c
. MPI_HOST - Rank of process that is host, if any
Packit Service c5cf8c
. MPI_IO - Rank of process that can do I/O
Packit Service c5cf8c
. MPI_WTIME_IS_GLOBAL - Has value 1 if 'MPI_WTIME' is globally synchronized.
Packit Service c5cf8c
. MPI_UNIVERSE_SIZE - Number of available processes.  See the standard for
Packit Service c5cf8c
   a description of limitations on this value
Packit Service c5cf8c
. MPI_LASTUSEDCODE - Last used MPI error code (check - code or class?)
Packit Service c5cf8c
- MPI_APPNUM - Application number, starting from 0.  See the standard for
Packit Service c5cf8c
 'MPI_COMM_SPAWN_MULTIPLE' and 'mpiexec' for details
Packit Service c5cf8c
Packit Service c5cf8c
  Null objects:
Packit Service c5cf8c
+I  MPI_COMM_NULL          - Null communicator
Packit Service c5cf8c
.  MPI_OP_NULL            - Null operation
Packit Service c5cf8c
.  MPI_GROUP_NULL         - Null group
Packit Service c5cf8c
.  MPI_DATATYPE_NULL      - Null datatype
Packit Service c5cf8c
.  MPI_REQUEST_NULL       - Null request
Packit Service c5cf8c
.  MPI_ERRHANDLER_NULL    - Null error handler
Packit Service c5cf8c
.  MPI_WIN_NULL           - Null window handle
Packit Service c5cf8c
.  MPI_FILE_NULL          - Null file handle
Packit Service c5cf8c
.  MPI_INFO_NULL          - Null info handle
Packit Service c5cf8c
.  MPI_MESSAGE_NULL       - Null message handle
Packit Service c5cf8c
.  MPI_ARGV_NULL          - Empty ARGV value for spawn commands
Packit Service c5cf8c
.  MPI_ARGVS_NULL         - Empty ARGV array for spawn-multiple command
Packit Service c5cf8c
.  MPI_T_ENUM_NULL        - Null MPI_T enum
Packit Service c5cf8c
.  MPI_T_CVAR_HANDLE_NULL - Null MPI_T control variable handle
Packit Service c5cf8c
.  MPI_T_PVAR_HANDLE_NULL - Null MPI_T performance variable handle
Packit Service c5cf8c
-  MPI_T_PVAR_SESSION_NULL- Null MPI_T performance variable session handle
Packit Service c5cf8c
Packit Service c5cf8c
 Predefined Constants:
Packit Service c5cf8c
+I MPI_MAX_PROCESSOR_NAME         - Maximum length of name returned by
Packit Service c5cf8c
 'MPI_GET_PROCESSOR_NAME'
Packit Service c5cf8c
. MPI_MAX_ERROR_STRING           - Maximum length of string return by
Packit Service c5cf8c
 'MPI_ERROR_STRING'
Packit Service c5cf8c
. MPI_MAX_LIBRARY_VERSION_STRING - Maximum length of string returned by
Packit Service c5cf8c
 'MPI_GET_LIBRARY_VERSION_STRING'???
Packit Service c5cf8c
. MPI_MAX_PORT_NAME              - Maximum length of a port
Packit Service c5cf8c
. MPI_MAX_OBJECT_NAME            - Maximum length of an object (?)
Packit Service c5cf8c
. MPI_MAX_INFO_KEY               - Maximum length of an info key
Packit Service c5cf8c
. MPI_MAX_INFO_VAL               - Maximum length of an info value
Packit Service c5cf8c
. MPI_UNDEFINED                  - Used by many routines to indicated
Packit Service c5cf8c
  undefined or unknown integer value
Packit Service c5cf8c
. MPI_UNDEFINED_RANK             - Unknown rank
Packit Service c5cf8c
. MPI_KEYVAL_INVALID             - Special keyval that may be used to detect
Packit Service c5cf8c
   uninitialized keyvals.
Packit Service c5cf8c
. MPI_BSEND_OVERHEAD             - Add this to the size of a 'MPI_BSEND'
Packit Service c5cf8c
   buffer for each outstanding message
Packit Service c5cf8c
. MPI_PROC_NULL                  - This rank may be used to send or receive from no-one.
Packit Service c5cf8c
. MPI_ANY_SOURCE                 - In a receive, accept a message from anyone.
Packit Service c5cf8c
. MPI_ANY_TAG                    - In a receive, accept a message with any tag value.
Packit Service c5cf8c
. MPI_BOTTOM                     - May be used to indicate the bottom of the address space
Packit Service c5cf8c
. MPI_IN_PLACE                   - Special location for buffer in some
Packit Service c5cf8c
  collective communication routines
Packit Service c5cf8c
. MPI_VERSION                    - Numeric value of MPI version (e.g., 3)
Packit Service c5cf8c
- MPI_SUBVERSION                 - Numeric value of MPI subversion (e.g., 1)
Packit Service c5cf8c
Packit Service c5cf8c
  Topology types:
Packit Service c5cf8c
+I MPI_CART       - Cartesian grid
Packit Service c5cf8c
. MPI_GRAPH      - General graph
Packit Service c5cf8c
- MPI_DIST_GRAPH - General distributed graph
Packit Service c5cf8c
Packit Service c5cf8c
  Special values for distributed graph:
Packit Service c5cf8c
+I MPI_UNWEIGHTED    - Indicates that the edges are unweighted
Packit Service c5cf8c
- MPI_WEIGHTS_EMPTY - Special address that indicates no array of weights
Packit Service c5cf8c
 information
Packit Service c5cf8c
Packit Service c5cf8c
 File Modes:
Packit Service c5cf8c
+I MPI_MODE_RDONLY          - Read only
Packit Service c5cf8c
. MPI_MODE_RDWR            - Read and write
Packit Service c5cf8c
. MPI_MODE_WRONLY          - Write only
Packit Service c5cf8c
. MPI_MODE_CREATE          - Create the file if it does not exist
Packit Service c5cf8c
. MPI_MODE_EXCL            - It is an error if creating a file that already
Packit Service c5cf8c
 exists
Packit Service c5cf8c
. MPI_MODE_DELETE_ON_CLOSE - Delete the file on close
Packit Service c5cf8c
. MPI_MODE_UNIQUE_OPEN     - The file will not be concurrently opened elsewhere
Packit Service c5cf8c
. MPI_MODE_APPEND          - The initial position of all file pointers is at
Packit Service c5cf8c
 the end of the file
Packit Service c5cf8c
- MPI_MODE_SEQUENTIAL      - File will only be accessed sequentially
Packit Service c5cf8c
Packit Service c5cf8c
 File Displacement:
Packit Service c5cf8c
.I MPI_DISPLACEMENT_CURRENT - Use with files opened with mode
Packit Service c5cf8c
 'MPI_MODE_SEQUENTIAL' in calls to 'MPI_FILE_SET_VIEW'
Packit Service c5cf8c
Packit Service c5cf8c
File Positioning:
Packit Service c5cf8c
+I MPI_SEEK_SET             - Set the pointer to 'offset'
Packit Service c5cf8c
. MPI_SEEK_CUR             - Set the pointer to the current position plus 'offset'
Packit Service c5cf8c
- MPI_SEEK_END             - Set the pointer to the end of the file plus 'offset'
Packit Service c5cf8c
Packit Service c5cf8c
Window attributes:
Packit Service c5cf8c
+I MPI_WIN_BASE - window base address.
Packit Service c5cf8c
. MPI_WIN_SIZE - window size, in bytes
Packit Service c5cf8c
. MPI_WIN_DISP_UNIT - displacement unit associated with the window
Packit Service c5cf8c
. MPI_WIN_CREATE_FLAVOR - how the window was created
Packit Service c5cf8c
- MPI_WIN_MODEL - memory model for window
Packit Service c5cf8c
Packit Service c5cf8c
Window flavors:
Packit Service c5cf8c
+I MPI_WIN_FLAVOR_CREATE   - Window was created with MPI_WIN_CREATE.
Packit Service c5cf8c
. MPI_WIN_FLAVOR_ALLOCATE - Window was created with MPI_WIN_ALLOCATE.
Packit Service c5cf8c
. MPI_WIN_FLAVOR_DYNAMIC  - Window was created with MPI_WIN_CREATE_DYNAMIC.
Packit Service c5cf8c
- MPI_WIN_FLAVOR_SHARED   - Window was created with MPI_WIN_ALLOCATE_SHARED.
Packit Service c5cf8c
Packit Service c5cf8c
Window Memory Model:
Packit Service c5cf8c
+I MPI_WIN_SEPARATE - Separate public and private copies of window memory
Packit Service c5cf8c
- MPI_WIN_UNIFIED - The publich and private copies are identical (by which
Packit Service c5cf8c
 we mean that updates are eventually observed without additional RMA operations)
Packit Service c5cf8c
Packit Service c5cf8c
Window Lock Types:
Packit Service c5cf8c
+I MPI_LOCK_EXCLUSIVE - Only one process at a time will execute accesses
Packit Service c5cf8c
 within the lock
Packit Service c5cf8c
- MPI_LOCK_SHARED - Not exclusive; multiple processes may execute accesses
Packit Service c5cf8c
 within the lock
Packit Service c5cf8c
Packit Service c5cf8c
Window Assertions:
Packit Service c5cf8c
 See section 11.5 in MPI 3.1 for a detailed description of each of these
Packit Service c5cf8c
 assertion values.
Packit Service c5cf8c
+I MPI_MODE_NOCHECK      - The matching calls to MPI_WIN_POST or MPI_WIN_START
Packit Service c5cf8c
 have already completed, or no process holds or will attempt to acquire, a
Packit Service c5cf8c
 conflicting lock.
Packit Service c5cf8c
. MPI_MODE_NOSTORE      - The local window has not been updated by stores
Packit Service c5cf8c
 since the last synchronization
Packit Service c5cf8c
. MPI_MODE_NOPUT        - The local window will not be updated by put or
Packit Service c5cf8c
 accumulate until the next synchronization
Packit Service c5cf8c
. MPI_MODE_NOPRECEDE    - The fence does not complete any locally issued RMA
Packit Service c5cf8c
 calls
Packit Service c5cf8c
- MPI_MODE_NOSUCCEED    - The fence does not start any locally issued RMA calls
Packit Service c5cf8c
Packit Service c5cf8c
Predefined Info Object:
Packit Service c5cf8c
.I MPI_INFO_ENV - Contains the execution environment
Packit Service c5cf8c
Packit Service c5cf8c
 MPI Status:
Packit Service c5cf8c
 The 'MPI_Status' datatype is a structure in C.  The three elements for use
Packit Service c5cf8c
 by programmers are
Packit Service c5cf8c
+I  MPI_SOURCE - Who sent the message
Packit Service c5cf8c
.  MPI_TAG - What tag the message was sent with
Packit Service c5cf8c
-  MPI_ERROR - Any error return (only when the error returned by the routine
Packit Service c5cf8c
  has error class 'MPI_ERR_IN_STATUS')
Packit Service c5cf8c
Packit Service c5cf8c
+I MPI_STATUS_IGNORE   - Ignore a single 'MPI_Status' argument
Packit Service c5cf8c
- MPI_STATUSES_IGNORE - Ignore an array of 'MPI_Status'
Packit Service c5cf8c
Packit Service c5cf8c
Special value for error codes array:
Packit Service c5cf8c
.I MPI_ERRCODES_IGNORE - Ignore an array of error codes
Packit Service c5cf8c
Packit Service c5cf8c
 MPI_T Constants:
Packit Service c5cf8c
+I    MPI_T_VERBOSITY_USER_BASIC     - Basic information of interest to users
Packit Service c5cf8c
.    MPI_T_VERBOSITY_USER_DETAIL    - Detailed information of interest to users
Packit Service c5cf8c
.    MPI_T_VERBOSITY_USER_ALL       - All remaining information of interest to users
Packit Service c5cf8c
.    MPI_T_VERBOSITY_TUNER_BASIC    - Basic information required for tuning
Packit Service c5cf8c
.    MPI_T_VERBOSITY_TUNER_DETAIL   - Detailed information required for tuning
Packit Service c5cf8c
.    MPI_T_VERBOSITY_TUNER_ALL      - All remaining information required for tuning
Packit Service c5cf8c
.    MPI_T_VERBOSITY_MPIDEV_BASIC   - Basic information for MPI implementors
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
.    MPI_T_VERBOSITY_MPIDEV_DETAIL  - Detailed information for MPI implementors
Packit Service c5cf8c
.    MPI_T_VERBOSITY_MPIDEV_ALL     - All remaining information for MPI implementors
Packit Service c5cf8c
.    MPI_T_BIND_NO_OBJECT           - Applies globally to entire MPI process
Packit Service c5cf8c
.    MPI_T_BIND_MPI_COMM            - MPI communicators
Packit Service c5cf8c
.    MPI_T_BIND_MPI_DATATYPE        - MPI datatypes
Packit Service c5cf8c
.    MPI_T_BIND_MPI_ERRHANDLER      - MPI error handlers
Packit Service c5cf8c
.    MPI_T_BIND_MPI_FILE            - MPI file handles
Packit Service c5cf8c
.    MPI_T_BIND_MPI_GROUP           - MPI groups
Packit Service c5cf8c
.    MPI_T_BIND_MPI_OP              - MPI reduction operators
Packit Service c5cf8c
.    MPI_T_BIND_MPI_REQUEST         - MPI requests
Packit Service c5cf8c
.    MPI_T_BIND_MPI_WIN             - MPI windows for one-sided communication
Packit Service c5cf8c
.    MPI_T_BIND_MPI_MESSAGE         - MPI message object
Packit Service c5cf8c
.    MPI_T_BIND_MPI_INFO            - MPI info object
Packit Service c5cf8c
.    MPI_T_SCOPE_CONSTANT           -read-only, value is constant
Packit Service c5cf8c
.    MPI_T_SCOPE_READONLY           - read-only, cannot be written, but can
Packit Service c5cf8c
 change
Packit Service c5cf8c
.    MPI_T_SCOPE_LOCAL              - may be writeable, writing is a local
Packit Service c5cf8c
 operation
Packit Service c5cf8c
.    MPI_T_SCOPE_GROUP              - may be writeable, must be done to a
Packit Service c5cf8c
 group of processes, all processes in a group must be set to consistent values
Packit Service c5cf8c
.    MPI_T_SCOPE_GROUP_EQ           - may be writeable, must be done to a
Packit Service c5cf8c
 group of processes, all processes in a group must be set to the same value
Packit Service c5cf8c
.    MPI_T_SCOPE_ALL                - may be writeable, must be done to all
Packit Service c5cf8c
 processes, all connected processes must be set to consistent values
Packit Service c5cf8c
.    MPI_T_SCOPE_ALL_EQ             - may be writeable, must be done to all
Packit Service c5cf8c
 processes, all connected processes must be set to the same value
Packit Service c5cf8c
.    MPI_T_PVAR_CLASS_STATE         - set of discrete states (MPI_INT)
Packit Service c5cf8c
.    MPI_T_PVAR_CLASS_LEVEL         - utilization level of a resource
Packit Service c5cf8c
.    MPI_T_PVAR_CLASS_SIZE          - size of a resource
Packit Service c5cf8c
.    MPI_T_PVAR_CLASS_PERCENTAGE    - percentage utilization of a resource
Packit Service c5cf8c
.    MPI_T_PVAR_CLASS_HIGHWATERMARK - high watermark of a resource
Packit Service c5cf8c
.    MPI_T_PVAR_CLASS_LOWWATERMARK  - low watermark of a resource
Packit Service c5cf8c
.    MPI_T_PVAR_CLASS_COUNTER       - number of occurances of an event
Packit Service c5cf8c
.    MPI_T_PVAR_CLASS_AGGREGATE     - aggregate value over an event (e.g.,
Packit Service c5cf8c
 sum of all memory allocations)
Packit Service c5cf8c
.    MPI_T_PVAR_CLASS_TIMER         - aggretate time spent executing event
Packit Service c5cf8c
-    MPI_T_PVAR_CLASS_GENERIC       - used for any other time of performance
Packit Service c5cf8c
 variable
Packit Service c5cf8c
Packit Service c5cf8c
 Thread levels:
Packit Service c5cf8c
+I MPI_THREAD_SINGLE     - Only one thread executes
Packit Service c5cf8c
. MPI_THREAD_FUNNELED   - Only the main thread makes MPI calls
Packit Service c5cf8c
. MPI_THREAD_SERIALIZED - Only one thread at a time makes MPI calls
Packit Service c5cf8c
- MPI_THREAD_MULTIPLE   - Multiple threads may make MPI calls
Packit Service c5cf8c
Packit Service c5cf8c
 Special MPI types and functions:
Packit Service c5cf8c
Packit Service c5cf8c
+I MPI_Aint   - C type that holds any valid address.
Packit Service c5cf8c
. MPI_Count  - C type that holds any valid count.
Packit Service c5cf8c
. MPI_Offset - C type that holds any valid file offset.
Packit Service c5cf8c
. MPI_Handler_function - C function for handling errors (see
Packit Service c5cf8c
 'MPI_Errhandler_create') .
Packit Service c5cf8c
. MPI_User_function - C function to combine values (see collective operations
Packit Service c5cf8c
 and 'MPI_Op_create')
Packit Service c5cf8c
. MPI_Copy_function - Function to copy attributes (see 'MPI_Keyval_create')
Packit Service c5cf8c
. MPI_Delete_function - Function to delete attributes (see 'MPI_Keyval_create')
Packit Service c5cf8c
. MPI_ERRORS_ARE_FATAL - Error handler that forces exit on error
Packit Service c5cf8c
- MPI_ERRORS_RETURN - Error handler that returns error codes (as value of
Packit Service c5cf8c
 MPI routine in C and through last argument in Fortran)
Packit Service c5cf8c
Packit Service c5cf8c
 MPI Attribute Default Functions:
Packit Service c5cf8c
+I MPI_COMM_NULL_COPY_FN - Predefined attribute copy function for communicators
Packit Service c5cf8c
. MPI_COMM_NULL_DELETE_FN - Predefined attribute delete function for communicators
Packit Service c5cf8c
. MPI_COMM_DUP_FN  - Predefined attribute duplicate function for communicators
Packit Service c5cf8c
. MPI_WIN_NULL_COPY_FN - Predefined attribute copy function for windows
Packit Service c5cf8c
. MPI_WIN_NULL_DELETE_FN - Predefined attribute delete function for windows
Packit Service c5cf8c
. MPI_WIN_DUP_FN   - Predefined attribute duplicate function for windows
Packit Service c5cf8c
. MPI_TYPE_NULL_COPY_FN - Predefined attribute copy function for datatypes
Packit Service c5cf8c
. MPI_TYPE_NULL_DELETE_FN - Predefined attribute delete function for datatypes
Packit Service c5cf8c
- MPI_TYPE_DUP_FN - Predefined attribute duplicate function for datatypes
Packit Service c5cf8c
Packit Service c5cf8c
 MPI-1 Attribute Default Functions:
Packit Service c5cf8c
+I MPI_NULL_COPY_FN - Predefined copy function
Packit Service c5cf8c
. MPI_NULL_DELETE_FN - Predefined delete function
Packit Service c5cf8c
- MPI_DUP_FN - Predefined duplication function
Packit Service c5cf8c
Packit Service c5cf8c
 MPI Error classes:
Packit Service c5cf8c
+I   MPI_SUCCESS               - Successful return code
Packit Service c5cf8c
.   MPI_ERR_BUFFER            - Invalid buffer pointer
Packit Service c5cf8c
.   MPI_ERR_COUNT             - Invalid count argument
Packit Service c5cf8c
.   MPI_ERR_TYPE              - Invalid datatype argument
Packit Service c5cf8c
.   MPI_ERR_TAG               - Invalid tag argument
Packit Service c5cf8c
.   MPI_ERR_COMM              - Invalid communicator
Packit Service c5cf8c
.   MPI_ERR_RANK              - Invalid rank
Packit Service c5cf8c
.   MPI_ERR_ROOT              - Invalid root
Packit Service c5cf8c
.   MPI_ERR_GROUP             - Null group passed to function
Packit Service c5cf8c
.   MPI_ERR_OP                - Invalid operation
Packit Service c5cf8c
.   MPI_ERR_TOPOLOGY          - Invalid topology
Packit Service c5cf8c
.   MPI_ERR_DIMS              - Illegal dimension argument
Packit Service c5cf8c
.   MPI_ERR_ARG               - Invalid argument
Packit Service c5cf8c
.   MPI_ERR_UNKNOWN           - Unknown error
Packit Service c5cf8c
.   MPI_ERR_TRUNCATE          - Message truncated on receive
Packit Service c5cf8c
.   MPI_ERR_OTHER             - Other error; use Error_string
Packit Service c5cf8c
.   MPI_ERR_INTERN            - Internal error code
Packit Service c5cf8c
.   MPI_ERR_IN_STATUS         - Look in status for error value
Packit Service c5cf8c
.   MPI_ERR_PENDING           - Pending request
Packit Service c5cf8c
.   MPI_ERR_REQUEST           - Invalid mpi_request handle
Packit Service c5cf8c
.   MPI_ERR_ACCESS            - Permission denied
Packit Service c5cf8c
.   MPI_ERR_AMODE             - Error related to the amode passed to
Packit Service c5cf8c
 'MPI_FILE_OPEN'
Packit Service c5cf8c
.   MPI_ERR_BAD_FILE          - Invalid file name (e.g., path name too long)
Packit Service c5cf8c
.   MPI_ERR_CONVERSION        - An error occurred in a user supplied data
Packit Service c5cf8c
 conversion function
Packit Service c5cf8c
.   MPI_ERR_DUP_DATAREP       - Conversion functions could not be registered
Packit Service c5cf8c
 because a data representation identifier that was already defined was passed
Packit Service c5cf8c
 to 'MPI_REGISTER_DATAREP'
Packit Service c5cf8c
.   MPI_ERR_FILE_EXISTS       - File exists
Packit Service c5cf8c
.   MPI_ERR_FILE_IN_USE       - File operation could not be completed, as
Packit Service c5cf8c
 the file is currently open by some process
Packit Service c5cf8c
.   MPI_ERR_FILE              - Invalid file handle
Packit Service c5cf8c
.   MPI_ERR_IO                - Other I/O error
Packit Service c5cf8c
.   MPI_ERR_NO_SPACE          - Not enough space
Packit Service c5cf8c
.   MPI_ERR_NO_SUCH_FILE      - File does not exist
Packit Service c5cf8c
.   MPI_ERR_READ_ONLY         - Read-only file or file system
Packit Service c5cf8c
.   MPI_ERR_UNSUPPORTED_DATAREP - Unsupported datarep passed to
Packit Service c5cf8c
 'MPI_FILE_SET_VIEW'
Packit Service c5cf8c
.   MPI_ERR_INFO              - Invalid info argument
Packit Service c5cf8c
.   MPI_ERR_INFO_KEY          - Key longer than MPI_MAX_INFO_KEY
Packit Service c5cf8c
.   MPI_ERR_INFO_VALUE        - Value longer than MPI_MAX_INFO_VAL
Packit Service c5cf8c
.   MPI_ERR_INFO_NOKEY        - Invalid key passed to MPI_INFO_DELETE
Packit Service c5cf8c
.   MPI_ERR_NAME              - Invalid service name passed to MPI_LOOKUP_NAME
Packit Service c5cf8c
.   MPI_ERR_NO_MEM            - Alloc_mem could not allocate memory
Packit Service c5cf8c
.   MPI_ERR_NOT_SAME          - Collective argument not identical on all
Packit Service c5cf8c
 processes, or collective routines called in a different order by different
Packit Service c5cf8c
 processes
Packit Service c5cf8c
.   MPI_ERR_PORT              - Invalid port name passed to MPI_COMM_CONNECT
Packit Service c5cf8c
.   MPI_ERR_QUOTA             - Quota exceeded
Packit Service c5cf8c
.   MPI_ERR_SERVICE           - Invalid service name passed to MPI_UNPUBLISH_NAME
Packit Service c5cf8c
.   MPI_ERR_SPAWN             - Error in spawning processes
Packit Service c5cf8c
.   MPI_ERR_UNSUPPORTED_OPERATION - Unsupported operation, such as seeking on
Packit Service c5cf8c
 a file which supports sequential access only
Packit Service c5cf8c
.   MPI_ERR_WIN               - Invalid win argument
Packit Service c5cf8c
.   MPI_ERR_BASE              - Invalid base passed to MPI_FREE_MEM
Packit Service c5cf8c
.   MPI_ERR_LOCKTYPE          - Invalid locktype argument
Packit Service c5cf8c
.   MPI_ERR_KEYVAL            - Erroneous attribute key
Packit Service c5cf8c
.   MPI_ERR_RMA_CONFLICT      - Conflicting accesses to window
Packit Service c5cf8c
.   MPI_ERR_RMA_SYNC          - Wrong synchronization of RMA calls
Packit Service c5cf8c
.   MPI_ERR_SIZE              - Invalid size argument
Packit Service c5cf8c
.   MPI_ERR_DISP              - Invalid disp argument
Packit Service c5cf8c
.   MPI_ERR_ASSERT            - Invalid assert argument
Packit Service c5cf8c
.   MPI_ERR_RMA_RANGE         - Target memory is not part of the window (in
Packit Service c5cf8c
 the case of a window created with MPI_WIN_CREATE_DYNAMIC, target memory is
Packit Service c5cf8c
 not attached)
Packit Service c5cf8c
.   MPI_ERR_RMA_ATTACH        - Memory cannot be attached (e.g., because of
Packit Service c5cf8c
 resource exhaustion)
Packit Service c5cf8c
.   MPI_ERR_RMA_SHARED        - Memory cannot be shared (e.g., some process in
Packit Service c5cf8c
 the group of the specified communicator cannot expose shared memory)
Packit Service c5cf8c
.   MPI_ERR_RMA_FLAVOR        - Passed window has the wrong flavor for the
Packit Service c5cf8c
 called function
Packit Service c5cf8c
-   MPI_ERR_LASTCODE          - Last error code -- always at end
Packit Service c5cf8c
Packit Service c5cf8c
Error codes for MPI_T:
Packit Service c5cf8c
Packit Service c5cf8c
+I MPI_T_ERR_MEMORY            - Out of memory
Packit Service c5cf8c
. MPI_T_ERR_NOT_INITIALIZED   - Interface not initialized
Packit Service c5cf8c
. MPI_T_ERR_CANNOT_INIT       - Interface not in the state to be initialized
Packit Service c5cf8c
. MPI_T_ERR_INVALID_INDEX     - The index is invalid or has been deleted
Packit Service c5cf8c
. MPI_T_ERR_INVALID_ITEM      - Item index queried is out of range
Packit Service c5cf8c
. MPI_T_ERR_INVALID_HANDLE    - The handle is invalid
Packit Service c5cf8c
. MPI_T_ERR_OUT_OF_HANDLES    - No more handles available
Packit Service c5cf8c
. MPI_T_ERR_OUT_OF_SESSIONS   - No more sessions available
Packit Service c5cf8c
. MPI_T_ERR_INVALID_SESSION   - Session argument is not valid
Packit Service c5cf8c
. MPI_T_ERR_CVAR_SET_NOT_NOW  - Cvar can''t be set at this moment
Packit Service c5cf8c
. MPI_T_ERR_CVAR_SET_NEVER    - Cvar can''t be set until end of execution
Packit Service c5cf8c
. MPI_T_ERR_PVAR_NO_STARTSTOP - Pvar can''t be started or stopped
Packit Service c5cf8c
. MPI_T_ERR_PVAR_NO_WRITE     - Pvar can''t be written or reset
Packit Service c5cf8c
. MPI_T_ERR_PVAR_NO_ATOMIC    - Pvar can''t be R/W atomically
Packit Service c5cf8c
. MPI_T_ERR_INVALID_NAME      - Name doesn''t match
Packit Service c5cf8c
- MPI_T_ERR_INVALID           - Invalid use of the interface or bad parameter
Packit Service c5cf8c
 values(s)
Packit Service c5cf8c
Packit Service c5cf8c
D*/