Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
MPI_Get_processor_name(3)	      MPI	     MPI_Get_processor_name(3)

NAME
       MPI_Get_processor_name -	 Gets the name of the processor

SYNOPSIS
       int MPI_Get_processor_name(char *name, int *resultlen)

OUTPUT PARAMETERS
       name   -	 A  unique  specifier  for  the	actual (as opposed to virtual)
	      node. (string)
       resultlen
	      -	Length (in printable characters) of  the  result  returned  in
	      name (integer)

NOTES
       The  name  returned should identify a particular	piece of hardware; the
       exact format is implementation defined.	This name may or  may  not  be
       the same	as might be returned by	gethostname , uname , or sysinfo .

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

NOTES FOR FORTRAN
       All MPI routines	in Fortran (except for MPI_WTIME and MPI_WTICK )  have
       an  additional  argument	ierr at	the end	of the argument	list.  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 call	statement.

       All MPI objects (e.g., MPI_Datatype , MPI_Comm )	are of type INTEGER in
       Fortran.

       In Fortran, the character argument should be declared  as  a  character
       string  of  MPI_MAX_PROCESSOR_NAME  rather  than	 an array of dimension
       MPI_MAX_PROCESSOR_NAME .	 That is,
       character*(MPI_MAX_PROCESSOR_NAME) name

       rather than
       character name(MPI_MAX_PROCESSOR_NAME)

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

ERRORS
       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	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 MPI_Comm_set_errhandler (for com-
       municators),  MPI_File_set_errhandler  (for files), and MPI_Win_set_er-
       rhandler	(for RMA windows).  The	MPI-1 routine  MPI_Errhandler_set  may
       be  used	 but  its  use	is  deprecated.	  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; however, MPI implementations will attempt to  continue	 when-
       ever possible.

       MPI_SUCCESS
	      -	No error; MPI routine completed	successfully.
       MPI_ERR_ARG
	      -	Invalid	argument.  Some	argument is invalid and	is not identi-
	      fied by a	specific error class (e.g., MPI_ERR_RANK ).
       MPI_ERR_OTHER
	      -	 Other	error;	use  MPI_Error_string  to get more information
	      about this error code.

				   2/3/2025	     MPI_Get_processor_name(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=MPI_Get_processor_name&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help