pmsetdebug(3) — Linux manual page


PMSETDEBUG(3)           Library Functions Manual           PMSETDEBUG(3)

NAME         top

       pmSetDebug, pmClearDebug - manipulate PCP debugging control

C SYNOPSIS         top

       #include <pcp/pmapi.h>

       int pmSetDebug(const char *spec);
       int pmClearDebug(const char *spec);

       cc ... -lpcp

DESCRIPTION         top

       Within the libraries and applications of the Performance Co-Pilot
       (PCP) there is an extensive set of debugging options that may be
       enabled or disabled at run-time.

       Both pmSetDebug and pmClearDebug parse spec assuming it to be a
       comma separated list of PCP debug option names.

       The names of the available options may be found using the -l
       argument to pmdbg(1).

       As a special case, the name ``all'' is treated as a synonym for
       identifying all option names.

       pmSetDebug will set the corresponding options, while pmClearDebug
       will clear the corresponding options.

       Consecutive calls to either routine will be additive.  For
       example the following code fragments are equivalent in terms of
       the final configuration of the debug options.

            sts = pmClearDebug("all");
            sts = pmSetDebug("appl0");
            sts = pmSetDebug("pdu,fetch");
            sts = pmSetDebug("fetch,profile,context");
            sts = pmClearDebug("appl0");

            sts = pmClearDebug("all");
            sts = pmSetDebug("pdu,fetch,profile,context");

       An earlier implementation of the PCP debug facilities used a bit-
       vector and for backwards compatibility the elements of spec may
       include decimal values corresponding to those bit-values.  Refer
       to pmdbg(1) for more details of this deprecated format.

DIAGNOSTICS         top

       If successful, these routines return 0, otherwise the return is
       PM_ERR_CONV to indicate a parsing error.

SEE ALSO         top


COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.
       Information about the project can be found at 
       ⟨⟩.  If you have a bug report for this manual
       page, send it to  This page was obtained from the
       project's upstream Git repository
       ⟨⟩ on 2023-12-22.
       (At that time, the date of the most recent commit that was found
       in the repository was 2023-12-16.)  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

Performance Co-Pilot               PCP                     PMSETDEBUG(3)

Pages that refer to this page: pmdbg(1)pmdaconnect(3)pmgetoptions(3)pmparsedebug(3)QMC(3)QmcContext(3)QmcDesc(3)QmcGroup(3)QmcIndom(3)QmcMetric(3)QmcSource(3)