Open MPI logo

Portable Hardware Locality (hwloc) Documentation: v2.4.1

  |   Home   |   Support   |   FAQ   |  
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 
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 
82 
87  struct hwloc_disc_component * next;
88 };
89 
100 typedef enum hwloc_disc_phase_e {
106 
110 
114 
118 
122 
126 
130 
136  HWLOC_DISC_PHASE_TWEAK = (1U<<7)
138 
143 };
144 
155 
159  unsigned excluded_phases;
160 
162  unsigned long flags;
163 };
164 
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 
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 
251 
255 
263  unsigned abi;
264 
282  int (*init)(unsigned long flags);
283 
295  void (*finalize)(unsigned long flags);
296 
299 
301  unsigned long flags;
302 
304  void * data;
305 };
306 
317 HWLOC_DECLSPEC int hwloc_hide_errors(void);
318 
347 HWLOC_DECLSPEC hwloc_obj_t
348 hwloc__insert_object_by_cpuset(struct hwloc_topology *topology, hwloc_obj_t root,
349  hwloc_obj_t obj, const char *reason);
350 
367 HWLOC_DECLSPEC void hwloc_insert_object_by_parent(struct hwloc_topology *topology, hwloc_obj_t parent, hwloc_obj_t obj);
368 
373 HWLOC_DECLSPEC hwloc_obj_t hwloc_alloc_setup_object(hwloc_topology_t topology, hwloc_obj_type_t type, unsigned os_index);
374 
383 HWLOC_DECLSPEC int hwloc_obj_add_children_sets(hwloc_obj_t obj);
384 
392 HWLOC_DECLSPEC int hwloc_topology_reconnect(hwloc_topology_t topology, unsigned long flags __hwloc_attribute_unused);
393 
415 static __hwloc_inline int
416 hwloc_plugin_check_namespace(const char *pluginname __hwloc_attribute_unused, const char *symbol __hwloc_attribute_unused)
417 {
418 #ifdef HWLOC_INSIDE_PLUGIN
419  void *sym;
420 #ifdef HWLOC_HAVE_LTDL
421  lt_dlhandle handle = lt_dlopen(NULL);
422 #else
423  void *handle = dlopen(NULL, RTLD_NOW|RTLD_LOCAL);
424 #endif
425  if (!handle)
426  /* cannot check, assume things will work */
427  return 0;
428 #ifdef HWLOC_HAVE_LTDL
429  sym = lt_dlsym(handle, symbol);
430  lt_dlclose(handle);
431 #else
432  sym = dlsym(handle, symbol);
433  dlclose(handle);
434 #endif
435  if (!sym) {
436  static int verboseenv_checked = 0;
437  static int verboseenv_value = 0;
438  if (!verboseenv_checked) {
439  const char *verboseenv = getenv("HWLOC_PLUGINS_VERBOSE");
440  verboseenv_value = verboseenv ? atoi(verboseenv) : 0;
441  verboseenv_checked = 1;
442  }
443  if (verboseenv_value)
444  fprintf(stderr, "Plugin `%s' disabling itself because it cannot find the `%s' core symbol.\n",
445  pluginname, symbol);
446  return -1;
447  }
448 #endif /* HWLOC_INSIDE_PLUGIN */
449  return 0;
450 }
451 
465 static __hwloc_inline int
467 {
468  unsigned baseclass = classid >> 8;
469  return (baseclass == 0x03 /* PCI_BASE_CLASS_DISPLAY */
470  || baseclass == 0x02 /* PCI_BASE_CLASS_NETWORK */
471  || baseclass == 0x01 /* PCI_BASE_CLASS_STORAGE */
472  || baseclass == 0x0b /* PCI_BASE_CLASS_PROCESSOR */
473  || classid == 0x0c04 /* PCI_CLASS_SERIAL_FIBER */
474  || classid == 0x0c06 /* PCI_CLASS_SERIAL_INFINIBAND */
475  || baseclass == 0x12 /* Processing Accelerators */);
476 }
477 
482 static __hwloc_inline int
484 {
485  return (subtype != HWLOC_OBJ_OSDEV_DMA);
486 }
487 
494 static __hwloc_inline int
496 {
498  hwloc_topology_get_type_filter(topology, type, &filter);
499  assert(filter != HWLOC_TYPE_FILTER_KEEP_IMPORTANT); /* IMPORTANT only used for I/O */
500  return filter == HWLOC_TYPE_FILTER_KEEP_NONE ? 0 : 1;
501 }
502 
507 static __hwloc_inline int
509 {
510  hwloc_obj_type_t type = obj->type;
512  hwloc_topology_get_type_filter(topology, type, &filter);
513  if (filter == HWLOC_TYPE_FILTER_KEEP_NONE)
514  return 0;
515  if (filter == HWLOC_TYPE_FILTER_KEEP_IMPORTANT) {
516  if (type == HWLOC_OBJ_PCI_DEVICE)
518  if (type == HWLOC_OBJ_OS_DEVICE)
520  }
521  return 1;
522 }
523 
537 HWLOC_DECLSPEC unsigned hwloc_pcidisc_find_cap(const unsigned char *config, unsigned cap);
538 
544 HWLOC_DECLSPEC int hwloc_pcidisc_find_linkspeed(const unsigned char *config, unsigned offset, float *linkspeed);
545 
550 HWLOC_DECLSPEC hwloc_obj_type_t hwloc_pcidisc_check_bridge_type(unsigned device_class, const unsigned char *config);
551 
558 HWLOC_DECLSPEC int hwloc_pcidisc_find_bridge_buses(unsigned domain, unsigned bus, unsigned dev, unsigned func,
559  unsigned *secondary_busp, unsigned *subordinate_busp,
560  const unsigned char *config);
561 
566 HWLOC_DECLSPEC void hwloc_pcidisc_tree_insert_by_busid(struct hwloc_obj **treep, struct hwloc_obj *obj);
567 
573 HWLOC_DECLSPEC int hwloc_pcidisc_tree_attach(struct hwloc_topology *topology, struct hwloc_obj *tree);
574 
591 HWLOC_DECLSPEC struct hwloc_obj * hwloc_pci_find_parent_by_busid(struct hwloc_topology *topology, unsigned domain, unsigned bus, unsigned dev, unsigned func);
592 
598 #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:176
@ HWLOC_OBJ_OSDEV_DMA
Operating system dma engine device. For instance the "dma0chan0" DMA channel on Linux.
Definition: hwloc.h:350
@ HWLOC_OBJ_OS_DEVICE
Operating system device (filtered out by default).
Definition: hwloc.h:279
@ HWLOC_OBJ_PCI_DEVICE
PCI device (filtered out by default).
Definition: hwloc.h:269
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:691
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:2136
@ HWLOC_TYPE_FILTER_KEEP_NONE
Ignore all objects of this type.
Definition: hwloc.h:2150
@ HWLOC_TYPE_FILTER_KEEP_IMPORTANT
Only keep likely-important objects of the given type.
Definition: hwloc.h:2179
struct hwloc_bitmap_s * hwloc_bitmap_t
Set of bits represented as an opaque pointer to an internal bitmap.
Definition: bitmap.h:68
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.
hwloc_disc_phase_e
Discovery phase.
Definition: plugins.h:100
hwloc_disc_status_flag_e
Discovery status flags.
Definition: plugins.h:140
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_CPU
CPU discovery.
Definition: plugins.h:109
@ HWLOC_DISC_PHASE_PCI
Attach PCI devices and bridges to existing CPU objects.
Definition: plugins.h:117
@ HWLOC_DISC_PHASE_ANNOTATE
Annotating existing objects, adding distances, etc.
Definition: plugins.h:129
@ HWLOC_DISC_PHASE_MISC
Misc objects that gets added below anything else.
Definition: plugins.h:125
@ HWLOC_DISC_PHASE_IO
I/O discovery that requires PCI devices (OS devices such as OpenCL, CUDA, etc.).
Definition: plugins.h:121
@ HWLOC_DISC_PHASE_GLOBAL
xml or synthetic, platform-specific components such as bgq. Discovers everything including CPU,...
Definition: plugins.h:105
@ HWLOC_DISC_PHASE_MEMORY
Attach memory to existing CPU objects.
Definition: plugins.h:113
@ 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
The sets of allowed resources were already retrieved.
Definition: plugins.h:142
enum hwloc_component_type_e hwloc_component_type_t
Generic component type.
hwloc_component_type_e
Generic component type.
Definition: plugins.h:248
@ HWLOC_COMPONENT_TYPE_DISC
The data field must point to a struct hwloc_disc_component.
Definition: plugins.h:250
@ HWLOC_COMPONENT_TYPE_XML
The data field must point to a struct hwloc_xml_component.
Definition: plugins.h:253
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 insertion errors 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:416
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:495
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:508
static int hwloc_filter_check_pcidev_subtype_important(unsigned classid)
Check whether the given PCI device classid is important.
Definition: plugins.h:466
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:483
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_parent_by_busid(struct hwloc_topology *topology, unsigned domain, unsigned bus, unsigned dev, unsigned func)
Find the normal parent of a PCI bus ID.
Structure of a topology object.
Definition: hwloc.h:395
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:397
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:414
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
struct hwloc_obj_attr_u::hwloc_osdev_attr_s osdev
unsigned short class_id
Definition: hwloc.h:639
hwloc_obj_osdev_type_t type
Definition: hwloc.h:665
Discovery component structure.
Definition: plugins.h:38
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
unsigned phases
Discovery phases performed by this component. OR'ed set of hwloc_disc_phase_t.
Definition: plugins.h:47
unsigned excluded_phases
Component phases to exclude, as an OR'ed set of hwloc_disc_phase_t.
Definition: plugins.h:57
unsigned enabled_by_default
Enabled by default. If unset, if will be disabled unless explicitly requested.
Definition: plugins.h:81
unsigned priority
Component priority. Used to sort topology->components, higher priority first. Also used to decide bet...
Definition: plugins.h:76
Discovery status structure.
Definition: plugins.h:150
unsigned excluded_phases
Dynamically excluded phases. If a component decides during discovery that some phases are no longer n...
Definition: plugins.h:159
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
unsigned long flags
OR'ed set of hwloc_disc_status_flag_e.
Definition: plugins.h:162
Discovery backend structure.
Definition: plugins.h:183
void * private_data
Backend private data, or NULL if none.
Definition: plugins.h:210
void(* disable)(struct hwloc_backend *backend)
Callback for freeing the private_data. May be NULL.
Definition: plugins.h:214
unsigned long flags
Backend flags, currently always 0.
Definition: plugins.h:199
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
int is_thissystem
Backend-specific 'is_thissystem' property. Set to 0 if the backend disables the thissystem flag for t...
Definition: plugins.h:207
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
unsigned phases
Discovery phases performed by this component, possibly without some of them if excluded by other comp...
Definition: plugins.h:196
Generic component structure.
Definition: plugins.h:261
unsigned abi
Component ABI version, set to HWLOC_COMPONENT_ABI.
Definition: plugins.h:263
void(* finalize)(unsigned long flags)
Process-wide component termination callback.
Definition: plugins.h:295
void * data
Component data, pointing to a struct hwloc_disc_component or struct hwloc_xml_component.
Definition: plugins.h:304
hwloc_component_type_t type
Component type.
Definition: plugins.h:298
unsigned long flags
Component flags, unused for now.
Definition: plugins.h:301
int(* init)(unsigned long flags)
Process-wide component initialization callback.
Definition: plugins.h:282