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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
.TH MPI_Pack 3 "1/17/1997" " " "MPI"
.SH NAME
MPI_Pack \- Packs a datatype into contiguous memory
.SH SYNOPSIS
.nf
#include "mpi.h"
int MPI_Pack ( inbuf, incount, datatype, outbuf, outcount, position, comm )
void *inbuf;
int incount;
MPI_Datatype datatype;
void *outbuf;
int outcount;
int *position;
MPI_Comm comm;
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B inbuf
- input buffer start (choice)
.PD 1
.PD 0
.TP
.B incount
- number of input data items (integer)
.PD 1
.PD 0
.TP
.B datatype
- datatype of each input data item (handle)
.PD 1
.PD 0
.TP
.B outcount
- output buffer size, in bytes (integer)
.PD 1
.PD 0
.TP
.B position
- current position in buffer, in bytes (integer)
.PD 1
.PD 0
.TP
.B comm
- communicator for packed message (handle)
.PD 1
.SH OUTPUT PARAMETER
.PD 0
.TP
.B outbuf
- output buffer start (choice)
.PD 1
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Errhandler_set
; the predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarentee that an MPI program can continue past
an error.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_TYPE
- Invalid datatype argument. May be an uncommitted
.PD 1
MPI_Datatype (see
.I MPI_Type_commit
).
.PD 0
.TP
.B MPI_ERR_COUNT
- Invalid count argument. Count arguments must be
non-negative; a count of zero is often valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g.,
.I MPI_ERR_RANK
).
.PD 1
.SH SEE ALSO
MPI_Unpack, MPI_Pack_size
.br
.SH LOCATION
pack.c
|
