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
|
//-----------------------------------------------------------------------------
//
// Copyright (C) Microsoft Corporation. All Rights Reserved.
//
//-----------------------------------------------------------------------------
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using Microsoft.Cci;
using Microsoft.Cci.MetadataReader;
using Microsoft.Cci.MutableCodeModel;
using Microsoft.Cci.Contracts;
using Microsoft.Cci.ILToCodeModel;
using System.Diagnostics.Contracts;
using Bpl = Microsoft.Boogie;
using BytecodeTranslator.TranslationPlugins;
using System.IO;
namespace BytecodeTranslator {
public class Sink {
public IEnumerable<Translator> TranslationPlugins {
get { return this.translationPlugins; }
set { this.translationPlugins= value; }
}
private IEnumerable<Translator> translationPlugins;
private readonly Options options;
readonly bool whiteList;
readonly List<Regex> exemptionList;
public Sink(IContractAwareHost host, HeapFactory heapFactory, Options options, List<Regex> exemptionList, bool whiteList) {
Contract.Requires(host != null);
Contract.Requires(heapFactory != null);
this.host = host;
var b = heapFactory.MakeHeap(this, out this.heap, out this.TranslatedProgram); // TODO: what if it returns false?
this.options = options;
this.exemptionList = exemptionList;
this.whiteList = whiteList;
if (this.TranslatedProgram == null) {
this.TranslatedProgram = new Bpl.Program();
}
else {
foreach (var d in this.TranslatedProgram.TopLevelDeclarations) {
var p = d as Bpl.Procedure;
if (p != null) {
if (Bpl.QKeyValue.FindBoolAttribute(p.Attributes, "extern")) continue;
this.initiallyDeclaredProcedures.Add(p.Name, new ProcedureInfo(p));
}
}
}
this.uniqueNumberSeed = 0;
}
public Options Options { get { return this.options; } }
public Heap Heap {
get { return this.heap; }
}
readonly Heap heap;
public Bpl.Formal ThisVariable {
get {
return this.thisVariable;
//ProcedureInfo info = FindOrCreateProcedure(this.methodBeingTranslated);
//return info.ThisVariable;
}
}
private Bpl.Formal thisVariable;
public Bpl.Formal ReturnVariable {
get {
ProcedureInfo info = FindOrCreateProcedure(this.methodBeingTranslated);
return info.ReturnVariable;
}
}
public Bpl.LocalVariable LocalExcVariable {
get {
ProcedureInfo info = FindOrCreateProcedure(this.methodBeingTranslated);
return info.LocalExcVariable;
}
}
public Bpl.LocalVariable LabelVariable {
get {
ProcedureInfo info = FindOrCreateProcedure(this.methodBeingTranslated);
return info.LabelVariable;
}
}
public readonly string AllocationMethodName = "Alloc";
public readonly string StaticFieldFunction = "ClassRepr";
public readonly string ReferenceTypeName = "Ref";
public readonly string DelegateCreateName = "DelegateCreate";
public readonly string DelegateAddName = "DelegateAdd";
public readonly string DelegateRemoveName = "DelegateRemove";
public Bpl.Expr ReadDelegateMultiset(Bpl.Expr delegateReference) {
return new Bpl.NAryExpr(delegateReference.tok, new Bpl.FunctionCall(Heap.RefToDelegateMultiset), new Bpl.ExprSeq(delegateReference));
}
public Bpl.Expr ReadDelegate(Bpl.Expr delegateReference) {
return new Bpl.NAryExpr(delegateReference.tok, new Bpl.FunctionCall(Heap.RefToDelegate), new Bpl.ExprSeq(delegateReference));
}
public Bpl.Expr ReadMethod(Bpl.Expr delegateExpr) {
return new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(this.heap.DelegateMethod), new Bpl.ExprSeq(delegateExpr));
}
public Bpl.Expr ReadReceiver(Bpl.Expr delegateExpr) {
return new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(this.heap.DelegateReceiver), new Bpl.ExprSeq(delegateExpr));
}
public Bpl.Expr ReadTypeParameters(Bpl.Expr delegateExpr) {
return new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(this.heap.DelegateTypeParameters), new Bpl.ExprSeq(delegateExpr));
}
public Bpl.Expr CreateDelegate(Bpl.Expr methodExpr, Bpl.Expr instanceExpr, Bpl.Expr typeParameterExpr) {
return new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(this.heap.DelegateCons),
new Bpl.ExprSeq(methodExpr, instanceExpr, typeParameterExpr));
}
public readonly Bpl.Program TranslatedProgram;
public Bpl.Type CciTypeToBoogie(ITypeReference type) {
if (TypeHelper.TypesAreEquivalent(type, type.PlatformType.SystemBoolean))
return Bpl.Type.Bool;
else if (type.TypeCode == PrimitiveTypeCode.UIntPtr || type.TypeCode == PrimitiveTypeCode.IntPtr)
return Bpl.Type.Int;
else if (TypeHelper.IsPrimitiveInteger(type))
return Bpl.Type.Int;
else if (type.TypeCode == PrimitiveTypeCode.Float32 || type.TypeCode == PrimitiveTypeCode.Float64)
return heap.RealType;
else if (type.ResolvedType.IsStruct)
return heap.RefType; // structs are kept on the heap with special rules about assignment
else if (type.IsEnum)
return Bpl.Type.Int; // The underlying type of an enum is always some kind of integer
else if (type is IGenericParameterReference) {
var gp = type.ResolvedType as IGenericParameter;
if (gp.MustBeReferenceType)// || gp.MustBeValueType)
return heap.RefType;
foreach (var c in gp.Constraints) {
if (TypeHelper.TypesAreEquivalent(c, type.PlatformType.SystemValueType)) continue;
return CciTypeToBoogie(c);
}
return heap.UnionType;
} else
return heap.RefType;
}
/// <summary>
/// Creates a fresh local var of the given Type and adds it to the
/// Bpl Implementation
/// </summary>
/// <param name="typeReference"> The type of the new variable </param>
/// <returns> A fresh Variable with automatic generated name and location </returns>
public Bpl.Variable CreateFreshLocal(ITypeReference typeReference) {
Bpl.IToken loc = Bpl.Token.NoToken; // Helper Variables do not have a location
Bpl.Type t = CciTypeToBoogie(typeReference);
var localName = TranslationHelper.GenerateTempVarName();
Bpl.LocalVariable v = new Bpl.LocalVariable(loc, new Bpl.TypedIdent(loc, localName, t));
ILocalDefinition dummy = new LocalDefinition(); // Creates a dummy entry for the Dict, since only locals in the dict are translated to boogie
localVarMap.Add(localName, v);
return v;
}
public Bpl.Variable CreateFreshLocal(Bpl.Type t) {
Bpl.IToken loc = Bpl.Token.NoToken; // Helper Variables do not have a location
var localName = TranslationHelper.GenerateTempVarName();
Bpl.LocalVariable v = new Bpl.LocalVariable(loc, new Bpl.TypedIdent(loc, localName, t));
ILocalDefinition dummy = new LocalDefinition(); // Creates a dummy entry for the Dict, since only locals in the dict are translated to boogie
localVarMap.Add(localName, v);
return v;
}
/// <summary>
/// There are no global variables in code, but it may be useful to have global Boogie vars in the translation
///
/// This should be just the same as the encoding for a static field, but I'm being
/// IL-unaware here...not sure if this is 100% right
/// </summary>
private IDictionary<string, Bpl.Variable> globalVariables = new Dictionary<string, Bpl.Variable>();
public Bpl.Variable FindOrCreateGlobalVariable(string globalVarName, Bpl.Type type) {
Bpl.Variable globalVar;
// assuming globalVarName is a valid identifier. Possible name clashing issues too
if (!globalVariables.TryGetValue(globalVarName, out globalVar)) {
globalVar = new Bpl.GlobalVariable(null, new Bpl.TypedIdent(null, globalVarName, type));
}
return globalVar;
}
/// <summary>
/// State that gets re-initialized per method
/// Keys are the mangled names to avoid name clashes.
/// </summary>
private Dictionary<string, Bpl.LocalVariable> localVarMap = null;
public Dictionary<string, Bpl.LocalVariable> LocalVarMap {
get { return this.localVarMap; }
}
private int localCounter;
public int LocalCounter { get { return this.localCounter++; } }
/// <summary>
///
/// </summary>
/// <param name="local"></param>
/// <returns></returns>
public Bpl.Variable FindOrCreateLocalVariable(ILocalDefinition local) {
Bpl.LocalVariable v;
Bpl.IToken tok = local.Token();
Bpl.Type t = CciTypeToBoogie(local.Type.ResolvedType);
var name = local.Name.Value;
name = TranslationHelper.TurnStringIntoValidIdentifier(name);
var typeName = t.ToString();
typeName = TranslationHelper.TurnStringIntoValidIdentifier(typeName);
var mangledName = String.Format("{0}_{1}", name, typeName);
if (!localVarMap.TryGetValue(mangledName, out v)) {
v = new Bpl.LocalVariable(tok, new Bpl.TypedIdent(tok, mangledName, t));
localVarMap.Add(mangledName, v);
}
return v;
}
/// <summary>
///
/// </summary>
/// <param name="param"></param>
/// <remarks>STUB</remarks>
/// <returns></returns>
public Bpl.Variable FindParameterVariable(IParameterDefinition param, bool contractContext) {
MethodParameter mp;
ProcedureInfo procAndFormalMap;
var sig = param.ContainingSignature;
// BUGBUG: If param's signature is not a method reference, then it can't be used as a key.
// The declaredMethods table needs to use ISignature for its keys.
var key = ((IMethodReference)sig);
this.declaredMethods.TryGetValue(key, out procAndFormalMap);
var formalMap = procAndFormalMap.FormalMap;
mp = formalMap[param.Index];
return contractContext ? mp.inParameterCopy : mp.outParameterCopy;
}
public Bpl.Variable FindOrCreateFieldVariable(IFieldReference field) {
// The Heap has to decide how to represent the field (i.e., its type),
// all the Sink cares about is adding a declaration for it.
Bpl.Variable v;
var specializedField = field as ISpecializedFieldReference;
if (specializedField != null)
field = specializedField.UnspecializedVersion;
if (!this.declaredFields.TryGetValue(field, out v)) {
v = this.Heap.CreateFieldVariable(field);
var isExtern = this.assemblyBeingTranslated != null &&
!TypeHelper.GetDefiningUnitReference(field.ContainingType).UnitIdentity.Equals(this.assemblyBeingTranslated.UnitIdentity);
if (isExtern) {
var attrib = new Bpl.QKeyValue(Bpl.Token.NoToken, "extern", new List<object>(1), null);
v.Attributes = attrib;
}
this.declaredFields.Add(field, v);
this.TranslatedProgram.TopLevelDeclarations.Add(v);
}
return v;
}
class FieldComparer : IEqualityComparer<IFieldReference> {
public bool Equals(IFieldReference x, IFieldReference y) {
return x.InternedKey == y.InternedKey;
}
public int GetHashCode(IFieldReference obj) {
return (int)obj.InternedKey;
}
}
/// <summary>
/// The keys to the table are the fields themselves, but the equality of keys is via their interned keys.
/// </summary>
private Dictionary<IFieldReference, Bpl.Variable> declaredFields = new Dictionary<IFieldReference, Bpl.Variable>(new FieldComparer());
public Bpl.Variable FindOrCreateEventVariable(IEventDefinition e) {
Bpl.Variable v;
if (!this.declaredEvents.TryGetValue(e, out v)) {
v = null;
// First, see if the compiler generated a field (which happens when the event did not explicitly
// define an adder and remover. If so, then just use the variable that corresponds to that field.
foreach (var f in e.ContainingTypeDefinition.Fields) {
if (e.Name == f.Name) {
v = this.FindOrCreateFieldVariable(f);
break;
}
}
if (v == null) {
v = this.Heap.CreateEventVariable(e);
var isExtern = this.assemblyBeingTranslated != null &&
!TypeHelper.GetDefiningUnitReference(e.ContainingType).UnitIdentity.Equals(this.assemblyBeingTranslated.UnitIdentity);
if (isExtern) {
var attrib = new Bpl.QKeyValue(Bpl.Token.NoToken, "extern", new List<object>(1), null);
v.Attributes = attrib;
}
this.TranslatedProgram.TopLevelDeclarations.Add(v);
}
this.declaredEvents.Add(e, v);
}
return v;
}
private Dictionary<IEventDefinition, Bpl.Variable> declaredEvents = new Dictionary<IEventDefinition, Bpl.Variable>();
public Bpl.Variable FindOrCreatePropertyVariable(IPropertyDefinition p) {
return null;
}
public Bpl.Constant FindOrCreateConstant(string str) {
str = str.Replace("\n", "\\n");
str = str.Replace("\r", "\\r");
str = str.Replace("\"", "\\\"");
Bpl.Constant c;
if (!this.declaredStringConstants.TryGetValue(str, out c)) {
var tok = Bpl.Token.NoToken;
var t = Heap.RefType;
var name = "$string_literal_" + TranslationHelper.TurnStringIntoValidIdentifier(str) + "_" + declaredStringConstants.Count;
var tident = new Bpl.TypedIdent(tok, name, t);
c = new Bpl.Constant(tok, tident, true);
var attrib = new Bpl.QKeyValue(Bpl.Token.NoToken, "value", new List<object> { str, }, null);
c.Attributes = attrib;
this.declaredStringConstants.Add(str, c);
this.TranslatedProgram.TopLevelDeclarations.Add(c);
}
return c;
}
private Dictionary<string, Bpl.Constant> declaredStringConstants = new Dictionary<string, Bpl.Constant>();
public Bpl.Constant FindOrCreateConstant(double d) {
Bpl.Constant c;
var str = d.ToString();
if (!this.declaredRealConstants.TryGetValue(str, out c)) {
var tok = Bpl.Token.NoToken;
var t = Heap.RealType;
var name = "$real_literal_" + TranslationHelper.TurnStringIntoValidIdentifier(str) + "_" + declaredStringConstants.Count;
var tident = new Bpl.TypedIdent(tok, name, t);
c = new Bpl.Constant(tok, tident, true);
this.declaredRealConstants.Add(str, c);
this.TranslatedProgram.TopLevelDeclarations.Add(c);
}
return c;
}
public Bpl.Constant FindOrCreateConstant(float f) {
Bpl.Constant c;
var str = f.ToString();
if (!this.declaredRealConstants.TryGetValue(str, out c)) {
var tok = Bpl.Token.NoToken;
var t = Heap.RealType;
var name = "$real_literal_" + TranslationHelper.TurnStringIntoValidIdentifier(str) + "_" + declaredStringConstants.Count;
var tident = new Bpl.TypedIdent(tok, name, t);
c = new Bpl.Constant(tok, tident, true);
this.declaredRealConstants.Add(str, c);
this.TranslatedProgram.TopLevelDeclarations.Add(c);
}
return c;
}
private Dictionary<string, Bpl.Constant> declaredRealConstants = new Dictionary<string, Bpl.Constant>();
private Dictionary<IPropertyDefinition, Bpl.Variable> declaredProperties = new Dictionary<IPropertyDefinition, Bpl.Variable>();
private List<Bpl.Function> projectionFunctions = new List<Bpl.Function>();
private Dictionary<int, Bpl.Function> arityToNaryIntFunctions = new Dictionary<int, Bpl.Function>();
public Bpl.Function FindOrCreateNaryIntFunction(int arity) {
Bpl.Function f;
if (!this.arityToNaryIntFunctions.TryGetValue(arity, out f)) {
Bpl.VariableSeq vseq = new Bpl.VariableSeq();
for (int i = 0; i < arity; i++) {
vseq.Add(new Bpl.Formal(Bpl.Token.NoToken, new Bpl.TypedIdent(Bpl.Token.NoToken, "arg" + i, Bpl.Type.Int), true));
}
f = new Bpl.Function(Bpl.Token.NoToken, "Int" + arity, vseq, new Bpl.Formal(Bpl.Token.NoToken, new Bpl.TypedIdent(Bpl.Token.NoToken, "result", Bpl.Type.Int), false));
this.arityToNaryIntFunctions.Add(arity, f);
TranslatedProgram.TopLevelDeclarations.Add(f);
if (arity > projectionFunctions.Count) {
for (int i = projectionFunctions.Count; i < arity; i++) {
Bpl.Variable input = new Bpl.Formal(Bpl.Token.NoToken, new Bpl.TypedIdent(Bpl.Token.NoToken, "in", Bpl.Type.Int), true);
Bpl.Variable output = new Bpl.Formal(Bpl.Token.NoToken, new Bpl.TypedIdent(Bpl.Token.NoToken, "out", Bpl.Type.Int), false);
Bpl.Function g = new Bpl.Function(Bpl.Token.NoToken, "Proj" + i, new Bpl.VariableSeq(input), output);
TranslatedProgram.TopLevelDeclarations.Add(g);
projectionFunctions.Add(g);
}
}
Bpl.VariableSeq qvars = new Bpl.VariableSeq();
Bpl.ExprSeq exprs = new Bpl.ExprSeq();
for (int i = 0; i < arity; i++) {
Bpl.Variable v = new Bpl.Constant(Bpl.Token.NoToken, new Bpl.TypedIdent(Bpl.Token.NoToken, "arg" + i, Bpl.Type.Int));
qvars.Add(v);
exprs.Add(Bpl.Expr.Ident(v));
}
Bpl.Expr e = new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(f), exprs);
for (int i = 0; i < arity; i++) {
Bpl.Expr appl = new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(projectionFunctions[i]), new Bpl.ExprSeq(e));
Bpl.Trigger trigger = new Bpl.Trigger(Bpl.Token.NoToken, true, new Bpl.ExprSeq(e));
Bpl.Expr qexpr = new Bpl.ForallExpr(Bpl.Token.NoToken, new Bpl.TypeVariableSeq(), qvars, null, trigger, Bpl.Expr.Eq(appl, Bpl.Expr.Ident(qvars[i])));
TranslatedProgram.TopLevelDeclarations.Add(new Bpl.Axiom(Bpl.Token.NoToken, qexpr));
}
}
return f;
}
private List<Bpl.Function> typeParameterFunctions = new List<Bpl.Function>();
private Dictionary<int, Bpl.Function> arityToNaryTypeFunctions = new Dictionary<int, Bpl.Function>();
public Bpl.Function FindOrCreateNaryTypeFunction(int arity) {
Bpl.Function f;
if (!this.arityToNaryTypeFunctions.TryGetValue(arity, out f)) {
Bpl.VariableSeq vseq = new Bpl.VariableSeq();
for (int i = 0; i < arity; i++) {
vseq.Add(new Bpl.Formal(Bpl.Token.NoToken, new Bpl.TypedIdent(Bpl.Token.NoToken, "arg" + i, this.Heap.TypeType), true));
}
f = new Bpl.Function(Bpl.Token.NoToken, "Type" + arity, vseq, new Bpl.Formal(Bpl.Token.NoToken, new Bpl.TypedIdent(Bpl.Token.NoToken, "result", this.Heap.TypeType), false));
this.arityToNaryTypeFunctions.Add(arity, f);
TranslatedProgram.TopLevelDeclarations.Add(f);
if (arity > typeParameterFunctions.Count) {
for (int i = typeParameterFunctions.Count; i < arity; i++) {
Bpl.Variable input = new Bpl.Formal(Bpl.Token.NoToken, new Bpl.TypedIdent(Bpl.Token.NoToken, "in", this.Heap.TypeType), true);
Bpl.Variable output = new Bpl.Formal(Bpl.Token.NoToken, new Bpl.TypedIdent(Bpl.Token.NoToken, "out", this.Heap.TypeType), false);
Bpl.Function g = new Bpl.Function(Bpl.Token.NoToken, "TypeProj" + i, new Bpl.VariableSeq(input), output);
TranslatedProgram.TopLevelDeclarations.Add(g);
typeParameterFunctions.Add(g);
}
}
Bpl.VariableSeq qvars = new Bpl.VariableSeq();
Bpl.ExprSeq exprs = new Bpl.ExprSeq();
for (int i = 0; i < arity; i++) {
Bpl.Variable v = new Bpl.Constant(Bpl.Token.NoToken, new Bpl.TypedIdent(Bpl.Token.NoToken, "arg" + i, this.Heap.TypeType));
qvars.Add(v);
exprs.Add(Bpl.Expr.Ident(v));
}
Bpl.Expr e = new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(f), exprs);
for (int i = 0; i < arity; i++) {
Bpl.Expr appl = new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(typeParameterFunctions[i]), new Bpl.ExprSeq(e));
Bpl.Trigger trigger = new Bpl.Trigger(Bpl.Token.NoToken, true, new Bpl.ExprSeq(e));
Bpl.Expr qexpr = new Bpl.ForallExpr(Bpl.Token.NoToken, new Bpl.TypeVariableSeq(), qvars, null, trigger, Bpl.Expr.Eq(appl, Bpl.Expr.Ident(qvars[i])));
TranslatedProgram.TopLevelDeclarations.Add(new Bpl.Axiom(Bpl.Token.NoToken, qexpr));
}
}
return f;
}
public Bpl.Function FindOrCreateTypeParameterFunction(int id) {
FindOrCreateNaryTypeFunction(id + 1);
return typeParameterFunctions[id];
}
public struct ProcedureInfo {
private Bpl.DeclWithFormals decl;
private MethodParameter[] formalMap; // maps parameter index to formal
private Bpl.Formal thisVariable;
private Bpl.Formal returnVariable;
private Bpl.LocalVariable localExcVariable;
private Bpl.LocalVariable labelVariable;
private List<Bpl.Formal> typeParameters;
private List<Bpl.Formal> methodParameters;
public ProcedureInfo(Bpl.DeclWithFormals decl) {
this.decl = decl;
this.formalMap = null;
this.returnVariable = null;
this.thisVariable = null;
this.localExcVariable = null;
this.labelVariable = null;
this.typeParameters = null;
this.methodParameters = null;
}
public ProcedureInfo(
Bpl.DeclWithFormals decl,
MethodParameter[] formalMap)
: this(decl) {
this.formalMap = formalMap;
}
public ProcedureInfo(
Bpl.DeclWithFormals decl,
MethodParameter[] formalMap,
Bpl.Formal returnVariable)
: this(decl, formalMap) {
this.returnVariable = returnVariable;
}
public ProcedureInfo(
Bpl.DeclWithFormals decl,
MethodParameter[] formalMap,
Bpl.Formal returnVariable,
Bpl.Formal thisVariable,
Bpl.LocalVariable localExcVariable,
Bpl.LocalVariable labelVariable,
List<Bpl.Formal> typeParameters,
List<Bpl.Formal> methodParameters)
: this(decl, formalMap, returnVariable) {
this.thisVariable = thisVariable;
this.localExcVariable = localExcVariable;
this.labelVariable = labelVariable;
this.typeParameters = typeParameters;
this.methodParameters = methodParameters;
}
public Bpl.DeclWithFormals Decl { get { return decl; } }
public MethodParameter[] FormalMap { get { return formalMap; } }
public Bpl.Formal ThisVariable { get { return thisVariable; } }
public Bpl.Formal ReturnVariable { get { return returnVariable; } }
public Bpl.LocalVariable LocalExcVariable { get { return localExcVariable; } }
public Bpl.LocalVariable LabelVariable { get { return labelVariable; } }
public Bpl.Formal TypeParameter(int index) { return typeParameters[index]; }
public Bpl.Formal MethodParameter(int index) { return methodParameters[index]; }
}
public ProcedureInfo FindOrCreateProcedure(IMethodDefinition method) {
ProcedureInfo procInfo;
var key = method;
if (!this.declaredMethods.TryGetValue(key, out procInfo)) {
string MethodName = TranslationHelper.CreateUniqueMethodName(method);
if (this.initiallyDeclaredProcedures.TryGetValue(MethodName, out procInfo)) return procInfo;
Bpl.Formal thisVariable = null;
Bpl.Formal retVariable = null;
Bpl.LocalVariable localExcVariable = new Bpl.LocalVariable(Bpl.Token.NoToken, new Bpl.TypedIdent(Bpl.Token.NoToken, "$localExc", this.Heap.RefType));
Bpl.LocalVariable labelVariable = new Bpl.LocalVariable(Bpl.Token.NoToken, new Bpl.TypedIdent(Bpl.Token.NoToken, "$label", Bpl.Type.Int));
int in_count = 0;
int out_count = 0;
MethodParameter mp;
var formalMap = new MethodParameter[IteratorHelper.EnumerableCount(method.Parameters)];
foreach (IParameterDefinition formal in method.Parameters) {
mp = new MethodParameter(formal, this.CciTypeToBoogie(formal.Type));
if (mp.inParameterCopy != null) in_count++;
if (mp.outParameterCopy != null && formal.IsByReference)
out_count++;
formalMap[formal.Index] = mp;
}
if (method.Type.TypeCode != PrimitiveTypeCode.Void) {
Bpl.Type rettype = CciTypeToBoogie(method.Type);
out_count++;
retVariable = new Bpl.Formal(method.Token(), new Bpl.TypedIdent(method.Type.Token(), "$result", rettype), false);
}
if (!method.IsStatic) {
var selfType = CciTypeToBoogie(method.ContainingType);
in_count++;
thisVariable = new Bpl.Formal(method.Token(), new Bpl.TypedIdent(method.Type.Token(), "$this", selfType), true);
}
List<Bpl.Formal> typeParameters = new List<Bpl.Formal>();
ITypeDefinition containingType = method.ContainingType.ResolvedType;
while (true) {
int paramIndex = 0;
foreach (IGenericTypeParameter gtp in containingType.GenericParameters) {
Bpl.Formal f = new Bpl.Formal(Bpl.Token.NoToken, new Bpl.TypedIdent(Bpl.Token.NoToken, gtp.Name.Value, this.Heap.TypeType), true);
typeParameters.Insert(paramIndex, f);
if (method.IsStatic) in_count++;
paramIndex++;
}
INestedTypeDefinition ntd = containingType as INestedTypeDefinition;
if (ntd == null) break;
containingType = ntd.ContainingType.ResolvedType;
}
List<Bpl.Formal> methodParameters = new List<Bpl.Formal>();
foreach (IGenericMethodParameter gmp in method.GenericParameters) {
Bpl.Formal f = new Bpl.Formal(Bpl.Token.NoToken, new Bpl.TypedIdent(Bpl.Token.NoToken, gmp.Name.Value, this.Heap.TypeType), true);
methodParameters.Add(f);
in_count++;
}
Bpl.Variable[] invars = new Bpl.Formal[in_count];
Bpl.Variable[] outvars = new Bpl.Formal[out_count];
int i = 0;
int j = 0;
if (thisVariable != null)
invars[i++] = thisVariable;
foreach (MethodParameter mparam in formalMap) {
if (mparam.inParameterCopy != null) {
invars[i++] = mparam.inParameterCopy;
}
if (mparam.outParameterCopy != null) {
if (mparam.underlyingParameter.IsByReference)
outvars[j++] = mparam.outParameterCopy;
}
}
if (method.IsStatic) {
foreach (Bpl.Formal f in typeParameters) {
invars[i++] = f;
}
}
foreach (Bpl.Formal f in methodParameters) {
invars[i++] = f;
}
if (retVariable != null) outvars[j++] = retVariable;
var tok = method.Token();
Bpl.RequiresSeq boogiePrecondition = new Bpl.RequiresSeq();
Bpl.EnsuresSeq boogiePostcondition = new Bpl.EnsuresSeq();
Bpl.IdentifierExprSeq boogieModifies = new Bpl.IdentifierExprSeq();
Bpl.DeclWithFormals decl;
if (IsPure(method)) {
var func = new Bpl.Function(tok,
MethodName,
new Bpl.VariableSeq(invars),
retVariable);
decl = func;
}
else {
var proc = new Bpl.Procedure(tok,
MethodName,
new Bpl.TypeVariableSeq(),
new Bpl.VariableSeq(invars),
new Bpl.VariableSeq(outvars),
boogiePrecondition,
boogieModifies,
boogiePostcondition);
decl = proc;
}
if (this.assemblyBeingTranslated != null && !TypeHelper.GetDefiningUnitReference(method.ContainingType).UnitIdentity.Equals(this.assemblyBeingTranslated.UnitIdentity)) {
var attrib = new Bpl.QKeyValue(tok, "extern", new List<object>(1), null);
decl.Attributes = attrib;
}
string newName = null;
if (IsStubMethod(method, out newName)) {
if (newName != null) {
decl.Name = newName;
}
}
else {
this.TranslatedProgram.TopLevelDeclarations.Add(decl);
}
procInfo = new ProcedureInfo(decl, formalMap, retVariable, thisVariable, localExcVariable, labelVariable, typeParameters, methodParameters);
this.declaredMethods.Add(key, procInfo);
// Can't visit the method's contracts until the formalMap and procedure are added to the
// table because information in them might be needed (e.g., if a parameter is mentioned
// in a contract.
#region Translate the method's contracts
var possiblyUnspecializedMethod = Unspecialize(method);
var contract = Microsoft.Cci.MutableContracts.ContractHelper.GetMethodContractFor(this.host, possiblyUnspecializedMethod.ResolvedMethod);
if (contract != null) {
try {
foreach (Translator translatorPlugin in translationPlugins) {
ContractAwareTranslator translator = translatorPlugin as ContractAwareTranslator;
if (translator != null) {
IEnumerable<Bpl.Requires> preConds = translator.getPreconditionTranslation(contract);
foreach (Bpl.Requires preExpr in preConds) {
boogiePrecondition.Add(preExpr);
}
IEnumerable<Bpl.Ensures> ensures = translator.getPostconditionTranslation(contract);
foreach (Bpl.Ensures ensuring in ensures) {
boogiePostcondition.Add(ensuring);
}
IEnumerable<Bpl.IdentifierExpr> modifiedExpr = translator.getModifiedIdentifiers(contract);
foreach (Bpl.IdentifierExpr ident in modifiedExpr) {
boogieModifies.Add(ident);
}
}
}
}
catch (TranslationException te) {
throw new NotImplementedException("Cannot Handle Errors in Method Contract: " + te.ToString());
}
catch {
throw;
}
}
#endregion
#region Add disjointness contracts for any struct values passed by value
var paramList = new List<IParameterDefinition>(method.Parameters);
for (int p1index = 0; p1index < method.ParameterCount; p1index++) {
var p1 = paramList[p1index];
if (p1.IsByReference) continue;
if (!TranslationHelper.IsStruct(p1.Type)) continue;
for (int p2index = p1index + 1; p2index < method.ParameterCount; p2index++) {
var p2 = paramList[p2index];
if (p2.IsByReference) continue;
if (!TranslationHelper.IsStruct(p2.Type)) continue;
if (!TypeHelper.TypesAreEquivalent(p1.Type, p2.Type)) continue;
var req = new Bpl.Requires(true, Bpl.Expr.Binary(Bpl.BinaryOperator.Opcode.Neq,
Bpl.Expr.Ident(formalMap[p1.Index].inParameterCopy), Bpl.Expr.Ident(formalMap[p2.Index].inParameterCopy)));
boogiePrecondition.Add(req);
}
}
#endregion
if (options.monotonicHeap) {
#region Add free ensures for allocatedness of result (for methods that return references)
if (retVariable != null && retVariable.TypedIdent.Type == this.Heap.RefType) {
var ens = new Bpl.Ensures(true,
Bpl.Expr.Binary(Bpl.BinaryOperator.Opcode.Or,
Bpl.Expr.Binary(Bpl.BinaryOperator.Opcode.Eq,
Bpl.Expr.Ident(retVariable), Bpl.Expr.Ident(this.Heap.NullRef)),
Bpl.Expr.Select(Bpl.Expr.Ident(this.Heap.AllocVariable), Bpl.Expr.Ident(retVariable))
));
boogiePostcondition.Add(ens);
}
#endregion
#region Add free ensures for preservation of allocatedness: AllocMapImplies(old($Alloc), $Alloc) == AllocMapConst(true)
var preserveAlloc = new Bpl.Ensures(true,
Bpl.Expr.Binary(Bpl.BinaryOperator.Opcode.Eq,
new Bpl.NAryExpr(
Bpl.Token.NoToken,
new Bpl.FunctionCall(this.Heap.AllocImplies),
new Bpl.ExprSeq(
new Bpl.OldExpr(Bpl.Token.NoToken, Bpl.Expr.Ident(this.Heap.AllocVariable)),
Bpl.Expr.Ident(this.Heap.AllocVariable))),
new Bpl.NAryExpr(
Bpl.Token.NoToken,
new Bpl.FunctionCall(this.Heap.AllocConstBool),
new Bpl.ExprSeq(Bpl.Expr.True))
));
boogiePostcondition.Add(preserveAlloc);
#endregion
}
}
return procInfo;
}
/// <summary>
/// The keys are the mangled names for the ctors. That is avoid generating name conflicts in the translated
/// program. This is needed for things like System.Drawing.Rect, which was referenced in both System.Drawing v2
/// as well as System.Drawing v4. Since those assemblies are not unified, the two types are distinct, but
/// the (generated) name for the default struct ctors clash.
/// NB: This means that if there are two different types with the same full name (minus the assembly name),
/// then this will implicitly unify them. This could lead to big trouble!
/// </summary>
private Dictionary<string, ProcedureInfo> declaredStructDefaultCtors = new Dictionary<string, ProcedureInfo>();
/// <summary>
/// Struct "creation" (source code that looks like "new S()" for a struct type S) is modeled
/// by a call to the nullary "ctor" that initializes all of the structs fields to zero-
/// equivalent values. Note that the generated procedure has no contract. So if the struct
/// is defined in an assembly that is not being translated, then its behavior is unspecified.
/// </summary>
/// <param name="structType">A type reference to the value type for which the ctor should be returned.</param>
/// <returns>A unary procedure (i.e., it takes the struct value as its parameter) that initializes
/// its parameter of type <paramref name="structType"/>.
/// </returns>
public Bpl.DeclWithFormals FindOrCreateProcedureForDefaultStructCtor(ITypeReference structType) {
Contract.Requires(structType.IsValueType);
ProcedureInfo procAndFormalMap;
var typename = TranslationHelper.TurnStringIntoValidIdentifier(TypeHelper.GetTypeName(structType));
var procName = typename + ".#default_ctor";
if (!this.declaredStructDefaultCtors.TryGetValue(procName, out procAndFormalMap)) {
var tok = structType.Token();
var selfType = this.CciTypeToBoogie(structType); //new Bpl.MapType(Bpl.Token.NoToken, new Bpl.TypeVariableSeq(), new Bpl.TypeSeq(Heap.FieldType), Heap.BoxType);
var selfIn = new Bpl.Formal(tok, new Bpl.TypedIdent(tok, "$this", selfType), true);
var invars = new Bpl.Formal[] { selfIn };
var proc = new Bpl.Procedure(Bpl.Token.NoToken, procName,
new Bpl.TypeVariableSeq(),
new Bpl.VariableSeq(invars),
new Bpl.VariableSeq(), // out
new Bpl.RequiresSeq(),
new Bpl.IdentifierExprSeq(), // modifies
new Bpl.EnsuresSeq()
);
this.TranslatedProgram.TopLevelDeclarations.Add(proc);
procAndFormalMap = new ProcedureInfo(proc, new MethodParameter[0]);
this.declaredStructDefaultCtors.Add(procName, procAndFormalMap);
}
return procAndFormalMap.Decl;
}
/// <summary>
/// The keys are the mangled names for the ctors. That is avoid generating name conflicts in the translated
/// program. This is needed for things like System.Drawing.Rect, which was referenced in both System.Drawing v2
/// as well as System.Drawing v4. Since those assemblies are not unified, the two types are distinct, but
/// the (generated) name for the default struct ctors clash.
/// NB: This means that if there are two different types with the same full name (minus the assembly name),
/// then this will implicitly unify them. This could lead to big trouble!
/// </summary>
private Dictionary<string, ProcedureInfo> declaredStructCopyCtors = new Dictionary<string, ProcedureInfo>();
private Dictionary<uint, ProcedureInfo> declaredStructEqualityOperators = new Dictionary<uint, ProcedureInfo>();
/// <summary>
/// The assignment of one struct value to another is modeled by a method that makes a field-by-field
/// copy of the source of the assignment.
/// Note that the generated procedure has no contract. So if the struct
/// is defined in an assembly that is not being translated, then its behavior is unspecified.
/// </summary>
/// <param name="structType">A type reference to the value type for which the procedure should be returned.</param>
/// <returns>A binary procedure (i.e., it takes the two struct values as its parameters).
/// </returns>
public Bpl.DeclWithFormals FindOrCreateProcedureForStructCopy(ITypeReference structType) {
Contract.Requires(structType.IsValueType);
ProcedureInfo procAndFormalMap;
var typename = TranslationHelper.TurnStringIntoValidIdentifier(TypeHelper.GetTypeName(structType));
var procName = typename + ".#copy_ctor";
if (!this.declaredStructCopyCtors.TryGetValue(procName, out procAndFormalMap)) {
var tok = structType.Token();
var selfType = this.CciTypeToBoogie(structType); //new Bpl.MapType(Bpl.Token.NoToken, new Bpl.TypeVariableSeq(), new Bpl.TypeSeq(Heap.FieldType), Heap.BoxType);
var selfIn = new Bpl.Formal(tok, new Bpl.TypedIdent(tok, "this", selfType), true);
var otherOut = new Bpl.Formal(tok, new Bpl.TypedIdent(tok, "other", selfType), true);
var invars = new Bpl.Formal[] { selfIn, };
var outvars = new Bpl.Formal[] { otherOut, };
var selfInExpr = Bpl.Expr.Ident(selfIn);
var otherInExpr = Bpl.Expr.Ident(otherOut);
//var req = new Bpl.Requires(true, Bpl.Expr.Binary(Bpl.BinaryOperator.Opcode.Neq, selfInExpr, otherInExpr));
var ens = new Bpl.Ensures(true, Bpl.Expr.Binary(Bpl.BinaryOperator.Opcode.Neq, selfInExpr, otherInExpr));
var proc = new Bpl.Procedure(Bpl.Token.NoToken, procName,
new Bpl.TypeVariableSeq(),
new Bpl.VariableSeq(invars),
new Bpl.VariableSeq(outvars),
new Bpl.RequiresSeq(/*req*/),
new Bpl.IdentifierExprSeq(), // modifies
new Bpl.EnsuresSeq(ens)
);
this.TranslatedProgram.TopLevelDeclarations.Add(proc);
procAndFormalMap = new ProcedureInfo(proc, new MethodParameter[0]);
this.declaredStructCopyCtors.Add(procName, procAndFormalMap);
}
return procAndFormalMap.Decl;
}
// TODO: Fix test to return true iff method is marked with the "real" [Pure] attribute
// also, should it return true for properties and all of the other things the tools
// consider pure?
private bool IsPure(IMethodDefinition method) {
// TODO:
// This needs to wait until we get function bodies sorted out.
//bool isPropertyGetter = method.IsSpecialName && method.Name.Value.StartsWith("get_");
//if (isPropertyGetter) return true;
foreach (var a in method.Attributes) {
if (TypeHelper.GetTypeName(a.Type).EndsWith("PureAttribute")) {
return true;
}
}
return false;
}
// TODO: check method's containing type in case the entire type is a stub type.
// TODO: do a type test, not a string test for the attribute
private bool IsStubMethod(IMethodReference method, out string/*?*/ newName) {
newName = null;
var methodDefinition = method.ResolvedMethod;
foreach (var a in methodDefinition.Attributes) {
if (TypeHelper.GetTypeName(a.Type).EndsWith("StubAttribute")) {
foreach (var c in a.Arguments) {
var mdc = c as IMetadataConstant;
if (mdc != null && mdc.Type.TypeCode == PrimitiveTypeCode.String) {
newName = (string)(mdc.Value);
break;
}
}
return true;
}
}
return false;
}
public static IMethodReference Unspecialize(IMethodReference method) {
IMethodReference result = method;
var gmir = result as IGenericMethodInstanceReference;
if (gmir != null) {
result = gmir.GenericMethod;
}
var smr = result as ISpecializedMethodReference;
if (smr != null) {
result = smr.UnspecializedVersion;
}
// Temporary hack until ISpecializedMethodDefinition implements ISpecializedMethodReference
var smd = result as ISpecializedMethodDefinition;
if (smd != null) {
result = smd.UnspecializedVersion;
}
return result;
}
public static ushort ConsolidatedGenericParameterCount(ITypeReference typeReference) {
Contract.Requires(typeReference != null);
var typeDefinition = typeReference.ResolvedType;
var totalNumberOfParameters = typeDefinition.GenericParameterCount;
var nestedTypeDefinition = typeDefinition as INestedTypeDefinition;
while (nestedTypeDefinition != null) {
var containingType = nestedTypeDefinition.ContainingType.ResolvedType;
totalNumberOfParameters += containingType.GenericParameterCount;
nestedTypeDefinition = containingType as INestedTypeDefinition;
}
return totalNumberOfParameters;
}
public static ITypeReference GetUninstantiatedGenericType(ITypeReference typeReference) {
IGenericTypeInstanceReference/*?*/ genericTypeInstanceReference = typeReference as IGenericTypeInstanceReference;
if (genericTypeInstanceReference != null) return GetUninstantiatedGenericType(genericTypeInstanceReference.GenericType);
INestedTypeReference/*?*/ nestedTypeReference = typeReference as INestedTypeReference;
if (nestedTypeReference != null) {
ISpecializedNestedTypeReference/*?*/ specializedNestedType = nestedTypeReference as ISpecializedNestedTypeReference;
if (specializedNestedType != null) return specializedNestedType.UnspecializedVersion;
return nestedTypeReference;
}
return typeReference;
}
public static void GetConsolidatedTypeArguments(List<ITypeReference> consolidatedTypeArguments, ITypeReference typeReference) {
IGenericTypeInstanceReference/*?*/ genTypeInstance = typeReference as IGenericTypeInstanceReference;
if (genTypeInstance != null) {
GetConsolidatedTypeArguments(consolidatedTypeArguments, genTypeInstance.GenericType);
consolidatedTypeArguments.AddRange(genTypeInstance.GenericArguments);
return;
}
INestedTypeReference/*?*/ nestedTypeReference = typeReference as INestedTypeReference;
if (nestedTypeReference != null) GetConsolidatedTypeArguments(consolidatedTypeArguments, nestedTypeReference.ContainingType);
}
[Obsolete]
public static int GetNumberTypeParameters(IMethodDefinition method) {
return method.GenericParameterCount + ConsolidatedGenericParameterCount(method.ContainingType);
}
/// <summary>
/// Creates a fresh variable that represents the type of
/// <paramref name="type"/> in the Bpl program. I.e., its
/// value represents the expression "typeof(type)".
/// </summary>
public Bpl.Expr FindOrCreateTypeReference(ITypeReference type, bool codeContext = false) {
var gtir = type as IGenericTypeInstanceReference;
if (gtir != null) {
var genericType = FindOrDefineType(gtir.GenericType.ResolvedType);
var gArgs = new Bpl.ExprSeq();
foreach (var a in gtir.GenericArguments) {
var a_prime = FindOrCreateTypeReference(a, codeContext);
gArgs.Add(a_prime);
}
var typeExpression = new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(genericType), gArgs);
}
IGenericTypeParameter gtp = type as IGenericTypeParameter;
if (gtp != null) {
if (codeContext) {
var selectorName = gtp.Name.Value;
selectorName = TranslationHelper.TurnStringIntoValidIdentifier(selectorName);
var typeName = TypeHelper.GetTypeName(gtp.DefiningType, NameFormattingOptions.DocumentationId);
typeName = TranslationHelper.TurnStringIntoValidIdentifier(typeName);
var funcName = String.Format("{0}#{1}", selectorName, typeName);
Bpl.IToken tok = Bpl.Token.NoToken;
var identExpr = Bpl.Expr.Ident(new Bpl.LocalVariable(tok, new Bpl.TypedIdent(tok, funcName, this.Heap.TypeType)));
var funcCall = new Bpl.FunctionCall(identExpr);
var thisArg = new Bpl.IdentifierExpr(tok, this.ThisVariable);
var dynType = this.Heap.DynamicType(thisArg);
var nary = new Bpl.NAryExpr(Bpl.Token.NoToken, funcCall, new Bpl.ExprSeq(dynType));
return nary;
} else {
var formal = FindOrDefineTypeParameter(gtp);
return Bpl.Expr.Ident(formal);
}
}
IGenericMethodParameter gmp = type as IGenericMethodParameter;
if (gmp != null) {
ProcedureInfo info = FindOrCreateProcedure(methodBeingTranslated);
return Bpl.Expr.Ident(info.MethodParameter(gmp.Index));
}
ITypeReference uninstantiatedGenericType = GetUninstantiatedGenericType(type);
// Corner case: type might be a reference to the uninstantiated generic type.
// This happens, e.g., with "typeof(Dictionary<,>)".
// In that case, need to create a constant for it (because Boogie doesn't allow
// overloading by arity on functions
if (type.ResolvedType.IsGeneric && type == uninstantiatedGenericType) {
return FindOrDefineTypeConstant(type);
}
List<ITypeReference> consolidatedTypeArguments = new List<ITypeReference>();
GetConsolidatedTypeArguments(consolidatedTypeArguments, type);
if (consolidatedTypeArguments.Count > 0) {
this.FindOrCreateTypeReference(uninstantiatedGenericType);
var k = uninstantiatedGenericType.InternedKey;
var f2 = this.declaredTypeFunctions[k];
Bpl.ExprSeq args = new Bpl.ExprSeq();
foreach (ITypeReference p in consolidatedTypeArguments) {
args.Add(FindOrCreateTypeReference(p, codeContext));
}
Bpl.Expr naryExpr = new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(f2), args);
return naryExpr;
}
var f = FindOrDefineType(type.ResolvedType);
var fCall = new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(f), new Bpl.ExprSeq());
return fCall;
}
/// <summary>
/// Constants of type "Type" that represent the uninstantiated type of a generic type.
/// E.g. "Dictionary<,>".
/// </summary>
private Dictionary<uint, Bpl.Constant> declaredTypeConstants = new Dictionary<uint, Bpl.Constant>();
private Bpl.Expr FindOrDefineTypeConstant(ITypeReference type) {
Bpl.Constant c;
var k = type.InternedKey;
if (!this.declaredTypeConstants.TryGetValue(k, out c)) {
var typeName = TypeHelper.GetTypeName(type);
var i = typeName.IndexOf('`');
// assume there is just one occurrence
if (i != -1) {
typeName = typeName.Substring(0, i);
}
typeName = TranslationHelper.TurnStringIntoValidIdentifier(typeName);
var typedIdent = new Bpl.TypedIdent(Bpl.Token.NoToken, typeName, this.Heap.TypeType);
c = new Bpl.Constant(Bpl.Token.NoToken, typedIdent, true);
this.declaredTypeConstants.Add(k, c);
this.TranslatedProgram.TopLevelDeclarations.Add(c);
}
return Bpl.Expr.Ident(c);
}
private Dictionary<IGenericParameter, Bpl.Formal> declaredTypeParameters = new Dictionary<IGenericParameter, Bpl.Formal>();
public Bpl.Formal FindOrDefineTypeParameter(IGenericParameter genericParameter) {
Bpl.Formal formal;
if (!this.declaredTypeParameters.TryGetValue(genericParameter, out formal)) {
var n = genericParameter.Name.Value;
var n2 = TranslationHelper.TurnStringIntoValidIdentifier(n);
formal = new Bpl.Formal(Bpl.Token.NoToken, new Bpl.TypedIdent(Bpl.Token.NoToken, n2, this.Heap.TypeType), true);
}
return formal;
}
/// <summary>
/// Every type is represented as a function.
/// Non-generic types are nullary functions.
/// Generic types are n-ary functions, where n is the number of generic parameters.
/// </summary>
public Bpl.Function FindOrDefineType(ITypeDefinition type) {
Bpl.Function f;
var key = type.InternedKey;
if (this.declaredTypeFunctions.TryGetValue(key, out f))
return f;
var numParameters = ConsolidatedGenericParameterCount(type);
//f = this.Heap.CreateTypeFunction(type, numParameters);
string typename = TypeHelper.GetTypeName(type, NameFormattingOptions.DocumentationId);
typename = TranslationHelper.TurnStringIntoValidIdentifier(typename);
var tok = type.Token();
var inputs = new Bpl.VariableSeq();
foreach (var t in TranslationHelper.ConsolidatedGenericParameters(type)) {
var formal = FindOrDefineTypeParameter(t);
inputs.Add(formal);
}
Bpl.Variable output = new Bpl.Formal(tok, new Bpl.TypedIdent(tok, "result", this.Heap.TypeType), false);
Bpl.Function func = new Bpl.Function(tok, typename, inputs, output);
func.Attributes = new Bpl.QKeyValue(Bpl.Token.NoToken, "constructor", new List<object>(1), null);
f = func;
this.declaredTypeFunctions.Add(key, f);
this.TranslatedProgram.TopLevelDeclarations.Add(f);
DeclareParentsNew(type, f);
bool isExtern = this.assemblyBeingTranslated != null &&
!TypeHelper.GetDefiningUnitReference(type).UnitIdentity.Equals(this.assemblyBeingTranslated.UnitIdentity);
if (isExtern) {
var attrib = new Bpl.QKeyValue(Bpl.Token.NoToken, "extern", new List<object>(1), null);
f.Attributes.AddLast(attrib);
}
return f;
}
private void DeclareParentsNew(ITypeDefinition typeDefinition, Bpl.Function typeDefinitionAsBplFunction) {
List<Bpl.Expr> superTypeExprs = new List<Bpl.Expr>();
foreach (var p in typeDefinition.BaseClasses) {
superTypeExprs.Add(FindOrCreateTypeReference(p));
}
foreach (var j in typeDefinition.Interfaces) {
superTypeExprs.Add(FindOrCreateTypeReference(j));
}
var numberOfGenericParameters = typeDefinitionAsBplFunction.InParams.Length;
var qvars = new Bpl.VariableSeq();
var exprs1 = new Bpl.ExprSeq();
var exprs2 = new Bpl.ExprSeq();
var exprs3 = new Bpl.ExprSeq();
for (int i = 0; i < numberOfGenericParameters; i++) {
var t = typeDefinitionAsBplFunction.InParams[i];
qvars.Add(t);
exprs1.Add(Bpl.Expr.Ident(t));
exprs2.Add(Bpl.Expr.Ident(t));
exprs3.Add(Bpl.Expr.Ident(t));
}
// G(t,u)
var callToG1 = new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(typeDefinitionAsBplFunction), exprs1);
var callToG2 = new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(typeDefinitionAsBplFunction), exprs2);
var callToG3 = new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(typeDefinitionAsBplFunction), exprs3);
// T
Bpl.BoundVariable boundTypeVar = new Bpl.BoundVariable(Bpl.Token.NoToken, new Bpl.TypedIdent(Bpl.Token.NoToken, "$T", this.Heap.TypeType));
qvars.Add(boundTypeVar);
var lhs = new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(this.Heap.Subtype), new Bpl.ExprSeq(callToG1, Bpl.Expr.Ident(boundTypeVar)));
var rhs = Bpl.Expr.Binary(Bpl.BinaryOperator.Opcode.Eq, callToG2, Bpl.Expr.Ident(boundTypeVar));
foreach (var superTypeExpr in superTypeExprs) {
var subtype = new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(this.Heap.Subtype), new Bpl.ExprSeq(superTypeExpr, Bpl.Expr.Ident(boundTypeVar)));
rhs = Bpl.Expr.Binary(Bpl.BinaryOperator.Opcode.Or, rhs, subtype);
}
var trigger = new Bpl.Trigger(Bpl.Token.NoToken, true, new Bpl.ExprSeq(new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(this.Heap.Subtype), new Bpl.ExprSeq(callToG3, Bpl.Expr.Ident(boundTypeVar)))));
var forall = new Bpl.ForallExpr(Bpl.Token.NoToken, new Bpl.TypeVariableSeq(), qvars, null, trigger, Bpl.Expr.Binary(Bpl.BinaryOperator.Opcode.Iff, lhs, rhs));
this.TranslatedProgram.TopLevelDeclarations.Add(new Bpl.Axiom(Bpl.Token.NoToken, forall));
}
private void DeclareParents(ITypeDefinition typeDefinition, Bpl.Function typeDefinitionAsBplFunction) {
foreach (var p in typeDefinition.BaseClasses) {
DeclareSuperType(typeDefinitionAsBplFunction, p);
}
foreach (var j in typeDefinition.Interfaces) {
DeclareSuperType(typeDefinitionAsBplFunction, j);
}
return;
}
private void DeclareSuperType(Bpl.Function typeDefinitionAsBplFunction, ITypeReference superType) {
var superTypeExpr = FindOrCreateTypeReference(superType);
var numberOfGenericParameters = typeDefinitionAsBplFunction.InParams.Length;
var qvars = new Bpl.VariableSeq();
var exprs = new Bpl.ExprSeq();
for (int i = 0; i < numberOfGenericParameters; i++) {
var t = typeDefinitionAsBplFunction.InParams[i];
qvars.Add(t);
var identForT = Bpl.Expr.Ident(t);
exprs.Add(identForT);
}
// G(t,u)
var callToG = new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(typeDefinitionAsBplFunction), exprs);
// Subtype(G(t,u), super)
Bpl.Expr subtype = new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(this.Heap.Subtype), new Bpl.ExprSeq(callToG, superTypeExpr));
Bpl.Expr disjointSubtree = null;
var isDisjoint = !superType.ResolvedType.IsInterface;
if (isDisjoint) {
// DisjointSubtree(G(t,u), super)
disjointSubtree = new Bpl.NAryExpr(Bpl.Token.NoToken, new Bpl.FunctionCall(this.Heap.DisjointSubtree), new Bpl.ExprSeq(callToG, superTypeExpr));
}
if (0 < numberOfGenericParameters) {
// (forall t : Type, u : Type :: { G(t,u) } Subtype(G(t,u), super))
var trigger = new Bpl.Trigger(Bpl.Token.NoToken, true, new Bpl.ExprSeq(callToG));
var forall = new Bpl.ForallExpr(Bpl.Token.NoToken, new Bpl.TypeVariableSeq(), qvars, null, trigger, subtype);
subtype = forall;
if (isDisjoint) {
// (forall t : Type, u : Type :: { G(t,u) } DisjointSubtree(G(t,u), super))
disjointSubtree = new Bpl.ForallExpr(Bpl.Token.NoToken, new Bpl.TypeVariableSeq(), qvars, null, trigger, disjointSubtree);
}
}
this.TranslatedProgram.TopLevelDeclarations.Add(new Bpl.Axiom(Bpl.Token.NoToken, subtype));
if (isDisjoint) {
this.TranslatedProgram.TopLevelDeclarations.Add(new Bpl.Axiom(Bpl.Token.NoToken, disjointSubtree));
}
}
private List<Bpl.ConstantParent> GetParents(ITypeDefinition typeDefinition, out List<ITypeReference> structuralParents) {
var parents = new List<Bpl.ConstantParent>();
structuralParents = new List<ITypeReference>();
foreach (var p in typeDefinition.BaseClasses) {
if (p is IGenericTypeInstanceReference) {
structuralParents.Add(p);
}
else {
var v = (Bpl.IdentifierExpr)FindOrCreateTypeReference(p);
parents.Add(new Bpl.ConstantParent(v, true));
}
}
foreach (var j in typeDefinition.Interfaces) {
if (j is IGenericTypeInstanceReference) {
structuralParents.Add(j);
}
else {
var v = (Bpl.IdentifierExpr)FindOrCreateTypeReference(j);
parents.Add(new Bpl.ConstantParent(v, false));
}
}
return parents;
}
/// <summary>
/// The keys to the table are the interned key of the type.
/// </summary>
private Dictionary<uint, Bpl.Function> declaredTypeFunctions = new Dictionary<uint, Bpl.Function>();
private List<Bpl.Function> childFunctions = new List<Bpl.Function>();
class MethodComparer : IEqualityComparer<IMethodReference> {
public bool Equals(IMethodReference x, IMethodReference y) {
return x.InternedKey == y.InternedKey;
}
public int GetHashCode(IMethodReference obj) {
return (int)obj.InternedKey;
}
}
/// <summary>
/// The keys to the table are the methods. (Equality on keys is determined by their InternedKey.)
/// The values are pairs: first element is the procedure,
/// second element is the formal map for the procedure
/// </summary>
private Dictionary<IMethodReference, ProcedureInfo> declaredMethods = new Dictionary<IMethodReference, ProcedureInfo>(new MethodComparer());
/// <summary>
/// The values in this table are the procedures
/// defined in the program created by the heap in the Sink's ctor.
/// </summary>
public Dictionary<string, ProcedureInfo> initiallyDeclaredProcedures = new Dictionary<string, ProcedureInfo>();
public void BeginMethod(ITypeReference containingType) {
this.localVarMap = new Dictionary<string, Bpl.LocalVariable>();
this.localCounter = 0;
this.methodBeingTranslated = null;
var selfType = CciTypeToBoogie(containingType);
this.thisVariable = new Bpl.Formal(Bpl.Token.NoToken, new Bpl.TypedIdent(Bpl.Token.NoToken, "$this", selfType), true);
}
public Dictionary<IName, int> cciLabels;
public int FindOrCreateCciLabelIdentifier(IName label) {
int v;
if (!cciLabels.TryGetValue(label, out v)) {
v = cciLabels.Count;
cciLabels[label] = v;
}
return v;
}
public Dictionary<ITryCatchFinallyStatement, int> tryCatchFinallyIdentifiers;
public string FindOrCreateCatchLabel(ITryCatchFinallyStatement stmt) {
int id;
if (!tryCatchFinallyIdentifiers.TryGetValue(stmt, out id)) {
id = tryCatchFinallyIdentifiers.Count;
tryCatchFinallyIdentifiers[stmt] = id;
}
return "catch" + id;
}
public string FindOrCreateFinallyLabel(ITryCatchFinallyStatement stmt) {
int id;
if (!tryCatchFinallyIdentifiers.TryGetValue(stmt, out id)) {
id = tryCatchFinallyIdentifiers.Count;
tryCatchFinallyIdentifiers[stmt] = id;
}
return "finally" + id;
}
public string FindOrCreateContinuationLabel(ITryCatchFinallyStatement stmt) {
int id;
if (!tryCatchFinallyIdentifiers.TryGetValue(stmt, out id)) {
id = tryCatchFinallyIdentifiers.Count;
tryCatchFinallyIdentifiers[stmt] = id;
}
return "continuation" + id;
}
MostNestedTryStatementTraverser mostNestedTryStatementTraverser;
public ITryCatchFinallyStatement MostNestedTryStatement(IName label) {
return mostNestedTryStatementTraverser.MostNestedTryStatement(label);
}
Dictionary<ITryCatchFinallyStatement, List<string>> escapingGotoEdges;
public void AddEscapingEdge(ITryCatchFinallyStatement tryCatchFinallyStatement, out int labelId, out string label) {
List<string> edges = null;
if (!escapingGotoEdges.ContainsKey(tryCatchFinallyStatement)) {
escapingGotoEdges[tryCatchFinallyStatement] = new List<string>();
}
edges = escapingGotoEdges[tryCatchFinallyStatement];
label = this.FindOrCreateFinallyLabel(tryCatchFinallyStatement) + "_" + edges.Count;
labelId = edges.Count;
edges.Add(label);
}
public List<string> EscapingEdges(ITryCatchFinallyStatement tryCatchFinallyStatement) {
if (!escapingGotoEdges.ContainsKey(tryCatchFinallyStatement)) {
escapingGotoEdges[tryCatchFinallyStatement] = new List<string>();
}
return escapingGotoEdges[tryCatchFinallyStatement];
}
public enum TryCatchFinallyContext { InTry, InCatch, InFinally };
public List<Tuple<ITryCatchFinallyStatement, TryCatchFinallyContext>> nestedTryCatchFinallyStatements;
IMethodDefinition methodBeingTranslated;
public IMethodDefinition getMethodBeingTranslated() {
return methodBeingTranslated;
}
public void BeginMethod(IMethodDefinition method) {
TranslationHelper.tmpVarCounter = 0;
this.BeginMethod(method.ContainingType);
this.methodBeingTranslated = method;
this.cciLabels = new Dictionary<IName, int>();
this.tryCatchFinallyIdentifiers = new Dictionary<ITryCatchFinallyStatement, int>();
mostNestedTryStatementTraverser = new MostNestedTryStatementTraverser();
escapingGotoEdges = new Dictionary<ITryCatchFinallyStatement, List<string>>();
nestedTryCatchFinallyStatements = new List<Tuple<ITryCatchFinallyStatement, TryCatchFinallyContext>>();
mostNestedTryStatementTraverser.Traverse(method.Body);
}
public void BeginAssembly(IAssembly assembly) {
this.assemblyBeingTranslated = assembly;
}
public void EndAssembly(IAssembly assembly) {
this.assemblyBeingTranslated = null;
}
private IAssembly/*?*/ assemblyBeingTranslated;
public Dictionary<uint, Tuple<ITypeDefinition, HashSet<IMethodDefinition>>> delegateTypeToDelegates =
new Dictionary<uint, Tuple<ITypeDefinition, HashSet<IMethodDefinition>>>();
public void AddDelegate(ITypeDefinition type, IMethodDefinition defn) {
if (type == Dummy.Type) {
}
uint key = type.InternedKey;
if (!delegateTypeToDelegates.ContainsKey(key))
delegateTypeToDelegates[key] = new Tuple<ITypeDefinition, HashSet<IMethodDefinition>>(type, new HashSet<IMethodDefinition>());
FindOrCreateProcedure(defn);
delegateTypeToDelegates[key].Item2.Add(defn);
}
public void AddDelegateType(ITypeDefinition type) {
if (type == Dummy.Type) {
}
uint key = type.InternedKey;
if (!delegateTypeToDelegates.ContainsKey(key))
delegateTypeToDelegates[key] = new Tuple<ITypeDefinition, HashSet<IMethodDefinition>>(type, new HashSet<IMethodDefinition>());
}
private Dictionary<IMethodDefinition, Bpl.Constant> delegateMethods = new Dictionary<IMethodDefinition, Bpl.Constant>();
internal IContractAwareHost host;
public Bpl.Constant FindOrCreateDelegateMethodConstant(IMethodDefinition defn) {
if (delegateMethods.ContainsKey(defn))
return delegateMethods[defn];
string methodName = TranslationHelper.CreateUniqueMethodName(defn);
var typedIdent = new Bpl.TypedIdent(Bpl.Token.NoToken, methodName, Bpl.Type.Int);
var constant = new Bpl.Constant(Bpl.Token.NoToken, typedIdent, true);
this.TranslatedProgram.TopLevelDeclarations.Add(constant);
delegateMethods[defn] = constant;
return constant;
}
public bool TranslateType(ITypeReference t) {
if (this.exemptionList == null)
return !this.whiteList;
var fullName = TypeHelper.GetTypeName(t);
var fullerName = "[" + TypeHelper.GetDefiningUnitReference(t).Name.Value + "]" + fullName;
foreach (Regex r in this.exemptionList) {
Match m = r.Match(fullName);
if (m.Success)
return this.whiteList;
m = r.Match(fullerName);
if (m.Success)
return this.whiteList;
}
return !this.whiteList;
}
// TODO: get full namespace name from a namespace definition
//public bool TranslateNamespace(INamespaceDefinition nameSpace) {
// if (this.exemptionList == null)
// return !this.whiteList;
// var fullName = TypeHelper.GetNamespaceName(nameSpace, NameFormattingOptions.None);
// foreach (Regex r in this.exemptionList) {
// Match m = r.Match(fullName);
// if (m.Success)
// return this.whiteList;
// }
// return !this.whiteList;
//}
internal void CreateIdentifierCorrespondenceTable(string baseFileName) {
using (var writer = new StreamWriter(baseFileName + "_names.txt")) {
foreach (var pair in this.declaredMethods) {
var m = pair.Key;
var mName = MemberHelper.GetMethodSignature(m, NameFormattingOptions.DocumentationId);
var proc = pair.Value;
writer.WriteLine("{0}\t\t\t{1}", mName, proc.Decl.Name);
}
foreach (var pair in this.declaredFields) {
var f = pair.Key;
var fName = MemberHelper.GetMemberSignature(f, NameFormattingOptions.DocumentationId);
var variable = pair.Value;
writer.WriteLine("{0}\t\t\t{1}", fName, variable.Name);
}
}
}
private int uniqueNumberSeed;
public int UniqueNumberAcrossAllAssemblies {
get {
return uniqueNumberSeed++;
}
}
}
}
|