/usr/include/trilinos/Teuchos_MpiReductionOpSetter.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 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 | // @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_MPI_REDUCTION_OP_SETTER_HPP
#define TEUCHOS_MPI_REDUCTION_OP_SETTER_HPP
/// \file Teuchos_MpiReductionOpSetter.hpp
/// \brief Implementation detail of Teuchos' MPI wrapper.
///
/// \warning Everything in this file is an implementation detail of
/// Teuchos. Do not use it and do not depend on it.
///
/// This file only contains meaningful content if building with MPI.
#include <Teuchos_ConfigDefs.hpp>
#ifdef HAVE_MPI
#include "Teuchos_ReductionOp.hpp"
#include <mpi.h>
namespace Teuchos {
namespace Details {
/// \brief Base class for an MPI-compatible reduction operator.
///
/// This class exists as an intermediate wrapper between
/// ValueTypeReductionOp and MPI_Op. Its pure virtual method reduce()
/// takes the same arguments as an MPI_Op reduction / scan operator.
///
/// \note This class only exists if building with MPI enabled.
class TEUCHOSCOMM_LIB_DLL_EXPORT MpiReductionOpBase :
virtual public Describable {
public:
virtual void
reduce (void* invec, void* inoutvec,
int* len, MPI_Datatype* datatype) const = 0;
};
/// \brief Subclass of MpiReductionOpBase that implements reduce()
/// using a ValueTypeReductionOp instance.
///
/// \note This class only views the ValueTypeReductionOp instance; it
/// does not own it. The ValueTypeReductionOp must be in scope;
/// otherwise this class' behavior is undefined.
template<typename OrdinalType>
class MpiReductionOp : public MpiReductionOpBase {
public:
MpiReductionOp (const ValueTypeReductionOp<OrdinalType,char>& reductOp)
: reductOp_ (reductOp)
{}
void
reduce (void* invec, void* inoutvec, int* len, MPI_Datatype* datatype) const
{
#ifdef TEUCHOS_DEBUG
TEUCHOS_TEST_FOR_EXCEPT(!len);
TEUCHOS_TEST_FOR_EXCEPT(!datatype);
#endif
// mfh 23 Nov 2014: Ross made the unfortunate decision initially
// to mash everything into MPI_CHAR. This means that we have to
// do a lot of type casting here. Of course, most implementations
// of ValueTypeReductionOp will immediately cast back from char*
// to the actual type of interest.
int sz;
MPI_Type_size (*datatype, &sz);
(void) datatype;
reductOp_.reduce ((*len) * sz, reinterpret_cast<char*> (invec),
reinterpret_cast<char*> (inoutvec));
}
private:
const ValueTypeReductionOp<OrdinalType, char>& reductOp_;
// Not defined and not to be called
MpiReductionOp ();
MpiReductionOp (const MpiReductionOp&);
MpiReductionOp& operator= (const MpiReductionOp&);
};
/// \brief Set the current reduction or scan operation for MpiComm.
/// Get the resulting MPI_Op to pass into MPI functions.
///
/// \return Global singleton MPI_Op to pass into MPI functions.
/// This is valid only before MPI_Finalize has been called.
///
/// \warning This is an implementation detail of Teuchos.
/// Users should never call this function directly.
MPI_Op setMpiReductionOp (const MpiReductionOpBase& reductOp);
} // namespace Details
} // namespace Teuchos
#endif // HAVE_MPI
#endif // TEUCHOS_MPI_REDUCTION_OP_SETTER_HPP
|