Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

kstat_chain_update(3kstat) [opensolaris man page]

kstat_chain_update(3KSTAT)				Kernel Statistics Library Functions				kstat_chain_update(3KSTAT)

NAME
kstat_chain_update - update the kstat header chain SYNOPSIS
cc [ flag... ] file... -lkstat [ library...] #include <kstat.h> kid_t kstat_chain_update(kstat_ctl_t *kc); DESCRIPTION
The kstat_chain_update() function brings the user's kstat header chain in sync with that of the kernel. The kstat chain is a linked list of kstat headers (kstat_t's) pointed to by kc->kc_chain, which is initialized by kstat_open(3KSTAT). This chain constitutes a list of all kstats currently in the system. During normal operation, the kernel creates new kstats and delete old ones as various device instances are added and removed, thereby caus- ing the user's copy of the kstat chain to become out of date. The kstat_chain_update() function detects this condition by comparing the kernel's current kstat chain ID (KCID), which is incremented every time the kstat chain changes, to the user's KCID, kc->kc_chain_id. If the KCIDs match, kstat_chain_update() does nothing. Otherwise, it deletes any invalid kstat headers from the user's kstat chain, adds any new ones, and sets kc->kc_chain_id to the new KCID. All other kstat headers in the user's kstat chain are unmodified. RETURN VALUES
Upon successful completion, kstat_chain_update() returns the new KCID if the kstat chain has changed and 0 if it has not changed. Other- wise, it returns -1 and sets errno to indicate the error. ERRORS
The kstat_chain_update() function will fail if: EAGAIN The kstat was temporarily unavailable for reading or writing. ENOMEM Insufficient storage space is available. ENXIO The given kstat could not be located for reading. EOVERFLOW The data for the given kstat was too large to be stored in the structure. FILES
/dev/kstat kernel statistics driver ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Stable | +-----------------------------+-----------------------------+ |MT-Level |Unsafe | +-----------------------------+-----------------------------+ SEE ALSO
kstat(3KSTAT), kstat_lookup(3KSTAT), kstat_open(3KSTAT), kstat_read(3KSTAT), attributes(5) SunOS 5.11 3 Aug 2004 kstat_chain_update(3KSTAT)

Check Out this Related Man Page

kstat_lookup(3KSTAT)					Kernel Statistics Library Functions				      kstat_lookup(3KSTAT)

NAME
kstat_lookup, kstat_data_lookup - find a kstat by name SYNOPSIS
cc [ flag... ] file... -lkstat [ library...] #include <kstat.h> kstat_t *kstat_lookup(kstat_ctl_t *kc, char *ks_module, int ks_instance, char *ks_name); void *kstat_data_lookup(kstat_t *ksp, char *name); DESCRIPTION
The kstat_lookup() function traverses the kstat chain, kc->kc_chain, searching for a kstat with the same ks_module, ks_instance, and ks_name fields; this triplet uniquely identifies a kstat. If ks_module is NULL, ks_instance is -1, or ks_name is NULL, those fields will be ignored in the search. For example, kstat_lookup(kc, NULL, -1, "foo") will find the first kstat with name "foo". The kstat_data_lookup() function searches the kstat's data section for the record with the specified name. This operation is valid only for those kstat types that have named data records: KSTAT_TYPE_NAMED and KSTAT_TYPE_TIMER. RETURN VALUES
The kstat_lookup() function returns a pointer to the requested kstat if it is found. Otherwise it returns NULL and sets errno to indicate the error. The kstat_data_lookup() function returns a pointer to the requested data record if it is found. Otherwise it returns NULL and sets errno to indicate the error . ERRORS
The kstat_lookup() and kstat_data_lookup() functions will fail if: EINVAL An attempt was made to look up data for a kstat that was not of type KSTAT_TYPE_NAMED or KSTAT_TYPE_TIMER. ENOENT The requested kstat could not be found. FILES
/dev/kstat kernel statistics driver ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Stable | +-----------------------------+-----------------------------+ |MT-Level |Unsafe | +-----------------------------+-----------------------------+ SEE ALSO
kstat(3KSTAT), kstat_chain_update(3KSTAT), kstat_open(3KSTAT), kstat_read(3KSTAT), attributes(5) SunOS 5.11 3 Aug 2004 kstat_lookup(3KSTAT)
Man Page