Blame www/www3/MPI_Get_processor_name.html

Packit 0848f5
Packit 0848f5
<HTML>
Packit 0848f5
<HEAD>
Packit 0848f5
<META NAME="GENERATOR" CONTENT="DOCTEXT">
Packit 0848f5
<TITLE>MPI_Get_processor_name</TITLE>
Packit 0848f5
</HEAD>
Packit 0848f5
<BODY BGCOLOR="FFFFFF">
Packit 0848f5

MPI_Get_processor_name

Packit 0848f5
Gets the name of the processor 
Packit 0848f5

Synopsis

Packit 0848f5
Packit 0848f5
int MPI_Get_processor_name( char *name, int *resultlen )
Packit 0848f5
Packit 0848f5

Output Parameters

Packit 0848f5
Packit 0848f5
name
A unique specifier for the actual (as opposed to virtual) node. This
Packit 0848f5
must be an array of size at least <tt>MPI_MAX_PROCESSOR_NAME</tt>.
Packit 0848f5
Packit 0848f5
resultlen
Length (in characters) of the name
Packit 0848f5
Packit 0848f5

Packit 0848f5

Notes

Packit 0848f5
The name returned should identify a particular piece of hardware;
Packit 0848f5
the exact format is implementation defined.  This name may or may not
Packit 0848f5
be the same as might be returned by <tt>gethostname</tt>, <tt>uname</tt>, or <tt>sysinfo</tt>.
Packit 0848f5

Packit 0848f5

Thread and Interrupt Safety

Packit 0848f5

Packit 0848f5
This routine is thread-safe.  This means that this routine may be
Packit 0848f5
safely used by multiple threads without the need for any user-provided
Packit 0848f5
thread locks.  However, the routine is not interrupt safe.  Typically,
Packit 0848f5
this is due to the use of memory allocation routines such as <tt>malloc
Packit 0848f5
</tt>or other non-MPICH runtime routines that are themselves not interrupt-safe.
Packit 0848f5

Packit 0848f5

Notes for Fortran

Packit 0848f5
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
Packit 0848f5
an additional argument <tt>ierr</tt> at the end of the argument list.  <tt>ierr
Packit 0848f5
</tt>is an integer and has the same meaning as the return value of the routine
Packit 0848f5
in C.  In Fortran, MPI routines are subroutines, and are invoked with the
Packit 0848f5
<tt>call</tt> statement.
Packit 0848f5

Packit 0848f5
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
Packit 0848f5
</tt>in Fortran.
Packit 0848f5

Packit 0848f5
In Fortran, the character argument should be declared as a character string
Packit 0848f5
of <tt>MPI_MAX_PROCESSOR_NAME</tt> rather than an array of dimension
Packit 0848f5
<tt>MPI_MAX_PROCESSOR_NAME</tt>.  That is,
Packit 0848f5
Packit 0848f5
   character*(MPI_MAX_PROCESSOR_NAME) name
Packit 0848f5
Packit 0848f5
Packit 0848f5
rather than
Packit 0848f5
Packit 0848f5
   character name(MPI_MAX_PROCESSOR_NAME)
Packit 0848f5
Packit 0848f5
Packit 0848f5
The two
Packit 0848f5

Packit 0848f5

Packit 0848f5
The sizes of MPI strings in Fortran are one less than the sizes of that
Packit 0848f5
string in C/C++ because the C/C++ versions provide room for the trailing
Packit 0848f5
null character required by C/C++.  For example, <tt>MPI_MAX_ERROR_STRING</tt> is
Packit 0848f5
<tt>mpif.h</tt> is one smaller than the same value in <tt>mpi.h</tt>.  See the MPI
Packit 0848f5
standard, sections 2.6.2 and 4.12.9.
Packit 0848f5

Packit 0848f5

Packit 0848f5

Errors

Packit 0848f5

Packit 0848f5
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) return an error value;
Packit 0848f5
C routines as the value of the function and Fortran routines in the last
Packit 0848f5
argument.  Before the value is returned, the current MPI error handler is
Packit 0848f5
called.  By default, this error handler aborts the MPI job.  The error handler
Packit 0848f5
may be changed with <tt>MPI_Comm_set_errhandler</tt> (for communicators),
Packit 0848f5
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
Packit 0848f5
RMA windows).  The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
Packit 0848f5
its use is deprecated.  The predefined error handler
Packit 0848f5
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
Packit 0848f5
Note that MPI does not guarentee that an MPI program can continue past
Packit 0848f5
an error; however, MPI implementations will attempt to continue whenever
Packit 0848f5
possible.
Packit 0848f5

Packit 0848f5
MPI_SUCCESS
No error; MPI routine completed successfully.
Packit 0848f5
Packit 0848f5
</BODY></HTML>