Object/String Conversion

Functions
HWLOC_DECLSPEC const char *	hwloc_obj_type_string (hwloc_obj_type_t type) __hwloc_attribute_const
	Return a stringified topology object type.
HWLOC_DECLSPEC hwloc_obj_type_t	hwloc_obj_type_of_string (const char *string) __hwloc_attribute_pure
	Return an object type from the string.
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.
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.
HWLOC_DECLSPEC int	hwloc_obj_snprintf (char __hwloc_restrict string, size_t size, hwloc_topology_t topology, hwloc_obj_t obj, const char __hwloc_restrict indexprefix, int verbose)
	Stringify a given topology object into a human-readable form.
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.

Function Documentation

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.

Returns:: how many characters were actually written (not including the ending \0), or -1 on error.

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.

Returns:: how many characters were actually written (not including the ending \0).

HWLOC_DECLSPEC int hwloc_obj_snprintf	(	char *__hwloc_restrict	string,
		size_t	size,
		hwloc_topology_t	topology,
		hwloc_obj_t	obj,
		const char *__hwloc_restrict	indexprefix,
		int	verbose
	)

Stringify a given topology object into a human-readable form.

Note:: This function is deprecated in favor of hwloc_obj_type_snprintf() and hwloc_obj_attr_snprintf() since it is not very flexible and only prints physical/OS indexes.

Fill string string up to size characters with the description of topology object obj in topology topology.

If verbose is set, a longer description is used. Otherwise a short description is used.

indexprefix is used to prefix the os_index attribute number of the object in the description. If NULL, the # character is used.

Returns:: how many characters were actually written (not including the ending \0), or -1 on error.

HWLOC_DECLSPEC hwloc_obj_type_t hwloc_obj_type_of_string ( const char * string )

Return an object type from the string.

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.

Returns:: how many characters were actually written (not including the ending \0), or -1 on error.

HWLOC_DECLSPEC const char* hwloc_obj_type_string ( hwloc_obj_type_t type ) const

Return a stringified topology object type.