aboutsummaryrefslogtreecommitdiffstats
path: root/tools/perf/scripts/python/event_analyzing_sample.py
blob: 163c39fa12d92baf83630670e1301799ac301909 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# event_analyzing_sample.py: general event handler in python
#
# Current perf report is already very powerful with the annotation integrated,
# and this script is not trying to be as powerful as perf report, but
# providing end user/developer a flexible way to analyze the events other
# than trace points.
#
# The 2 database related functions in this script just show how to gather
# the basic information, and users can modify and write their own functions
# according to their specific requirement.
#
# The first function "show_general_events" just does a basic grouping for all
# generic events with the help of sqlite, and the 2nd one "show_pebs_ll" is
# for a x86 HW PMU event: PEBS with load latency data.
#

import os
import sys
import math
import struct
import sqlite3

sys.path.append(os.environ['PERF_EXEC_PATH'] + \
        '/scripts/python/Perf-Trace-Util/lib/Perf/Trace')

from perf_trace_context import *
from EventClass import *

#
# If the perf.data has a big number of samples, then the insert operation
# will be very time consuming (about 10+ minutes for 10000 samples) if the
# .db database is on disk. Move the .db file to RAM based FS to speedup
# the handling, which will cut the time down to several seconds.
#
con = sqlite3.connect("/dev/shm/perf.db")
con.isolation_level = None

def trace_begin():
	print "In trace_begin:\n"

        #
        # Will create several tables at the start, pebs_ll is for PEBS data with
        # load latency info, while gen_events is for general event.
        #
        con.execute("""
                create table if not exists gen_events (
                        name text,
                        symbol text,
                        comm text,
                        dso text
                );""")
        con.execute("""
                create table if not exists pebs_ll (
                        name text,
                        symbol text,
                        comm text,
                        dso text,
                        flags integer,
                        ip integer,
                        status integer,
                        dse integer,
                        dla integer,
                        lat integer
                );""")

#
# Create and insert event object to a database so that user could
# do more analysis with simple database commands.
#
def process_event(param_dict):
        event_attr = param_dict["attr"]
        sample     = param_dict["sample"]
        raw_buf    = param_dict["raw_buf"]
        comm       = param_dict["comm"]
        name       = param_dict["ev_name"]

        # Symbol and dso info are not always resolved
        if (param_dict.has_key("dso")):
                dso = param_dict["dso"]
        else:
                dso = "Unknown_dso"

        if (param_dict.has_key("symbol")):
                symbol = param_dict["symbol"]
        else:
                symbol = "Unknown_symbol"

        # Create the event object and insert it to the right table in database
        event = create_event(name, comm, dso, symbol, raw_buf)
        insert_db(event)

def insert_db(event):
        if event.ev_type == EVTYPE_GENERIC:
                con.execute("insert into gen_events values(?, ?, ?, ?)",
                                (event.name, event.symbol, event.comm, event.dso))
        elif event.ev_type == EVTYPE_PEBS_LL:
                event.ip &= 0x7fffffffffffffff
                event.dla &= 0x7fffffffffffffff
                con.execute("insert into pebs_ll values (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)",
                        (event.name, event.symbol, event.comm, event.dso, event.flags,
                                event.ip, event.status, event.dse, event.dla, event.lat))

def trace_end():
	print "In trace_end:\n"
        # We show the basic info for the 2 type of event classes
        show_general_events()
        show_pebs_ll()
        con.close()

#
# As the event number may be very big, so we can't use linear way
# to show the histogram in real number, but use a log2 algorithm.
#

def num2sym(num):
        # Each number will have at least one '#'
        snum = '#' * (int)(math.log(num, 2) + 1)
        return snum

def show_general_events():

        # Check the total record number in the table
        count = con.execute("select count(*) from gen_events")
        for t in count:
                print "There is %d records in gen_events table" % t[0]
                if t[0] == 0:
                        return

        print "Statistics about the general events grouped by thread/symbol/dso: \n"

         # Group by thread
        commq = con.execute("select comm, count(comm) from gen_events group by comm order by -count(comm)")
        print "\n%16s %8s %16s\n%s" % ("comm", "number", "histogram", "="*42)
        for row in commq:
             print "%16s %8d     %s" % (row[0], row[1], num2sym(row[1]))

        # Group by symbol
        print "\n%32s %8s %16s\n%s" % ("symbol", "number", "histogram", "="*58)
        symbolq = con.execute("select symbol, count(symbol) from gen_events group by symbol order by -count(symbol)")
        for row in symbolq:
             print "%32s %8d     %s" % (row[0], row[1], num2sym(row[1]))

        # Group by dso
        print "\n%40s %8s %16s\n%s" % ("dso", "number", "histogram", "="*74)
        dsoq = con.execute("select dso, count(dso) from gen_events group by dso order by -count(dso)")
        for row in dsoq:
             print "%40s %8d     %s" % (row[0], row[1], num2sym(row[1]))

