annotate contrib/gen_autofdo_event.py @ 158:494b0b89df80 default tip

...
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Mon, 25 May 2020 18:13:55 +0900
parents 04ced10e8804
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
111
kono
parents:
diff changeset
1 #!/usr/bin/python
kono
parents:
diff changeset
2 # Generate Intel taken branches Linux perf event script for autofdo profiling.
kono
parents:
diff changeset
3
kono
parents:
diff changeset
4 # Copyright (C) 2016 Free Software Foundation, Inc.
kono
parents:
diff changeset
5 #
kono
parents:
diff changeset
6 # GCC is free software; you can redistribute it and/or modify it under
kono
parents:
diff changeset
7 # the terms of the GNU General Public License as published by the Free
kono
parents:
diff changeset
8 # Software Foundation; either version 3, or (at your option) any later
kono
parents:
diff changeset
9 # version.
kono
parents:
diff changeset
10 #
kono
parents:
diff changeset
11 # GCC is distributed in the hope that it will be useful, but WITHOUT ANY
kono
parents:
diff changeset
12 # WARRANTY; without even the implied warranty of MERCHANTABILITY or
kono
parents:
diff changeset
13 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
kono
parents:
diff changeset
14 # for more details.
kono
parents:
diff changeset
15 #
kono
parents:
diff changeset
16 # You should have received a copy of the GNU General Public License
kono
parents:
diff changeset
17 # along with GCC; see the file COPYING3. If not see
kono
parents:
diff changeset
18 # <http://www.gnu.org/licenses/>. */
kono
parents:
diff changeset
19
kono
parents:
diff changeset
20 # Run it with perf record -b -e EVENT program ...
kono
parents:
diff changeset
21 # The Linux Kernel needs to support the PMU of the current CPU, and
kono
parents:
diff changeset
22 # It will likely not work in VMs.
kono
parents:
diff changeset
23 # Add --all to print for all cpus, otherwise for current cpu.
kono
parents:
diff changeset
24 # Add --script to generate shell script to run correct event.
kono
parents:
diff changeset
25 #
kono
parents:
diff changeset
26 # Requires internet (https) access. This may require setting up a proxy
kono
parents:
diff changeset
27 # with export https_proxy=...
kono
parents:
diff changeset
28 #
kono
parents:
diff changeset
29 import urllib2
kono
parents:
diff changeset
30 import sys
kono
parents:
diff changeset
31 import json
kono
parents:
diff changeset
32 import argparse
kono
parents:
diff changeset
33 import collections
kono
parents:
diff changeset
34
kono
parents:
diff changeset
35 baseurl = "https://download.01.org/perfmon"
kono
parents:
diff changeset
36
kono
parents:
diff changeset
37 target_events = (u'BR_INST_RETIRED.NEAR_TAKEN',
kono
parents:
diff changeset
38 u'BR_INST_EXEC.TAKEN',
kono
parents:
diff changeset
39 u'BR_INST_RETIRED.TAKEN_JCC',
kono
parents:
diff changeset
40 u'BR_INST_TYPE_RETIRED.COND_TAKEN')
kono
parents:
diff changeset
41
kono
parents:
diff changeset
42 ap = argparse.ArgumentParser()
kono
parents:
diff changeset
43 ap.add_argument('--all', '-a', help='Print for all CPUs', action='store_true')
kono
parents:
diff changeset
44 ap.add_argument('--script', help='Generate shell script', action='store_true')
kono
parents:
diff changeset
45 args = ap.parse_args()
kono
parents:
diff changeset
46
kono
parents:
diff changeset
47 eventmap = collections.defaultdict(list)
kono
parents:
diff changeset
48
kono
parents:
diff changeset
49 def get_cpu_str():
kono
parents:
diff changeset
50 with open('/proc/cpuinfo', 'r') as c:
kono
parents:
diff changeset
51 vendor, fam, model = None, None, None
kono
parents:
diff changeset
52 for j in c:
kono
parents:
diff changeset
53 n = j.split()
kono
parents:
diff changeset
54 if n[0] == 'vendor_id':
kono
parents:
diff changeset
55 vendor = n[2]
kono
parents:
diff changeset
56 elif n[0] == 'model' and n[1] == ':':
kono
parents:
diff changeset
57 model = int(n[2])
kono
parents:
diff changeset
58 elif n[0] == 'cpu' and n[1] == 'family':
kono
parents:
diff changeset
59 fam = int(n[3])
kono
parents:
diff changeset
60 if vendor and fam and model:
kono
parents:
diff changeset
61 return "%s-%d-%X" % (vendor, fam, model), model
kono
parents:
diff changeset
62 return None, None
kono
parents:
diff changeset
63
kono
parents:
diff changeset
64 def find_event(eventurl, model):
kono
parents:
diff changeset
65 print >>sys.stderr, "Downloading", eventurl
kono
parents:
diff changeset
66 u = urllib2.urlopen(eventurl)
kono
parents:
diff changeset
67 events = json.loads(u.read())
kono
parents:
diff changeset
68 u.close()
kono
parents:
diff changeset
69
kono
parents:
diff changeset
70 found = 0
kono
parents:
diff changeset
71 for j in events:
kono
parents:
diff changeset
72 if j[u'EventName'] in target_events:
kono
parents:
diff changeset
73 event = "cpu/event=%s,umask=%s/" % (j[u'EventCode'], j[u'UMask'])
kono
parents:
diff changeset
74 if u'PEBS' in j and j[u'PEBS'] > 0:
kono
parents:
diff changeset
75 event += "p"
kono
parents:
diff changeset
76 if args.script:
kono
parents:
diff changeset
77 eventmap[event].append(model)
kono
parents:
diff changeset
78 else:
kono
parents:
diff changeset
79 print j[u'EventName'], "event for model", model, "is", event
kono
parents:
diff changeset
80 found += 1
kono
parents:
diff changeset
81 return found
kono
parents:
diff changeset
82
kono
parents:
diff changeset
83 if not args.all:
kono
parents:
diff changeset
84 cpu, model = get_cpu_str()
kono
parents:
diff changeset
85 if not cpu:
kono
parents:
diff changeset
86 sys.exit("Unknown CPU type")
kono
parents:
diff changeset
87
kono
parents:
diff changeset
88 url = baseurl + "/mapfile.csv"
kono
parents:
diff changeset
89 print >>sys.stderr, "Downloading", url
kono
parents:
diff changeset
90 u = urllib2.urlopen(url)
kono
parents:
diff changeset
91 found = 0
kono
parents:
diff changeset
92 cpufound = 0
kono
parents:
diff changeset
93 for j in u:
kono
parents:
diff changeset
94 n = j.rstrip().split(',')
kono
parents:
diff changeset
95 if len(n) >= 4 and (args.all or n[0] == cpu) and n[3] == "core":
kono
parents:
diff changeset
96 if args.all:
kono
parents:
diff changeset
97 vendor, fam, model = n[0].split("-")
kono
parents:
diff changeset
98 model = int(model, 16)
kono
parents:
diff changeset
99 cpufound += 1
kono
parents:
diff changeset
100 found += find_event(baseurl + n[2], model)
kono
parents:
diff changeset
101 u.close()
kono
parents:
diff changeset
102
kono
parents:
diff changeset
103 if args.script:
kono
parents:
diff changeset
104 print '''#!/bin/sh
kono
parents:
diff changeset
105 # Profile workload for gcc profile feedback (autofdo) using Linux perf.
kono
parents:
diff changeset
106 # Auto generated. To regenerate for new CPUs run
kono
parents:
diff changeset
107 # contrib/gen_autofdo_event.py --script --all in gcc source
kono
parents:
diff changeset
108
kono
parents:
diff changeset
109 # usages:
kono
parents:
diff changeset
110 # gcc-auto-profile program (profile program and children)
kono
parents:
diff changeset
111 # gcc-auto-profile -a sleep X (profile all for X secs, may need root)
kono
parents:
diff changeset
112 # gcc-auto-profile -p PID sleep X (profile PID)
kono
parents:
diff changeset
113 # gcc-auto-profile --kernel -a sleep X (profile kernel)
kono
parents:
diff changeset
114 # gcc-auto-profile --all -a sleep X (profile kernel and user space)
kono
parents:
diff changeset
115
kono
parents:
diff changeset
116 # Identify branches taken event for CPU.
kono
parents:
diff changeset
117 #
kono
parents:
diff changeset
118
kono
parents:
diff changeset
119 FLAGS=u
kono
parents:
diff changeset
120
kono
parents:
diff changeset
121 if [ "$1" = "--kernel" ] ; then
kono
parents:
diff changeset
122 FLAGS=k
kono
parents:
diff changeset
123 shift
kono
parents:
diff changeset
124 fi
kono
parents:
diff changeset
125 if [ "$1" = "--all" ] ; then
kono
parents:
diff changeset
126 FLAGS=uk
kono
parents:
diff changeset
127 shift
kono
parents:
diff changeset
128 fi
kono
parents:
diff changeset
129
kono
parents:
diff changeset
130 if ! grep -q Intel /proc/cpuinfo ; then
kono
parents:
diff changeset
131 echo >&2 "Only Intel CPUs supported"
kono
parents:
diff changeset
132 exit 1
kono
parents:
diff changeset
133 fi
kono
parents:
diff changeset
134
kono
parents:
diff changeset
135 if grep -q hypervisor /proc/cpuinfo ; then
kono
parents:
diff changeset
136 echo >&2 "Warning: branch profiling may not be functional in VMs"
kono
parents:
diff changeset
137 fi
kono
parents:
diff changeset
138
kono
parents:
diff changeset
139 case `egrep -q "^cpu family\s*: 6" /proc/cpuinfo &&
kono
parents:
diff changeset
140 egrep "^model\s*:" /proc/cpuinfo | head -n1` in'''
kono
parents:
diff changeset
141 for event, mod in eventmap.iteritems():
kono
parents:
diff changeset
142 for m in mod[:-1]:
kono
parents:
diff changeset
143 print "model*:\ %s|\\" % m
kono
parents:
diff changeset
144 print 'model*:\ %s) E="%s$FLAGS" ;;' % (mod[-1], event)
kono
parents:
diff changeset
145 print '''*)
kono
parents:
diff changeset
146 echo >&2 "Unknown CPU. Run contrib/gen_autofdo_event.py --all --script to update script."
kono
parents:
diff changeset
147 exit 1 ;;'''
kono
parents:
diff changeset
148 print "esac"
kono
parents:
diff changeset
149 print 'exec perf record -e $E -b "$@"'
kono
parents:
diff changeset
150
kono
parents:
diff changeset
151 if cpufound == 0 and not args.all:
kono
parents:
diff changeset
152 sys.exit('CPU %s not found' % cpu)
kono
parents:
diff changeset
153
kono
parents:
diff changeset
154 if found == 0:
kono
parents:
diff changeset
155 sys.exit('Branch event not found')