1PMDBG(1) General Commands Manual PMDBG(1)
2
6 pmdbg - report Performance Co-Pilot debug options
7
9 pmdbg code ...
10 pmdbg -l [-o] [-g]
11 pmdbg -D name[,name ...]
12
14 The components of the Performance Co-Pilot (PCP) use a global mechanism
15 to control diagnostic and debug output. Historically this was a vector
16 of bit-fields but this was later replaced by an array of debug options.
17 All of the bit-field debug controls have an equivalent in the new
18 scheme, but some new debug options cannot be represented in the old
19 bit-field scheme.
20 pmdbg with a -l option prints out all the debug options. If there is
22 no -g and no -o option then the output lists the name of each option
23 and some descriptive text.
24 With the -l and -g options the descriptive text is replaced with an ex‐
26 pression that can be used to set or print the corresponding debug flag
27 in gdb (1).
28 With the -l and -o options the output is for only the old bit-fields
30 with the mnemonic and decimal values of each the bit-field along with
31 some descriptive text.
32 Obviously the -o and -g options are mutually exclusive.
34 pmdbg with a -D option parses the list of names(s) using __pmParseDe‐
36 bug(3) and reports the corresponding decimal value. This use is not
37 required in the new scheme, but for the old bit-fields scheme it was
38 useful when debugging and wanting to set the internal value of the con‐
39 trol vector (pmDebug) via a debugger, e.g. gdb(1). For the new
40 scheme, the same effect can be achieved using the name of the option(s)
41 and calling pmSetDebug(3) from within the debugger.
42 The alternative usage also relates to the old bit-field scheme and the
44 code arguments are values for the debug vector, and the bit-fields that
45 are enabled by each of these values is listed.
46 Each code may be an integer, a hexadecimal value or a hexadecimal value
48 prefixed by either ``0x'' or ``0X''.
49 Most applications using the facilities of the PCP support a -D
51 name[,name ...] command-line syntax to enable debug control using the
52 name(s) of the desired debug options.
53 Alternatively the initial value of the debug control flags may be set
55 to either a value N (old scheme) or a comma-separated list if option
56 name(s) (new scheme) using the environment variable $PCP_DEBUG. If
57 both mechanisms are used the effect is additive, so the resultant flags
58 are those set via $PCP_DEBUG combined with those set via any -D command
59 line options.
60
62 The available command line options are:
63 -D name, --debug=name
65 Parse a comma-separated list of name(s) and report the correspond‐
66 ing decimal value(s).
67 -l, --list
69 List all the debug options.
70 -g, --gdb
72 Output gdb(1) expressions with -l.
73 -o, --old
75 Use old-style output format with -l.
76 -?, --help
78 Display usage message and exit.
79
81 Environment variables with the prefix PCP_ are used to parameterize the
82 file and directory names used by PCP. On each installation, the file
83 /etc/pcp.conf contains the local values for these variables. The
84 $PCP_CONF variable may be used to specify an alternative configuration
85 file, as described in pcp.conf(5).
86
88 PCPIntro(1), pmSetDebug(3), pmClearDebug(3), __pmParseDebug(3),
89 pcp.conf(5) and pcp.env(5).
90Performance Co-Pilot PCP PMDBG(1)