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 | ------------------------------------------------------------------------------
-- Copyright (C) 2020 by Heisenbug Ltd. (gh+spat@heisenbug.eu)
--
-- This work is free. You can redistribute it and/or modify it under the
-- terms of the Do What The Fuck You Want To Public License, Version 2,
-- as published by Sam Hocevar. See the LICENSE file for more details.
------------------------------------------------------------------------------
pragma License (Unrestricted);
------------------------------------------------------------------------------
--
-- SPARK Proof Analysis Tool
--
-- S.P.A.T. - Map information from JSON data into internal data structure.
--
-- Collect file contents.
--
------------------------------------------------------------------------------
private with Ada.Tags;
limited private with Ada.Containers.Hashed_Maps;
limited private with Ada.Containers.Hashed_Sets;
with SPAT.Entity.Tree;
limited with SPAT.Strings;
with SPAT.Timing_Item;
package SPAT.Spark_Info is
type Sorting_Criterion is
(None,
Name, -- Alphabetical
Max_Time, -- Maximum (accumulated) proof time
Max_Success_Time, -- Minimum time for successful proof
Max_Steps, -- Maximum (accumulated) proof steps
Max_Success_Steps -- Minimum steps for successful proof
);
type T is tagged limited private;
-- Binary representation of the information obtained from a .spark JSON
-- file.
---------------------------------------------------------------------------
-- Map_Spark_File
--
-- Traverses through the JSON data given in Root and translates it into
-- the data structure given in This.
--
-- Must be called first before the below subroutines can be called.
---------------------------------------------------------------------------
not overriding
procedure Map_Spark_File (This : in out T;
File : in SPARK_File_Name;
Root : in JSON_Value);
---------------------------------------------------------------------------
-- List_All_Entities
--
-- Returns an (optionally sorted) list of all entities (source unit names)
-- currently stored in This.
---------------------------------------------------------------------------
not overriding
function List_All_Entities
(This : in T;
Sort_By : in Sorting_Criterion := Name) return Strings.Entity_Names;
---------------------------------------------------------------------------
-- List_All_Files
--
-- Returns an (optionally sorted) list of the names of all files that have
-- been parsed into This.
---------------------------------------------------------------------------
not overriding
function List_All_Files
(This : in T;
Sort_By : in Sorting_Criterion := None) return Strings.SPARK_File_Names;
---------------------------------------------------------------------------
-- Num_Flows
--
-- Return the total number of flows (flow items) collected.
---------------------------------------------------------------------------
not overriding
function Num_Flows (This : not null access T)
return Ada.Containers.Count_Type;
---------------------------------------------------------------------------
-- Flow_Time
--
-- Reported time taken for the flow analysis for File.
---------------------------------------------------------------------------
not overriding
function Flow_Time (This : in T;
File : in SPARK_File_Name) return Duration;
---------------------------------------------------------------------------
-- Num_Proofs
--
-- Return the total number of proofs collected.
---------------------------------------------------------------------------
not overriding
function Num_Proofs (This : not null access T)
return Ada.Containers.Count_Type;
---------------------------------------------------------------------------
-- Proof_Time
--
-- Reported time taken for all the proofs for File.
---------------------------------------------------------------------------
not overriding
function Proof_Time (This : in T;
File : in SPARK_File_Name) return Duration;
---------------------------------------------------------------------------
-- Max_Proof_Steps
---------------------------------------------------------------------------
not overriding
function Max_Proof_Steps (This : in T;
File : in SPARK_File_Name) return Prover_Steps;
---------------------------------------------------------------------------
-- Max_Proof_Time
---------------------------------------------------------------------------
not overriding
function Max_Proof_Time (This : in T;
File : in SPARK_File_Name) return Duration;
---------------------------------------------------------------------------
-- Max_Success_Proof_Steps
--
-- Reported steps for the longest successful proof.
---------------------------------------------------------------------------
not overriding
function Max_Success_Proof_Steps
(This : in T;
File : in SPARK_File_Name) return Prover_Steps;
---------------------------------------------------------------------------
-- Max_Success_Proof_Time
--
-- Reported time for the longest successful proof.
---------------------------------------------------------------------------
not overriding
function Max_Success_Proof_Time (This : in T;
File : in SPARK_File_Name) return Duration;
---------------------------------------------------------------------------
-- Max_Proof_Steps
--
-- Maximum steps taken for a single proof for Entity.
---------------------------------------------------------------------------
not overriding
function Max_Proof_Steps (This : in T;
Entity : in Entity_Name) return Prover_Steps;
---------------------------------------------------------------------------
-- Max_Success_Proof_Steps
--
-- Maximum steps taken for a single successful proof for Entity.
---------------------------------------------------------------------------
not overriding
function Max_Success_Proof_Steps
(This : in T;
Entity : in Entity_Name) return Prover_Steps;
---------------------------------------------------------------------------
-- Max_Proof_Time
--
-- Maximum time taken for a single proof for Entity.
---------------------------------------------------------------------------
not overriding
function Max_Proof_Time (This : in T;
Entity : in Entity_Name) return Duration;
---------------------------------------------------------------------------
-- Max_Success_Proof_Time
--
-- Maximum time taken for a single successful proof for Entity,
-- considering all verification conditions and proof paths in them.
---------------------------------------------------------------------------
not overriding
function Max_Success_Proof_Time (This : in T;
Entity : in Entity_Name) return Duration;
---------------------------------------------------------------------------
-- Total_Proof_Time
--
-- Total (accumulated) time taken for all proofs for Entity.
---------------------------------------------------------------------------
not overriding
function Total_Proof_Time (This : in T;
Entity : in Entity_Name) return Duration;
---------------------------------------------------------------------------
-- Proof_List
--
-- List of proof items for given Entity, sorted by time.
---------------------------------------------------------------------------
not overriding
function Proof_Tree
(This : in T;
Entity : in Entity_Name) return SPAT.Entity.Tree.Forward_Iterator'Class;
---------------------------------------------------------------------------
-- Iterate_Children
---------------------------------------------------------------------------
not overriding
function Iterate_Children (This : in T;
Entity : in Entity_Name;
Position : in SPAT.Entity.Tree.Cursor)
return SPAT.Entity.Tree.Forward_Iterator'Class;
---------------------------------------------------------------------------
-- Has_Failed_Attempts
--
-- Returns True if any of the proof attempts for Entity do not have a
-- "Valid" result.
---------------------------------------------------------------------------
not overriding
function Has_Failed_Attempts (This : in T;
Entity : in Entity_Name) return Boolean;
---------------------------------------------------------------------------
-- Has_Unjustified_Attempts
--
-- Returns True if some of the proof attempts for Entity are not "Valid"
-- and there is no justification message.
---------------------------------------------------------------------------
not overriding
function Has_Unjustified_Attempts
(This : in T;
Entity : in Entity_Name) return Boolean;
---------------------------------------------------------------------------
-- Has_Unproved_Attempts
--
-- Returns True if some of the proof attempts for Entity do have a "Valid"
-- result.
---------------------------------------------------------------------------
not overriding
function Has_Unproved_Attempts (This : in T;
Entity : in Entity_Name) return Boolean;
---------------------------------------------------------------------------
-- Print_Trees
--
-- Debugging subroutine to print the trees to Standard_Output. Only does
-- something if the Verbose flag is set.
---------------------------------------------------------------------------
not overriding
procedure Print_Trees (This : in T);
private
type Source_Lines_Sentinel is new Entity.T with null record;
---------------------------------------------------------------------------
-- Image
---------------------------------------------------------------------------
overriding
function Image (This : in Source_Lines_Sentinel) return String is
(Ada.Tags.External_Tag (T => Source_Lines_Sentinel'Class (This)'Tag) & ": ()");
Empty_Source_Lines_Sentinel : constant Source_Lines_Sentinel :=
(Entity.T with null record);
type Flows_Sentinel is new Entity.T with null record;
---------------------------------------------------------------------------
-- Image
---------------------------------------------------------------------------
overriding
function Image (This : in Flows_Sentinel) return String is
(Ada.Tags.External_Tag (T => Flows_Sentinel'Class (This)'Tag) & ": ()");
Empty_Flows_Sentinel : constant Flows_Sentinel :=
(Entity.T with null record);
type Proof_Cache is
record
Max_Proof_Time : Duration;
Max_Proof_Steps : Prover_Steps;
Max_Success_Proof_Time : Duration;
Max_Success_Proof_Steps : Prover_Steps;
Total_Proof_Time : Duration;
Has_Failed_Attempts : Boolean;
Has_Unproved_Attempts : Boolean;
Has_Unjustified_Attempts : Boolean;
end record;
type Proofs_Sentinel is new Entity.T with
record
Cache : Proof_Cache;
end record;
---------------------------------------------------------------------------
-- Image
---------------------------------------------------------------------------
overriding
function Image (This : in Proofs_Sentinel) return String is
(Ada.Tags.External_Tag (T => Proofs_Sentinel'Class (This)'Tag) & ":" &
"(Max_Proof_Time =>" & This.Cache.Max_Proof_Time'Image &
", Max_Proof_Steps =>" & This.Cache.Max_Proof_Steps'Image &
", Max_Success_Proof_Time =>" & This.Cache.Max_Success_Proof_Time'Image &
", Max_Success_Proof_Steps =>" & This.Cache.Max_Success_Proof_Steps'Image &
", Total_Proof_Time => " & This.Cache.Total_Proof_Time'Image &
", Has_Failed_Attempts => " & This.Cache.Has_Failed_Attempts'Image &
", Has_Unproved_Attempts => " & This.Cache.Has_Unproved_Attempts'Image &
", Has_Unjustified_Attempts => " & This.Cache.Has_Unjustified_Attempts'Image &
")");
Empty_Proofs_Sentinel : constant Proofs_Sentinel :=
(Entity.T with
Cache => Proof_Cache'(Max_Proof_Time => 0.0,
Max_Proof_Steps => 0,
Max_Success_Proof_Time => 0.0,
Max_Success_Proof_Steps => 0,
Total_Proof_Time => 0.0,
Has_Failed_Attempts => False,
Has_Unproved_Attempts => False,
Has_Unjustified_Attempts => False));
-- Ordered set of known filenames. Used to build a cross reference from
-- an entity to the .spark file it has been found in.
package File_Sets is new
Ada.Containers.Hashed_Sets (Element_Type => SPARK_File_Name,
Hash => SPAT.Hash,
Equivalent_Elements => "=",
"=" => "=");
-- Type representing a source (file) entity.
type Analyzed_Entity is
record
SPARK_File : File_Sets.Cursor; -- File the entity was found in.
The_Tree : Entity.Tree.T; -- Holds all entities.
Source_Lines : Entity.Tree.Cursor; -- Currently unused.
Flows : Entity.Tree.Cursor; -- List of Flow_Items
Proofs : Entity.Tree.Cursor; -- List of Proof_Items
end record;
-- Entity_Name -> Analyzed_Entity mapping
package Analyzed_Entities is new
Ada.Containers.Hashed_Maps (Key_Type => Entity_Name,
Element_Type => Analyzed_Entity,
Hash => Hash,
Equivalent_Keys => "=");
-- File_Name -> Timings mapping
package File_Timings is new
Ada.Containers.Hashed_Maps (Key_Type => SPARK_File_Name,
Element_Type => Timing_Item.T,
Hash => Hash,
Equivalent_Keys => "=",
"=" => Timing_Item."=");
-- Cached information for calls to Max_Proof_Time and Max_Success_Proof_Time
-- on files.
type Cache_Info is
record
Max_Success_Proof_Time : Duration;
Max_Success_Proof_Steps : Prover_Steps;
Max_Proof_Time : Duration;
Max_Proof_Steps : Prover_Steps;
end record;
package File_Cached_Info is new
Ada.Containers.Hashed_Maps (Key_Type => SPARK_File_Name,
Element_Type => Cache_Info,
Hash => Hash,
Equivalent_Keys => "=",
"=" => "=");
type T is tagged limited
record
Files : File_Sets.Set;
Entities : Analyzed_Entities.Map; -- The list of entities.
Timings : File_Timings.Map; -- The "timings" block for a file.
-- Cached data
Cached : File_Cached_Info.Map; -- Info per file
Flow_Count : Ada.Containers.Count_Type'Base;
Proof_Count : Ada.Containers.Count_Type'Base;
end record;
end SPAT.Spark_Info;
|