1 | .\"Copyright 2007-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Win_start 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Win_start\fP \- Starts an RMA access epoch for \fIwin\fP |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Win_start(MPI_Group \fIgroup\fP, int assert, MPI_Win \fIwin\fP) |
---|
13 | |
---|
14 | .SH Fortran Syntax |
---|
15 | .nf |
---|
16 | INCLUDE 'mpif.h' |
---|
17 | MPI_WIN_START(\fIGROUP, ASSERT, WIN, IERROR\fP) |
---|
18 | INTEGER GROUP, ASSERT, WIN, IERROR |
---|
19 | |
---|
20 | .SH C++ Syntax |
---|
21 | .nf |
---|
22 | #include <mpi.h> |
---|
23 | void MPI::Win::Start(const MPI::Group& group, int assert) const |
---|
24 | |
---|
25 | .SH INPUT PARAMETERS |
---|
26 | .ft R |
---|
27 | .TP 1i |
---|
28 | group |
---|
29 | The group of target processes (handle). |
---|
30 | .TP 1i |
---|
31 | assert |
---|
32 | Program assertion (integer). |
---|
33 | .TP 1i |
---|
34 | win |
---|
35 | Window object (handle). |
---|
36 | |
---|
37 | .SH OUTPUT PARAMETERS |
---|
38 | .ft R |
---|
39 | .TP 1i |
---|
40 | IERROR |
---|
41 | Fortran only: Error status (integer). |
---|
42 | |
---|
43 | .SH DESCRIPTION |
---|
44 | .ft R |
---|
45 | MPI_Win_start is a one-sided MPI communication synchronization call that starts an RMA access epoch for \fIwin\fP. RMA calls issued on \fIwin\fP during this epoch must |
---|
46 | access only windows at processes in \fIgroup\fP. Each process in \fIgroup\fP must issue a matching |
---|
47 | call to MPI_Win_post. MPI_Win_start |
---|
48 | is allowed to block until the corresponding MPI_Win_post calls have been executed, but is not required to. |
---|
49 | .sp |
---|
50 | The \fIassert\fP argument is used to provide assertions on the context of the call that may be used for various optimizations. (See Section 6.4.4 of the MPI-2 Standard.) A value of \fIassert\fP = 0 is always valid. The following assertion value is supported: |
---|
51 | .sp |
---|
52 | .TP 1i |
---|
53 | MPI_MODE_NOCHECK |
---|
54 | When this value is passed in to this call, the library assumes that |
---|
55 | the post call on the target has been called and it is not necessary |
---|
56 | for the library to check to see if such a call has been made. |
---|
57 | |
---|
58 | .SH ERRORS |
---|
59 | Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI:Exception object. |
---|
60 | .sp |
---|
61 | Before the error value is returned, the current MPI error handler is |
---|
62 | called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Win_set_errhandler; 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. |
---|
63 | |
---|
64 | .SH SEE ALSO |
---|
65 | MPI_Win_post |
---|
66 | MPI_Win_complete |
---|
67 | .br |
---|
68 | |
---|