Hardware Locality (hwloc) 2.2.0

plugins.h
1 /*
2 * Copyright © 2013-2020 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
38 struct hwloc_disc_component {
42 const char *name;
43
47 unsigned phases;
48
57 unsigned excluded_phases;
58
62 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);
63
76 unsigned priority;
77
81 unsigned enabled_by_default;
82
87 struct hwloc_disc_component * next;
88 };
89
100 typedef enum hwloc_disc_phase_e {
105 HWLOC_DISC_PHASE_GLOBAL = (1U<<0),
106
109 HWLOC_DISC_PHASE_CPU = (1U<<1),
110
113 HWLOC_DISC_PHASE_MEMORY = (1U<<2),
114
117 HWLOC_DISC_PHASE_PCI = (1U<<3),
118
121 HWLOC_DISC_PHASE_IO = (1U<<4),
122
125 HWLOC_DISC_PHASE_MISC = (1U<<5),
126
129 HWLOC_DISC_PHASE_ANNOTATE = (1U<<6),
130
136 HWLOC_DISC_PHASE_TWEAK = (1U<<7)
137 } hwloc_disc_phase_t;
138
140 enum hwloc_disc_status_flag_e {
142 HWLOC_DISC_STATUS_FLAG_GOT_ALLOWED_RESOURCES = (1UL<<1)
143 };
144
150 struct hwloc_disc_status {
154 hwloc_disc_phase_t phase;
155
159 unsigned excluded_phases;
160
162 unsigned long flags;
163 };
164
183 struct hwloc_backend {
185 struct hwloc_disc_component * component;
187 struct hwloc_topology * topology;
189 int envvar_forced;
191 struct hwloc_backend * next;
192
196 unsigned phases;
197
199 unsigned long flags;
200
207 int is_thissystem;
208
210 void * private_data;
214 void (*disable)(struct hwloc_backend *backend);
215
221 int (*discover)(struct hwloc_backend *backend, struct hwloc_disc_status *status);
222
227 int (*get_pci_busid_cpuset)(struct hwloc_backend *backend, struct hwloc_pcidev_attr_s *busid, hwloc_bitmap_t cpuset);
228 };
229
233 HWLOC_DECLSPEC struct hwloc_backend * hwloc_backend_alloc(struct hwloc_topology *topology, struct hwloc_disc_component *component);
234
236 HWLOC_DECLSPEC int hwloc_backend_enable(struct hwloc_backend *backend);
237
248 typedef enum hwloc_component_type_e {
250 HWLOC_COMPONENT_TYPE_DISC,
251
253 HWLOC_COMPONENT_TYPE_XML
254 } hwloc_component_type_t;
255
261 struct hwloc_component {
263 unsigned abi;
264
282 int (*init)(unsigned long flags);
283
295 void (*finalize)(unsigned long flags);
296
298 hwloc_component_type_t type;
299
301 unsigned long flags;
302
304 void * data;
305 };
306
340 HWLOC_DECLSPEC struct hwloc_obj *hwloc_insert_object_by_cpuset(struct hwloc_topology *topology, hwloc_obj_t obj);
341
343 typedef void (*hwloc_report_error_t)(const char * msg, int line);
345 HWLOC_DECLSPEC void hwloc_report_os_error(const char * msg, int line);
347 HWLOC_DECLSPEC int hwloc_hide_errors(void);
348
355 HWLOC_DECLSPEC struct hwloc_obj *hwloc__insert_object_by_cpuset(struct hwloc_topology *topology, hwloc_obj_t root, hwloc_obj_t obj, hwloc_report_error_t report_error);
356
373 HWLOC_DECLSPEC void hwloc_insert_object_by_parent(struct hwloc_topology *topology, hwloc_obj_t parent, hwloc_obj_t obj);
374
379 HWLOC_DECLSPEC hwloc_obj_t hwloc_alloc_setup_object(hwloc_topology_t topology, hwloc_obj_type_t type, unsigned os_index);
380
389 HWLOC_DECLSPEC int hwloc_obj_add_children_sets(hwloc_obj_t obj);
390
398 HWLOC_DECLSPEC int hwloc_topology_reconnect(hwloc_topology_t topology, unsigned long flags __hwloc_attribute_unused);
399
421 static __hwloc_inline int
422 hwloc_plugin_check_namespace(const char *pluginname __hwloc_attribute_unused, const char *symbol __hwloc_attribute_unused)
423 {
424 #ifdef HWLOC_INSIDE_PLUGIN
425 void *sym;
426 #ifdef HWLOC_HAVE_LTDL
427 lt_dlhandle handle = lt_dlopen(NULL);
428 #else
429 void *handle = dlopen(NULL, RTLD_NOW|RTLD_LOCAL);
430 #endif
431 if (!handle)
432 /* cannot check, assume things will work */
433 return 0;
434 #ifdef HWLOC_HAVE_LTDL
435 sym = lt_dlsym(handle, symbol);
436 lt_dlclose(handle);
437 #else
438 sym = dlsym(handle, symbol);
439 dlclose(handle);
440 #endif
441 if (!sym) {
442 static int verboseenv_checked = 0;
443 static int verboseenv_value = 0;
444 if (!verboseenv_checked) {
445 const char *verboseenv = getenv("HWLOC_PLUGINS_VERBOSE");
446 verboseenv_value = verboseenv ? atoi(verboseenv) : 0;
447 verboseenv_checked = 1;
448 }
449 if (verboseenv_value)
450 fprintf(stderr, "Plugin `%s' disabling itself because it cannot find the `%s' core symbol.\n",
451 pluginname, symbol);
452 return -1;
453 }
454 #endif /* HWLOC_INSIDE_PLUGIN */
455 return 0;
456 }
457
471 static __hwloc_inline int
472 hwloc_filter_check_pcidev_subtype_important(unsigned classid)
473 {
474 unsigned baseclass = classid >> 8;
475 return (baseclass == 0x03 /* PCI_BASE_CLASS_DISPLAY */
476 || baseclass == 0x02 /* PCI_BASE_CLASS_NETWORK */
477 || baseclass == 0x01 /* PCI_BASE_CLASS_STORAGE */
478 || baseclass == 0x0b /* PCI_BASE_CLASS_PROCESSOR */
479 || classid == 0x0c04 /* PCI_CLASS_SERIAL_FIBER */
480 || classid == 0x0c06 /* PCI_CLASS_SERIAL_INFINIBAND */
481 || baseclass == 0x12 /* Processing Accelerators */);
482 }
483
488 static __hwloc_inline int
489 hwloc_filter_check_osdev_subtype_important(hwloc_obj_osdev_type_t subtype)
490 {
491 return (subtype != HWLOC_OBJ_OSDEV_DMA);
492 }
493
500 static __hwloc_inline int
501 hwloc_filter_check_keep_object_type(hwloc_topology_t topology, hwloc_obj_type_t type)
502 {
503 enum hwloc_type_filter_e filter = HWLOC_TYPE_FILTER_KEEP_NONE;
504 hwloc_topology_get_type_filter(topology, type, &filter);
505 assert(filter != HWLOC_TYPE_FILTER_KEEP_IMPORTANT); /* IMPORTANT only used for I/O */
506 return filter == HWLOC_TYPE_FILTER_KEEP_NONE ? 0 : 1;
507 }
508
513 static __hwloc_inline int
514 hwloc_filter_check_keep_object(hwloc_topology_t topology, hwloc_obj_t obj)
515 {
516 hwloc_obj_type_t type = obj->type;
517 enum hwloc_type_filter_e filter = HWLOC_TYPE_FILTER_KEEP_NONE;
518 hwloc_topology_get_type_filter(topology, type, &filter);
519 if (filter == HWLOC_TYPE_FILTER_KEEP_NONE)
520 return 0;
521 if (filter == HWLOC_TYPE_FILTER_KEEP_IMPORTANT) {
522 if (type == HWLOC_OBJ_PCI_DEVICE)
523 return hwloc_filter_check_pcidev_subtype_important(obj->attr->pcidev.class_id);
524 if (type == HWLOC_OBJ_OS_DEVICE)
525 return hwloc_filter_check_osdev_subtype_important(obj->attr->osdev.type);
526 }
527 return 1;
528 }
529
543 HWLOC_DECLSPEC unsigned hwloc_pcidisc_find_cap(const unsigned char *config, unsigned cap);
544
550 HWLOC_DECLSPEC int hwloc_pcidisc_find_linkspeed(const unsigned char *config, unsigned offset, float *linkspeed);
551
556 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_pcidisc_check_bridge_type(unsigned device_class, const unsigned char *config);
557
564 HWLOC_DECLSPEC int hwloc_pcidisc_find_bridge_buses(unsigned domain, unsigned bus, unsigned dev, unsigned func,
565 unsigned *secondary_busp, unsigned *subordinate_busp,
566 const unsigned char *config);
567
572 HWLOC_DECLSPEC void hwloc_pcidisc_tree_insert_by_busid(struct hwloc_obj **treep, struct hwloc_obj *obj);
573
579 HWLOC_DECLSPEC int hwloc_pcidisc_tree_attach(struct hwloc_topology *topology, struct hwloc_obj *tree);
580
597 HWLOC_DECLSPEC struct hwloc_obj * hwloc_pci_find_parent_by_busid(struct hwloc_topology *topology, unsigned domain, unsigned bus, unsigned dev, unsigned func);
598
604 #endif /* HWLOC_PLUGINS_H */
hwloc_backend::flags
unsigned long flags
Backend flags, currently always 0.
Definition: plugins.h:199
hwloc_obj_osdev_type_t
enum hwloc_obj_osdev_type_e hwloc_obj_osdev_type_t
Type of a OS device.
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:221
hwloc_disc_phase_e
hwloc_disc_phase_e
Discovery phase.
Definition: plugins.h:100
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 normal parent of a PCI bus ID.
HWLOC_OBJ_PCI_DEVICE
@ HWLOC_OBJ_PCI_DEVICE
PCI device (filtered out by default). They are not added to the topology unless I/O discovery is enab...
Definition: hwloc.h:266
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_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_report_os_error
void hwloc_report_os_error(const char *msg, int line)
Report an insertion error from a backend.
hwloc_disc_status::flags
unsigned long flags
OR'ed set of hwloc_disc_status_flag_e.
Definition: plugins.h:162
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_filter_check_pcidev_subtype_important
static int hwloc_filter_check_pcidev_subtype_important(unsigned classid)
Check whether the given PCI device classid is important.
Definition: plugins.h:472
hwloc_obj_attr_u::hwloc_osdev_attr_s::type
hwloc_obj_osdev_type_t type
Definition: hwloc.h:652
hwloc_obj::os_index
unsigned os_index
OS-provided physical index number. It is not guaranteed unique across the entire machine,...
Definition: hwloc.h:389
hwloc_component::type
hwloc_component_type_t type
Component type.
Definition: plugins.h:298
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:42
HWLOC_DISC_PHASE_GLOBAL
@ HWLOC_DISC_PHASE_GLOBAL
xml or synthetic, platform-specific components such as bgq. Discovers everything including CPU,...
Definition: plugins.h:105
hwloc_obj_attr_u::osdev
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
hwloc_obj_attr_u::hwloc_pcidev_attr_s::class_id
unsigned short class_id
Definition: hwloc.h:626
hwloc_obj::type
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:386
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_obj::attr
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:403
HWLOC_OBJ_OS_DEVICE
@ HWLOC_OBJ_OS_DEVICE
Operating system device (filtered out by default). They are not added to the topology unless I/O disc...
Definition: hwloc.h:273
hwloc_filter_check_keep_object
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:514
hwloc_topology_t
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:678
hwloc_component_type_e
hwloc_component_type_e
Generic component type.
Definition: plugins.h:248
hwloc_component::flags
unsigned long flags
Component flags, unused for now.
Definition: plugins.h:301
hwloc_component
Generic component structure.
Definition: plugins.h:261
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_bitmap_t
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:68
hwloc_filter_check_keep_object_type
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:501
hwloc_backend::disable
void(* disable)(struct hwloc_backend *backend)
Callback for freeing the private_data. May be NULL.
Definition: plugins.h:214
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_obj
Structure of a topology object.
Definition: hwloc.h:384
HWLOC_DISC_PHASE_ANNOTATE
@ HWLOC_DISC_PHASE_ANNOTATE
Annotating existing objects, adding distances, etc.
Definition: plugins.h:129
hwloc_insert_object_by_cpuset
struct hwloc_obj * hwloc_insert_object_by_cpuset(struct hwloc_topology *topology, hwloc_obj_t obj)
Add an object to the topology.
hwloc__insert_object_by_cpuset
struct hwloc_obj * hwloc__insert_object_by_cpuset(struct hwloc_topology *topology, hwloc_obj_t root, hwloc_obj_t obj, hwloc_report_error_t report_error)
Add an object to the topology and specify which error callback to use.
HWLOC_COMPONENT_TYPE_XML
@ HWLOC_COMPONENT_TYPE_XML
The data field must point to a struct hwloc_xml_component.
Definition: plugins.h:253
hwloc_disc_status_flag_e
hwloc_disc_status_flag_e
Discovery status flags.
Definition: plugins.h:140
hwloc_backend
Discovery backend structure.
Definition: plugins.h:183
HWLOC_DISC_PHASE_PCI
@ HWLOC_DISC_PHASE_PCI
Attach PCI devices and bridges to existing CPU objects.
Definition: plugins.h:117
HWLOC_DISC_PHASE_MEMORY
@ HWLOC_DISC_PHASE_MEMORY
Attach memory to existing CPU objects.
Definition: plugins.h:113
hwloc_backend::phases
unsigned phases
Discovery phases performed by this component, possibly without some of them if excluded by other comp...
Definition: plugins.h:196
hwloc_component::abi
unsigned abi
Component ABI version, set to HWLOC_COMPONENT_ABI.
Definition: plugins.h:263
hwloc_obj::parent
struct hwloc_obj * parent
Parent, NULL if root (Machine object)
Definition: hwloc.h:434
HWLOC_DISC_PHASE_MISC
@ HWLOC_DISC_PHASE_MISC
Misc objects that gets added below anything else.
Definition: plugins.h:125
HWLOC_TYPE_FILTER_KEEP_IMPORTANT
@ HWLOC_TYPE_FILTER_KEEP_IMPORTANT
Only keep likely-important objects of the given type.
Definition: hwloc.h:2120
hwloc_component::finalize
void(* finalize)(unsigned long flags)
Process-wide component termination callback.
Definition: plugins.h:295
hwloc_obj_attr_u::pcidev
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
hwloc_backend_alloc
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_report_error_t
void(* hwloc_report_error_t)(const char *msg, int line)
Type of error callbacks during object insertion.
Definition: plugins.h:343
HWLOC_OBJ_OSDEV_DMA
@ HWLOC_OBJ_OSDEV_DMA
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:338
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_type_filter_e
hwloc_type_filter_e
Type filtering flags.
Definition: hwloc.h:2077
hwloc_obj_type_t
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:176
hwloc_filter_check_osdev_subtype_important
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:489
hwloc_disc_phase_t
enum hwloc_disc_phase_e hwloc_disc_phase_t
Discovery phase.
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:57
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:154
hwloc_obj::subtype
char * subtype
Subtype string to better describe the type field.
Definition: hwloc.h:387
hwloc_disc_component
Discovery component structure.
Definition: plugins.h:38
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:136
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:142
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:227
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_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_disc_component::phases
unsigned phases
Discovery phases performed by this component. OR'ed set of hwloc_disc_phase_t.
Definition: plugins.h:47
HWLOC_COMPONENT_TYPE_DISC
@ HWLOC_COMPONENT_TYPE_DISC
The data field must point to a struct hwloc_disc_component.
Definition: plugins.h:250
HWLOC_TYPE_FILTER_KEEP_NONE
@ HWLOC_TYPE_FILTER_KEEP_NONE
Ignore all objects of this type.
Definition: hwloc.h:2091
hwloc_plugin_check_namespace
static int hwloc_plugin_check_namespace(const char *pluginname, const char *symbol)
Make sure that plugins can lookup core symbols.
Definition: plugins.h:422
HWLOC_DISC_PHASE_CPU
@ HWLOC_DISC_PHASE_CPU
CPU discovery.
Definition: plugins.h:109
hwloc_backend_enable
int hwloc_backend_enable(struct hwloc_backend *backend)
Enable a previously allocated and setup backend.
hwloc_component::data
void * data
Component data, pointing to a struct hwloc_disc_component or struct hwloc_xml_component.
Definition: plugins.h:304
hwloc_hide_errors
int hwloc_hide_errors(void)
Check whether insertion errors are hidden.
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:121
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:159
hwloc_backend::private_data
void * private_data
Backend private data, or NULL if none.
Definition: plugins.h:210
hwloc_component_type_t
enum hwloc_component_type_e hwloc_component_type_t
Generic component type.
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:81
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_disc_status
Discovery status structure.
Definition: plugins.h:150
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::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:207
hwloc_disc_component::priority
unsigned priority
Component priority. Used to sort topology->components, higher priority first. Also used to decide bet...
Definition: plugins.h:76
hwloc_component::init
int(* init)(unsigned long flags)
Process-wide component initialization callback.
Definition: plugins.h:282