#
# This function just shows the basic info, and we could do more with the
# data in the tables, like checking the function parameters when some
# big latency events happen.
#
def show_pebs_ll():

        count = con.execute("select count(*) from pebs_ll")
        for t in count:
                print "There is %d records in pebs_ll table" % t[0]
                if t[0] == 0:
                        return

        print "Statistics about the PEBS Load Latency events grouped by thread/symbol/dse/latency: \n"

        # Group by thread
        commq = con.execute("select comm, count(comm) from pebs_ll group by comm order by -count(comm)")
        print "\n%16s %8s %16s\n%s" % ("comm", "number", "histogram", "="*42)
        for row in commq:
             print "%16s %8d     %s" % (row[0], row[1], num2sym(row[1]))

        # Group by symbol
        print "\n%32s %8s %16s\n%s" % ("symbol", "number", "histogram", "="*58)
        symbolq = con.execute("select symbol, count(symbol) from pebs_ll group by symbol order by -count(symbol)")
        for row in symbolq:
             print "%32s %8d     %s" % (row[0], row[1], num2sym(row[1]))

        # Group by dse
        dseq = con.execute("select dse, count(dse) from pebs_ll group by dse order by -count(dse)")
        print "\n%32s %8s %16s\n%s" % ("dse", "number", "histogram", "="*58)
        for row in dseq:
             print "%32s %8d     %s" % (row[0], row[1], num2sym(row[1]))

        # Group by latency
        latq = con.execute("select lat, count(lat) from pebs_ll group by lat order by lat")
        print "\n%32s %8s %16s\n%s" % ("latency", "number", "histogram", "="*58)
        for row in latq:
             print "%32s %8d     %s" % (row[0], row[1], num2sym(row[1]))

def trace_unhandled(event_name, context, event_fields_dict):
		print ' '.join(['%s=%s'%(k,str(v))for k,v in sorted(event_fields_dict.items())])
lass='sha1'>c5cc2070b453
49a2f1e3f231
77216b048481

49a2f1e3f231
c5cc2070b453

49a2f1e3f231
77216b048481
69df0ab030c9






49a2f1e3f231

3c798398e393
a29a171e7c46
0381411e4b1a
77216b048481
9138125beabb
ff26eaadf4d9
c5cc2070b453
cd1604fab4f9
9138125beabb
aa6ec29bee86
9138125beabb




aa6ec29bee86
9138125beabb






aa6ec29bee86
9138125beabb



c5cc2070b453




a29a171e7c46
77216b048481
a29a171e7c46
e56da7e28796



8a3d26151f24





ff26eaadf4d9
8a3d26151f24
3b07e9ca2686
ff26eaadf4d9
8a3d26151f24

693e751e7084























3c798398e393
8a3d26151f24

ff26eaadf4d9
8a3d26151f24
ff26eaadf4d9
8a3d26151f24
ff26eaadf4d9
8a3d26151f24

69df0ab030c9

8a3d26151f24

3c798398e393
8a3d26151f24












a29a171e7c46

3c798398e393

e43473b7f223
e43473b7f223
3c798398e393

cd1604fab4f9
3c798398e393
03d8e11142a8
e43473b7f223
e8989fae38d9
e43473b7f223

cd1604fab4f9
3c798398e393
e43473b7f223
f469a7b4d5b1
cd1604fab4f9
bc16a4f933bc
f469a7b4d5b1
3c798398e393

f469a7b4d5b1
3c798398e393
03d8e11142a8
cd1604fab4f9
3c798398e393
f469a7b4d5b1
3c96cb32d318
f469a7b4d5b1
cd1604fab4f9

0381411e4b1a
3f3299d5c026
03d8e11142a8
f469a7b4d5b1

e43473b7f223


0049af73bb4b

e43473b7f223

0049af73bb4b
e43473b7f223

0049af73bb4b

e43473b7f223
0049af73bb4b

e43473b7f223









0049af73bb4b

e43473b7f223
0049af73bb4b



e43473b7f223

0049af73bb4b
e43473b7f223


0049af73bb4b
e43473b7f223


0049af73bb4b
e43473b7f223

77216b048481
e43473b7f223
77216b048481
0049af73bb4b
e43473b7f223

















0049af73bb4b
e43473b7f223

0049af73bb4b
e43473b7f223

77216b048481
e43473b7f223
77216b048481
5b2c16aae0c0
77216b048481
e43473b7f223

77216b048481
e43473b7f223
5b2c16aae0c0
77216b048481
e43473b7f223

77216b048481
e43473b7f223
77216b048481
5b2c16aae0c0
e43473b7f223

77216b048481
e43473b7f223
5b2c16aae0c0
77216b048481
e43473b7f223

a9131a27e2a3
69df0ab030c9

a9131a27e2a3
69df0ab030c9


a9131a27e2a3

7f52f98c2a83



















