Configure Topology Detection


Enumerations

enum  topo_flags_e { TOPO_FLAGS_WHOLE_SYSTEM = (1<<1) }
 Flags to be set onto a topology context before load. More...

Functions

int topo_topology_ignore_type (topo_topology_t topology, topo_obj_type_t type)
 Ignore an object type.
int topo_topology_ignore_type_keep_structure (topo_topology_t topology, topo_obj_type_t type)
 Ignore an object type if it does not bring any structure.
int topo_topology_ignore_all_keep_structure (topo_topology_t topology)
 Ignore all objects that do not bring any structure.
int topo_topology_set_flags (topo_topology_t topology, unsigned long flags)
 Set OR'ed flags to non-yet-loaded topology.
int topo_topology_set_fsys_root (topo_topology_t __topo_restrict topology, const char *__topo_restrict fsys_root_path)
 Change the file-system root path when building the topology from sysfs/procfs.
int topo_topology_set_synthetic (topo_topology_t __topo_restrict topology, const char *__topo_restrict description)
 Enable synthetic topology.
int topo_topology_set_xml (topo_topology_t __topo_restrict topology, const char *__topo_restrict xmlpath)
 Enable XML-file based topology.

Detailed Description

These functions can optionally be called between topology_init() and topology_load() to configure how the detection should be performed, e.g. to ignore some objects types, define a synthetic topology, etc.

If none of them is called, the default is to detect all the objects of the machine that the caller is allowed to access.


Enumeration Type Documentation

Flags to be set onto a topology context before load.

Flags should be given to topo_topology_set_flags().

Enumerator:
TOPO_FLAGS_WHOLE_SYSTEM 


Function Documentation

int topo_topology_ignore_all_keep_structure ( topo_topology_t  topology  ) 

Ignore all objects that do not bring any structure.

Ignore all objects that do not bring any structure: Each ignored object should have a single children or be the only child of its father.

int topo_topology_ignore_type ( topo_topology_t  topology,
topo_obj_type_t  type 
)

Ignore an object type.

Ignore all objects from the given type. The top-level type TOPO_OBJ_SYSTEM and bottom-level type TOPO_OBJ_PROC may not be ignored.

int topo_topology_ignore_type_keep_structure ( topo_topology_t  topology,
topo_obj_type_t  type 
)

Ignore an object type if it does not bring any structure.

Ignore all objects from the given type as long as they do not bring any structure: Each ignored object should have a single children or be the only child of its father. The top-level type TOPO_OBJ_SYSTEM and bottom-level type TOPO_OBJ_PROC may not be ignored.

int topo_topology_set_flags ( topo_topology_t  topology,
unsigned long  flags 
)

Set OR'ed flags to non-yet-loaded topology.

Set a OR'ed set of topo_flags_e onto a topology that was not yet loaded.

int topo_topology_set_fsys_root ( topo_topology_t __topo_restrict  topology,
const char *__topo_restrict  fsys_root_path 
)

Change the file-system root path when building the topology from sysfs/procfs.

On Linux system, use sysfs and procfs files as if they were mounted on the given fsys_root_path instead of the main file-system root. Not using the main file-system root causes the is_fake field of the topo_topology_info structure to be set.

int topo_topology_set_synthetic ( topo_topology_t __topo_restrict  topology,
const char *__topo_restrict  description 
)

Enable synthetic topology.

Gather topology information from the given description which should be a comma separated string of numbers describing the arity of each level. Each number may be prefixed with a type and a colon to enforce the type of a level.

int topo_topology_set_xml ( topo_topology_t __topo_restrict  topology,
const char *__topo_restrict  xmlpath 
)

Enable XML-file based topology.

Gather topology information the XML file given at xmlpath. This file may have been generated earlier with lstopo file.xml.


Generated on Fri Jul 3 19:00:23 2009 for libtopology by  doxygen 1.5.9