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
|
import sys
import getopt
import os
from xml.dom import minidom
from itertools import product
import xml.dom
CONTROL_NAMES= ["Button", "CheckBox", "RadioButton", "ApplicationBarIconButton", "Pivot"]
CONTAINER_CONTROL_NAMES= ["Canvas", "Grid", "StackPanel"]
# TODO externalize strings, share with C# code
CONTINUEONPAGE_VAR= "__BOOGIE_ContinueOnPage__"
staticControlsMap= {}
mainPageXAML= None
mainAppClassname= None
appVarName = "__BOOGIE_APP_VAR"
currentNavigationVariable= None
originalPageVars= []
boogiePageVars= []
boogiePageClasses= []
dummyPageVar= "dummyBoogieStringPageName"
anonymousControlCount= 0;
ANONYMOUS_CONTROL_PREFIX= "__BOOGIE_ANONYMOUS_CONTROL_"
unrolls= 0
def showUsage():
print "PhoneBoogieCodeGenerator -- create boilerplate code for Boogie verification of Phone apps"
print "Usage:"
print "\tPhoneBoogieCodeGenerator --staticUnroll <n> --controls <app_control_info_file> --output <code_output_file>\n"
print "Options:"
print "\t--staticUnroll <n>: Do not generate loops, unroll up to n times. If not set generates loops (default). Short form: -u"
print "\t--controls <app_control_info_file>: Phone app control info. See PhoneControlsExtractor. Short form: -c"
print "\t--output <code_output_file>: file to write with boilerplate code. Short form: -o\n"
def isAnonymousControl(control):
name= control["bplName"]
return name.find(ANONYMOUS_CONTROL_PREFIX) != -1
def loadControlInfo(infoMap, controlClass, controlName, enabled, visible, clickHandler, checkedHandler, uncheckedHandler, selectionChangedHandler, bplName):
global anonymousControlCount
global ANONYMOUS_CONTROL_PREFIX
newControl={}
newControl["class"]= controlClass
newControl["enabled"]= enabled
newControl["visible"]= visible
newControl["clickHandler"]= clickHandler
newControl["checkedHandler"]= checkedHandler
newControl["uncheckedHandler"]= uncheckedHandler
newControl["selectionChangedHandler"]= selectionChangedHandler
if (bplName == ""):
# anonymous control, need a dummy boogie var, but we cannot know how it got initialized
bplName= ANONYMOUS_CONTROL_PREFIX + str(anonymousControlCount)
anonymousControlCount= anonymousControlCount+1
newControl["bplName"]=bplName
infoMap[controlName]= newControl
def outputPageVariables(file):
global originalPageVars
global boogiePageVars
global boogiePageClasses
file.write("var " + appVarName + ": Ref;\n")
for entry in staticControlsMap.keys():
pageVarName= "__BOOGIE_PAGE_VAR_" + entry
originalPageVars.append(entry)
pageInfo={}
pageInfo["name"]=pageVarName
pageInfo["boogieStringName"]= staticControlsMap[entry]["boogieStringName"]
boogiePageVars.append(pageInfo)
boogiePageClasses.append(staticControlsMap[entry]["class"])
pageVar= "var " + pageVarName + ": Ref;\n"
file.write(pageVar)
def outputMainProcedures(file, batFile):
for i,j in product(range(0, len(boogiePageVars)),repeat=2):
if i == j:
continue
if (boogiePageVars[i]["boogieStringName"] == dummyPageVar):
continue
if (boogiePageVars[j]["boogieStringName"] == dummyPageVar):
continue
file.write("procedure {:inline 1} __BOOGIE_VERIFICATION_PROCEDURE_" + str(i) + "_" + str(j) + "();\n")
file.write("implementation __BOOGIE_VERIFICATION_PROCEDURE_" + str(i) + "_" + str(j) + "() {\n")
file.write("\tvar $doWork: bool;\n")
file.write("\tvar $activeControl: int;\n")
file.write("\tvar $isEnabledRef: Ref;\n")
file.write("\tvar $isEnabled: bool;\n")
file.write("\tvar $control: Ref;\n\n")
file.write("\tcall " + mainAppClassname + ".#ctor(" + appVarName + ");\n")
for k in range(0,len(boogiePageVars)):
file.write("\tcall " + boogiePageClasses[k] + ".#ctor(" + boogiePageVars[k]["name"] + ");\n")
file.write("\t//TODO still need to call Loaded handler on main page.\n")
if (unrolls == 0):
file.write("\thavoc $doWork;\n")
file.write("\twhile ($doWork) {\n")
file.write("\t\tcall DriveControls();\n")
file.write("\t\thavoc $doWork;\n")
file.write("\t}\n")
else:
for unr in range(unrolls):
file.write("\t\tcall DriveControls();\n")
file.write("\tassume " + currentNavigationVariable + " == " + boogiePageVars[i]["boogieStringName"] + ";\n")
file.write("\tcall DriveControls();\n")
file.write("\tassume " + currentNavigationVariable + " == " + boogiePageVars[j]["boogieStringName"] + ";\n")
file.write("\tassert false;\n");
file.write("}\n")
batFile.write("type BOOGIE_PARTIAL.bpl > BOOGIE_PLACEHOLDER.bpl\n")
batFile.write("type BOOGIE_BOILERPLATE.bpl >> BOOGIE_PLACEHOLDER.bpl\n")
batFile.write("%POIROT_ROOT%\Corral\BctCleanup.exe BOOGIE_PLACEHOLDER.bpl BOOGIE_PLACEHOLDER_Clean.bpl /main:__BOOGIE_VERIFICATION_PROCEDURE_" + str(i) + "_" + str(j) +"\n");
batFile.write("del corral_out_trace.txt\n")
batFile.write("%POIROT_ROOT%\corral\corral.exe /k:1 /recursionBound:20 /main:__BOOGIE_VERIFICATION_PROCEDURE_" + str(i) +"_" + str(j) + " BOOGIE_PLACEHOLDER_Clean_" + str(i) + "_" + str(j) + ".bpl\n")
batFile.write("if exist corral_out_trace.txt move corral_out_trace.txt corral_out_trace_" + str(i) + "_" + str(j) + ".txt\n")
def outputPageControlDriver(file, originalPageName, boogiePageName):
file.write("procedure {:inline 1} drive" + boogiePageName + "Controls();\n")
file.write("implementation drive" + boogiePageName + "Controls() {\n")
file.write("\tvar $activeControl: int;\n")
file.write("\tvar $control: Ref;\n")
file.write("\tvar $isEnabledRef: Ref;\n")
file.write("\tvar $isEnabled: bool;\n")
file.write("\tvar $handlerToActivate: int;\n")
file.write("\t" + CONTINUEONPAGE_VAR +":=true;\n")
file.write("\thavoc $activeControl;\n")
file.write("\twhile (" + CONTINUEONPAGE_VAR + ") {\n")
activeControl=0
ifInitialized= False
for entry in staticControlsMap[originalPageName]["controls"].keys():
controlInfo= staticControlsMap[originalPageName]["controls"][entry]
if controlInfo["bplName"] == "":
continue;
if not ifInitialized:
file.write("\t\tif ($activeControl == " + str(activeControl) + ") {\n")
ifInitialized= True
else:
file.write("\t\telse if ($activeControl == " + str(activeControl) + ") {\n")
file.write("\t\t\t$control := " + controlInfo["bplName"] + "[" + boogiePageName + "];\n")
file.write("\t\t\tcall $isEnabledRef := System.Windows.Controls.Control.get_IsEnabled($control);\n")
file.write("\t\t\t$isEnabled := Box2Bool(Ref2Box($isEnabledRef));\n")
file.write("\t\t\tif ($isEnabled) {\n")
file.write("\t\t\t\thavoc $handlerToActivate;\n")
if not controlInfo["clickHandler"] == "":
file.write("\t\t\t\tif ($handlerToActivate == 0) {\n")
file.write("\t\t\t\t\tcall " + staticControlsMap[originalPageName]["class"] + "." + controlInfo["clickHandler"] + "$System.Object$System.Windows.RoutedEventArgs(" + controlInfo["bplName"] + "[" + boogiePageName + "],null,null);\n")
file.write("\t\t\t\t}\n")
if not controlInfo["checkedHandler"] == "":
file.write("\t\t\t\tif ($handlerToActivate == 1) {\n")
file.write("\t\t\t\t\tcall " + staticControlsMap[originalPageName]["class"] + "." + controlInfo["checkedHandler"] + "$System.Object$System.Windows.RoutedEventArgs(" + controlInfo["bplName"] + "[" + boogiePageName + "],null,null);\n")
file.write("\t\t\t\t}\n")
if not controlInfo["uncheckedHandler"] == "":
file.write("\t\t\t\tif ($handlerToActivate == 2) {\n")
file.write("\t\t\t\t\tcall " + staticControlsMap[originalPageName]["class"] + "." + controlInfo["uncheckedHandler"] + "$System.Object$System.Windows.RoutedEventArgs(" + controlInfo["bplName"] + "[" + boogiePageName + "],null,null);\n")
file.write("\t\t\t\t}\n")
if not controlInfo["selectionChangedHandler"] == "":
file.write("\t\t\t\tif ($handlerToActivate == 3) {\n")
file.write("\t\t\t\t\tcall " + staticControlsMap[originalPageName]["class"] + "." + controlInfo["selectionChangedHandler"] + "$System.Object$System.Windows.RoutedEventArgs(" + controlInfo["bplName"] + "[" + boogiePageName + "],null,null);\n")
file.write("\t\t\t\t}\n")
file.write("\t\t\t}\n")
file.write("\t\t}\n")
activeControl= activeControl+1
file.write("\t}\n")
file.write("}\n")
def outputControlDrivers(file, batFile):
for i in range(0,len(boogiePageVars)):
outputPageControlDriver(file, originalPageVars[i],boogiePageVars[i]["name"])
file.write("procedure {:inline 1} DriveControls();\n")
file.write("implementation DriveControls() {\n")
for i in range(0,len(boogiePageVars)):
file.write("\tvar isCurrent" + boogiePageVars[i]["name"] + ": bool;\n")
file.write("\n")
for i in range(0,len(boogiePageVars)):
if boogiePageVars[i]["boogieStringName"] == dummyPageVar:
file.write("\tisCurrent" + boogiePageVars[i]["name"] + " := false;\n")
else:
file.write("\tcall isCurrent" + boogiePageVars[i]["name"] + " := System.String.op_Equality$System.String$System.String(" + currentNavigationVariable + "," + boogiePageVars[i]["boogieStringName"] + ");\n")
firstTime= True
for i in range(0,len(boogiePageVars)):
if firstTime:
file.write("\tif")
firstTime= False
else:
file.write("\telse if")
file.write(" (isCurrent" + boogiePageVars[i]["name"] + ") {\n")
file.write("\t\t call drive" + boogiePageVars[i]["name"] + "Controls();\n\t}\n")
file.write("}\n")
def outputURIHavocProcedure(file):
file.write("procedure {:inline 1} __BOOGIE_Havoc_CurrentURI__();\n")
file.write("implementation __BOOGIE_Havoc_CurrentURI__() {\n")
# file.write("\thavoc " + currentNavigationVariable + ";\n")
file.write("// TODO write assume statements to filter havoc'd variable to either of all pages\n")
# file.write("\tassume )
file.write("}\n")
#build a batch file for test running at the same time
def outputBoilerplate(outputFile, cmdFile):
file= open(outputFile,"w")
batFile= open(cmdFile, "w")
batFile.write("del corral_out_trace.txt")
outputPageVariables(file)
outputURIHavocProcedure(file)
outputControlDrivers(file, batFile)
outputMainProcedures(file, batFile)
file.close()
batFile.close()
def buildControlInfo(controlInfoFileName):
global mainPageXAML
global mainAppClassname
global currentNavigationVariable
global staticControlsMap
file = open(controlInfoFileName, "r")
# Info file format is first line containing only the main page, another line with boogie's current navigation variable and then one line per
# <pageClassName>,<page.xaml file>,<xaml boogie string representation>,<controlClassName>,<controlName (as in field name)>,<IsEnabledValue>,<VisibilityValue>,<ClickValue>,<CheckedValue>,<UncheckedValue>,<SelectionChangedValue>,<BoogieName>
mainPageXAML= file.readline().strip()
currentNavigationVariable= file.readline().strip()
mainAppClassname= file.readline().strip()
infoLine= file.readline().strip()
while not infoLine == "":
pageClass, pageName, pageBoogieStringName, controlClass, controlName, enabled, visible, clickHandler, checkedHandler, uncheckedHandler, selectionChangedHandler, bplName= infoLine.split(",")
pageInfo={}
pageInfo["class"]=pageClass
try:
pageInfo= staticControlsMap[pageName]
except KeyError:
staticControlsMap[pageName]=pageInfo
pageInfo["boogieStringName"]= pageBoogieStringName
pageControlInfo={}
try:
pageControlInfo= pageInfo["controls"]
except KeyError:
pageInfo["controls"]=pageControlInfo
loadControlInfo(pageControlInfo, controlClass, controlName, enabled, visible, clickHandler, checkedHandler, uncheckedHandler, selectionChangedHandler, bplName)
pageInfo["controls"]= pageControlInfo
staticControlsMap[pageName]=pageInfo
infoLine=file.readline().strip()
file.close()
def main():
global unrolls
controlFile= ""
outputFile= ""
try:
opts, args= getopt.getopt(sys.argv[1:], "c:o:u:", ["controls=","output=","staticUnroll="])
except getopt.error, msg:
print msg
showUsage()
sys.exit(2)
if not len(opts) >= 2:
print "Missing options"
showUsage()
sys.exit(2)
for o, a in opts:
if o in ["-c","--controls"]:
controlFile= a
if o in ["-o", "--output"]:
outputFile= a
if o in ["-u", "--staticUnroll"]:
unrolls= int(a)
buildControlInfo(controlFile)
outputBoilerplate(outputFile, outputFile + ".bat")
if __name__ == "__main__":
main()
|