e43473b7f223
6a525600ffeb
c9e0332e877c
7f52f98c2a83
e43473b7f223
c9e0332e877c
e43473b7f223
69df0ab030c9
7f52f98c2a83
69df0ab030c9
7f52f98c2a83
69df0ab030c9

7f52f98c2a83

e43473b7f223

32ee5bc4787d





















0f3457f60edc
e43473b7f223

8e89d13f4ede
e43473b7f223

fda6f272c77a



e43473b7f223

0f3457f60edc

d1ae8ffdfaa1



0f3457f60edc

e43473b7f223

fda6f272c77a



e43473b7f223


0f3457f60edc
e43473b7f223

5cf8c2277576
e43473b7f223




0f3457f60edc
e43473b7f223
3aad5d3ee4e4

e43473b7f223







0f3457f60edc
e43473b7f223

d1ae8ffdfaa1







0f3457f60edc
d1ae8ffdfaa1
e43473b7f223





3aad5d3ee4e4


e43473b7f223
8e89d13f4ede
e43473b7f223
8e89d13f4ede
e43473b7f223






8e89d13f4ede




e43473b7f223

fda6f272c77a



e43473b7f223

0f3457f60edc

e43473b7f223

8e89d13f4ede
e43473b7f223
c49c06e49609
e43473b7f223
8e89d13f4ede
e43473b7f223
8e89d13f4ede





c49c06e49609













8e89d13f4ede

e43473b7f223

5cf8c2277576
e43473b7f223

8e89d13f4ede












0f3457f60edc

8e89d13f4ede

3aad5d3ee4e4
8e89d13f4ede
e43473b7f223








5e901a2b95db

3aad5d3ee4e4
e43473b7f223
4f024f3797c4
e43473b7f223

5cf8c2277576
e43473b7f223


4f024f3797c4
e43473b7f223









e43473b7f223

8e89d13f4ede






0f3457f60edc

8e89d13f4ede









73f0d49a9637
c5cc2070b453
e43473b7f223
8e89d13f4ede



5cf8c2277576
8e89d13f4ede






0f3457f60edc

8e89d13f4ede

0f3457f60edc
8e89d13f4ede

0f3457f60edc

8e89d13f4ede










0f3457f60edc
e43473b7f223



3c798398e393
629ed0b10209

8a3d26151f24

629ed0b10209


8a3d26151f24
629ed0b10209








8a3d26151f24
629ed0b10209
629ed0b10209





e43473b7f223


e43473b7f223

4f024f3797c4
8e89d13f4ede
e43473b7f223
2a0f61e6ecd0












4f024f3797c4

2a0f61e6ecd0
e43473b7f223

c5cc2070b453










e43473b7f223
73f0d49a9637
e43473b7f223

c5cc2070b453


0e9f4164ba91








c5cc2070b453

73f0d49a9637
77216b048481
e43473b7f223

77216b048481
e43473b7f223
73f0d49a9637
e43473b7f223


c5cc2070b453
0f3457f60edc
e43473b7f223
c5cc2070b453
0f3457f60edc
e43473b7f223



e43473b7f223
77216b048481
e43473b7f223
77216b048481
0e9f4164ba91


e43473b7f223

32ee5bc4787d









77216b048481
e43473b7f223
73f0d49a9637
6bc9c2b464fb

c5cc2070b453
e43473b7f223

c5cc2070b453






73f0d49a9637
e43473b7f223

6bc9c2b464fb








c5cc2070b453
32ee5bc4787d
6bc9c2b464fb
c5cc2070b453

6bc9c2b464fb


e43473b7f223
0f3457f60edc
6bc9c2b464fb
c5cc2070b453

e43473b7f223

77216b048481
e43473b7f223
73f0d49a9637
e43473b7f223

c2f6805d470a
e43473b7f223



c5cc2070b453
0f3457f60edc
e43473b7f223
77216b048481
e43473b7f223





c5cc2070b453
0f3457f60edc
e43473b7f223
77216b048481
e43473b7f223








651930bc1c2a
e43473b7f223

e43473b7f223

73f0d49a9637

e43473b7f223






77216b048481
e43473b7f223
77216b048481
e43473b7f223
73f0d49a9637
77216b048481
e43473b7f223







6e1a5704cbbd






2e48a530a3a7






6e1a5704cbbd
69df0ab030c9


2e48a530a3a7
69df0ab030c9
cb76199c36a7
2e48a530a3a7

6e1a5704cbbd
e43473b7f223

2e48a530a3a7


e43473b7f223
7f52f98c2a83

2e48a530a3a7

7f52f98c2a83


7f52f98c2a83


e43473b7f223
7f52f98c2a83

e43473b7f223
7f52f98c2a83



651930bc1c2a
e43473b7f223
2e48a530a3a7

6e1a5704cbbd
2e48a530a3a7















e43473b7f223
6e1a5704cbbd
e43473b7f223
6e1a5704cbbd







8876e140ec7b
6e1a5704cbbd












c5cc2070b453


6e1a5704cbbd


