Skip to content

Commit 8e2cd28

Browse files
pearztc-rhodes
pearzt
authored and
c-rhodes
committed
[OpenMP] Fix preprocessor mismatches between include and usages of hwloc (#158349)
Fix #156679 There is a mismatch between the preprocessor guards around the include of `hwloc.h` and those protecting its usages, leading to build failures on Darwin: spack/spack-packages#1212 This change introduces `KMP_HWLOC_ENABLED` that reflects whether hwloc is actually used. (cherry picked from commit cd24d10)
1 parent df3145b commit 8e2cd28

File tree

7 files changed

+57
-54
lines changed

7 files changed

+57
-54
lines changed

‎openmp/runtime/src/kmp.h‎

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -106,12 +106,15 @@ class kmp_stats_list;
106106
// OMPD_SKIP_HWLOC used in libompd/omp-icv.cpp to avoid OMPD depending on hwloc
107107
#if KMP_USE_HWLOC && KMP_AFFINITY_SUPPORTED && !defined(OMPD_SKIP_HWLOC)
108108
#include "hwloc.h"
109+
#define KMP_HWLOC_ENABLED 1
109110
#ifndef HWLOC_OBJ_NUMANODE
110111
#define HWLOC_OBJ_NUMANODE HWLOC_OBJ_NODE
111112
#endif
112113
#ifndef HWLOC_OBJ_PACKAGE
113114
#define HWLOC_OBJ_PACKAGE HWLOC_OBJ_SOCKET
114115
#endif
116+
#else
117+
#define KMP_HWLOC_ENABLED 0
115118
#endif
116119

117120
#if KMP_ARCH_X86 || KMP_ARCH_X86_64
@@ -692,10 +695,10 @@ typedef BOOL (*kmp_SetThreadGroupAffinity_t)(HANDLE, const GROUP_AFFINITY *,
692695
extern kmp_SetThreadGroupAffinity_t __kmp_SetThreadGroupAffinity;
693696
#endif /* KMP_OS_WINDOWS */
694697

695-
#if KMP_USE_HWLOC && !defined(OMPD_SKIP_HWLOC)
698+
#if KMP_HWLOC_ENABLED
696699
extern hwloc_topology_t __kmp_hwloc_topology;
697700
extern int __kmp_hwloc_error;
698-
#endif
701+
#endif // KMP_HWLOC_ENABLED
699702

700703
extern size_t __kmp_affin_mask_size;
701704
#define KMP_AFFINITY_CAPABLE() (__kmp_affin_mask_size > 0)
@@ -804,10 +807,10 @@ class KMPAffinity {
804807
static void destroy_api();
805808
enum api_type {
806809
NATIVE_OS
807-
#if KMP_USE_HWLOC
810+
#if KMP_HWLOC_ENABLED
808811
,
809812
HWLOC
810-
#endif
813+
#endif // KMP_HWLOC_ENABLED
811814
};
812815
virtual api_type get_api_type() const {
813816
KMP_ASSERT(0);
@@ -876,9 +879,9 @@ enum affinity_top_method {
876879
affinity_top_method_group,
877880
#endif /* KMP_GROUP_AFFINITY */
878881
affinity_top_method_flat,
879-
#if KMP_USE_HWLOC
882+
#if KMP_HWLOC_ENABLED
880883
affinity_top_method_hwloc,
881-
#endif
884+
#endif // KMP_HWLOC_ENABLED
882885
affinity_top_method_default
883886
};
884887

@@ -1145,9 +1148,9 @@ typedef struct kmp_allocator_t {
11451148
omp_alloctrait_value_t target_access;
11461149
omp_alloctrait_value_t atomic_scope;
11471150
size_t part_size;
1148-
#if KMP_USE_HWLOC
1151+
#if KMP_HWLOC_ENABLED
11491152
omp_alloctrait_value_t membind;
1150-
#endif
1153+
#endif // KMP_HWLOC_ENABLED
11511154
} kmp_allocator_t;
11521155

11531156
extern omp_allocator_handle_t __kmpc_init_allocator(int gtid,
@@ -2107,12 +2110,12 @@ typedef struct dispatch_shared_info {
21072110
#if KMP_USE_HIER_SCHED
21082111
void *hier;
21092112
#endif
2110-
#if KMP_USE_HWLOC
2113+
#if KMP_HWLOC_ENABLED
21112114
// When linking with libhwloc, the ORDERED EPCC test slows down on big
21122115
// machines (> 48 cores). Performance analysis showed that a cache thrash
21132116
// was occurring and this padding helps alleviate the problem.
21142117
char padding[64];
2115-
#endif
2118+
#endif // KMP_HWLOC_ENABLED
21162119
} dispatch_shared_info_t;
21172120

21182121
typedef struct kmp_disp {

‎openmp/runtime/src/kmp_affinity.cpp‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@
1919
#if KMP_USE_HIER_SCHED
2020
#include "kmp_dispatch_hier.h"
2121
#endif
22-
#if KMP_USE_HWLOC
22+
#if KMP_HWLOC_ENABLED
2323
// Copied from hwloc
2424
#define HWLOC_GROUP_KIND_INTEL_MODULE 102
2525
#define HWLOC_GROUP_KIND_INTEL_TILE 103
2626
#define HWLOC_GROUP_KIND_INTEL_DIE 104
2727
#define HWLOC_GROUP_KIND_WINDOWS_PROCESSOR_GROUP 220
28-
#endif
28+
#endif // KMP_HWLOC_ENABLED
2929
#include <ctype.h>
3030

3131
// The machine topology
@@ -1438,15 +1438,15 @@ void KMPAffinity::pick_api() {
14381438
KMPAffinity *affinity_dispatch;
14391439
if (picked_api)
14401440
return;
1441-
#if KMP_USE_HWLOC
1441+
#if KMP_HWLOC_ENABLED
14421442
// Only use Hwloc if affinity isn't explicitly disabled and
14431443
// user requests Hwloc topology method
14441444
if (__kmp_affinity_top_method == affinity_top_method_hwloc &&
14451445
__kmp_affinity.type != affinity_disabled) {
14461446
affinity_dispatch = new KMPHwlocAffinity();
14471447
__kmp_hwloc_available = true;
14481448
} else
1449-
#endif
1449+
#endif // KMP_HWLOC_ENABLED
14501450
{
14511451
affinity_dispatch = new KMPNativeAffinity();
14521452
}
@@ -1697,7 +1697,7 @@ kmp_affin_mask_t *__kmp_affin_fullMask = NULL;
16971697
// Original mask is a subset of full mask in multiple processor groups topology
16981698
kmp_affin_mask_t *__kmp_affin_origMask = NULL;
16991699

1700-
#if KMP_USE_HWLOC
1700+
#if KMP_HWLOC_ENABLED
17011701
static inline bool __kmp_hwloc_is_cache_type(hwloc_obj_t obj) {
17021702
#if HWLOC_API_VERSION >= 0x00020000
17031703
return hwloc_obj_type_is_cache(obj->type);
@@ -2005,7 +2005,7 @@ static bool __kmp_affinity_create_hwloc_map(kmp_i18n_id_t *const msg_id) {
20052005
__kmp_topology->sort_ids();
20062006
return true;
20072007
}
2008-
#endif // KMP_USE_HWLOC
2008+
#endif // KMP_HWLOC_ENABLED
20092009

20102010
// If we don't know how to retrieve the machine's processor topology, or
20112011
// encounter an error in doing so, this routine is called to form a "flat"
@@ -4845,7 +4845,7 @@ static bool __kmp_aux_affinity_initialize_topology(kmp_affinity_t &affinity) {
48454845
// In the default code path, errors are not fatal - we just try using
48464846
// another method. We only emit a warning message if affinity is on, or the
48474847
// verbose flag is set, an the nowarnings flag was not set.
4848-
#if KMP_USE_HWLOC
4848+
#if KMP_HWLOC_ENABLED
48494849
if (!success &&
48504850
__kmp_affinity_dispatch->get_api_type() == KMPAffinity::HWLOC) {
48514851
if (!__kmp_hwloc_error) {
@@ -4857,7 +4857,7 @@ static bool __kmp_aux_affinity_initialize_topology(kmp_affinity_t &affinity) {
48574857
KMP_INFORM(AffIgnoringHwloc, env_var);
48584858
}
48594859
}
4860-
#endif
4860+
#endif // KMP_HWLOC_ENABLED
48614861

48624862
#if KMP_ARCH_X86 || KMP_ARCH_X86_64
48634863
if (!success) {
@@ -4905,7 +4905,7 @@ static bool __kmp_aux_affinity_initialize_topology(kmp_affinity_t &affinity) {
49054905
// If the user has specified that a paricular topology discovery method is to be
49064906
// used, then we abort if that method fails. The exception is group affinity,
49074907
// which might have been implicitly set.
4908-
#if KMP_USE_HWLOC
4908+
#if KMP_HWLOC_ENABLED
49094909
else if (__kmp_affinity_top_method == affinity_top_method_hwloc) {
49104910
KMP_ASSERT(__kmp_affinity_dispatch->get_api_type() == KMPAffinity::HWLOC);
49114911
success = __kmp_affinity_create_hwloc_map(&msg_id);
@@ -4914,7 +4914,7 @@ static bool __kmp_aux_affinity_initialize_topology(kmp_affinity_t &affinity) {
49144914
KMP_FATAL(MsgExiting, __kmp_i18n_catgets(msg_id));
49154915
}
49164916
}
4917-
#endif // KMP_USE_HWLOC
4917+
#endif // KMP_HWLOC_ENABLED
49184918

49194919
#if KMP_ARCH_X86 || KMP_ARCH_X86_64
49204920
else if (__kmp_affinity_top_method == affinity_top_method_x2apicid ||
@@ -5308,12 +5308,12 @@ void __kmp_affinity_uninitialize(void) {
53085308
__kmp_free(__kmp_osid_to_hwthread_map);
53095309
__kmp_osid_to_hwthread_map = NULL;
53105310
}
5311-
#if KMP_USE_HWLOC
5311+
#if KMP_HWLOC_ENABLED
53125312
if (__kmp_hwloc_topology != NULL) {
53135313
hwloc_topology_destroy(__kmp_hwloc_topology);
53145314
__kmp_hwloc_topology = NULL;
53155315
}
5316-
#endif
5316+
#endif // KMP_HWLOC_ENABLED
53175317
if (__kmp_hw_subset) {
53185318
kmp_hw_subset_t::deallocate(__kmp_hw_subset);
53195319
__kmp_hw_subset = nullptr;

‎openmp/runtime/src/kmp_affinity.h‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
#include <limits>
1919

2020
#if KMP_AFFINITY_SUPPORTED
21-
#if KMP_USE_HWLOC
21+
#if KMP_HWLOC_ENABLED
2222
class KMPHwlocAffinity : public KMPAffinity {
2323
public:
2424
class Mask : public KMPAffinity::Mask {
@@ -109,7 +109,7 @@ class KMPHwlocAffinity : public KMPAffinity {
109109
}
110110
return error;
111111
}
112-
#endif
112+
#endif // KMP_OS_WINDOWS
113113
int get_proc_group() const override {
114114
int group = -1;
115115
#if KMP_OS_WINDOWS
@@ -191,7 +191,7 @@ class KMPHwlocAffinity : public KMPAffinity {
191191
}
192192
api_type get_api_type() const override { return HWLOC; }
193193
};
194-
#endif /* KMP_USE_HWLOC */
194+
#endif /* KMP_HWLOC_ENABLED */
195195

196196
#if KMP_OS_LINUX || KMP_OS_FREEBSD || KMP_OS_NETBSD || KMP_OS_DRAGONFLY || \
197197
KMP_OS_AIX

‎openmp/runtime/src/kmp_alloc.cpp‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
#include "kmp_io.h"
1515
#include "kmp_wrapper_malloc.h"
1616

17-
#if KMP_USE_HWLOC
17+
#if KMP_HWLOC_ENABLED
1818
#if HWLOC_API_VERSION > 0x00020300
1919
#define KMP_HWLOC_LOCATION_TYPE_CPUSET HWLOC_LOCATION_TYPE_CPUSET
2020
#elif HWLOC_API_VERSION == 0x00020300
@@ -26,7 +26,7 @@ enum hwloc_memattr_id_e {
2626
HWLOC_MEMATTR_ID_CAPACITY
2727
};
2828
#endif
29-
#endif // KMP_USE_HWLOC
29+
#endif // KMP_HWLOC_ENABLED
3030

3131
// Disable bget when it is not used
3232
#if KMP_USE_BGET
@@ -1545,7 +1545,7 @@ void __kmp_fini_memkind() {
15451545
#endif
15461546
}
15471547

1548-
#if KMP_USE_HWLOC
1548+
#if KMP_HWLOC_ENABLED
15491549
static bool __kmp_is_hwloc_membind_supported(hwloc_membind_policy_t policy) {
15501550
#if HWLOC_API_VERSION >= 0x00020300
15511551
const hwloc_topology_support *support;
@@ -1561,7 +1561,7 @@ static bool __kmp_is_hwloc_membind_supported(hwloc_membind_policy_t policy) {
15611561
return false;
15621562
#else
15631563
return false;
1564-
#endif
1564+
#endif // KMP_HWLOC_ENABLED
15651565
}
15661566

15671567
void *__kmp_hwloc_alloc_membind(hwloc_memattr_id_e attr, size_t size,
@@ -1611,7 +1611,7 @@ void *__kmp_hwloc_membind_policy(omp_memspace_handle_t ms, size_t size,
16111611
return NULL;
16121612
#endif
16131613
}
1614-
#endif // KMP_USE_HWLOC
1614+
#endif // KMP_HWLOC_ENABLED
16151615

16161616
void __kmp_init_target_mem() {
16171617
*(void **)(&kmp_target_alloc_host) = KMP_DLSYM("llvm_omp_target_alloc_host");
@@ -1680,13 +1680,13 @@ omp_allocator_handle_t __kmpc_init_allocator(int gtid, omp_memspace_handle_t ms,
16801680
al->fb_data = RCAST(kmp_allocator_t *, traits[i].value);
16811681
break;
16821682
case omp_atk_partition:
1683-
#if KMP_USE_HWLOC
1683+
#if KMP_HWLOC_ENABLED
16841684
al->membind = (omp_alloctrait_value_t)traits[i].value;
16851685
KMP_DEBUG_ASSERT(al->membind == omp_atv_environment ||
16861686
al->membind == omp_atv_nearest ||
16871687
al->membind == omp_atv_blocked ||
16881688
al->membind == omp_atv_interleaved);
1689-
#endif
1689+
#endif // KMP_HWLOC_ENABLED
16901690
al->memkind = RCAST(void **, traits[i].value);
16911691
break;
16921692
case omp_atk_pin_device:
@@ -1980,7 +1980,7 @@ void *__kmp_alloc(int gtid, size_t algn, size_t size,
19801980
}
19811981
}
19821982

1983-
#if KMP_USE_HWLOC
1983+
#if KMP_HWLOC_ENABLED
19841984
if (__kmp_hwloc_available) {
19851985
if (__kmp_is_hwloc_membind_supported(HWLOC_MEMBIND_BIND)) {
19861986
if (allocator < kmp_max_mem_alloc) {
@@ -2074,7 +2074,7 @@ void *__kmp_alloc(int gtid, size_t algn, size_t size,
20742074
ptr = hwloc_alloc(__kmp_hwloc_topology, desc.size_a);
20752075
}
20762076
} else {
2077-
#endif
2077+
#endif // KMP_HWLOC_ENABLED
20782078
if (__kmp_memkind_available) {
20792079
if (allocator < kmp_max_mem_alloc) {
20802080
// pre-defined allocator
@@ -2201,9 +2201,9 @@ void *__kmp_alloc(int gtid, size_t algn, size_t size,
22012201
KMP_ASSERT(0); // abort fallback requested
22022202
} // no sense to look for another fallback because of same internal alloc
22032203
}
2204-
#if KMP_USE_HWLOC
2204+
#if KMP_HWLOC_ENABLED
22052205
}
2206-
#endif
2206+
#endif // KMP_HWLOC_ENABLED
22072207
KE_TRACE(10, ("__kmp_alloc: T#%d %p=alloc(%d)\n", gtid, ptr, desc.size_a));
22082208
if (ptr == NULL)
22092209
return NULL;
@@ -2339,7 +2339,7 @@ void ___kmpc_free(int gtid, void *ptr, omp_allocator_handle_t allocator) {
23392339
kmp_target_unlock_mem(desc.ptr_alloc, device);
23402340
}
23412341

2342-
#if KMP_USE_HWLOC
2342+
#if KMP_HWLOC_ENABLED
23432343
if (__kmp_hwloc_available) {
23442344
if (oal > kmp_max_mem_alloc && al->pool_size > 0) {
23452345
kmp_uint64 used =
@@ -2349,7 +2349,7 @@ void ___kmpc_free(int gtid, void *ptr, omp_allocator_handle_t allocator) {
23492349
}
23502350
hwloc_free(__kmp_hwloc_topology, desc.ptr_alloc, desc.size_a);
23512351
} else {
2352-
#endif
2352+
#endif // KMP_HWLOC_ENABLED
23532353
if (__kmp_memkind_available) {
23542354
if (oal < kmp_max_mem_alloc) {
23552355
// pre-defined allocator
@@ -2378,9 +2378,9 @@ void ___kmpc_free(int gtid, void *ptr, omp_allocator_handle_t allocator) {
23782378
}
23792379
__kmp_thread_free(__kmp_thread_from_gtid(gtid), desc.ptr_alloc);
23802380
}
2381-
#if KMP_USE_HWLOC
2381+
#if KMP_HWLOC_ENABLED
23822382
}
2383-
#endif
2383+
#endif // KMP_HWLOC_ENABLED
23842384
}
23852385

23862386
/* If LEAK_MEMORY is defined, __kmp_free() will *not* free memory. It causes

‎openmp/runtime/src/kmp_dispatch.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,12 +182,12 @@ template <typename T> struct dispatch_shared_info_template {
182182
#if KMP_USE_HIER_SCHED
183183
kmp_hier_t<T> *hier;
184184
#endif
185-
#if KMP_USE_HWLOC
185+
#if KMP_HWLOC_ENABLED
186186
// When linking with libhwloc, the ORDERED EPCC test slowsdown on big
187187
// machines (> 48 cores). Performance analysis showed that a cache thrash
188188
// was occurring and this padding helps alleviate the problem.
189189
char padding[64];
190-
#endif
190+
#endif // KMP_HWLOC_ENABLED
191191
};
192192

193193
/* ------------------------------------------------------------------------ */

‎openmp/runtime/src/kmp_global.cpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -250,10 +250,10 @@ enum mic_type __kmp_mic_type = non_mic;
250250

251251
KMPAffinity *__kmp_affinity_dispatch = NULL;
252252

253-
#if KMP_USE_HWLOC
253+
#if KMP_HWLOC_ENABLED
254254
int __kmp_hwloc_error = FALSE;
255255
hwloc_topology_t __kmp_hwloc_topology = NULL;
256-
#endif
256+
#endif // KMP_HWLOC_ENABLED
257257

258258
#if KMP_OS_WINDOWS
259259
#if KMP_GROUP_AFFINITY

0 commit comments

Comments
 (0)