57 lines
2.6 KiB
Groff
57 lines
2.6 KiB
Groff
.TH "hwlocality_levelzero" 3 "Wed Dec 14 2022" "Version 2.9.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
hwlocality_levelzero \- Interoperability with the oneAPI Level Zero interface\&.
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static int \fBhwloc_levelzero_get_device_cpuset\fP (\fBhwloc_topology_t\fP topology, ze_device_handle_t device, \fBhwloc_cpuset_t\fP set)"
|
|
.br
|
|
.ti -1c
|
|
.RI "static \fBhwloc_obj_t\fP \fBhwloc_levelzero_get_device_osdev\fP (\fBhwloc_topology_t\fP topology, ze_device_handle_t device)"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
This interface offers ways to retrieve topology information about devices managed by the Level Zero API\&.
|
|
.SH "Function Documentation"
|
|
.PP
|
|
.SS "static int hwloc_levelzero_get_device_cpuset (\fBhwloc_topology_t\fP topology, ze_device_handle_t device, \fBhwloc_cpuset_t\fP set)\fC [inline]\fP, \fC [static]\fP"
|
|
|
|
.PP
|
|
Get the CPU set of logical processors that are physically close to the Level Zero device \fCdevice\fP\&. Store in \fCset\fP the CPU-set describing the locality of the Level Zero device \fCdevice\fP\&.
|
|
.PP
|
|
Topology \fCtopology\fP and device \fCdevice\fP must match the local machine\&. The Level Zero must have been initialized with Sysman enabled (ZES_ENABLE_SYSMAN=1 in the environment)\&. I/O devices detection and the Level Zero component are not needed in the topology\&.
|
|
.PP
|
|
The function only returns the locality of the device\&. If more information about the device is needed, OS objects should be used instead, see \fBhwloc_levelzero_get_device_osdev()\fP\&.
|
|
.PP
|
|
This function is currently only implemented in a meaningful way for Linux; other systems will simply get a full cpuset\&.
|
|
.SS "static \fBhwloc_obj_t\fP hwloc_levelzero_get_device_osdev (\fBhwloc_topology_t\fP topology, ze_device_handle_t device)\fC [inline]\fP, \fC [static]\fP"
|
|
|
|
.PP
|
|
Get the hwloc OS device object corresponding to Level Zero device \fCdevice\fP\&.
|
|
.PP
|
|
\fBReturns\fP
|
|
.RS 4
|
|
The hwloc OS device object that describes the given Level Zero device \fCdevice\fP\&.
|
|
.PP
|
|
\fCNULL\fP if none could be found\&.
|
|
.RE
|
|
.PP
|
|
Topology \fCtopology\fP and device \fCdv_ind\fP must match the local machine\&. I/O devices detection and the Level Zero component must be enabled in the topology\&. If not, the locality of the object may still be found using \fBhwloc_levelzero_get_device_cpuset()\fP\&.
|
|
.PP
|
|
\fBNote\fP
|
|
.RS 4
|
|
The corresponding hwloc PCI device may be found by looking at the result parent pointer (unless PCI devices are filtered out)\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.
|