/
analysis.file.m
1053 lines (922 loc) · 37.7 KB
/
analysis.file.m
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
%-----------------------------------------------------------------------------%
% vim: ft=mercury ts=4 sw=4 et
%-----------------------------------------------------------------------------%
% Copyright (C) 2003, 2005-2011 The University of Melbourne.
% This file may only be copied under the terms of the GNU Library General
% Public License - see the file COPYING.LIB in the Mercury distribution.
%-----------------------------------------------------------------------------%
%
% File: analysis.file.m
% Main author: stayl, wangp.
%
% This module deals with the on-disk representations of the analysis registry
% and associated files.
%
%-----------------------------------------------------------------------------%
:- module analysis.file.
:- interface.
:- import_module libs.
:- import_module libs.globals.
% read_module_overall_status(Compiler, Globals, ModuleName,
% MaybeModuleStatus, !IO)
%
% Read the overall status of a module from its `.analysis_status' file.
% If the module has outstanding requests, then an overall status of
% `optimal' is downgraded to `suboptimal'.
%
:- pred read_module_overall_status(Compiler::in, globals::in, module_name::in,
analysis_status::out, io::di, io::uo) is det <= compiler(Compiler).
% write_module_overall_status(AnalysisInfo, Globals, ModuleName,
% ModuleStatus, !IO)
%
% Write the status of a module to its `.analysis_status' file.
%
:- pred write_module_overall_status(analysis_info::in, globals::in,
module_name::in, analysis_status::in, io::di, io::uo) is det.
% read_module_analysis_results(AnalysisInfo, Globals, ModuleName,
% AnalysisResults, !IO)
%
% Read the analysis results from a `.analysis' file,
% or from the analysis file cache (if enabled, and the cache file is
% up-to-date).
%
:- pred read_module_analysis_results(analysis_info::in, globals::in,
module_name::in, module_analysis_map(some_analysis_result)::out,
io::di, io::uo) is det.
% write_module_analysis_results(AnalysisInfo, Globals, ModuleName,
% AnalysisResults, !IO)
%
% Write the analysis results for a module to its `.analysis' file.
% Optionally, also write the cache copy of the analysis file.
%
:- pred write_module_analysis_results(analysis_info::in, globals::in,
module_name::in, module_analysis_map(some_analysis_result)::in,
io::di, io::uo) is det.
% read_module_analysis_requests(AnalysisInfo, Globals, ModuleName,
% ModuleRequests, !IO)
%
% Read outstanding analysis requests to a module from disk.
%
:- pred read_module_analysis_requests(analysis_info::in, globals::in,
module_name::in, module_analysis_map(analysis_request)::out,
io::di, io::uo) is det.
% write_module_analysis_requests(AnalysisInfo, Globals, ModuleName,
% ModuleRequests, !IO)
%
% Write outstanding analysis requests for a module to disk.
%
:- pred write_module_analysis_requests(analysis_info::in, globals::in,
module_name::in, module_analysis_map(analysis_request)::in,
io::di, io::uo) is det.
% read_module_imdg(AnalysisInfo, Globals, ModuleName, ModuleEntries, !IO)
%
% Read the intermodule dependencies graph entries for a module from disk.
%
:- pred read_module_imdg(analysis_info::in, globals::in, module_name::in,
module_analysis_map(imdg_arc)::out, io::di, io::uo) is det.
% write_module_imdg(AnalysisInfo, Globals, ModuleName, ModuleEntries, !IO)
%
% Write the intermodule dependencies graph entries for a module to disk.
%
:- pred write_module_imdg(analysis_info::in, globals::in, module_name::in,
module_analysis_map(imdg_arc)::in, io::di, io::uo) is det.
% empty_request_file(AnalysisInfo, Globals, ModuleName, !IO)
%
% Delete the file containing outstanding analysis requests for a module.
% This means all the analysis requests should have been satisfied already.
%
:- pred empty_request_file(analysis_info::in, globals::in, module_name::in,
io::di, io::uo) is det.
%-----------------------------------------------------------------------------%
%-----------------------------------------------------------------------------%
:- implementation.
:- import_module libs.options.
:- import_module libs.pickle.
:- import_module parse_tree.
:- import_module parse_tree.module_cmds. % XXX unwanted dependency
:- import_module parse_tree.parse_sym_name.
:- import_module parse_tree.prog_out.
:- import_module bool.
:- import_module char.
:- import_module dir.
:- import_module exception.
:- import_module parser.
:- import_module require.
:- import_module string.
:- import_module term.
:- import_module term_io.
:- import_module type_desc.
:- import_module univ.
:- import_module varset.
%-----------------------------------------------------------------------------%
% The format of an analysis result file is:
%
% version_number.
% analysis_name(analysis_version, func_id, call_pattern, answer_pattern,
% result_status).
%
% where func_id = p(name, arity, mode_id).
% or func_id = f(name, arity, mode_id).
% An .analysis_status file contains a single line, which is one of:
%
% optimal.
% suboptimal.
% invalid.
%
% A missing file is equivalent to `optimal'.
% The format of an IMDG file is:
%
% version_number.
% calling_module -> analysis_name(analysis_version, func_id, call_pattern).
% The format of an analysis request file is:
%
% version_number.
% calling_module -> analysis_name(analysis_version, func_id, call_pattern).
:- type invalid_analysis_file
---> invalid_analysis_file(string).
:- func version_number = int.
version_number = 6.
:- func analysis_registry_suffix = string.
analysis_registry_suffix = ".analysis".
:- func analysis_registry_status_suffix = string.
analysis_registry_status_suffix = ".analysis_status".
:- func imdg_suffix = string.
imdg_suffix = ".imdg".
:- func request_suffix = string.
request_suffix = ".request".
%-----------------------------------------------------------------------------%
:- pred analysis_status_to_string(analysis_status, string).
:- mode analysis_status_to_string(in, out) is det.
:- mode analysis_status_to_string(out, in) is semidet.
analysis_status_to_string(invalid, "invalid").
analysis_status_to_string(suboptimal, "suboptimal").
analysis_status_to_string(optimal, "optimal").
%-----------------------------------------------------------------------------%
%
% Reading.
%
:- type parse_entry(T) == pred(term, T, T).
:- inst parse_entry == (pred(in, in, out) is det).
read_module_overall_status(Compiler, Globals, ModuleName, ModuleStatus, !IO) :-
module_name_to_read_file_name(Compiler, Globals, ModuleName,
analysis_registry_status_suffix, MaybeFileName, !IO),
(
MaybeFileName = ok(FileName),
read_module_overall_status_2(FileName, ModuleStatus0, !IO)
;
MaybeFileName = error(_),
% Missing file means optimal. We don't install `.analysis_status' files
% when installing libraries, for example.
ModuleStatus0 = optimal
),
(
ModuleStatus0 = optimal,
module_name_to_read_file_name(Compiler, Globals, ModuleName,
request_suffix, MaybeRequestFileName, !IO),
(
% There are outstanding requests for this module.
MaybeRequestFileName = ok(_),
ModuleStatus = suboptimal
;
MaybeRequestFileName = error(_),
ModuleStatus = ModuleStatus0
)
;
( ModuleStatus0 = suboptimal
; ModuleStatus0 = invalid
),
ModuleStatus = ModuleStatus0
).
:- pred read_module_overall_status_2(string::in, analysis_status::out,
io::di, io::uo) is det.
read_module_overall_status_2(FileName, ModuleStatus, !IO) :-
io.open_input(FileName, OpenResult, !IO),
(
OpenResult = ok(Stream),
io.read_line_as_string(Stream, ReadResult, !IO),
io.close_input(Stream, !IO),
(
ReadResult = ok(String),
( if string.prefix(String, "optimal.") then
ModuleStatus = optimal
else if string.prefix(String, "suboptimal.") then
ModuleStatus = suboptimal
else if string.prefix(String, "invalid.") then
ModuleStatus = invalid
else
unexpected($module, $pred, "unexpected line")
)
;
ReadResult = eof,
unexpected($module, $pred, "unexpected eof")
;
ReadResult = error(IOError),
unexpected($module, $pred, io.error_message(IOError))
)
;
OpenResult = error(IOError),
unexpected($module, $pred, io.error_message(IOError))
).
%-----------------------------------------------------------------------------%
read_module_analysis_results(Info, Globals, ModuleName, ModuleResults, !IO) :-
% If the module's overall status is `invalid', then at least one of its
% results is invalid. However, we can't just discard the results,
% as we want to know which results change after we reanalyse the module.
Compiler = Info ^ compiler,
module_name_to_read_file_name(Compiler, Globals, ModuleName,
analysis_registry_suffix, MaybeAnalysisFileName, !IO),
(
MaybeAnalysisFileName = ok(AnalysisFileName),
% If analysis file caching is enabled, and the cache file exists
% and is up-to-date, then read from the cache instead.
globals.lookup_string_option(Globals, analysis_file_cache_dir,
CacheDir),
( if CacheDir = "" then
read_module_analysis_results_2(Compiler, AnalysisFileName,
ModuleResults, !IO)
else
CacheFileName = make_cache_filename(CacheDir, AnalysisFileName),
io.file_modification_time(AnalysisFileName, AnalysisTimeResult,
!IO),
io.file_modification_time(CacheFileName, CacheTimeResult, !IO),
( if
AnalysisTimeResult = ok(AnalysisTime),
CacheTimeResult = ok(CacheTime),
CacheTime @>= AnalysisTime
then
Unpicklers = init_analysis_unpicklers(Compiler),
unpickle_from_file(Unpicklers, CacheFileName, UnpickleResult,
!IO),
(
UnpickleResult = ok(ModuleResults)
;
UnpickleResult = error(Error),
io.write_string("Error reading ", !IO),
io.write_string(CacheFileName, !IO),
io.write_string(": ", !IO),
io.write_string(io.error_message(Error), !IO),
io.nl(!IO),
read_module_analysis_results_2(Compiler, AnalysisFileName,
ModuleResults, !IO),
write_analysis_cache_file(CacheFileName, ModuleResults,
!IO)
)
else
read_module_analysis_results_2(Compiler, AnalysisFileName,
ModuleResults, !IO),
write_analysis_cache_file(CacheFileName, ModuleResults, !IO)
)
)
;
MaybeAnalysisFileName = error(_),
ModuleResults = map.init
).
:- pred read_module_analysis_results_2(Compiler::in, string::in,
module_analysis_map(some_analysis_result)::out, io::di, io::uo) is det
<= compiler(Compiler).
read_module_analysis_results_2(Compiler, AnalysisFileName, ModuleResults,
!IO) :-
ModuleResults0 = map.init,
io.open_input(AnalysisFileName, OpenResult, !IO),
(
OpenResult = ok(Stream),
debug_msg((pred(!.IO::di, !:IO::uo) is det :-
io.write_string("% Reading analysis registry file ", !IO),
io.write_string(AnalysisFileName, !IO),
io.nl(!IO)
), !IO),
check_analysis_file_version_number(Stream, !IO),
promise_equivalent_solutions [Results, !:IO] (
try_io(read_analysis_file_2(Stream, parse_result_entry(Compiler),
ModuleResults0), Results, !IO)
),
io.close_input(Stream, !IO),
(
Results = succeeded(ModuleResults)
;
Results = exception(_),
rethrow(Results)
)
;
OpenResult = error(_),
debug_msg((pred(!.IO::di, !:IO::uo) is det :-
io.write_string("% Error reading analysis registry file: ", !IO),
io.write_string(AnalysisFileName, !IO),
io.nl(!IO)
), !IO),
ModuleResults = ModuleResults0
).
:- pred parse_result_entry(Compiler::in, term::in,
module_analysis_map(some_analysis_result)::in,
module_analysis_map(some_analysis_result)::out) is det
<= compiler(Compiler).
parse_result_entry(Compiler, Term, !Results) :-
( if
Term = term.functor(term.atom(AnalysisName),
[VersionNumberTerm, FuncIdTerm,
CallPatternTerm, AnswerPatternTerm, StatusTerm], _),
StatusTerm = term.functor(term.atom(StatusString), [], _),
analyses(Compiler, AnalysisName, Analysis),
analysis_type(_ : unit(Call), _ : unit(Answer)) = Analysis,
parse_func_id(FuncIdTerm, FuncId),
from_term(CallPatternTerm, CallPattern : Call),
from_term(AnswerPatternTerm, AnswerPattern : Answer),
analysis_status_to_string(Status, StatusString)
then
( if
VersionNumber = analysis_version_number(_ : Call, _ : Answer),
decimal_term_to_int(VersionNumberTerm, VersionNumber)
then
Result = 'new some_analysis_result'(CallPattern, AnswerPattern,
Status),
( if map.search(!.Results, AnalysisName, AnalysisResults0) then
AnalysisResults1 = AnalysisResults0
else
AnalysisResults1 = map.init
),
( if map.search(AnalysisResults1, FuncId, FuncResults0) then
FuncResults = [Result | FuncResults0]
else
FuncResults = [Result]
),
map.set(FuncId, FuncResults, AnalysisResults1, AnalysisResults),
map.set(AnalysisName, AnalysisResults, !Results)
else
% Ignore results with an out-of-date version number.
true
)
else
Msg = "failed to parse result entry: " ++ string(Term),
throw(invalid_analysis_file(Msg))
).
%-----------------------------------------------------------------------------%
read_module_analysis_requests(Info, Globals, ModuleName, ModuleRequests,
!IO) :-
read_analysis_file(Info ^ compiler, Globals, ModuleName, request_suffix,
parse_request_entry(Info ^ compiler),
map.init, ModuleRequests, !IO).
:- pred parse_request_entry(Compiler::in, term::in,
module_analysis_map(analysis_request)::in,
module_analysis_map(analysis_request)::out) is det
<= compiler(Compiler).
parse_request_entry(Compiler, Term, !Requests) :-
( if
Term = term.functor(atom("->"), [CallerModuleTerm, RHS], _),
RHS = term.functor(atom(AnalysisName),
[VersionNumberTerm, FuncIdTerm, CallPatternTerm], _),
analyses(Compiler, AnalysisName, Analysis),
analysis_type(_ : unit(Call), _ : unit(Answer)) = Analysis,
try_parse_module_name(CallerModuleTerm, CallerModule),
parse_func_id(FuncIdTerm, FuncId),
from_term(CallPatternTerm, CallPattern : Call)
then
( if
VersionNumber = analysis_version_number(_ : Call, _ : Answer),
decimal_term_to_int(VersionNumberTerm, VersionNumber)
then
Result = 'new analysis_request'(CallPattern, CallerModule),
( if map.search(!.Requests, AnalysisName, AnalysisRequests0) then
AnalysisRequests1 = AnalysisRequests0
else
AnalysisRequests1 = map.init
),
( if map.search(AnalysisRequests1, FuncId, FuncRequests0) then
FuncRequests = [Result | FuncRequests0]
else
FuncRequests = [Result]
),
map.set(FuncId, FuncRequests, AnalysisRequests1, AnalysisRequests),
map.set(AnalysisName, AnalysisRequests, !Requests)
else
% Ignore requests with an out-of-date version number.
true
)
else
Msg = "failed to parse request entry: " ++ string(Term),
throw(invalid_analysis_file(Msg))
).
%-----------------------------------------------------------------------------%
read_module_imdg(Info, Globals, ModuleName, ModuleEntries, !IO) :-
read_analysis_file(Info ^ compiler, Globals, ModuleName, imdg_suffix,
parse_imdg_arc(Info ^ compiler), map.init, ModuleEntries, !IO).
:- pred parse_imdg_arc(Compiler::in, term::in,
module_analysis_map(imdg_arc)::in, module_analysis_map(imdg_arc)::out)
is det <= compiler(Compiler).
parse_imdg_arc(Compiler, Term, !Arcs) :-
( if
Term = term.functor(atom("->"), [DependentModuleTerm, ResultTerm], _),
ResultTerm = functor(atom(AnalysisName),
[VersionNumberTerm, FuncIdTerm, CallPatternTerm], _),
analyses(Compiler, AnalysisName, Analysis),
analysis_type(_ : unit(Call), _ : unit(Answer)) = Analysis,
try_parse_module_name(DependentModuleTerm, DependentModule),
parse_func_id(FuncIdTerm, FuncId),
from_term(CallPatternTerm, CallPattern : Call)
then
( if
VersionNumber = analysis_version_number(_ : Call, _ : Answer),
decimal_term_to_int(VersionNumberTerm, VersionNumber)
then
Arc = 'new imdg_arc'(CallPattern, DependentModule),
( if map.search(!.Arcs, AnalysisName, AnalysisArcs0) then
AnalysisArcs1 = AnalysisArcs0
else
AnalysisArcs1 = map.init
),
( if map.search(AnalysisArcs1, FuncId, FuncArcs0) then
FuncArcs = [Arc | FuncArcs0]
else
FuncArcs = [Arc]
),
map.set(FuncId, FuncArcs, AnalysisArcs1, AnalysisArcs),
map.set(AnalysisName, AnalysisArcs, !Arcs)
else
% Ignore results with an out-of-date version number.
% XXX: is that the right thing to do?
% do we really need a version number for the IMDG?
true
)
else
Msg = "failed to parse IMDG arc: " ++ string(Term),
throw(invalid_analysis_file(Msg))
).
%-----------------------------------------------------------------------------%
:- pred parse_func_id(term::in, func_id::out) is semidet.
parse_func_id(Term, FuncId) :-
Term = functor(atom(PF), [NameTerm, ArityTerm, ProcTerm], _),
(
PF = "p",
PredOrFunc = pf_predicate
;
PF = "f",
PredOrFunc = pf_function
),
NameTerm = functor(atom(Name), [], _),
decimal_term_to_int(ArityTerm, Arity),
decimal_term_to_int(ProcTerm, ProcInt),
proc_id_to_int(ProcId, ProcInt),
FuncId = func_id(PredOrFunc, Name, Arity, ProcId).
:- pred try_parse_module_name(term::in, module_name::out) is semidet.
try_parse_module_name(Term, ModuleName) :-
try_parse_sym_name_and_no_args(Term, ModuleName).
%-----------------------------------------------------------------------------%
:- pred read_analysis_file(Compiler::in, globals::in, module_name::in,
string::in, parse_entry(T)::in(parse_entry), T::in, T::out,
io::di, io::uo) is det <= compiler(Compiler).
read_analysis_file(Compiler, Globals, ModuleName, Suffix, ParseEntry,
ModuleResults0, ModuleResults, !IO) :-
module_name_to_read_file_name(Compiler, Globals, ModuleName, Suffix,
MaybeAnalysisFileName, !IO),
(
MaybeAnalysisFileName = ok(AnalysisFileName),
read_analysis_file(AnalysisFileName, ParseEntry,
ModuleResults0, ModuleResults, !IO)
;
MaybeAnalysisFileName = error(Message),
debug_msg((pred(!.IO::di, !:IO::uo) is det :-
io.write_string("Couldn't open ", !IO),
io.write_string(Suffix, !IO),
io.write_string(" for module ", !IO),
io.write(ModuleName, !IO),
io.write_string(": ", !IO),
io.write_string(Message, !IO),
io.nl(!IO)
), !IO),
ModuleResults = ModuleResults0
).
:- pred read_analysis_file(string::in, parse_entry(T)::in(parse_entry),
T::in, T::out, io::di, io::uo) is det.
read_analysis_file(AnalysisFileName, ParseEntry, ModuleResults0, ModuleResults,
!IO) :-
io.open_input(AnalysisFileName, OpenResult, !IO),
(
OpenResult = ok(Stream),
debug_msg((pred(!.IO::di, !:IO::uo) is det :-
io.write_string("% Reading analysis file ", !IO),
io.write_string(AnalysisFileName, !IO),
io.nl(!IO)
), !IO),
promise_equivalent_solutions [Result, !:IO] (
try_io(
( pred(Results1::out, !.IO::di, !:IO::uo) is det :-
check_analysis_file_version_number(Stream, !IO),
read_analysis_file_2(Stream, ParseEntry,
ModuleResults0, Results1, !IO)
), Result, !IO)
),
io.close_input(Stream, !IO),
(
Result = succeeded(ModuleResults)
;
Result = exception(_),
rethrow(Result)
)
;
OpenResult = error(_),
debug_msg((pred(!.IO::di, !:IO::uo) is det :-
io.write_string("Error reading analysis file: ", !IO),
io.write_string(AnalysisFileName, !IO),
io.nl(!IO)
), !IO),
ModuleResults = ModuleResults0
).
:- pred check_analysis_file_version_number(io.text_input_stream::in,
io::di, io::uo) is det.
check_analysis_file_version_number(Stream, !IO) :-
parser.read_term(Stream, TermResult : read_term, !IO),
( if
TermResult = term(_, NumberTerm),
decimal_term_to_int(NumberTerm, version_number)
then
true
else
Msg = "bad analysis file version: " ++ string(TermResult),
throw(invalid_analysis_file(Msg))
).
:- pred read_analysis_file_2(io.text_input_stream::in,
parse_entry(T)::in(parse_entry), T::in, T::out, io::di, io::uo) is det.
read_analysis_file_2(Stream, ParseEntry, Results0, Results, !IO) :-
parser.read_term(Stream, TermResult : read_term, !IO),
(
TermResult = term(_, Term),
ParseEntry(Term, Results0, Results1),
read_analysis_file_2(Stream, ParseEntry, Results1, Results, !IO)
;
TermResult = eof,
Results = Results0
;
TermResult = error(Msg, _),
throw(invalid_analysis_file(Msg))
).
%-----------------------------------------------------------------------------%
%
% Writing.
%
:- type write_entry(T) == pred(analysis_name, func_id, T, io, io).
:- inst write_entry == (pred(in, in, in, di, uo) is det).
write_module_overall_status(Info, Globals, ModuleName, Status, !IO) :-
module_name_to_write_file_name(Info ^ compiler, Globals, ModuleName,
analysis_registry_status_suffix, FileName, !IO),
io.open_output(FileName, OpenResult, !IO),
(
OpenResult = ok(Stream),
(
Status = optimal,
io.write_string(Stream, "optimal.\n", !IO)
;
Status = suboptimal,
io.write_string(Stream, "suboptimal.\n", !IO)
;
Status = invalid,
io.write_string(Stream, "invalid.\n", !IO)
),
io.close_output(Stream, !IO)
;
OpenResult = error(IOError),
unexpected($module, $pred, io.error_message(IOError))
).
%-----------------------------------------------------------------------------%
write_module_analysis_results(Info, Globals, ModuleName, ModuleResults, !IO) :-
debug_msg((pred(!.IO::di, !:IO::uo) is det :-
io.write_string("% Writing module analysis results for ", !IO),
io.write(ModuleName, !IO),
io.nl(!IO)
), !IO),
ToTmp = yes,
write_analysis_file(Info ^ compiler, Globals, ModuleName,
analysis_registry_suffix, ToTmp, write_result_entry,
ModuleResults, FileName, !IO),
update_interface_return_changed(Globals, FileName, Result, !IO),
% If analysis file caching is turned on, write the internal represention of
% the module results to disk right now.
globals.lookup_string_option(Globals, analysis_file_cache_dir, CacheDir),
( if
CacheDir \= "",
Result = interface_new_or_changed
then
CacheFileName = make_cache_filename(CacheDir, FileName),
write_analysis_cache_file(CacheFileName, ModuleResults, !IO)
else
true
).
:- pred write_result_entry(analysis_name::in, func_id::in,
some_analysis_result::in, io::di, io::uo) is det.
write_result_entry(AnalysisName, FuncId, Result, !IO) :-
Result = some_analysis_result(Call, Answer, Status),
VersionNumber = analysis_version_number(Call, Answer),
analysis_status_to_string(Status, StatusString),
io.write_string(AnalysisName, !IO),
io.write_char('(', !IO),
io.write_int(VersionNumber, !IO),
io.write_string(", ", !IO),
write_func_id(FuncId, !IO),
io.write_string(", ", !IO),
term_io.write_term(varset.init, to_term(Call), !IO),
io.write_string(", ", !IO),
term_io.write_term(varset.init, to_term(Answer), !IO),
io.write_string(", ", !IO),
io.write_string(StatusString, !IO),
io.write_string(").\n", !IO).
%-----------------------------------------------------------------------------%
write_module_analysis_requests(Info, Globals, ModuleName, ModuleRequests,
!IO) :-
Compiler = Info ^ compiler,
module_name_to_write_file_name(Compiler, Globals, ModuleName,
request_suffix, AnalysisFileName, !IO),
debug_msg((pred(!.IO::di, !:IO::uo) is det :-
io.write_string("% Writing module analysis requests to ", !IO),
io.write_string(AnalysisFileName, !IO),
io.nl(!IO)
), !IO),
io.open_input(AnalysisFileName, InputResult, !IO),
(
InputResult = ok(InputStream),
% Request file already exists. Check it has the right version number,
% then append the new requests to the end.
parser.read_term(InputStream, VersionResult : read_term, !IO),
io.close_input(InputStream, !IO),
( if
VersionResult = term(_, NumberTerm),
decimal_term_to_int(NumberTerm, version_number)
then
io.open_append(AnalysisFileName, AppendResult, !IO),
(
AppendResult = ok(AppendStream),
io.set_output_stream(AppendStream, OldOutputStream, !IO),
write_analysis_file_2(write_request_entry(Compiler),
ModuleRequests, !IO),
io.set_output_stream(OldOutputStream, _, !IO),
io.close_output(AppendStream, !IO),
Appended = yes
;
AppendResult = error(_),
Appended = no
)
else
Appended = no
)
;
InputResult = error(_),
Appended = no
),
(
Appended = no,
write_analysis_file(AnalysisFileName, write_request_entry(Compiler),
ModuleRequests, !IO)
;
Appended = yes
).
:- pred write_request_entry(Compiler::in, analysis_name::in, func_id::in,
analysis_request::in, io::di, io::uo) is det <= compiler(Compiler).
write_request_entry(Compiler, AnalysisName, FuncId, Request, !IO) :-
Request = analysis_request(Call, CallerModule),
( if
analyses(Compiler, AnalysisName, Analysis),
analysis_type(_ : unit(Call), _ : unit(Answer)) = Analysis
then
VersionNumber = analysis_version_number(_ : Call, _ : Answer)
else
unexpected($module, $pred, "unknown analysis type")
),
write_quoted_module_name(CallerModule, !IO),
io.write_string(" -> ", !IO),
io.write_string(AnalysisName, !IO),
io.write_string("(", !IO),
io.write_int(VersionNumber, !IO),
io.write_string(", ", !IO),
write_func_id(FuncId, !IO),
io.write_string(", ", !IO),
term_io.write_term(varset.init, to_term(Call), !IO),
io.write_string(").\n", !IO).
%-----------------------------------------------------------------------------%
write_module_imdg(Info, Globals, ModuleName, ModuleEntries, !IO) :-
ToTmp = no,
write_analysis_file(Info ^ compiler, Globals, ModuleName, imdg_suffix,
ToTmp, write_imdg_arc(Info ^ compiler), ModuleEntries, _FileName, !IO).
:- pred write_imdg_arc(Compiler::in, analysis_name::in, func_id::in,
imdg_arc::in, io::di, io::uo) is det <= compiler(Compiler).
write_imdg_arc(Compiler, AnalysisName, FuncId, Arc, !IO) :-
Arc = imdg_arc(Call, DependentModule),
( if
analyses(Compiler, AnalysisName, Analysis),
analysis_type(_ : unit(Call), _ : unit(Answer)) = Analysis
then
VersionNumber = analysis_version_number(_ : Call, _ : Answer)
else
unexpected($module, $pred, "unknown analysis type")
),
write_quoted_module_name(DependentModule, !IO),
io.write_string(" -> ", !IO),
io.write_string(AnalysisName, !IO),
io.write_char('(', !IO),
io.write_int(VersionNumber, !IO),
io.write_string(", ", !IO),
write_func_id(FuncId, !IO),
io.write_string(", ", !IO),
term_io.write_term(varset.init, to_term(Call), !IO),
io.write_string(").\n", !IO).
%-----------------------------------------------------------------------------%
:- pred write_func_id(func_id::in, io::di, io::uo) is det.
write_func_id(func_id(PredOrFunc, Name, Arity, ProcId), !IO) :-
(
PredOrFunc = pf_predicate,
io.write_string("p(", !IO)
;
PredOrFunc = pf_function,
io.write_string("f(", !IO)
),
term_io.quote_atom(Name, !IO),
io.write_string(", ", !IO),
io.write_int(Arity, !IO),
io.write_string(", ", !IO),
io.write_int(proc_id_to_int(ProcId), !IO),
io.write_char(')', !IO).
:- pred write_quoted_module_name(module_name::in, io::di, io::uo) is det.
write_quoted_module_name(ModuleName, !IO) :-
write_quoted_sym_name(ModuleName, !IO).
%-----------------------------------------------------------------------------%
:- pred write_analysis_file(Compiler::in, globals::in, module_name::in,
string::in, bool::in, write_entry(T)::in(write_entry),
module_analysis_map(T)::in, string::out, io::di, io::uo) is det
<= compiler(Compiler).
write_analysis_file(Compiler, Globals, ModuleName, Suffix, ToTmp, WriteEntry,
ModuleResults, FileName, !IO) :-
module_name_to_write_file_name(Compiler, Globals, ModuleName,
Suffix, FileName, !IO),
(
ToTmp = yes,
WriteFileName = FileName ++ ".tmp"
;
ToTmp = no,
WriteFileName = FileName
),
write_analysis_file(WriteFileName, WriteEntry, ModuleResults, !IO).
:- pred write_analysis_file(string::in, write_entry(T)::in(write_entry),
module_analysis_map(T)::in, io::di, io::uo) is det.
write_analysis_file(FileName, WriteEntry, ModuleResults, !IO) :-
io.open_output(FileName, OpenResult, !IO),
(
OpenResult = ok(Stream),
io.set_output_stream(Stream, OldOutput, !IO),
io.write_int(version_number, !IO),
io.write_string(".\n", !IO),
write_analysis_file_2(WriteEntry, ModuleResults, !IO),
io.set_output_stream(OldOutput, _, !IO),
io.close_output(Stream, !IO)
;
OpenResult = error(IOError),
unexpected($module, $pred,
"error opening `" ++ FileName ++ "' for output: " ++
io.error_message(IOError))
).
:- pred write_analysis_file_2(write_entry(T)::in(write_entry),
module_analysis_map(T)::in, io::di, io::uo) is det.
write_analysis_file_2(WriteEntry, ModuleResults, !IO) :-
map.foldl(write_analysis_file_3(WriteEntry), ModuleResults, !IO).
:- pred write_analysis_file_3(write_entry(T)::in(write_entry), string::in,
func_analysis_map(T)::in, io::di, io::uo) is det.
write_analysis_file_3(WriteEntry, AnalysisName, FuncResults, !IO) :-
map.foldl(write_analysis_file_4(WriteEntry, AnalysisName),
FuncResults, !IO).
:- pred write_analysis_file_4(write_entry(T)::in(write_entry), string::in,
func_id::in, list(T)::in, io::di, io::uo) is det.
write_analysis_file_4(WriteEntry, AnalysisName, FuncId, FuncResultList, !IO) :-
list.sort(FuncResultList, FuncResultListSorted),
list.foldl(
(pred(FuncResult::in, !.IO::di, !:IO::uo) is det :-
WriteEntry(AnalysisName, FuncId, FuncResult, !IO)
), FuncResultListSorted, !IO).
%-----------------------------------------------------------------------------%
%-----------------------------------------------------------------------------%
empty_request_file(Info, Globals, ModuleName, !IO) :-
module_name_to_write_file_name(Info ^ compiler, Globals, ModuleName,
request_suffix, RequestFileName, !IO),
debug_msg((pred(!.IO::di, !:IO::uo) is det :-
io.write_string("% Removing request file ", !IO),
io.write_string(RequestFileName, !IO),
io.nl(!IO)
), !IO),
io.remove_file(RequestFileName, _, !IO).
%-----------------------------------------------------------------------------%
%-----------------------------------------------------------------------------%
%
% Analysis file caching.
%
% An analysis cache file stores a binary representation of the parsed
% information in the corresponding .analysis file. In some cases,
% the binary format can be faster to read than the usual representation.
% The textual analysis files are portable, they more stable (they don't depend
% on compiler internals) and are easier to debug, which is why we don't
% use binary files exclusively.
%
:- func make_cache_filename(string, string) = string.
make_cache_filename(Dir, FileName) = CacheFileName :-
Components = string.split_at_separator(dir_sep, FileName),
EscFileName = string.join_list(":", Components),
CacheFileName = Dir / EscFileName.
:- pred dir_sep(char::in) is semidet.
dir_sep(Char) :-
dir.is_directory_separator(Char).
:- pred write_analysis_cache_file(string::in,
module_analysis_map(some_analysis_result)::in, io::di, io::uo) is det.
write_analysis_cache_file(CacheFileName, ModuleResults, !IO) :-
% Write to a temporary file first, and only move it into place
% once it is complete.
TmpFileName = CacheFileName ++ ".tmp",
io.tell_binary(TmpFileName, TellRes, !IO),
(
TellRes = ok,
pickle(init_analysis_picklers, ModuleResults, !IO),
io.told_binary(!IO),
io.rename_file(TmpFileName, CacheFileName, RenameRes, !IO),
(
RenameRes = ok
;
RenameRes = error(Error),
io.write_string("Error renaming ", !IO),
io.write_string(CacheFileName, !IO),
io.write_string(": ", !IO),
io.write_string(io.error_message(Error), !IO),
io.nl(!IO),
io.remove_file(TmpFileName, _, !IO)
)
;
TellRes = error(Error),
unexpected($module, $pred, io.error_message(Error))
).
:- func init_analysis_picklers = picklers.
init_analysis_picklers = Pickles :-
some [!Pickles] (
!:Pickles = init_picklers,
Dummy = 'new some_analysis_result'(any_call, dummy_answer, optimal),
Type = type_ctor(type_of(Dummy)),
register_pickler(Type, pickle_analysis_result, !Pickles),
Pickles = !.Pickles
).
:- pred pickle_analysis_result(picklers::in, univ::in, io::di, io::uo) is det.
pickle_analysis_result(Pickles, Univ, !IO) :-
det_univ_to_type(Univ, some_analysis_result(Call, Answer, Status)),
Name = analysis_name(Call, Answer),
pickle(Pickles, Name, !IO),
pickle(Pickles, Call, !IO),
pickle(Pickles, Answer, !IO),
pickle(Pickles, Status, !IO).
:- func init_analysis_unpicklers(Compiler) = unpicklers
<= compiler(Compiler).
init_analysis_unpicklers(Compiler) = Unpicklers :-
some [!Unpicklers] (
!:Unpicklers = init_unpicklers,
Dummy = 'new some_analysis_result'(any_call, dummy_answer, optimal),
Type = type_ctor(type_of(Dummy)),
register_unpickler(Type, unpickle_analysis_result(Compiler),
!Unpicklers),
Unpicklers = !.Unpicklers
).
:- pred unpickle_analysis_result(Compiler::in, unpicklers::in,