man pages section 3: Extended Library Functions, Volume 2

kstat2_lookup_map (3KSTAT2)

Name

kstat2_lookup_map - look up kstat2 data by name

Synopsis

cc [ flag... ] file... -lkstat2 [ library...]
     #include <kstat2.h>

kstat2_status_t kstat2_lookup_map(kstat2_handle_t handle,
         const char *uri, kstat2_map_t *map);

Description

The kstat2_lookup_map() function obtains a reference to a kstat2 map given the URI of the map.

Return Values

Upon successful completion, the kstat2_lookup_map() function will set the map parameter to reference the relevant map and KSTAT2_S_OK will be returned.

If the requested item cannot be found, the map reference will be set to NULL and an error will be returned.

Errors

The kstat2_lookup_map() function will fail if:

KSTAT2_S_INVAL_ARG

the handle, uri or map reference are NULL

KSTAT2_S_NOT_FOUND

the requested map could not be found

Files

/dev/kstat

kernel statistics driver

/usr/include/kstat2.h

header

Examples

See the kstat2(3KSTAT2) manpage.

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE Interface Stability Committed MT-Level MT-Safe with exceptions

See Also

kstat2(3KSTAT2), kstat2_close(3KSTAT2), kstat2_map_get(3KSTAT2), kstat2_map_get_userdata(3KSTAT2), kstat2_map_meta(3KSTAT2), kstat2_map_parent(3KSTAT2), kstat2_map_put_integer(3KSTAT2), kstat2_map_put_integers(3KSTAT2), kstat2_map_put_string(3KSTAT2), kstat2_map_put_strings(3KSTAT2), kstat2_map_remove(3KSTAT2), kstat2_map_set_data_cb(3KSTAT2), kstat2_map_set_destroy_cb(3KSTAT2), kstat2_map_set_tree_cb(3KSTAT2), kstat2_map_set_userdata(3KSTAT2), kstat2_map_size(3KSTAT2), kstat2_map_to_array(3KSTAT2), kstat2_map_uri(3KSTAT2), kstat2_mapiter_end(3KSTAT2), kstat2_mapiter_hasnext(3KSTAT2), kstat2_mapiter_next(3KSTAT2), kstat2_mapiter_remove(3KSTAT2), kstat2_mapiter_start(3KSTAT2), kstat2_mapref_alloc(3KSTAT2), kstat2_mapref_deref(3KSTAT2), kstat2_mapref_free(3KSTAT2), kstat2_nv_meta(3KSTAT2), kstat2_open(3KSTAT2), kstat2_status_string(3KSTAT2), kstat2_update(3KSTAT2), kstat2_uri_decode(3KSTAT2), kstat2_uri_encode(3KSTAT2), libkstat2(3LIB)

Notes

The kstat2 functions are MT-Safe with the exception that only one thread may actively use a kstat2_handle_t, or any object obtained through it, at any one time. Synchronization is required if multiple threads intend to share a kstat2_handle_t or any object obtained through it. Synchronization is left to the application.