/usr/include/trilinos/Teuchos_Details_MpiCommRequest.hpp is in libtrilinos-teuchos-dev 12.12.1-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | // @HEADER
// ***********************************************************************
//
// Teuchos: Common Tools Package
// Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER
#ifndef TEUCHOS_DETAILS_MPICOMMREQUEST_HPP
#define TEUCHOS_DETAILS_MPICOMMREQUEST_HPP
#include "Teuchos_DefaultMpiComm.hpp"
namespace Teuchos {
namespace Details {
/// \class MpiCommRequest
/// \brief MPI implementation of CommRequest<int>.
///
/// This class wraps MPI_Request, which is MPI's reification of a
/// nonblocking communication operation.
///
/// Users would not normally create an instance of this class. Calls
/// to nonblocking communication operations (such as ireceive() or
/// isend()) return a pointer to a CommRequest. If the Comm is an
/// MpiComm, then the returned CommRequest is an MpiCommRequest.
///
/// Users might wish to create an MpiCommRequest directly if they want
/// to encapsulate an MPI_Request returned by an external library or
/// by their own code.
///
/// The releaseRawMpiRequest() method (inherited from the base class)
/// does <i>not</i> free (decrement the reference count of) the
/// buffer, because relinquishing ownership does not actually force
/// the nonblocking operation to complete. The destructor will free
/// the buffer automatically.
class MpiCommRequest : public MpiCommRequestBase<int> {
public:
/// \brief Constructor.
///
/// \param rawMpiRequest [in/out] Raw MPI_Request created by the
/// nonblocking communication operation.
///
/// \param buffer [in] Buffer used by the nonblocking communication
/// operation. We keep this only to delay its deallocation until
/// after the communication operation completes. This may be null
/// if the message length is zero or if rawMpiRequest is
/// <tt>MPI_REQUEST_NULL</tt>.
///
/// We do not template the buffer type on the \c Packet type (the
/// type of the data being communicated). You must do an
/// rcp_reinterpret_cast on input of the buffer. We require this
/// because this class does not need to access the buffer; it merely
/// needs to retain a reference to prevent premature deallocation.
MpiCommRequest (MPI_Request rawMpiRequest,
const ArrayRCP<const char>& buffer);
//! Destructor; cancels the request if it is still pending.
virtual ~MpiCommRequest ();
private:
//! The buffer for the nonblocking communication operation.
ArrayRCP<const char> buffer_;
MpiCommRequest (); // Not defined
MpiCommRequest (const MpiCommRequest&); // Not defined
MpiCommRequest& operator= (const MpiCommRequest&); // Not defined
};
/// \fn mpiCommRequest
/// \brief Nonmember constructor for MpiCommRequest.
/// \relates MpiCommRequest
///
/// \param rawMpiRequest [in] The raw MPI_Request opaque object.
/// \param buffer [in] Buffer used by the nonblocking communication
/// operation.
RCP<MpiCommRequest>
mpiCommRequest (MPI_Request rawMpiRequest,
const ArrayRCP<const char>& buffer);
} // namespace Details
} // namespace Teuchos
#endif // TEUCHOS_DETAILS_MPICOMMREQUEST_HPP
|