hwlocality_windows.3 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. .TH "hwlocality_windows" 3 "Thu Sep 7 2023" "Version 2.9.3" "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. .in +1c
  11. .ti -1c
  12. .RI "int \fBhwloc_windows_get_nr_processor_groups\fP (\fBhwloc_topology_t\fP topology, unsigned long flags)"
  13. .br
  14. .ti -1c
  15. .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)"
  16. .br
  17. .in -1c
  18. .SH "Detailed Description"
  19. .PP
  20. 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\&.
  21. .SH "Function Documentation"
  22. .PP
  23. .SS "int hwloc_windows_get_nr_processor_groups (\fBhwloc_topology_t\fP topology, unsigned long flags)"
  24. .PP
  25. Get the number of Windows processor groups\&. \fCflags\fP must be 0 for now\&.
  26. .PP
  27. \fBReturns\fP
  28. .RS 4
  29. at least \fC1\fP on success\&.
  30. .PP
  31. -1 on error, for instance if the topology does not match the current system (e\&.g\&. loaded from another machine through XML)\&.
  32. .RE
  33. .PP
  34. .SS "int hwloc_windows_get_processor_group_cpuset (\fBhwloc_topology_t\fP topology, unsigned pg_index, \fBhwloc_cpuset_t\fP cpuset, unsigned long flags)"
  35. .PP
  36. Get the CPU-set of a Windows processor group\&. Get the set of PU included in the processor group specified by \fCpg_index\fP\&. \fCpg_index\fP must be between \fC0\fP and the value returned by \fBhwloc_windows_get_nr_processor_groups()\fP minus 1\&.
  37. .PP
  38. \fCflags\fP must be 0 for now\&.
  39. .PP
  40. \fBReturns\fP
  41. .RS 4
  42. \fC0\fP on success\&.
  43. .PP
  44. \fC-1\fP on error, for instance if \fCpg_index\fP is invalid, or if the topology does not match the current system (e\&.g\&. loaded from another machine through XML)\&.
  45. .RE
  46. .PP
  47. .SH "Author"
  48. .PP
  49. Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.