Skip to content

Commit eed4157

Browse files
committed
MPI_Init_thread(3): update refs about MPI_THREAD_MULTIPLE
Thanks to Andreas Lösel for bringing the outdated docs to our attention. Signed-off-by: Jeff Squyres <[email protected]> (cherry picked from commit 0a52936)
1 parent 95bb54c commit eed4157

File tree

1 file changed

+11
-35
lines changed

1 file changed

+11
-35
lines changed

ompi/mpi/man/man3/MPI_Init_thread.3in

Lines changed: 11 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.\" -*- nroff -*-
22
.\" Copyright 2006-2008 Sun Microsystems, Inc.
33
.\" Copyright (c) 1996 Thinking Machines Corporation
4-
.\" Copyright (c) 2010-2015 Cisco Systems, Inc. All rights reserved.
4+
.\" Copyright (c) 2010-2020 Cisco Systems, Inc. All rights reserved.
5+
.\" Copyright (c) 2020 Google, LLC. All rights reserved.
56
.\" $COPYRIGHT$
67
.TH MPI_Init_thread 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
78
.
@@ -135,52 +136,27 @@ opening files, reading standard input, or writing to standard output.
135136
.
136137
.SH MPI_THREAD_MULTIPLE Support
137138
.
138-
MPI_THREAD_MULTIPLE support is included if Open MPI was configured
139-
with the --enable-mpi-thread-multiple configure switch. You can check the
139+
MPI_THREAD_MULTIPLE support is included if the environment in which
140+
Open MPI was built supports threading. You can check the
140141
output of
141142
.BR ompi_info (1)
142143
to see if Open MPI has MPI_THREAD_MULTIPLE support:
143144
.
144145
.PP
145146
.nf
146-
shell$ ompi_info | grep -i thread
147-
Thread support: posix (mpi: yes, progress: no)
147+
shell$ ompi_info | grep "Thread support"
148+
Thread support: posix (MPI_THREAD_MULTIPLE: yes, OPAL support: yes, OMPI progress: no, Event lib: yes)
148149
shell$
149150
.fi
150151
.
151152
.PP
152-
The "mpi: yes" portion of the above output indicates that Open MPI was
153-
compiled with MPI_THREAD_MULTIPLE support.
153+
The "MPI_THREAD_MULTIPLE: yes" portion of the above output indicates
154+
that Open MPI was compiled with MPI_THREAD_MULTIPLE support.
154155
.
155156
.PP
156-
Note that MPI_THREAD_MULTIPLE support is only lightly tested. It
157-
likely does not work for thread-intensive applications. Also note
158-
that
159-
.I only
160-
the MPI point-to-point communication functions for the BTL's listed
161-
below are considered thread safe. Other support functions (e.g., MPI
162-
attributes) have not been certified as safe when simultaneously used
163-
by multiple threads.
164-
.
165-
.PP
166-
.nf
167-
tcp
168-
sm
169-
mx
170-
elan
171-
self
172-
.fi
173-
.
174-
.PP
175-
Note that Open MPI's thread support is in a fairly early stage; the
176-
above devices are likely to
177-
.IR work ,
178-
but the latency is likely to be fairly high. Specifically, efforts so
179-
far have concentrated on
180-
.IR correctness ,
181-
not
182-
.I performance
183-
(yet).
157+
Note that there is a small performance penalty for using
158+
MPI_THREAD_MULTIPLE support; latencies for short messages will be
159+
higher as compared to when using MPI_THREAD_SINGLE, for example.
184160
.
185161
.
186162
.SH ERRORS

0 commit comments

Comments
 (0)