xref: /freebsd/tools/test/hwpmc/pmctest.py (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1#!/usr/bin/env python
2# SPDX-License-Identifier: BSD-3-Clause
3#
4# Copyright (c) 2012, Neville-Neil Consulting
5# All rights reserved.
6#
7# Redistribution and use in source and binary forms, with or without
8# modification, are permitted provided that the following conditions are
9# met:
10#
11# Redistributions of source code must retain the above copyright notice,
12# this list of conditions and the following disclaimer.
13#
14# Redistributions in binary form must reproduce the above copyright
15# notice, this list of conditions and the following disclaimer in the
16# documentation and/or other materials provided with the distribution.
17#
18# Neither the name of Neville-Neil Consulting nor the names of its
19# contributors may be used to endorse or promote products derived from
20# this software without specific prior written permission.
21#
22# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33#
34# Author: George V. Neville-Neil
35#
36
37# Description: A program to run a simple program against every available
38# pmc counter present in a system.
39#
40# To use:
41#
42# pmctest.py -p ls > /dev/null
43#
44# This should result in ls being run with every available counter
45# and the system should neither lock up nor panic.
46#
47# The default is to wait after each counter is tested.  Since the
48# prompt would go to stdout you won't see it, just press return
49# to continue or Ctrl-D to stop.
50
51import sys
52import subprocess
53from subprocess import PIPE
54
55# Use input() for Python version 3
56if sys.version_info[0] == 3:
57    raw_input = input
58
59# A list of strings that are not really counters, just
60# name tags that are output by pmccontrol -L
61notcounter = ["IAF", "IAP", "TSC", "UNC", "UCF", "UCP", "SOFT" ]
62
63def main():
64
65    from optparse import OptionParser
66
67    parser = OptionParser()
68    parser.add_option("-p", "--program", dest="program",
69                      help="program to execute")
70    parser.add_option("-w", "--wait", action="store_true", dest="wait",
71                      default=True, help="wait after each execution")
72
73    (options, args) = parser.parse_args()
74
75    if (options.program == None):
76        print("specify program, such as ls, with -p/--program")
77        sys.exit()
78
79    p = subprocess.Popen(["pmccontrol", "-L"], stdout=PIPE)
80    counters = p.communicate()[0]
81
82    if len(counters) <= 0:
83        print("no counters found")
84        sys.exit()
85
86    for counter in counters.split():
87        if counter in notcounter:
88            continue
89        p = subprocess.Popen(["pmcstat", "-p", counter, options.program],
90                             stdout=PIPE)
91        result = p.communicate()[0]
92        print(result)
93        if (options.wait == True):
94            try:
95                value = raw_input("next?")
96            except EOFError:
97                sys.exit()
98
99# The canonical way to make a python module into a script.
100# Remove if unnecessary.
101
102if __name__ == "__main__":
103    main()
104