Kokkos Core Kernels Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Kokkos_hwloc.hpp
1 /*
2 //@HEADER
3 // ************************************************************************
4 //
5 // Kokkos v. 3.0
6 // Copyright (2020) National Technology & Engineering
7 // Solutions of Sandia, LLC (NTESS).
8 //
9 // Under the terms of Contract DE-NA0003525 with NTESS,
10 // the U.S. Government retains certain rights in this software.
11 //
12 // Redistribution and use in source and binary forms, with or without
13 // modification, are permitted provided that the following conditions are
14 // met:
15 //
16 // 1. Redistributions of source code must retain the above copyright
17 // notice, this list of conditions and the following disclaimer.
18 //
19 // 2. Redistributions in binary form must reproduce the above copyright
20 // notice, this list of conditions and the following disclaimer in the
21 // documentation and/or other materials provided with the distribution.
22 //
23 // 3. Neither the name of the Corporation nor the names of the
24 // contributors may be used to endorse or promote products derived from
25 // this software without specific prior written permission.
26 //
27 // THIS SOFTWARE IS PROVIDED BY NTESS "AS IS" AND ANY
28 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NTESS OR THE
31 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 //
39 // Questions? Contact Christian R. Trott (crtrott@sandia.gov)
40 //
41 // ************************************************************************
42 //@HEADER
43 */
44 
45 #ifndef KOKKOS_HWLOC_HPP
46 #define KOKKOS_HWLOC_HPP
47 
48 #include <utility>
49 
50 namespace Kokkos {
51 
64 namespace hwloc {
65 
67 bool available();
68 
73 unsigned get_available_numa_count();
74 
80 
84 
85 } /* namespace hwloc */
86 } /* namespace Kokkos */
87 
88 //----------------------------------------------------------------------------
89 //----------------------------------------------------------------------------
90 // Internal functions for binding persistent spawned threads.
91 
92 namespace Kokkos {
93 namespace hwloc {
94 
104 unsigned thread_mapping(const char* const label, const bool allow_async,
105  unsigned& thread_count, unsigned& use_numa_count,
106  unsigned& use_cores_per_numa,
107  std::pair<unsigned, unsigned> threads_coord[]);
108 
118 std::pair<unsigned, unsigned> get_this_thread_coordinate();
119 
121 bool bind_this_thread(const std::pair<unsigned, unsigned>);
122 
124 bool can_bind_threads();
125 
130 unsigned bind_this_thread(const unsigned coordinate_count,
131  std::pair<unsigned, unsigned> coordinate[]);
132 
134 bool unbind_this_thread();
135 
136 } /* namespace hwloc */
137 } /* namespace Kokkos */
138 
139 //----------------------------------------------------------------------------
140 //----------------------------------------------------------------------------
141 
142 #endif /* #define KOKKOS_HWLOC_HPP */
bool bind_this_thread(const std::pair< unsigned, unsigned >)
Bind the current thread to a core.
bool can_bind_threads()
Can hwloc bind threads?
unsigned get_available_cores_per_numa()
Query number of available cores per NUMA regions. This will be less than the hardware capacity if the...
unsigned get_available_threads_per_core()
Query number of available &quot;hard&quot; threads per core; i.e., hyperthreads.
unsigned get_available_numa_count()
Query number of available NUMA regions. This will be less than the hardware capacity if the MPI proce...
std::pair< unsigned, unsigned > get_this_thread_coordinate()
Query core-coordinate of the current thread with respect to the core_topology.
bool unbind_this_thread()
Unbind the current thread back to the original process binding.
unsigned thread_mapping(const char *const label, const bool allow_async, unsigned &thread_count, unsigned &use_numa_count, unsigned &use_cores_per_numa, std::pair< unsigned, unsigned > threads_coord[])
Recommend mapping of threads onto cores.
bool available()
Query if hwloc is available.