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
|
#!/usr/bin/python3
import re
import io
callDict = dict() # callInfo tuple -> callValue
# clang does not always use exactly the same numbers in the type-parameter vars it generates
# so I need to substitute them to ensure we can match correctly.
normalizeTypeParamsRegex = re.compile(r"type-parameter-\d+-\d+")
def normalizeTypeParams( line ):
return normalizeTypeParamsRegex.sub("type-parameter-?-?", line)
# reading as binary (since we known it is pure ascii) is much faster than reading as unicode
with io.open("workdir/loplugin.constantparam.log", "r") as txt:
line_no = 1
try:
for line in txt:
tokens = line.strip().split("\t")
returnType = normalizeTypeParams(tokens[0])
nameAndParams = normalizeTypeParams(tokens[1])
sourceLocation = tokens[2]
# the cxx should actually ignore these
if sourceLocation.startswith("workdir/"):
continue
paramName = tokens[3]
paramType = normalizeTypeParams(tokens[4])
callValue = tokens[5]
callInfo = (returnType, nameAndParams, paramName, paramType, sourceLocation)
if callInfo not in callDict:
callDict[callInfo] = set()
callDict[callInfo].add(callValue)
line_no += 1
except (IndexError,UnicodeDecodeError):
print("problem with line " + str(line_no))
raise
def RepresentsInt(s):
try:
int(s)
return True
except ValueError:
return False
constructor_regex = re.compile(r"^\w+\(\)$")
tmp1list = list()
tmp2list = list()
tmp3list = list()
tmp4list = list()
for callInfo, callValues in iter(callDict.items()):
nameAndParams = callInfo[1]
if len(callValues) != 1:
continue
callValue = next(iter(callValues))
if "unknown" in callValue:
continue
sourceLoc = callInfo[4]
functionSig = callInfo[0] + " " + callInfo[1]
# try to ignore setter methods
if ("," not in nameAndParams) and (("::set" in nameAndParams) or ("::Set" in nameAndParams)):
continue
# ignore code that follows a common pattern
if sourceLoc.startswith("sw/inc/swatrset.hxx"):
continue
if sourceLoc.startswith("sw/inc/format.hxx"):
continue
# template generated code
if sourceLoc.startswith("include/sax/fshelper.hxx"):
continue
# debug code
if sourceLoc.startswith("include/oox/dump"):
continue
# part of our binary API
if sourceLoc.startswith("include/LibreOfficeKit"):
continue
# ignore methods generated by SFX macros
if "RegisterInterface(class SfxModule *)" in nameAndParams:
continue
if "RegisterChildWindow(_Bool,class SfxModule *,enum SfxChildWindowFlags)" in nameAndParams:
continue
if "RegisterControl(unsigned short,class SfxModule *)" in nameAndParams:
continue
if RepresentsInt(callValue):
if callValue == "0" or callValue == "1":
tmp1list.append((sourceLoc, functionSig, callInfo[3] + " " + callInfo[2], callValue))
else:
tmp2list.append((sourceLoc, functionSig, callInfo[3] + " " + callInfo[2], callValue))
# look for places where the callsite is always a constructor invocation
elif constructor_regex.match(callValue) or callValue == "\"\"":
if callValue.startswith("Get"):
continue
if callValue.startswith("get"):
continue
if "operator=" in functionSig:
continue
if "&&" in functionSig:
continue
if callInfo[2] == "###0" and callValue == "InitData()":
continue
if callInfo[2] == "###0" and callValue == "InitAggregate()":
continue
if callValue == "shared_from_this()":
continue
tmp3list.append((sourceLoc, functionSig, callInfo[3] + " " + callInfo[2], callValue))
else:
tmp4list.append((sourceLoc, functionSig, callInfo[3] + " " + callInfo[2], callValue))
# sort results by filename:lineno
def natural_sort_key(s, _nsre=re.compile('([0-9]+)')):
return [int(text) if text.isdigit() else text.lower()
for text in re.split(_nsre, s)]
# sort by both the source-line and the datatype, so the output file ordering is stable
# when we have multiple items on the same source line
def v_sort_key(v):
return natural_sort_key(v[0]) + [v[1]]
tmp1list.sort(key=lambda v: v_sort_key(v))
tmp2list.sort(key=lambda v: v_sort_key(v))
tmp3list.sort(key=lambda v: v_sort_key(v))
tmp4list.sort(key=lambda v: v_sort_key(v))
# print out the results
with open("compilerplugins/clang/constantparam.booleans.results", "wt") as f:
for v in tmp1list:
f.write(v[0] + "\n")
f.write(" " + v[1] + "\n")
f.write(" " + v[2] + "\n")
f.write(" " + v[3] + "\n")
with open("compilerplugins/clang/constantparam.numbers.results", "wt") as f:
for v in tmp2list:
f.write(v[0] + "\n")
f.write(" " + v[1] + "\n")
f.write(" " + v[2] + "\n")
f.write(" " + v[3] + "\n")
with open("compilerplugins/clang/constantparam.constructors.results", "wt") as f:
for v in tmp3list:
f.write(v[0] + "\n")
f.write(" " + v[1] + "\n")
f.write(" " + v[2] + "\n")
f.write(" " + v[3] + "\n")
with open("compilerplugins/clang/constantparam.others.results", "wt") as f:
for v in tmp4list:
f.write(v[0] + "\n")
f.write(" " + v[1] + "\n")
f.write(" " + v[2] + "\n")
f.write(" " + v[3] + "\n")
# -------------------------------------------------------------
# Now a fun set of heuristics to look for methods that
# take bitmask parameters where one or more of the bits in the
# bitmask is always one or always zero
# integer to hex str
def hex(i):
return "0x%x" % i
# I can't use python's ~ operator, because that produces negative numbers
def negate(i):
return (1 << 32) - 1 - i
tmp2list = list()
for callInfo, callValues in iter(callDict.items()):
nameAndParams = callInfo[1]
if len(callValues) < 2:
continue
# we are only interested in enum parameters
if "enum" not in callInfo[3]:
continue
if "Flag" not in callInfo[3] and "flag" not in callInfo[3] and "Bit" not in callInfo[3] and "State" not in callInfo[3]:
continue
# try to ignore setter methods
if ("," not in nameAndParams) and (("::set" in nameAndParams) or ("::Set" in nameAndParams)):
continue
setBits = 0
clearBits = 0
continue_flag = False
first = True
for callValue in callValues:
if "unknown" == callValue or not callValue.isdigit():
continue_flag = True
break
if first:
setBits = int(callValue)
clearBits = negate(int(callValue))
first = False
else:
setBits = setBits & int(callValue)
clearBits = clearBits & negate(int(callValue))
# estimate allBits by using the highest bit we have seen
# TODO dump more precise information about the allBits values of enums
allBits = (1 << setBits.bit_length()) - 1
clearBits = clearBits & allBits
if continue_flag or (setBits == 0 and clearBits == 0):
continue
sourceLoc = callInfo[4]
functionSig = callInfo[0] + " " + callInfo[1]
v2 = callInfo[3] + " " + callInfo[2]
if setBits != 0:
v2 += " setBits=" + hex(setBits)
if clearBits != 0:
v2 += " clearBits=" + hex(clearBits)
tmp2list.append((sourceLoc, functionSig, v2))
# sort results by filename:lineno
tmp2list.sort(key=lambda v: v_sort_key(v))
# print out the results
with open("compilerplugins/clang/constantparam.bitmask.results", "wt") as f:
for v in tmp2list:
f.write(v[0] + "\n")
f.write(" " + v[1] + "\n")
f.write(" " + v[2] + "\n")
|
