1MPI_Free_mem(3)                     LAM/MPI                    MPI_Free_mem(3)
2
3
4

NAME

6       MPI_Free_mem   -    Free   memory  that  was  previously  allocated  by
7       MPI_ALLOC_MEM
8

SYNOPSIS

10       #include <mpi.h>
11       int MPI_Free_mem(void *base)
12

INPUT PARAMETER

14       base   - pointer to memory to free
15
16

NOTES

18       For the TCP, SYSV, and USYSV RPIs, this function is  simply  a  wrapper
19       around free .
20
21
22       However,  future  RPIs (e.g., for Myrinet and VIA-based RPIs) will pro‐
23       vide "special" memory deallocation routines that will deallocate memory
24       that was used directly for DMA (i.e., allocated by MPI_ALLOC_MEM ).
25
26

NOTES FOR FORTRAN

28       All  MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
29       an additional argument ierr at the end of the argument list.   ierr  is
30       an  integer and has the same meaning as the return value of the routine
31       in C.  In Fortran, MPI routines are subroutines, and are  invoked  with
32       the call statement.
33
34       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
35       Fortran.
36
37

ERRORS

39       If an error occurs in an MPI function, the current MPI error handler is
40       called  to  handle  it.   By default, this error handler aborts the MPI
41       job.  The error handler may be changed with  MPI_Errhandler_set  ;  the
42       predefined  error  handler MPI_ERRORS_RETURN may be used to cause error
43       values to be returned (in C and Fortran; this  error  handler  is  less
44       useful  in  with  the  C++  MPI bindings.  The predefined error handler
45       MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the  error  value
46       needs  to  be recovered).  Note that MPI does not guarantee that an MPI
47       program can continue past an error.
48
49       All MPI routines (except MPI_Wtime and  MPI_Wtick  )  return  an  error
50       value;  C routines as the value of the function and Fortran routines in
51       the last argument.  The C++ bindings for MPI do not return  error  val‐
52       ues;  instead,  error values are communicated by throwing exceptions of
53       type MPI::Exception (but not by default).  Exceptions are  only  thrown
54       if the error value is not MPI::SUCCESS .
55
56
57       Note  that  if  the MPI::ERRORS_RETURN handler is set in C++, while MPI
58       functions will return upon an error, there will be no  way  to  recover
59       what the actual error value was.
60       MPI_SUCCESS
61              - No error; MPI routine completed successfully.
62       MPI_ERR_ARG
63              - Invalid argument.  Some argument is invalid and is not identi‐
64              fied by a specific  error  class.   This  is  typically  a  NULL
65              pointer or other such error.
66       MPI_ERR_NO_MEM
67              -  This  error class is associated with an error code that indi‐
68              cates that free space is exhausted.
69
70

MORE INFORMATION

72       For more information, please see the official MPI Forum web site, which
73       contains  the  text of both the MPI-1 and MPI-2 standards.  These docu‐
74       ments contain detailed information about each  MPI  function  (most  of
75       which is not duplicated in these man pages).
76
77       http://www.mpi-forum.org/
78
79
80

ACKNOWLEDGEMENTS

82       The  LAM Team would like the thank the MPICH Team for the handy program
83       to generate man pages  ("doctext"  from  ftp://ftp.mcs.anl.gov/pub/sow‐
84       ing/sowing.tar.gz  ), the initial formatting, and some initial text for
85       most of the MPI-1 man pages.
86

LOCATION

88       freemem.c
89
90
91
92LAM/MPI 7.1.2                      2/23/2006                   MPI_Free_mem(3)