Open MPI logo

Portable Hardware Locality (hwloc) Documentation: v2.11.2

  |   Home   |   Support   |   FAQ   |  
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
14struct 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
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
144
150
161
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
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
239HWLOC_DECLSPEC struct hwloc_backend * hwloc_backend_alloc(struct hwloc_topology *topology, struct hwloc_disc_component *component);
240
242HWLOC_DECLSPEC int hwloc_backend_enable(struct hwloc_backend *backend);
243
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
345HWLOC_DECLSPEC int hwloc_hide_errors(void);
346
347#define HWLOC_SHOW_CRITICAL_ERRORS() (hwloc_hide_errors() < 2)
348#define HWLOC_SHOW_ALL_ERRORS() (hwloc_hide_errors() == 0)
349
378HWLOC_DECLSPEC hwloc_obj_t
379hwloc__insert_object_by_cpuset(struct hwloc_topology *topology, hwloc_obj_t root,
380 hwloc_obj_t obj, const char *reason);
381
398HWLOC_DECLSPEC void hwloc_insert_object_by_parent(struct hwloc_topology *topology, hwloc_obj_t parent, hwloc_obj_t obj);
399
404HWLOC_DECLSPEC hwloc_obj_t hwloc_alloc_setup_object(hwloc_topology_t topology, hwloc_obj_type_t type, unsigned os_index);
405
415
423HWLOC_DECLSPEC int hwloc_topology_reconnect(hwloc_topology_t topology, unsigned long flags __hwloc_attribute_unused);
424
446static __hwloc_inline int
447hwloc_plugin_check_namespace(const char *pluginname __hwloc_attribute_unused, const char *symbol __hwloc_attribute_unused)
448{
449#ifdef HWLOC_INSIDE_PLUGIN
450 void *sym;
451#ifdef HWLOC_HAVE_LTDL
452 lt_dlhandle handle = lt_dlopen(NULL);
453#else
454 void *handle = dlopen(NULL, RTLD_NOW|RTLD_LOCAL);
455#endif
456 if (!handle)
457 /* cannot check, assume things will work */
458 return 0;
459#ifdef HWLOC_HAVE_LTDL
460 sym = lt_dlsym(handle, symbol);
461 lt_dlclose(handle);
462#else
463 sym = dlsym(handle, symbol);
464 dlclose(handle);
465#endif
466 if (!sym) {
467 static int verboseenv_checked = 0;
468 static int verboseenv_value = 0;
469 if (!verboseenv_checked) {
470 const char *verboseenv = getenv("HWLOC_PLUGINS_VERBOSE");
471 verboseenv_value = verboseenv ? atoi(verboseenv) : 0;
472 verboseenv_checked = 1;
473 }
474 if (verboseenv_value)
475 fprintf(stderr, "Plugin `%s' disabling itself because it cannot find the `%s' core symbol.\n",
476 pluginname, symbol);
477 return -1;
478 }
479#endif /* HWLOC_INSIDE_PLUGIN */
480 return 0;
481}
482
499static __hwloc_inline int
501{
502 unsigned baseclass = classid >> 8;
503 return (baseclass == 0x03 /* PCI_BASE_CLASS_DISPLAY */
504 || baseclass == 0x02 /* PCI_BASE_CLASS_NETWORK */
505 || baseclass == 0x01 /* PCI_BASE_CLASS_STORAGE */
506 || baseclass == 0x00 /* Unclassified, for Atos/Bull BXI */
507 || baseclass == 0x0b /* PCI_BASE_CLASS_PROCESSOR */
508 || classid == 0x0c04 /* PCI_CLASS_SERIAL_FIBER */
509 || classid == 0x0c06 /* PCI_CLASS_SERIAL_INFINIBAND */
510 || classid == 0x0502 /* PCI_CLASS_MEMORY_CXL */
511 || baseclass == 0x06 /* PCI_BASE_CLASS_BRIDGE with non-PCI downstream. the core will drop the useless ones later */
512 || baseclass == 0x12 /* Processing Accelerators */);
513}
514
519static __hwloc_inline int
524
531static __hwloc_inline int
533{
535 hwloc_topology_get_type_filter(topology, type, &filter);
536 assert(filter != HWLOC_TYPE_FILTER_KEEP_IMPORTANT); /* IMPORTANT only used for I/O */
537 return filter == HWLOC_TYPE_FILTER_KEEP_NONE ? 0 : 1;
538}
539
544static __hwloc_inline int
546{
547 hwloc_obj_type_t type = obj->type;
549 hwloc_topology_get_type_filter(topology, type, &filter);
550 if (filter == HWLOC_TYPE_FILTER_KEEP_NONE)
551 return 0;
552 if (filter == HWLOC_TYPE_FILTER_KEEP_IMPORTANT) {
553 if (type == HWLOC_OBJ_PCI_DEVICE)
555 if (type == HWLOC_OBJ_OS_DEVICE)
557 }
558 return 1;
559}
560
577HWLOC_DECLSPEC unsigned hwloc_pcidisc_find_cap(const unsigned char *config, unsigned cap);
578
584HWLOC_DECLSPEC int hwloc_pcidisc_find_linkspeed(const unsigned char *config, unsigned offset, float *linkspeed);
585
590HWLOC_DECLSPEC hwloc_obj_type_t hwloc_pcidisc_check_bridge_type(unsigned device_class, const unsigned char *config);
591
598HWLOC_DECLSPEC int hwloc_pcidisc_find_bridge_buses(unsigned domain, unsigned bus, unsigned dev, unsigned func,
599 unsigned *secondary_busp, unsigned *subordinate_busp,
600 const unsigned char *config);
601
606HWLOC_DECLSPEC void hwloc_pcidisc_tree_insert_by_busid(struct hwloc_obj **treep, struct hwloc_obj *obj);
607
613HWLOC_DECLSPEC int hwloc_pcidisc_tree_attach(struct hwloc_topology *topology, struct hwloc_obj *tree);
614
638HWLOC_DECLSPEC struct hwloc_obj * hwloc_pci_find_parent_by_busid(struct hwloc_topology *topology, unsigned domain, unsigned bus, unsigned dev, unsigned func);
639
646HWLOC_DECLSPEC struct hwloc_obj * hwloc_pci_find_by_busid(struct hwloc_topology *topology, unsigned domain, unsigned bus, unsigned dev, unsigned func);
647
648
663
672 const char *name, unsigned long kind,
673 unsigned long flags);
674
686HWLOC_DECLSPEC int
689 unsigned nbobjs, hwloc_obj_t *objs,
690 hwloc_uint64_t *values,
691 unsigned long flags);
692
699HWLOC_DECLSPEC int
702 unsigned long flags);
703
709#endif /* HWLOC_PLUGINS_H */
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
hwloc_obj_type_t
Type of topology object.
Definition hwloc.h:197
@ HWLOC_OBJ_OSDEV_DMA
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition hwloc.h:383
@ HWLOC_OBJ_OS_DEVICE
Operating system device (filtered out by default).
Definition hwloc.h:305
@ HWLOC_OBJ_PCI_DEVICE
PCI device (filtered out by default).
Definition hwloc.h:295
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition hwloc.h:742
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_type_filter_e
Type filtering flags.
Definition hwloc.h:2439
@ HWLOC_TYPE_FILTER_KEEP_NONE
Ignore all objects of this type.
Definition hwloc.h:2453
@ HWLOC_TYPE_FILTER_KEEP_IMPORTANT
Only keep likely-important objects of the given type.
Definition hwloc.h:2482
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition bitmap.h:69
int hwloc_backend_enable(struct hwloc_backend *backend)
Enable a previously allocated and setup backend.
enum hwloc_disc_phase_e hwloc_disc_phase_t
Discovery phase.
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,...
hwloc_disc_phase_e
Discovery phase.
Definition plugins.h:106
hwloc_disc_status_flag_e
Discovery status flags.
Definition plugins.h:146
@ HWLOC_DISC_PHASE_CPU
CPU discovery.
Definition plugins.h:115
@ HWLOC_DISC_PHASE_PCI
Attach PCI devices and bridges to existing CPU objects.
Definition plugins.h:123
@ HWLOC_DISC_PHASE_ANNOTATE
Annotating existing objects, adding distances, etc.
Definition plugins.h:135
@ HWLOC_DISC_PHASE_MISC
Misc objects that gets added below anything else.
Definition plugins.h:131
@ HWLOC_DISC_PHASE_IO
I/O discovery that requires PCI devices (OS devices such as OpenCL, CUDA, etc.).
Definition plugins.h:127
@ HWLOC_DISC_PHASE_GLOBAL
xml or synthetic, platform-specific components such as bgq. Discovers everything including CPU,...
Definition plugins.h:111
@ HWLOC_DISC_PHASE_MEMORY
Attach memory to existing CPU objects.
Definition plugins.h:119
@ HWLOC_DISC_PHASE_TWEAK
Final tweaks to a ready-to-use topology. This phase runs once the topology is loaded,...
Definition plugins.h:142
@ HWLOC_DISC_STATUS_FLAG_GOT_ALLOWED_RESOURCES
The sets of allowed resources were already retrieved.
Definition plugins.h:148
enum hwloc_component_type_e hwloc_component_type_t
Generic component type.
hwloc_component_type_e
Generic component type.
Definition plugins.h:257
@ HWLOC_COMPONENT_TYPE_DISC
The data field must point to a struct hwloc_disc_component.
Definition plugins.h:259
@ HWLOC_COMPONENT_TYPE_XML
The data field must point to a struct hwloc_xml_component.
Definition plugins.h:262
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.
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.
int hwloc_topology_reconnect(hwloc_topology_t topology, unsigned long flags)
Request a reconnection of children and levels in the topology.
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.
int hwloc_obj_add_children_sets(hwloc_obj_t obj)
Setup object cpusets/nodesets by OR'ing its children.
int hwloc_hide_errors(void)
Check whether error messages are hidden.
static int hwloc_plugin_check_namespace(const char *pluginname, const char *symbol)
Make sure that plugins can lookup core symbols.
Definition plugins.h:447
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:532
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:545
static int hwloc_filter_check_pcidev_subtype_important(unsigned classid)
Check whether the given PCI device classid is important.
Definition plugins.h:500
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:520
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_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 hwloc_pcidisc_find_cap(const unsigned char *config, unsigned cap)
Return the offset of the given capability in the PCI config space buffer.
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.
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_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.
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.
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.
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.
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_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.
void * hwloc_backend_distances_add_handle_t
Handle to a new distances structure during its addition to the topology.
Definition plugins.h:662
Structure of a topology object.
Definition hwloc.h:431
char * name
Object-specific name if any. Mostly used for identifying OS devices and Misc objects where a name str...
Definition hwloc.h:443
hwloc_obj_type_t type
Type of object.
Definition hwloc.h:433
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition hwloc.h:450
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
unsigned short class_id
The class number (first two bytes, without the prog_if).
Definition hwloc.h:679
hwloc_obj_osdev_type_t type
Definition hwloc.h:716
Discovery component structure.
Definition plugins.h:41
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
unsigned phases
Discovery phases performed by this component. OR'ed set of hwloc_disc_phase_t.
Definition plugins.h:50
unsigned excluded_phases
Component phases to exclude, as an OR'ed set of hwloc_disc_phase_t.
Definition plugins.h:60
unsigned enabled_by_default
Enabled by default. If unset, if will be disabled unless explicitly requested.
Definition plugins.h:84
unsigned priority
Component priority. Used to sort topology->components, higher priority first. Also used to decide bet...
Definition plugins.h:79
Discovery status structure.
Definition plugins.h:156
unsigned excluded_phases
Dynamically excluded phases. If a component decides during discovery that some phases are no longer n...
Definition plugins.h:165
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
unsigned long flags
OR'ed set of hwloc_disc_status_flag_e.
Definition plugins.h:168
Discovery backend structure.
Definition plugins.h:189
void * private_data
Backend private data, or NULL if none.
Definition plugins.h:216
void(* disable)(struct hwloc_backend *backend)
Callback for freeing the private_data. May be NULL.
Definition plugins.h:220
unsigned long flags
Backend flags, currently always 0.
Definition plugins.h:205
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 is_thissystem
Backend-specific 'is_thissystem' property. Set to 0 if the backend disables the thissystem flag for t...
Definition plugins.h:213
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:227
unsigned phases
Discovery phases performed by this component, possibly without some of them if excluded by other comp...
Definition plugins.h:202
Generic component structure.
Definition plugins.h:270
unsigned abi
Component ABI version, set to HWLOC_COMPONENT_ABI.
Definition plugins.h:272
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
hwloc_component_type_t type
Component type.
Definition plugins.h:307
unsigned long flags
Component flags, unused for now.
Definition plugins.h:310
int(* init)(unsigned long flags)
Process-wide component initialization callback.
Definition plugins.h:291