69d60eb96ae8
e43473b7f223

69d60eb96ae8
e43473b7f223
e43473b7f223

f95a04afa80c

41b38b6d540f
f95a04afa80c
41b38b6d540f


045c47ca306a


41b38b6d540f
8a3d26151f24
41b38b6d540f





f95a04afa80c
41b38b6d540f

2da8ca822d49
41b38b6d540f
2da8ca822d49

41b38b6d540f


f95a04afa80c

60c2bc2d5a12
f95a04afa80c

60c2bc2d5a12
af133ceb2610
60c2bc2d5a12
f95a04afa80c
60c2bc2d5a12

f95a04afa80c

e43473b7f223
f95a04afa80c

fe0714377ee2
af133ceb2610

f95a04afa80c
e43473b7f223

2da8ca822d49
8e89d13f4ede
2da8ca822d49

af133ceb2610
8e89d13f4ede

2da8ca822d49
8e89d13f4ede
2da8ca822d49

af133ceb2610
60c2bc2d5a12

451af504df0c

60c2bc2d5a12
451af504df0c
60c2bc2d5a12
af133ceb2610
69df0ab030c9
693e751e7084
492eb21b98f8
60c2bc2d5a12

3c798398e393
60c2bc2d5a12


af133ceb2610
69df0ab030c9
af133ceb2610
a2b1693bac45

af133ceb2610
a2b1693bac45
451af504df0c
a2b1693bac45
451af504df0c
af133ceb2610
fda6f272c77a



632b44935f4c

693e751e7084





492eb21b98f8
693e751e7084


632b44935f4c






0f3457f60edc

632b44935f4c
5b2c16aae0c0
77216b048481
7f52f98c2a83
632b44935f4c
60c2bc2d5a12

451af504df0c
8e89d13f4ede

451af504df0c

60c2bc2d5a12
451af504df0c
60c2bc2d5a12

451af504df0c

60c2bc2d5a12
451af504df0c
60c2bc2d5a12




af133ceb2610
2da8ca822d49
451af504df0c
60c2bc2d5a12


af133ceb2610
2da8ca822d49
451af504df0c
60c2bc2d5a12


af133ceb2610
2da8ca822d49
451af504df0c
60c2bc2d5a12


af133ceb2610
2da8ca822d49
451af504df0c
60c2bc2d5a12


5bc4afb1ec6a
2da8ca822d49
60c2bc2d5a12


5bc4afb1ec6a
2da8ca822d49
60c2bc2d5a12



da527770007f
e43473b7f223


69df0ab030c9
e43473b7f223

3c798398e393
f9fcc2d3919b



693e751e7084
f9fcc2d3919b

e43473b7f223

bc16a4f933bc
e43473b7f223

c5cc2070b453
e43473b7f223
73f0d49a9637
0e9f4164ba91
3c798398e393
bc16a4f933bc
e43473b7f223
2a0f61e6ecd0

bc16a4f933bc
e43473b7f223
af75cd3c6784




af75cd3c6784
3c798398e393
cd1604fab4f9
af75cd3c6784
693e751e7084
629ed0b10209
4f024f3797c4
2a7f124414b3
af75cd3c6784

af75cd3c6784




e43473b7f223
cd1604fab4f9
bc16a4f933bc

f469a7b4d5b1
73f0d49a9637

9e660acffcd1



de701c74a340
9e660acffcd1




e43473b7f223
04521db04e9a











0f3457f60edc
9e660acffcd1





c5cc2070b453
9e660acffcd1



e43473b7f223

9e660acffcd1
fda6f272c77a

4f024f3797c4
fda6f272c77a

e43473b7f223
671058fb2a2a
6bc9c2b464fb
c5cc2070b453
bc16a4f933bc
e43473b7f223
7f52f98c2a83





0e9f4164ba91
77216b048481
7f52f98c2a83
e43473b7f223

bc16a4f933bc
e43473b7f223
2a7f124414b3

bc16a4f933bc
2a0f61e6ecd0






bc16a4f933bc
e43473b7f223

2a12f0dcdad1














c5cc2070b453
2a12f0dcdad1
c5cc2070b453
2a12f0dcdad1



c9a929dde391









2a12f0dcdad1
492eb21b98f8
c9a929dde391
651930bc1c2a
c9a929dde391
8bcb6c7d48eb
2a12f0dcdad1
c9a929dde391
2a12f0dcdad1





492eb21b98f8
2a12f0dcdad1
73f0d49a9637
2a12f0dcdad1



c9a929dde391

2a12f0dcdad1
651930bc1c2a
c5cc2070b453

651930bc1c2a
c9a929dde391



e43473b7f223


a2b1693bac45
e43473b7f223




69df0ab030c9
77216b048481
e43473b7f223
cd1604fab4f9
29b125892f33
02977e4af7ed
a2b1693bac45
3c798398e393
a2b1693bac45
f51b802c17e2
a2b1693bac45
e43473b7f223



