Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pmunitsstr(3) [centos man page]

PMUNITSSTR(3)						     Library Functions Manual						     PMUNITSSTR(3)

NAME
pmUnitsStr, pmUnitsStr_r - convert a performance metric's units into a string C SYNOPSIS
#include <pcp/pmapi.h> const char *pmUnitsStr(const pmUnits *pu); char *pmUnitsStr_r(const pmUnits *pu, char *buf, int buflen); cc ... -lpcp DESCRIPTION
The encoding of a performance metric's dimensionality and scale uses a pmUnits structure; see pmLookupDesc(3). As an aid to labeling graphs and tables, or for error messages, pmUnitsStr will take a dimension and scale specification as per pu, and return the corresponding text string. The pmUnitsStr_r function does the same, but stores the result in a user-supplied buffer buf of length buflen, which should have room for at least 60 bytes. For example {1, -2, 0, PM_SPACE_MBYTE, PM_TIME_SEC, 0}, as the value of *pu gives the result string Mbyte / sec^2. The string value result from pmUnitsStr is held in a single static buffer, so the returned value is only valid until the next call to pmU- nitsStr. If the ``count'' dimension is non-zero, and the ``count'' scale is not zero, then the text string will include a decimal scaling factor, eg. count x 10^6. As a special case, if all components of the dimension are zero, then the ``count'' scale is used to produce the text. If this scale is zero the result is an empty string, otherwise the result is of the form x1 0^2. NOTES
pmUnitsStr returns a pointer to a static buffer and hence is not thread-safe. Multi-threaded applications should use pmUnitsStr_r instead. SEE ALSO
PMAPI(3), pmAtomStr(3), pmConvScale(3), pmExtractValue(3), pmLookupDesc(3), pmPrintValue(3) and pmTypeStr(3). Performance Co-Pilot PCP PMUNITSSTR(3)

Check Out this Related Man Page

PMINDOMSTR(3)						     Library Functions Manual						     PMINDOMSTR(3)

NAME
pmInDomStr, pmInDomStr_r - convert a performance metric instance domain identifier into a string C SYNOPSIS
#include <pcp/pmapi.h> const char *pmInDomStr(pmInDom indom); char *pmInDomStr_r(pmInDom indom, char *buf, int buflen); cc ... -lpcp DESCRIPTION
For use in error and diagnostic messages, pmInDomStr return a 'human readable' version of the specified instance domain identifier. The pmInDomStr_r function does the same, but stores the result in a user-supplied buffer buf of length buflen, which should have room for at least 20 bytes. The value for the instance domain indom is typically extracted from a pmDesc structure, following a call to pmLookupDesc(3) for a particu- lar performance metric. Internally, an instance domain identifier is encoded as follows; typedef struct { int pad:2; unsigned int domain:8; /* the administrative PMD */ unsigned int serial:22; /* unique within PMD */ } __pmInDom_int; pmInDomStr returns a string with each of the domain and serial subfields appearing as decimal numbers, separated by periods. The string value returned by pmInDomStr is held in a single static buffer, so the returned value is only valid until the next call to pmIn- DomStr. NOTES
pmInDomStr returns a pointer to a static buffer and hence is not thread-safe. Multi-threaded applications should use pmInDomStr_r instead. PCP ENVIRONMENT
Environment variables with the prefix PCP_ are used to parameterize the file and directory names used by PCP. On each installation, the file /etc/pcp.conf contains the local values for these variables. The $PCP_CONF variable may be used to specify an alternative configura- tion file, as described in pcp.conf(5). Values for these variables may be obtained programmatically using the pmGetConfig(3) function. SEE ALSO
PMAPI(3), pmGetConfig(3), pmIDStr(3), pmLookupDesc(3), pcp.conf(5) and pcp.env(5). Performance Co-Pilot PCP PMINDOMSTR(3)
Man Page

Featured Tech Videos