[97] | 1 | .\"Copyright 2008 Sun Microsystems, Inc. |
---|
| 2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
| 3 | .TH MPI 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
| 4 | .SH NAME |
---|
| 5 | MPI \- General information Open MPI 1.4. |
---|
| 6 | |
---|
| 7 | .SH MPI |
---|
| 8 | .ft R |
---|
| 9 | Open MPI is an open source implementation of MPI (message-passing |
---|
| 10 | interface), the industry-standard specification for writing |
---|
| 11 | message-passing programs. Message passing is a programming model that |
---|
| 12 | gives the programmer explicit control over interprocess communication. |
---|
| 13 | .sp |
---|
| 14 | The MPI specification was developed by the MPI Forum, a group of |
---|
| 15 | software developers, computer vendors, academics, and computer-science |
---|
| 16 | researchers whose goal was to develop a standard for writing |
---|
| 17 | message-passing programs that would be efficient, flexible, and |
---|
| 18 | portable. |
---|
| 19 | .sp |
---|
| 20 | The outcome, known as the MPI Standard, was first published in 1993; |
---|
| 21 | its most recent version (MPI-2) was published in July 1997. Open MPI |
---|
| 22 | 1.2 includes all MPI 1.2-compliant and MPI 2-compliant routines. |
---|
| 23 | .sp |
---|
| 24 | For more information about Open MPI, see the following URL: |
---|
| 25 | .nf |
---|
| 26 | |
---|
| 27 | http://www.open-mpi.org |
---|
| 28 | .fi |
---|
| 29 | .sp |
---|
| 30 | The MPI standards are available at the following URL: |
---|
| 31 | .nf |
---|
| 32 | |
---|
| 33 | http://www.mpi-forum.org |
---|
| 34 | .fi |
---|
| 35 | |
---|
| 36 | .SH MAN PAGE SYNTAX |
---|
| 37 | .ft R |
---|
| 38 | Man pages for Open MPI and Open MPI I/O routines are named according to C syntax, that is, they begin with the prefix "MPI_", all in uppercase, and the first letter following the "MPI_" prefix is also uppercase. The rest of the letters in the routine are all lowercase, for example, "MPI_Comm_get_attr". |
---|
| 39 | |
---|
| 40 | .SH ENVIRONMENT |
---|
| 41 | .ft R |
---|
| 42 | To fine-tune your Open MPI environment, you can either use arguments to the \fImpirun\fP, \fIorterun\fP, or \fImpiexec\fP commands, or you can use MCA parameters. |
---|
| 43 | .sp |
---|
| 44 | For more information on arguments, see the orterun.1 man page. |
---|
| 45 | .sp |
---|
| 46 | For a complete listing of MCA parameters and their descriptions, issue the command \fIompi_info -h\fP or \fIompi_info -param all all\fP. This information also appears in the FAQ on the Open MPI web site at: |
---|
| 47 | .nf |
---|
| 48 | |
---|
| 49 | http://www.open-mpi.org/faq/?category=tuning#mca-params |
---|
| 50 | .fi |
---|
| 51 | |
---|
| 52 | .SH ERRORS |
---|
| 53 | .ft R |
---|
| 54 | All MPI routines (except MPI_Wtime and MPI_Wtick) return an error value; C routines as the value of the function and Fortran routines in the last |
---|
| 55 | argument. Before the value is returned, the current MPI error handler is |
---|
| 56 | called. By default, this error handler aborts the MPI job. The error handler |
---|
| 57 | may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN |
---|
| 58 | may be used to cause error values to be returned. |
---|
| 59 | Note that MPI does not guarantee that an MPI program can continue past |
---|
| 60 | an error. |
---|
| 61 | .sp |
---|
| 62 | For more information on Open MPI error codes, see \fImpi.h\fP in the \fIinclude\fP directory. |
---|
| 63 | .sp |
---|
| 64 | Standard error return classes for Open MPI: |
---|
| 65 | .sp |
---|
| 66 | .nf |
---|
| 67 | MPI_SUCCESS 0 Successful return code. |
---|
| 68 | MPI_ERR_BUFFER 1 Invalid buffer pointer. |
---|
| 69 | MPI_ERR_COUNT 2 Invalid count argument. |
---|
| 70 | MPI_ERR_TYPE 3 Invalid datatype argument. |
---|
| 71 | MPI_ERR_TAG 4 Invalid tag argument. |
---|
| 72 | MPI_ERR_COMM 5 Invalid communicator. |
---|
| 73 | |
---|
| 74 | MPI_ERR_RANK 6 Invalid rank. |
---|
| 75 | MPI_ERR_REQUEST 7 Invalid MPI_Request handle. |
---|
| 76 | MPI_ERR_ROOT 7 Invalid root. |
---|
| 77 | MPI_ERR_GROUP 8 Null group passed to function. |
---|
| 78 | MPI_ERR_OP 9 Invalid operation. |
---|
| 79 | MPI_ERR_TOPOLOGY 10 Invalid topology. |
---|
| 80 | |
---|
| 81 | MPI_ERR_DIMS 11 Illegal dimension argument. |
---|
| 82 | MPI_ERR_ARG 12 Invalid argument. |
---|
| 83 | MPI_ERR_UNKNOWN 13 Unknown error. |
---|
| 84 | MPI_ERR_TRUNCATE 14 Message truncated on receive. |
---|
| 85 | MPI_ERR_OTHER 15 Other error; use Error_string. |
---|
| 86 | |
---|
| 87 | MPI_ERR_INTERN 16 Internal error code. |
---|
| 88 | MPI_ERR_IN_STATUS 17 Look in status for error value. |
---|
| 89 | MPI_ERR_PENDING 18 Pending request. |
---|
| 90 | MPI_ERR_ACCESS 19 Permission denied. |
---|
| 91 | MPI_ERR_AMODE 20 Unsupported amode passed to open. |
---|
| 92 | |
---|
| 93 | MPI_ERR_ASSERT 21 Invalid assert. |
---|
| 94 | MPI_ERR_BAD_FILE 22 Invalid file name (for example, |
---|
| 95 | path name too long). |
---|
| 96 | MPI_ERR_BASE 23 Invalid base. |
---|
| 97 | MPI_ERR_CONVERSION 24 An error occurred in a user-supplied |
---|
| 98 | data-conversion function. |
---|
| 99 | MPI_ERR_DISP 25 Invalid displacement. |
---|
| 100 | |
---|
| 101 | MPI_ERR_DUP_DATAREP 26 Conversion functions could not |
---|
| 102 | be registered because a data |
---|
| 103 | representation identifier that was |
---|
| 104 | already defined was passed to |
---|
| 105 | MPI_REGISTER_DATAREP. |
---|
| 106 | MPI_ERR_FILE_EXISTS 27 File exists. |
---|
| 107 | MPI_ERR_FILE_IN_USE 28 File operation could not be |
---|
| 108 | completed, as the file is currently |
---|
| 109 | open by some process. |
---|
| 110 | MPI_ERR_FILE 29 |
---|
| 111 | MPI_ERR_INFO_KEY 30 Illegal info key. |
---|
| 112 | |
---|
| 113 | MPI_ERR_INFO_NOKEY 31 No such key. |
---|
| 114 | MPI_ERR_INFO_VALUE 32 Illegal info value. |
---|
| 115 | MPI_ERR_INFO 33 Invalid info object. |
---|
| 116 | MPI_ERR_IO 34 I/O error. |
---|
| 117 | MPI_ERR_KEYVAL 35 Illegal key value. |
---|
| 118 | |
---|
| 119 | MPI_ERR_LOCKTYPE 36 Invalid locktype. |
---|
| 120 | MPI_ERR_NAME 37 Name not found. |
---|
| 121 | MPI_ERR_NO_MEM 38 Memory exhausted. |
---|
| 122 | MPI_ERR_NOT_SAME 39 |
---|
| 123 | MPI_ERR_NO_SPACE 40 Not enough space. |
---|
| 124 | |
---|
| 125 | MPI_ERR_NO_SUCH_FILE 41 File (or directory) does not exist. |
---|
| 126 | MPI_ERR_PORT 42 Invalid port. |
---|
| 127 | MPI_ERR_QUOTA 43 Quota exceeded. |
---|
| 128 | MPI_ERR_READ_ONLY 44 Read-only file system. |
---|
| 129 | MPI_ERR_RMA_CONFLICT 45 Conflicting accesses to window. |
---|
| 130 | |
---|
| 131 | MPI_ERR_RMA_SYNC 46 Erroneous RMA synchronization. |
---|
| 132 | MPI_ERR_SERVICE 47 Invalid publish/unpublish. |
---|
| 133 | MPI_ERR_SIZE 48 Invalid size. |
---|
| 134 | MPI_ERR_SPAWN 49 Error spawning. |
---|
| 135 | MPI_ERR_UNSUPPORTED_DATAREP |
---|
| 136 | 50 Unsupported datarep passed to |
---|
| 137 | MPI_File_set_view. |
---|
| 138 | |
---|
| 139 | MPI_ERR_UNSUPPORTED_OPERATION |
---|
| 140 | 51 Unsupported operation, such as |
---|
| 141 | seeking on a file that supports |
---|
| 142 | only sequential access. |
---|
| 143 | MPI_ERR_WIN 52 Invalid window. |
---|
| 144 | MPI_ERR_LASTCODE 53 Last error code. |
---|
| 145 | |
---|
| 146 | MPI_ERR_SYSRESOURCE -2 Out of resources |
---|
| 147 | .fi |
---|
| 148 | |
---|