Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_DefaultMpiComm.cpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
43 
44 // Only enable the contents of this file if building with MPI.
45 #ifdef HAVE_TEUCHOS_MPI
46 
47 namespace Teuchos {
48 
49  std::string
50  mpiErrorCodeToString (const int errCode)
51  {
52  if (errCode == MPI_SUCCESS) {
53  return "MPI_SUCCESS";
54  }
55  else {
56  char rawErrString[MPI_MAX_ERROR_STRING];
57  int len = 0;
58  int err = MPI_Error_string (errCode, rawErrString, &len);
59  if (err != MPI_SUCCESS) {
60  // Assume that the string wasn't written. This means it might
61  // not be null terminated, so make it a valid empty string by
62  // writing the null termination character to it.
63  if (MPI_MAX_ERROR_STRING > 0) {
64  rawErrString[0] = '\0';
65  }
66  }
67  return std::string (rawErrString);
68  }
69  }
70 
71  namespace details {
72  void safeCommFree (MPI_Comm* comm) {
73  // FIXME (mfh 08 Dec 2014) Use the MPI_Finalize hook trick to
74  // call MPI_Comm_free at MPI_Finalize automatically, if it
75  // hasn't already been called on the object. Store the MPI_Comm
76  // (by allocated pointer) as the value of the (key,value) pair
77  // (used in the hook), and be sure to free the pair if the free
78  // function is called before MPI_Finalize.
79  int finalized = 0;
80  const int err = MPI_Finalized (&finalized);
81  // Just to be safe, don't do anything if calling MPI_Finalized
82  // didn't succeed. It's better to leak memory than to crash.
83  if (err == MPI_SUCCESS && ! finalized) {
84  // Don't throw an exception if MPI_Comm_free reports an error,
85  // since we're likely to be in a destructor and destructors
86  // shouldn't throw exceptions.
87  (void) MPI_Comm_free (comm);
88  }
89  }
90 
91  int setCommErrhandler (MPI_Comm comm, MPI_Errhandler handler) {
92 #if MPI_VERSION >= 2
93  return MPI_Comm_set_errhandler (comm, handler);
94 #else // MPI 1
95  return MPI_Errhandler_set (comm, handler);
96 #endif // MPI_VERSION >= 2
97  }
98  } // namespace details
99 
100 } // namespace Teuchos
101 
102 #endif // HAVE_TEUCHOS_MPI
Implementation of Teuchos wrappers for MPI.