c875f4d0250a
da527770007f
3c798398e393
c9a929dde391
e43473b7f223



450adcbe518a



3c798398e393
e43473b7f223


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699










                                                            
                             
                









                                                                              
                                               
 

                                                   
 




























                                                                              
                             

                                                                              



                                                                        
                                                                               





                                                                           



                                                                                      
                                                                                     

  

                                                                              
                                                                                  

  

                                                                            







                                                      
                   


                                      
                                                      

                               


                                               


                                                  
          










                                                                           





                                                                           

                           


                                                                   


                                          


                             

                                                         

                                                         



                                           
 




                                                                          



                  
                                                   
                                                  
 





                                                                 
                                             



                                                 
                                         

  






                                                                    

                                                       




                                                                      
                                                                  
 
                                                                

 
                                                                
 
                                   

 




                                                                   


















































                                                                           
                                                                         




                                                                                   
           
 





                                                        

                                                                       
                                                                     









                                                                              

                        


                                                                          
                                                                           

                               

                                                                   

















                                                                              


















































































                                                                                      
                                                        

                                                                             
 

                                       
                                   
                                  






                                                                      

 
                                                 
 
                                                 
                                             
                                               
                            
               
 
          
                                                                          




                                                                          
                                                                     






                                                                       
                                                                   



                                                                     




                                                                
                                    
                    
 



                             





                                                                          
                                                       
                                                              
                                                       
                                                            

 























                                                                              
                                                 

                                                 
                            
 
                                                       
                                             
                                                            

                                   

                                                      

 
                                                        












                                                                          

 

                                                                  
 
          

                                                                          
           
                                 
                                      
 
                                                         

 
                                                                         
                                                                      
 
                                            
                                     
 
          

                                                                          
           
                                   
                                    
                
                                      
 
                                                    
 

                                                                    
                                              
                                             
                                            

         


                  

                                                       

                                   
                                   

                            

                                                                              
 

                                                             









                                                                  

                                                                   
 



                                                   

 
                                                                            


                              
                                        


                       
                                                         

 
                                                       
 
                                                                             
                                                                 

















                                                     
                                                        

                                                 
                                                                

 
                                                      
 
                                 
                                       
                                                  

 
                                                    
 
                                             
                                        

 
                                                      
 
                                                                   
                                        

 
                                                    
 
                                          
                                        

 
                               

                                                                          
 


                                                               

 



















                                                                           
 
                                        
                            
                            
 
                                     
 
                                                      
                                                                       
                                                                              
                            

         

                                                     

 





















                                                                              
                                                                         

                               
                            

                                                   



                                                                  

 

                                                                       



                                                             

                                                                      

                                                             



                                                                     


                                                                            
                                                             

                                                                           
                             




                                                             
                                                                    
 

                                                       







                                                                       
                                      

                       







                                                                            
                                                             
 





                                                     


                                                     
 
                                                               
 
                                    






                                                 




                                           

                                                        



                                                                                            

 

                                                                         

                                    
                                
                                                                   
                
 
                                                                          
 





                                                                     













                                                                             

                                                

                                  
                            

         












                                                                   

                                                                        

                                    
                                            
                                                                   








                                                                          

                                              
                            
 
                                                                         

                                  
                            


                                          
                                                                                









                                                                           

                                   






                                                                              

                                                                   









                                                                      
                                                 
                                                                         
 



                                                      
                            






                                                                            

                                               

                                                                           
                                                                            

         

                                                         










                                                               
                                                                



                 
                                                                          

                                                

                                                 


                                                                              
                                  








                                                                       
                                                
 





                                                              


                                                                     

                                         
                                                   
                          
 












                                                                           

                                                                               
         

 










                                                                       
 
                                                             

                                    


                                            








                                                                       

                                                       
                            
                              

 
                                                     
 
                                                             


                                                                               
                                                          
                                                     
 
                                                           
                                                      



                                              
                                  
                              
                                
                              


                                          

 









                                                                              
                                                               
 
                                                             

                                                               
                                            

                        






                                                                           
                            

                                   








                                                                         
                                                                            
                                                                  
                

                                                                   


                                                   
 
                                  
 

                                                

 
                                                    
 
                                                             

                                                           
                                                                       



                                                      
                                                               
                                                
 
                                                           





                                             
                                                                
                                                
 
                                                           








                                               
                                                                         

                                 

                   

                                                                     






                                                       
                                      
 
                                                  
 
                                                         
                                               







                                              






                                                                            






                                                                          
   


                                                      
                                             
                                              
                                            

                                               
                

                                     


                                  
 

                                                                        

                                                                      


                                                 


                                                            
 

                                                             
 



                                                                           
         
 

                                
 















                                                                                
                                       
 
 







                                                                             
                                                                 












                                                                       


                                                                           


                                                  
                                      

                                                               
                                       
         

 

                                                                     
 
                                             


                                             


                                  
                                    
                                                                          





                                                         
                                                     

 
                                                            
 

                                                                              


                 

                                                                               
 

                                             
 
                    
                         
                                            

 

                                                                                
 

                                                             
 

                         
                                            

 
                                                          
 

                                                                             
                 

 
                                                           
 

                                                                             
                 

 

                                                                             
 
                                                       
                                 
                              
                                        
                              
                                            

                
                                                                     


                           
                                  
                                
 

                           
 
                   
                                                                   
            
                                                                            
 



                                                                        

          





                                                                          
                                                             


                                                      






                                                                         

                                      
 
                                            
                                       
                                                                   
         

                               
                      

 

                                                                    
 
                                                       

 

                                                                     
 
                                                        




                                                   
                                                                  
                                              
                                         


                                                    
                                                                   
                                              
                                         


                                                    
                                                                   
                                               
                                          


                                                     
                                                                    
                                               
                                          


                                                    
                                                                        
                                                


                                               
                                                                   
                                                



                               
                                                       


                                       
                                             

 
                                                  



                                                            
                                                   

                                                        

  
                                                             

                                       
                                       
                              
                                        
                                    
                            
                               
 

                                       
                         
 




                                                                         
                        
                               
                                         
                 
                                         
                                                                    
                                                                          
                                            

                 




                                                                            
                                     
                                                

                                
 

                                



                                                                               
 




                                                                       
                                           











                                                                             
                                          





                                                                          
                                              



                                        

         
                                        

                                                                                            
                                                                         

                                                              
 
                                   
                                
                                       
                         
 





                                                                           
                                              
                                       
                                                                                 

         
           
                                       

                          
    






                                                                         
                         

 














                                                                           
                                                                     
                                                                   
                                                                      



                                                                   









                                                                           
                              
                                            
                        
               
 
                                     
                        
 





                                                                         
                                                                          
                                                                
 



                                                                    

                                       
                                                                     
                                          

                                                                              
                                                  



                                     


                                            
                




                                                            
                                                                   
                                                            
 
                   
                      
 
                             
                                                             
                
                          
                   



                                             
                       
                              
                                                         
                     



                                   



                                                                            
                                                           


                         
/*
 * Interface for controlling IO bandwidth on a request queue
 *
 * Copyright (C) 2010 Vivek Goyal <vgoyal@redhat.com>
 */

