Hardware Locality (hwloc)  v2.8-20240516.1852.gitc5dfa82e
plugins.h
1 /*
2  * Copyright © 2013-2021 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 
106 typedef enum hwloc_disc_phase_e {
112 
116 
120 
124 
128 
132 
136 
144 
149 };
150 
161 
165  unsigned excluded_phases;
166 
168  unsigned long flags;
169 };
170 
191  struct hwloc_disc_component * component;
193  struct hwloc_topology * topology;
195  int envvar_forced;
197  struct hwloc_backend * next;
198 
202  unsigned phases;
203 
205  unsigned long flags;
206 
214 
216  void * private_data;
220  void (*disable)(struct hwloc_backend *backend);
221 
227  int (*discover)(struct hwloc_backend *backend, struct hwloc_disc_status *status);
228 
233  int (*get_pci_busid_cpuset)(struct hwloc_backend *backend, struct hwloc_pcidev_attr_s *busid, hwloc_bitmap_t cpuset);
234 };
235 
239 HWLOC_DECLSPEC struct hwloc_backend * hwloc_backend_alloc(struct hwloc_topology *topology, struct hwloc_disc_component *component);
240 
242 HWLOC_DECLSPEC int hwloc_backend_enable(struct hwloc_backend *backend);
243 
260 
264 
272  unsigned abi;
273 
291  int (*init)(unsigned long flags);
292 
304  void (*finalize)(unsigned long flags);
305 
308 
310  unsigned long flags;
311 
313  void * data;
314 };
315 
342 HWLOC_DECLSPEC int hwloc_hide_errors(void);
343 
372 HWLOC_DECLSPEC hwloc_obj_t
373 hwloc__insert_object_by_cpuset(struct hwloc_topology *topology, hwloc_obj_t root,
374  hwloc_obj_t obj, const char *reason);
375 
392 HWLOC_DECLSPEC void hwloc_insert_object_by_parent(struct hwloc_topology *topology, hwloc_obj_t parent, hwloc_obj_t obj);
393 
398 HWLOC_DECLSPEC hwloc_obj_t hwloc_alloc_setup_object(hwloc_topology_t topology, hwloc_obj_type_t type, unsigned os_index);
399 
408 HWLOC_DECLSPEC int hwloc_obj_add_children_sets(hwloc_obj_t obj);
409 
417 HWLOC_DECLSPEC int hwloc_topology_reconnect(hwloc_topology_t topology, unsigned long flags __hwloc_attribute_unused);
418 
440 static __hwloc_inline int
441 hwloc_plugin_check_namespace(const char *pluginname __hwloc_attribute_unused, const char *symbol __hwloc_attribute_unused)
442 {
443 #ifdef HWLOC_INSIDE_PLUGIN
444  void *sym;
445 #ifdef HWLOC_HAVE_LTDL
446  lt_dlhandle handle = lt_dlopen(NULL);
447 #else
448  void *handle = dlopen(NULL, RTLD_NOW|RTLD_LOCAL);
449 #endif
450  if (!handle)
451  /* cannot check, assume things will work */
452  return 0;
453 #ifdef HWLOC_HAVE_LTDL
454  sym = lt_dlsym(handle, symbol);
455  lt_dlclose(handle);
456 #else
457  sym = dlsym(handle, symbol);
458  dlclose(handle);
459 #endif
460  if (!sym) {
461  static int verboseenv_checked = 0;
462  static int verboseenv_value = 0;
463  if (!verboseenv_checked) {
464  const char *verboseenv = getenv("HWLOC_PLUGINS_VERBOSE");
465  verboseenv_value = verboseenv ? atoi(verboseenv) : 0;
466  verboseenv_checked = 1;
467  }
468  if (verboseenv_value)
469  fprintf(stderr, "Plugin `%s' disabling itself because it cannot find the `%s' core symbol.\n",
470  pluginname, symbol);
471  return -1;
472  }
473 #endif /* HWLOC_INSIDE_PLUGIN */
474  return 0;
475 }
476 
493 static __hwloc_inline int
495 {
496  unsigned baseclass = classid >> 8;
497  return (baseclass == 0x03 /* PCI_BASE_CLASS_DISPLAY */
498  || baseclass == 0x02 /* PCI_BASE_CLASS_NETWORK */
499  || baseclass == 0x01 /* PCI_BASE_CLASS_STORAGE */
500  || baseclass == 0x00 /* Unclassified, for Atos/Bull BXI */
501  || baseclass == 0x0b /* PCI_BASE_CLASS_PROCESSOR */
502  || classid == 0x0c04 /* PCI_CLASS_SERIAL_FIBER */
503  || classid == 0x0c06 /* PCI_CLASS_SERIAL_INFINIBAND */
504  || classid == 0x0502 /* PCI_CLASS_MEMORY_CXL */
505  || baseclass == 0x06 /* PCI_BASE_CLASS_BRIDGE with non-PCI downstream. the core will drop the useless ones later */
506  || baseclass == 0x12 /* Processing Accelerators */);
507 }
508 
513 static __hwloc_inline int
515 {
516  return (subtype != HWLOC_OBJ_OSDEV_DMA);
517 }
518 
525 static __hwloc_inline int
527 {
529  hwloc_topology_get_type_filter(topology, type, &filter);
530  assert(filter != HWLOC_TYPE_FILTER_KEEP_IMPORTANT); /* IMPORTANT only used for I/O */
531  return filter == HWLOC_TYPE_FILTER_KEEP_NONE ? 0 : 1;
532 }
533 
538 static __hwloc_inline int
540 {
541  hwloc_obj_type_t type = obj->type;
543  hwloc_topology_get_type_filter(topology, type, &filter);
544  if (filter == HWLOC_TYPE_FILTER_KEEP_NONE)
545  return 0;
546  if (filter == HWLOC_TYPE_FILTER_KEEP_IMPORTANT) {
547  if (type == HWLOC_OBJ_PCI_DEVICE)
549  if (type == HWLOC_OBJ_OS_DEVICE)
551  }
552  return 1;
553 }
554 
571 HWLOC_DECLSPEC unsigned hwloc_pcidisc_find_cap(const unsigned char *config, unsigned cap);
572 
578 HWLOC_DECLSPEC int hwloc_pcidisc_find_linkspeed(const unsigned char *config, unsigned offset, float *linkspeed);
579 
584 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_pcidisc_check_bridge_type(unsigned device_class, const unsigned char *config);
585 
592 HWLOC_DECLSPEC int hwloc_pcidisc_find_bridge_buses(unsigned domain, unsigned bus, unsigned dev, unsigned func,
593  unsigned *secondary_busp, unsigned *subordinate_busp,
594  const unsigned char *config);
595 
600 HWLOC_DECLSPEC void hwloc_pcidisc_tree_insert_by_busid(struct hwloc_obj **treep, struct hwloc_obj *obj);
601 
607 HWLOC_DECLSPEC int hwloc_pcidisc_tree_attach(struct hwloc_topology *topology, struct hwloc_obj *tree);
608 
632 HWLOC_DECLSPEC struct hwloc_obj * hwloc_pci_find_parent_by_busid(struct hwloc_topology *topology, unsigned domain, unsigned bus, unsigned dev, unsigned func);
633 
640 HWLOC_DECLSPEC struct hwloc_obj * hwloc_pci_find_by_busid(struct hwloc_topology *topology, unsigned domain, unsigned bus, unsigned dev, unsigned func);
641 
644 
653  const char *name, unsigned long kind,
654  unsigned long flags);
655 
667 HWLOC_DECLSPEC int
670  unsigned nbobjs, hwloc_obj_t *objs,
671  hwloc_uint64_t *values,
672  unsigned long flags);
673 
680 HWLOC_DECLSPEC int
683  unsigned long flags);
684 
690 #endif /* HWLOC_PLUGINS_H */
int(* init)(unsigned long flags)
Process-wide component initialization callback.
Definition: plugins.h:291
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:439
unsigned long flags
Backend flags, currently always 0.
Definition: plugins.h:205
Final tweaks to a ready-to-use topology. This phase runs once the topology is loaded, before it is returned to the topology. Hence it may only use the main hwloc API for modifying the topology, for instance by restricting it, adding info attributes, etc.
Definition: plugins.h:142
static int hwloc_filter_check_osdev_subtype_important(hwloc_obj_osdev_type_t subtype)
Check whether the given OS device subtype is important.
Definition: plugins.h:514
void * private_data
Backend private data, or NULL if none.
Definition: plugins.h:216
Annotating existing objects, adding distances, etc.
Definition: plugins.h:135
The data field must point to a struct hwloc_disc_component.
Definition: plugins.h:259
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:160
Only keep likely-important objects of the given type.
Definition: hwloc.h:2408
struct hwloc_backend * hwloc_backend_alloc(struct hwloc_topology *topology, struct hwloc_disc_component *component)
Allocate a backend structure, set good default values, initialize backend->component and topology...
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.
void * hwloc_backend_distances_add_handle_t
Handle to a new distances structure during its addition to the topology.
Definition: plugins.h:643
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.
static 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:526
unsigned hwloc_pcidisc_find_cap(const unsigned char *config, unsigned cap)
Return the offset of the given capability in the PCI config space buffer.
void(* finalize)(unsigned long flags)
Process-wide component termination callback.
Definition: plugins.h:304
void * data
Component data, pointing to a struct hwloc_disc_component or struct hwloc_xml_component.
Definition: plugins.h:313
enum hwloc_disc_phase_e hwloc_disc_phase_t
Discovery phase.
Generic component structure.
Definition: plugins.h:270
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.
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...
Discovery component structure.
Definition: plugins.h:41
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:716
CPU discovery.
Definition: plugins.h:115
xml or synthetic, platform-specific components such as bgq. Discovers everything including CPU...
Definition: plugins.h:111
hwloc_component_type_t type
Component type.
Definition: plugins.h:307
unsigned excluded_phases
Dynamically excluded phases. If a component decides during discovery that some phases are no longer n...
Definition: plugins.h:165
unsigned phases
Discovery phases performed by this component. OR&#39;ed set of hwloc_disc_phase_t.
Definition: plugins.h:50
Discovery backend structure.
Definition: plugins.h:189
int hwloc_hide_errors(void)
Check whether error messages are hidden.
Misc objects that gets added below anything else.
Definition: plugins.h:131
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_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...
unsigned phases
Discovery phases performed by this component, possibly without some of them if excluded by other comp...
Definition: plugins.h:202
unsigned long flags
OR&#39;ed set of hwloc_disc_status_flag_e.
Definition: plugins.h:168
int hwloc_topology_reconnect(hwloc_topology_t topology, unsigned long flags)
Request a reconnection of children and levels in the topology.
Operating system device (filtered out by default).
Definition: hwloc.h:300
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.
int(* discover)(struct hwloc_backend *backend, struct hwloc_disc_status *status)
Main discovery callback. returns -1 on error, either because it couldn&#39;t add its objects ot the exist...
Definition: plugins.h:227
unsigned priority
Component priority. Used to sort topology->components, higher priority first. Also used to decide bet...
Definition: plugins.h:79
PCI device (filtered out by default).
Definition: hwloc.h:290
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.
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
static int hwloc_filter_check_pcidev_subtype_important(unsigned classid)
Check whether the given PCI device classid is important.
Definition: plugins.h:494
hwloc_component_type_e
Generic component type.
Definition: plugins.h:257
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:233
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
Discovery status flags.
Definition: plugins.h:146
int hwloc_backend_enable(struct hwloc_backend *backend)
Enable a previously allocated and setup backend.
enum hwloc_component_type_e hwloc_component_type_t
Generic component type.
The data field must point to a struct hwloc_xml_component.
Definition: plugins.h:262
unsigned abi
Component ABI version, set to HWLOC_COMPONENT_ABI.
Definition: plugins.h:272
The sets of allowed resources were already retrieved.
Definition: plugins.h:148
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_type_t
Type of topology object.
Definition: hwloc.h:197
unsigned long flags
Component flags, unused for now.
Definition: plugins.h:310
Attach PCI devices and bridges to existing CPU objects.
Definition: plugins.h:123
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_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_obj_osdev_type_t type
Definition: hwloc.h:690
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:372
hwloc_type_filter_e
Type filtering flags.
Definition: hwloc.h:2365
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.
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.
static 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:539
I/O discovery that requires PCI devices (OS devices such as OpenCL, CUDA, etc.).
Definition: plugins.h:127
static int hwloc_plugin_check_namespace(const char *pluginname, const char *symbol)
Make sure that plugins can lookup core symbols.
Definition: plugins.h:441
Attach memory to existing CPU objects.
Definition: plugins.h:119
unsigned excluded_phases
Component phases to exclude, as an OR&#39;ed set of hwloc_disc_phase_t.
Definition: plugins.h:60
unsigned short class_id
Definition: hwloc.h:664
hwloc_disc_phase_e
Discovery phase.
Definition: plugins.h:106
Ignore all objects of this type.
Definition: hwloc.h:2379
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:422
Discovery status structure.
Definition: plugins.h:156
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition: hwloc.h:432
int is_thissystem
Backend-specific &#39;is_thissystem&#39; property. Set to 0 if the backend disables the thissystem flag for t...
Definition: plugins.h:213
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
void(* disable)(struct hwloc_backend *backend)
Callback for freeing the private_data. May be NULL.
Definition: plugins.h:220
Structure of a topology object.
Definition: hwloc.h:420
unsigned enabled_by_default
Enabled by default. If unset, if will be disabled unless explicitly requested.
Definition: plugins.h:84
int hwloc_obj_add_children_sets(hwloc_obj_t obj)
Setup object cpusets/nodesets by OR&#39;ing its children.
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.