Hardware Locality (hwloc)  master-20250612.1317.gitd03ae8e67
plugins.h
1 /*
2  * Copyright © 2013-2024 Inria. All rights reserved.
3  * Copyright © 2016 Cisco Systems, Inc. All rights reserved.
4  * See COPYING in top-level directory.
5  */
6 
7 #ifndef HWLOC_PLUGINS_H
8 #define HWLOC_PLUGINS_H
9 
14 struct hwloc_backend;
15 
16 #include "hwloc.h"
17 
18 #ifdef HWLOC_INSIDE_PLUGIN
19 /* needed for hwloc_plugin_check_namespace() */
20 #ifdef HWLOC_HAVE_LTDL
21 #include <ltdl.h>
22 #else
23 #include <dlfcn.h>
24 #endif
25 #endif
26 
27 
28 
45  const char *name;
46 
50  unsigned phases;
51 
60  unsigned excluded_phases;
61 
65  struct hwloc_backend * (*instantiate)(struct hwloc_topology *topology, struct hwloc_disc_component *component, unsigned excluded_phases, const void *data1, const void *data2, const void *data3);
66 
79  unsigned priority;
80 
85 
90  struct hwloc_disc_component * next;
91 };
92 
94 typedef enum hwloc_disc_phase_e {
100 
104 
108 
112 
116 
120 
124 
132 
137 };
138 
149 
153  unsigned excluded_phases;
154 
156  unsigned long flags;
157 };
158 
179  struct hwloc_disc_component * component;
181  struct hwloc_topology * topology;
183  int envvar_forced;
185  struct hwloc_backend * next;
186 
190  unsigned phases;
191 
193  unsigned long flags;
194 
202 
206  void (*disable)(struct hwloc_backend *backend);
207 
213  int (*discover)(struct hwloc_backend *backend, struct hwloc_disc_status *status);
214 
219  int (*get_pci_busid_cpuset)(struct hwloc_backend *backend, struct hwloc_pcidev_attr_s *busid, hwloc_bitmap_t cpuset);
220 };
221 
223 #define HWLOC_BACKEND_PRIVATE_DATA(_backend) (void*)(((char*)(_backend)) + sizeof(struct hwloc_backend))
224 
231 HWLOC_DECLSPEC struct hwloc_backend * hwloc_backend_alloc(struct hwloc_topology *topology, struct hwloc_disc_component *component, unsigned long private_data_size);
232 
234 HWLOC_DECLSPEC int hwloc_backend_enable(struct hwloc_backend *backend);
235 
252 
256 
264  unsigned abi;
265 
283  int (*init)(unsigned long flags);
284 
296  void (*finalize)(unsigned long flags);
297 
300 
302  unsigned long flags;
303 
305  void * data;
306 };
307 
329 static __hwloc_inline int
330 hwloc_plugin_check_namespace(const char *pluginname __hwloc_attribute_unused, const char *symbol __hwloc_attribute_unused)
331 {
332 #ifdef HWLOC_INSIDE_PLUGIN
333  void *sym;
334 #ifdef HWLOC_HAVE_LTDL
335  lt_dlhandle handle = lt_dlopen(NULL);
336 #else
337  void *handle = dlopen(NULL, RTLD_NOW|RTLD_LOCAL);
338 #endif
339  if (!handle)
340  /* cannot check, assume things will work */
341  return 0;
342 #ifdef HWLOC_HAVE_LTDL
343  sym = lt_dlsym(handle, symbol);
344  lt_dlclose(handle);
345 #else
346  sym = dlsym(handle, symbol);
347  dlclose(handle);
348 #endif
349  if (!sym) {
350  static int verboseenv_checked = 0;
351  static int verboseenv_value = 0;
352  if (!verboseenv_checked) {
353  const char *verboseenv = getenv("HWLOC_PLUGINS_VERBOSE");
354  verboseenv_value = verboseenv ? atoi(verboseenv) : 0;
355  verboseenv_checked = 1;
356  }
357  if (verboseenv_value)
358  fprintf(stderr, "Plugin `%s' disabling itself because it cannot find the `%s' core symbol.\n",
359  pluginname, symbol);
360  return -1;
361  }
362 #endif /* HWLOC_INSIDE_PLUGIN */
363  return 0;
364 }
365 
395 HWLOC_DECLSPEC int hwloc_hide_errors(void);
396 
397 #define HWLOC_SHOW_CRITICAL_ERRORS() (hwloc_hide_errors() < 2)
398 #define HWLOC_SHOW_ALL_ERRORS() (hwloc_hide_errors() == 0)
399 
428 HWLOC_DECLSPEC hwloc_obj_t
429 hwloc__insert_object_by_cpuset(struct hwloc_topology *topology, hwloc_obj_t root,
430  hwloc_obj_t obj, const char *reason);
431 
448 HWLOC_DECLSPEC void hwloc_insert_object_by_parent(struct hwloc_topology *topology, hwloc_obj_t parent, hwloc_obj_t obj);
449 
454 HWLOC_DECLSPEC hwloc_obj_t hwloc_alloc_setup_object(hwloc_topology_t topology, hwloc_obj_type_t type, unsigned os_index);
455 
464 HWLOC_DECLSPEC int hwloc_obj_add_children_sets(hwloc_obj_t obj);
465 
473 HWLOC_DECLSPEC int hwloc_topology_reconnect(hwloc_topology_t topology, unsigned long flags __hwloc_attribute_unused);
474 
491 static __hwloc_inline int
493 {
494  unsigned baseclass = classid >> 8;
495  return (baseclass == 0x03 /* PCI_BASE_CLASS_DISPLAY */
496  || baseclass == 0x02 /* PCI_BASE_CLASS_NETWORK */
497  || baseclass == 0x01 /* PCI_BASE_CLASS_STORAGE */
498  || baseclass == 0x00 /* Unclassified, for Atos/Bull BXI */
499  || baseclass == 0x0b /* PCI_BASE_CLASS_PROCESSOR */
500  || classid == 0x0c04 /* PCI_CLASS_SERIAL_FIBER */
501  || classid == 0x0c06 /* PCI_CLASS_SERIAL_INFINIBAND */
502  || classid == 0x0502 /* PCI_CLASS_MEMORY_CXL */
503  || baseclass == 0x06 /* PCI_BASE_CLASS_BRIDGE with non-PCI downstream. the core will drop the useless ones later */
504  || baseclass == 0x12 /* Processing Accelerators */);
505 }
506 
511 static __hwloc_inline int
513 {
514  return (subtype && subtype != HWLOC_OBJ_OSDEV_DMA);
515 }
516 
523 static __hwloc_inline int
525 {
527  hwloc_topology_get_type_filter(topology, type, &filter);
528  assert(filter != HWLOC_TYPE_FILTER_KEEP_IMPORTANT); /* IMPORTANT only used for I/O */
529  return filter == HWLOC_TYPE_FILTER_KEEP_NONE ? 0 : 1;
530 }
531 
536 static __hwloc_inline int
538 {
539  hwloc_obj_type_t type = obj->type;
541  hwloc_topology_get_type_filter(topology, type, &filter);
542  if (filter == HWLOC_TYPE_FILTER_KEEP_NONE)
543  return 0;
544  if (filter == HWLOC_TYPE_FILTER_KEEP_IMPORTANT) {
545  if (type == HWLOC_OBJ_PCI_DEVICE)
547  if (type == HWLOC_OBJ_OS_DEVICE)
549  }
550  return 1;
551 }
552 
569 HWLOC_DECLSPEC unsigned hwloc_pcidisc_find_cap(const unsigned char *config, unsigned cap);
570 
576 HWLOC_DECLSPEC int hwloc_pcidisc_find_linkspeed(const unsigned char *config, unsigned offset, float *linkspeed);
577 
582 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_pcidisc_check_bridge_type(unsigned device_class, const unsigned char *config);
583 
590 HWLOC_DECLSPEC int hwloc_pcidisc_find_bridge_buses(unsigned domain, unsigned bus, unsigned dev, unsigned func,
591  unsigned *secondary_busp, unsigned *subordinate_busp,
592  const unsigned char *config);
593 
598 HWLOC_DECLSPEC void hwloc_pcidisc_tree_insert_by_busid(struct hwloc_obj **treep, struct hwloc_obj *obj);
599 
605 HWLOC_DECLSPEC int hwloc_pcidisc_tree_attach(struct hwloc_topology *topology, struct hwloc_obj *tree);
606 
630 HWLOC_DECLSPEC struct hwloc_obj * hwloc_pci_find_parent_by_busid(struct hwloc_topology *topology, unsigned domain, unsigned bus, unsigned dev, unsigned func);
631 
638 HWLOC_DECLSPEC struct hwloc_obj * hwloc_pci_find_by_busid(struct hwloc_topology *topology, unsigned domain, unsigned bus, unsigned dev, unsigned func);
639 
640 
655 
664  const char *name, unsigned long kind,
665  unsigned long flags);
666 
678 HWLOC_DECLSPEC int
681  unsigned nbobjs, hwloc_obj_t *objs,
682  hwloc_uint64_t *values,
683  unsigned long flags);
684 
691 HWLOC_DECLSPEC int
694  unsigned long flags);
695 
701 #endif /* HWLOC_PLUGINS_H */
hwloc_pcidisc_find_bridge_buses
int hwloc_pcidisc_find_bridge_buses(unsigned domain, unsigned bus, unsigned dev, unsigned func, unsigned *secondary_busp, unsigned *subordinate_busp, const unsigned char *config)
Fills the attributes of the given PCI bridge using the given PCI config space.
hwloc_backend_distances_add_handle_t
void * hwloc_backend_distances_add_handle_t
Handle to a new distances structure during its addition to the topology.
Definition: plugins.h:654
HWLOC_OBJ_OS_DEVICE
@ HWLOC_OBJ_OS_DEVICE
Operating system device (filtered out by default).
Definition: hwloc.h:329
HWLOC_COMPONENT_TYPE_DISC
@ HWLOC_COMPONENT_TYPE_DISC
The data field must point to a struct hwloc_disc_component.
Definition: plugins.h:251
hwloc_disc_component::priority
unsigned priority
Component priority. Used to sort topology->components, higher priority first. Also used to decide bet...
Definition: plugins.h:79
hwloc_component_type_e
hwloc_component_type_e
Generic component type.
Definition: plugins.h:249
hwloc_disc_phase_e
hwloc_disc_phase_e
Discovery phase.
Definition: plugins.h:94
hwloc_disc_component::excluded_phases
unsigned excluded_phases
Component phases to exclude, as an OR'ed set of hwloc_disc_phase_t.
Definition: plugins.h:60
HWLOC_COMPONENT_TYPE_XML
@ HWLOC_COMPONENT_TYPE_XML
The data field must point to a struct hwloc_xml_component.
Definition: plugins.h:254
hwloc_backend::disable
void(* disable)(struct hwloc_backend *backend)
Callback for freeing things stored inside the private data. May be NULL.
Definition: plugins.h:206
hwloc_disc_status::phase
hwloc_disc_phase_t phase
The current discovery phase that is performed. Must match one of the phases in the component phases f...
Definition: plugins.h:148
hwloc_obj_attr_u::osdev
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
hwloc_pci_find_by_busid
struct hwloc_obj * hwloc_pci_find_by_busid(struct hwloc_topology *topology, unsigned domain, unsigned bus, unsigned dev, unsigned func)
Find the PCI device or bridge matching a PCI bus ID exactly.
hwloc_obj_attr_u::hwloc_pcidev_attr_s::class_id
unsigned short class_id
The class number (first two bytes, without the prog_if).
Definition: hwloc.h:729
hwloc_obj::type
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:489
hwloc_backend_alloc
struct hwloc_backend * hwloc_backend_alloc(struct hwloc_topology *topology, struct hwloc_disc_component *component, unsigned long private_data_size)
Allocate a backend structure, set good default values, initialize backend->component and topology,...
hwloc_filter_check_osdev_subtype_important
int hwloc_filter_check_osdev_subtype_important(hwloc_obj_osdev_types_t subtype)
Check whether the given OS device subtype is important.
Definition: plugins.h:512
hwloc_backend_distances_add_create
hwloc_backend_distances_add_handle_t hwloc_backend_distances_add_create(hwloc_topology_t topology, const char *name, unsigned long kind, unsigned long flags)
Create a new empty distances structure.
HWLOC_DISC_PHASE_GLOBAL
@ HWLOC_DISC_PHASE_GLOBAL
xml or synthetic, platform-specific components. Discovers everything including CPU,...
Definition: plugins.h:99
hwloc_component::init
int(* init)(unsigned long flags)
Process-wide component initialization callback.
Definition: plugins.h:283
HWLOC_OBJ_PCI_DEVICE
@ HWLOC_OBJ_PCI_DEVICE
PCI device (filtered out by default).
Definition: hwloc.h:319
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:506
hwloc_filter_check_keep_object
int hwloc_filter_check_keep_object(hwloc_topology_t topology, hwloc_obj_t obj)
Check whether the given object should be filtered-out.
Definition: plugins.h:537
hwloc_bitmap_t
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:69
hwloc_obj_osdev_types_t
unsigned long hwloc_obj_osdev_types_t
Type(s) of a OS device. OR'ed set of hwloc_obj_osdev_type_e.
Definition: hwloc.h:423
hwloc_obj_type_t
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:197
hwloc_topology_t
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:777
hwloc_disc_component
Discovery component structure.
Definition: plugins.h:41
HWLOC_DISC_PHASE_ANNOTATE
@ HWLOC_DISC_PHASE_ANNOTATE
Annotating existing objects, adding distances, etc.
Definition: plugins.h:123
hwloc_backend::phases
unsigned phases
Discovery phases performed by this component, possibly without some of them if excluded by other comp...
Definition: plugins.h:190
hwloc_pcidisc_tree_attach
int hwloc_pcidisc_tree_attach(struct hwloc_topology *topology, struct hwloc_obj *tree)
Add some hostbridges on top of the given tree of PCI objects and attach them to the topology.
hwloc_disc_status_flag_e
hwloc_disc_status_flag_e
Discovery status flags.
Definition: plugins.h:134
hwloc_pcidisc_tree_insert_by_busid
void hwloc_pcidisc_tree_insert_by_busid(struct hwloc_obj **treep, struct hwloc_obj *obj)
Insert a PCI object in the given PCI tree by looking at PCI bus IDs.
hwloc_backend_distances_add_values
int hwloc_backend_distances_add_values(hwloc_topology_t topology, hwloc_backend_distances_add_handle_t handle, unsigned nbobjs, hwloc_obj_t *objs, hwloc_uint64_t *values, unsigned long flags)
Specify the objects and values in a new empty distances structure.
hwloc_obj
Structure of a topology object.
Definition: hwloc.h:487
HWLOC_TYPE_FILTER_KEEP_IMPORTANT
@ HWLOC_TYPE_FILTER_KEEP_IMPORTANT
Only keep likely-important objects of the given type.
Definition: hwloc.h:2639
hwloc_disc_component::name
const char * name
Name. If this component is built as a plugin, this name does not have to match the plugin filename.
Definition: plugins.h:45
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:760
HWLOC_DISC_PHASE_PCI
@ HWLOC_DISC_PHASE_PCI
Attach PCI devices and bridges to existing CPU objects.
Definition: plugins.h:111
hwloc_backend
Discovery backend structure.
Definition: plugins.h:177
HWLOC_TYPE_FILTER_KEEP_NONE
@ HWLOC_TYPE_FILTER_KEEP_NONE
Ignore all objects of this type.
Definition: hwloc.h:2610
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:499
hwloc_pci_find_parent_by_busid
struct hwloc_obj * hwloc_pci_find_parent_by_busid(struct hwloc_topology *topology, unsigned domain, unsigned bus, unsigned dev, unsigned func)
Find the object or a parent of a PCI bus ID.
hwloc_disc_status::excluded_phases
unsigned excluded_phases
Dynamically excluded phases. If a component decides during discovery that some phases are no longer n...
Definition: plugins.h:153
hwloc_disc_component::enabled_by_default
unsigned enabled_by_default
Enabled by default. If unset, if will be disabled unless explicitly requested.
Definition: plugins.h:84
hwloc_topology_reconnect
int hwloc_topology_reconnect(hwloc_topology_t topology, unsigned long flags)
Request a reconnection of children and levels in the topology.
hwloc_filter_check_pcidev_subtype_important
int hwloc_filter_check_pcidev_subtype_important(unsigned classid)
Check whether the given PCI device classid is important.
Definition: plugins.h:492
HWLOC_DISC_PHASE_MEMORY
@ HWLOC_DISC_PHASE_MEMORY
Attach memory to existing CPU objects.
Definition: plugins.h:107
hwloc_component::abi
unsigned abi
Component ABI version, set to HWLOC_COMPONENT_ABI.
Definition: plugins.h:264
hwloc_topology_get_type_filter
int hwloc_topology_get_type_filter(hwloc_topology_t topology, hwloc_obj_type_t type, enum hwloc_type_filter_e *filter)
Get the current filtering for the given object type.
hwloc_pcidisc_check_bridge_type
hwloc_obj_type_t hwloc_pcidisc_check_bridge_type(unsigned device_class, const unsigned char *config)
Return the hwloc object type (PCI device or Bridge) for the given class and configuration space.
hwloc_disc_component::phases
unsigned phases
Discovery phases performed by this component. OR'ed set of hwloc_disc_phase_t.
Definition: plugins.h:50
hwloc_component::flags
unsigned long flags
Component flags, unused for now.
Definition: plugins.h:302
hwloc_obj_attr_u::pcidev
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
HWLOC_DISC_PHASE_MISC
@ HWLOC_DISC_PHASE_MISC
Misc objects that gets added below anything else.
Definition: plugins.h:119
hwloc_disc_phase_t
enum hwloc_disc_phase_e hwloc_disc_phase_t
Discovery phase.
hwloc_component::type
hwloc_component_type_t type
Component type.
Definition: plugins.h:299
hwloc_plugin_check_namespace
int hwloc_plugin_check_namespace(const char *pluginname, const char *symbol)
Make sure that plugins can lookup core symbols.
Definition: plugins.h:330
hwloc_backend::flags
unsigned long flags
Backend flags, currently always 0.
Definition: plugins.h:193
hwloc_disc_status::flags
unsigned long flags
OR'ed set of hwloc_disc_status_flag_e.
Definition: plugins.h:156
hwloc_type_filter_e
hwloc_type_filter_e
Type filtering flags.
Definition: hwloc.h:2596
hwloc_component::data
void * data
Component data, pointing to a struct hwloc_disc_component or struct hwloc_xml_component.
Definition: plugins.h:305
HWLOC_DISC_STATUS_FLAG_GOT_ALLOWED_RESOURCES
@ HWLOC_DISC_STATUS_FLAG_GOT_ALLOWED_RESOURCES
The sets of allowed resources were already retrieved.
Definition: plugins.h:136
hwloc_backend::is_thissystem
int is_thissystem
Backend-specific 'is_thissystem' property. Set to 0 if the backend disables the thissystem flag for t...
Definition: plugins.h:201
hwloc_disc_status
Discovery status structure.
Definition: plugins.h:144
HWLOC_DISC_PHASE_TWEAK
@ HWLOC_DISC_PHASE_TWEAK
Final tweaks to a ready-to-use topology. This phase runs once the topology is loaded,...
Definition: plugins.h:130
HWLOC_DISC_PHASE_CPU
@ HWLOC_DISC_PHASE_CPU
CPU discovery.
Definition: plugins.h:103
hwloc_insert_object_by_parent
void hwloc_insert_object_by_parent(struct hwloc_topology *topology, hwloc_obj_t parent, hwloc_obj_t obj)
Insert an object somewhere in the topology.
hwloc_hide_errors
int hwloc_hide_errors(void)
Check whether error messages are hidden.
hwloc_backend::discover
int(* discover)(struct hwloc_backend *backend, struct hwloc_disc_status *status)
Main discovery callback. returns -1 on error, either because it couldn't add its objects ot the exist...
Definition: plugins.h:213
HWLOC_DISC_PHASE_IO
@ HWLOC_DISC_PHASE_IO
I/O discovery that requires PCI devices (OS devices such as OpenCL, CUDA, etc.).
Definition: plugins.h:115
hwloc__insert_object_by_cpuset
hwloc_obj_t hwloc__insert_object_by_cpuset(struct hwloc_topology *topology, hwloc_obj_t root, hwloc_obj_t obj, const char *reason)
Add an object to the topology.
hwloc_alloc_setup_object
hwloc_obj_t hwloc_alloc_setup_object(hwloc_topology_t topology, hwloc_obj_type_t type, unsigned os_index)
Allocate and initialize an object of the given type and physical index.
hwloc_component
Generic component structure.
Definition: plugins.h:262
hwloc_pcidisc_find_cap
unsigned hwloc_pcidisc_find_cap(const unsigned char *config, unsigned cap)
Return the offset of the given capability in the PCI config space buffer.
hwloc_component_type_t
enum hwloc_component_type_e hwloc_component_type_t
Generic component type.
hwloc_obj_add_children_sets
int hwloc_obj_add_children_sets(hwloc_obj_t obj)
Setup object cpusets/nodesets by OR'ing its children.
hwloc_backend::get_pci_busid_cpuset
int(* get_pci_busid_cpuset)(struct hwloc_backend *backend, struct hwloc_pcidev_attr_s *busid, hwloc_bitmap_t cpuset)
Callback to retrieve the locality of a PCI object. Called by the PCI core when attaching PCI hierarch...
Definition: plugins.h:219
hwloc_pcidisc_find_linkspeed
int hwloc_pcidisc_find_linkspeed(const unsigned char *config, unsigned offset, float *linkspeed)
Fill linkspeed by reading the PCI config space where PCI_CAP_ID_EXP is at position offset.
hwloc_component::finalize
void(* finalize)(unsigned long flags)
Process-wide component termination callback.
Definition: plugins.h:296
hwloc_backend_enable
int hwloc_backend_enable(struct hwloc_backend *backend)
Enable a previously allocated and setup backend.
hwloc_backend_distances_add_commit
int hwloc_backend_distances_add_commit(hwloc_topology_t topology, hwloc_backend_distances_add_handle_t handle, unsigned long flags)
Commit a new distances structure.
hwloc_filter_check_keep_object_type
int hwloc_filter_check_keep_object_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Check whether a non-I/O object type should be filtered-out.
Definition: plugins.h:524
HWLOC_OBJ_OSDEV_DMA
@ HWLOC_OBJ_OSDEV_DMA
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:414