manpagez: man pages & more
man hwloc_nodeset_from_linux_libnuma_ulongs(3)
Home | html | info | man
hwlocality_linux_libnuma_ulongs(3)                    Library Functions Manual


NAME

       hwlocality_linux_libnuma_ulongs - Interoperability with Linux libnuma
       unsigned long masks


SYNOPSIS

   Functions
       int hwloc_cpuset_to_linux_libnuma_ulongs (hwloc_topology_t topology,
           hwloc_const_cpuset_t cpuset, unsigned long *mask, unsigned long
           *maxnode)
       int hwloc_nodeset_to_linux_libnuma_ulongs (hwloc_topology_t topology,
           hwloc_const_nodeset_t nodeset, unsigned long *mask, unsigned long
           *maxnode)
       int hwloc_cpuset_from_linux_libnuma_ulongs (hwloc_topology_t topology,
           hwloc_cpuset_t cpuset, const unsigned long *mask, unsigned long
           maxnode)
       int hwloc_nodeset_from_linux_libnuma_ulongs (hwloc_topology_t topology,
           hwloc_nodeset_t nodeset, const unsigned long *mask, unsigned long
           maxnode)


Detailed Description

       This interface helps converting between Linux libnuma unsigned long
       masks and hwloc cpusets and nodesets.

       Note
           Topology topology must match the current machine.

           The behavior of libnuma is undefined if the kernel is not NUMA-
           aware. (when CONFIG_NUMA is not set in the kernel configuration).
           This helper and libnuma may thus not be strictly compatible in this
           case, which may be detected by checking whether numa_available()
           returns -1.


Function Documentation

   int hwloc_cpuset_from_linux_libnuma_ulongs (hwloc_topology_t topology,
       hwloc_cpuset_t cpuset, const unsigned long * mask, unsigned long
       maxnode) [inline]
       Convert the array of unsigned long mask into hwloc CPU set. mask is a
       array of unsigned long that will be read. maxnode contains the maximal
       node number that may be read in mask.

       This function may be used after calling get_mempolicy or any other
       function that takes an array of unsigned long as output parameter (and
       possibly a maximal node number as input parameter).

       Returns
           0 on success.

           -1 on error, for instance if failing an internal reallocation.

   int hwloc_cpuset_to_linux_libnuma_ulongs (hwloc_topology_t topology,
       hwloc_const_cpuset_t cpuset, unsigned long * mask, unsigned long *
       maxnode) [inline]
       Convert hwloc CPU set cpuset into the array of unsigned long mask. mask
       is the array of unsigned long that will be filled. maxnode contains the
       maximal node number that may be stored in mask. maxnode will be set to
       the maximal node number that was found, plus one.

       This function may be used before calling set_mempolicy, mbind,
       migrate_pages or any other function that takes an array of unsigned
       long and a maximal node number as input parameter.

       Returns
           0.

   int hwloc_nodeset_from_linux_libnuma_ulongs (hwloc_topology_t topology,
       hwloc_nodeset_t nodeset, const unsigned long * mask, unsigned long
       maxnode) [inline]
       Convert the array of unsigned long mask into hwloc NUMA node set. mask
       is a array of unsigned long that will be read. maxnode contains the
       maximal node number that may be read in mask.

       This function may be used after calling get_mempolicy or any other
       function that takes an array of unsigned long as output parameter (and
       possibly a maximal node number as input parameter).

       Returns
           0 on success.

           -1 with errno set to ENOMEM if some internal reallocation failed.

   int hwloc_nodeset_to_linux_libnuma_ulongs (hwloc_topology_t topology,
       hwloc_const_nodeset_t nodeset, unsigned long * mask, unsigned long *
       maxnode) [inline]
       Convert hwloc NUMA node set nodeset into the array of unsigned long
       mask. mask is the array of unsigned long that will be filled. maxnode
       contains the maximal node number that may be stored in mask. maxnode
       will be set to the maximal node number that was found, plus one.

       This function may be used before calling set_mempolicy, mbind,
       migrate_pages or any other function that takes an array of unsigned
       long and a maximal node number as input parameter.

       Returns
           0.


Author

       Generated automatically by Doxygen for Hardware Locality (hwloc) from
       the source code.

Hardware Locality (hwloc)       Version 2.12.0
                                            hwlocality_linux_libnuma_ulongs(3)

hwloc 2.12.0 - Generated Fri May 9 06:42:39 CDT 2025
© manpagez.com 2000-2025
Individual documents may contain additional copyright information.