pmid_helper(3) — Linux manual page

NAME | C SYNOPSIS | DESCRIPTION | SEE ALSO | COLOPHON

PMID_BUILD(3)            Library Functions Manual           PMID_BUILD(3)

NAME         top

       pmID_build, pmID_domain, pmID_cluster, pmID_item - helper methods
       for manipulating PMIDs

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       pmID pmID_build(unsigned int domain, unsigned int cluster,
                       unsigned int item);
       unsigned int pmID_domain(pmID pmid);
       unsigned int pmID_cluster(pmID pmid);
       unsigned int pmID_item(pmID pmid);

       cc ... -lpcp

DESCRIPTION         top

       Within  the  Performance  Co-Pilot (PCP) each metric is assigned a
       unique Performance Metric Identifier (pmID).  Internally a pmID is
       constructed from 3 fields: the domain number  (of  the  associated
       Performance Metrics Domain Agent, or PMDA), the cluster number and
       the item number (the last two are assigned by the PMDA).

       pmID_build constructs a pmID from domain, cluster and item.

       pmID_domain,  pmID_cluster  and  pmID_item  return  the respective
       fields from pmid.

SEE ALSO         top

       PMAPI(3) and pmIDStr(3).

COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.   In‐
       formation  about the project can be found at ⟨http://www.pcp.io/⟩.
       If you have a  bug  report  for  this  manual  page,  send  it  to
       pcp@groups.io.  This page was obtained from the project's upstream
       Git  repository ⟨https://github.com/performancecopilot/pcp.git⟩ on
       2025-08-11.  (At that time, the date of  the  most  recent  commit
       that was found in the repository was 2025-08-11.)  If you discover
       any  rendering  problems  in this HTML version of the page, or you
       believe there is a better or more up-to-date source for the  page,
       or you have corrections or improvements to the information in this
       COLOPHON  (which  is not part of the original manual page), send a
       mail to man-pages@man7.org

Performance Co-Pilot               PCP                      PMID_BUILD(3)