Open MPI logo

Portable Hardware Locality (hwloc) Documentation: v1.8

  |   Home   |   Support   |   FAQ   |  
Manipulating Object Type, Sets and Attributes as Strings

Functions

HWLOC_DECLSPEC const char * hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const
 
HWLOC_DECLSPEC hwloc_obj_type_t hwloc_obj_type_of_string (const char *string) __hwloc_attribute_pure
 
HWLOC_DECLSPEC int hwloc_obj_type_snprintf (char *__hwloc_restrict string, size_t size, hwloc_obj_t obj, int verbose)
 
HWLOC_DECLSPEC int hwloc_obj_attr_snprintf (char *__hwloc_restrict string, size_t size, hwloc_obj_t obj, const char *__hwloc_restrict separator, int verbose)
 
HWLOC_DECLSPEC int hwloc_obj_cpuset_snprintf (char *__hwloc_restrict str, size_t size, size_t nobj, const hwloc_obj_t *__hwloc_restrict objs)
 
static __hwloc_inline const char * hwloc_obj_get_info_by_name (hwloc_obj_t obj, const char *name) __hwloc_attribute_pure
 
HWLOC_DECLSPEC void hwloc_obj_add_info (hwloc_obj_t obj, const char *name, const char *value)
 

Detailed Description

Function Documentation

HWLOC_DECLSPEC void hwloc_obj_add_info ( hwloc_obj_t  obj,
const char *  name,
const char *  value 
)

Add the given info name and value pair to the given object.

The info is appended to the existing info array even if another key with the same name already exists.

The input strings are copied before being added in the object infos.

Note
This function may be used to enforce object colors in the lstopo graphical output by using "lstopoStyle" as a name and "Background=#rrggbb" as a value. See CUSTOM COLORS in the lstopo(1) manpage for details.
If value contains some non-printable characters, they will be dropped when exporting to XML, see hwloc_topology_export_xml().
HWLOC_DECLSPEC int hwloc_obj_attr_snprintf ( char *__hwloc_restrict  string,
size_t  size,
hwloc_obj_t  obj,
const char *__hwloc_restrict  separator,
int  verbose 
)

Stringify the attributes of a given topology object into a human-readable form.

Attribute values are separated by separator.

Only the major attributes are printed in non-verbose mode.

If size is 0, string may safely be NULL.

Returns
the number of character that were actually written if not truncating, or that would have been written (not including the ending \0).
HWLOC_DECLSPEC int hwloc_obj_cpuset_snprintf ( char *__hwloc_restrict  str,
size_t  size,
size_t  nobj,
const hwloc_obj_t *__hwloc_restrict  objs 
)

Stringify the cpuset containing a set of objects.

If size is 0, string may safely be NULL.

Returns
the number of character that were actually written if not truncating, or that would have been written (not including the ending \0).
static __hwloc_inline const char* hwloc_obj_get_info_by_name ( hwloc_obj_t  obj,
const char *  name 
)
static

Search the given key name in object infos and return the corresponding value.

If multiple keys match the given name, only the first one is returned.

Returns
NULL if no such key exists.
HWLOC_DECLSPEC hwloc_obj_type_t hwloc_obj_type_of_string ( const char *  string)

Return an object type from the string.

Returns
-1 if unrecognized.
HWLOC_DECLSPEC int hwloc_obj_type_snprintf ( char *__hwloc_restrict  string,
size_t  size,
hwloc_obj_t  obj,
int  verbose 
)

Stringify the type of a given topology object into a human-readable form.

It differs from hwloc_obj_type_string() because it prints type attributes such as cache depth and type.

If size is 0, string may safely be NULL.

Returns
the number of character that were actually written if not truncating, or that would have been written (not including the ending \0).
HWLOC_DECLSPEC const char* hwloc_obj_type_string ( hwloc_obj_type_t  type) const

Return a stringified topology object type.