Tpetra_Details_checkPointer.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//          Tpetra: Templated Linear Algebra Services Package
//                 Copyright (2008) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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.
//
// ************************************************************************
// @HEADER

#ifndef TPETRA_DETAILS_CHECKPOINTER_HPP
#define TPETRA_DETAILS_CHECKPOINTER_HPP


#include "TpetraCore_config.h"
#include <string>

#ifdef HAVE_TPETRACORE_CUDA
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Kokkos {
  class Cuda; // forward declaration
} // namespace Kokkos
#endif // DOXYGEN_SHOULD_SKIP_THIS
#endif // HAVE_TPETRACORE_CUDA

namespace Tpetra {
namespace Details {
namespace Impl {

bool isHostAccessible (const void* ptr);

template<class ExecutionSpace>
struct CheckPointerAccessibility {
  static bool
  accessible (const void* ptr,
              const ExecutionSpace& /* space */)
  {
    return isHostAccessible (ptr);
  }
};

#ifdef HAVE_TPETRACORE_CUDA
template<>
struct CheckPointerAccessibility<Kokkos::Cuda> {
  static bool
  accessible (const void* ptr,
              const Kokkos::Cuda& space);
};
#endif // HAVE_TPETRACORE_CUDA

} // namespace Impl

template<class ExecutionSpace>
bool
pointerAccessibleFromExecutionSpace (const void* ptr,
                                     const ExecutionSpace& space)
{
  using impl_type = Impl::CheckPointerAccessibility<ExecutionSpace>;
  return impl_type::accessible (ptr, space);
}

std::string memorySpaceName (const void* ptr);

} // namespace Details
} // namespace Tpetra

#endif // TPETRA_DETAILS_CHECKPOINTER_HPP