- •Contents
- •List of Figures
- •List of Tables
- •Acknowledgments
- •Introduction to MPI
- •Overview and Goals
- •Background of MPI-1.0
- •Background of MPI-1.1, MPI-1.2, and MPI-2.0
- •Background of MPI-1.3 and MPI-2.1
- •Background of MPI-2.2
- •Who Should Use This Standard?
- •What Platforms Are Targets For Implementation?
- •What Is Included In The Standard?
- •What Is Not Included In The Standard?
- •Organization of this Document
- •MPI Terms and Conventions
- •Document Notation
- •Naming Conventions
- •Semantic Terms
- •Data Types
- •Opaque Objects
- •Array Arguments
- •State
- •Named Constants
- •Choice
- •Addresses
- •Language Binding
- •Deprecated Names and Functions
- •Fortran Binding Issues
- •C Binding Issues
- •C++ Binding Issues
- •Functions and Macros
- •Processes
- •Error Handling
- •Implementation Issues
- •Independence of Basic Runtime Routines
- •Interaction with Signals
- •Examples
- •Point-to-Point Communication
- •Introduction
- •Blocking Send and Receive Operations
- •Blocking Send
- •Message Data
- •Message Envelope
- •Blocking Receive
- •Return Status
- •Passing MPI_STATUS_IGNORE for Status
- •Data Type Matching and Data Conversion
- •Type Matching Rules
- •Type MPI_CHARACTER
- •Data Conversion
- •Communication Modes
- •Semantics of Point-to-Point Communication
- •Buffer Allocation and Usage
- •Nonblocking Communication
- •Communication Request Objects
- •Communication Initiation
- •Communication Completion
- •Semantics of Nonblocking Communications
- •Multiple Completions
- •Non-destructive Test of status
- •Probe and Cancel
- •Persistent Communication Requests
- •Send-Receive
- •Null Processes
- •Datatypes
- •Derived Datatypes
- •Type Constructors with Explicit Addresses
- •Datatype Constructors
- •Subarray Datatype Constructor
- •Distributed Array Datatype Constructor
- •Address and Size Functions
- •Lower-Bound and Upper-Bound Markers
- •Extent and Bounds of Datatypes
- •True Extent of Datatypes
- •Commit and Free
- •Duplicating a Datatype
- •Use of General Datatypes in Communication
- •Correct Use of Addresses
- •Decoding a Datatype
- •Examples
- •Pack and Unpack
- •Canonical MPI_PACK and MPI_UNPACK
- •Collective Communication
- •Introduction and Overview
- •Communicator Argument
- •Applying Collective Operations to Intercommunicators
- •Barrier Synchronization
- •Broadcast
- •Example using MPI_BCAST
- •Gather
- •Examples using MPI_GATHER, MPI_GATHERV
- •Scatter
- •Examples using MPI_SCATTER, MPI_SCATTERV
- •Example using MPI_ALLGATHER
- •All-to-All Scatter/Gather
- •Global Reduction Operations
- •Reduce
- •Signed Characters and Reductions
- •MINLOC and MAXLOC
- •All-Reduce
- •Process-local reduction
- •Reduce-Scatter
- •MPI_REDUCE_SCATTER_BLOCK
- •MPI_REDUCE_SCATTER
- •Scan
- •Inclusive Scan
- •Exclusive Scan
- •Example using MPI_SCAN
- •Correctness
- •Introduction
- •Features Needed to Support Libraries
- •MPI's Support for Libraries
- •Basic Concepts
- •Groups
- •Contexts
- •Intra-Communicators
- •Group Management
- •Group Accessors
- •Group Constructors
- •Group Destructors
- •Communicator Management
- •Communicator Accessors
- •Communicator Constructors
- •Communicator Destructors
- •Motivating Examples
- •Current Practice #1
- •Current Practice #2
- •(Approximate) Current Practice #3
- •Example #4
- •Library Example #1
- •Library Example #2
- •Inter-Communication
- •Inter-communicator Accessors
- •Inter-communicator Operations
- •Inter-Communication Examples
- •Caching
- •Functionality
- •Communicators
- •Windows
- •Datatypes
- •Error Class for Invalid Keyval
- •Attributes Example
- •Naming Objects
- •Formalizing the Loosely Synchronous Model
- •Basic Statements
- •Models of Execution
- •Static communicator allocation
- •Dynamic communicator allocation
- •The General case
- •Process Topologies
- •Introduction
- •Virtual Topologies
- •Embedding in MPI
- •Overview of the Functions
- •Topology Constructors
- •Cartesian Constructor
- •Cartesian Convenience Function: MPI_DIMS_CREATE
- •General (Graph) Constructor
- •Distributed (Graph) Constructor
- •Topology Inquiry Functions
- •Cartesian Shift Coordinates
- •Partitioning of Cartesian structures
- •Low-Level Topology Functions
- •An Application Example
- •MPI Environmental Management
- •Implementation Information
- •Version Inquiries
- •Environmental Inquiries
- •Tag Values
- •Host Rank
- •IO Rank
- •Clock Synchronization
- •Memory Allocation
- •Error Handling
- •Error Handlers for Communicators
- •Error Handlers for Windows
- •Error Handlers for Files
- •Freeing Errorhandlers and Retrieving Error Strings
- •Error Codes and Classes
- •Error Classes, Error Codes, and Error Handlers
- •Timers and Synchronization
- •Startup
- •Allowing User Functions at Process Termination
- •Determining Whether MPI Has Finished
- •Portable MPI Process Startup
- •The Info Object
- •Process Creation and Management
- •Introduction
- •The Dynamic Process Model
- •Starting Processes
- •The Runtime Environment
- •Process Manager Interface
- •Processes in MPI
- •Starting Processes and Establishing Communication
- •Reserved Keys
- •Spawn Example
- •Manager-worker Example, Using MPI_COMM_SPAWN.
- •Establishing Communication
- •Names, Addresses, Ports, and All That
- •Server Routines
- •Client Routines
- •Name Publishing
- •Reserved Key Values
- •Client/Server Examples
- •Ocean/Atmosphere - Relies on Name Publishing
- •Simple Client-Server Example.
- •Other Functionality
- •Universe Size
- •Singleton MPI_INIT
- •MPI_APPNUM
- •Releasing Connections
- •Another Way to Establish MPI Communication
- •One-Sided Communications
- •Introduction
- •Initialization
- •Window Creation
- •Window Attributes
- •Communication Calls
- •Examples
- •Accumulate Functions
- •Synchronization Calls
- •Fence
- •General Active Target Synchronization
- •Lock
- •Assertions
- •Examples
- •Error Handling
- •Error Handlers
- •Error Classes
- •Semantics and Correctness
- •Atomicity
- •Progress
- •Registers and Compiler Optimizations
- •External Interfaces
- •Introduction
- •Generalized Requests
- •Examples
- •Associating Information with Status
- •MPI and Threads
- •General
- •Initialization
- •Introduction
- •File Manipulation
- •Opening a File
- •Closing a File
- •Deleting a File
- •Resizing a File
- •Preallocating Space for a File
- •Querying the Size of a File
- •Querying File Parameters
- •File Info
- •Reserved File Hints
- •File Views
- •Data Access
- •Data Access Routines
- •Positioning
- •Synchronism
- •Coordination
- •Data Access Conventions
- •Data Access with Individual File Pointers
- •Data Access with Shared File Pointers
- •Noncollective Operations
- •Collective Operations
- •Seek
- •Split Collective Data Access Routines
- •File Interoperability
- •Datatypes for File Interoperability
- •Extent Callback
- •Datarep Conversion Functions
- •Matching Data Representations
- •Consistency and Semantics
- •File Consistency
- •Random Access vs. Sequential Files
- •Progress
- •Collective File Operations
- •Type Matching
- •Logical vs. Physical File Layout
- •File Size
- •Examples
- •Asynchronous I/O
- •I/O Error Handling
- •I/O Error Classes
- •Examples
- •Subarray Filetype Constructor
- •Requirements
- •Discussion
- •Logic of the Design
- •Examples
- •MPI Library Implementation
- •Systems with Weak Symbols
- •Systems Without Weak Symbols
- •Complications
- •Multiple Counting
- •Linker Oddities
- •Multiple Levels of Interception
- •Deprecated Functions
- •Deprecated since MPI-2.0
- •Deprecated since MPI-2.2
- •Language Bindings
- •Overview
- •Design
- •C++ Classes for MPI
- •Class Member Functions for MPI
- •Semantics
- •C++ Datatypes
- •Communicators
- •Exceptions
- •Mixed-Language Operability
- •Problems With Fortran Bindings for MPI
- •Problems Due to Strong Typing
- •Problems Due to Data Copying and Sequence Association
- •Special Constants
- •Fortran 90 Derived Types
- •A Problem with Register Optimization
- •Basic Fortran Support
- •Extended Fortran Support
- •The mpi Module
- •No Type Mismatch Problems for Subroutines with Choice Arguments
- •Additional Support for Fortran Numeric Intrinsic Types
- •Language Interoperability
- •Introduction
- •Assumptions
- •Initialization
- •Transfer of Handles
- •Status
- •MPI Opaque Objects
- •Datatypes
- •Callback Functions
- •Error Handlers
- •Reduce Operations
- •Addresses
- •Attributes
- •Extra State
- •Constants
- •Interlanguage Communication
- •Language Bindings Summary
- •Groups, Contexts, Communicators, and Caching Fortran Bindings
- •External Interfaces C++ Bindings
- •Change-Log
- •Bibliography
- •Examples Index
- •MPI Declarations Index
- •MPI Function Index
586 |
ANNEX A. LANGUAGE BINDINGS SUMMARY |
1A.4.10 External Interfaces C++ Bindings
2
3
4
5
6
7
8
9
10
11
namespace MPI {
fvoid Grequest::Complete() (binding deprecated, see Section 15.2) g fint Init_thread(int required) (binding deprecated, see Section 15.2) g
fint Init_thread(int& argc, char**& argv, int required) (binding deprecated, see Section 15.2) g
fbool Is_thread_main() (binding deprecated, see Section 15.2) g
12fint Query_thread() (binding deprecated, see Section 15.2) g
13fvoid Status::Set_cancelled(bool flag) (binding deprecated, see Section 15.2) g
14
15
16
17
18
19
20
21
22
fvoid Status::Set_elements(const Datatype& datatype, int count) (binding deprecated, see Section 15.2) g
fstatic Grequest Grequest::Start(const Grequest::Query_function*
query_fn, const Grequest::Free_function* free_fn,
const Grequest::Cancel_function* cancel_fn, void *extra_state)
(binding deprecated, see Section 15.2) g
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
};
A.4.11 I/O C++ Bindings
namespace MPI {
fvoid File::Close() (binding deprecated, see Section 15.2) g
fstatic void File::Delete(const char* filename, const Info& info) (binding deprecated, see Section 15.2) g
fint File::Get_amode() const (binding deprecated, see Section 15.2) g
fbool File::Get_atomicity() const (binding deprecated, see Section 15.2) g
fOffset File::Get_byte_offset(const Offset disp) const (binding deprecated, see Section 15.2) g
fGroup File::Get_group() const (binding deprecated, see Section 15.2) g
fInfo File::Get_info() const (binding deprecated, see Section 15.2) g
fOffset File::Get_position() const (binding deprecated, see Section 15.2) g
fOffset File::Get_position_shared() const (binding deprecated, see Section 15.2) g
fOffset File::Get_size() const (binding deprecated, see Section 15.2) g
fAint File::Get_type_extent(const Datatype& datatype) const (binding deprecated, see Section 15.2) g
48
A.4. C++ BINDINGS (DEPRECATED) |
587 |
fvoid File::Get_view(Offset& disp, Datatype& etype, Datatype& filetype, char* datarep) const (binding deprecated, see Section 15.2) g
fRequest File::Iread(void* buf, int count, const Datatype& datatype)
(binding deprecated, see Section 15.2) g
fRequest File::Iread_at(Offset offset, void* buf, int count,
const Datatype& datatype) (binding deprecated, see Section 15.2) g
fRequest File::Iread_shared(void* buf, int count,
const Datatype& datatype) (binding deprecated, see Section 15.2) g
fRequest File::Iwrite(const void* buf, int count,
const Datatype& datatype) (binding deprecated, see Section 15.2) g
fRequest File::Iwrite_at(Offset offset, const void* buf, int count, const Datatype& datatype) (binding deprecated, see Section 15.2) g
fRequest File::Iwrite_shared(const void* buf, int count,
const Datatype& datatype) (binding deprecated, see Section 15.2) g
fstatic File File::Open(const Intracomm& comm, const char* filename,
int amode, const Info& info) (binding deprecated, see Section 15.2) g
fvoid File::Preallocate(Offset size) (binding deprecated, see Section 15.2) g
fvoid File::Read(void* buf, int count, const Datatype& datatype) (binding deprecated, see Section 15.2) g
fvoid File::Read(void* buf, int count, const Datatype& datatype, Status& status) (binding deprecated, see Section 15.2) g
fvoid File::Read_all(void* buf, int count, const Datatype& datatype)
(binding deprecated, see Section 15.2) g
fvoid File::Read_all(void* buf, int count, const Datatype& datatype, Status& status) (binding deprecated, see Section 15.2) g
fvoid File::Read_all_begin(void* buf, int count,
const Datatype& datatype) (binding deprecated, see Section 15.2) g
fvoid File::Read_all_end(void* buf) (binding deprecated, see Section 15.2) g
fvoid File::Read_all_end(void* buf, Status& status) (binding deprecated, see Section 15.2) g
fvoid File::Read_at(Offset offset, void* buf, int count,
const Datatype& datatype) (binding deprecated, see Section 15.2) g
fvoid File::Read_at(Offset offset, void* buf, int count,
const Datatype& datatype, Status& status) (binding deprecated, see Section 15.2) g
fvoid File::Read_at_all(Offset offset, void* buf, int count,
const Datatype& datatype) (binding deprecated, see Section 15.2) g
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
588 |
ANNEX A. LANGUAGE BINDINGS SUMMARY |
1fvoid File::Read_at_all(Offset offset, void* buf, int count,
2
3
4
const Datatype& datatype, Status& status) (binding deprecated, see Section 15.2) g
5fvoid File::Read_at_all_begin(Offset offset, void* buf, int count,
6
7
8
const Datatype& datatype) (binding deprecated, see Section 15.2) g
fvoid File::Read_at_all_end(void* buf) (binding deprecated, see Section 15.2) g
9fvoid File::Read_at_all_end(void* buf, Status& status) (binding deprecated,
10
11
12
13
see Section 15.2) g
fvoid File::Read_ordered(void* buf, int count, const Datatype& datatype)
(binding deprecated, see Section 15.2) g
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
fvoid File::Read_ordered(void* buf, int count, const Datatype& datatype, Status& status) (binding deprecated, see Section 15.2) g
fvoid File::Read_ordered_begin(void* buf, int count,
const Datatype& datatype) (binding deprecated, see Section 15.2) g
fvoid File::Read_ordered_end(void* buf) (binding deprecated, see Section 15.2) g
fvoid File::Read_ordered_end(void* buf, Status& status) (binding deprecated, see Section 15.2) g
fvoid File::Read_shared(void* buf, int count, const Datatype& datatype)
(binding deprecated, see Section 15.2) g
fvoid File::Read_shared(void* buf, int count, const Datatype& datatype, Status& status) (binding deprecated, see Section 15.2) g
fvoid Register_datarep(const char* datarep, Datarep_conversion_function* read_conversion_fn, Datarep_conversion_function* write_conversion_fn, Datarep_extent_function* dtype_file_extent_fn, void* extra_state) (binding deprecated, see Section 15.2) g
fvoid File::Seek(Offset offset, int whence) (binding deprecated, see Section 15.2) g
fvoid File::Seek_shared(Offset offset, int whence) (binding deprecated, see Section 15.2) g
fvoid File::Set_atomicity(bool flag) (binding deprecated, see Section 15.2) g fvoid File::Set_info(const Info& info) (binding deprecated, see Section 15.2) g fvoid File::Set_size(Offset size) (binding deprecated, see Section 15.2) g
fvoid File::Set_view(Offset disp, const Datatype& etype, const Datatype& filetype, const char* datarep,
const Info& info) (binding deprecated, see Section 15.2) g
fvoid File::Sync() (binding deprecated, see Section 15.2) g
A.4. C++ BINDINGS (DEPRECATED) |
589 |
fvoid File::Write(const void* buf, int count, const Datatype& datatype)
(binding deprecated, see Section 15.2) g
fvoid File::Write(const void* buf, int count, const Datatype& datatype, Status& status) (binding deprecated, see Section 15.2) g
fvoid File::Write_all(const void* buf, int count,
const Datatype& datatype) (binding deprecated, see Section 15.2) g
fvoid File::Write_all(const void* buf, int count,
const Datatype& datatype, Status& status) (binding deprecated, see Section 15.2) g
fvoid File::Write_all_begin(const void* buf, int count,
const Datatype& datatype) (binding deprecated, see Section 15.2) g
fvoid File::Write_all_end(const void* buf) (binding deprecated, see Section 15.2) g
fvoid File::Write_all_end(const void* buf, Status& status) (binding deprecated, see Section 15.2) g
fvoid File::Write_at(Offset offset, const void* buf, int count,
const Datatype& datatype) (binding deprecated, see Section 15.2) g
fvoid File::Write_at(Offset offset, const void* buf, int count,
const Datatype& datatype, Status& status) (binding deprecated, see Section 15.2) g
fvoid File::Write_at_all(Offset offset, const void* buf, int count, const Datatype& datatype) (binding deprecated, see Section 15.2) g
fvoid File::Write_at_all(Offset offset, const void* buf, int count,
const Datatype& datatype, Status& status) (binding deprecated, see Section 15.2) g
fvoid File::Write_at_all_begin(Offset offset, const void* buf, int count, const Datatype& datatype) (binding deprecated, see Section 15.2) g
fvoid File::Write_at_all_end(const void* buf) (binding deprecated, see Section 15.2) g
fvoid File::Write_at_all_end(const void* buf, Status& status) (binding deprecated, see Section 15.2) g
fvoid File::Write_ordered(const void* buf, int count,
const Datatype& datatype) (binding deprecated, see Section 15.2) g
fvoid File::Write_ordered(const void* buf, int count,
const Datatype& datatype, Status& status) (binding deprecated, see Section 15.2) g
fvoid File::Write_ordered_begin(const void* buf, int count,
const Datatype& datatype) (binding deprecated, see Section 15.2) g
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
590 |
ANNEX A. LANGUAGE BINDINGS SUMMARY |
1
2
3
fvoid File::Write_ordered_end(const void* buf) (binding deprecated, see Section 15.2) g
4fvoid File::Write_ordered_end(const void* buf, Status& status) (binding
5
6
7
8
deprecated, see Section 15.2) g
fvoid File::Write_shared(const void* buf, int count,
const Datatype& datatype) (binding deprecated, see Section 15.2) g
9
10
11
12
13
14
15
16
fvoid File::Write_shared(const void* buf, int count,
const Datatype& datatype, Status& status) (binding deprecated, see Section 15.2) g
};
A.4.12 Language Bindings C++ Bindings
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
namespace MPI {
fstatic Datatype Datatype::Create_f90_complex(int p, int r) (binding deprecated, see Section 15.2) g
fstatic Datatype Datatype::Create_f90_integer(int r) (binding deprecated, see Section 15.2) g
fstatic Datatype Datatype::Create_f90_real(int p, int r) (binding deprecated, see Section 15.2) g
Exception::Exception(int error_code)
fint Exception::Get_error_class() const (binding deprecated, see Section 15.2) g
fint Exception::Get_error_code() const (binding deprecated, see Section 15.2) g
fconst char* Exception::Get_error_string() const (binding deprecated, see Section 15.2) g
fstatic Datatype Datatype::Match_size(int typeclass, int size) (binding deprecated, see Section 15.2) g
37 };
38
39 |
A.4.13 Pro ling Interface C++ Bindings |
|
40
41
42
43
44
namespace MPI {
fvoid Pcontrol(const int level, ...) (binding deprecated, see Section 15.2) g
45 };
46
47
48
A.4. C++ BINDINGS (DEPRECATED) |
591 |
A.4.14 C++ Bindings on all MPI Classes
The C++ language requires all classes to have four special functions: a default constructor, a copy constructor, a destructor, and an assignment operator. The bindings for these functions are listed below; their semantics are discussed in Section 16.1.5. The two constructors are not virtual. The bindings prototype functions are using the type hCLASSi rather than listing each function for every MPI class. The token hCLASSi can be replaced with valid MPI- 2 class names, such as Group, Datatype, etc., except when noted. In addition, bindings are provided for comparison and inter-language operability from Sections 16.1.5 and 16.1.9.
A.4.15 Construction / Destruction
namespace MPI {
hCLASSi::hCLASSi() hCLASSi:: hCLASSi()
};
A.4.16 Copy / Assignment
namespace MPI {
hCLASSi::hCLASSi(const hCLASSi& data)
hCLASSi& hCLASSi::operator=(const hCLASSi& data)
};
A.4.17 Comparison
Since Status instances are not handles to underlying MPI objects, the operator==() and operator!=() functions are not de ned on the Status class.
namespace MPI {
bool hCLASSi::operator==(const hCLASSi& data) const
bool hCLASSi::operator!=(const hCLASSi& data) const
};
A.4.18 Inter-language Operability
Since there are no C++ MPI::STATUS_IGNORE and MPI::STATUSES_IGNORE objects, the result of promoting the C or Fortran handles (MPI_STATUS_IGNORE and
MPI_STATUSES_IGNORE) to C++ is unde ned.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
namespace MPI {
48
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
592 |
ANNEX A. LANGUAGE BINDINGS SUMMARY |
hCLASSi& hCLASSi::operator=(const MPI_hCLASSi& data) hCLASSi::hCLASSi(const MPI_hCLASSi& data) hCLASSi::operator MPI_hCLASSi() const
};