#include <linux/module.h>
#include <linux/slab.h>
#include <linux/blkdev.h>
#include <linux/bio.h>
#include <linux/blktrace_api.h>
#include <linux/blk-cgroup.h>
#include "blk.h"

/* Max dispatch from a group in 1 round */
static int throtl_grp_quantum = 8;

/* Total max dispatch from all groups in one round */
static int throtl_quantum = 32;

/* Throttling is performed over 100ms slice and after that slice is renewed */
static unsigned long throtl_slice = HZ/10;	/* 100 ms */

static struct blkcg_policy blkcg_policy_throtl;

/* A workqueue to queue throttle related work */
static struct workqueue_struct *kthrotld_workqueue;

/*
 * To implement hierarchical throttling, throtl_grps form a tree and bios
 * are dispatched upwards level by level until they reach the top and get
 * issued.  When dispatching bios from the children and local group at each
 * level, if the bios are dispatched into a single bio_list, there's a risk
 * of a local or child group which can queue many bios at once filling up
 * the list starving others.
 *
 * To avoid such starvation, dispatched bios are queued separately
 * according to where they came from.  When they are again dispatched to
 * the parent, they're popped in round-robin order so that no single source
 * hogs the dispatch window.
 *
 * throtl_qnode is used to keep the queued bios separated by their sources.
 * Bios are queued to throtl_qnode which in turn is queued to
 * throtl_service_queue and then dispatched in round-robin order.
 *
 * It's also used to track the reference counts on blkg's.  A qnode always
 * belongs to a throtl_grp and gets queued on itself or the parent, so
 * incrementing the reference of the associated throtl_grp when a qnode is
 * queued and decrementing when dequeued is enough to keep the whole blkg
 * tree pinned while bios are in flight.
 */
struct throtl_qnode {
	struct list_head	node;		/* service_queue->queued[] */
	struct bio_list		bios;		/* queued bios */
	struct throtl_grp	*tg;		/* tg this qnode belongs to */
};

struct throtl_service_queue {
	struct throtl_service_queue *parent_sq;	/* the parent service_queue */

	/*
	 * Bios queued directly to this service_queue or dispatched from
	 * children throtl_grp's.
	 */
	struct list_head	queued[2];	/* throtl_qnode [READ/WRITE] */
	unsigned int		nr_queued[2];	/* number of queued bios */

	/*
	 * RB tree of active children throtl_grp's, which are sorted by
	 * their ->disptime.
	 */
	struct rb_root		pending_tree;	/* RB tree of active tgs */
	struct rb_node		*first_pending;	/* first node in the tree */
	unsigned int		nr_pending;	/* # queued in the tree */
	unsigned long		first_pending_disptime;	/* disptime of the first tg */
	struct timer_list	pending_timer;	/* fires on first_pending_disptime */
};

