Kokkos_Core.hpp

/*
//@HEADER
// ************************************************************************
//
//                        Kokkos v. 3.0
//       Copyright (2020) National Technology & Engineering
//               Solutions of Sandia, LLC (NTESS).
//
// Under the terms of Contract DE-NA0003525 with NTESS,
// 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 NTESS "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 NTESS 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 Christian R. Trott (crtrott@sandia.gov)
//
// ************************************************************************
//@HEADER
*/

#ifndef KOKKOS_CORE_HPP
#define KOKKOS_CORE_HPP

//----------------------------------------------------------------------------
// Include the execution space header files for the enabled execution spaces.

#include <Kokkos_Core_fwd.hpp>

#if defined(KOKKOS_ENABLE_SERIAL)
#include <Kokkos_Serial.hpp>
#endif

#if defined(KOKKOS_ENABLE_OPENMP)
#include <Kokkos_OpenMP.hpp>
#endif

#if defined(KOKKOS_ENABLE_OPENMPTARGET)
#include <Kokkos_OpenMPTarget.hpp>
#include <Kokkos_OpenMPTargetSpace.hpp>
#endif

#if defined(KOKKOS_ENABLE_HPX)
#include <Kokkos_HPX.hpp>
#endif

#if defined(KOKKOS_ENABLE_THREADS)
#include <Kokkos_Threads.hpp>
#endif

#if defined(KOKKOS_ENABLE_CUDA)
#include <Kokkos_Cuda.hpp>
#endif

#if defined(KOKKOS_ENABLE_ROCM)
#include <Kokkos_ROCm.hpp>
#endif
#if defined(KOKKOS_ENABLE_HIP)
#include <Kokkos_HIP.hpp>
#endif

#include <Kokkos_AnonymousSpace.hpp>
#include <Kokkos_Pair.hpp>
#include <Kokkos_MemoryPool.hpp>
#include <Kokkos_Array.hpp>
#include <Kokkos_View.hpp>
#include <Kokkos_Vectorization.hpp>
#include <Kokkos_Atomic.hpp>
#include <Kokkos_hwloc.hpp>
#include <Kokkos_Timer.hpp>
#include <Kokkos_TaskScheduler.hpp>
#include <Kokkos_Complex.hpp>
#include <Kokkos_CopyViews.hpp>
#include <functional>
#include <iosfwd>

//----------------------------------------------------------------------------

namespace Kokkos {

struct InitArguments {
  int num_threads;
  int num_numa;
  int device_id;
  int ndevices;
  int skip_device;
  bool disable_warnings;

  InitArguments(int nt = -1, int nn = -1, int dv = -1, bool dw = false)
      : num_threads{nt},
        num_numa{nn},
        device_id{dv},
        ndevices{-1},
        skip_device{9999},
        disable_warnings{dw} {}
};

void initialize(int& narg, char* arg[]);

void initialize(InitArguments args = InitArguments());

namespace Impl {

void pre_initialize(const InitArguments& args);

void post_initialize(const InitArguments& args);

}  // namespace Impl

bool is_initialized() noexcept;

bool show_warnings() noexcept;

void finalize();

void push_finalize_hook(std::function<void()> f);

void finalize_all();

void fence();

void print_configuration(std::ostream&, const bool detail = false);

}  // namespace Kokkos

//----------------------------------------------------------------------------
//----------------------------------------------------------------------------

namespace Kokkos {

/* Allocate memory from a memory space.
 * The allocation is tracked in Kokkos memory tracking system, so
 * leaked memory can be identified.
 */
template <class Space = typename Kokkos::DefaultExecutionSpace::memory_space>
inline void* kokkos_malloc(const std::string& arg_alloc_label,
                           const size_t arg_alloc_size) {
  typedef typename Space::memory_space MemorySpace;
  return Impl::SharedAllocationRecord<MemorySpace>::allocate_tracked(
      MemorySpace(), arg_alloc_label, arg_alloc_size);
}

template <class Space = typename Kokkos::DefaultExecutionSpace::memory_space>
inline void* kokkos_malloc(const size_t arg_alloc_size) {
  typedef typename Space::memory_space MemorySpace;
  return Impl::SharedAllocationRecord<MemorySpace>::allocate_tracked(
      MemorySpace(), "no-label", arg_alloc_size);
}

template <class Space = typename Kokkos::DefaultExecutionSpace::memory_space>
inline void kokkos_free(void* arg_alloc) {
  typedef typename Space::memory_space MemorySpace;
  return Impl::SharedAllocationRecord<MemorySpace>::deallocate_tracked(
      arg_alloc);
}

template <class Space = typename Kokkos::DefaultExecutionSpace::memory_space>
inline void* kokkos_realloc(void* arg_alloc, const size_t arg_alloc_size) {
  typedef typename Space::memory_space MemorySpace;
  return Impl::SharedAllocationRecord<MemorySpace>::reallocate_tracked(
      arg_alloc, arg_alloc_size);
}

}  // namespace Kokkos

namespace Kokkos {

class ScopeGuard {
 public:
  ScopeGuard(int& narg, char* arg[]) {
    sg_init = false;
    if (!Kokkos::is_initialized()) {
      initialize(narg, arg);
      sg_init = true;
    }
  }

  ScopeGuard(const InitArguments& args = InitArguments()) {
    sg_init = false;
    if (!Kokkos::is_initialized()) {
      initialize(args);
      sg_init = true;
    }
  }

  ~ScopeGuard() {
    if (Kokkos::is_initialized() && sg_init) {
      finalize();
    }
  }

  // private:
  bool sg_init;

  ScopeGuard& operator=(const ScopeGuard&) = delete;
  ScopeGuard(const ScopeGuard&)            = delete;
};

}  // namespace Kokkos

#include <Kokkos_Crs.hpp>
#include <Kokkos_WorkGraphPolicy.hpp>

//----------------------------------------------------------------------------
//----------------------------------------------------------------------------

#endif