DragonFly On-Line Manual Pages

hwlocality_tinker(3)       Hardware Locality (hwloc)      hwlocality_tinker(3)

NAME
       hwlocality_tinker - Modifying a loaded Topology

   Enumerations
       enum hwloc_restrict_flags_e { HWLOC_RESTRICT_FLAG_ADAPT_DISTANCES,
           HWLOC_RESTRICT_FLAG_ADAPT_MISC, HWLOC_RESTRICT_FLAG_ADAPT_IO }

   Functions
       hwloc_obj_t hwloc_topology_insert_misc_object_by_cpuset
           (hwloc_topology_t topology, hwloc_const_cpuset_t cpuset, const char
           *name)
       hwloc_obj_t hwloc_topology_insert_misc_object_by_parent
           (hwloc_topology_t topology, hwloc_obj_t parent, const char *name)
       int hwloc_topology_restrict (hwloc_topology_t restrict topology,
           hwloc_const_cpuset_t cpuset, unsigned long flags)

Detailed Description
Enumeration Type Documentation
   enum hwloc_restrict_flags_e
       Flags to be given to hwloc_topology_restrict().

       Enumerator

       HWLOC_RESTRICT_FLAG_ADAPT_DISTANCES
              Adapt distance matrices according to objects being removed
              during restriction. If this flag is not set, distance matrices
              are removed.

       HWLOC_RESTRICT_FLAG_ADAPT_MISC
              Move Misc objects to ancestors if their parents are removed
              during restriction. If this flag is not set, Misc objects are
              removed when their parents are removed.

       HWLOC_RESTRICT_FLAG_ADAPT_IO
              Move I/O objects to ancestors if their parents are removed
              during restriction. If this flag is not set, I/O devices and
              bridges are removed when their parents are removed.

Function Documentation
   hwloc_obj_t hwloc_topology_insert_misc_object_by_cpuset (hwloc_topology_t
       topology, hwloc_const_cpuset_t cpuset, const char * name)
       Add a MISC object to the topology. A new MISC object will be created
       and inserted into the topology at the position given by bitmap cpuset.
       This offers a way to add new intermediate levels to the topology
       hierarchy.

       cpuset and name will be copied to setup the new object attributes.

       Returns:
           the newly-created object.

           NULL if the insertion conflicts with the existing topology tree.

       Note:
           If name contains some non-printable characters, they will be
           dropped when exporting to XML, see hwloc_topology_export_xml().

   hwloc_obj_t hwloc_topology_insert_misc_object_by_parent (hwloc_topology_t
       topology, hwloc_obj_t parent, const char * name)
       Add a MISC object as a leaf of the topology. A new MISC object will be
       created and inserted into the topology at the position given by parent.
       It is appended to the list of existing children, without ever adding
       any intermediate hierarchy level. This is useful for annotating the
       topology without actually changing the hierarchy.

       name will be copied to the setup the new object attributes. However,
       the new leaf object will not have any cpuset.

       Returns:
           the newly-created object

       Note:
           If name contains some non-printable characters, they will be
           dropped when exporting to XML, see hwloc_topology_export_xml().

   int hwloc_topology_restrict (hwloc_topology_t restrict topology,
       hwloc_const_cpuset_t cpuset, unsigned long flags)
       Restrict the topology to the given CPU set. Topology topology is
       modified so as to remove all objects that are not included (or
       partially included) in the CPU set cpuset. All objects CPU and node
       sets are restricted accordingly.

       flags is a OR'ed set of hwloc_restrict_flags_e.

       Note:
           This call may not be reverted by restricting back to a larger
           cpuset. Once dropped during restriction, objects may not be brought
           back, except by loading another topology with
           hwloc_topology_load().

       Returns:
           0 on success.

           -1 with errno set to EINVAL if the input cpuset is invalid. The
           topology is not modified in this case.

           -1 with errno set to ENOMEM on failure to allocate internal data.
           The topology is reinitialized in this case. It should be either
           destroyed with hwloc_topology_destroy() or configured and loaded
           again.

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

Version 1.11.1                  Thu Oct 15 2015           hwlocality_tinker(3)