| 1 |
.TH "hwlocality_windows" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*- |
| 2 |
.ad l |
| 3 |
.nh |
| 4 |
.SH NAME |
| 5 |
hwlocality_windows \- Windows-specific helpers |
| 6 |
.SH SYNOPSIS |
| 7 |
.br |
| 8 |
.PP |
| 9 |
.SS "Functions" |
| 10 |
|
| 11 |
.in +1c |
| 12 |
.ti -1c |
| 13 |
.RI "int \fBhwloc_windows_get_nr_processor_groups\fP (\fBhwloc_topology_t\fP topology, unsigned long flags)" |
| 14 |
.br |
| 15 |
.ti -1c |
| 16 |
.RI "int \fBhwloc_windows_get_processor_group_cpuset\fP (\fBhwloc_topology_t\fP topology, unsigned pg_index, \fBhwloc_cpuset_t\fP cpuset, unsigned long flags)" |
| 17 |
.br |
| 18 |
.in -1c |
| 19 |
.SH "Detailed Description" |
| 20 |
.PP |
| 21 |
These functions query Windows processor groups\&. These groups partition the operating system into virtual sets of up to 64 neighbor PUs\&. Threads and processes may only be bound inside a single group\&. Although Windows processor groups may be exposed in the hwloc hierarchy as hwloc Groups, they are also often merged into existing hwloc objects such as NUMA nodes or Packages\&. This API provides explicit information about Windows processor groups so that applications know whether binding to a large set of PUs may fail because it spans over multiple Windows processor groups\&. |
| 22 |
.SH "Function Documentation" |
| 23 |
.PP |
| 24 |
.SS "int hwloc_windows_get_nr_processor_groups (\fBhwloc_topology_t\fP topology, unsigned long flags)" |
| 25 |
|
| 26 |
.PP |
| 27 |
Get the number of Windows processor groups\&. \fRflags\fP must be 0 for now\&. |
| 28 |
|
| 29 |
.PP |
| 30 |
\fBReturns\fP |
| 31 |
.RS 4 |
| 32 |
at least \fR1\fP on success\&. |
| 33 |
|
| 34 |
.PP |
| 35 |
-1 on error, for instance if the topology does not match the current system (e\&.g\&. loaded from another machine through XML)\&. |
| 36 |
.RE |
| 37 |
.PP |
| 38 |
|
| 39 |
.SS "int hwloc_windows_get_processor_group_cpuset (\fBhwloc_topology_t\fP topology, unsigned pg_index, \fBhwloc_cpuset_t\fP cpuset, unsigned long flags)" |
| 40 |
|
| 41 |
.PP |
| 42 |
Get the CPU-set of a Windows processor group\&. Get the set of PU included in the processor group specified by \fRpg_index\fP\&. \fRpg_index\fP must be between \fR0\fP and the value returned by \fBhwloc_windows_get_nr_processor_groups()\fP minus 1\&. |
| 43 |
|
| 44 |
.PP |
| 45 |
\fRflags\fP must be 0 for now\&. |
| 46 |
|
| 47 |
.PP |
| 48 |
\fBReturns\fP |
| 49 |
.RS 4 |
| 50 |
\fR0\fP on success\&. |
| 51 |
|
| 52 |
.PP |
| 53 |
\fR-1\fP on error, for instance if \fRpg_index\fP is invalid, or if the topology does not match the current system (e\&.g\&. loaded from another machine through XML)\&. |
| 54 |
.RE |
| 55 |
.PP |
| 56 |
|
| 57 |
.SH "Author" |
| 58 |
.PP |
| 59 |
Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&. |