enum tg_state_flags {
	THROTL_TG_PENDING	= 1 << 0,	/* on parent's pending tree */
	THROTL_TG_WAS_EMPTY	= 1 << 1,	/* bio_lists[] became non-empty */
};

#define rb_entry_tg(node)	rb_entry((node), struct throtl_grp, rb_node)

/* Per-cpu group stats */
struct tg_stats_cpu {
	/* total bytes transferred */
	struct blkg_rwstat		service_bytes;
	/* total IOs serviced, post merge */
	struct blkg_rwstat		serviced;
};

struct throtl_grp {
	/* must be the first member */
	struct blkg_policy_data pd;

	/* active throtl group service_queue member */
	struct rb_node rb_node;

	/* throtl_data this group belongs to */
	struct throtl_data *td;

	/* this group's service queue */
	struct throtl_service_queue service_queue;

	/*
	 * qnode_on_self is used when bios are directly queued to this
	 * throtl_grp so that local bios compete fairly with bios
	 * dispatched from children.  qnode_on_parent is used when bios are
	 * dispatched from this throtl_grp into its parent and will compete
	 * with the sibling qnode_on_parents and the parent's
	 * qnode_on_self.
	 */
	struct throtl_qnode qnode_on_self[2];
	struct throtl_qnode qnode_on_parent[2];

	/*
	 * Dispatch time in jiffies. This is the estimated time when group
	 * will unthrottle and is ready to dispatch more bio. It is used as
	 * key to sort active groups in service tree.
	 */
	unsigned long disptime;

	unsigned int flags;

	/* are there any throtl rules between this group and td? */
	bool has_rules[2];

	/* bytes per second rate limits */
	uint64_t bps[2];

	/* IOPS limits */
	unsigned int iops[2];

	/* Number of bytes disptached in current slice */
	uint64_t bytes_disp[2];
	/* Number of bio's dispatched in current slice */
	unsigned int io_disp[2];

	/* When did we start a new slice */
	unsigned long slice_start[2];
	unsigned long slice_end[2];

	/* Per cpu stats pointer */
	struct tg_stats_cpu __percpu *stats_cpu;

	/* List of tgs waiting for per cpu stats memory to be allocated */
	struct list_head stats_alloc_node;
};

struct throtl_data
{
	/* service tree for active throtl groups */
	struct throtl_service_queue service_queue;

	struct request_queue *queue;

	/* Total Number of queued bios on READ and WRITE lists */
	unsigned int nr_queued[2];

	/*
	 * number of total undestroyed groups
	 */
	unsigned int nr_undestroyed_grps;

	/* Work for dispatching throttled bios */
	struct work_struct dispatch_work;
};

/* list and work item to allocate percpu group stats */
static DEFINE_SPINLOCK(tg_stats_alloc_lock);
static LIST_HEAD(tg_stats_alloc_list);

static void tg_stats_alloc_fn(struct work_struct *);
static DECLARE_DELAYED_WORK(tg_stats_alloc_work, tg_stats_alloc_fn);

static void throtl_pending_timer_fn(unsigned long arg);

static inline struct throtl_grp *pd_to_tg(struct blkg_policy_data *pd)
{
	return pd ? container_of(pd, struct throtl_grp, pd) : NULL;
}

static inline struct throtl_grp *blkg_to_tg(struct blkcg_gq *blkg)
{
	return pd_to_tg(blkg_to_pd(blkg, &blkcg_policy_throtl));
}

static inline struct blkcg_gq *tg_to_blkg(struct throtl_grp *tg)
{
	return pd_to_blkg(&tg->pd);
}

static inline struct throtl_grp *td_root_tg(struct throtl_data *td)
{
	return blkg_to_tg(td->queue->root_blkg);
}

/**
 * sq_to_tg - return the throl_grp the specified service queue belongs to
 * @sq: the throtl_service_queue of interest
 *
 * Return the throtl_grp @sq belongs to.  If @sq is the top-level one
 * embedded in throtl_data, %NULL is returned.
 */
static struct throtl_grp *sq_to_tg(struct throtl_service_queue *sq)
{
	if (sq && sq->parent_sq)
		return container_of(sq, struct throtl_grp, service_queue);
	else
		return NULL;
}

/**
 * sq_to_td - return throtl_data the specified service queue belongs to
 * @sq: the throtl_service_queue of interest
 *
 * A service_queue can be embeded in either a throtl_grp or throtl_data.
 * Determine the associated throtl_data accordingly and return it.
 */
static struct throtl_data *sq_to_td(struct throtl_service_queue *sq)
{
	struct throtl_grp *tg = sq_to_tg(sq);

	if (tg)
		return tg->td;
	else
		return container_of(sq, struct throtl_data, service_queue);
}

