1PMDBG(1) General Commands Manual PMDBG(1)
2
3
4
6 pmdbg - report Performance Co-Pilot debug options
7
9 pmdbg code ...
10 pmdbg -l [-o]
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
21 pmdbg with a -l argument prints out all the debug options. Without the
22 -o argument the output lists the name of each option and some descrip‐
23 tive text. Otherwise the output is for only the old bit-fields with
24 the mnemonic and decimal values of each the bit-field along with some
25 descriptive text.
26
27 pmdbg with a -D argument parses the list of names(s) using __pmParseDe‐
28 bug(3) and reports the corresponding decimal value. This use is not
29 required in the new scheme, but for the old bit-fields scheme it was
30 useful when debugging and wanting to set the internal value of the con‐
31 trol vector (pmDebug) via a debugger, e.g. gdb(1). For the new
32 scheme, the same effect can be achieved using the name of the option(s)
33 and calling pmSetDebug(3) from within the debugger.
34
35 The alternative usage also relates to the old bit-field scheme and the
36 code arguments are values for the debug vector, and the bit-fields that
37 are enabled by each of these values is listed.
38
39 Each code may be an integer, a hexadecimal value or a hexadecimal value
40 prefixed by either ``0x'' or ``0X''.
41
42 Most applications using the facilities of the PCP support a -D
43 name[,name ...] command-line syntax to enable debug control using the
44 name(s) of the desired debug options.
45
46 Alternatively the initial value of the debug control flags may be set
47 to either a value N (old scheme) or a comma-separated list if option
48 name(s) (new scheme) using the environment variable $PCP_DEBUG. If
49 both mechanisms are used the effect is additive, so the resultant flags
50 are those set via $PCP_DEBUG combined with those set via any -D command
51 line options.
52
54 The available command line options are:
55
56 -D name, --debug=name
57 Parse a comma-separated list of name(s) and report the correspond‐
58 ing decimal value(s).
59
60 -l, --list
61 List all the debug options.
62
63 -o, --old
64 Use old-style output format with -l.
65
66 -?, --help
67 Display usage message and exit.
68
70 Environment variables with the prefix PCP_ are used to parameterize the
71 file and directory names used by PCP. On each installation, the file
72 /etc/pcp.conf contains the local values for these variables. The
73 $PCP_CONF variable may be used to specify an alternative configuration
74 file, as described in pcp.conf(5).
75
77 PCPIntro(1), pmSetDebug(3), pmClearDebug(3), __pmParseDebug(3),
78 pcp.conf(5) and pcp.env(5).
79
80
81
82Performance Co-Pilot PCP PMDBG(1)