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
|
# Copyright 2013, 2017 David Malcolm <dmalcolm@redhat.com>
# Copyright 2013, 2017 Red Hat, Inc.
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
# USA
# Parser for the .plist files emitted by the clang-static-analyzer,
# when "-plist" is passed as an option to "scan-build" or "clang"
# Originally developed against output from clang-3.0-14.fc17;
# updated against output from clang-3.4-12.fc20.x86_64
import glob
import os
import plistlib
from pprint import pprint
import sys
from firehose.model import Message, Function, Point, Range, \
File, Location, Generator, Metadata, Analysis, Issue, Sut, Trace, \
State, Notes, CustomFields
def parse_scandir(resultdir, analyzerversion=None, sut=None):
"""
Given a path to a directory of scan-build output, parse it and
yield Analysis instances
"""
for filename in glob.glob(os.path.join(resultdir, 'report-*.plist')):
yield parse_plist(filename, analyzerversion, sut)
def parse_plist(file_path, analyzerversion=None, sut=None, file_=None, stats=None):
"""
Given a .plist file emitted by clang-static-analyzer (e.g. via
scan-build), parse it and return an Analysis instance
"""
with open(file_path, 'rb') as f:
plist = plistlib.load(f)
# We now have the .plist file as a hierarchy of dicts, lists, etc
# Handy debug dump:
if 0:
pprint(plist)
# A list of filenames, apparently referenced by index within
# diagnostics:
files = plist['files']
generator = Generator(name='clang-analyzer',
version=analyzerversion)
metadata = Metadata(generator, sut, file_, stats)
analysis = Analysis(metadata, [])
if 'clang_version' in plist:
generator.version = plist['clang_version']
for diagnostic in plist['diagnostics']:
if 0:
pprint(diagnostic)
cwe = None
customfields = CustomFields()
for key in ['category', 'issue_context', 'issue_context_kind']:
if key in diagnostic:
customfields[key] = diagnostic[key]
message = Message(text=diagnostic['description'])
loc = diagnostic['location']
location = Location(file=File(givenpath=files[loc['file']],
abspath=None),
# FIXME: doesn't tell us function name
# TODO: can we patch this upstream?
function=None,
point=Point(int(loc['line']),
int(loc['col'])))
notes = None
trace = make_trace(files, diagnostic['path'])
issue = Issue(cwe,
# Use the 'type' field for the testid:
diagnostic['type'],
location, message, notes, trace,
customfields=customfields)
analysis.results.append(issue)
return analysis
def make_point_from_plist_point(loc):
# point:
# e.g. {'col': 2, 'file': 0, 'line': 130}
return Point(int(loc['line']),
int(loc['col']))
def make_location_from_point(files, loc):
# loc:
# e.g. {'col': 2, 'file': 0, 'line': 130}
location = Location(file=File(givenpath=files[loc['file']],
abspath=None),
# FIXME: doesn't tell us function name
# TODO: can we patch this upstream?
function=Function(''),
point=make_point_from_plist_point(loc))
return location
def make_location_from_range(files, range_):
# range_:
# e.g.:
# [{'col': 18, 'file': 0, 'line': 165},
# {'col': 21, 'file': 0, 'line': 165}]
assert len(range_) == 2
start = range_[0]
end = range_[1]
assert start['file'] == end['file']
if start == end:
point = make_point_from_plist_point(start)
range_ = None
else:
point = None
range_ = Range(start=make_point_from_plist_point(start),
end=make_point_from_plist_point(end))
location = Location(file=File(givenpath=files[start['file']],
abspath=None),
# FIXME: doesn't tell us function name
# TODO: can we patch this upstream?
function=Function(''),
point=point,
range_=range_)
return location
def make_trace(files, path):
"""
Construct a Trace instance from the .plist's 'path' list
"""
trace = Trace([])
lastlocation = None
for node in path:
if 0:
pprint(node)
kind = node['kind']
if kind == 'event':
# e.g.:
# {'extended_message': "Value stored to 'ret' is never read",
# 'kind': 'event',
# 'location': {'col': 2, 'file': 0, 'line': 130},
# 'message': "Value stored to 'ret' is never read",
# 'ranges': [[{'col': 8, 'file': 0, 'line': 130},
# {'col': 29, 'file': 0, 'line': 130}]]}
# TODO: we're not yet handling the following:
# node['extended_message']
# node['ranges']
loc = node['location']
location = make_location_from_point(files, loc)
notes = Notes(node['message'])
trace.add_state(State(location, notes))
lastlocation = location
elif kind == 'control':
# e.g.:
# {'edges': [{'end': [{'col': 9, 'file': 0, 'line': 161},
# {'col': 9, 'file': 0, 'line': 161}],
# 'start': [{'col': 2, 'file': 0, 'line': 161},
# {'col': 2, 'file': 0, 'line': 161}]}],
# 'kind': 'control'}
edges = node['edges']
for edge in edges:
edge_start = edge['start']
edge_end = edge['end']
startloc = make_location_from_range(files, edge_start)
endloc = make_location_from_range(files, edge_end)
if startloc != lastlocation:
trace.add_state(State(startloc, None))
trace.add_state(State(endloc, None))
lastlocation = endloc
else:
raise ValueError('unknown kind: %r' % kind)
return trace
if __name__ == '__main__':
if len(sys.argv) != 2:
print("provide either the path to scan-build results directory, or to that of a .plist file as the only argument")
else:
path = sys.argv[1]
if path.endswith('.plist'):
analysis = parse_plist(path)
sys.stdout.write(str(analysis.to_xml()))
sys.stdout.write('\n')
else:
for analysis in parse_scandir(path):
sys.stdout.write(str(analysis.to_xml()))
sys.stdout.write('\n')
|