/**
 * throtl_log - log debug message via blktrace
 * @sq: the service_queue being reported
 * @fmt: printf format string
 * @args: printf args
 *
 * The messages are prefixed with "throtl BLKG_NAME" if @sq belongs to a
 * throtl_grp; otherwise, just "throtl".
 *
 * TODO: this should be made a function and name formatting should happen
 * after testing whether blktrace is enabled.
 */
#define throtl_log(sq, fmt, args...)	do {				\
	struct throtl_grp *__tg = sq_to_tg((sq));			\
	struct throtl_data *__td = sq_to_td((sq));			\
									\
	(void)__td;							\
	if ((__tg)) {							\
		char __pbuf[128];					\
									\
		blkg_path(tg_to_blkg(__tg), __pbuf, sizeof(__pbuf));	\
		blk_add_trace_msg(__td->queue, "throtl %s " fmt, __pbuf, ##args); \
	} else {							\
		blk_add_trace_msg(__td->queue, "throtl " fmt, ##args);	\
	}								\
} while (0)

static void tg_stats_init(struct tg_stats_cpu *tg_stats)
{
	blkg_rwstat_init(&tg_stats->service_bytes);
	blkg_rwstat_init(&tg_stats->serviced);
}

/*
 * Worker for allocating per cpu stat for tgs. This is scheduled on the
 * system_wq once there are some groups on the alloc_list waiting for
 * allocation.
 */
static void tg_stats_alloc_fn(struct work_struct *work)
{
	static struct tg_stats_cpu *stats_cpu;	/* this fn is non-reentrant */
	struct delayed_work *dwork = to_delayed_work(work);
	bool empty = false;

alloc_stats:
	if (!stats_cpu) {
		int cpu;

		stats_cpu = alloc_percpu(struct tg_stats_cpu);
		if (!stats_cpu) {
			/* allocation failed, try again after some time */
			schedule_delayed_work(dwork, msecs_to_jiffies(10));
			return;
		}
		for_each_possible_cpu(cpu)
			tg_stats_init(per_cpu_ptr(stats_cpu, cpu));
	}

	spin_lock_irq(&tg_stats_alloc_lock);

	if (!list_empty(&tg_stats_alloc_list)) {
		struct throtl_grp *tg = list_first_entry(&tg_stats_alloc_list,
							 struct throtl_grp,
							 stats_alloc_node);
		swap(tg->stats_cpu, stats_cpu);
		list_del_init(&tg->stats_alloc_node);
	}

	empty = list_empty(&tg_stats_alloc_list);
	spin_unlock_irq(&tg_stats_alloc_lock);
	if (!empty)
		goto alloc_stats;
}

static void throtl_qnode_init(struct throtl_qnode *qn, struct throtl_grp *tg)
{
	INIT_LIST_HEAD(&qn->node);
	bio_list_init(&qn->bios);
	qn->tg = tg;
}

/**
 * throtl_qnode_add_bio - add a bio to a throtl_qnode and activate it
 * @bio: bio being added
 * @qn: qnode to add bio to
 * @queued: the service_queue->queued[] list @qn belongs to
 *
 * Add @bio to @qn and put @qn on @queued if it's not already on.
 * @qn->tg's reference count is bumped when @qn is activated.  See the
 * comment on top of throtl_qnode definition for details.
 */
static void throtl_qnode_add_bio(struct bio *bio, struct throtl_qnode *qn,
				 struct list_head *queued)
{
	bio_list_add(&qn->bios, bio);
	if (list_empty(&qn->node)) {
		list_add_tail(&qn->node, queued);
		blkg_get(tg_to_blkg(qn->tg));
	}
}

/**
 * throtl_peek_queued - peek the first bio on a qnode list
 * @queued: the qnode list to peek
 */
static struct bio *throtl_peek_queued(struct list_head *queued)
{
	struct throtl_qnode *qn = list_first_entry(queued, struct throtl_qnode, node);
	struct bio *bio;

	if (list_empty(queued))
		return NULL;

	bio = bio_list_peek(&qn->bios);
	WARN_ON_ONCE(!bio);
	return bio;
}

/**
 * throtl_pop_queued - pop the first bio form a qnode list
 * @queued: the qnode list to pop a bio from
 * @tg_to_put: optional out argument for throtl_grp to put
 *
 * Pop the first bio from the qnode list @queued.  After popping, the first
 * qnode is removed from @queued if empty or moved to the end of @queued so
 * that the popping order is round-robin.
 *
 * When the first qnode is removed, its associated throtl_grp should be put
 * too.  If @tg_to_put is NULL, this function automatically puts it;
 * otherwise, *@tg_to_put is set to the throtl_grp to put and the caller is
 * responsible for putting it.
 */
static struct bio *throtl_pop_queued(struct list_head *queued,
				     struct throtl_grp **tg_to_put)
{
	struct throtl_qnode *qn = list_first_entry(queued, struct throtl_qnode, node);
	struct bio *bio;

	if (list_empty(queued))
		return NULL;