Hardware Locality (hwloc)  PR-737-20250925.0822.gite8f69c77f
openfabrics-verbs.h
1 /*
2  * SPDX-License-Identifier: BSD-3-Clause
3  * Copyright © 2009 CNRS
4  * Copyright © 2009-2024 Inria. All rights reserved.
5  * Copyright © 2009-2010 Université Bordeaux
6  * Copyright © 2009-2011 Cisco Systems, Inc. All rights reserved.
7  * See COPYING in top-level directory.
8  */
9 
20 #ifndef HWLOC_OPENFABRICS_VERBS_H
21 #define HWLOC_OPENFABRICS_VERBS_H
22 
23 #include "hwloc.h"
24 #include "hwloc/autogen/config.h"
25 #ifdef HWLOC_LINUX_SYS
26 #include "hwloc/linux.h"
27 #endif
28 
29 #include <infiniband/verbs.h>
30 
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 
65 static __hwloc_inline int
66 hwloc_ibv_get_device_cpuset(hwloc_topology_t topology __hwloc_attribute_unused,
67  struct ibv_device *ibdev, hwloc_cpuset_t set)
68 {
69 #ifdef HWLOC_LINUX_SYS
70  /* If we're on Linux, use the verbs-provided sysfs mechanism to
71  get the local cpus */
72 #define HWLOC_OPENFABRICS_VERBS_SYSFS_PATH_MAX 128
73  char path[HWLOC_OPENFABRICS_VERBS_SYSFS_PATH_MAX];
74 
75  if (!hwloc_topology_is_thissystem(topology)) {
76  errno = EINVAL;
77  return -1;
78  }
79 
80  sprintf(path, "/sys/class/infiniband/%s/device/local_cpus",
81  ibv_get_device_name(ibdev));
82  if (hwloc_linux_read_path_as_cpumask(path, set) < 0
83  || hwloc_bitmap_iszero(set))
85 #else
86  /* Non-Linux systems simply get a full cpuset */
88 #endif
89  return 0;
90 }
91 
109 static __hwloc_inline hwloc_obj_t
111  const char *ibname)
112 {
113  hwloc_obj_t osdev = NULL;
114  while ((osdev = hwloc_get_next_osdev(topology, osdev)) != NULL) {
115  if ((osdev->attr->osdev.types & HWLOC_OBJ_OSDEV_OPENFABRICS) /* assume future OFED devices will be at least OFED */
116  && osdev->name && !strcmp(ibname, osdev->name))
117  return osdev;
118  }
119  return NULL;
120 }
121 
137 static __hwloc_inline hwloc_obj_t
139  struct ibv_device *ibdev)
140 {
141  if (!hwloc_topology_is_thissystem(topology)) {
142  errno = EINVAL;
143  return NULL;
144  }
145  return hwloc_ibv_get_device_osdev_by_name(topology, ibv_get_device_name(ibdev));
146 }
147 
151 #ifdef __cplusplus
152 } /* extern "C" */
153 #endif
154 
155 
156 #endif /* HWLOC_OPENFABRICS_VERBS_H */
hwloc_bitmap_iszero
int hwloc_bitmap_iszero(hwloc_const_bitmap_t bitmap)
Test whether bitmap bitmap is empty.
hwloc_obj
Structure of a topology object.
Definition: hwloc.h:488
hwloc_topology_t
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:778
hwloc_linux_read_path_as_cpumask
int hwloc_linux_read_path_as_cpumask(const char *path, hwloc_bitmap_t set)
Convert a linux kernel cpumask file path into a hwloc bitmap set.
hwloc_obj_attr_u::osdev
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
hwloc_topology_get_complete_cpuset
hwloc_const_cpuset_t hwloc_topology_get_complete_cpuset(hwloc_topology_t topology)
Get complete CPU set.
hwloc_ibv_get_device_osdev
hwloc_obj_t hwloc_ibv_get_device_osdev(hwloc_topology_t topology, struct ibv_device *ibdev)
Get the hwloc OS device object corresponding to the OpenFabrics device ibdev.
Definition: openfabrics-verbs.h:138
hwloc_obj::attr
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:507
hwloc_ibv_get_device_osdev_by_name
hwloc_obj_t hwloc_ibv_get_device_osdev_by_name(hwloc_topology_t topology, const char *ibname)
Get the hwloc OS device object corresponding to the OpenFabrics device named ibname.
Definition: openfabrics-verbs.h:110
hwloc_obj_attr_u::hwloc_osdev_attr_s::types
hwloc_obj_osdev_types_t types
OR'ed set of at least one hwloc_obj_osdev_type_e.
Definition: hwloc.h:761
hwloc_obj::name
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:500
hwloc_cpuset_t
hwloc_bitmap_t hwloc_cpuset_t
A CPU set is a bitmap whose bits are set according to CPU physical OS indexes.
Definition: hwloc.h:162
HWLOC_OBJ_OSDEV_OPENFABRICS
@ HWLOC_OBJ_OSDEV_OPENFABRICS
Operating system OpenFabrics device. For instance the "mlx4_0" InfiniBand HCA, or "hfi1_0" Omni-Path ...
Definition: hwloc.h:409
hwloc_bitmap_copy
int hwloc_bitmap_copy(hwloc_bitmap_t dst, hwloc_const_bitmap_t src)
Copy the contents of bitmap src into the already allocated bitmap dst.
hwloc_ibv_get_device_cpuset
int hwloc_ibv_get_device_cpuset(hwloc_topology_t topology, struct ibv_device *ibdev, hwloc_cpuset_t set)
Get the CPU set of processors that are physically close to device ibdev.
Definition: openfabrics-verbs.h:66
hwloc_get_next_osdev
hwloc_obj_t hwloc_get_next_osdev(hwloc_topology_t topology, hwloc_obj_t prev)
Get the next OS device in the system.
Definition: helper.h:1291
hwloc_topology_is_thissystem
int hwloc_topology_is_thissystem(hwloc_topology_t restrict topology)
Does the topology context come from this system?