1 % (c) 2009-2025 Lehrstuhl fuer Softwaretechnik und Programmiersprachen,
2 % Heinrich Heine Universitaet Duesseldorf
3 % This software is licenced under EPL 1.0 (http://www.eclipse.org/org/documents/epl-v10.html)
4
5 %:- set_prolog_flag(source_info,on).
6 % comment in if you want source location, e.g., for exceptions,...
7 % you can also comment in a line in remove_debugging_calls in debugging_calls_te.pl to see location of nl/0
8 % (and ensure debugging_calls.pl is loaded below and in term_expansion hook is set in debugging_calls_te.pl)
9 % with ?- trace, leash(off). one can creep without entering return in the debugger; with leash([redo]) the debugger only stops at the Redo-Port. Use @<RETURN> to enter Prolog commands in the debugger.
10 % leash(exception) also useful
11 % Note: to run probcli from source for ProB2 change change probcli.sh: PROBCOMMAND=probproxy and start probsli -s 8888
12
13 :- module(prob_cli, [go_cli/0,
14 run_probcli/2, run_probcli_with_argv_string/1,
15 reset_cli/0, recognised_cli_option/4, recognised_option/2, go_proxy/0,
16 print_version/1, cli_print_statistics/1]).
17
18 :- set_prolog_flag(double_quotes, codes).
19
20 :- if(predicate_property(expects_dialect(_), _)).
21 :- expects_dialect(sicstus4).
22 :- endif.
23
24 :- multifile user:portray_message/2.
25 user:portray_message(informational, imported(_Nr,_M1,_M2)) :- !.
26 user:portray_message(informational, loading(_Nr,_,_File)) :- !.
27 %user:portray_message(informational, loaded(_Nr,compiled,_File,M,MS,_)) :- !, format('~w ms for ~w~n',[MS,M]).
28 user:portray_message(informational, loaded(_Nr,_CompiledLoaded,_File,_Module,_TimeMS,_Bytes)) :- !.
29 user:portray_message(informational, foreign_resource(_Nr,_Status,_File,_Mod)) :- !.
30 user:portray_message(informational, chr_banner) :- !.
31 %user:portray_message(informational, halt) :- !.
32 %user:portray_message(informational, prompt(off,0,user,off,off,off)) :- !.
33 %user:portray_message(informational, M) :- !, write(M),nl,nl.
34
35
36 :- meta_predicate if_option_set(-,0).
37 :- meta_predicate if_option_set(-,0,0).
38 :- meta_predicate if_options_set(-,0).
39 :- meta_predicate if_option_set_loaded(-,-,0).
40 :- meta_predicate ifm_option_set(-,0).
41 :- meta_predicate ifm_option_set(-,-,0).
42 :- meta_predicate ifm_option_set_loaded(-,-,0).
43
44
45 % patch for SICStus 4.3.3 performance issue
46 % sprm_14972_patch.pl BEGIN
47 :- if((current_prolog_flag(dialect, sicstus),
48 current_prolog_flag(version_data, sicstus(4,3,3,_,_)))).
49 prolog:wf_call_like_arg(A, B, C, D, E, F, G, H, I, _) :-
50 prolog:wellformed_body_iso(A, B, C, D, E, F, G, H, I, quiet),
51 !.
52 prolog:wf_call_like_arg(A, B, C, A, D, _, E, _, _, _) :-
53 F=E:A,
54 prolog:condense_layout(B, G),
55 prolog:comp_layout2(B, G, B, H),
56 C=call(F),
57 prolog:comp_layout1(B, H, D).
58 :- endif.
59 % sprm_14972_patch.pl END
60
61
62 %:- include('self_check_off.pl').
63
64 :- use_module(module_information).
65 :- module_info(group,cli).
66 :- module_info(description,'ProB start file in cli mode.').
67
68 %:- use_module(debugging_calls).
69 %:- register_debugging_calls([pp_mnf(*), pp_cll(*), mnf(*), mnf(-,*), det_call(*)]).
70 %:- disable_debugging_calls.
71
72 :- use_module(prob_startup, [startup_prob/0]).
73 %:- use_module(pathes,[set_search_pathes/0]). % called first to set_compile_time_search_pathes
74 :- use_module(tools,[string_concatenate/3,arg_is_number/2, print_memory_used_wo_gc/1, print_memory_used_wo_gc/0,
75 split_atom/3, get_options/5,
76 start_ms_timer/1, stop_ms_timer/1, stop_ms_timer/2, stop_ms_timer_with_msg/2]).
77 :- use_module(tools_printing,[print_error/1,format_with_colour/4, format_with_colour_nl/4]).
78 :- use_module(tools_strings,[atom_split/4,convert_atom_to_number/2]).
79 :- use_module(tools_meta,[safe_time_out/3]).
80 :- use_module(tools_lists,[count_occurences/2]).
81
82 :- use_module(preferences).
83 :- set_prob_application_type(probcli). %
84
85 :- use_module(library(lists)).
86 :- use_module(library(file_systems),[file_exists/1]).
87 :- use_module(library(system)).
88 :- use_module(library(codesio)).
89 :- use_module(library(between),[between/3]).
90 :- use_module(library(terms),[term_hash/2]).
91 :- use_module(library(random),[random/3, setrand/1]).
92
93 :- use_module(self_check,[disable_interaction_on_errors/0,
94 perform_self_check/2,turn_off_run_time_type_checks/0,turn_on_run_time_type_checks/0]).
95 :- use_module(debug).
96 :- use_module(error_manager).
97 :- use_module(translate,[pretty_type/2]).
98 :- use_module(tools,[safe_absolute_file_name/2, safe_absolute_file_name/3, convert_ms_time_to_string/2]).
99 :- use_module(extension('counter/counter'),
100 [counter_init/0, new_counter/1, get_counter/2, inc_counter/1, inc_counter/2, reset_counter/1]).
101 :- use_module(state_space,[current_expression/2]).
102
103
104 :- dynamic junit_mode/1.
105 :- use_module(junit_tests,[set_junit_dir/1, create_and_print_junit_result/4]).
106
107 :- use_module(b_trace_checking,[check_default_trace_for_specfile/1, tcltk_check_state_sequence_from_file/1,
108 tcltk_check_sequence_from_file/3, get_default_trace_file/3,
109 tcltk_save_history_as_trace_file/2,tcltk_save_history_as_trace_file/3]).
110 :- use_module(eventhandling,[store_virtual_event/1]).
111 :- use_module(bmachine,[b_set_initial_machine/0]).
112 :- use_module(specfile).
113 :- use_module(test_typechecker,[run_typecheck_testcase/2]).
114 :- use_module(basic_unit_tests). % basic unit tests
115 :- use_module(bsyntaxtree,[size_of_conjunction/2, get_texpr_id/2, get_texpr_description/2,
116 conjunction_to_list/2,
117 get_texpr_label/2, predicate_components/2, get_texpr_pos/2]).
118 :- use_module(bmachine,[b_write_machine_representation_to_file/3,
119 full_b_machine/1, b_write_eventb_machine_to_classicalb_to_file/1]).
120 :- use_module(state_space,[current_state_id/1, get_state_space_stats/4, compute_full_state_space_hash/1]).
121 :- use_module(xtl_interface,[set_cspm_main_process/1]).
122 :- use_module(extrasrc(meta_interface),[is_dot_command/1, call_dot_command_with_engine/4,
123 is_dot_command_for_expr/1,call_dot_command_with_engine_for_expr/5,
124 is_plantuml_command/1, is_plantuml_command_for_expr/1,
125 is_table_command/1, is_table_command_for_expr/1,
126 call_plantuml_command/2, call_plantuml_command_for_expr/4,
127 call_command/5, is_table_command/6, write_table_to_csv_file/3,
128 command_description/3]).
129 :- use_module(kodkodsrc(kodkod_test),[test_kodkod/1, compare_kodkod_performance/2]).
130 :- use_module(kodkodsrc(predicate_analysis),[test_predicate_analysis/0]).
131 :- use_module(b_show_history,[write_history_to_file/2,write_values_to_file/1,
132 write_all_values_to_dir/1,write_history_to_user_output/1]).
133 :- use_module(cbcsrc(sap), [write_all_deadlocking_paths_to_xml/1, test_generation_by_xml_description/1]).
134 :- use_module(smtlib_solver(smtlib2_cli),[smtlib2_file/2]).
135 :- use_module(disproversrc(disprover_test_runner), [run_disprover_on_all_pos/1,
136 load_po_file/1,print_disprover_stats/0, set_disprover_timeout/1,
137 set_disprover_options/1, reset_disprover_timeout/0]).
138 :- use_module(extrasrc(latex_processor), [process_latex_file/2]).
139 :- use_module(probltlsrc(ltl),[ltl_check_assertions/2,ltl_model_check/4]).
140 :- use_module(probltlsrc(ctl),[ctl_model_check/4]).
141
142 :- use_module(logger).
143 :- use_module(extension('zmq/master/master'),[start_master/8]).
144 :- use_module(extension('zmq/worker/worker'),[start_worker/5]).
145 :- use_module(extension('ltsmin/ltsmin'),
146 [start_ltsmin/4,ltsmin_init/3,ltsmin_loop/1,ltsmin_teardown/2,ltsmin_generate_ltlfile/2]).
147 :- use_module(extrasrc(coverage_statistics),[compute_the_coverage/5]).
148 :- use_module(value_persistance, [set_storage_directory/2, print_value_persistance_stats/0,
149 delete_cache_files_for_machine/1, delete_cache_files/0,
150 get_value_persistance_stats/1, show_cache_file_contents/1]).
151 :- use_module(prob_socketserver,[start_prob_socketserver/2]).
152 :- use_module(tcltk_interface).
153 %:- compile(gui_tcltk).
154 :- use_module(eclipse_interface).
155 :- use_module(prob2_interface,[start_animation/0, is_initialised_state/1, reset_animator/0,
156 set_eclipse_preference/2, update_preferences_from_spec/1,
157 load_cspm_spec_from_cspm_file/1, load_xtl_spec_from_prolog_file/1]).
158
159 start_probcli_timer(timer(T1,WT1)) :-
160 statistics(runtime,[T1,_]),
161 statistics(walltime,[WT1,_]).
162 stop_probcli_debug_timer(Timer,Msg) :- (debug_mode(on) -> stop_probcli_timer(Timer,Msg) ; true).
163 stop_probcli_timer(timer(T1,WT1),Msg) :- stop_probcli_timer(timer(T1,WT1),Msg,_).
164 stop_probcli_timer(timer(T1,WT1),Msg,WTotTime) :-
165 statistics(runtime,[T2,_]), TotTime is T2-T1,
166 statistics(walltime,[WT2,_]), WTotTime is WT2-WT1,
167 convert_ms_time_to_string(WT2,WTString),
168 format('~w ~w ms walltime (~w ms runtime), since start: ~w~n',[Msg,WTotTime,TotTime,WTString]),
169 !.
170 stop_probcli_timer(Timer,Msg,_) :- add_internal_error('Illegal timer call: ',stop_probcli_timer(Timer,Msg)).
171 print_total_probcli_timer :-
172 statistics(runtime,[T2,_]),
173 statistics(walltime,[WT2,_]),
174 format('Since start of probcli: ~w ms walltime (~w ms runtime)~n',[WT2,T2]).
175 get_probcli_elapsed_walltime(timer(_,WT1),WTotTime) :-
176 statistics(walltime,[WT2,_]), WTotTime is WT2-WT1.
177 get_probcli_elapsed_runtime(timer(RT1,_),RTotTime) :-
178 statistics(runtime,[RT2,_]), RTotTime is RT2-RT1.
179
180 :- meta_predicate timeout_call(0,-,-).
181 timeout_call(Call,NOW,PP) :- option(timeout(TO)),!,
182 statistics(runtime,[T1,_]),
183 safe_time_out(Call,TO,Res),
184 statistics(runtime,[T2,_]), Runtime is T2-T1,
185 formatsilent('Runtime for ~w: ~w ms~n',[PP,Runtime]),
186 (Res=time_out -> print('*** Timeout occurred: '), print(TO),nl,
187 print('*** Call: '), print(Call),nl,
188 nl,
189 writeln_log(timeout_occurred(NOW,Call))
190 ; true).
191 timeout_call(Call,_NOW,PP) :-
192 statistics(runtime,[T1,_]),
193 call(Call),
194 statistics(runtime,[T2,_]), Runtime is T2-T1,
195 formatsilent('Runtime for ~w: ~w ms~n',[PP,Runtime]).
196
197 set_junit_mode(X) :-
198 set_junit_dir(X),
199 retractall(junit_mode(_)),
200 statistics(runtime,[Start,_]),
201 assertz(junit_mode(Start)).
202
203 go_proxy :-
204 catch( run_probcli(['-s','8888'],[proxy]), halt(ExitCode),
205 ( nl,write('CLI halt prevented, exit code '),write(ExitCode),nl) ).
206
207 go_cli :-
208 % set_prob_application_type(probcli) is already done at compile_time
209 current_prolog_flag(argv,ArgV),
210 run_probcli_with_junit_check(ArgV).
211
212 initialise_cli :- counter_init,
213 new_counter(cli_execute_inits),
214 new_counter(cli_errors), new_counter(cli_warnings),
215 new_counter(cli_expected_errors).
216
217 % called from test_runner.pl:
218 reset_cli :-
219 announce_event(clear_specification),
220 announce_event(reset_prob),
221 reset_expected_error_occurred,
222 reset_optional_errors_or_warnings,
223 reset_counter(cli_errors), reset_counter(cli_warnings),
224 reset_counter(cli_expected_errors),
225 retractall(accumulated_infos(_,_,_)),
226 retractall(merged_individual_file_infos(_,_,_)),
227 retractall(individual_file_infos(_,_,_)),
228 (file_loaded(_)
229 -> clear_loaded_machines, % TODO: also treat by reset_prob eventhandling?
230 retractall(file_loaded(_,_)),
231 retractall(loaded_main_file(_,_))
232 ; true).
233
234 run_probcli_with_junit_check(ArgV) :-
235 catch( run_probcli(ArgV,[junit]),
236 halt(ExitCode),
237 ( ExitCode = 0 ->
238 true
239 ; ( junit_mode(S) ->
240 statistics(runtime,[E,_]), T is E - S,
241 create_and_print_junit_result(['Integration Tests'],ArgV,T,error([ExitCode]))
242 ; true),
243 throw(halt(ExitCode)))).
244
245
246 % a useful entry point for Jupyter to mimic probcli execution in notebooks
247 run_probcli_with_argv_string(ArgVAtom) :- split_argv_string(ArgVAtom,Atoms),
248 (Atoms = [probcli|Atoms2] -> true ; Atoms2=Atoms),
249 run_probcli(Atoms2,[run_probcli_with_argv_string]).
250
251 split_argv_string(ArgVAtom,Atoms) :- split_atom(ArgVAtom,[' '],Atoms). % TODO: treat quoting
252
253 run_probcli(ArgV,Context) :- % format(user_output,'~n* Starting probcli with argv: ~w~n~n',[ArgV]),
254 (catch(
255 run_probcli2(ArgV),
256 Exc,
257 process_exception(Exc,Context)
258 )
259 -> true
260 ; flush_output,
261 print_error('INTERNAL ERROR OCCURRED (run_probcli failed) !'),nl,
262 error_occurred(internal_error),
263 halt_exception(1)
264 ).
265
266 :- use_module(translate,[translate_error_term/2]).
267 %process_exception(Exception,_) :- write('Exception: '),write(Exception),nl,fail. % for debugging
268 process_exception(halt(A),_) :- !, throw(halt(A)).
269 process_exception('$aborted',_) :- !, throw('$aborted'). % thrown by SWI-Prolog on abort by user
270 process_exception(user_interrupt_signal,Context) :- !,
271 %add_error(probcli,'probcli interrupted by user (CTRL-C)').
272 statistics(walltime,[WStart,_]),
273 format_with_colour_nl(user_error,[red],'~nprobcli interrupted by user (CTRL-C), total walltime ~w ms',[WStart]),
274 (member(test_runner,Context)
275 -> throw(user_interrupt_signal) % will be caught by test_runner
276 ; error_occurred_with_msg(user_interrupt_signal,'probcli interrupted by user (CTRL-C)')
277 ).
278 process_exception(Exc,_) :-
279 (translate_error_term(Exc,S)
280 -> format_error_with_nl('Uncaught exception in probcli: ~w',[S])
281 ; true),
282 error_occurred(internal_error(exception(Exc))),fail.
283
284 no_command_issued :- \+ command_option(_).
285 command_option(X) :- option(X), \+ not_command_option(X).
286 not_command_option(verbose(_)).
287 not_command_option(profiling_on).
288 not_command_option(set_pref(_,_)).
289 not_command_option(set_preference_group(_,_)).
290 not_command_option(set_card(_,_)).
291 not_command_option(set_argv(_)).
292 not_command_option(silent).
293 not_command_option(strict_raise_error).
294 not_command_option(no_color).
295
296 probcli_startup :-
297 %print_total_probcli_timer,
298 startup_prob, % % startup_prob will already call init_preferences
299 %myheap_init,
300 initialise_cli.
301
302 :- load_files(library(system), [when(compile_time), imports([environ/2])]).
303 :- if(environ(prob_logging_mode,true)).
304 cli_set_options(ArgV,RemArgV) :-
305 cli_init_options(['-ll'|ArgV],RemArgV). %% adds -ll to have an automatically logging probcli to /tmp/prob_cli_debug.log
306 :- else.
307 cli_set_options(ArgV,RemArgV) :- cli_init_options(ArgV,RemArgV).
308 :- endif.
309
310 %:- use_module(extension('myheap/myheap')).
311 run_probcli2(ArgV) :- %print(probcli_startup),nl_time,
312 treat_important_options_beforehand(ArgV),
313 probcli_startup,
314 external_functions:reset_argv,
315 cli_set_options(ArgV,RemArgV), % recognise command-line options
316 %% cli_set_options(['-vv','-version'|ArgV],RemArgV), %% comment in to have an automatically verbose probcli
317 maplist(prob_cli:check_atom_looks_like_file,RemArgV),
318 (option(prolog_trace) -> error_manager:safe_trace ; true),
319 !,
320 run_probcli3(ArgV,RemArgV).
321
322 % treat important options beforehand, e.g., to enable debug prints straight-away, e.g., before probcli_startup
323 treat_important_options_beforehand(ArgV) :-
324 ? member(Opt,ArgV),recognised_option(Opt,RecognisedOpt),treat_important_option(RecognisedOpt),fail.
325 treat_important_options_beforehand(_).
326
327 treat_important_option(verbose(Nr)) :- verbose(Nr).
328 treat_important_option(set_gc_trace(X)) :- set_gc_trace(X).
329 treat_important_option(profiling_on) :- profiling_on.
330
331
332 run_probcli3(ArgV,RemArgV) :-
333 ( RemArgV=[File],no_command_issued,
334 get_filename_extension(File,Ext),
335 \+ do_not_execute_automatically(Ext)
336 % then assume we want to do -execute_all:
337 -> assert_option(execute(2147483647,false,current_state(1)))
338 ; true),
339 if_option_set(set_application_type(PAT),set_prob_application_type(PAT)),
340 if_option_set(test_mode,set_random_seed_to_deterministic_start_seed, set_new_random_seed),
341 ifm_option_set(verbose(VN),
342 verbose(VN), %tcltk_turn_debugging_on(5)),
343 tcltk_turn_debugging_off),
344 % TODO: reset the next three to default values if no flags present, in case we use them for tests:
345 if_option_set(set_gc_trace(GCT),set_gc_trace(GCT)),
346 if_option_set(set_gc_margin(GCM),set_gc_margin(GCM)),
347 if_option_set(set_gc_on_off(GCO),set_gc_on_off(GCO)),
348 if_option_set(profiling_on,profiling_on),
349 debug_print(9,'Command Line Arguments: '),debug_println(9,ArgV),
350 (debug_level_active_for(5) -> print_options ; true),
351 debug_print(6,'Command Line File Args: '),debug_println(6,RemArgV),
352 debug_flush_output,
353 if_option_set(cache_storage(StorageDir,SetStorMode), set_storage_directory(StorageDir,SetStorMode)),
354 if_option_set(parsercp(ParserLoc),
355 (add_message(parsercp,'Command -parcercp PATH deprecated, use -p JAVA_PARSER_PATH PATH',''),
356 set_preference(path_to_java_parser,ParserLoc))
357 ),
358 if_option_set(parserport(ParserPort),
359 connect_to_external_console_parser_on_port(ParserPort)),
360 generate_time_stamp(Datime,NOW),
361 if_option_set(log(LogF,Mode),
362 cli_start_logging(LogF,Mode,NOW,Datime,RemArgV)),
363 if_option_set(runtimechecking,
364 turn_on_run_time_type_checks,
365 turn_off_run_time_type_checks),
366 if_option_set(junit(JUX),
367 set_junit_mode(JUX)),
368 set_prefs,
369 (option_verbose, (option(set_prefs_from_file(_)) ; option(set_preference_group(_,_))),
370 get_non_default_preferences(list(NDPrefs))
371 -> format('Non-default preferences:~n',[]),print_list(NDPrefs),nl ; true),
372 set_optional_errors,
373 check_unavailable_options,
374 cli_show_help(ArgV,RemArgV),
375 if_option_set(set_argv(ArgVStr),
376 set_argv(ArgVStr)),
377 if_option_set(selfcheck(_,_),
378 cli_start_selfcheck),
379 if_option_set(typechecker_test(Filename),
380 (run_typecheck_testcase(Filename,typesok) -> halt_prob(NOW,0); halt_prob(NOW,1))),
381 if_option_set(install_prob_lib(LIBTOINSTALL,INSTALLOPTS), install_prob_lib(LIBTOINSTALL,INSTALLOPTS)),
382 if_options_set(print_version(VERSIONKIND), print_version(VERSIONKIND)),
383 if_option_set(check_java_version, check_java_version),
384 (debug_level_active_for(5) -> preferences:print_preferences ; true),
385 if_option_set(zmq_worker(Identifier), zmq_start_worker(Identifier, NOW)),
386 %if_option_set(zmq_worker2(MasterIP, Port, ProxyID, Logfile), zmq_start_worker(MasterIP,Port,ProxyID,Logfile,NOW)),
387 % process remaining arguments as files to load
388 % some utility commands which do not require main file:
389 ifm_option_set(indent_b_file_to_file(PPBFILE0,OUTFILE,OPTS),
390 indent_b_file_to_file(PPBFILE0,OUTFILE,OPTS)), % utility to format B file
391 ifm_option_set(pretty_print_prolog_file(PPFILE0,OUTFILE),
392 pretty_print_prolog_file(PPFILE0,OUTFILE)), % utility to print Prolog file
393 debug_println(6,processing(RemArgV)),
394 cli_load_files(RemArgV,NOW), % all CLI arguments which are not understood are supposed to be files to be treated
395 debug_println(19,finished_loading(RemArgV)),
396 if_option_set(socket(Port,Loopback),
397 cli_start_socketserver(Port,Loopback)),
398 % check_all_expected_errors_occurred(NOW), % is now checked for each file; socket_server should not generate errors ?
399 debug_println(20,'% probcli execution finished'),
400 cli_print_junit_results(ArgV),
401 debug_println(20,'% Stored Junit results'),
402 stop_xml_probcli_run(NOW),
403 debug_println(20,'% ProB Finished').
404
405 % finish logxml file by writing total number of errors and warnings
406 stop_xml_probcli_run(NOW) :-
407 get_counter(cli_errors,CErrs), get_counter(cli_warnings,CWarns), get_counter(cli_expected_errors,EErrs),
408 writeln_log_time(prob_finished(NOW,CErrs,CWarns)),
409 (EErrs>0
410 -> write_xml_element_to_log('probcli-errors',[errors/CErrs,warnings/CWarns,expected_errors/EErrs])
411 ; write_xml_element_to_log('probcli-errors',[errors/CErrs,warnings/CWarns])
412 ),
413 ((CErrs>0 ; CWarns>0) -> format(user_error,'! Total Errors: ~w, Warnings:~w~n',[CErrs,CWarns]) ; true),
414 stop_xml_group_in_log('probcli-run'). % Generating this tag means probcli ran to completion without segfault,...
415
416 % check if a cli argument looks like a proper filename
417 :- public check_file_arg/2. % is actually called when parsing options
418 check_file_arg(File,Command) :- normalise_option_atom(File,NF),
419 recognised_option(NF,_,_,_),!,
420 ajoin(['Command-line file argument for ', Command, ' looks like another probcli command: '],Msg),
421 add_warning(probcli,Msg,File).
422 check_file_arg(File,Command) :-
423 tools:check_filename_arg(File,Command).
424
425 % check if a remaining argument looks suspicious (e.g., like an unknown command)
426 check_atom_looks_like_file(Number) :- number(Number),!,
427 add_warning(probcli,'Command-line argument is a number (expected file name or probcli command): ',Number).
428 check_atom_looks_like_file(File) :- atom_codes(File,Codes),
429 check_codes_look_like_file(Codes,File).
430 check_codes_look_like_file(Codes,Arg) :-
431 check_codes_resembles_command(Codes,Arg),!.
432 check_codes_look_like_file([D|T],Arg) :- D >= 0'0, D =< 0'9,
433 nonmember(0'/,T), % detect things like 01_Jan/a.mch
434 !,
435 add_message(probcli,'Command-line argument looks like a number: ',Arg).
436 check_codes_look_like_file(_,_).
437
438 check_codes_resembles_command([45|_],Arg) :- !,
439 (get_possible_fuzzy_match_options(Arg,FuzzyMatches),
440 FuzzyMatches \= []
441 -> (FuzzyMatches=[FM]
442 -> ajoin(['Command-line argument ', Arg, ' looks like a probcli command! Did you mean: '],Msg),
443 add_warning(probcli,Msg,FM)
444 ; ajoin(['Command-line argument ', Arg, ' looks like a probcli command! Did you mean any of: '],Msg),
445 add_warning(probcli,Msg,FuzzyMatches)
446 )
447 ; get_possible_options_completion_msg(Arg,Completions)
448 -> ajoin(['Command-line argument ', Arg, ' looks like a probcli command! Did you mean: '],Msg),
449 add_warning(probcli,Msg,Completions)
450 ; add_message(probcli,'Command-line argument looks like an unknown probcli command: ',Arg)).
451
452 :- use_module(extrasrc(refinement_checker),[valid_failures_model/2]).
453 check_failures_mode(Shortcut,FailuresModel) :- valid_failures_model(FailuresModel,Shortcut),!.
454 check_failures_mode(Shortcut,trace) :-
455 add_warning(probcli,'Unrecognised refinement model flag (must be F, FD, T, R, RD, V, VD; using default trace model T): ',Shortcut).
456
457 % ----------
458
459 cli_init_options(ArgV,RemArgV) :- %print(argv(ArgV)),nl,
460 append(ProBArgV,['--'|BArgV],ArgV),!, % pass arguments after -- to B via external_functions
461 cli_init_options2(ProBArgV,RemArgV),
462 debug_println(20,set_argv_from_list(BArgV)),
463 external_functions:set_argv_from_list(BArgV).
464 cli_init_options(ArgV,RemArgV) :- cli_init_options2(ArgV,RemArgV).
465 cli_init_options2(ArgV,RemArgV) :-
466 reset_options,
467 %%assertz(option(log('/tmp/ProBLog.log'))), print('LOGGING'),nl, %% coment in to build a version of probcli that automatically logs
468 ( get_options(ArgV,recognised_cli_option,Options,RemArgV,throw(halt(1))) ->
469 assert_all_options(Options)
470 ;
471 print_error(get_options_failed(ArgV)),definite_error_occurred).
472 cli_show_help(ArgV,RemArgV) :-
473 ( (option(help) ; ArgV=[]) ->
474 print_help, (RemArgV=[] -> halt_exception ; true)
475 ; true).
476 cli_start_logging(F,Mode,NOW,Datime,RemArgV) :-
477 debug_print(20,'%logging to: '), debug_println(20,F),
478 set_log_file(F), set_logging_mode(Mode),
479 start_xml_group_in_log('probcli-run'),
480 writeln_log(start_logging(NOW,F)),
481 version(V1,V2,V3,Suffix), revision(Rev), lastchangeddate(LCD),
482 writeln_log(version(NOW,V1,V2,V3,Suffix,Rev,LCD)), % still used by log_analyser
483 current_prolog_flag(version,PV),
484 write_xml_element_to_log(version,[major/V1,minor/V2,patch/V3,suffix/Suffix,revision/Rev,lastchanged/LCD,prolog/PV]),
485 findall(Opt, option(Opt), Options),
486 write_prolog_term_as_xml_to_log(options(NOW,Options)),
487 write_prolog_term_as_xml_to_log(files(NOW,RemArgV)), %
488 datime(Datime,DateRecord),
489 writeln_log(date(NOW,DateRecord)),
490 (DateRecord=datime(Yr,Mon,Day,Hr,Min,Sec)
491 -> write_xml_element_to_log(date,[year/Yr,month/Mon,day/Day,hour/Hr,minutes/Min,seconds/Sec]) ; true).
492
493 cli_start_selfcheck :-
494 %clear_loaded_machines_wo_errors,
495 b_set_initial_machine,
496 set_animation_mode(b),
497 store_virtual_event(clear_specification), % TO DO: try and get rid of the need for this
498 start_animation,
499 option(selfcheck(ModuleCombo,Opts)),
500 (atom(ModuleCombo),
501 atom_split(Module,':',TestNrA,ModuleCombo)
502 -> convert_atom_to_number(TestNrA,TestNr),
503 Opts2=[run_only_nr(TestNr)|Opts]
504 ; Module=ModuleCombo, Opts2=Opts
505 ),
506 (option(silent) -> Opts3=[silent|Opts2] ; option_verbose -> Opts3=[verbose|Opts2] ; Opts3=Opts2),
507 (perform_self_check(Module,Opts3) -> true ; error_occurred(selfcheck)),
508 fail.
509 cli_start_selfcheck.
510
511
512 :- dynamic file_loaded/2.
513 file_loaded(Status) :- file_loaded(Status,_File).
514
515
516 cli_load_files([],NOW) :- % no files are provided
517 !,
518 ( options_allow_start_without_file
519 -> debug_format(19,'Using empty machine to process probcli command~n',[]),
520 cli_set_empty_machine
521 ; we_did_something -> true
522 ; print('No file to process'),nl),
523 writeln_log_time(start_processing_empty_machine(NOW)),
524 start_xml_feature(process_file,filename,'$EMPTY_MACHINE',FINFO),
525 cli_process_loaded_file(NOW,'$EMPTY_MACHINE'),
526 check_all_expected_errors_occurred(NOW), % check that all expected errors occurred; below they will be checked for each file
527 stop_xml_feature(process_file,FINFO),
528 (option(benchmark_info_csv_output(_,_,_)) -> print_accumulated_infos(0) ; true).
529 cli_load_files(RemArgV,NOW) :-
530 cli_load_files2(RemArgV,NOW,0).
531
532
533 cli_set_empty_machine :- % TO DO: do this more properly here and for initialise_required
534 set_animation_mode(b),
535 bmachine:b_set_empty_machine,
536 assertz(file_loaded(true,'$$empty_machine')).
537
538 empty_machine_loaded :- file_loaded(true,'$$empty_machine').
539
540
541 options_allow_start_without_file :- option(run_benchmark(_,_,_)).
542 options_allow_start_without_file :- option(eval_repl(_)).
543 options_allow_start_without_file :- option(eval_string_or_file(_,_,_,_,_)).
544 options_allow_start_without_file :- option(check_log(_)).
545 options_allow_start_without_file :- option(process_latex_file(_,_)).
546 options_allow_start_without_file :- option(socket(_,_)).
547
548 we_did_something :- option(print_version(_)).
549 we_did_something :- option(check_java_version).
550 we_did_something :- option(check_parser_version).
551 we_did_something :- option(install_prob_lib(_,_)).
552 we_did_something :- option(indent_b_file_to_file(_,_,_)).
553 we_did_something :- option(pretty_print_prolog_file(_,_)).
554
555 option_only_works_for_single_file(zmq_assertion(_Identifier)).
556 option_only_works_for_single_file(zmq_master(_Identifier)).
557
558 clear_loaded_files :-
559 (file_loaded(_) -> clear_loaded_machines_wo_errors ; true).
560
561 % called if we have at least one file
562 cli_load_files2([],_,NrFilesProcessed) :- !,
563 debug_println(19,finished_procesing_all_files(NrFilesProcessed)),
564 print_accumulated_infos(NrFilesProcessed). % print summary of all runs for different files
565 cli_load_files2([F1,F2|T],NOW,_NrFilesProcessed) :-
566 option(Option),
567 option_only_works_for_single_file(Option),!,
568 add_error(probcli,'The following option can only be used for a single file: ',Option),
569 add_error(probcli,'Multiple files provided: ',[F1,F2|T]),
570 halt_prob(NOW,0).
571 cli_load_files2(RemArgV,NOW,NrFilesProcessed) :-
572 %print_total_probcli_timer,
573 clear_loaded_files,
574 retractall(file_loaded(_,_)),
575 RemArgV = [MainFile0|Rest],!,
576 N1 is NrFilesProcessed+1,
577 cli_load_files3(MainFile0,Rest,NOW,N1).
578 cli_load_files3(MainFile0,Rest,NOW,NrOfFile) :-
579 safe_absolute_file_name(MainFile0,MainFile,[access(none)]), % converts Windows slash into Unix slash,...
580 if_option_set(file_info,print_file_info(MainFile)),
581 ((Rest=[_|_] ; NrOfFile>1)
582 -> length(Rest,RLen), Tot is NrOfFile+RLen,
583 format('~n~n% Processing file ~w/~w: ~w~n',[NrOfFile,Tot,MainFile]) % was formatsilent
584 ; true),
585 start_xml_feature(process_file,filename,MainFile,FINFO),
586 ( file_exists(MainFile) ->
587 debug_println(6,file_exists(MainFile)),
588 ( load_main_file(MainFile,NOW,Already_FullyProcessed) ->
589 (Already_FullyProcessed==true
590 -> true
591 ; assertz(file_loaded(true,MainFile)),
592 trimcore_if_useful(Rest),
593 writeln_log_time(start_processing(NOW)),
594 start_probcli_timer(Timer),
595 catch((cli_process_loaded_file(NOW,MainFile)
596 -> stop_probcli_debug_timer(Timer,'% Finished processing file after')
597 ; print_error('Processing or loading file failed: '), print_error(MainFile),
598 start_repl_even_after_failure
599 ),
600 user_interrupt_signal, % catch CTRL-C by user but give chance to enter REPL
601 start_repl_even_after_failure
602 ),
603 writeln_log_time(finished_processing(NOW))
604 )
605 ;
606 assertz(file_loaded(error,MainFile)),
607 print_error('Loading Specification Failed'),
608 writeln_log_time(loading_failed(NOW,MainFile)),
609 error_occurred(load_main_file)
610 %start_repl_even_after_failure : TODO: fix issues with bmachine not precompiled and counter extension
611 ),
612 nls,
613 ifm_option_set(indent_main_b_file(PPFILE0),
614 indent_main_b_file(PPFILE0)),
615 ifm_option_set(pretty_print_prolog_file(PPFILE0),
616 pretty_print_prolog_file(PPFILE0))
617 ; % not file_exists
618 nl, assertz(file_loaded(error,MainFile)),
619 (number(MainFile0)
620 -> add_error(load_main_file,'Command-line argument is a number which is not associated with a command and does not exist as file: ',MainFile0)
621 ; atom_codes(MainFile0,[45|_]) % starts with a dash - : probably an illegal command-line option
622 -> add_error(load_main_file,'Specified option or file does not exist: ',MainFile0)
623 ; get_filename_extension(MainFile,Ext), \+ known_spec_file_extension(Ext,_)
624 -> (Ext = '' -> EMsg = 'Specified file does not exist and has no file extension:'
625 ; ajoin(['Specified file does not exist and has an unrecognised file extension ".',Ext,'" :'], EMsg)
626 ),
627 add_error(load_main_file,EMsg,MainFile)
628 ; add_error(load_main_file,'Specified file does not exist:',MainFile)
629 )
630 ),
631 check_all_expected_errors_occurred(NOW),
632 stop_xml_feature(process_file,FINFO),
633
634 debug_println(19,reset_expected_error_occurred),
635 reset_expected_error_occurred, % reset for next file
636 debug_println(19,resetting_errors),
637 reset_errors,
638 debug_println(19,update_time_stamp),
639 NOW1 is NOW+1,
640 update_time_stamp(NOW1),
641 debug_println(19,remaining_files_to_process(Rest)),
642 cli_load_files2(Rest,NOW1,NrOfFile).
643
644 start_repl_even_after_failure :-
645 (option(eval_repl([]))
646 -> format_with_colour_nl(user_output,[blue],'Starting REPL, but ignoring any other commands',[]),
647 % TODO: check if setup_constants_fails and then suggest e.g. :core @PROPERTIES command
648 start_repl_if_required % can be useful to debug properties, e.g, one can fix an error and reload
649 ; true
650 ).
651
652 print_file_info(F) :-
653 print('Specification_File('), print(F), print(')'),nl.
654
655 :- use_module(probsrc(tools),[statistics_memory_used/1]).
656 trimcore_if_useful(_) :- option(release_java_parser),!, prob_trimcore.
657 % if user wants to release java parser, this is an indication that the .prob files are big and it can be good to free memory
658 trimcore_if_useful([]) :- % try and reduce Prologs memory consumption, see also PROLOGKEEPSIZE parameter
659 % a lot of memory can be consumed loading .prob file and doing machine construction
660 !,
661 (option(X), memory_intensive_option(X)
662 -> debug_format(9,'Not trimming memory usage because of memory intensive option: ~w~n',[X])
663 ; statistics_memory_used(M), M< 300000000 % less than 300 MB used
664 -> debug_format(9,'Not trimming memory usage because of memory used is already low: ~w~n',[M])
665 ; prob_trimcore
666 ).
667 trimcore_if_useful(_) :- debug_println(9,'Not trimming memory usage as there are still files to process').
668
669 prob_trimcore :- (option_verbose ; option(release_java_parser)),!,prob_trimcore_verbose.
670 prob_trimcore :- prob_trimcore_silent.
671
672 prob_trimcore_verbose :-
673 print('Memory used before trimming: '),print_memory_used_wo_gc,flush_output, nl_time,
674 prob_trimcore_silent,
675 print('Memory used after trimming : '),print_memory_used_wo_gc,flush_output, nl_time.
676 prob_trimcore_silent :-
677 garbage_collect, % is important, otherwise trimming may achieve very little
678 trimcore.
679
680 memory_intensive_option(cli_mc(_)).
681 memory_intensive_option(ltl_formula_model_check(_,_)).
682 memory_intensive_option(ctl_formula_model_check(_,_)).
683 memory_intensive_option(pctl_formula_model_check(_,_)).
684 memory_intensive_option(refinement_check(_,_,_)).
685 memory_intensive_option(generate_all_traces_until(_,_,_)).
686
687 % ---------------------
688
689 % process all the commands for a loaded file:
690 cli_process_loaded_file(NOW,MainFile) :-
691 (real_error_occurred -> print_error('% *** Errors occurred while loading ! ***'),nl,nl ; true),
692 get_errors, reset_errors,
693 if_option_set(kodkod_performance(KPFile,Iterations),
694 compare_kodkod_performance1(KPFile,Iterations,NOW)),
695 if_option_set(kodkod_comparision(MaxResiduePreds),
696 test_kodkod_and_exit(MaxResiduePreds,NOW)),
697 % if_option_set(add_csp_guide(CspGuide), tcltk_add_csp_file(CspGuide)), %% moved to later to ensure B machine is precompiled; allows e.g. type_check_csp_and_b to run
698
699 if_option_set(csp_main(MAINPROC),
700 set_cspm_main_process(MAINPROC)),
701
702 if_option_set(zmq_master(Identifier), zmq_start_master(invariant,Identifier)),
703 %if_option_set(zmq_master(IP, Logfile), zmq_start_master(invariant,200,-1,5000,0,IP,Logfile)),
704
705 ifm_option_set(check_machine_file_sha(FileToCheck,ExpectedSha1Hash),
706 check_machine_file_sha(FileToCheck,ExpectedSha1Hash)),
707 ifm_option_set(clear_value_persistance_cache(MachineToClear),
708 delete_cache_files_for_machine(MachineToClear)),
709 ifm_option_set(clear_value_persistance_cache,
710 delete_cache_files),
711
712 % STARTING ANIMATION/MODEL CHECKING
713 cli_start_animation(NOW),
714
715 if_option_set_loaded(cli_core_properties(MaxCoreSize),cli_core_properties,
716 cli_core_properties(MaxCoreSize)),
717
718 if_option_set_loaded(default_trace_check,default_trace_check,
719 cli_start_default_trace_check(MainFile)),
720 if_option_set_loaded(trace_check(TrStyle,TraceFile,ChkMode),trace_check,
721 cli_start_trace_check(TrStyle,TraceFile,ChkMode)),
722
723 cli_process_loaded_file_afer_start_animation(NOW).
724
725 cli_process_loaded_file_afer_start_animation(NOW) :-
726 ifm_option_set(cli_print_machine_info(IKind),
727 cli_print_machine_info(IKind)),
728 ifm_option_set(pretty_print_internal_rep(PPFILE1,MachName1,TYPES1,ASCII1),
729 pretty_print_internal_rep(PPFILE1,MachName1,TYPES1,ASCII1)),
730 ifm_option_set(pretty_print_internal_rep_to_B(PPFILE3),
731 b_write_eventb_machine_to_classicalb_to_file(PPFILE3)),
732
733 if_option_set_loaded(state_trace(TraceFile),state_trace,
734 cli_start_trace_state_check(TraceFile)),
735
736 if_option_set(evaldot(EvalDotF),
737 set_eval_dot_file(EvalDotF)),
738
739 (initialise_required
740 -> check_loaded(initialise),
741 cli_start_initialisation(NOW),
742 writeln_log_time(initialised(NOW))
743 ; true),
744 if_option_set(check_abstract_constants,
745 check_abstract_constants),
746
747 if_option_set(zmq_assertion(Identifier),
748 zmq_start_master(assertion,Identifier)),
749
750 if_option_set(cli_lint,cli_lint(_)),
751 ifm_option_set_loaded(cli_lint(LintCheck),cli_lint,cli_lint(LintCheck)),
752 if_option_set(cli_wd_check(Disch,TotPos),cli_wd_check(Disch,TotPos)),
753 if_option_set(cli_wd_inv_proof(UnchangedNr,ProvenNr,TotPOsNr),cli_wd_inv_proof(UnchangedNr,ProvenNr,TotPOsNr)),
754 if_option_set(cli_start_mc_with_tlc,cli_start_mc_with_tlc),
755 if_option_set(cli_start_sym_mc_with_lts(LType),cli_start_sym_mc_with_lts(LType)),
756
757 if_option_set(cli_symbolic_model_check(Algorithm),cli_symbolic_model_check(Algorithm)),
758
759 if_option_set_loaded(cli_check_properties,check_properties,
760 cli_check_properties(NOW)),
761 ifm_option_set_loaded(cli_check_assertions(ALL,ReqInfos),check_assertions,
762 cli_check_assertions(ALL,ReqInfos,NOW)),
763 if_option_set(set_goal(GOAL),
764 cli_set_goal(GOAL)),
765 if_option_set(set_searchscope(SCOPE),
766 cli_set_searchscope(SCOPE)),
767 ifm_option_set_loaded(cli_mc(Nr,MCOpts),model_check,
768 cli_start_model_check(Nr,NOW,MCOpts)),
769 ifm_option_set_loaded(cli_random_animate(Steps,ErrOnDeadlock),animate,
770 cli_random_animate(NOW,Steps,ErrOnDeadlock)),
771 ifm_option_set_loaded(execute(ESteps,ErrOnDeadlock,From),execute,
772 cli_execute(ESteps,ErrOnDeadlock,From)),
773 ifm_option_set_loaded(animate_until_ltl(LTLFormula,ExOption,ExpResult,ExpSteps),execute,
774 animate_until_ltl(LTLFormula,ExOption,ExpResult,ExpSteps)),
775 if_option_set_loaded(pa_check,predicate_analysis,
776 test_predicate_analysis),
777
778 cbc_check(NOW),
779
780 ifm_option_set_loaded(logxml_write_ids(Prefix,IDScope),logxml_write_ids,
781 logxml_write_ids(Prefix,IDScope)),
782
783 if_options_set(generate_read_write_matrix_csv(RWCsvFile),
784 generate_read_write_matrix(RWCsvFile)),
785 if_options_set(feasibility_analysis_csv(TimeOut,EnablingCsvFile),
786 do_feasibility_analysis(TimeOut,EnablingCsvFile)),
787 ifm_option_set_loaded(mcm_tests(ADepth1,AMaxS,ATarget1,Output1),mcm_test_cases,
788 mcm_test_case_generation(ADepth1,AMaxS,ATarget1,Output1)),
789 ifm_option_set_loaded(all_deadlocking_paths(File),all_deadlocking_paths,
790 write_all_deadlocking_paths_to_xml(File)),
791 ifm_option_set_loaded(cbc_tests(ADepth2,ATarget2,Output2),cb_test_cases,
792 cbc_test_case_generation(ADepth2,ATarget2,Output2)),
793 ifm_option_set_loaded(test_description(TestDescFile),cb_test_cases,
794 test_generation_by_xml_description(TestDescFile)),
795 if_options_set(csp_in_situ_refinement_check(RP,RType,RQ),
796 cli_csp_in_situ_refinement_check(RP,RType,RQ,NOW)),
797 if_options_set(csp_checkAssertion(Proc,Model,AssertionType),
798 cli_checkAssertion(Proc,Model,AssertionType,NOW)),
799 if_options_set(check_csp_assertion(Assertion),
800 cli_check_csp_assertion(Assertion,NOW)),
801 if_options_set(refinement_check(RefFile,PerformSingleFailures,RefNrNodes),
802 cli_start_refinement_check(RefFile,PerformSingleFailures,RefNrNodes,NOW)),
803 if_options_set(ctl_formula_model_check(CFormula,CExpected),
804 (timeout_call(cli_ctl_model_check(CFormula,init,CExpected,_),NOW,ctl_model_check) -> true; true)),
805 if_options_set(pctl_formula_model_check(PFormula,PExpected),
806 (timeout_call(cli_pctl_model_check(PFormula,init,PExpected,_),NOW,ctl_model_check) -> true; true)),
807 % TO DO print ctl/ltl statistics
808 if_options_set(csp_get_assertions,cli_csp_get_assertions),
809 if_options_set(eval_csp_expression(CspExpr),cli_eval_csp_expression(CspExpr)),
810 if_options_set(csp_translate_to_file(PlFile),cli_csp_translate_to_file(PlFile)),
811 if_options_set(get_coverage_information(CovFileName),cli_get_coverage_information(CovFileName)), %% TODO: replace
812 if_options_set(vacuity_check,cli_vacuity_check),
813 if_option_set_loaded(check_goal,check_goal,cli_check_goal),
814 if_option_set_loaded(animate,animate,
815 (interactive_animate_machine -> true ; true)),
816 if_option_set(ltsmin, start_ltsmin_srv('/tmp/ltsmin.probz', NOW)),
817 if_option_set(ltsmin2(EndpointPath), start_ltsmin_srv(EndpointPath, NOW)),
818 if_option_set(ltsmin_ltl_output(Path), ltsmin_ltl_output(Path, NOW)),
819 if_options_set(run_benchmark(Kind,Option,Path), run_benchmark(Kind,Option,Path)),
820 evaluate_from_commandline,
821 if_option_set_loaded(ltl_assertions,check_ltl_assertions,
822 (timeout_call(ltl_check_assertions,NOW,check_ltl_assertions) -> true; true)),
823 ifm_option_set_loaded(ltl_formula_model_check(LFormula,LExpected),check_ltl_assertions,
824 (option(cli_start_sym_mc_with_lts(_))-> true % we request LTSMin, do not start prob model check
825 ; timeout_call(cli_ltl_model_check(LFormula,init,LExpected,_),NOW,ltl_formula_model_check)
826 -> true; true)),
827 ifm_option_set_loaded(ltl_file(LtlFilename),check_ltl_file,
828 (ltl_check_file(LtlFilename) -> true; true)),
829 ifm_option_set_loaded(visb_history(VJSONFile,VHTMLFile,Options),visb,
830 cli_visb_history(VJSONFile,VHTMLFile,Options)),
831 ifm_option_set_loaded(history(HistoryFilename),history,
832 cli_print_history(HistoryFilename)),
833 ifm_option_set_loaded(print_values(ValuesFilename),sptxt,
834 cli_print_values(ValuesFilename)),
835 ifm_option_set_loaded(print_all_values(ValuesDirname),print_all_values,
836 cli_print_all_values(ValuesDirname)),
837 ifm_option_set_loaded(generate_all_traces_until(LTL_Stop_AsAtom,FilePrefix),generate_all_traces_until,
838 cli_generate_all_traces_until(LTL_Stop_AsAtom,FilePrefix)),
839 if_options_set(save_state_for_refinement(SaveRefF),
840 tcltk_save_specification_state_for_refinement(SaveRefF)),
841 if_options_set(rule_report(File),
842 rule_validation:generate_report(File)),
843 if_options_set(dot_command(DCommand1,DotFile1,DotEngine1),
844 dot_command(DCommand1,DotFile1,DotEngine1)),
845 if_options_set(dot_command_for_expr(DECommand,Expr,DotFile,Opts,DotEngine),
846 dot_command_for_expr(DECommand,Expr,DotFile,Opts,DotEngine)),
847 if_options_set(plantuml_command(PCommand1,UmlFile1),
848 plantuml_command(PCommand1,UmlFile1)),
849 if_options_set(plantuml_command_for_expr(PECommand,Expr,UmlFile,Opts),
850 plantuml_command_for_expr(PECommand,Expr,UmlFile,Opts)),
851 if_options_set(csv_table_command(TECommand,TableFormulas,TableOptions,TableCSVFile),
852 csv_table_command(TECommand,TableFormulas,TableOptions,TableCSVFile)),
853 if_options_set(evaluate_expression_over_history_to_csv_file(HistExpr,HistDotFile),
854 tcltk_interface:evaluate_expression_over_history_to_csv_file(HistExpr,HistDotFile)),
855 if_options_set(enabling_analysis_csv(EnablingCsvFile),
856 do_enabling_analysis_csv(EnablingCsvFile,NOW)),
857 if_options_set(process_latex_file(LatexF1,LatexF2),
858 process_latex_file(LatexF1,LatexF2)),
859 ifm_option_set(coverage(Nodes,Operations,ShowEnabledInfo),
860 cli_show_coverage(Nodes,Operations,ShowEnabledInfo,NOW)),
861 ifm_option_set(check_statespace_hash(ExpectedHash,Kind),
862 cli_check_statespace_hash(ExpectedHash,Kind)),
863 ifm_option_set(check_op_cache(ExpectedC),
864 cli_check_op_cache(ExpectedC)),
865 ifm_option_set(coverage(ShowEnabledInfo),
866 cli_show_coverage(ShowEnabledInfo,NOW)),
867 if_option_set(save_state_space(StateFile),
868 save_state_space(StateFile)),
869 ifm_option_set(cli_print_statistics(SPARA),
870 cli_print_statistics(SPARA)),
871 if_option_set(show_cache(SCVM),
872 show_cache(SCVM)),
873 if_option_set(cli_cache_stats_check(CStats),cli_cache_stats_check(CStats)),
874 if_option_set(check_complete, check_complete),
875 if_option_set(check_complete_operation_coverage, check_complete_operation_coverage),
876 if_option_set(check_scc_for_ltl_formula(LtlFormula,SCC),cli_check_scc_for_ltl_formula(LtlFormula,SCC)).
877
878 % what needs to be done for files like .po files, where all processing is already done:
879 cli_process_options_for_alrady_fully_processed_file(_MainFile) :-
880 ifm_option_set(cli_print_statistics(SPARA),
881 cli_print_statistics(SPARA)).
882
883 show_cache(default) :- !,
884 (option_verbose -> show_cache(normal) ; show_cache(verbose)).
885 show_cache(Verbose) :-
886 show_cache_file_contents(Verbose).
887
888 cli_cache_stats_check(Expected) :-
889 get_value_persistance_stats(Stats),
890 check_required_infos(Expected,Stats,check_cache_stats).
891
892 % new profiler
893 %:- use_module('../extensions/profiler/profiler.pl').
894 %cli_print_statistics :- pen,nl,garbage_collect,statistics,nl,state_space:state_space_initialise_with_stats.
895
896 :- use_module(runtime_profiler,[print_runtime_profile/0]).
897 :- use_module(source_profiler,[print_source_profile/0]).
898 :- use_module(memoization,[print_memo_profile/0]).
899 :- use_module(state_packing,[print_state_packing_profile/0]).
900 :- use_module(external_functions,[print_external_function_instantiation_profile/0]).
901
902 % old profiler
903 :- use_module(covsrc(hit_profiler),[print_hit_profile_statistics/0]).
904 :- use_module(extrasrc(b_operation_cache),[print_op_cache_profile/0, reset_b_operation_cache_with_statistics/0]).
905 :- use_module(memoization,[reset_memo_with_statistics/0]).
906 :- use_module(disproversrc(disprover),[print_prover_result_stats/0]).
907 :- use_module(probsrc(tools),[print_mb/1]).
908 cli_print_statistics(hshow) :- !,
909 print_machine_topological_order.
910 cli_print_statistics(memory) :- !,
911 print_memory_statistics(user_output).
912 cli_print_statistics(value_persistance_stats) :- !,
913 print_value_persistance_stats.
914 cli_print_statistics(sicstus_profile) :- !,
915 format('SICStus Prolog PROFILE STATISTICS~n',[]),
916 sicstus_profile_statistics.
917 cli_print_statistics(disprover_profile) :- !,
918 print_prover_result_stats.
919 cli_print_statistics(prob_profile) :- !,
920 statistics(walltime,[WT,_]),
921 statistics(runtime,[RT,_]),
922 format('--------------------------~nPROB PROFILING INFORMATION after ~w ms walltime (~w ms runtime) ',[WT,RT]),
923 statistics_memory_used(M), print_mb(M),nl,
924 print_source_profile,
925 print_runtime_profile,
926 print_memo_profile,
927 print_state_packing_profile,
928 print_external_function_instantiation_profile,
929 (get_preference(operation_reuse_setting,false) -> true ; print_op_cache_profile). % relevant for test 2152 under SWI
930 cli_print_statistics(hit_profile) :- !,
931 (print_hit_profile_statistics -> true ; true). % mainly used by external functions
932 cli_print_statistics(op_cache_profile) :- !,
933 get_preference(try_operation_reuse,OR),
934 format('PROB OPERATION_REUSE (value:~w) STATISTICS~n',[OR]),
935 print_op_cache_profile.
936 cli_print_statistics(full) :- format('PROB FULL STATISTICS~n',[]),
937 sicstus_profile_statistics,
938 garbage_collect,
939 statistics,
940 nl,
941 print_op_cache_profile,
942 print_prover_result_stats,
943 state_space:state_space_initialise_with_stats,
944 reset_memo_with_statistics,
945 reset_b_operation_cache_with_statistics.
946
947 print_memory_statistics(Stream) :-
948 garbage_collect,
949 write(Stream,'ProB memory used: '),
950 print_memory_used_wo_gc(Stream), nl(Stream), flush_output(Stream).
951
952 sicstus_profile_statistics :-
953 %(hit_profiler:print_hit_profile_statistics -> true ; true), % only used by external functions
954 (option(profiling_on)
955 -> catch(print_profile,
956 error(existence_error(_,_),_),
957 print_red('SICStus Prolog Profiler can only be used when running from source'))
958 ; true).
959
960
961 :- use_module(state_space,[not_all_transitions_added/1, not_invariant_checked/1,
962 not_interesting/1, get_operation_name_coverage_infos/4]).
963 check_complete :-
964 (tcltk_find_max_reached_node(Node1) ->
965 add_error(check_complete,'Maximum number of transitions reached for at least one state: ',Node1) ; true),
966 (not_all_transitions_added(Node2) ->
967 add_error(check_complete,'At least one state was not examined: ',Node2) ; true),
968 (not_invariant_checked(Node3) ->
969 add_error(check_complete,'The invariant was not checked for at least one state: ',Node3) ; true),
970 (not_interesting(Node4) ->
971 add_message(check_complete,'At least one state was ignored (not satisfying the SCOPE predicate): ',Node4) ; true).
972
973 check_complete_operation_coverage :-
974 (state_space: operation_name_not_yet_covered(OpName) ->
975 add_error(check_complete_operation_coverage,'At least one operation is not covered: ', OpName)
976 ; true).
977
978 show_operation_coverage_summary(NOW) :-
979 get_operation_name_coverage_infos(PossibleNr,FeasibleNr,UncovNr,UncoveredList),
980 writeln_log(uncovered_info(NOW,PossibleNr,UncoveredList)),
981 (UncovNr=0 -> format(' All ~w possible operations have been covered',[PossibleNr]),nl
982 ; (FeasibleNr=PossibleNr
983 -> format(' The following ~w operations (out of ~w) were not covered:~n ~w~n',
984 [UncovNr, PossibleNr,UncoveredList])
985 ; INr is PossibleNr-FeasibleNr,
986 format(' The following ~w operations (out of ~w with ~w infeasible) were not covered:~n ~w~n',
987 [UncovNr, PossibleNr, INr,UncoveredList])
988 )).
989 show_initialisation_summary(NOW) :-
990 findall(ID,state_space:is_concrete_constants_state_id(ID),L),
991 length(L,Nr), N1 is Nr+1, % for root
992 writeln_log(uninitialised_states(NOW,N1)),
993 format(' Uninitialised states: ~w (root and constants only)~n',[N1]).
994
995 % ---------------------
996
997 animation_mode_does_not_support_animation(File) :-
998 loaded_main_file(smt2,File).
999 cli_start_animation(NOW) :-
1000 file_loaded(true,LoadedFile),
1001 \+ animation_mode_does_not_support_animation(LoadedFile),
1002 !,
1003 debug_println(20,'% Starting Animation'),
1004 writeln_log_time(start_animation(NOW)),
1005 start_probcli_timer(Timer1),
1006 start_animation_without_computing,
1007 stop_probcli_debug_timer(Timer1,'% Finished Starting Animation'),
1008 if_option_set(add_csp_guide(CspGuide), tcltk_add_csp_file(CspGuide)),
1009
1010 xml_log_machine_statistics,
1011 getAllOperations(Ops),
1012 debug_print(20,'Operations: '), debug_println(20,Ops),
1013
1014 (we_need_only_static_assertions(ALL)
1015 -> debug_println(20,'% Projecting on static ASSERTIONS'),
1016 b_interpreter:set_projection_on_static_assertions(ALL) ; true),
1017
1018 (option(load_state(File))
1019 -> debug_println(20,'% Loading stored state from file'),
1020 state_space:tcltk_load_state(File)
1021 ; computeOperations_for_root_required ->
1022 debug_println(20,'% Searching for valid initial states'),
1023 start_probcli_timer(Timer2),
1024 cli_computeOperations(EO),
1025 stop_probcli_debug_timer(Timer2,'% Finished searching for valid initial states'),
1026 debug_println(10,EO)
1027 ; debug_println(20,'% No initialisation required')
1028 ).
1029 cli_start_animation(_NOW).
1030
1031 start_animation_without_computing :-
1032 update_preferences_from_spec(ListOfPrefs),
1033 (ListOfPrefs=[] -> true ; write_prolog_term_as_xml_to_log(b_machine_preferences(ListOfPrefs))),
1034 set_prefs, % override SET_PREF in DEFINITIONS with values from command-line;
1035 start_animation,
1036 ifm_option_set(add_additional_property(PROP),
1037 cli_add_additional_property(PROP)),
1038 get_errors.
1039
1040 animate_until_ltl(LTLFormula,ExOption,ExpectedResult,ExpectedNrSteps) :-
1041 tcltk_animate_until(LTLFormula,ExOption,StepsExecuted,Result),
1042 formatsilent('Found trace of length ~w for LTL formula. Result: ~w ~n',[StepsExecuted,Result]),
1043 print_history_as_counter_example(false), % TODO: only print from current id before command
1044 (ExpectedResult=Result -> true % Result can be ltl_found, maximum_nr_of_steps_reached, deadlock
1045 ; add_error(animate_until_ltl,'Unexpected animation result: ',Result),
1046 error_occurred(animate_until_ltl)
1047 ),
1048 (ExpectedNrSteps=StepsExecuted -> true
1049 ; add_error(animate_until_ltl,'Unexpected number of animation steps: ',StepsExecuted),
1050 error_occurred(animate_until_ltl)
1051 ).
1052
1053 % ---------------------
1054
1055 % an execution engine with minimal overhead: states are not stored in visited_expression database, only first enabled operation is taken
1056
1057 cli_execute(Steps,ErrorOnDeadlock,FromWhere) :-
1058 temporary_set_preference(operation_reuse_setting,false,ChangeOccured),
1059 (ChangeOccured=true % operation reuse not compatible with cut used below after solution found
1060 -> add_debug_message(execute_model,'Disabling OPERATION_REUSE preference for -execute ',Steps) ; true),
1061 call_cleanup(cli_execute2(Steps,ErrorOnDeadlock,FromWhere),
1062 reset_temporary_preference(operation_reuse_setting,ChangeOccured)).
1063 cli_execute2(Steps,ErrorOnDeadlock,FromWhere) :-
1064 FromWhere=from_all_initial_states,!,
1065 % try out all initial states and from each of those perform deterministic execution
1066 start_ms_timer(Start),
1067 format('Running execute from all initial states~n',[]),
1068 reset_counter(cli_execute_inits),
1069 findall(Result,
1070 (cli_trans(root,Action,CurState,0,'$NO_OPERATION'), %print(Action),nl,
1071 (\+ functor(Action,'$setup_constants',_)
1072 -> inc_counter(cli_execute_inits,Nr),
1073 format('~nExecuting model from initial state ~w~n',[Nr]),
1074 (option(animate_stats) -> print_state_silent(CurState) ; true),
1075 (cli_execute_from(CurState,Steps,ErrorOnDeadlock,1,Result) -> true)
1076 ; format('~nInitialising state~n',[]), % we need to execute initialise_machine
1077 cli_trans(CurState,_ActionName,NewState,0,'$NO_OPERATION'),
1078 inc_counter(cli_execute_inits,Nr),
1079 format('~nExecuting model from initial state ~w with constants~n',[Nr]),
1080 (option(animate_stats) -> print_state_silent(NewState) ; true),
1081 (cli_execute_from(NewState,Steps,ErrorOnDeadlock,2,Result) -> true)
1082 )), Results),
1083 get_counter(cli_execute_inits,Nr),
1084 format('---------~nTotal runtime for all ~w executions:',[Nr]),nl,
1085 stop_ms_timer(Start),
1086 count_occurences(Results,Occs), format('Results: ~w~n',[Occs]).
1087 cli_execute2(Steps,ErrorOnDeadlock,current_state(Repetitions)) :-
1088 current_expression(ID,CurState),
1089 start_xml_feature(execute,max_steps,Steps,FINFO),
1090 start_ms_timer(Start),
1091 (between(1,Repetitions,RepNr),
1092 % with -strict option we will stop after first error found
1093 % for repetitions you should probably set RANDOMISE_OPERATION_ORDER and RANDOMISE_ENUMERATION_ORDER to TRUE
1094 debug_format(19,'Starting execute (~w/~w) from state ~w with maximum number of steps ~w~n',[RepNr,Repetitions,ID,Steps]),
1095 (cli_execute_from(CurState,Steps,ErrorOnDeadlock,1,_Result) -> fail ; fail)
1096 ; Repetitions>1 -> stop_ms_timer_with_msg(Start,'-execute-repeat')
1097 ; true),
1098 stop_xml_feature(execute,FINFO).
1099
1100 :- use_module(bmachine,[b_top_level_operation/1]).
1101 allow_filter_unused_constants :-
1102 b_or_z_mode,
1103 b_top_level_operation(_), % we can filter out unused constants, unless there are no operations in which case the user probably wants to see the constant values
1104 \+ options_can_eval_any_cst,
1105 \+ option(cache_storage(_,_)). % we do not know what constants other machines using the cache may use
1106
1107 options_can_eval_any_cst :- option(eval_repl(_)).
1108 options_can_eval_any_cst :- option(eval_string_or_file(_,_,_,_,_)).
1109 options_can_eval_any_cst :- option(dot_command(_,_,_)).
1110 options_can_eval_any_cst :- option(dot_command_for_expr(_,_,_,_,_)).
1111 options_can_eval_any_cst :- option(process_latex_file(_,_)).
1112 options_can_eval_any_cst :- option(logxml_write_ids(all,_)). % the user writes out constants (not just variables) to file: also do not filter
1113
1114 :- dynamic execute_timeout_occurred/0.
1115
1116 cli_execute_from(CurState,Steps,ErrorOnDeadlock,FirstStepNr,Result) :-
1117 retractall(max_walltime(_,_,_)),
1118 retractall(execute_timeout_occurred),
1119 start_ms_timer(Start),
1120 (allow_filter_unused_constants -> temporary_set_preference(filter_unused_constants,true,CHNG) ; true),
1121 cli_execute_aux(FirstStepNr,Steps,CurState,_MEMO,ErrorOnDeadlock,'$NO_OPERATION',Result),
1122 (allow_filter_unused_constants -> reset_temporary_preference(filter_unused_constants,CHNG) ; true),
1123 (option(silent) -> true ; stop_ms_timer_with_msg(Start,'-execute')),
1124 print_max_walltime.
1125
1126 :- use_module(tools_strings,[ajoin/2, ajoin_with_sep/3]).
1127 :- use_module(external_functions,[reset_side_effect_occurred/0, side_effect_occurred/1]).
1128 cli_execute_aux(Nr,Steps,CurState,_,_ErrorOnDeadlock,_LastActionName,Result) :- Nr>Steps,!,
1129 formatsilent('Stopping execution after ~w steps~n',[Steps]), Result = stopped,
1130 print_state_silent(CurState),
1131 cli_execute_add_virtual_transition(Steps,CurState,Result).
1132 cli_execute_aux(Nr,Steps,CurState0,MEMO,ErrorOnDeadlock,LastActionName,Result) :-
1133 (Nr mod 5000 =:= 0, \+option(animate_stats), \+option(silent)
1134 -> (var(LastActionName) -> format('Step ~w~n',[Nr])
1135 ; format('Step ~w (after ~w)~n',[Nr,LastActionName])),
1136 (option_verbose -> print_state_silent(CurState0) ; true),
1137 %copy_term(CurState0,CurState), tools_printing:print_term_summary((CurState0)),nl,
1138 !,
1139 garbage_collect,
1140 !,
1141 print('Memory used: '),print_memory_used_wo_gc,flush_output,nl %nl_time
1142 ; true),
1143 prepare_state_for_specfile_trans(CurState0,unknown,MEMO,CurState), % ensure we memoize expanded constants in MEMO
1144 % avoid re-expanding constants in every state !
1145 % relevant e.g. for probcli -execute 20001 DataValidationTestSmallStep.mch -init
1146 (cli_invariant_ko(CurState,LastActionName,InvStatus,CliErr) -> % also recognises no_inv command
1147 N1 is Nr-1,
1148 ajoin(['INVARIANT ',InvStatus,' after ',N1,' steps (after ',LastActionName,').'],ErrMsg),
1149 format('~w~n',[ErrMsg]),!,
1150 print_state_silent(CurState),
1151 error_occurred_with_msg(CliErr,ErrMsg),
1152 Result=CliErr,
1153 cli_execute_add_virtual_transition(N1,CurState,Result,NewID),
1154 %(option_verbose -> b_interpreter:analyse_invariant_for_state(NewID) ; true)
1155 b_interpreter:analyse_invariant_for_state(NewID)
1156 ; cli_assertions_ko(CurState,LastActionName,AssRes) -> % also recognises no_inv command
1157 N1 is Nr-1,
1158 format('ASSERTIONS ~w after ~w steps (after ~w).~n',[AssRes,N1,LastActionName]),!,
1159 print_state_silent(CurState),
1160 error_occurred(assertion_violation), Result=assertion_violation,
1161 cli_execute_add_virtual_transition(N1,CurState,Result)
1162 ; cli_goal_found(CurState) -> % also recognizes no_goal command
1163 N1 is Nr-1,
1164 format('GOAL FOUND after ~w steps (after ~w).~n',[N1,LastActionName]),!,
1165 print_state_silent(CurState), Result=goal_found,
1166 cli_execute_add_virtual_transition(N1,CurState,Result)
1167 ; reset_side_effect_occurred,
1168 cli_trans(CurState,ActionName,NewState,Nr,LastActionName), % Compute new transition
1169 !,
1170 N1 is Nr+1,
1171 (NewState=CurState0, % could be expensive for large states; states are expanded ! % TO DO: look only at written variables ?!
1172 \+ side_effect_occurred(file)
1173 -> formatsilent('Infinite loop reached after ~w steps (looping on ~w).~n',[N1,ActionName]),
1174 Result=loop,
1175 print_state_silent(CurState),
1176 cli_execute_add_virtual_transition(N1,CurState,Result)
1177 ; cli_execute_aux(N1,Steps,NewState,MEMO,ErrorOnDeadlock,ActionName,Result))
1178 ).
1179 cli_execute_aux(Nr,_Steps,CurState,_,_ErrorOnDeadlock,LastActionName,Result) :- execute_timeout_occurred,!,
1180 N1 is Nr-1,
1181 formatsilent('Timeout occurred after ~w steps (after ~w).~n',[N1,LastActionName]),
1182 Result=time_out,
1183 print_state_silent(CurState),
1184 cli_execute_add_virtual_transition(N1,CurState,Result).
1185 cli_execute_aux(Nr,_Steps,CurState,_,ErrorOnDeadlock,LastActionName,Result) :- N1 is Nr-1,
1186 formatsilent('Deadlock reached after ~w steps (after ~w).~n',[N1,LastActionName]),
1187 Result=deadlock,
1188 (ErrorOnDeadlock=true,\+ option(no_deadlocks) -> error_occurred(deadlock) ; true),
1189 print_state_silent(CurState),
1190 cli_execute_add_virtual_transition(N1,CurState,Result).
1191
1192 check_nr_of_steps(Steps) :- option(execute_expect_steps(ExpSteps)),
1193 (Steps = ExpSteps -> formatsilent('The expected number of steps were executed: ~w~n',[Steps]),fail
1194 ; true),
1195 !,
1196 ajoin(['Unexpected number of steps ',Steps,', expected:'],Msg),
1197 add_error(cli_execute,Msg,ExpSteps).
1198 check_nr_of_steps(_).
1199
1200 cli_execute_add_virtual_transition(Steps,CurState,Result) :-
1201 cli_execute_add_virtual_transition(Steps,CurState,Result,_).
1202 cli_execute_add_virtual_transition(Steps,CurState,Result,ToID) :-
1203 current_state_id(CurID),
1204 write_xml_element_to_log(executed,[steps/Steps,result/Result]),
1205 (Steps=0 -> true
1206 ; some_command_requires_state_space % check whether storing is actually useful for any outstanding command
1207 -> (CurID=root
1208 -> tcltk_interface:tcltk_add_cbc_state(CurState,'$execute'(Steps)) % generate separate constants state
1209 ; tcltk_interface:tcltk_add_new_transition(CurID,'$execute'(Steps),ToID,CurState,[]),
1210 tcltk_goto_state('$execute'(Steps),ToID)
1211 ),
1212 debug_format(19,'Added transition ~w -> ~w to state space for ~w execution steps~n',[CurID,ToID,Steps])
1213 ; debug_format(19,'Not adding transition for -execute ~w steps; not required by other commands~n',[Steps])
1214 ),
1215 check_nr_of_steps(Steps).
1216
1217 some_command_requires_state_space :-
1218 option(X),
1219 \+ does_not_require_state_space(X),
1220 !.
1221 does_not_require_state_space(execute_expect_steps(_)).
1222 does_not_require_state_space(execute(_,_,_)).
1223 does_not_require_state_space(animate_stats).
1224 does_not_require_state_space(execute_monitoring).
1225 does_not_require_state_space(set_pref(_,_)).
1226 does_not_require_state_space(set_preference_group(_,_)).
1227 does_not_require_state_space(timeout(_)).
1228 does_not_require_state_space(verbose(_)).
1229 does_not_require_state_space(verbose_off).
1230 does_not_require_state_space(silent).
1231 does_not_require_state_space(force_no_silent).
1232 does_not_require_state_space(strict_raise_error).
1233 does_not_require_state_space(release_java_parser).
1234 does_not_require_state_space(fast_read_prob).
1235 does_not_require_state_space(file_info).
1236 does_not_require_state_space(print_version(_)).
1237 does_not_require_state_space(check_java_version).
1238 does_not_require_state_space(pretty_print_internal_rep(_,_,_,_)).
1239 does_not_require_state_space(expect_error(_)).
1240 does_not_require_state_space(optional_error(_)).
1241 does_not_require_state_space(no_deadlocks).
1242 does_not_require_state_space(no_invariant_violations).
1243 does_not_require_state_space(no_goal).
1244 does_not_require_state_space(no_assertion_violations).
1245 does_not_require_state_space(no_state_errors).
1246 does_not_require_state_space(no_counter_examples).
1247 does_not_require_state_space(no_color).
1248 % TODO: register more commands that do not require the state space
1249
1250 :- dynamic max_walltime/3.
1251 print_max_walltime :- (max_walltime(Action,Nr,WT),option_verbose
1252 -> format('% Maximum walltime ~w ms at step ~w for ~w.~n',[WT,Nr,Action]) ; true).
1253
1254 % will be used to compute a single successor
1255 % b_operation_cannot_modify_state
1256 cli_trans(CurState,ActionName,NewState,Nr,LastActionName) :-
1257 option(animate_stats),!, % provide statistics about the animation
1258 start_probcli_timer(Timer),
1259 cli_trans_aux(CurState,ActionName,Act,NewState,Nr,LastActionName),
1260 (option_verbose -> translate:translate_event(Act,TStr)
1261 ; translate:translate_event_with_limit(Act,100,TStr)),
1262 format('~w~5|: ~w~n',[Nr,TStr]),
1263 format(' ~5|',[]),stop_probcli_timer(Timer,' '),
1264 (option_verbose -> format(' ~5|',[]),print_memory_used_wo_gc,nl ; true),
1265 flush_output,
1266 get_probcli_elapsed_walltime(Timer,WallTime),
1267 get_probcli_elapsed_runtime(Timer,RunTime),
1268 accumulate_infos(animate_stats,[step-1,step_nr-Nr,runtime-RunTime,walltime-WallTime]),
1269 (max_walltime(_,_,MWT), MWT >= WallTime -> true
1270 ; retractall(max_walltime(_,_,_)),
1271 assertz(max_walltime(ActionName,Nr,WallTime))).
1272 cli_trans(CurState,ActionName,NewState,Nr,LastActionName) :-
1273 cli_trans_aux(CurState,ActionName,_,NewState,Nr,LastActionName).
1274
1275 cli_trans_aux(CurState,ActionName,Act,NewState,Nr,LastActionName) :-
1276 option(timeout(TO)),!,
1277 safe_time_out(cli_trans_aux2(CurState,ActionName,Act,NewState,LastActionName),TO,Res),
1278 (Res=time_out -> format_error_with_nl('! Timeout occurred while performing step ~w of execute: ~w ms',[Nr,TO]),
1279 % TO DO: try and obtain operation name in which time-out occured
1280 error_occurred(time_out,execute),
1281 assertz(execute_timeout_occurred),
1282 fail
1283 ; true).
1284 cli_trans_aux(CurState,ActionName,Act,NewState,_Nr,LastActionName) :-
1285 cli_trans_aux2(CurState,ActionName,Act,NewState,LastActionName).
1286
1287 cli_trans_aux2(CurState,ActionName,Act,NewState,LastActionName) :-
1288 catch_enumeration_warning_exceptions(
1289 (throw_enumeration_warnings_in_current_scope,
1290 cli_execute_trans(CurState,ActionName,Act,NewState,LastActionName), % no time-out !
1291 (error_occurred_in_error_scope -> ErrorEvent=true ; ErrorEvent=false)
1292 ),
1293 (error_occurred(virtual_time_out_execute),
1294 ActionName = '*** VIRTUAL_TIME_OUT ***', Act=ActionName,
1295 CurState=NewState) % this forces loop detection above; not very elegant way of signalling
1296 ),
1297 (ErrorEvent==true,option(strict_raise_error)
1298 -> print('*** ERROR OCCURED DURING EXECUTE ***'),nl, error_occurred(execute),fail
1299 ; true).
1300
1301 :- use_module(runtime_profiler,[profile_single_call/3]).
1302 :- use_module(specfile,[get_specification_description/2]).
1303 cli_execute_trans(CurState,ActionName,Act,NewState,LastActionName) :-
1304 statistics(runtime,[StartExecuteForState,_]),
1305 get_possible_next_operation_for_execute(CurState,LastActionName,ActionName),
1306 start_check_disabled(ActionName,StartActionTime),
1307 catch(
1308 profile_single_call(ActionName,
1309 unknown, % state Unknown
1310 specfile_trans_with_check(CurState,ActionName,Act,NewState,Residue) % no time-out !
1311 ),
1312 EXC,
1313 (translate_exception(EXC,EMSG),
1314 (nonvar(ActionName)
1315 -> get_specification_description(operation,OP),
1316 format_with_colour_nl(user_error,[red,bold],'~n*** ~w while executing ~w "~w"~n',[EMSG,OP,ActionName])
1317 ; get_specification_description(operations,OP),
1318 format_with_colour_nl(user_error,[red,bold],'~n*** ~w while computing ~w~n',[EMSG,OP])
1319 ),
1320 perform_feedback_options_after_exception,
1321 throw(EXC))),
1322 (Residue=[]
1323 -> check_trans_time(StartExecuteForState,StartActionTime,ActionName)
1324 ; error_occurred(cli_execute_residue(ActionName,Residue,Act))).
1325
1326 :- use_module(probsrc(static_enabling_analysis),[static_cannot_enable/2,
1327 static_disables_itself/1, static_disabled_after/2]).
1328 % compute all possible next operations to try out in -execute, based on LastActionName
1329 % the predicate makes use of the fact that operations are tried in order
1330 get_possible_next_operation_for_execute(CurState,LastActionName,ActionName) :-
1331 get_preference(randomise_operation_order,false),
1332 get_preference(use_po,true), % PROOF_INFO: should we use a proper preference for use_po_for_execute ?
1333 b_or_z_mode,
1334 b_top_level_operation(LastActionName),
1335 % prevent trying ActionName which we know is infeasible according to previous LastActionName
1336 % we rely on the fact that execute tries the operations in order
1337 findall(AN,specfile_possible_trans_name_for_successors(CurState,AN),ANS),
1338 !,
1339 member_with_last(ActionName,ANS,LastActionName,FoundLast),
1340 (var(FoundLast)
1341 -> % ActionName occurs before LastActionName, this means
1342 % we did try this ActionName at the last execution step and it was not possible
1343 % format('** Checking operation ~w against ~w~n',[ActionName,LastActionName]),debug:nl_time,
1344 %Note: we could use result of cbc enabling analysis if it was performed
1345 (static_cannot_enable(LastActionName,ActionName)
1346 -> %format('Operation ~w : ~w cannot be enabled by ~w : ~w~n',[Nr2,ActionName,Nr1,LastActionName]),
1347 %print('- '),
1348 fail
1349 ; true
1350 )
1351 ; ActionName=LastActionName, static_disables_itself(ActionName)
1352 -> %format('** Operation ~w cannot be enabled after itself~n',[ActionName]),
1353 fail
1354 %; static_disabled_after(LastActionName,ActionName) % TODO: check if this more general case is worth it
1355 % -> format('** Operation ~w cannot be enabled after ~w~n',[ActionName,LastActionName]),
1356 % fail
1357 ; true % we did not try this ActionName at the last execution step
1358 ).
1359 get_possible_next_operation_for_execute(CurState,_LastActionName,ActionName) :-
1360 specfile_possible_trans_name_for_successors(CurState,ActionName).
1361
1362 % like member but instantiate FoundLast when we pass the element Last
1363 member_with_last(X,[H|T],Last,FoundLast) :-
1364 (H=Last -> !,FoundLast=true, member(X,[H|T]) ; X=H).
1365 member_with_last(X,[_|T],Last,FoundLast) :- member_with_last(X,T,Last,FoundLast).
1366
1367 :- use_module(probsrc(value_persistance),[start_cache_execute_modus/1,stop_cache_execute_modus/0,
1368 add_new_transition_to_cache_from_expanded_state/4]).
1369 % also checks whether a setup_constants_inconsistent error should be raised:
1370 specfile_trans_with_check(CurState,ActionName,Act,NewState,Residue) :-
1371 start_cache_execute_modus(CacheInfo),
1372 if(specfile_trans_or_partial_trans(CurState,ActionName,Act,NewState,_TransInfo,Residue,Partial), % no time-out !
1373 (check_partial_trans(Partial,ActionName),
1374 (Partial=true -> true ; add_new_transition_to_cache_from_expanded_state(CurState,Act,NewState,CacheInfo)),
1375 stop_cache_execute_modus
1376 ),
1377 (stop_cache_execute_modus,
1378 check_deadlock_fail(ActionName) % add_deadlock_to_cache_from_expanded_state(CurState,ActionName)
1379 )
1380 ).
1381
1382 % check whether we should raise errors on deadlock in -execute:
1383 check_deadlock_fail('$setup_constants') :- !, error_occurred(setup_constants_inconsistent),fail.
1384
1385 % check whether we should raise errors due to partial transitions in -execute:
1386 check_partial_trans(true,'$setup_constants') :- !, error_occurred(setup_constants_inconsistent).
1387 check_partial_trans(true,ActionName) :- !, format('Unknown partial transition: ~w~n',[ActionName]),
1388 error_occurred(setup_constants_inconsistent).
1389 check_partial_trans(_,_).
1390
1391 % check if we did not spend too much time on disabled operations and print warning if we do
1392 check_trans_time(StartExecuteForState,StartActionTime,ActionName) :-
1393 option(execute_monitoring),
1394 statistics(runtime,[CurrentTime,_]),
1395 Delta1 is StartActionTime-StartExecuteForState,
1396 Delta2 is CurrentTime-StartActionTime,
1397 Delta1 > 100, Delta1 > Delta2,
1398 !,
1399 format_with_colour(user_output,[blue],'~n ~5|: WARNING from -execute_monitor: ~w ms for disabled operations and ~w ms for operation ~w itself~n',[Delta1,Delta2,ActionName]).
1400 check_trans_time(_,_,_).
1401
1402 % check if we did not spend too much time on a single disabled operations and print warning if we do
1403 start_check_disabled(ActionName,StartActionTime) :- option(execute_monitoring),!,
1404 statistics(runtime,[StartActionTime,_]),
1405 (true
1406 ; statistics(runtime,[EndActionTime,_]),
1407 Delta is EndActionTime - StartActionTime,
1408 Delta > 50,
1409 format_with_colour(user_output,[blue],'~n ~5|: WARNING from -execute_monitor: ~w ms for disabled operation ~w~n',[Delta,ActionName]),
1410 fail
1411 ).
1412 start_check_disabled(_,0).
1413
1414 translate_exception(user_interrupt_signal,'User-Interrupt (CTRL-C)').
1415 translate_exception(enumeration_warning(_,_,_,_,_),'Enumeration Warning').
1416 translate_exception(E,E).
1417
1418 :- use_module(bmachine,[b_machine_has_constants/0]).
1419 print_state_silent(_) :- option(silent),!.
1420 print_state_silent(CurState) :- (option_verbose;\+ b_machine_has_constants),!,
1421 translate:print_bstate_limited(CurState,1000,-1),nl.
1422 print_state_silent(CurState) :- remove_constants(CurState,VarState),
1423 % only print variables
1424 format('VARIABLES (use -v to see constants or -silent to suppress output):~n',[]),
1425 translate:print_bstate_limited(VarState,1000,-1),nl.
1426
1427 :- use_module(bmachine,[b_is_constant/1]).
1428 is_constant_binding(bind(C,_)) :- b_is_constant(C).
1429 remove_constants(const_and_vars(_,Vars),Res) :- !,Res=Vars.
1430 remove_constants([H|T],Res) :- !,exclude(prob_cli:is_constant_binding,[H|T],Res).
1431 remove_constants(root,Res) :- !,Res=[].
1432 remove_constants(concrete_constants(_),Res) :- !, Res=[].
1433 remove_constants(X,X).
1434
1435 % write vars to xml log file if they start with a given prefix
1436 logxml_write_ids(variables,Prefix) :- !,
1437 current_expression(_,CurState),
1438 remove_constants(CurState,VarState),
1439 % TO DO: store also final state in xml_log
1440 write_bstate_to_log(VarState,Prefix).
1441 logxml_write_ids(_,Prefix) :- !,
1442 current_expression(_,CurState),
1443 expand_const_and_vars_to_full_store(CurState,EState),
1444 write_bstate_to_log(EState,Prefix).
1445
1446 :- use_module(bmachine,[b_get_invariant_from_machine/1, b_specialized_invariant_for_op/2, b_machine_has_constants/0]).
1447 cli_invariant_ko(_,_,_,_) :- option(no_invariant_violations),!,fail. % user asks not to check it
1448 cli_invariant_ko(_,_,_,_) :- get_preference(do_invariant_checking,false),!,fail. % user asks not to check it via preference
1449 cli_invariant_ko(CurState,LastActionName,ResInvStatus,CliError) :-
1450 profile_single_call('INVARIANT',unknown,cli_invariant_ko2(CurState,LastActionName,ResInvStatus,CliError)).
1451 cli_invariant_ko2(CurState,LastActionName,ResInvStatus,CliError) :-
1452 state_corresponds_to_initialised_b_machine(CurState,BState),!,
1453 start_probcli_timer(InvTimer),
1454 (b_specialized_invariant_for_op(LastActionName,Invariant) -> true
1455 %, print('Specialized invariant: '),translate:print_bexpr(Invariant),nl
1456 ; b_get_invariant_from_machine(Invariant)),
1457 cli_test_pred(BState,'INVARIANT',Invariant,ResInvStatus),
1458 stop_probcli_debug_timer(InvTimer,'Finished Invariant Checking'),
1459 ResInvStatus \= 'TRUE',
1460 (ResInvStatus == 'FALSE' -> CliError = invariant_violation
1461 ; ResInvStatus == 'UNKNOWN' -> CliError = invariant_unknown
1462 ; ResInvStatus == 'TIME-OUT' -> CliError = invariant_time_out
1463 ; format_error_with_nl('Unexpected invariant status: ~w',[ResInvStatus]),
1464 CliError= invariant_unknown).
1465 %cli_invariant_ko(_,_,_,_) :- fail. % not yet initialised
1466
1467 :- use_module(b_interpreter,[b_test_boolean_expression_for_ground_state/4]).
1468 cli_test_pred(BState,PredKind,Pred) :- cli_test_pred(BState,PredKind,Pred,'TRUE').
1469 % comment in following clause to get more precise location for exceptions/virtual timeouts:
1470 %cli_test_pred(BState,PredKind,Pred,Res) :- option_verbose, bsyntaxtree:decompose_conjunct(Pred,A,B),!,
1471 % cli_test_pred(BState,PredKind,A,ResA), (ResA = 'TRUE' -> cli_test_pred(BState,PredKind,B,Res) ; Res = ResA).
1472 cli_test_pred(BState,PredKind,Pred,Res) :- option(timeout(TO)),!,
1473 debug_format(9,'Testing ~w with time-out ~w~n',[PredKind,TO]),
1474 safe_time_out(cli_test_pred2(BState,PredKind,Pred,Res), TO, TRes),
1475 (Res=time_out -> TRes='TIME-OUT' ; true).
1476 cli_test_pred(BState,PredKind,Pred,Res) :-
1477 debug_format(9,'Checking ~w without a time-out~n',[PredKind]),
1478 cli_test_pred2(BState,PredKind,Pred,Res).
1479 cli_test_pred2(BState,PredKind,Pred,Res) :-
1480 % currently does not do a time-out: % b_interpreter calls: time_out_with_enum_warning_one_solution_no_new_error_scope
1481 catch(
1482 on_enumeration_warning(b_test_boolean_expression_for_ground_state(Pred,[],BState,PredKind ), (
1483 add_error(cli_test_pred,'Enumeration warning while testing',PredKind,Pred),
1484 cli_print_pred_info(Pred),
1485 Res='UNKNOWN')
1486 ),
1487 E,
1488 (
1489 ajoin(['VIRTUAL TIME-OUT or exception while testing ',PredKind,': '],Msg),
1490 add_error(cli_test_pred,Msg,E,Pred), % E can also be user_interrupt_signal
1491 cli_print_pred_info(Pred),
1492 Res='UNKNOWN'
1493 )
1494 ),
1495 !,
1496 (var(Res) -> Res = 'TRUE' ; true).
1497 cli_test_pred2(_BState,_PredKind,_Pred,'FALSE').
1498
1499 cli_print_pred_info(Pred) :- get_texpr_label(Pred,Label),
1500 format('Label = ~w~n',[Label]),fail.
1501 cli_print_pred_info(Pred) :- get_texpr_description(Pred,Desc),
1502 format('Description = ~w~n',[Desc]),fail.
1503 %cli_print_pred_info(Pred) :- bsyntaxtree:get_texpr_pos(Pred,Pos), Pos \= none, translate_span(Pos,Str),
1504 % format('Location = ~w~n',[Str]),fail.
1505 cli_print_pred_info(Pred) :-
1506 option_verbose,
1507 write('Predicate: '), translate:nested_print_bexpr(Pred),nl.
1508
1509 :- use_module(bmachine,[get_assertions_from_machine/2]).
1510 % TO DO: also check static assertions
1511 cli_assertions_ko(_,_,_) :- option(no_assertion_violations),!,fail. % user asks not to check it
1512 cli_assertions_ko(CurState,_LastActionName,Res) :-
1513 state_corresponds_to_initialised_b_machine(CurState,BState),
1514 get_assertions_from_machine(dynamic,Assertions), % TO DO: do something similar to b_specialized_invariant_for_op
1515 !,
1516 profile_single_call('ASSERTIONS',unknown,cli_assertions_ko2(BState,Assertions,Res)).
1517
1518
1519 cli_assertions_ko2(BState,Assertions,Res) :-
1520 start_probcli_timer(AssTimer),
1521 %nl,nl,print(check),nl,maplist(translate:print_bexpr,Assertions),nl,
1522 (member(Ass,Assertions),
1523 cli_test_pred(BState,'ASSERTION',Ass,Res),
1524 Res \= 'TRUE' -> true
1525 ; Res = 'TRUE'
1526 ),
1527 stop_probcli_debug_timer(AssTimer,'Finished Checking Assertions'),
1528 Res \= 'TRUE'.
1529
1530
1531 :- use_module(bmachine,[b_get_machine_goal/1]).
1532 cli_goal_found(_):- option(no_goal),!,fail.
1533 cli_goal_found(CurState) :-
1534 b_get_machine_goal(Goal),
1535 state_corresponds_to_initialised_b_machine(CurState,BState),
1536 profile_single_call('GOAL',unknown,cli_goal_found2(Goal,BState)).
1537 cli_goal_found2(Goal,BState) :-
1538 b_test_boolean_expression_for_ground_state(Goal,[],BState,'GOAL').
1539
1540
1541 % random animation
1542 :- public cli_random_animate/2. % for repl to use -animate command
1543 cli_random_animate(Steps,Err) :- probcli_time_stamp(NOW),
1544 cli_random_animate(NOW,Steps,Err).
1545 cli_random_animate(_NOW,Steps,ErrorOnDeadlock) :-
1546 start_xml_feature(random_animate,max_steps,Steps,FINFO),
1547 start_ms_timer(Start),
1548 perform_random_steps(Steps,ErrorOnDeadlock),
1549 (option(silent) -> true ; stop_ms_timer_with_msg(Start,'-animate')),
1550 %tcltk_save_history_as_trace_file(prolog,user),
1551 stop_xml_feature(random_animate,FINFO).
1552
1553 :- use_module(bmachine,[b_get_assertions/3]).
1554 we_need_only_static_assertions(ALL) :- specfile:b_or_z_mode,
1555 (option(cli_check_assertions(main,_)) -> ALL=main
1556 ; option(cli_check_assertions(ALL,_))),
1557 % we do an assertion check
1558 \+ ((option(A), option_requires_all_properties(A))),
1559 b_get_assertions(ALL,dynamic,[]). % the assertions do not reference variables
1560
1561 % do we need all properties/constants of the machine, or only certain ones (e.g., static)
1562 option_requires_all_properties(cli_mc(_,_)).
1563 option_requires_all_properties(cli_check_properties). % we may want to check all properties
1564 option_requires_all_properties(cli_core_properties(_)).
1565 option_requires_all_properties(cli_random_animate(_)).
1566 option_requires_all_properties(default_trace_check).
1567 option_requires_all_properties(trace_check(_,_,_)).
1568 option_requires_all_properties(state_trace(_)).
1569 option_requires_all_properties(mcm_tests(_,_,_,_)).
1570 option_requires_all_properties(cbc_tests(_,_,_)).
1571 option_requires_all_properties(animate).
1572 option_requires_all_properties(initialise). % INITIALISATION may access constants
1573 option_requires_all_properties(eval_repl(_)).
1574 option_requires_all_properties(eval_string_or_file(_,_,_,_,_)).
1575 option_requires_all_properties(ltl_assertions).
1576 option_requires_all_properties(ltl_file(_)).
1577 option_requires_all_properties(refinement_check(_,_,_)).
1578 option_requires_all_properties(cli_start_mc_with_tlc).
1579 option_requires_all_properties(cli_symbolic_model_check(_)).
1580 option_requires_all_properties(process_latex_file(_,_)).
1581 option_requires_all_properties(cli_wd_check(_,_)).
1582 option_requires_all_properties(cli_lint(_)).
1583 option_requires_all_properties(visb_history(_,_,_)).
1584
1585 :- use_module(b_intelligent_trace_replay,[replay_json_trace_file/2]).
1586 :- public default_trace_check/0.
1587 default_trace_check :- loaded_main_file(_,MainFile),
1588 cli_start_default_trace_check(MainFile).
1589 cli_start_default_trace_check(MainFile) :-
1590 debug_println(20,'% Starting Default Trace Check: '),
1591 (check_default_trace_for_specfile(MainFile) -> true ; error_occurred(trace_check)).
1592
1593 default_json_trace_save :-
1594 loaded_main_file(_,MainFile),
1595 get_default_trace_file(MainFile,'.prob2trace',HistFile),
1596 format('Saving history to JSON ProB2-UI default trace file: ~w~n',[HistFile]),
1597 tcltk_save_history_as_trace_file(json,HistFile).
1598 cli_start_trace_check(json,File,default_trace_replay) :- !,
1599 replay_json_trace_file(File,Status),
1600 (Status=perfect -> true
1601 ; Status = imperfect(_) -> add_warning(trace_replay,'Imperfect JSON trace replay:',Status)
1602 ; add_error(trace_replay,'Failed JSON trace replay:',Status)
1603 ).
1604 cli_start_trace_check(Style,File,Mode) :-
1605 debug_format(20,'% Starting Trace Check (~w:~w): ~w~n',[Style,Mode,File]),
1606 (tcltk_check_sequence_from_file(Style,File,Mode) -> true ; error_occurred(trace_check)).
1607 cli_start_trace_state_check(File) :-
1608 debug_println(20,'% Starting Trace Check: '),
1609 (tcltk_check_state_sequence_from_file(File) -> true ; error_occurred(state_trace)).
1610
1611 % is it necessary to compute enabled operations for root state
1612 computeOperations_for_root_required :- initialise_required.
1613 computeOperations_for_root_required :- option(default_trace_check).
1614 computeOperations_for_root_required :- option(trace_check(_,_,_)).
1615 computeOperations_for_root_required :- option(state_trace(_)).
1616 computeOperations_for_root_required :- option(ltl_assertions).
1617 computeOperations_for_root_required :- option(cli_random_animate(_,_)).
1618 computeOperations_for_root_required :- option(socket(_,_)).
1619 computeOperations_for_root_required :- option(cli_mc(_,_)).
1620 computeOperations_for_root_required :- option(ltl_file(_)).
1621 computeOperations_for_root_required :- option(ltl_formula_model_check(_,_)).
1622 computeOperations_for_root_required :- option(ctl_formula_model_check(_,_)).
1623 computeOperations_for_root_required :- option(pctl_formula_model_check(_,_)).
1624 computeOperations_for_root_required :- option(refinement_check(_,_,_)).
1625 computeOperations_for_root_required :- option(csp_in_situ_refinement_check(_,_)).
1626 computeOperations_for_root_required :- option(csp_checkAssertion(_,_)).
1627 computeOperations_for_root_required :- option(mcm_tests(_,_,_,_)).
1628 computeOperations_for_root_required :- option(mcm_cover(_)).
1629
1630 % is an initialisation mandatory:
1631 initialise_required :- option(initialise), \+ empty_machine_loaded.
1632 initialise_required :- \+ option(default_trace_check), \+ option(trace_check(_,_,_)), \+ option(state_trace(_)),
1633 \+ option(load_state(_)),
1634 \+ empty_machine_loaded,
1635 \+ (option(execute(Nr,_,_)), Nr>=2), % execute will also initialise machine
1636 init_req2.
1637 init_req2 :- option(cli_check_properties).
1638 init_req2 :- option(zmq_assertion(_,_,_)).
1639 init_req2 :- option(cli_check_assertions(_,_)).
1640 init_req2 :- option(process_latex_file(_,_)).
1641 init_req2 :- option(eval_string_or_file(_,_,_,_,_)). % ensure that we initialise/precompile empty machine in case no main file specified; currently no longer required
1642 init_req2 :- option(check_abstract_constants).
1643 init_req2 :- option(visb_click(_)).
1644 init_req2 :- option(dot_command_for_expr(Cat,_,_,_,_)),
1645 nonmember(Cat,[transition_diagram,expression_coverage]). % see test 1033, option also works with empty state space
1646 %init_req2 :- option(csv_table_command(Cat,_,_,_)), ...
1647
1648 :- public initialise/0. % for REPL
1649 initialise :- probcli_time_stamp(NOW),cli_start_initialisation(NOW).
1650
1651 cli_start_initialisation(NOW) :-
1652 debug_println(20,'% Performing INITIALISATION: '),
1653 (perform_random_initialisation -> true ;
1654 writeln_log_time(cli_start_initialisation_failed(NOW)),
1655 fail).
1656
1657 :- use_module(wdsrc(well_def_analyser),[analyse_wd_for_machine/4]).
1658 :- public cli_wd_check/2. % for REPL
1659 cli_wd_check(ExpectedDis,ExpectedTot) :-
1660 (option(timeout(TO)) -> true ; TO=5000), % this is global_time_out option
1661 (option(silent) -> Opts=[discharge_po,ignore_wd_infos,reorder_conjuncts]
1662 ; Opts=[create_not_discharged_msg(warning),discharge_po,ignore_wd_infos,reorder_conjuncts]),
1663 statistics(walltime,[W1,_]),
1664 safe_time_out(analyse_wd_for_machine(NrDischarged,NrTot,_Res,Opts),TO,Res),
1665 statistics(walltime,[W2,_]), WT is W2-W1,
1666 (Res=time_out -> accumulate_infos(wd_check,[timeout-1,walltime-WT]), % discharged and total are unknown
1667 add_error(cli_wd_check,'TIME-OUT in WD Analysis (use -global_time_out X to increase it)')
1668 ; format(user_output,'WD Analysis Result: discharged ~w / ~w',[NrDischarged,NrTot]),
1669 (NrTot >0
1670 -> Perc is 100*NrDischarged/NrTot,
1671 (NrDischarged=NrTot -> Col=[green,bold] ; Col=[red])
1672 ; Perc = 100, Col=[]),
1673 format_with_colour(user_output,Col,' (~2f %)~n',[Perc]),
1674 WDInfos = [discharged-NrDischarged,timeout-0,total-NrTot,walltime-WT],
1675 accumulate_infos(wd_check,WDInfos),
1676 (ExpectedDis==ExpectedTot, ExpectedTot = NrTot -> true ; true), % for -wd-check-all: bind ExpectedDis
1677 check_required_infos([discharged-ExpectedDis,total-ExpectedTot],WDInfos,cli_wd_check)
1678 ).
1679 :- use_module(wdsrc(well_def_analyser),[analyse_invariants_for_machine/5]).
1680 cli_wd_inv_proof(UnchangedNr,ProvenNr,TotPOsNr) :-
1681 (option(timeout(TO)) -> true ; TO=5000),
1682 Options=[],
1683 statistics(walltime,[W1,_]),
1684 safe_time_out(analyse_invariants_for_machine(UnchangedNr,ProvenNr,UnProvenNr,TotPOsNr,Options),TO,Res),
1685 statistics(walltime,[W2,_]), WT is W2-W1,
1686 (Res=time_out -> accumulate_infos(wd_inv_proof,[timeout-1,walltime-WT]), % discharged and total are unknown
1687 add_error(cli_wd_check,'TIME-OUT in WD Invariant Proving (use -global_time_out X to increase it)')
1688 ;
1689 (TotPOsNr>0 -> Perc is (UnchangedNr+ProvenNr)*100/ TotPOsNr ; Perc = 100.0),
1690 format('Proof summary for ~w Invariant POs (~2f % discharged): ~w unchanged, ~w proven, ~w unproven~n',
1691 [TotPOsNr,Perc,UnchangedNr,ProvenNr,UnProvenNr]),
1692 WDInfos = [proven-ProvenNr,timeout-0,total-TotPOsNr,unchanged-UnchangedNr,unproven-UnProvenNr,walltime-WT],
1693 accumulate_infos(wd_inv_proof,WDInfos)
1694 ).
1695
1696
1697 :- use_module(bmachine_static_checks,[extended_static_check_machine/1]).
1698 :- use_module(visbsrc(visb_visualiser),[extended_static_check_default_visb_file/0]).
1699 % perform some additional static checks
1700 :- public cli_lint/0. % for REPL
1701 cli_lint(Check) :-
1702 extended_static_check_machine(Check),
1703 (unavailable_extension(visb_extension,_) -> true
1704 ; Check=visb -> extended_static_check_default_visb_file
1705 ; true).
1706 cli_lint :- cli_lint(_).
1707
1708
1709 :- use_module(extrasrc(predicate_debugger),[tcltk_debug_properties/3]).
1710 :- use_module(state_space,[current_state_corresponds_to_setup_constants_b_machine/0]).
1711 :- public cli_check_properties/0. % for REPL
1712 cli_check_properties :- probcli_time_stamp(NOW),
1713 cli_check_properties(NOW).
1714 cli_check_properties(NOW) :-
1715 printsilent('% Checking PROPERTIES: '),nls,
1716 writeln_log_time(starting_check_properties(NOW)),
1717 ( current_state_corresponds_to_setup_constants_b_machine ->
1718 set_analyse_hook('_P'),
1719 predicate_evaluator:tcltk_analyse_properties(_PROPRES,PROPInfos),
1720 unset_analyse_hook,
1721 printsilent(PROPInfos),nls, % ex: [total/33,true/29,false/0,unknown/4,timeout/4,runtime/49950]
1722 accumulate_infos(properties,PROPInfos),
1723 write_important_xml_element_to_log(check_properties,PROPInfos),
1724 (predicate_evaluator:check_summary_all_true(PROPInfos) -> true
1725 ; print_error('Not all PROPERTIES true'), error_occurred(check_properties))
1726 ;
1727 (tcltk_debug_properties(list(PROPRES),false,Satisfiable)
1728 -> printsilent(PROPRES),nls,
1729 printsilent(Satisfiable),nls
1730 ; error_occurred(debug_properties_failed))
1731 ),
1732 writeln_log_time(finished_check_properties(NOW,PROPInfos)),
1733 loaded_root_filename(RootName),
1734 formatsilent('% Finished checking PROPERTIES of ~w~n',[RootName]).
1735
1736 % TODO: provide argument so that we run it only if necessary; e.g., when ProB has not already found a solution
1737
1738 cli_core_properties(Algorithm) :-
1739 format('% Checking CONSISTENCY of PROPERTIES by finding UNSAT CORE (using ~w)~n',[Algorithm]),
1740 b_get_properties_from_machine(Properties),!,
1741 size_of_conjunction(Properties,NrOfConjuncts),
1742 statistics(walltime,[W1,_]),
1743 (find_core(Algorithm,Properties,Core,Result)
1744 -> statistics(walltime,[W2,_]), WTime is W2-W1,
1745 length(Core,Len),
1746 accumulate_infos(properties_core,[contradiction_found-1,core_length-Len,
1747 properties-NrOfConjuncts,walltime-WTime]),
1748 format('UNSAT CORE of length ~w found, PROPERTIES are inconsistent! (~w, ~w ms walltime using ~w)~n',[Len,Result,WTime,Algorithm]),
1749 translate:nested_print_bexpr_as_classicalb(Core),
1750 format('% END OF UNSAT CORE (~w conjuncts)~n',[Len])
1751 % TODO: raise setup_constants_fails and avoid trying to solve properties later
1752 ; statistics(walltime,[W2,_]), WTime is W2-W1,
1753 accumulate_infos(properties_core,[contradiction_found-0,core_length-0,
1754 properties-NrOfConjuncts,walltime-WTime]),
1755 format('No small UNSAT CORE found, PROPERTIES may be consistent (~w ms walltime).~n',[WTime])
1756 ).
1757
1758 :- use_module(extrasrc(unsat_cores),[quick_bup_core_up_to/4]).
1759 :- use_module(wdsrc(well_def_analyser),[find_inconsistent_axiom/3]).
1760 find_core(wd_prover,_,Core,Result) :-
1761 find_inconsistent_axiom([],Axiom,NecHyps),
1762 Core = [Axiom|NecHyps], Result = contradiction_found.
1763 find_core(z3_bup(MaxSize),Properties,Core,Result) :-
1764 (var(MaxSize) -> MaxSize=2 ; true),
1765 quick_bup_core_up_to(Properties,MaxSize,Core,Result).
1766
1767
1768 % -----------------------
1769
1770 :- public cli_check_assertions/2. % for REPL
1771 cli_check_assertions(ALL,RI) :-
1772 probcli_time_stamp(NOW),
1773 cli_check_assertions(ALL,RI,NOW).
1774 cli_check_assertions(ALL,ReqInfos,NOW) :-
1775 printsilent('% Checking ASSERTIONS: '),nls,
1776 writeln_log_time(starting_check_assertions(NOW)),
1777 set_analyse_hook('_A'), % for dot output, in case users wants to generate dot files for assertions
1778 predicate_evaluator:tcltk_analyse_assertions(ALL,_ASSRES,Infos), % also checks CSP assertions
1779 unset_analyse_hook,
1780 printsilent(Infos),nls,
1781 accumulate_infos(assertions,Infos),
1782 write_important_xml_element_to_log(check_assertions,Infos),
1783 check_required_infos(ReqInfos,Infos,check_assertions),
1784 writeln_log_time(finished_check_assertions(NOW,Infos)),
1785 loaded_root_filename(RootName),
1786 formatsilent('% Finished checking ASSERTIONS of ~w~n',[RootName]),!.
1787 cli_check_assertions(ALL,ReqInfos,NOW) :-
1788 add_internal_error('Analyse ASSERTIONS unexpectedly failed',cli_check_assertions(ALL,ReqInfos,NOW)),
1789 error_occurred(internal_error).
1790 cli_set_goal(GOAL) :-
1791 debug_println(20,set_goal(GOAL)), %print(set_goal(GOAL)), nl,
1792 (bmachine:b_set_machine_goal(GOAL) -> true
1793 ; add_error(scope,'Setting GOAL predicate failed:',GOAL)).
1794 cli_add_additional_property(PROP) :-
1795 debug_println(20,add_additional_property(PROP)),
1796 (bmachine:add_additional_property(PROP,'command line -property') -> true
1797 ; add_error(scope,'Adding additional predicate to PROPERTIES failed:',PROP)).
1798 cli_set_searchscope(GOAL) :-
1799 debug_println(20,set_searchscope(GOAL)),
1800 format('Setting SCOPE for verification: ~w~n (Only states satisfying this predicate will be examined)~n',[GOAL]),
1801 (b_or_z_mode, bmachine:b_set_machine_searchscope(GOAL) -> true
1802 ; (xtl_mode, xtl_interface:xtl_set_search_scope(GOAL) -> true
1803 ; add_error(scope,'Setting model checking search SCOPE failed:',GOAL))
1804 ).
1805 cli_check_goal :- \+ b_get_machine_goal(_),!,
1806 add_error(cli_check_goal,'No GOAL DEFINITION found'),
1807 error_occurred(cli_check_goal).
1808 cli_check_goal :-
1809 printsilent('% Checking GOAL predicate: '),nls,
1810 tcltk_analyse_goal(_List,Summary),
1811 debug_println(20,Summary),
1812 accumulate_infos(check_goal,Summary),
1813 write_important_xml_element_to_log(check_goal,Summary),
1814 check_required_infos([false/0,unknown/0],Summary,check_goal).
1815 :- public cli_mc/2. % for REPL
1816 cli_mc(Nr,Opts) :- probcli_time_stamp(NOW), cli_start_model_check(Nr,NOW,Opts).
1817 cli_start_model_check(Nr,NOW,Options) :-
1818 (member(reset_state_space,Options)
1819 -> formatsilent('Resetting state space for benchmarking model checking (limit:~w, options:~w)~n',[Nr, Options]),
1820 announce_event(reset_specification) % for benchmarking purposes
1821 %,state_space:portray_state_space,nl
1822 ; true),
1823 start_xml_feature(model_check,max_states,Nr,FINFO),
1824 regular_safety_model_check_now(Nr,Time,WallTime,MCRes,NOW),
1825 %nl,
1826 stop_xml_feature(model_check,FINFO),
1827 get_state_space_stats(TS,TT,PT,IgnT),
1828 statistics_memory_used(Mem),
1829 (MCRes=time_out -> TInfos=[timeout/1] ; TInfos=[]),
1830 accumulate_infos(model_check,[runtime-Time,walltime-WallTime, % mc only runtime, and total wall time
1831 processed_states/PT,total_states/TS,total_transitions/TT,
1832 ignored_states/IgnT, memory_used/Mem|TInfos]), %for bench_csv output
1833 writeln_log_time(model_check(NOW,Nr,Time,WallTime,MCRes)),
1834 (select(repeat(RepNr),Options,RestOptions)
1835 -> (RepNr>1
1836 -> N1 is RepNr-1,
1837 cli_start_model_check(Nr,NOW,[repeat(N1)|RestOptions])
1838 ; merge_accumulated_infos(model_check)
1839 )
1840 ; true
1841 ).
1842
1843 cli_start_mc_with_tlc :-
1844 (animation_mode(b), \+ animation_minor_mode(eventb) -> true
1845 ; error_manager: add_error_and_fail(mc_with_tlc,'TLC4B tool can be used only for classical B models.')),
1846 % TO DO: use b_write_eventb_machine_to_classicalb_to_file to do conversion
1847 catch(
1848 safe_absolute_file_name(prob_lib('TLC4B.jar'),TLC4BTool),
1849 error(E,_),
1850 error_manager:add_error_fail(get_tlc_command,'Could not find TLC4B.jar file.',E)),
1851 start_xml_feature(model_check_with_tlc,tlc4bjar,TLC4BTool,FINFO),
1852 construct_and_execute_tlc_command(TLC4BTool),
1853 stop_xml_feature(model_check_with_tlc,FINFO).
1854
1855 :- use_module(system_call,[system_call/4]).
1856 construct_and_execute_tlc_command(TLC4BTool) :-
1857 parsercall: get_java_command_path(JavaCmd),
1858 loaded_main_file(File),
1859 % determine extra arguments:
1860 (get_preference(tlc_number_of_workers,TLCWorkers), TLCWorkers>1
1861 -> number_codes(TLCWorkers,CC), atom_codes(TLAWA,CC), WW = ['-workers',TLAWA]
1862 ; WW=[]),
1863 (option(no_assertion_violations) -> WA = ['-noass'] ; WA=[]),
1864 (option(no_deadlocks) -> WD = ['-nodead'] ; WD=[]),
1865 (option(no_invariant_violations) -> WI = ['-noinv'] ; WI=[]),
1866 (option(no_goal) -> WG = ['-nogoal'] ; WG=[]),
1867 (option(no_ltl) -> WL = ['-noltl'] ; WL=[]),
1868 (option_verbose -> WV = ['-verbose'] ; WV=[]),
1869 (option(silent) -> WS = ['-silent'] ; WS=[]),
1870 (option(logtlc(Log)) -> WLG = ['-log',Log] ; WLG=[]),
1871 (get_preference(tlc_use_prob_constant_setup,true),
1872 tcltk_get_constants_predicate(DNF_Pred)
1873 -> WCS = ['-constantssetup', DNF_Pred]
1874 ; WCS=[]),
1875 append([WW,WA,WD,WI,WG,WL,WCS,WV,WS,WLG,[File]],TLCArgs),
1876 debug_println(19,tlc_args(TLCArgs)),
1877 statistics(walltime,[W1,_]),
1878 % we could call get_jvm_options: '-Xss5m' is useful e.g. for Generated1000.mch
1879 system_call(JavaCmd, ['-Xss5m', '-jar', TLC4BTool | TLCArgs], Text,JExit),
1880 statistics(walltime,[W2,_]),
1881 WTime is W2-W1,
1882 formatsilent('exit : ~w walltime: ~w ms~n',[JExit,WTime]),
1883 (JExit=exit(0)
1884 -> accumulate_infos(mc_with_tlc,[walltime-WTime,model_check_ok-1])
1885 ; accumulate_infos(mc_with_tlc,[walltime-WTime,model_check_error-1]),
1886 add_error(construct_and_execute_tlc_command,'Error while model checking with TLC: ',TLC4BTool/File),
1887 atom_codes(T,Text),
1888 add_error_fail(construct_and_execute_tlc_command,'Std error: ',T)
1889 ).
1890
1891 % SymbolicOrSequential = symbolic or sequential
1892 cli_start_sym_mc_with_lts(SymbolicOrSequential) :-
1893 (option(no_deadlocks) -> NoDead = true ; NoDead = false),
1894 (option(no_invariant_violations) -> NoInv = true ; NoInv = false), % does LTSMin support goal checking
1895 findall(Option,option(ltsmin_option(Option)),MoreFlags1),
1896 findall(ltl_formula(LTLF),option(ltl_formula_model_check(LTLF,_)),MoreFlags2),
1897 append(MoreFlags1,MoreFlags2,MoreFlags),
1898 (NoDead = false, NoInv = false ->
1899 print_error('ERROR: cannot start LTSmin with both deadlock and invariant checking'),
1900 print_error(' use either the -noinv or -nodead flag'),
1901 flush_output(user_error)
1902 ; true),
1903 formatsilent('starting prob2lts-sym/seq (flags nodead=~w, noinv=~w, moreflags=~w)~n',[NoDead,NoInv,MoreFlags]),
1904 statistics(walltime,[W1,_]),
1905 start_ltsmin(SymbolicOrSequential, [NoDead, NoInv], MoreFlags,Result),
1906 process_ltsmin_result(Result,AccInfos),
1907 statistics(walltime,[W2,_]), WT is W2-W1,
1908 accumulate_infos(mc_with_lts_min(SymbolicOrSequential),[walltime-WT|AccInfos]).
1909 % TO DO: start lts-sym + start start_ltsmin_srv('/tmp/ltsmin.probz', NOW) + print output
1910
1911 :- use_module(extension('ltsmin/ltsmin_trace'),[csv_to_trace/3]).
1912 process_ltsmin_result(ltsmin_model_checking_ok,[model_check_ok-1]) :-
1913 print_green('LTSMin found no counter example\n').
1914 process_ltsmin_result(ltsmin_model_checking_aborted,[model_check_aborted-1]) :-
1915 add_warning(ltsmin_model_checking_aborted,'LTSMin was aborted (e.g., by CTRL-C)').
1916 process_ltsmin_result(ltsmin_counter_example_found(CsvFile),[model_check_counter_example-1]) :-
1917 add_error(ltsmin_counter_example_found,'LTSMin found a counter example, written to:',CsvFile),
1918 (option(silent) -> true
1919 ; csv_to_trace(CsvFile,_States,Transitions) ->
1920 print('*** TRACE: '),nl,print_list(Transitions) % ,print(_States),nl
1921 ; add_error(ltsmin,'Could not extract trace information from LTSmin file: ',CsvFile)
1922 ).
1923
1924 :- use_module(symbolic_model_checker(ic3), [ic3_symbolic_model_check/1]).
1925 :- use_module(symbolic_model_checker(ctigar), [ctigar_symbolic_model_check/1]).
1926 :- use_module(symbolic_model_checker(kinduction), [kinduction_symbolic_model_check/1,
1927 tinduction_symbolic_model_check/1]).
1928 :- use_module(symbolic_model_checker(bmc), [bmc_symbolic_model_check/1]).
1929 cli_symbolic_model_check(Algorithm) :-
1930 debug_format(20,'% Starting Symbolic Model Check. Using ~w Algorithm', [Algorithm]),
1931 start_xml_feature(model_check,algorithm,Algorithm,FINFO),
1932 (animation_mode(b)
1933 -> true
1934 ; error_manager:add_error_and_fail(cli_symbolic_model_check,'Symbolic Model Checking is currently only available for B and Event-B.')),
1935 perform_symbolic_model_checking(Algorithm,Result),
1936 handle_symbolic_model_check_result(Result),
1937 stop_xml_feature(model_check,FINFO).
1938
1939 perform_symbolic_model_checking(ic3,Result) :- !, ic3_symbolic_model_check(Result).
1940 perform_symbolic_model_checking(ctigar,Result) :- !, ctigar_symbolic_model_check(Result).
1941 perform_symbolic_model_checking(kinduction,Result) :- !, kinduction_symbolic_model_check(Result).
1942 perform_symbolic_model_checking(tinduction,Result) :- !, tinduction_symbolic_model_check(Result).
1943 perform_symbolic_model_checking(bmc,Result) :- !, bmc_symbolic_model_check(Result).
1944 perform_symbolic_model_checking(Alg,_) :- add_error_fail(cli_symbolic_model_check,'Invalid symbolic model checking algorithm: ',Alg).
1945
1946 handle_symbolic_model_check_result(counterexample_found) :- !, error_occurred(invariant_violation).
1947 handle_symbolic_model_check_result(property_holds) :- !,
1948 format('Model checking complete, invariant holds~n',[]).
1949 handle_symbolic_model_check_result(solver_and_provers_too_weak) :- !,
1950 format('Model checking incomplete because a constraint could not be solved in time~n',[]),
1951 error_occurred(model_check_incomplete).
1952 handle_symbolic_model_check_result(limit_reached) :- !,
1953 format('Model checking incomplete because an iteration limit was reached~n',[]),
1954 error_occurred(model_check_incomplete).
1955
1956 zmq_start_master(invariant,Identifier) :-
1957 start_animation_without_computing,
1958 zmq_get_initialisation_term(InitTerm),
1959 (option(strict_raise_error) -> Strict = 1 ; Strict = 0),
1960 get_preference(port, PortStart),
1961 get_preference(max_states, Max),
1962 get_preference(ip, IP),
1963 get_preference(logdir, LogDir),
1964 get_preference(tmpdir, TmpDir),
1965 get_preference(hash_cycle, HashCycle),
1966 atom_concat(LogDir, '/distb-', ATmp),
1967 atom_concat(ATmp, Identifier, Logfile),
1968 atom_concat(TmpDir, '/db-distb-', TTmp),
1969 atom_concat(TTmp, Identifier, TmpDir2),
1970 start_master(InitTerm,Max,PortStart,Strict,IP,Logfile,TmpDir2,HashCycle),
1971 halt.
1972 zmq_start_master(assertion,Identifier) :-
1973 get_preference(port, PortStart),
1974 get_preference(logdir, LogDir),
1975 get_preference(ip, IP),
1976 get_preference(tmpdir, TmpDir),
1977 get_preference(hash_cycle, HashCycle),
1978 atom_concat(LogDir, '/distb-', ATmp),
1979 atom_concat(ATmp, Identifier, Logfile),
1980 atom_concat(TmpDir, '/db-distb-', TTmp),
1981 atom_concat(TTmp, Identifier, TmpDir2),
1982 current_state_corresponds_to_setup_constants_b_machine,
1983 animation_mode(b),
1984 full_b_machine(Machine),
1985 b_get_assertions(_,static,SAss),
1986 b_get_assertions(_,dynamic,DAss),
1987 append(SAss,DAss,Ass),
1988 count_assertions(Ass,0,N),
1989 assertz(master:assertion_count(N)),
1990 current_expression(_,State1),
1991 specfile:state_corresponds_to_set_up_constants(State1,State),
1992 zmq_get_important_options(Options),
1993 (option(strict_raise_error) -> Strict = 1 ; Strict = 0),
1994 %start_master(assertions(classical_b(Machine,Options),State,Ass),2,-1,PortStart,0,Strict,IP,Logfile,TmpDir2),
1995 start_master(assertions(classical_b(Machine,Options),State,Ass),2,PortStart,Strict,IP,Logfile,TmpDir2,HashCycle),
1996 halt.
1997
1998 zmq_get_initialisation_term(Term) :-
1999 (animation_mode(b) ; animation_mode(csp_and_b)), % CSP file not yet added when ZMQ master starts working
2000 \+ animation_minor_mode(eventb),
2001 option(add_csp_guide(CspGuide)),
2002 !, % Classical B + CSP
2003 debug_println(20,'ZMQ: Transferring CSP || B model'),
2004 full_b_machine(Machine),
2005 % TO DO: extract CSP Term rather than file name: will not work for distribution on other file-systems
2006 zmq_get_important_options(Options),
2007 Term = classical_b_with_csp(Machine,CspGuide,Options).
2008 zmq_get_initialisation_term(Term) :-
2009 debug_println(20,'Generating ZMQ Worker Initialisation'),
2010 animation_mode(b), \+ animation_minor_mode(eventb), !, % Classical B
2011 debug_println(20,'ZMQ: Transferring Classical-B model'),
2012 full_b_machine(Machine),
2013 zmq_get_important_options(Options),
2014 Term = classical_b(Machine,Options).
2015 zmq_get_initialisation_term(Term) :-
2016 animation_mode(b), animation_minor_mode(eventb), !, % Event-B
2017 debug_println(20,'ZMQ: Transferring Event-B model'),
2018 full_b_machine(Machine),
2019 zmq_get_important_options(Options),
2020 Term = eventb(Machine,Options).
2021 zmq_get_initialisation_term(Term) :-
2022 animation_mode(cspm),
2023 loaded_main_file(MainCSPFile),!, % TO DO: pass CSP Prolog term rather than file name (for distribution)
2024 zmq_get_important_options(Options),
2025 debug_println(20,'ZMQ: Transferring CSP specification'),
2026 Term = csp_specification(MainCSPFile,Options).
2027 zmq_get_initialisation_term(_Term) :-
2028 \+ real_error_occurred, % otherwise error occured while loading
2029 animation_mode(Mode),
2030 add_internal_error('Unsupported formalism for ZMQ', Mode),
2031 fail.
2032
2033 zmq_get_initialisation_term(filename(FN)) :-
2034 loaded_main_file(FN).
2035
2036 % get important command-line options to be transmitted to probcli worker
2037 zmq_get_important_options(Options) :- findall(O, (option(O), zmq_important_option(O)), Options),
2038 debug_println(20,transferring_zmq_options_to_workers(Options)).
2039 zmq_important_option(coverage(_)).
2040 zmq_important_option(expect_error(_)).
2041 zmq_important_option(optional_error(_)).
2042 zmq_important_option(file_info).
2043 zmq_important_option(log(_)).
2044 zmq_important_option(print_version(_)).
2045 zmq_important_option(profiling_on).
2046 zmq_important_option(set_card(_,_)).
2047 zmq_important_option(set_pref(_,_)).
2048 zmq_important_option(set_preference_group(_,_)).
2049 zmq_important_option(statistics).
2050 zmq_important_option(csv_table_command(_,_,_,_)).
2051 zmq_important_option(verbose(_)).
2052 zmq_important_option(set_searchscope(_)).
2053 zmq_important_option(no_invariant_violations).
2054 %zmq_important_option(no_deadlocks).
2055 %zmq_important_option(no_goal).
2056 % we could consider also supporting: -argv, -cache, -prefs FILE csp_main(ProcessName) profiling_on prob_profile runtimechecking
2057
2058 % set options received by a zmq worker
2059 :- use_module(b_global_sets, [set_user_defined_scope/2]).
2060 :- use_module(tools_strings, [convert_cli_arg/2]).
2061 zmq_set_important_options(Options) :- debug_println(20,setting_zmq_options(Options)),
2062 maplist(prob_cli:zmq_set_option,Options).
2063 zmq_set_option(file_info) :- !, file_info.
2064 zmq_set_option(log(F)) :- !,
2065 generate_time_stamp(Datime,NOW),
2066 cli_start_logging(F,ascii,NOW,Datime,[zmq_worker]).
2067 zmq_set_option(print_version(V)) :- !, print_version(V).
2068 zmq_set_option(profiling_on) :- !, profiling_on.
2069 zmq_set_option(set_card(Set,V)) :- !,
2070 convert_cli_arg(V,Value),
2071 set_user_defined_scope(Set,Value).
2072 zmq_set_option(set_pref(P,V)) :- !, set_pref(P,V).
2073 zmq_set_option(set_preference_group(P,V)) :- !, set_preference_group(P,V).
2074 zmq_set_option(verbose(Nr)) :- !, verbose(Nr).
2075 zmq_set_option(O) :- zmq_delayed_option(O),!, assert_option(O). % DO IT LATER
2076 zmq_set_option(O) :- add_internal_error('Unsupported option for ZMQ worker: ',zmq_set_option(O)).
2077
2078 zmq_delayed_option(coverage(_)).
2079 zmq_delayed_option(expect_error(_)).
2080 zmq_delayed_option(expect_error_pos(_,_,_)).
2081 zmq_delayed_option(optional_error(_)).
2082 zmq_delayed_option(statistics).
2083 zmq_delayed_option(set_searchscope(_)).
2084 zmq_delayed_option(no_invariant_violations). % not supported yet
2085
2086 ltsmin_ltl_output(Filename, NOW) :-
2087 if_option_set(ltl_formula_model_check(Formula, _),true),
2088 ltsmin_generate_ltlfile(Formula, Filename),
2089 halt_prob(NOW,0). % if we additionally specify -ltsformula, we do not want to model check it
2090
2091
2092 start_ltsmin_srv(X, NOW) :-
2093 nls,println_silent('Starting LTSMin Server...'),
2094 if_option_set(ltl_formula_model_check(Formula, _),true),
2095 ltsmin_init(X, Zocket, Formula),
2096 ltsmin_loop(Zocket),
2097 ltsmin_teardown(Zocket, X),
2098 nls,println_silent('Stopped LTSMin Server.'),
2099 halt_prob(NOW,0). % if we additionally specify -ltsformula, we do not want to model check it
2100
2101 zmq_start_worker(Identifier, NOW) :-
2102 get_preference(port, Port),
2103 get_preference(logdir, LogDir),
2104 get_preference(tmpdir, TmpDir),
2105 get_preference(proxynumber, ProxyNumber),
2106 /* TODO: ensure directory exists (pk, 09.01.2018) */
2107 atom_concat(LogDir, '/worker-', ATmp),
2108 atom_concat(ATmp, Identifier, Logfile),
2109 % TODO: tmp dir currently not used
2110 atom_concat(TmpDir, '/db-worker-', TTmp),
2111 atom_concat(TTmp, Identifier, TmpDir2),
2112 start_worker(Port,ProxyNumber,Logfile,TmpDir2,zmq_worker_load_model),
2113 formatsilent('ZMQ worker finished (Port:~w)~n',[Port]),
2114 cli_process_loaded_file_afer_start_animation(NOW),
2115 println_silent('Exiting probcli worker'),
2116 halt_prob(NOW,0).
2117
2118 zmq_start_animation :-
2119 prob2_interface:start_animation,
2120 if_option_set(set_goal(GOAL),
2121 cli_set_goal(GOAL)), % not used yet
2122 if_option_set(set_searchscope(SCOPE),
2123 cli_set_searchscope(SCOPE)),
2124 cli_computeOperations(_).
2125 zmq_worker_load_model(classical_b(Machine,Options)) :- !,
2126 debug_println(20,'ZMQ WORKER: Loading classical B model'),
2127 zmq_set_important_options(Options),
2128 bmachine:b_machine_reset, bmachine:assert_main_machine(Machine),
2129 set_animation_mode(b),
2130 zmq_start_animation.
2131 zmq_worker_load_model(classical_b_with_csp(Machine,CspGuide,Options)) :- !,
2132 debug_println(20,'ZMQ WORKER: Loading CSP || B model'),
2133 zmq_set_important_options(Options),
2134 bmachine:b_machine_reset, bmachine:assert_main_machine(Machine),
2135 set_animation_mode(b),
2136 prob2_interface:start_animation,
2137 tcltk_add_csp_file(CspGuide), % TO DO: use CSP Prolog term rather than filename <----------------
2138 zmq_start_animation.
2139 zmq_worker_load_model(eventb(Machine,Options)) :- !,
2140 print(loading_eventb(Options)),nl,
2141 zmq_set_important_options(Options),
2142 bmachine:b_machine_reset, bmachine:assert_main_machine(Machine),
2143 set_animation_mode(b), set_animation_minor_mode(eventb),
2144 zmq_start_animation.
2145 zmq_worker_load_model(csp_specification(CSPFile,Options)) :-
2146 zmq_set_important_options(Options),
2147 load_cspm_spec_from_cspm_file(CSPFile), % TO DO: pass CSP Prolog term rather than filename
2148 zmq_start_animation.
2149 zmq_worker_load_model(filename(FN)) :- !,
2150 printsilent('loading file by filename\n'),flush_output,
2151 ( is_eventb_b(FN) ->
2152 eclipse_interface:load_eventb_file(FN)
2153 ;
2154 bmachine:b_load_machine_probfile(FN)),
2155 zmq_start_animation.
2156 zmq_worker_load_model(assertions(Machine,State,Assertions)) :- !,
2157 assertz(assertion_counter(-1)),
2158 println_silent(loaded_model_for_assertion_checking),
2159 zmq_worker_load_model(Machine),
2160 assertz(worker:assertion_state(State)),
2161 make_assertionwps(Assertions).
2162 % assert current state
2163 zmq_worker_load_model(Other) :-
2164 add_internal_error('ZMQ worker: Unexpected machine description', zmq_worker_load_model(Other)),
2165 fail.
2166
2167
2168 :-dynamic assertion_counter/1.
2169
2170 count_assertions([],A,A).
2171 count_assertions([H|T],A,R) :- size_of_conjunction(H,N1),
2172 NN is A + N1,
2173 count_assertions(T,NN,R).
2174
2175 make_assertionwps([]).
2176 make_assertionwps([H|T]) :- conjunction_to_list(H,HL),
2177 sort_assertions(HL,SL),
2178 append_assertion(SL),
2179 make_assertionwps(T).
2180
2181 append_assertion([]).
2182 append_assertion([H|T]) :- assertion_counter(N),
2183 retractall(assertion_counter(_)),
2184 N1 is N + 1,
2185 assertz(assertion_counter(N1)),
2186 assertz(worker:assertion_task(N1,H)),
2187 append_assertion(T).
2188
2189 %assertions_order(A,B) :- term_size(A,NA),term_size(B,NB), NA > NB.
2190 sort_assertions(X,X).
2191 % :- samsort(assertions_order,X,Y).
2192
2193
2194
2195 is_eventb_b(FN) :- append(_,FN,".eventb").
2196 % load_model(Initialisation)
2197
2198
2199 :- use_module(predicate_evaluator).
2200 :- use_module(bmachine,[b_machine_name/1]).
2201 set_analyse_hook(AddPrefix) :- % set a hook to write false/unknown expressions into a dot file
2202 reset_dot_file_number,
2203 if_options_set(dot_analyse_output_prefix(_Path),
2204 (set_dot_file_prefix_if_option_set(AddPrefix),
2205 register_conjunct_error_hook(prob_cli:pred_eval_hook))).
2206 unset_analyse_hook :- predicate_evaluator:reset_conjunct_error_hook.
2207
2208 :- use_module(tools,[get_modulename_filename/2]).
2209 loaded_root_filename(RootName) :- loaded_main_file(MainFile),
2210 get_modulename_filename(MainFile,RootName).
2211
2212 set_dot_file_prefix_if_option_set(AddPrefix) :-
2213 if_options_set(dot_analyse_output_prefix(Path),
2214 (loaded_root_filename(RootName),
2215 % we could also use b_machine_hierarchy:main_machine_name(RootName)
2216 string_concatenate(Path,RootName,P1),
2217 string_concatenate(P1,AddPrefix,FullPath),
2218 set_dot_file_prefix(FullPath),
2219 debug_println(9,dot_file_prefix(FullPath)))).
2220
2221 % Status: true, false, unknown
2222 :- public pred_eval_hook/5.
2223 pred_eval_hook(_Conjunct,true,_EnumWarning,_IsExpanded, _CS) :-
2224 \+ option(dot_generate_for_all_formulas),!. % don't generate .dot for true formulas, unless explicitly requested
2225 pred_eval_hook(Conjunct,Status,_EnumWarning,_IsExpanded, CS) :-
2226 printsilent('Generating dotfile for: '),printsilent(CS),nls,
2227 (write_dot_graph_to_new_file(Status,Conjunct) -> true
2228 ; add_error(dot_output,'Writing dot to file failed: ',CS)).
2229
2230
2231 :- dynamic dot_file_prefix/1.
2232 :- dynamic dot_file_number/1.
2233
2234 dot_file_prefix('~/Desktop/dot').
2235 set_dot_file_prefix(F) :- retractall(dot_file_prefix(_)), assertz(dot_file_prefix(F)).
2236 dot_file_number(0).
2237 reset_dot_file_number :- retractall(dot_file_number(_)), assertz(dot_file_number(0)).
2238 get_next_nr(GNr) :- retract(dot_file_number(Nr)), N1 is Nr+1,
2239 assertz(dot_file_number(N1)), GNr = Nr.
2240 write_dot_graph_to_new_file(Status,BExpr) :-
2241 dot_file_prefix(Dir),get_next_nr(Nr),
2242 string_concatenate('_',Status,Str1),
2243 string_concatenate(Nr,Str1,NS),
2244 string_concatenate(Dir,NS,F1),
2245 atom_concat(F1,'.dot',FileName),
2246 tcltk_interface:write_dot_file_for_pred_expr(BExpr,FileName).
2247
2248 % get dot file name if dot_output has been set
2249 get_dot_file(Type,FileName) :- option(dot_analyse_output_prefix(_)),
2250 set_dot_file_prefix_if_option_set(Type),
2251 dot_file_prefix(Dir),
2252 string_concatenate('_',Type,Str1),
2253 string_concatenate(Dir,Str1,F1),
2254 atom_concat(F1,'.dot',FileName).
2255
2256 :- use_module(extrasrc(refinement_checker),
2257 [tcltk_refinement_search/3, tcltk_load_refine_spec_file/1, tcltk_save_specification_state_for_refinement/1]).
2258 cli_csp_in_situ_refinement_check(P,Type,Q,NOW) :-
2259 debug_println(20,'% Starting CSP Refinement Check'),
2260 loaded_main_file(CSPFile),
2261 ajoin_with_sep(['assert',P,Type,Q], ' ',Assertion),
2262 start_xml_feature(csp_refinement_check,assertion,Assertion,FINFO),
2263 ( timeout_call(tcltk_interface:tcltk_check_csp_assertion(Assertion,CSPFile,'False',_PlTerm,RefTrace),NOW,'cspref')
2264 -> check_ref_result(RefTrace)
2265 ; true),
2266 stop_xml_feature(csp_refinement_check,FINFO).
2267 cli_start_refinement_check(RefFile,PerformSingleFailures,RefNrNodes,NOW) :-
2268 start_xml_feature(refinement_check,file,RefFile,FINFO),
2269 tcltk_load_refine_spec_file(RefFile),
2270 ( timeout_call(tcltk_refinement_search(RefTrace,PerformSingleFailures,RefNrNodes),NOW,refinement_check)
2271 -> check_ref_result(RefTrace)
2272 ; true),
2273 stop_xml_feature(refinement_check,FINFO).
2274 check_ref_result(RefTrace) :-
2275 ( RefTrace==no_counter_example ->
2276 print('==> Refinement Check Successful'),nl
2277 ; RefTrace==no_counter_example_found ->
2278 print('==> Refinement Check did not find Counter-Example but is incomplete'),nl,
2279 error_occurred(refinement_check_incomplete)
2280 ;
2281 print('*** Refinement Check Counter-Example: ***'),nl, print(RefTrace),nl,
2282 print('*** Refinement Check Failed ***'),nl,
2283 error_occurred(refinement_check_fails)).
2284 cli_checkAssertion(Proc,Model,AssertionType,_NOW) :-
2285 loaded_main_file(CSPFile),
2286 ajoin(['assert ',Proc,' :[ ',AssertionType,'[',Model,']',' ]'],Assertion),
2287 start_xml_feature(csp_deadlock_check,assertion,Assertion,FINFO),
2288 ( /*timeout_call(*/tcltk_interface:tcltk_check_csp_assertion(Assertion,CSPFile,'False',_PlTerm,ResTrace)/*,NOW,a)*/
2289 -> check_model_result(Assertion,ResTrace)
2290 ; true),
2291 stop_xml_feature(csp_deadlock_check,FINFO).
2292 cli_check_csp_assertion(Assertion,NOW) :-
2293 start_xml_feature(csp_assertion_check,assertion,Assertion,FINFO),
2294 loaded_main_file(CSPFile),
2295 ajoin(['assert ',Assertion],AssertionFull),
2296 ( timeout_call(tcltk_interface:tcltk_check_csp_assertion(AssertionFull,CSPFile,_Negated,PlTerm,ResTrace),NOW,csp_assertion_check)
2297 -> check_model_result(PlTerm,ResTrace)
2298 ; true),
2299 stop_xml_feature(csp_assertion_check,FINFO).
2300
2301
2302
2303 check_model_result(AssertionPlTerm,ResTrace) :-
2304 ( ResTrace==no_counter_example ->
2305 printsilent('==> Model Check Successful'),nls
2306 ;
2307 (functor(AssertionPlTerm,assertRef,_Arity) ->
2308 print('*** Refinement Check Counter-Example: ***'),nl, print(ResTrace),nl,
2309 print('*** Refinement Check Failed ***'),nl,
2310 error_occurred(refinement_check_fails)
2311 ;
2312 print('*** Model Check Counterexample: ***'),nl,print(ResTrace),nl,
2313 print('*** Model Check Failed ***'),nl,
2314 error_occurred(model_check_fails))
2315 ).
2316 :- use_module(probcspsrc(haskell_csp),[get_csp_assertions_as_string/2,
2317 parse_and_load_cspm_file_into_specific_pl_file/2,
2318 evaluate_csp_expression/2, evaluate_csp_expression/3]).
2319 cli_csp_get_assertions :-
2320 loaded_main_file(CSPFile),
2321 get_csp_assertions_as_string(CSPFile,String),
2322 print('*** Assertions in File (separated by $) ***'),nl,print(String),nl.
2323 cli_eval_csp_expression(E) :-
2324 (loaded_main_file(CSPFile) ->
2325 evaluate_csp_expression(E, CSPFile, Res)
2326 ; evaluate_csp_expression(E,Res)
2327 ), print('Evaluated Expression: '),nl,print(Res),nl.
2328 cli_csp_translate_to_file(PlFile) :-
2329 loaded_main_file(CSPFile),
2330 parse_and_load_cspm_file_into_specific_pl_file(CSPFile,PlFile).
2331 :- use_module(probltlsrc(ltl_fairness),[check_scc_ce/2]).
2332 cli_check_scc_for_ltl_formula(LtlFormula,SCC) :-
2333 check_scc_ce(LtlFormula,SCC).
2334
2335 :- use_module(extrasrc(coverage_statistics),[pretty_print_coverage_information_to_file/1]).
2336 cli_get_coverage_information(FileName) :-
2337 pretty_print_coverage_information_to_file(FileName).
2338 cli_vacuity_check :-
2339 eclipse_interface:get_vacuous_invariants(L),
2340 (L=[] -> print('No vacuous invariants'),nl
2341 ; maplist(prob_cli:add_vacuous_invariant,L)).
2342 add_vacuous_invariant(Inv) :-
2343 translate:translate_bexpression(Inv,TI),
2344 add_error(vacuity_check,'Vacuous invariant: ',TI).
2345 cli_start_socketserver(Port,Loopback) :-
2346 printsilent('Starting Socket Server'),nls,
2347 safe_absolute_file_name(prob_home('.'),AppDir),
2348 printsilent('Application Path: '),printsilent(AppDir),nls,
2349 disable_interaction_on_errors,
2350 ( start_prob_socketserver(Port,Loopback) -> true
2351 ;
2352 print('Starting socket server failed, Port: '), print(Port),nl),
2353 printsilent('Finished Socket Server'),nls.
2354 :- use_module(tools_platform, [platform_is_64_bit/0]).
2355 cli_check_statespace_hash(Expected,Kind) :-
2356 printsilent('Computing hash of entire statespace: '),
2357 compute_full_state_space_hash(Hash),
2358 printsilent(Hash),nls, % TO DO: maybe also compute hash for transitions and check that
2359 (Hash=Expected -> true
2360 ; Kind=='64bit', \+ platform_is_64_bit -> format('Hash does not match ~w (but was computed on 64-bit system)~n',[Expected])
2361 ; Kind=='32bit', platform_is_64_bit -> format('Hash does not match ~w (but was computed on 32-bit system)~n',[Expected])
2362 ; add_error(hash,'Expected Statespace Hash to be: ',Expected)).
2363 :- use_module(extrasrc(b_operation_cache),[get_op_cache_stats/1]).
2364 cli_check_op_cache(ReqInfos) :-
2365 get_op_cache_stats(Stats),
2366 (ReqInfos=[] -> format('Operation caching statistics: ~w~n',[Stats])
2367 ; formatsilent('Operation caching statistics: ~w~n',[Stats])),
2368 accumulate_infos(op_cache,Stats),
2369 check_required_infos(ReqInfos,Stats,op_cache_stats).
2370 cli_show_coverage(ShowEnabledInfo,NOW) :-
2371 cli_show_coverage(_Nodes,_Operations,ShowEnabledInfo,NOW).
2372 cli_show_coverage(Nodes,Operations,ShowEnabledInfo,NOW) :-
2373 ShowEnabledInfo == just_check_stats,!, % no printing of individual transition coverage
2374 get_state_space_stats(TotalNodeSum,TotalTransSum,_ProcessedTotal,_), % no computation overhead
2375 writeln_log(computed_coverage(NOW,TotalNodeSum,TotalTransSum)),
2376 check_totals(Nodes,Operations,TotalNodeSum,TotalTransSum).
2377 cli_show_coverage(Nodes,Operations,ShowEnabledInfo,NOW) :-
2378 ShowEnabledInfo == just_summary,
2379 !, % no printing of detailed transition coverage (avoid traversing state space)
2380 get_state_space_stats(TotalNodeSum,TotalTransSum,ProcessedTotal,Ignored), % no computation overhead
2381 writeln_log(computed_coverage(NOW,TotalNodeSum,TotalTransSum)),
2382 format('Coverage:~n States: ~w (~w processed, ~w ignored)~n Transitions: ~w~n',
2383 [TotalNodeSum,ProcessedTotal,Ignored,TotalTransSum]),
2384 show_initialisation_summary(NOW),
2385 show_operation_coverage_summary(NOW),
2386 (invariant_violated(ID) -> format('At least one state violates the invariant (~w) ~n',[ID]) ; true),
2387 check_totals(Nodes,Operations,TotalNodeSum,TotalTransSum).
2388 cli_show_coverage(Nodes,Operations,ShowEnabledInfo,NOW) :-
2389 print('Coverage:'),nl,
2390 compute_the_coverage(Res,TotalNodeSum,TotalTransSum,ShowEnabledInfo,false),
2391 writeln_log(computed_coverage(NOW,TotalNodeSum,TotalTransSum)),
2392 print(Res),nl,
2393 check_totals(Nodes,Operations,TotalNodeSum,TotalTransSum).
2394 check_totals(Nodes,Operations,TotalNodeSum,TotalTransSum) :-
2395 ( Nodes=TotalNodeSum -> true
2396 ;
2397 add_error(probcli,'Unexpected number of nodes: ',TotalNodeSum),
2398 add_error(probcli,'Expected: ',Nodes),error_occurred(coverage)),
2399 ( Operations=TotalTransSum -> true
2400 ;
2401 add_error(probcli,'Unexpected number of transitions: ',TotalTransSum),
2402 add_error(probcli,'Expected: ',Operations),error_occurred(coverage)).
2403
2404
2405 :- use_module(bmachine,[b_machine_statistics/2, b_get_main_filename/1, b_get_all_used_filenames/1,get_full_b_machine_sha_hash/1]).
2406 :- use_module(tools_strings,[get_hex_bytes/2]).
2407 cli_print_machine_info(statistics) :-
2408 b_machine_name(Name),
2409 %(b_get_main_filename(File) -> true ; File=unknown),
2410 format('Machine statistics for ~w:~n',[Name]),
2411 findall(Key/Nr,b_machine_statistics(Key,Nr),L),
2412 maplist(prob_cli:print_keynr,L),!.
2413 cli_print_machine_info(files(WithSha)) :-
2414 b_machine_name(Name),
2415 (WithSha = with_sha -> Msg2='and SHA1 ' ; Msg2=''),
2416 format('Files ~wused for machine ~w:~n',[Msg2,Name]),
2417 b_get_all_used_filenames(Files),
2418 maplist(prob_cli:print_individual_file(WithSha),Files),!.
2419 cli_print_machine_info(hash(Expected)) :-
2420 b_machine_name(MainName), % to do: findall machines and hashes
2421 get_full_b_machine_sha_hash(HashBytes),
2422 get_hex_bytes(HashBytes,Hash),
2423 format('SHA hash for machine ~w = ~s~n',[MainName,Hash]),!,
2424 write_xml_element_to_log(machine_hash,[hash/Hash]),
2425 (var(Expected) -> true
2426 ; atom_codes(Expected,Hash)
2427 -> format_with_colour_nl(user_output,[green],'Machine hash for ~w matches provided hash.',[MainName])
2428 ; add_error(machine_hash_check,'Unexpected machine hash, expected: ',Expected)).
2429 cli_print_machine_info(Kind) :- add_error(machine_stats,'Could not obtain machine information:',Kind).
2430 print_keynr(Key/Nr) :- format(' ~w : ~w~n',[Key,Nr]).
2431 :- use_module(extension('probhash/probhash'),[raw_sha_hash_file/3]).
2432 :- use_module(tools_strings,[get_hex_bytes/2]).
2433 print_individual_file(with_sha,File) :- Span = machine_info,
2434 raw_sha_hash_file(File,Term,Span),
2435 get_hex_bytes(Term,SHAHexCodes),
2436 format(' ~w, ~s~n',[File,SHAHexCodes]).
2437 print_individual_file(_,File) :- format(' ~w~n',[File]).
2438
2439 check_machine_file_sha(File,ExpectedHash) :- Span = check_machine_file_sha,
2440 get_full_machine_file_path(File,AbsFile),
2441 raw_sha_hash_file(AbsFile,Term,Span),
2442 get_hex_bytes(Term,SHAHexCodes), atom_codes(ExpectedHash,ExpectedShaCodes),
2443 (SHAHexCodes=ExpectedShaCodes
2444 -> format_with_colour_nl(user_output,[green],'Checked SHA1 hash for file ~w is ~s',[AbsFile,SHAHexCodes])
2445 ; add_error(check_machine_file_sha,'Unexpected SHA1 hash of file:',AbsFile),
2446 format_with_colour_nl(user_error,[orange],'! Expected: ~w~n! Actual : ~s',[ExpectedHash,SHAHexCodes])
2447 ).
2448
2449 :- use_module(bmachine,[get_machine_file_number/4, b_absolute_file_name_relative_to_main_machine/2]).
2450 :- use_module(probsrc(tools), [get_parent_directory/2]).
2451 get_full_machine_file_path(File,AbsFile) :-
2452 get_modulename_filename(File,Name), get_filename_extension(File,ExtF),
2453 (get_machine_file_number(Name,ExtF,_Nr,AbsFile)
2454 -> get_parent_directory(File,Parent),
2455 (Parent='' -> true % no path provided
2456 ; File=AbsFile -> true % full path provided
2457 ; b_absolute_file_name_relative_to_main_machine(File,AbsFile) -> true % consistent partial path provided
2458 ; add_error(check_machine_file_sha,'File path is inconsistent with used file:',File),
2459 format_with_colour_nl(user_error,[orange],'! File actually used in B specification:~n ~w',[AbsFile])
2460 )
2461 ; add_error(check_machine_file_sha,'Could not locate the file for:',File),
2462 b_absolute_file_name_relative_to_main_machine(File,AbsFile)
2463 ).
2464
2465 :- use_module(tools,[get_tail_filename/2]).
2466 xml_log_machine_statistics :-
2467 animation_mode(Major),
2468 (animation_minor_mode(Minor) -> true ; Minor=none),
2469 write_xml_element_to_log(animation_mode,[major/Major,minor/Minor]),
2470 (b_or_z_mode, b_machine_name(Main)
2471 -> findall(Key/Nr,b_machine_statistics(Key,Nr),BMachStats),
2472 (b_get_main_filename(MainFile) -> get_tail_filename(MainFile,TailFile) ; TailFile = unknown),
2473 write_xml_element_to_log(b_machine_statistics,[machine_name/Main, tail_filename/TailFile|BMachStats])
2474 ; true).
2475
2476 cli_print_junit_results(ArgV) :-
2477 junit_mode(S),!,
2478 statistics(runtime,[E,_]),
2479 T is E - S,
2480 create_and_print_junit_result(['Integration Tests'],ArgV,T,pass).
2481 cli_print_junit_results(_).
2482
2483 :- use_module(visbsrc(visb_visualiser),[load_visb_file/1,
2484 tcltk_perform_visb_click_event/1, generate_visb_html_for_history/2]).
2485 cli_visb_history(JSONFile,HTMLFile,Options) :-
2486 (load_visb_file(JSONFile)
2487 -> ifm_option_set(visb_click(SVGID),tcltk_perform_visb_click_event(SVGID)), % simulate clicks if requested
2488 generate_visb_html_for_history(HTMLFile,Options)
2489 ; true). % errors already reported
2490
2491 cli_print_history(HistFile) :-
2492 findall( O, option(history_option(O)), Options),
2493 debug_println(9,writing_history_to_file(HistFile)),
2494 (select(trace_file,Options,ROpt) -> tcltk_save_history_as_trace_file(prolog,ROpt,HistFile) % save as Prolog trace file for replay with -t
2495 ; select(json,Options,ROpt) -> tcltk_save_history_as_trace_file(json,ROpt,HistFile) % save for replay with ProB2 UI
2496 ; write_history_to_file(HistFile,Options) -> true
2497 ; add_error(history,'Writing history to file failed: ',HistFile)).
2498
2499 cli_print_values(ValuesFilename) :-
2500 (write_values_to_file(ValuesFilename) -> true ; add_error(sptxt,'Writing values to file failed: ',ValuesFilename)).
2501 cli_print_all_values(ValuesDirname) :-
2502 (write_all_values_to_dir(ValuesDirname) -> true ; add_error(sstxt,'Writing all values to directory failed: ',ValuesDirname)).
2503
2504 :- use_module(probltlsrc(trace_generator),[generate_all_traces_until/4]).
2505
2506 cli_generate_all_traces_until(LTL_Stop_AsAtom,FilePrefix) :-
2507 generate_all_traces_until(LTL_Stop_AsAtom,FilePrefix,Result,NrTracesGenerated),
2508 format_with_colour_nl(user_error,[blue],'Generated ~w traces, result=~w~n',[NrTracesGenerated,Result]).
2509
2510 :- dynamic probcli_time_stamp/1.
2511 generate_time_stamp(NOW,TS) :- retractall(probcli_time_stamp(_)),
2512 now(NOW),
2513 current_prolog_flag(argv,ArgV),term_hash(ArgV,Hash),
2514 Rnd is Hash mod 1000,
2515 % random(0,1000,Rnd), always returns 216 % TO DO: try to get milliseconds from some library function
2516 TS is (NOW*1000)+Rnd,
2517 assertz(probcli_time_stamp(TS)).
2518 update_time_stamp(NOW1) :- retractall(probcli_time_stamp(_)),
2519 assertz(probcli_time_stamp(NOW1)).
2520
2521 %get_errors :- \+ real_error_occurred,!, (get_error(_Source,_Msg) -> print('*** Warnings occurred'),nl ; true), reset_errors.
2522 get_errors :-
2523 (get_preference(view_probcli_errors_using_bbresults,true)
2524 -> tools_commands:show_errors_with_bb_results([current]) ; true),
2525 get_error_sources.
2526
2527 get_error_sources :- get_error_with_span(ErrSource,Msg,Span), !,
2528 error_occurred_with_msg(ErrSource,Msg,Span),
2529 findall(1,get_error(ErrSource,_),L), length(L,Nr),
2530 (Nr>0 -> N1 is Nr+1, get_error_category_and_type(ErrSource,Cat,Type),
2531 (Type=error -> print_error('*** Occurences of this error: ')
2532 ; print_error('*** Occurences of this warning: ')),
2533 print_error(N1),
2534 write_xml_element_to_log(multiple_errors_occurred,[category/Cat,(type)/Type,number/N1])
2535 ; true),
2536 get_error_sources.
2537 get_error_sources.
2538
2539 :- use_module(state_space,[state_error/3, invariant_violated/1, time_out_for_invariant/1, time_out_for_assertions/1, time_out_for_node/3]).
2540 ?get_state_space_errors :- option(strict_raise_error),
2541 !,
2542 (\+ option(no_invariant_violations),invariant_violated(ID)
2543 -> (option_verbose ->
2544 format('Invariant violation in state with id = ~w~n',[ID]),
2545 b_interpreter:analyse_invariant_for_state(ID) % caused issue for test 1076
2546 ; format('Invariant violation in state with id = ~w (use -v to print more details)~n',[ID])
2547 ),
2548 error_occurred(invariant_violation)
2549 ; true),
2550 (state_error(_,_,abort_error(TYPE,Msg,_,Span)) -> error_occurred(TYPE,error,Span,Msg) ; true),
2551 get_state_errors(_).
2552 get_state_space_errors.
2553
2554 get_state_errors(ID) :- state_error(ID,_,X), X\=invariant_violated, X\=abort_error(_,_,_,_),
2555 create_state_error_description(X,Msg),error_occurred(Msg),fail.
2556 get_state_errors(ID) :- time_out_for_invariant(ID),error_occurred(time_out_for_invariant),fail.
2557 get_state_errors(ID) :- time_out_for_assertions(ID),error_occurred(time_out_for_assertions),fail.
2558 get_state_errors(ID) :- time_out_for_node(ID,_,time_out),error_occurred(time_out),fail.
2559 get_state_errors(ID) :-
2560 time_out_for_node(ID,_,virtual_time_out(_)), %print(virtual_time_out_for_node(ID)),nl,
2561 error_occurred(virtual_time_out),fail.
2562 get_state_errors(_).
2563
2564
2565 create_state_error_description(eventerror(Event,Error,_),Description) :- !,
2566 functor(Error,Functor,_),
2567 ajoin(['event_error:',Event,':',Functor],Description).
2568 create_state_error_description(StateError,Description) :-
2569 functor(StateError,Functor,_),
2570 atom_concat('state_error:',Functor,Description).
2571
2572 % require a real machine to be loaded
2573 check_loaded_not_empty(Action) :-
2574 file_loaded(true,'$$empty_machine'),!,
2575 add_error(probcli,'No file specified; cannot perform command: ',Action),
2576 error_occurred(loading),fail.
2577 check_loaded_not_empty(Action) :- check_loaded(Action).
2578
2579 check_loaded(Action) :-
2580 ( file_loaded(true) -> true
2581 ; file_loaded(error) -> fail /* we have already generated error message */
2582 ;
2583 add_error(probcli,'No file specified; cannot perform action: ',Action),
2584 error_occurred(loading),fail).
2585
2586 :- dynamic loaded_main_file/2.
2587 loaded_main_file(File) :- loaded_main_file(_Ext,File).
2588
2589 :- use_module(tools,[get_filename_extension/2]).
2590 load_main_file(MainFile,NOW,Already_FullyProcessed) :- retractall(loaded_main_file(_,_)),
2591 debug_print(20,'% Loading: '), debug_println(20,MainFile),
2592 writeln_log_time(loading(NOW,MainFile)),
2593 get_filename_extension(MainFile,Ext),
2594 debug_println(6,file_extension(Ext)),
2595 file_extension_can_be_loaded(Ext,MainFile),
2596 start_probcli_timer(Timer),
2597 load_spec_file(Ext,MainFile,Already_FullyProcessed),
2598 stop_probcli_debug_timer(Timer,'% Finished loading'),
2599 (Already_FullyProcessed==true -> true
2600 ; assertz(loaded_main_file(Ext,MainFile))).
2601
2602 known_spec_file_extension('P',xtl).
2603 known_spec_file_extension(als,alloy).
2604 known_spec_file_extension(csp,csp).
2605 known_spec_file_extension(cspm,csp).
2606 known_spec_file_extension(def,b).
2607 known_spec_file_extension(eval,b_eval).
2608 known_spec_file_extension(eventb,eventb).
2609 known_spec_file_extension(fuzz,z).
2610 known_spec_file_extension(imp,b).
2611 known_spec_file_extension(mch,b).
2612 known_spec_file_extension(pb,b).
2613 known_spec_file_extension(pla,alloy). % Prolog AST of Alloy translation
2614 known_spec_file_extension(prob,b).
2615 known_spec_file_extension(ref,b).
2616 known_spec_file_extension(rmch,b_rules).
2617 known_spec_file_extension(smt,smt).
2618 known_spec_file_extension(smt2,smt).
2619 known_spec_file_extension(sys,b).
2620 known_spec_file_extension(tex,z).
2621 known_spec_file_extension(tla,tla).
2622 known_spec_file_extension(zed,z).
2623
2624 :- use_module(pathes_extensions_db, [load_spec_file_requires_extension/2]).
2625 :- use_module(pathes_lib, [available_extension/1, unavailable_extension/2]).
2626 % check if we can load the file extension given available ProB extensions
2627 file_extension_can_be_loaded(FileExt,_) :- known_spec_file_extension(FileExt,Mode),
2628 load_spec_file_requires_extension(Mode,ProBExtension),
2629 unavailable_extension(ProBExtension,Reason),!,
2630 ajoin(['File with ending .', FileExt,' cannot be loaded because extension not available (',Reason,'):'],Msg),
2631 add_error(probcli,Msg,ProBExtension),
2632 fail.
2633 file_extension_can_be_loaded(_,_). % assume ok; if unrecognized we will load as B machine
2634
2635 %load_spec_file('pl',MainFile) :- !, load_cspm_spec_from_pl_file(MainFile). % no longer needed ?
2636 load_spec_file('csp',MainFile) :- !, load_cspm_spec_from_cspm_file(MainFile).
2637 load_spec_file('cspm',MainFile) :- !, load_cspm_spec_from_cspm_file(MainFile).
2638 load_spec_file('P',MainFile) :- !, load_xtl_spec_from_prolog_file(MainFile).
2639 load_spec_file('p',MainFile) :- !, load_xtl_spec_from_prolog_file(MainFile). % sometimes windows is confused about the upper case letter....
2640 load_spec_file('eventb',MainFile) :- !, load_eventb_file(MainFile).
2641 load_spec_file('v',MainFile) :- !,
2642 print('Warning: .v proof rule file format no longer supported, use -eval_rule_file FILE'),nl,
2643 % but even that may not work; some older rule files required predicate variables
2644 load_b_file_with_options(MainFile). % Siemens Rule File; now use -eval_rule_file
2645 load_spec_file('prob',MainFile) :- !,load_prob_file_with_options(MainFile). % .prob files
2646 load_spec_file('mch',MainFile) :- !,load_b_file_with_options(MainFile).
2647 load_spec_file('sys',MainFile) :- !,load_b_file_with_options(MainFile).
2648 load_spec_file('ref',MainFile) :- !,load_b_file_with_options(MainFile).
2649 load_spec_file('imp',MainFile) :- !,load_b_file_with_options(MainFile).
2650 load_spec_file('rmch',MainFile) :- !,load_b_file_with_options(MainFile).
2651 load_spec_file('def',MainFile) :- !,load_b_file_with_options(MainFile). % .def DEFINITIONS file
2652 load_spec_file('fuzz',MainFile) :- !,tcltk_open_z_file(MainFile).
2653 load_spec_file('tex',MainFile) :- !,tcltk_open_z_tex_file(MainFile).
2654 load_spec_file('zed',MainFile) :- !,tcltk_open_z_tex_file(MainFile). % proz .zed file
2655 load_spec_file('als',MainFile) :- !,tcltk_open_alloy_file(MainFile).
2656 load_spec_file('pla',MainFile) :- !,tcltk_open_alloy_prolog_ast_file(MainFile). % maybe we should detect .als.pl
2657 load_spec_file('tla',MainFile) :- !, load_tla_file(MainFile).
2658 load_spec_file('eval',File) :- !, % .eval file
2659 cli_set_empty_machine,
2660 assertz(option(eval_string_or_file(file(default),File,exists,_,norecheck))).
2661 load_spec_file('pb',File) :- !, cli_set_empty_machine, % .pb file
2662 cli_set_empty_machine,
2663 assertz(option(eval_string_or_file(file(default),File,exists,_,norecheck))).
2664 %load_spec_file('pml',MainFile) :- !,parsercall:call_promela_parser(MainFile),
2665 % parsercall:promela_prolog_filename(MainFile,PrologFile),
2666 % println_silent(consulting(PrologFile)),
2667 % tcltk_open_promela_file(PrologFile).
2668 load_spec_file(EXT,MainFile) :- print_error('Unknown file extension, assuming B machine:'),
2669 print_error(EXT),
2670 load_b_file_with_options(MainFile).
2671
2672 load_spec_file('pl',MainFile, Already_FullyProcessed) :- !, Already_FullyProcessed=true,
2673 printsilent('Processing PO file: '),printsilent(MainFile),nls,
2674 load_po_file(MainFile),
2675 (option(timeout(TO)) -> set_disprover_timeout(TO) ; reset_disprover_timeout),
2676 (option(disprover_options(L)) -> set_disprover_options(L) ; set_disprover_options([])),
2677 println_silent('Running ProB Disprover'),
2678 run_disprover_on_all_pos(Summary),
2679 print_disprover_stats,
2680 accumulate_infos(disprover,[po_files-1|Summary]),
2681 get_errors,
2682 (option(cli_check_disprover_result(Infos)) -> check_required_infos(Infos,Summary,load_po_file)
2683 ; option(strict_raise_error) -> check_required_infos([false-0,unknown-0,failure-0],Summary,load_po_file)
2684 % TO DO: provide way for user to specify expected info
2685 ; true),
2686 cli_process_options_for_alrady_fully_processed_file(MainFile),
2687 clear_loaded_machines.
2688 load_spec_file(EXT,MainFile,Already_FullyProcessed) :- (EXT='smt2' ; EXT= 'smt'), !,
2689 Already_FullyProcessed=true,
2690 printsilent('Processing SMT file: '),printsilent(MainFile),nls,
2691 (option(eval_repl([])) -> Opts = [repl] ; Opts=[]),
2692 smtlib2_file(MainFile,Opts).
2693 load_spec_file(EXT,F,false) :- load_spec_file(EXT,F).
2694
2695 load_prob_file_with_options(File) :-
2696 (option(release_java_parser) -> Options = [use_fastread] ; Options = []),
2697 load_prob_file(File,Options).
2698 load_b_file_with_options(File) :-
2699 (option(release_java_parser) -> Options = [release_java_parser,use_fastread]
2700 ; option(fast_read_prob) -> Options = [use_fastread] % use fastread for large .prob files
2701 ; Options = []),
2702 % TO DO: automatically release if no option requires parsing and no more file uses it; or print warning if release will affect other options like -repl (DEFINITIONS not available,...)
2703 load_b_file(File,Options).
2704
2705 % do not perform -execute_all if no parameters provided
2706 do_not_execute_automatically('pl').
2707 do_not_execute_automatically('smt2').
2708
2709 test_kodkod_and_exit(MaxResiduePreds,NOW) :-
2710 start_animation_without_computing,
2711 test_kodkod(MaxResiduePreds),
2712 halt_prob(NOW,0).
2713
2714 compare_kodkod_performance1(KPFile,Iterations,NOW) :-
2715 start_animation_without_computing,
2716 compare_kodkod_performance(KPFile,Iterations),
2717 halt_prob(NOW,0).
2718
2719 :- use_module(parsercall,[check_java_version/2,get_parser_version/1, ensure_console_parser_launched/0,
2720 connect_to_external_console_parser_on_port/1]).
2721 check_java_version :- check_java_version(V,Result),
2722 format('Result of checking Java version:~n ~w~n',[V]),
2723 (Result=compatible -> check_parser_version
2724 ; add_error(check_java_version,V)).
2725
2726 check_parser_version :- get_parser_version(PV),!,
2727 format(' ProB B Java Parser available in version: ~w.~n',[PV]). % will also launch parser
2728 check_parser_version :- add_error(check_parser_version,'Cannot start Java B Parser to obtain version number').
2729
2730 :- use_module(pathes_lib,[install_lib_component/2]).
2731 install_prob_lib(Lib,Opts) :- install_lib_component(Lib,Opts).
2732
2733 print_version(Kind) :- print_version(Kind,user_output).
2734
2735 print_version(short,Stream) :- print_short_version(Stream).
2736 print_version(cpp,Stream) :- print_cpp_version(Stream).
2737 print_version(java,Stream) :- print_java_version(Stream).
2738 print_version(full,Stream) :- print_full_version(Stream).
2739 print_version(full_verbose,Stream) :- print_full_version(Stream,verbose).
2740 print_version(host,Stream) :- print_host_version(Stream).
2741 print_version(lib,Stream) :- check_lib_contents(Stream,verbose).
2742
2743 :- use_module(version).
2744 print_short_version(Stream) :-
2745 version(V1,V2,V3,Suffix),revision(Rev),
2746 format(Stream,'VERSION ~p.~p.~p-~p (~p)~N',[V1,V2,V3,Suffix,Rev]).
2747
2748 :- use_module(parsercall,[get_parser_version/1, get_java_command_path/1, get_java_fullversion/1]).
2749 :- use_module(pathes_lib,[check_lib_contents/2]).
2750 print_full_version(Stream) :-
2751 (option_verbose ->
2752 (option_very_verbose
2753 -> print_full_version(Stream,very_verbose)
2754 ; print_full_version(Stream,verbose)
2755 )
2756 ; print_full_version(Stream,normal)
2757 ).
2758 print_full_version(Stream,Verbose) :-
2759 format(Stream,'ProB Command Line Interface~n',[]),
2760 print_probcli_version(Stream),
2761 ( Verbose=normal -> true
2762 ;
2763 current_prolog_flag(system_type,SysType),
2764 format(Stream,' Prolog System Type: ~p~N', [SysType]), % development or runtime
2765 safe_absolute_file_name(prob_home('.'),AppDir),
2766 format(Stream,' Application Path: ~p~N', [AppDir]),
2767 print_host_version(Stream),
2768 print_java_version(Stream),
2769 print_cpp_version(Stream),
2770 (Verbose = very_verbose
2771 -> print_prolog_flags(Stream), print_extensions(Stream), print_modules(Stream),
2772 check_lib_contents(Stream,verbose)
2773 ; check_lib_contents(Stream,silent)
2774 )
2775 ), print_compile_time_flags.
2776
2777 print_java_version(Stream) :-
2778 (get_java_command_path(JavaPath)
2779 -> format(Stream,' Java Runtime: ~p~N', [JavaPath]),
2780 (get_java_fullversion(JavaVersion)
2781 -> format(Stream,' Java Version: ~s~N', [JavaVersion])
2782 ; format(Stream,' Java Version: *** not available ***~N',[])
2783 ),
2784 (get_parser_version(ParserVersion)
2785 -> format(Stream,' Java Parser: ~p~N', [ParserVersion])
2786 ; format(Stream,' Java Parser: *** not available ***~N',[])
2787 )
2788 ; format(Stream,' Java Runtime: *** not available ***~N',[])
2789 ).
2790
2791 :- use_module(tools_platform, [host_platform/1, host_processor/1]).
2792 print_host_version(Stream) :-
2793 host_platform(HP),
2794 host_processor(Proc),
2795 (platform_is_64_bit -> Bits=64 ; Bits=32),
2796 format(Stream,' Host Processor: ~w (~w bits)~n Host Operating System: ~w~n',[Proc,Bits,HP]).
2797
2798
2799 print_probcli_version(Stream) :-
2800 full_version_str(VersStr),
2801 revision(Rev), lastchangeddate(LCD),
2802 current_prolog_flag(dialect, Dialect),
2803 (Dialect= swi, current_prolog_flag(version_git,PV) -> true
2804 ; current_prolog_flag(version,PV)
2805 ),
2806 format(Stream,' VERSION ~w (~p)~N ~p~N Prolog (~w): ~p~N',
2807 [VersStr,Rev,LCD,Dialect, PV]).
2808
2809
2810 :- use_module(compile_time_flags,[compile_time_flags/1, relevant_prolog_flags/1]).
2811 :- use_module(extension('regexp/regexp'),[get_cpp_version/1]).
2812 print_compile_time_flags :-
2813 compile_time_flags(list(Flags)),
2814 (Flags=[], \+ option_verbose -> true ; format(' COMPILE TIME FLAGS: ~w~N',[Flags])).
2815 print_prolog_flags(Stream) :-
2816 relevant_prolog_flags(Flags),
2817 format(Stream,' PROLOG FLAGS: ~w~N',[Flags]).
2818 print_extensions(Stream) :- findall(E,available_extension(E),Es),
2819 format(Stream,' EXTENSIONS: ~w~N',[Es]).
2820 print_cpp_version(Stream) :-
2821 available_extension(regexp_extension),!,
2822 get_cpp_version(V),
2823 format(Stream,' C++ Version for extensions: ~w~n',[V]).
2824 print_cpp_version(_).
2825 print_modules(Stream) :- findall(M,current_module(M),Ms), sort(Ms,SMs),
2826 format(Stream,' PROLOG MODULES: ~w~N',[SMs]).
2827
2828 print_logo :-
2829 % should be improved considerably; doesn't look very nice yet on macOS terminal due to line separation
2830 % â–„â–„â–„â–„ â–„â–„â–„â–„
2831 % â–ˆ â–ˆ â–ˆ â–ˆ
2832 % █▀▀▀ ▄ ▄▄▄ █▀▀▀▄
2833 % █ █ █▄█ █▄▄▄▀
2834 format_with_colour_nl(user_output,[blue],' ~s',[[9604,9604,9604,9604,32,32,32,32,32,32,32,9604,9604,9604,9604]]),
2835 format_with_colour_nl(user_output,[blue],' ~s',[[9608,32,32,32,9608,32,32,32,32,32,32,9608,32,32,32,9608]]),
2836 format_with_colour_nl(user_output,[blue],' ~s',[[9608,9600,9600,9600,32,9604,32,9604,9604,9604,32,9608,9600,9600,9600,9604]]),
2837 format_with_colour_nl(user_output,[blue],' ~s',[[9608,32,32,32,9608,32,32,9608,9604,9608,32,9608,9604,9604,9604,9600]]).
2838
2839 print_help :-
2840 print_version(full),
2841 print('Usage: probcli FILE [OPTIONS]'),nl,
2842 print(' OPTIONS are: '),nl,
2843 print(' -mc Nr model check; checking at most Nr states'),nl,
2844 print(' -model_check model check without limit on states explored'),nl,
2845 ( \+ option_verbose ->
2846 print(' -noXXX XXX=dead,inv,goal,ass (for model check)'),nl % -nodead, -noinv, -nogoal, -noass
2847 ;
2848 print(' -nodead do not look for deadlocks (for model check, animate, execute)'),nl,
2849 print(' -noinv do not look for invariant violations (for model check, animate, execute)'),nl,
2850 print(' -nogoal do not look for GOAL predicate (for model check, execute)'),nl,
2851 print(' -noass do not look for ASSERTION violations (for model check, execute)'),nl
2852 ),
2853 print(' -bf proceed breadth-first (default is mixed bf/df)'),nl,
2854 print(' -df proceed depth-first'),nl,
2855 print(' -mc_mode M M=hash,heuristic,random,dlk,breadth-first,depth-first,mixed,size'),nl, % dlk stands for out_degree_hash
2856 print(' -global_time_out N total timeout in ms for model/refinement checking and'),nl,
2857 print(' and execute steps and disprover checks'),nl,
2858 print(' -disable_timeout disable timeouts for operations, invariants,....'),nl, % speeds up mc
2859 print(' -t trace check (associated .trace file must exist)'),nl,
2860 print(' -init initialise specification'),nl,
2861 print(' -cbc OPNAME constraint-based invariant checking for an operation'),nl,
2862 print(' (you can also use OPNAME=all)'),nl,
2863 print(' -cbc_deadlock constraint-based deadlock checking'),nl,
2864 ( \+ option_verbose -> true ;
2865 print(' -cbc_deadlock_pred PRED as above but with additional predicate'),nl
2866 ),
2867 print(' -cbc_assertions constraint-based static assertion checking'),nl,
2868 print(' -cbc_refinement constraint-based static refinement checking'),nl,
2869 print(' -cbc_sequence S constraint-based search for sequence of operations'),nl,
2870 print(' -strict raise error if model-checking finds counter example'),nl,
2871 print(' or trace checking fails or any error state found'),nl,
2872 print(' -expcterr ERR expect error to occur (ERR=cbc,mc,ltl,...)'),nl,
2873 print(' -animate Nr random animation (max. Nr steps)'),nl,
2874 print(' -animate_all random animation until a deadlock is reached'),nl,
2875 print(' -animate_stats provide feedback which operations are animated or executed'),nl,
2876 print(' -execute Nr execute specification (maximally Nr steps)'),nl,
2877 print(' in contrast to -animate: stops at first operation found, is deterministic,'),nl,
2878 print(' does not store intermediate states and does not use TIME_OUT preference'),nl,
2879 print(' -execute_all execute until a deadlock, direct loop, goal or error is reached'),nl,
2880 print(' -execute_monitor monitor performance of execute'),nl,
2881 print(' -his File write history to File'),nl,
2882 print(' -his_option O additional option when writing a history (show_init,show_states,json,trace_file)'),nl,
2883 print(' -sptxt File save constants and variable values of last discovered state to File'),nl,
2884 print(' -sstxt Dir save constants and variable values of all discovered states to files in Dir'),nl,
2885 print(' -cache Directory automatically save constants to files and avoid recomputation'),nl,
2886 print(' -det_check check if animation steps are deterministic'),nl,
2887 print(' -det_constants only check if SETUP_CONSTANTS step is deterministic'),nl,
2888 ( \+ option_verbose -> true ;
2889 print(' -i interactive animation. Only for interactive sessions,'),nl,
2890 print(' the output can arbitrarily change in future versions. '),nl,
2891 print(' Do not build automatic tools using the interactive mode'),nl
2892 ),
2893 print(' -repl start interactive read-eval-loop'),nl,
2894 print(' -eval "E" evaluate expression or predicate'),nl,
2895 print(' -eval_file FILE evaluate expression or predicate from file'),nl,
2896 print(' -c print coverage statistics'),nl,
2897 print(' -cc Nr Nr print and check coverage statistics'),nl,
2898 print(' -vacuity_check look for vacuous implications in invariant'),nl,
2899 print(' -cbc_redundant_invariants Nr find redundant invariants, expecting Nr'),nl, % Nr exepcted
2900 print(' -statistics print memory and other statistics at the end'),nl,
2901 print(' -p PREF Val set preference to value'),nl,
2902 print(' -prefs FILE set preferences from Prolog file'),nl,
2903 print(' -pref_group G S set group G of preferences to predefined value set S'),nl,
2904 print(' -card GS Val set cardinality (aka scope) of B deferred set'),nl,
2905 print(' -goal "PRED" set GOAL predicate for model checker'),nl,
2906 print(' -check_goal check GOAL (after -mc, -t, or -animate)'),nl,
2907 print(' -scope "PRED" set scope predicate for model checker'),nl,
2908 print(' (only states satsifying this predicate will be examined)'),nl,
2909 print(' -property "PRED" virtually add predicate to PROPERTIES'),nl,
2910 print(' -s Port start socket server on given port'),nl,
2911 print(' -ss start socket server on port 9000'),nl,
2912 print(' -sf start socket server on some free port'),nl,
2913 print(' -l LogFile log activities in LogFile'),nl,
2914 print(' -ll log activities in /tmp/prob_cli_debug.log'),nl,
2915 print(' -logxml LogFile log activities in XML LogFile'),nl,
2916 print(' -logxml_write_ids P write variables/constants starting with P to XML LogFile'),nl,
2917 print(' -pp FILE pretty-print internal representation to file (or user_output)'), nl,
2918 print(' -ppf FILE like -pp, but force printing of all type infos'),nl,
2919 print(' -ppAB FILE like -ppf, but make output readable by Atelier-B'),nl,
2920 print(' -ppB FILE pretty-print Event-B model to file in valid B syntax'),nl,
2921 ( \+ option_verbose -> true ;
2922 print(' -ppi FILE pretty-print B model main file with indenatation'),nl,
2923 print(' -indent_b_file BFILE FILE pretty-print BFILE to FILE with indenatation'),nl,
2924 print(' -reformat_b_file BFILE FILE reformat BFILE to FILE (may insert newlines)'),nl,
2925 print(' -pp_pl_file PLFILE FILE indent Prolog PLFILE to FILE'),nl
2926 ),
2927 print(' -v verbose'),nl,
2928 ( \+ option_verbose -> true ;
2929 print(' -vv very verbose'),nl
2930 ),
2931 print(' -mc_with_tlc model check using TLC (see also TLC_WORKERS preference)'),nl,
2932 print(' -mc_with_lts_sym model check using LTSmin (symbolic)'),nl,
2933 print(' -mc_with_lts_seq model check using LTSmin (sequential)'),nl,
2934
2935 ( \+ option_verbose -> true ;
2936 print(' -ltsmin_option OPT set option for LTSmin (e.g, por)'),nl,
2937 print(' -ltsmin_ltl_output FILE set output file for LTSMin'),nl,
2938 print(' -symbolic_model_check ALGO ALGO is bmc, kinduction, ctigar, ic3'),nl,
2939 print(' -enabling_analysis_csv FILE perform operation enabling analysis'),nl,
2940 print(' -feasibility_analysis perform operation feasibility analysis'),nl,
2941 print(' -feasibility_analysis_csv FILE write feasibility result to file'),nl,
2942 print(' -read_write_matrix show read/write matrix for operations'),nl
2943 ),
2944 print(' -version print version information (-svers for short info)'),nl,
2945 print(' -check_java_version check that Java version compatible with ProB parser'),nl,
2946 print(' -assertions check ASSERTIONS'),nl,
2947 print(' -main_assertions check ASSERTIONS from main file only'),nl,
2948 print(' -properties check PROPERTIES'),nl,
2949 print(' -cache Dir use directory "Dir" to cache constants and variables'),nl,
2950 print(' -ltlfile F check LTL formulas in file F'),nl,
2951 print(' -ltlassertions check LTL assertions (in DEFINITIONS)'),nl,
2952 print(' -ltllimit L explore at most L states when model-checking LTL or CTL'),nl,
2953 print(' -ltlformula \"F\" check the LTL formula F'),nl,
2954 print(' -ctlformula \"F\" check the CTL formula F'),nl,
2955 print(' -save File save state space for later refinement check'),nl,
2956 print(' -refchk File refinement check against previous saved state space'),nl,
2957 print(' -mcm_tests Depth MaxStates EndPredicate File'),nl,
2958 print(' generate test cases with maximum length Depth, explore'),nl,
2959 print(' maximally MaxStates, the last state satisfies EndPredicate'),nl,
2960 print(' and the test cases are written to File'),nl,
2961 print(' -mcm_cover Operation'),nl,
2962 print(' when generating MCM test cases, Operation should be covered'),nl,
2963 print(' -cbc_tests Depth EndPredicate File'),nl,
2964 print(' generate test cases by constraint solving with maximum'),nl,
2965 print(' length Depth, the last state satisfies EndPredicate'),nl,
2966 print(' and the test cases are written to File'),nl,
2967 print(' -cbc_cover Operation'),nl,
2968 print(' when generating CBC test cases, Operation should be covered'),nl,
2969 % print(' -cbc_cover_all try and cover all operations'),nl, % is now default if no cbc_cover provided
2970 print(' -test_description File'),nl,
2971 print(' read information for test generation from File'),nl,
2972 print(' -dot CMD File write a graph to a dot file, with CMD being one of:'),nl,
2973 (is_dot_command(Cmd),command_description(Cmd,_,Desc),
2974 format(' ~w : ~w~n',[Cmd,Desc]),fail
2975 ; true),
2976 print(' -dotexpr CMD Expr File write a graph for Expr to a dot file, with CMD:'),nl,
2977 (is_dot_command_for_expr(Cmd),command_description(Cmd,_,Desc),
2978 format(' ~w : ~w~n',[Cmd,Desc]),fail
2979 ; true),
2980 print(' -puml CMD File write a graph to a plantuml file, with CMD being one of:'),nl,
2981 (is_plantuml_command(Cmd),command_description(Cmd,_,Desc),
2982 format(' ~w : ~w~n',[Cmd,Desc]),fail
2983 ; true),
2984 print(' -pumlexpr CMD Expr File write a graph for Expr to a plantuml file, with CMD:'),nl,
2985 (is_plantuml_command_for_expr(Cmd),command_description(Cmd,_,Desc),
2986 format(' ~w : ~w~n',[Cmd,Desc]),fail
2987 ; true),
2988 print(' -csv CMD File write a table to a CSV file, with CMD being one of:'),nl,
2989 (is_table_command(Cmd),command_description(Cmd,_,Desc),
2990 format(' ~w : ~w~n',[Cmd,Desc]),fail
2991 ; true),
2992 print(' -csvexpr CMD Expr File write a table for Expr to a CSV file, with CMD:'),nl,
2993 (is_table_command_for_expr(Cmd),command_description(Cmd,_,Desc),
2994 format(' ~w : ~w~n',[Cmd,Desc]),fail
2995 ; true),
2996 print(' -dot_output Path generate dot files for false assertions/properties'),nl,
2997 print(' -dot_all also generate dot files for true assertions/properties'),nl,
2998 print(' -rule_report generate HTML validation report for rules machines (.rmch)'),nl,
2999 print(' -csvhist E File evaluate expression over history and generate CSV file'),nl,
3000 print(' -visb JFile HFile use VisB JSON file JFILE to create HTML visualistion of history'),nl,
3001 print(' -visb_with_vars JFile HFile (similar, but also show variable values)'),nl,
3002 print(' -load_state File load state of ProB from a saved state space (generated by ProB Tcl/Tk or -save_state)'),nl,
3003 % For Eclipse Version only
3004 %% print(' -parsercp CP class path of the B Parser, this has to be a valid Java class path'),nl,
3005 %% print(' -cspm load CSP-M .csp file rather than B Machine .mch/.ref/.imp File'),nl,
3006 %% print(' -csp load CSP-M .pl file rather than B Machine File'),nl,
3007
3008 /* Options -cspref, -cspdeadlock, -cspdeterministic, and -csplivelock are deprecated, should be excluded in favor of -csp_assertion */
3009 print(' -cspref Spec [m= Impl File'),nl,
3010 print(' checks a refinement statement,'),nl,
3011 print(' where Spec and Impl are processes from File, and \'m\' the type of the refinement:'),nl,
3012 print(' \'T\' for traces, \'F\' for failures, or \'FD\' for failures-divergences.'),nl,
3013 print(' -cspdeadlock P m File'),nl,
3014 print(' checks a process for deadlock,'),nl,
3015 print(' where \'P\' is a process from File, and \'m\' the type of the model:'),nl,
3016 print(' \'F\' for failures and \'FD\' for failures-divergences.'),nl,
3017 print(' -cspdeterministic P m File'),nl,
3018 print(' checks a process for determinism,'),nl,
3019 print(' where \'P\' is a process from File, and \'m\' the type of the model:'),nl,
3020 print(' \'F\' for failures and \'FD\' for failures-divergences.'),nl,
3021 print(' -csplivelock P File'),nl,
3022 print(' checks a process for divergence,'),nl,
3023 print(' where \'P\' is a process from File.'),nl,
3024 /* Options -cspref, -cspdeadlock, -cspdeterministic, and -csplivelock are deprecated, should be excluded in favor of -csp_assertion */
3025
3026 print(' -csp_assertion \"A\" File'),nl,
3027 print(' checks the CSP assertion \'A\' on file \'File\''),nl,
3028 print(' -csp_eval "E" evaluate CSP-M expression.'),nl,
3029 print(' -csp_guide File CSP||B: Use the CSP File to control the B machine'),nl,
3030 print(' '),nl,
3031 ( \+ option_verbose -> true
3032 ;
3033 print(' -test_mode set random seed to the Prolog\'s current random state'),nl,
3034 print(' -rc runtime checking of types/pre-/post-conditions'),nl,
3035 print(' -state_trace File read a file of B predicates (one per line) and try find a matching trace.'),nl
3036
3037 ),
3038 print(' FILE extensions are: '),nl,
3039 print(' .mch for B abstract machines'),nl,
3040 print(' .ref for B refinement machines'),nl,
3041 print(' .imp for B implementation machines'),nl,
3042 print(' .sys for Event-B abstract machines'),nl,
3043 print(' .rmch for B Rule DSL machines'),nl,
3044 print(' .csp, .cspm for CSP-M files, same format as FDR'),nl,
3045 print(' .eventb for Event-B packages exported from Rodin ProB Plugin'),nl,
3046 print(' .tex, .zed for Z models'),nl,
3047 print(' .tla for TLA+ models'),nl,
3048 print(' .als for Alloy models'),nl,
3049 print(' .P for Prolog XTL models'),nl,
3050 ( option_verbose ->
3051 print(' Preferences PREF are: '),nl,
3052 print_eclipse_prefs
3053 ;
3054 print(' Use --help -v to print available preferences PREF'),nl
3055 ),
3056 print(' Set NO_COLOR environment variable to disable terminal colors'),nl,
3057 print(' More info at: https://prob.hhu.de/w/index.php/ProB_Cli'),nl,
3058 nl.
3059
3060
3061 set_argv(V) :-
3062 debug_println(20,set_argv(V)),
3063 external_functions:set_argv_from_atom(V).
3064
3065 :- use_module(b_global_sets, [set_user_defined_scope/2]).
3066 :- use_module(state_space_exploration_modes,[set_depth_breadth_first_mode/1, get_current_breadth_first_level/1]).
3067 :- use_module(tools_strings, [convert_cli_arg/2]).
3068 set_prefs :-
3069 if_option_set(cli_start_sym_mc_with_lts(_),
3070 preferences:set_preference(try_operation_reuse,false)), % LTSMIN does its own OPERATION_REUSE
3071 if_option_set(socket(_,_), % then we may need the event(.) transition_info for the Java API
3072 preferences:set_preference(store_event_transinfo,true)),
3073 option(set_prefs_from_file(File)),
3074 debug_println(20,load_preferences(File)),
3075 preferences:load_preferences(File),
3076 fail.
3077 set_prefs :-
3078 option(set_preference_group(P,V)),
3079 debug_println(20,set_preference_group(P,V)),
3080 set_preference_group(P,V),
3081 fail.
3082 % eclipse preference or 'normal preference'
3083 set_prefs :-
3084 ? option(set_pref(P,V)),
3085 set_pref(P,V),
3086 fail.
3087 set_prefs :- option(set_card(Set,V)),
3088 debug_println(20,set_card(Set,V)),
3089 convert_cli_arg(V,Value),
3090 set_user_defined_scope(Set,Value),
3091 fail.
3092 set_prefs :-
3093 ( option(breadth_first) -> set_depth_breadth_first_mode(breadth_first)
3094 ; option(depth_first) -> set_depth_breadth_first_mode(depth_first)
3095 ; option(depth_breadth_first_mode(M)) -> set_depth_breadth_first_mode(M)
3096 ; true
3097 ).
3098 :- use_module(tools_matching,[get_possible_preferences_matches_msg/2]).
3099 set_pref(P,V) :-
3100 debug_println(20,set_pref(P,V)),
3101 ? ( eclipse_preference(P,_)
3102 -> set_eclipse_preference(P,V)
3103 ; deprecated_eclipse_preference(P,_,_,_) -> set_eclipse_preference(P,V)
3104 ; obsolete_eclipse_preference(P) -> probcli_add_light_warning('Obsolete preference: ',P)
3105 ; obsolete_preference(P) -> probcli_add_light_warning('Obsolete preference: ',P)
3106 ; % might be a term if its a plugin preference
3107 atom_codes(P,Codes),
3108 append(Codes,".",Codes2), % to make term readable by read_from_codes
3109 read_from_codes(Codes2,Preference),
3110 (nonvar(Preference),preference_val_type(Preference,_)
3111 -> convert_cli_arg(V,Value),
3112 set_preference(Preference,Value)
3113 ; P=timeout ->
3114 add_error(probcli,'Unknown preference timeout. Either set preference TIME_OUT or use -gobal_time_out command','')
3115 ; get_possible_preferences_matches_msg(P,FuzzyMsg) ->
3116 ajoin(['Unknown preference: ',P,'. Did you mean:'],Msg),
3117 add_error(probcli,Msg,FuzzyMsg)
3118 ; get_possible_fuzzy_match_options(P,FuzzyMatches),
3119 % will only give perfect matches as P usually does not have the hyphen in front
3120 FuzzyMatches = [FMC|_] ->
3121 ajoin(['Unknown preference ', P, ' which looks like a probcli command! Did you want to call:'],Msg),
3122 add_error(probcli,Msg,FMC)
3123 ;
3124 add_error(probcli,'Unknown preference:',P)
3125 )
3126 ).
3127
3128 % add non severe warning:
3129 probcli_add_light_warning(Msg,Term) :- option(strict_raise_error),!,
3130 add_warning(probcli,Msg,Term). % does not write on user_error
3131 probcli_add_light_warning(Msg,Term) :- add_message(probcli,Msg,Term).
3132
3133 set_optional_errors :- % register optional/expected errors in the error_manager; avoid printing on stderr
3134 reset_optional_errors_or_warnings,
3135 (option(optional_error(Type)) ; option(expect_error(Type)) ; option(expect_error_pos(Type,_Line,_Col))),
3136 register_optional_error_or_warning(Type),
3137 fail.
3138 set_optional_errors.
3139
3140 % explicit state model checking, without LTL/CTL
3141 regular_safety_model_check_now(Nr,Runtime,WallTime,MCRes,NOW) :-
3142 statistics(runtime,[T1,_]),
3143 statistics(walltime,[W1,_]),
3144 (option(timeout(TO)) -> safe_time_out(regular_safety_model_check(Nr,Time,MCRes),TO,Res)
3145 ; regular_safety_model_check(Nr,Time,MCRes), Res=success
3146 ),
3147 statistics(runtime,[T2,_]),
3148 statistics(walltime,[W2,_]),
3149 WallTime is W2-W1,
3150 Runtime is T2-T1,
3151 (Res=time_out
3152 -> add_warning(model_check_incomplete,'Not all states examined due to -global_time_out option set by user: ',TO),
3153 writeln_log(timeout_occurred(NOW,model_check(Nr,Time,MCRes))),
3154 coverage(just_summary),
3155 MCRes=time_out
3156 ; true).
3157
3158 :- use_module(model_checker,[model_checking_is_incomplete/6]).
3159
3160 % TO DO: check for ignored states
3161 % code somewhat redundant also with model_check_incomplete below
3162 add_model_checking_warnings(FindInvViolations,FindDeadlocks,FindGoal,FindAssViolations) :-
3163 %print(check(model_checking_is_incomplete(FindInvViolations,FindDeadlocks,FindGoal,FindAssViolations,Msg,Term))),nl,
3164 model_checking_is_incomplete(FindInvViolations,FindDeadlocks,FindGoal,FindAssViolations,Msg,Term),
3165 add_warning(model_check_incomplete,Msg,Term),
3166 % TO DO: store for accumulate_infos
3167 fail.
3168 add_model_checking_warnings(_,_,_,_).
3169
3170 :- use_module(state_space,[current_state_id/1]).
3171 regular_safety_model_check(Nr,Time,ErrRes) :-
3172 statistics(runtime,[T1,_]),
3173 statistics(walltime,[W1,_]),
3174 catch(model_check_aux(Nr,T1,W1,Time,ErrRes), user_interrupt_signal, (
3175 statistics(walltime,[W2,_]), TotalWT is W2-W1,
3176 format_with_colour_nl(user_error,[red],'~nmodel checking interrupted after ~w ms by user (CTRL-C)',[TotalWT]),
3177 coverage(just_summary),
3178 perform_feedback_options_after_exception,
3179 throw(user_interrupt_signal)
3180 )).
3181
3182 % perform some important options for user feedback after CTRL-C interrupts model checking, execute, ...
3183 perform_feedback_options_after_exception :-
3184 (option(check_op_cache(_)) -> cli_check_op_cache([]) ; true),
3185 if_options_set(csv_table_command(TECommand,TableFormulas,TableOptions,TableCSVFile),
3186 csv_table_command(TECommand,TableFormulas,TableOptions,TableCSVFile)),
3187 (option(get_coverage_information(FCC)) -> pretty_print_coverage_information_to_file(FCC) ; true),
3188 (option(cli_print_statistics(X)), (cli_print_statistics(X) -> fail) ; true).
3189
3190 model_check_aux(Nr,T1,W1,Time,ErrRes) :-
3191 (option(no_deadlocks) -> FindDeadlocks=0 ; FindDeadlocks=1),
3192 (option(no_invariant_violations) -> FindInvViolations=0 ; FindInvViolations=1),
3193 (option(no_goal) -> FindGoal=0 ; FindGoal=1),
3194 (option(no_state_errors) -> FindStateErrors=0 ; FindStateErrors=1),
3195 (option(no_assertion_violations)
3196 -> FindAssViolations=0
3197 ; FindAssViolations=1
3198 ),
3199 get_preference(por,POR),
3200 StopAtFullCoverage=0,
3201 %STOPMCAFTER = 86400000, /* 86400000 = 1 day timeout */
3202 STOPMCAFTER = 1152921504606846975, /* equals 13,343,998,895 days */
3203 InspectExistingNodes = 1,
3204 write_xml_element_to_log(model_checking_options,[find_deadlocks/FindDeadlocks,
3205 find_invariant_violations/FindInvViolations, find_goal/FindGoal,
3206 find_assertion_violations/FindAssViolations,
3207 find_state_errors/FindStateErrors,
3208 partial_order_reduction/POR,
3209 inspect_existing_nodes/InspectExistingNodes]),
3210 (tcltk_interface:do_model_check(Nr,NodesAnalysed,STOPMCAFTER,ErrRes,
3211 FindDeadlocks,FindInvViolations,FindGoal,
3212 FindAssViolations,FindStateErrors,StopAtFullCoverage,POR, InspectExistingNodes)
3213 -> (statistics(runtime,[T2,_]), statistics(walltime,[W2,_]),
3214 Time1 is T2-T1, WTime is W2-W1,
3215 (model_checker: expired_static_analysis_time(AnalysisTime) ->
3216 Time is Time1 - AnalysisTime
3217 ; Time = Time1, AnalysisTime=0),
3218 formatsilent('Model checking time: ~w ms (~w ms walltime)~n',[Time,WTime]),
3219 formatsilent('States analysed: ~w~n',[NodesAnalysed]),
3220 get_state_space_stats(_,NrTransitions,_,_),
3221 printsilent('Transitions fired: '),printsilent(NrTransitions),nls,
3222 (get_current_breadth_first_level(Level)
3223 -> formatsilent('Breadth-first levels: ~w~n',[Level]) % is this the equivalent of TLC's diameter?
3224 ; true),
3225 write_xml_element_to_log(model_checking_statistics,
3226 [result/ErrRes,runtime/Time,walltime/WTime,
3227 states/NodesAnalysed,transitions/NrTransitions,staticAnalysisTime/AnalysisTime]),
3228 (ErrRes = no
3229 -> print('No counter example Found, not all states visited'),nl,
3230 add_warning(model_check_incomplete,'Not all states examined due to limit set by user: ',Nr)
3231 ; ErrRes=all
3232 -> (tcltk_find_max_reached_node
3233 -> (not_interesting(_)
3234 -> print('No counter example found. However, not all transitions were computed (and some states not satisfying SCOPE predicate were ignored) !')
3235 ; print('No counter example found. However, not all transitions were computed !')
3236 )
3237 ; not_interesting(_)
3238 -> print_green('No counter example found. ALL states (satisfying SCOPE predicate) visited.')
3239 % b_get_machine_searchscope(Scope)
3240 ; print_green('No counter example found. ALL states visited.')
3241 ),nl,
3242 add_model_checking_warnings(FindInvViolations,FindDeadlocks,FindGoal,FindAssViolations)
3243 ; % ErrRes is not no or all
3244 print_red('*** COUNTER EXAMPLE FOUND ***'),nl,
3245 debug_println(20,ErrRes),nl,
3246 tcltk_interface:translate_error_for_tclk(ErrRes,TclTkRes),
3247 print(TclTkRes),nl,
3248 print_history_as_counter_example(true),
3249 error_occurred(TclTkRes)
3250 ),nl
3251 )
3252 ; % do_model_check failed
3253 statistics(runtime,[T2,_]), Time1 is T2-T1,
3254 (model_checker: expired_static_analysis_time(AnalysisTime) -> Time is Time1 - AnalysisTime
3255 ; Time = Time1),
3256 printsilent('Model checking time: '), printsilent(Time), printsilent(' ms'),nls,
3257 print_error('*** Model checking FAILED '),nl,
3258 ErrRes=fail,
3259 definite_error_occurred
3260 ).
3261
3262 print_history_as_counter_example(CheckInv) :-
3263 (option(silent) -> true
3264 ; option(no_counter_examples) -> true % -nocounter
3265 ; cli_print_history,
3266 (silent_mode(off), CheckInv=true,
3267 current_state_id(ID),invariant_violated(ID)
3268 -> b_interpreter:analyse_invariant_for_state(ID)
3269 ; true)
3270 ).
3271
3272 cli_print_history :-
3273 tcltk_interface:tcltk_get_history(list(Hist)),
3274 length(Hist,Len),
3275 format('*** TRACE (length=~w):~n',[Len]),
3276 reverse(Hist,Trace),
3277 print_nr_list(Trace).
3278
3279 % perform all cbc checks on current machine
3280 cbc_check(_NOW) :-
3281 option(cbc_deadlock_check(DeadlockGoalPred)),
3282 cbc_deadlock_check(DeadlockGoalPred),
3283 fail.
3284 cbc_check(_NOW) :-
3285 option(constraint_based_check(OpName)),
3286 constraint_based_check(OpName),
3287 fail.
3288 cbc_check(_NOW) :- option(cbc_assertions(AllowEnumWarning,Options)),
3289 cbc_assertions(AllowEnumWarning,Options),
3290 fail.
3291 %cbc_check(NOW) :-
3292 % option(cbc_pred(TargetPredString)),
3293 % check_loaded(cbc_pred),
3294 % print('% Starting Constraint-Based Check for Predicate: '), print(TargetPredString),nl,
3295 % b_set_up_valid_state_with_pred(NormalisedState,Pred) TO DO: add this feature
3296 cbc_check(_NOW) :- option(cbc_sequence(Sequence,TargetPredString,Findall)),
3297 cbc_sequence(Sequence,TargetPredString,Findall),
3298 fail.
3299 cbc_check(_NOW) :- option(cbc_refinement),
3300 cbc_refinement,
3301 fail.
3302 cbc_check(_NOW) :- option(cbc_redundant_invariants(NrExpected)),
3303 cbc_redundant_invariants(NrExpected),
3304 fail.
3305 cbc_check(_).
3306
3307 :- use_module(tcltk_interface,[tcltk_constraint_based_check/2,
3308 tcltk_constraint_based_check_with_timeout/2,
3309 tcltk_constraint_find_deadlock_state_with_goal/3,
3310 tcltk_cbc_find_trace/4,
3311 tcltk_cbc_refinement_check/2]).
3312 :- use_module(probsrc(bmachine),[b_is_operation_name/1]).
3313
3314 constraint_based_check(all) :-
3315 check_loaded_not_empty(constraint_based_check),
3316 print_repl_prompt_s('% Starting Constraint-Based Check for all Operations: '),nl,
3317 start_xml_feature(cbc_operation_check,all_operations,true,FINFO),
3318 (tcltk_constraint_based_check(list(Result),ErrorsWereFound)
3319 -> print('% Constraint-Based Check Result: '),nl,
3320 print(Result),nl,
3321 write_result_to_file(Result),
3322 (ErrorsWereFound=true
3323 -> print_red('*** CONSTRAINT-BASED CHECK FOUND ERRORS ***'),nl, error_occurred(cbc)
3324 ; (ErrorsWereFound=false -> print_green('NO ERRORS FOUND'),nl)
3325 ; print_red('*** TIMEOUT OCCURRED ***'),nl,error_occurred(cbc)
3326 )
3327 ; write_result_to_file(cbc_check_failed), Result=internal_error, ErrorsWereFound=false,
3328 add_internal_error('ConstraintBasedCheck unexpectedly failed. ',cbc_check(all)),definite_error_occurred
3329 ),nl,
3330 write_cbc_check_result(Result,ErrorsWereFound),
3331 stop_xml_feature(cbc_operation_check,FINFO).
3332 constraint_based_check(OpName) :- OpName\=all, % -cbc OpName
3333 check_loaded_not_empty(constraint_based_check),
3334 print_repl_prompt_s('% Starting Constraint-Based Check for Operation: '), print(OpName),nl,
3335 start_xml_feature(cbc_operation_check,operation,OpName,FINFO),
3336 (tcltk_constraint_based_check_with_timeout(OpName,Result)
3337 -> print('% Constraint-Based Check Result: '),nl, print(Result),nl,
3338 write_result_to_file(Result),
3339 (Result=time_out
3340 -> print_red('*** TIMEOUT OCCURRED ***'),nl, error_occurred(cbc)
3341 ; (Result=ok -> print_green('NO ERRORS FOUND'),nl)
3342 ; print_red('*** CONSTRAINT-BASED CHECK FOUND ERRORS ***'),nl,error_occurred(cbc) )
3343 ; write_result_to_file(constraint_based_check_failed), Result=internal_error,
3344 add_error(probcli,'ConstraintBasedCheck unexpectedly failed'),
3345 (b_is_operation_name(OpName) -> true
3346 ; add_error(probcli,'Unknown Operation Name: ',OpName)),
3347 definite_error_occurred
3348 ),nl,
3349 write_cbc_check_result(Result),
3350 stop_xml_feature(cbc_operation_check,FINFO).
3351
3352 write_cbc_check_result(Result) :-
3353 functor(Result,F,_), % example result: no_counterexample_exists(Ids,Prd,Other)
3354 write_xml_element_to_log(cbc_check_result,[result/F]).
3355 write_cbc_check_result(Result,ErrorsWereFound) :- functor(Result,F,_),
3356 write_xml_element_to_log(cbc_check_result,[result/F,errors_were_found/ErrorsWereFound]).
3357
3358 cbc_deadlock_check(DeadlockGoalPred) :-
3359 print_repl_prompt_s('% Starting Constraint-Based DEADLOCK check '),nl,
3360 start_xml_feature(cbc_deadlock_check,FINFO),
3361 (tcltk_constraint_find_deadlock_state_with_goal(DeadlockGoalPred,false,Res)
3362 -> write_result_to_file(Res),
3363 (Res=time_out ->
3364 print_red('*** TIME_OUT occurred ***'),nl,
3365 error_occurred(cbc_deadlock_check_time_out)
3366 ; print_red('*** DEADLOCK state found ***'),nl,
3367 error_occurred(cbc_deadlock_check),
3368 (silent_mode(on) -> true
3369 ; print('*** STATE = '),nl,
3370 current_b_expression(DBState), translate:print_bstate(DBState),nl,
3371 print('*** END DEADLOCKING STATE '),nl
3372 )
3373 )
3374 ; write_result_to_file(no_deadlock_found), Res=no_deadlock_found,
3375 print_green('No DEADLOCK state found'),nl
3376 ),
3377 write_cbc_check_result(Res),
3378 stop_xml_feature(cbc_deadlock_check,FINFO).
3379 cbc_assertions(AllowEnumWarning,Options) :-
3380 findall(OPT,option(cbc_option(OPT)),FullOptions,Options),
3381 check_loaded_not_empty(cbc_assertions),
3382 print_repl_prompt_s('% Starting Constraint-Based static ASSERTIONS check '),nl,
3383 start_xml_feature(cbc_assertion_check,allow_enumeration_warning,AllowEnumWarning,FINFO),
3384 write_prolog_term_as_xml_to_log(options(Options)),
3385 (cbc_constraint_find_static_assertion_violation(Res,FullOptions)
3386 -> process_cbc_assertion_result(Res,AllowEnumWarning)
3387 ; write_result_to_file(cbc_assertions_failed), Res=internal_error,
3388 print_red('CBC Check failed'),nl,
3389 error_occurred(cbc_assertions_failure)
3390 ),
3391 write_cbc_check_result(Res),
3392 stop_xml_feature(cbc_assertion_check,FINFO).
3393 cbc_sequence(Sequence,TargetPredString,Findall) :-
3394 check_loaded_not_empty(cbc_sequence),
3395 print_repl_prompt_s('% Starting Constraint-Based Check for Sequence: '), print_repl_prompt_s(Sequence),
3396 start_xml_feature(cbc_sequence_check,sequence,Sequence,FINFO),
3397 (TargetPredString='' -> true ; print(' with target: '), print(TargetPredString)),
3398 nl,
3399 write_xml_element_to_log(options,[target_predicate/TargetPredString]),
3400 (tcltk_cbc_find_trace(Sequence,TargetPredString,Findall,Res)
3401 -> (Res=ok -> print_green('Sequence found and executed'),nl
3402 ; Res=time_out -> error_occurred(cbc_sequence_time_out)
3403 ; Res=no_solution_found -> print_red('*** NO SOLUTION FOUND '),error_occurred(cbc_sequence_no_solution_found)
3404 ; Res=nr_cbc_sols(NrSols) -> print('*** # SOLUTIONS FOUND: '),print(NrSols),nl
3405 ; print_red('*** Unknown result: '), print(Res),nl,
3406 error_occurred(cbc_sequence)
3407 )
3408 ; print('*** Internal error: Check failed '), error_occurred(cbc_sequence), Res=internal_error
3409 ),
3410 write_cbc_check_result(Res),
3411 stop_xml_feature(cbc_sequence_check,FINFO).
3412 cbc_refinement :-
3413 check_loaded_not_empty(cbc_refinement),
3414 print_repl_prompt_s('% Starting Constraint-Based static refinement check '),nl,
3415 start_xml_feature(cbc_refinement_check,FINFO),
3416 tcltk_cbc_refinement_check(list(Result),ErrorsWereFound),
3417 print('% Constraint-Based Refinement Check Result: '),nl,print(Result),nl,
3418 (ErrorsWereFound = time_out -> print_red('*** TIME_OUT occurred ***'),nl,error_occurred(cbc_refinement_time_out) ;
3419 ErrorsWereFound = true -> print_red('*** Refinement Violation found ***'),nl,error_occurred(cbc_refinement) ;
3420 print_green('No static Refinement Violation found'),nl
3421 ),
3422 write_xml_element_to_log(cbc_check_result,[errors_were_found/ErrorsWereFound]),
3423 stop_xml_feature(cbc_refinement_check,FINFO).
3424 :- use_module(b_state_model_check,[cbc_find_redundant_invariants/2]).
3425 cbc_redundant_invariants(NrExpected) :-
3426 check_loaded_not_empty(cbc_redundant_invariants),
3427 print_repl_prompt_s('% Starting Constraint-Based invariant redundancy check'),nl,
3428 start_xml_feature(cbc_redundant_invariants,FINFO),
3429 cbc_find_redundant_invariants(Res,TimeoutOccured),
3430 length(Res,NrInvs),
3431 (Res = [] -> print_green('No redundant invariants found'),nl
3432 ; format('*** REDUNDANT INVARIANTS (~w) ***~n',[NrInvs]),
3433 prnt(1,Res), nl
3434 ),
3435 (NrExpected = NrInvs -> true
3436 ; format_with_colour_nl(user_error,[red],'*** Expected ~w redundant invariants (instead of ~w).',[NrExpected,NrInvs]),
3437 error_occurred(cbc_redundant_invariants)),
3438 write_xml_element_to_log(cbc_redundant_invariants,[redundant_invariants/NrInvs, timeout_occured/TimeoutOccured]),
3439 stop_xml_feature(cbc_redundant_invariants,FINFO).
3440
3441 prnt(_,[]).
3442 prnt(N,[H|T]) :- format(' ~w : ~w~n',[N,H]), N1 is N+1, prnt(N1,T).
3443
3444 :- use_module(solver_interface,[predicate_uses_unfixed_deferred_set/2, unfixed_typed_id_in_list/3]).
3445 process_cbc_assertion_result(time_out,_) :- !,
3446 write_result_to_file(no_counterexample_found('"TIME_OUT"')),
3447 print_red('*** TIME_OUT occurred ***'),nl,
3448 error_occurred(cbc_assertions_time_out).
3449 process_cbc_assertion_result(no_counterexample_exists(Constants,TotPredicate,OtherInfo),AllowEnumWarning) :- !,
3450 print_green('No counter-example to ASSERTION exists '),(OtherInfo=[] -> true ; print(OtherInfo)),nl,
3451 (unfixed_typed_id_in_list(TID,CType,Constants) % TO DO: look only at component
3452 -> write_deferred_set_used(AllowEnumWarning),
3453 get_texpr_id(TID,CID),pretty_type(CType,CTypeS),
3454 format('Warning: Some constants use deferred sets (e.g., ~w:~w) which have only been checked for a single cardinality!~n',[CID,CTypeS])
3455 ; predicate_uses_unfixed_deferred_set(TotPredicate,CType)
3456 -> write_deferred_set_used(AllowEnumWarning),pretty_type(CType,CTypeS),
3457 format('Warning: Some quantified variables use deferred sets (e.g., ~w) which have only been checked for a single cardinality!~n',[CTypeS]) % happens for tests 1173, 1174
3458 ; write_result_to_file(no_counterexample_exists)
3459 %,print('Computing unsat core: '),nl,unsat_cores:unsat_core(TotPredicate,Core),print('CORE: '),translate:print_bexpr(Core),nl
3460 ). % WE HAVE A PROOF
3461 process_cbc_assertion_result(no_counterexample_found,AllowEnumWarning) :- !,
3462 write_result_to_file(no_counterexample_found('"Enumeration Warning"')),
3463 print('No counter-example for ASSERTION found (*enumeration warning occured*)'),nl,
3464 (AllowEnumWarning=true -> true ; error_occurred(cbc_assertions_enumeration_warning)).
3465 process_cbc_assertion_result(counterexample_found,_) :- !,
3466 write_result_to_file(counterexample_found),
3467 print_red('*** Counter-example for ASSERTION found ***'),nl,
3468 error_occurred(cbc_assertions),
3469 (silent_mode(on) -> true
3470 ; print('*** STATE = '),nl,
3471 current_b_expression(DBState), translate:print_bstate(DBState),nl,
3472 print('*** END ASSERTION counter-example STATE '),nl
3473 ),
3474 (get_dot_file('cbc_assertions',DFile) -> generate_dot_from_assertions(DFile) ; true).
3475 process_cbc_assertion_result(Res,A) :-
3476 write_result_to_file(Res),
3477 add_internal_error('Unknown: ',process_cbc_assertion_result(Res,A)).
3478
3479
3480 write_deferred_set_used(AllowEnumWarning) :-
3481 write_result_to_file(no_counterexample_found('"Deferred Sets Used"')),
3482 (AllowEnumWarning=true -> true ; error_occurred(cbc_assertions_enumeration_warning)).
3483
3484 :- use_module(tools_io,[safe_open_file/4]).
3485 write_result_to_file(Result) :- option(cbc_result_file(FILE)),
3486 safe_open_file(FILE,write,Stream,[encoding(utf8)]),
3487 !,
3488 write(Stream,Result),
3489 close(Stream).
3490 write_result_to_file(_).
3491
3492
3493
3494 if_option_set(Option,Call) :-
3495 if_option_set(Option,Call,true).
3496 if_option_set(Option,Then,Else) :-
3497 (option(Option) -> call_for_option(Then) ; call_for_option(Else)).
3498 ifm_option_set(Option,Call) :-
3499 ifm_option_set(Option,Call,true).
3500 ifm_option_set(Option,Then,Else) :- % can perform multiple options
3501 findall(Then,option(Option),As),
3502 (As=[] -> call_for_option(Else) ; perform(As)).
3503 perform([]).
3504 perform([A|T]) :-
3505 call_for_option(A),
3506 perform(T).
3507 call_for_option(Call) :- (call(Call) -> true ; add_internal_error('probcli option call failed: ',Call)).
3508 if_option_set_loaded(Option,Action,Call) :-
3509 ( option(Option),check_loaded_not_empty(Action) ->
3510 call_for_option(Call)
3511 ; true).
3512 ifm_option_set_loaded(Option,Action,Call) :- % can perform multiple options
3513 findall(Call,(option(Option),check_loaded_not_empty(Action)),As),
3514 perform(As).
3515
3516
3517
3518 if_options_set(Option,Call) :- % allow multiple solutions for Option
3519 option(Option),call(Call),fail.
3520 if_options_set(_,_).
3521
3522 print_options :- print('CLI OPTIONS: '),nl,
3523 option(Option), print(Option), nl, fail.
3524 print_options :- nl.
3525
3526 :- use_module(cbcsrc(enabling_analysis),[infeasible_operation_cache/1]).
3527 :- use_module(cbcsrc(sap),[explore_and_generate_testcases/7,cbc_gen_test_cases_from_string/5, tcl_get_stored_test_cases/1]).
3528 :- use_module(translate,[print_bexpr/1]).
3529
3530 mcm_test_case_generation(ADepth,AMaxStates,ATarget,Output) :-
3531 arg_is_number(ADepth,MaxDepth),
3532 arg_is_number(AMaxStates,MaxStates),
3533 bmachine:b_parse_machine_predicate(ATarget,Target),!,
3534 get_comma_or_space_separated_options(mcm_cover,Events),
3535 (option(silent) -> true
3536 ; print('mcm test case generation, maximum search depth: '),print(MaxDepth),nl,
3537 print('mcm test case generation, maximum number of states: '),print(MaxStates),nl,
3538 print('mcm test case generation, target state predicate: '),print_bexpr(Target),nl,
3539 print('mcm test case generation, output file: '),print(Output),nl,
3540 print('mcm test case generation, events to cover: '),print_list(Events),nl
3541 ),
3542 explore_and_generate_testcases(Events,Target,MaxDepth,MaxStates,Output,NumTests,Uncovered),
3543 printsilent('mcm test case generation, generated test cases: '),printsilent(NumTests),nls,
3544 print_uncovered('mcm test case generation, ',Uncovered).
3545 mcm_test_case_generation(_ADepth,_AMaxStates,_ATarget,_Output) :-
3546 print_error('MCM Test Case Generation failed'),
3547 error_occurred(mcm_tests).
3548
3549 cbc_test_case_generation(ADepth,TargetString,Output) :-
3550 arg_is_number(ADepth,MaxDepth),
3551 ( option(cbc_cover_all) -> Events=all
3552 ; (get_comma_or_space_separated_options(cbc_cover,Events), Events \= []) -> true
3553 ; Events=all ),
3554 (\+ option(cbc_cover_final) -> FEvents = Events
3555 ; Events=all -> FEvents=all,
3556 add_error(cbc_cover_final,'Option cbc_cover_final not compatible with trying to cover all events')
3557 ; FEvents = final(Events),
3558 println_silent('constraint based test case generation, target events considered final')),
3559 printsilent('constraint based test case generation, maximum search depth: '),printsilent(MaxDepth),nls,
3560 printsilent('constraint based test case generation, target state predicate: '),printsilent(TargetString),nls,
3561 printsilent('constraint based test case generation, output file: '),printsilent(Output),nls,
3562 (TargetString = '#not_invariant' -> BMC=invariant_violation
3563 ; TargetString = '#deadlock' -> BMC=deadlock
3564 ; BMC = 'none'),
3565 (BMC \= 'none' ->
3566 printsilent('constraint based test case generation, performing bounded model checking'),nls
3567 ; option(silent) -> true
3568 ; print('constraint based test case generation, events to cover: '),print_list(Events),nl),
3569 cbc_gen_test_cases_from_string(FEvents,TargetString,MaxDepth,Output,Uncovered),
3570 !,
3571 format('constraint based test case generation finished~n',[]),
3572 (BMC \= 'none'
3573 -> tcl_get_stored_test_cases(list(Tests)), %print(tests(Tests)),nl,
3574 (Tests=[] -> print_green('No counterexample found'),nl
3575 ; Tests = [_|_], BMC=deadlock -> add_error(deadlock,'Deadlock found by bmc')
3576 ; Tests = [_|_] -> add_error(invariant_violation,'Invariant violation found by bmc')
3577 ; add_internal_error('Unexpected bmc result: ',Tests)
3578 )
3579 ; Uncovered=[_|_],option(strict_raise_error)
3580 -> add_error(cbc_tests,'Uncovered events: ',Uncovered)
3581 ; print_uncovered('constraint based test case generation, ',Uncovered)
3582 ).
3583 cbc_test_case_generation(_ADepth,_ATarget,_Output) :-
3584 print_error('Constraint based test case generation failed!'),
3585 error_occurred(cbc_tests).
3586
3587 print_uncovered(Msg,Uncovered) :-
3588 include(enabling_analysis:infeasible_operation_cache,Uncovered,Infeasible),
3589 (Infeasible=[]
3590 -> format('~wuncovered events: ',[Msg]),print_list(Uncovered),nl
3591 ; format('~winfeasible uncovered events: ',[Msg]),print_list(Infeasible),nl,
3592 exclude(enabling_analysis:infeasible_operation_cache,Uncovered,Feasible),
3593 format('~wuncovered events: ',[Msg]),print_list(Feasible),nl
3594 ).
3595
3596 print_list(all) :- print('** all **').
3597 print_list(list(L)) :- print_list(L). % possibly not used
3598 print_list([]) :- print('** none **').
3599 print_list([H|T]) :- length([H|T],Len), format('(~w) ',[Len]),
3600 print(H),print(' '),print_list2(T).
3601 print_list2([]).
3602 print_list2([H|T]) :- print(H),print(' '),print_list2(T).
3603
3604 get_comma_or_space_separated_options(Option,Selection) :-
3605 functor(O,Option,1),
3606 findall(E, (option(O),arg(1,O,CommaSep),
3607 split_by_seperator(CommaSep,Es),
3608 member(E,Es)),
3609 Selection).
3610
3611 split_by_seperator(NonAtomic,Res) :- \+ atomic(NonAtomic),!, Res=[NonAtomic].
3612 split_by_seperator(String,Strings) :-
3613 atom_chars(String,Chars),
3614 split_by_seperator2(Chars,Strings).
3615 split_by_seperator2(Chars,Result) :-
3616 append(AChars,[X|B],Chars),seperator(X),!,
3617 (AChars=[] -> Result=Rest ; atom_chars(A,AChars), Result=[A|Rest]),
3618 split_by_seperator2(B,Rest).
3619 split_by_seperator2(Chars,[String]) :- atom_chars(String,Chars).
3620
3621 seperator(',').
3622 seperator(' ').
3623 seperator(';').
3624
3625 ltl_check_assertions :-
3626 (option(ltl_limit(Limit)) -> true; Limit= -1), % -1 means no limit
3627 formatsilent('Model checking LTL assertions~n',[]),
3628 ltl_check_assertions(Limit,Outcome),!,
3629 ( Outcome = pass -> print_green('LTL check passed'),nl
3630 ; Outcome = fail -> print_red('*** LTL check failed'),nl,error_occurred(ltl)
3631 ; Outcome = no_tests -> print_red('*** No LTL assertions found, test failed'),nl,definite_error_occurred
3632 ; print_red('*** An error occurred in the LTL assertion test'),nl,
3633 definite_error_occurred).
3634 ltl_check_assertions :-
3635 add_internal_error('Call failed:',ltl_check_assertions),definite_error_occurred.
3636
3637 :- use_module(probltlsrc(ltl),[parse_ltlfile/2]).
3638 ltl_check_file(Filename) :-
3639 (option(ltl_limit(Limit)) -> true; Limit= -1), % -1 means no limit
3640 ajoin(['Model checking LTL assertions from file ',Filename],Msg),
3641 print_repl_prompt_s(Msg),nl,
3642 ( parse_ltlfile(Filename, Formulas)
3643 -> ltl_check_formulas(Formulas,Limit)
3644 ; print_red('An error occurred while parsing the LTL file.\n'),
3645 definite_error_occurred
3646 ).
3647
3648 :- use_module(probltlsrc(ltl),[ltl_model_check2/4]).
3649 ltl_check_formulas([],_) :-
3650 print_green('All LTL formulas checked.\n').
3651 ltl_check_formulas([formula(Name,F)|Rest],Limit) :-
3652 print('Checking formula '),print(Name),print(':\n'),
3653 ltl_model_check2(F,Limit,init,Status),
3654 ( Status == no ->
3655 print_red('Counter-example found for formula \"'),print_red(Name),
3656 print_red('\", saving trace file.\n'),
3657 ajoin(['ltlce_', Name, '.trace'], Tracefile),
3658 tcltk_save_history_as_trace_file(prolog,Tracefile),
3659 add_error(ltl_counterexample,'Counter-example was found')
3660 ; Status == ok ->
3661 ltl_check_formulas(Rest,Limit)
3662 ; Status == incomplete ->
3663 ajoin(['Model was not completly model-checked, aborted after ',Limit,' new states'],
3664 Msg),
3665 add_error(ltl,Msg)
3666 ;
3667 ajoin(['Model checker returns unexpected result (',Status,')'],Msg),
3668 add_error(ltl,Msg)).
3669
3670 % Mode = init or specific_node(ID) or starthere
3671 cli_ltl_model_check(Formula,Mode,ExpectedStatus,Status) :-
3672 (option(ltl_limit(Max)) -> true; Max = -1), % -1 means no limit
3673 start_xml_feature(ltl_model_check,formula,Formula,FINFO),
3674 ltl_model_check(Formula,Max,Mode,Status),
3675 write_xml_element_to_log(model_check_result,[status/Status,expected_status/ExpectedStatus,(mode)/Mode]),
3676 check_status(Status,ExpectedStatus,Formula,ltl),
3677 stop_xml_feature(ltl_model_check,FINFO).
3678
3679 % Mode = init or specific_node(ID) or starthere
3680 cli_ctl_model_check(Formula,Mode,ExpectedStatus,Status) :-
3681 (option(ltl_limit(Max)) -> true; Max = -1), % -1 means no limit
3682 start_xml_feature(ctl_model_check,formula,Formula,FINFO),
3683 ctl_model_check(Formula,Max,Mode,Status),
3684 write_xml_element_to_log(model_check_result,[status/Status,expected_status/ExpectedStatus,(mode)/Mode]),
3685 check_status(Status,ExpectedStatus,Formula,ctl),
3686 stop_xml_feature(ctl_model_check,FINFO).
3687
3688 :- use_module(extension('markov/dtmc_model_checking.pl')).
3689 cli_pctl_model_check(Formula,Mode,ExpectedStatus,Status) :-
3690 % use_module(extension('markov/dtmc_model_checking.pl')),
3691 (option(ltl_limit(Max)) -> true; Max = -1), % -1 means no limit
3692 dtmc_model_checking:pctl_model_check(Formula,Max,Mode,Status),
3693 check_status(Status,ExpectedStatus,Formula,pctl).
3694
3695 check_expected(St,Exp,Mode) :-
3696 (St=Exp -> true
3697 ; ajoin(['Unexpected ',Mode,' model checking result ',St,', expected: '],Msg),
3698 add_error(Mode,Msg,Exp)).
3699
3700 check_status(ok,Expected,Formula,ltl) :- !, % TO DO: make uniform ? CTL returns true; LTL returns ok
3701 format_with_colour_nl(user_output,[green],'LTL Formula TRUE.~nNo counter example found for ~w.',[Formula]),
3702 flush_output(user_output),
3703 check_expected(true,Expected,ltl).
3704 check_status(true,Expected,Formula,ctl) :- !,
3705 format_with_colour_nl(user_output,[green],'CTL Formula TRUE.~nNo counter example found for ~w.',[Formula]),
3706 flush_output(user_output),
3707 check_expected(true,Expected,ctl).
3708 check_status(true,Expected,Formula,pctl) :- !,
3709 format_with_colour_nl(user_output,[green],'PCTL Formula TRUE: ~w~n',[Formula]),
3710 flush_output(user_output),
3711 check_expected(true,Expected,pctl).
3712 check_status(solution(Bindings),Expected,Formula,pctl) :- !,
3713 format_with_colour_nl(user_output,[green],'PCTL Formula TRUE: ~w',[Formula]),
3714 format_with_colour_nl(user_output,[green],'PCTL Solutions: ~w~n',[Bindings]),
3715 flush_output(user_output),
3716 check_expected(true,Expected,pctl).
3717 check_status(incomplete,Expected,Formula,LTLorCTL) :- !,
3718 incomplete_warning(LTLorCTL,Warning),
3719 add_warning(Warning, 'Warning: Model Check incomplete for: ', Formula),nl,
3720 format('No counter example found so far for ~w.~n',[Formula]),
3721 check_expected(incomplete,Expected,LTLorCTL).
3722 check_status(NO,Expected,Formula,LTLorCTL) :- (NO=no ; NO=false),!, % TO DO: make uniform
3723 (Expected==false
3724 -> format_with_colour_nl(user_error,[red],'Model Check Counterexample found for: ~w',[Formula])
3725 ; add_error(LTLorCTL, 'Model Check Counterexample found for: ', Formula)
3726 ),
3727 cli_print_history,
3728 print('Formula '), print('FALSE.'),nl,
3729 debug_format(19,'Use -his FILE -his_option show_states to display states of counterexample~n',[]),
3730 nl,
3731 check_expected(false,Expected,LTLorCTL).
3732 check_status(Status,Expected,Formula,LTLorCTL) :-
3733 add_internal_error('Unknown status: ', check_status(Status,Expected,Formula,LTLorCTL)).
3734
3735 incomplete_warning(ltl,ltl_incomplete) :- !.
3736 incomplete_warning(ctl,ctl_incomplete) :- !.
3737 incomplete_warning(X,X).
3738
3739 :- if(environ(prob_release,true)).
3740
3741 run_benchmark(_, _, _) :-
3742 add_message(probcli, 'Command-line argument for benchmarking is not available in release mode.').
3743
3744 :- else.
3745
3746 :- use_module('../tests/smt_solver_benchmarks/alloy2b_benchmarks').
3747 :- use_module('../tests/smt_solver_benchmarks/smt_solver_benchmarks').
3748 run_benchmark(alloy, CmdName, AlloyFilePath) :-
3749 alloy2b_benchmarks:benchmark_alloy_command(CmdName, AlloyFilePath).
3750 run_benchmark(smt, bmc, Path) :-
3751 smt_solver_benchmarks:run_additional_bmc_benchmarks(false, [Path]), halt.
3752 run_benchmark(smt, cbc_deadlock, Path) :-
3753 smt_solver_benchmarks:run_additional_deadlock_benchmarks(false, [Path]), halt.
3754 run_benchmark(smt, cbc_inv, Path) :-
3755 smt_solver_benchmarks:run_additional_inductive_inv_benchmarks(false, [Path]), halt.
3756
3757 :- endif.
3758
3759 evaluate_from_commandline :-
3760 retractall(eval_result(_,_)),
3761 option(eval_string_or_file(A,B,Q,E,Rchk)), %print(eval(A,B,Q,E)),nl,
3762 % treat eval_string and eval_file together to ensure proper order of evaluation
3763 % (only possible side-effect at the moment: formula can add new machine_string facts)
3764 eval_string_or_file(A,B,Q,E,Rchk),
3765 fail.
3766 evaluate_from_commandline :- print_eval_results,
3767 % treat -repl option or -replay File option
3768 (option(eval_repl([File1|TF]))
3769 -> (repl_evaluate_expressions([File1|TF]) -> true ; true)
3770 ; start_repl_if_required).
3771 start_repl_if_required :-
3772 (option(eval_repl([]))
3773 -> (repl_evaluate_expressions([]) -> true ; true)
3774 ; true).
3775
3776 :- dynamic eval_result/2.
3777 add_eval_result(R) :- retract(eval_result(R,N)),!,
3778 N1 is N+1, assertz(eval_result(R,N1)).
3779 add_eval_result(R) :- assertz(eval_result(R,1)).
3780 print_eval_results :- findall(R/N, eval_result(R,N), L), sort(L,SL),
3781 (SL=[] -> true ; format('Evaluation results: ~w~n',[SL])).
3782
3783 :- use_module(tools_printing,[print_error/1, format_error_with_nl/2]).
3784 %eval_string_or_file(string,_String,_,'FALSE',_Recheck) :- !. % comment in to skip evalf
3785 eval_string_or_file(string,String,_,Expected,Recheck) :-
3786 set_current_probcli_command(eval_string(String)),
3787 (option(silent),nonvar(Expected) -> true
3788 ; nonvar(Expected) -> format('eval(~w): ~w~n',[Expected,String])
3789 ; format('eval: ~w~n',[String])
3790 ),
3791 reset_error_spans, % avoid underlining previous errors in eval_string
3792 (eval_string_with_time_out(String,StringResult,EnumWarning,_LS) -> true
3793 ; print_error('Eval string failed: '), print_error(String),
3794 error_occurred(eval_string)
3795 ),
3796 add_eval_result(StringResult),
3797 eval_check_result(StringResult,Expected,EnumWarning,eval_string,String),
3798 (Recheck=recheck(Mode) -> recheck_pp_of_last_expression(Mode,_,_) ; true),
3799 unset_current_probcli_command.
3800 eval_string_or_file(file(bench),File,Quantifier,Expected,Recheck) :- !,
3801 ( member(Solver,[prob,kodkod,sat,'sat-z3','z3', 'cdclt',clingo]),
3802 (eval_string_or_file(file(Solver),File,Quantifier,Expected,Recheck) -> fail)
3803 ; true).
3804 eval_string_or_file(file(Solver),File,Quantifier,Expected,_) :-
3805 % evaluate a single formula stored in a file
3806 set_current_probcli_command(eval_file(Solver,File)),
3807 turn_show_error_source_off, % reduce clutter in user feedback; eval_file used in ProB Logic Calculator for example
3808 formatsilent('~nEvaluating file: ~w~n',[File]),
3809 error_manager:reset_error_scopes, % TO DO: avoid that exceptions mess up error scopes in eval_string/file
3810 statistics(runtime,[Start,_]),
3811 statistics(walltime,[W1,_]),
3812 (Expected=='TRUE' -> TypeInfo=predicate(_) % avoids parsing as expression
3813 ; true),
3814 (eval_file(Solver,File,Quantifier,Result,EnumWarning,TypeInfo)
3815 -> statistics(walltime,[W2,_]), WT is W2-W1,
3816 translate_solver_result(Result,Infos),
3817 accumulate_file_infos(File,Solver,[walltime-WT|Infos]),
3818 add_eval_result(Result),
3819 eval_check_result(Result,Expected,EnumWarning,eval_file,File)
3820 ; statistics(walltime,[W2,_]), WT is W2-W1,
3821 accumulate_file_infos(File,Solver,[failure-1,false-0,true-0,unknown-1,walltime-WT]),
3822 add_eval_result(eval_file_failed),
3823 print_error('Eval from file failed: '), print_error(File),
3824 error_occurred(eval_file)
3825 ),
3826 statistics(runtime,[Stop,_]), Time is Stop - Start,
3827 debug_format(19,'Time for ~w : ~w ms (~w ms walltime)~n',[File,Time,WT]),
3828 turn_show_error_source_on,
3829 unset_current_probcli_command.
3830
3831 translate_solver_result('TRUE',I) :- !, I=[false-0,true-1,unknown-0].
3832 translate_solver_result('FALSE',I) :- !, I=[false-1,true-0,unknown-0].
3833 translate_solver_result('UNKNOWN',I) :- !,I=[false-0,true-0,unknown-1].
3834 translate_solver_result('**** TIME-OUT ****',I) :- !,I=[false-0,true-0,unknown-1].
3835 translate_solver_result(_,[false-0,true-0,unknown-1]). % we could record this as error
3836
3837 eval_check_result(StringResult,Expected,_,Origin,File) :- Expected\=StringResult,!,
3838 format_error_with_nl('! Evaluation error, expected result to be: ~w (but was ~w) in ~w',[Expected,StringResult,File]),
3839 error_occurred(Origin).
3840 eval_check_result('NOT-WELL-DEFINED',Expected,_,Origin,File) :- var(Expected),!,
3841 format_error_with_nl('! Evaluation NOT-WELL-DEFINED in ~w',[File]),
3842 error_occurred(Origin).
3843 eval_check_result(_,_,EnumWarning,_,_) :- eval_gen_enum_warning(EnumWarning).
3844
3845 eval_gen_enum_warning(false) :- !.
3846 eval_gen_enum_warning(time_out) :- !,error_occurred(eval_string_time_out).
3847 eval_gen_enum_warning(_) :- print_error('Enumeration warning occurred'),
3848 error_occurred(eval_string_enum_warning,warning).
3849 %repl :- repl_evaluate_expressions([]).
3850 :- use_module(parsercall,[ensure_console_parser_launched/0]).
3851 repl_evaluate_expressions(StartFiles) :-
3852 get_errors, % first clear any errors from earlier commands
3853 nl,
3854 print('ProB Interactive Expression and Predicate Evaluator '), nl,
3855 print('Type ":help" for more information.'),nl,
3856 turn_show_error_source_off, % reduce clutter in user feedback
3857 (option(evaldot(File))
3858 -> print('Solutions written to dot file: '), print(File),nl
3859 ; true
3860 ),
3861 (ensure_console_parser_launched
3862 -> maplist(prob_cli:set_repl_input_file(verbose),StartFiles),
3863 top_level_eval
3864 ; print('>>> ABORTING REPL'),nl),
3865 turn_show_error_source_on.
3866
3867 :- use_module(user_interrupts,[interruptable_call/1]).
3868 top_level_eval :-
3869 catch(top_level_eval1, halt(0), (format('~s', ["Bye."]), nl)).
3870
3871 :- use_module(tools_printing,[reset_terminal_colour/1, print_red/1, print_green/1]).
3872 print_repl_prompt :- reset_terminal_colour(user_output), write('>>> ').
3873 print_repl_prompt_s(_) :- option(silent),!.
3874 print_repl_prompt_s(P) :- print_repl_prompt(P).
3875 print_repl_prompt(P) :- reset_terminal_colour(user_output), write(P).
3876 %print_repl_prompt(P) :- tools_printing:start_terminal_colour(dark_gray,user_output), write(P), reset_terminal_colour(user_output).
3877
3878 top_level_eval1 :-
3879 (interruptable_call(eval1) -> true
3880 ; print_red('Evaluation failed or interrupted'),nl,
3881 print_repl_prompt('Use :q to quit REPL'),nl),
3882 reset_errors,
3883 top_level_eval1.
3884 eval0 :- store_last_error_location_for_repl,
3885 reset_errors, % get_errors prints errors again and quits in -strict mode
3886 % However, reset_errors means that in subsequent REPL runs errors are not printed again!!
3887 garbage_collect, eval1.
3888 eval1 :- repl_multi_read_line(Expr), eval_probcli_repl_line(Expr).
3889
3890 :- dynamic last_repl_error/2.
3891 store_last_error_location_for_repl :-
3892 retractall(last_repl_error(_,_)),
3893 check_error_span_file_linecol(_,File,Line,_,_,_),!,
3894 assertz(last_repl_error(File,Line)).
3895 store_last_error_location_for_repl.
3896
3897 :- dynamic current_repl_input_stream/2.
3898 close_repl_input_stream(file_closed) :- retract(current_repl_input_stream(X,File)),!,
3899 format(":replayed ~w~n",[File]),
3900 close(X).
3901 close_repl_input_stream(no_file).
3902 :- use_module(tools_io,[safe_open_file/4]).
3903 set_repl_input_file(_,File) :- current_repl_input_stream(_,File),!,
3904 add_error(set_repl_input_file,'Cyclic file replay: ',File).
3905 set_repl_input_file(Verbose,File) :-
3906 % close_repl_input_stream, % this way we allow one REPL file to call another
3907 safe_open_file(File,read,Stream,[encoding(utf8)]),!,
3908 (Verbose=verbose -> format('Replaying REPL commands in file: ~w~n',[File]) ; true),
3909 asserta(current_repl_input_stream(Stream,File)).
3910 set_repl_input_file(_,_).
3911
3912 repl_multi_read_line(Line) :-
3913 (current_repl_input_stream(Stream,_)
3914 -> repl_multi_read_line(Stream,Line),
3915 format(user_output,'~s~n',[Line])
3916 ; repl_multi_read_line(user_input,Line)
3917 ).
3918 repl_multi_read_line(Stream,Line) :- repl_multi_read_line_aux(Stream,'>>> ',[],Line).
3919 repl_multi_read_line_aux(Stream,Prompt,SoFar,Line) :-
3920 prompt(OldPrompt,Prompt),
3921 call_cleanup(read_line(Stream,L), prompt(_,OldPrompt)),
3922 (L=end_of_file -> close_repl_input_stream(FileC),
3923 (SoFar=[], FileC = file_closed
3924 -> repl_multi_read_line(Line) % last line of file empty; do not process
3925 ; FileC = file_closed -> Line=SoFar
3926 ; Line=end_of_file) % user pressed CTRL-D
3927 ; append(LFront,[92],L) % line ends with slash \
3928 -> append(LFront,[10],LFront2), % insert newline instead;
3929 % note cleanup_newlines in parsercall transforms this into 8232 \x2028 Unicode
3930 append(SoFar,LFront2,NewSoFar),
3931 repl_multi_read_line_aux(Stream,'... ',NewSoFar,Line)
3932 ; append(SoFar,L,Line)).
3933
3934 :- use_module(eval_strings).
3935 :- dynamic trace_eval/0.
3936
3937 generate_atom_list([],[],R) :- !, R=[].
3938 generate_atom_list([],Last,[NewAtom]) :-
3939 reverse(Last,RL),
3940 atom_codes(NewAtom,RL).
3941 generate_atom_list([39|X],[],[QuotedAtom|T]) :- !,
3942 get_quoted_atom(X,[],QuotedAtom,Rest),
3943 strip_leading_ws(Rest,X2),
3944 generate_atom_list(X2,[],T).
3945 generate_atom_list([32|X],Last,[NewAtom|T]) :- !,
3946 reverse(Last,RL),
3947 atom_codes(NewAtom,RL),
3948 strip_leading_ws(X,X2),
3949 generate_atom_list(X2,[],T).
3950 generate_atom_list([H|X],Last,Res) :- generate_atom_list(X,[H|Last],Res).
3951
3952 get_quoted_atom([],Acc,QuotedAtom,[]) :- reverse(Acc,R), atom_codes(QuotedAtom,R).
3953 get_quoted_atom([39|T],Acc,QuotedAtom,T) :- !, reverse(Acc,R), atom_codes(QuotedAtom,R).
3954 get_quoted_atom([H|T],Acc,QuotedAtom,Rest) :- get_quoted_atom(T,[H|Acc],QuotedAtom,Rest).
3955
3956
3957 strip_leading_ws([32|X],R) :- !, strip_leading_ws(X,R).
3958 strip_leading_ws(X,X).
3959
3960 :- meta_predicate call_probcli_option(0).
3961 call_probcli_option(_:Option) :- just_assert_option(Option), !,
3962 (option(Option) -> true ; assert_option(Option)).
3963 call_probcli_option(_:statistics) :- !, % avoid calling SICS version
3964 cli_print_statistics(full).
3965 call_probcli_option(Option) :-
3966 catch(call(Option), error(existence_error(A,B),E), (
3967 treat_existence_error(A,B,E,Option),
3968 nl % ensure that next prompt is printed
3969 )).
3970
3971 % commands that require no execution; just asserting option(.)
3972 just_assert_option(depth_first).
3973 just_assert_option(breadth_first).
3974 just_assert_option(strict_raise_error).
3975 just_assert_option(no_deadlocks).
3976 just_assert_option(no_invariant_violations).
3977 just_assert_option(no_goal).
3978 just_assert_option(no_ltl).
3979 just_assert_option(no_assertion_violations).
3980 just_assert_option(no_state_errors).
3981 just_assert_option(no_counter_examples).
3982
3983 treat_existence_error(source_sink,File,E,Option) :- !,
3984 format_with_colour_nl(user_error,[red],
3985 '* Could not find file ~w~n* for probcli command ~w~n* Detailed error: ~w',[File,Option,E]).
3986 treat_existence_error(_,_,E,Option) :-
3987 format_with_colour_nl(user_error,[red],
3988 '* probcli command not yet supported in REPL: ~w~n* Error: ~w',[Option,E]).
3989
3990 reload_mainfile :-
3991 file_loaded(_,MainFile),
3992 reset_errors,
3993 print_repl_prompt_s('Reloading and initialising file: '), print_repl_prompt_s(MainFile),nl,
3994 clear_loaded_files,
3995 load_main_file(MainFile,0,_),
3996 get_errors,
3997 cli_start_animation(0),
3998 cli_start_initialisation(0).
3999
4000 % REPL EVAL LOOP:
4001 eval_probcli_repl_line(end_of_file) :- !, eval_line(end_of_file).
4002 eval_probcli_repl_line(Line) :- strip_ws(Line,SLine),
4003 catch(eval_line(SLine), E, (
4004 E=halt(_) -> throw(E) % e.g., coming from :quit; will be caught above
4005 ; E='$aborted' -> throw(E) % thrown by SWI-Prolog on abort by user
4006 ; add_error(repl,'Uncaught Exception in REPL: ',E),
4007 nl % ensure that next prompt is printed
4008 )).
4009
4010 % strip whitespace at end and beginning
4011 strip_ws([H|T],Res) :- is_ws(H),!, strip_ws(T,Res).
4012 strip_ws(C,Res) :- reverse(C,CR), strip_ws2(CR,SCR), reverse(SCR,Res).
4013 strip_ws2([H|T],Res) :- is_ws(H),!, strip_ws2(T,Res).
4014 strip_ws2(R,R).
4015
4016 is_ws(32).
4017
4018 :- use_module(performance_messages,[toggle_perfmessages/0]).
4019 eval_line([]) :- !, print_repl_prompt('Type :q or :quit to quit.'),nl,eval0.
4020 eval_line(end_of_file) :- !, halt_exception(0).
4021 % Haskell GHCI like syntax
4022 eval_line(":r") :- !, eval_line("--reload").
4023 eval_line(":reload") :- !, eval_line("--reload").
4024 eval_line("--reload") :- !,
4025 (reload_mainfile -> true ; get_errors,print_repl_prompt('Error(s) occured during reload (use :e to jump to first error)'),nl),
4026 eval0.
4027 % TO DO: other Haskell commands :info E :l FILE , let pattern = expression
4028 eval_line(":prefs") :- !,print_eclipse_prefs, eval0.
4029 eval_line([45|Command]) :- % -command
4030 generate_atom_list([45|Command],[],ArgV),
4031 %print(argv(ArgV)),nl,
4032 % try and parse like commands passed to probcli
4033 get_options(ArgV,recognised_cli_option,Options,[],fail),
4034 print_repl_prompt('Executing probcli command: '),print_repl_prompt(Options),nl,!,
4035 (maplist(prob_cli:call_probcli_option,Options) -> true
4036 ; print_red('Failed to execute probcli arguments'),nl),
4037 eval0.
4038 eval_line("+") :- !, add_last_expression_to_unit_tests, eval0.
4039 eval_line("$+") :- !, preferences:temporary_set_preference(expand_avl_upto,-1,CHNG),
4040 print_last_value,preferences:reset_temporary_preference(expand_avl_upto,CHNG),
4041 eval0.
4042 %eval_line("$$") :- !, print_last_expression, eval0. % now in eval_strings
4043 eval_line("$$$") :- !, % $$0 - $$9 commands to print last expression with indentation
4044 indent_print_last_expression, eval0.
4045 %eval_line("$") :- !, print_last_info, eval0. % now in eval_strings
4046 eval_line("!trace") :- !, eval_line("^").
4047 eval_line("^") :- !,
4048 (retract(trace_eval) -> print_repl_prompt('TRACING OFF'),nl
4049 ; assertz(trace_eval), print_repl_prompt('TRACING ON'),nl), eval0.
4050 eval_line("!observe") :- !, toggle_observe_evaluation.
4051 eval_line("!v") :- !, tcltk_turn_debugging_off.
4052 eval_line("!p") :- !, toggle_perfmessages.
4053 eval_line("!perf") :- !, toggle_perfmessages.
4054 eval_line("!profile") :- !, eval_line("%").
4055 eval_line("!print_profile") :- !, eval_line("%%").
4056 eval_line("%") :- !, print_repl_prompt('PROFILING : '), %spy([avl:avl_size/2]),
4057 (current_prolog_flag(profiling,on)
4058 -> set_prolog_flag(profiling,off), print('OFF') ;
4059 set_prolog_flag(profiling,on), print('ON')),
4060 nl,print_repl_prompt('USE %% to print profile info'),nl,eval0.
4061 eval_line("%%") :- !, nl,print_repl_prompt('PROLOG PROFILE INFORMATION:'), nl,
4062 catch(print_profile,
4063 error(existence_error(_,_),_),
4064 print_red('CAN ONLY BE USED WHEN RUNNING PROB FROM SOURCE')),
4065 nl,
4066 debug:timer_statistics,
4067 eval0.
4068 eval_line("!print_coverage") :- !, nl,print_repl_prompt('PROLOG COVERAGE INFORMATION:'), nl,
4069 (current_prolog_flag(source_info,on) -> true ; print_red('Only useful when current_prolog_flag(source_info,on)!'),nl),
4070 catch(print_coverage,
4071 error(existence_error(_,_),_),
4072 print_red('CAN ONLY BE USED WHEN RUNNING PROB FROM SOURCE')),
4073 nl,
4074 eval0.
4075 eval_line("!profile_reset") :- !, nl,print_repl_prompt('RESETTING PROLOG PROFILE INFORMATION'), nl,
4076 catch(profile_reset,
4077 error(existence_error(_,_),_),
4078 print_red('CAN ONLY BE USED WHEN RUNNING PROB FROM SOURCE')),
4079 eval0.
4080 eval_line("%%%") :- !, nl,print('PROFILE INFORMATION (Starting TK Viewer):'), nl,
4081 catch(
4082 (use_module(library(gauge)), gauge:view),
4083 error(existence_error(_,_),_),
4084 print_red('CAN ONLY BE USED WHEN RUNNING PROB FROM SOURCE')),
4085 nl,
4086 eval0.
4087 eval_line("!debug") :- !,
4088 print_repl_prompt('ENTERING PROLOG DEBUG MODE:'),
4089 catch(
4090 debug,
4091 error(existence_error(_,_),_),
4092 print_red('CAN ONLY BE USED WHEN RUNNING PROB FROM SOURCE')),
4093 nl,
4094 eval0.
4095 eval_line("@") :- !, get_preference(find_abort_values,OldVal),
4096 print_repl_prompt('Try more aggressively to detect ill-defined expressions: '),
4097 (OldVal=true -> Val=false ; Val=true), print(Val),nl,
4098 temporary_set_preference(find_abort_values,Val) , eval0.
4099 eval_line("!") :- !, toggle_eval_det,eval0.
4100 eval_line("!norm") :- !, toggle_normalising,eval0.
4101 eval_line(Codes) :- parse_eval_command(Codes,CommandName,Argument),!,
4102 debug_println(9,executing_eval_command(CommandName,Argument)),
4103 (exec_eval_command(CommandName,Argument) -> eval0
4104 ; format_with_colour_nl(user_error,[red,bold],'Command ~w failed',[CommandName]),
4105 eval0).
4106 eval_line(ExpressionOrPredicate) :- (trace_eval -> trace ; true),
4107 (eval_codes(ExpressionOrPredicate,exists,_,_,_,_)
4108 -> eval0
4109 ; print_red('Evaluation failed'),nl,eval0).
4110
4111 parse_eval_command([C|Rest],CommandName,Argument) :- [C]=":",
4112 eval_command(Cmd,CommandName),
4113 append(Cmd,RestArg,Rest),
4114 (RestArg = [Letter1|_] -> is_ws(Letter1) /* otherwise command name continues */ ; true),
4115 strip_ws(RestArg,Argument),
4116 (eval_command_help(CommandName,[],_), Argument = [_|_]
4117 -> format_with_colour_nl(user_error,[red],'WARNING: Command ~w does not take arguments!',[CommandName])
4118 ; eval_command_help(CommandName,[_|_],_), Argument = []
4119 -> format_with_colour_nl(user_error,[red],'WARNING: Command ~w requires arguments!',[CommandName])
4120 ; true).
4121
4122 % TO DO: some of these commands should also be made available in the Tcl/Tk Console
4123 eval_command("q",quit).
4124 eval_command("quit",quit).
4125 eval_command("halt",quit).
4126 eval_command("x",exit).
4127 eval_command("exit",exit).
4128 eval_command("f",find).
4129 eval_command("find",find).
4130 eval_command("*",apropos).
4131 eval_command("apropos",apropos).
4132 eval_command("help",help).
4133 eval_command("h",help).
4134 eval_command("?",help).
4135 eval_command("ctl",ctl(init)). % :ctl
4136 eval_command("ctlh",ctl(starthere)). % :ctlh
4137 eval_command("ltl",ltl(init)). % :ltl
4138 eval_command("ltlh",ltl(starthere)). % :ltlh
4139 eval_command("pctl",pctl(init)). % :pctl
4140 eval_command("pctlh",pctl(starthere)). % :pctlh
4141 eval_command("reset",reset_animator(hard)). % :reset
4142 eval_command("reset-history",reset_animator(history_only)). % :reset
4143 eval_command("statistics",statistics).
4144 eval_command("stats",statistics). % :stats
4145 eval_command("states",state_space_stats). % :states
4146 eval_command("state",show_state_info(2000)). % :state
4147 eval_command("statespace",state_space_display). % :statespace
4148 eval_command("u",unsat_core).
4149 %eval_command("core",unsat_core).
4150 eval_command("show",show_last_as_table). % :show
4151 eval_command("dot",show_last_as_dot(no_dot_viewing)). % :dot
4152 eval_command("dotty",show_last_as_dot(dotty)).
4153 eval_command("dotpdf",show_last_as_dot(dot)).
4154 eval_command("sfdp",show_last_as_dot(sfdp)).
4155 eval_command("browse",browse). % :browse
4156 eval_command("abstract_constants",check_abstract_constants). % :abstract_constants
4157 eval_command("det_check_constants",det_check_constants). % :det_check_constants
4158 eval_command("b",browse).
4159 eval_command("hbrowse",hbrowse). % :hbrowse browse hiearchy
4160 eval_command("hshow",hshow). % show inclusion hieararchy
4161 eval_command("comp",show_components). % :comp
4162 eval_command("replay",replay_repl_file). % :replay
4163 eval_command("trim",trimcore). % :trim
4164 eval_command("src",show_source). %:src
4165 eval_command("source",show_source). %:source
4166 eval_command("origin",show_origin). %:origin
4167 eval_command("edit",edit_main_file).
4168 eval_command("e",edit_main_file). % :e
4169 eval_command("comment",comment).
4170 eval_command("machine",show_machine_info(statistics)). %:machine
4171 eval_command("machine-stats",show_machine_info(statistics)). %:machine
4172 eval_command("files",show_machine_info(files)). %:files
4173 eval_command("syntax",syntax_help). % :syntax
4174 eval_command("open",open_file). % :open
4175
4176 available_commands(SLC) :-
4177 findall(Cmd,(eval_command(Cs,_),atom_codes(Cmd,[58|Cs])), LC),
4178 sort(LC,SLC).
4179
4180 eval_command_help(exit,[],'Exit ProB').
4181 eval_command_help(find,['P'],'Find state in state-space which makes LTL atomic proposition P true; LTL Propositions: {B-Pred}, e(Op), [Op], true, false, sink').
4182 eval_command_help(ltl(starthere),['F'],'Check LTL formula F starting from current state').
4183 eval_command_help(ltl,['F'],'Check LTL formula F; LTL Operators: G,F,X,U,W,R,not,&,or,=>; LTL Propositions: {B-Pred}, e(Op), [Op], true, false, sink; Past-LTL Operators: Y,H,O,S,T (dual to X,G,F,U,R)').
4184 eval_command_help(ctl(starthere),['F'],'Check CTL formula F starting from current state').
4185 eval_command_help(ctl(_),['F'],'Check CTL formula F in all initial states; CTL Syntax: ExUy,EXx,AXx,EFx,AGx,EX[Op]x,e(Op),{B-Pred}').
4186 eval_command_help(pctl(starthere),['F'],'Check PCTL formula F starting from current state').
4187 eval_command_help(pctl(_),['F'],'Check PCTL formula F; PCTL Operators: not, &, or, =>, {B-Pred}, e(Op), [Op], true, false, sink, P op {Exp} [PathFormula] with op in {<,<=,>=,>,=}; Path operators: X, U, F, G, U<=Bound, F<=Bound, G<=Bound').
4188 eval_command_help(browse,opt('PAT'),'Browse available constants, variables, sets and lets introduced in REPL').
4189 eval_command_help(apropos,['PAT'],'Find constant or variable whose names contains PAT').
4190 eval_command_help(hbrowse,['PAT'],'Browse machine hierarchy for all identifiers whose names contains PAT').
4191 eval_command_help(hshow,[],'Show machine inclusion hierarchy using topological sorting').
4192 eval_command_help(show_components,[],'Show components of PROPERTIES').
4193 eval_command_help(abstract_constants,[],'Show ABSTRACT_CONSTANTS and check if can be fully evaluated').
4194 eval_command_help(det_check_constants,[],'Check if values of CONSTANTS are forced and explain if they are').
4195 eval_command_help(show_last_as_table,[],'Show last evaluated expression in tabular form').
4196 eval_command_help(show_last_as_dot(_),['F'],'Show expression or predicate F as dot graph').
4197 eval_command_help(unsat_core,[],'Compute Unsatisfiable Core of last evaluated predicate').
4198 eval_command_help(help,opt('CMD'),'Provide help about REPL command CMD').
4199 eval_command_help(replay_repl_file,['FILE'],'Replay FILE of REPL commands').
4200 eval_command_help(reset_animator(_),[],'Reset history and statespace of animator').
4201 eval_command_help(show_source,['ID'],'Show origin and source code definition of identifier ID').
4202 eval_command_help(show_origin,['ID'],'Show origin of identifier ID and try opening in EDITOR').
4203 eval_command_help(show_machine_info(_),[],'Show statistics about loaded machine and files').
4204 eval_command_help(state_space_stats,[],'Show statistics about state space').
4205 eval_command_help(state_space_display,[],'Show complete state space transitions (could be very big !)').
4206 eval_command_help(show_state_info(_),[],'Show current state').
4207 eval_command_help(statistics,[],'Show statistics about last evaluation').
4208 % -machine_stats : cli_print_machine_info(statistics) -machine_files : cli_print_machine_info(files)
4209 eval_command_help(trim,[],'Trim memory usage of probcli (try and give memory back to the OS)').
4210 % implemented in eval_strings:
4211 eval_command_help(type,['E'],'Show type of expression E').
4212 eval_command_help(cvc4,['P'],'Solve predicate P using CVC4 solver').
4213 eval_command_help(kodkod,['P'],'Solve predicate P using SAT solver via Kodkod').
4214 eval_command_help(z3,['P'],'Solve predicate P using Z3 solver').
4215 eval_command_help('z3-free',['P'],'Solve predicate P using Z3 solver (ignoring current state)').
4216 eval_command_help('z3-file',['F'],'Solve predicate in File F using Z3 solver').
4217 eval_command_help('z3-free-file',['F'],'Solve predicate in File F using Z3 solver (ignoring current state)').
4218 eval_command_help(cdclt,['P'],'Solve predicate P using Prolog CDCL(T) solver').
4219 eval_command_help(cdclt-free,['P'],'Solve predicate P using Prolog CDCL(T) solver (ignoring current state)').
4220 eval_command_help(prob,['P'],'Solve predicate P using ProB solver (ignoring current state)').
4221 eval_command_help('prob-file',['F'],'Solve predicate in File F using ProB solver (ignoring current state)').
4222 eval_command_help(edit_main_file,opt('ID'),'Edit main file (or origin of identifier ID) using EDITOR (path_to_text_editor preference)').
4223 eval_command_help(comment,['STRING'],'provide STRING as a comment (mainly useful for :replay files)').
4224 eval_command_help(syntax_help,[],'Show a summary of the B syntax accepted by the REPL').
4225 eval_command_help(open_file,['FILE'],'Open FILE in preferred application.').
4226
4227 print_eval_command_help(Codes) :-
4228 eval_command(Codes,Cmd),
4229 eval_command_help(Cmd,Args,Descr),
4230 (Args = []
4231 -> format('Command ~w~n Syntax :~s~n ~w~n',[Cmd,Codes,Descr])
4232 ; Args=[Arg] -> format('Command ~w~n Syntax :~s ~w~n ~w~n',[Cmd,Codes,Arg,Descr])
4233 ; Args=opt(Arg) -> format('Command ~w~n Syntax :~s [~w]~n ~w~n',[Cmd,Codes,Arg,Descr])
4234 ; format('Command ~w~n Syntax :~s ~w~n ~w~n',[Cmd,Codes,Args,Descr])).
4235
4236 :- use_module(tools_commands,[show_dot_file/1, show_pdf_file/1, gen_dot_output/4]).
4237 :- use_module(state_space,[transition/4]).
4238 :- use_module(b_machine_hierarchy,[print_machine_topological_order/0]).
4239 exec_eval_command(quit,_) :- !, halt_exception(0).
4240 exec_eval_command(exit,_) :- !,halt.
4241 exec_eval_command(browse,CodesToMatch) :- !,
4242 (CodesToMatch=[] -> browse % maybe merge with apropos functionality
4243 ; exec_eval_command(apropos,CodesToMatch)).
4244 exec_eval_command(find,FORMULA) :-
4245 atom_codes(APF,FORMULA),cli_find_ltl_ap(APF).
4246 exec_eval_command(apropos,CodesToMatch) :- /* :* Pattern (apropos command) */
4247 browse_machine(CodesToMatch).
4248 exec_eval_command(hbrowse,CodesToMatch) :- /* :* Pattern (hbrowse command) */
4249 browse_all_machines(CodesToMatch).
4250 exec_eval_command(hshow,_) :- /* show inclusion hierarhcy */
4251 print_machine_topological_order.
4252 exec_eval_command(show_components,_) :-
4253 print_property_partitions.
4254 exec_eval_command(check_abstract_constants,_) :-
4255 check_abstract_constants.
4256 exec_eval_command(det_check_constants,_) :-
4257 det_check_constants.
4258 exec_eval_command(help,Arg) :-
4259 (Arg=[] -> eval_help
4260 ; print_eval_command_help(Arg) -> true
4261 ; (Arg=[58|RA],print_eval_command_help(RA)) -> true % remove : at front
4262 ; format('Cannot provide help about ~s~n',[Arg]),
4263 available_commands(LC), format('Available commands: ~w~n',[LC])
4264 ).
4265 exec_eval_command(ctl(Mode),FORMULA) :- % :ctl or :ctlh for ctl here
4266 atom_codes(F,FORMULA),
4267 (cli_ctl_model_check(F,Mode,_,Status)
4268 -> (Status=false -> write_history_to_user_output([show_init,show_states]) ; true)
4269 ; print('CTL Syntax: ExUy,EXx,AXx,EFx,AGx,EX[Op]x,e(Op),{B-Pred}'),nl).
4270 exec_eval_command(ltl(Mode),FORMULA) :- % :ltl or :ltlh with Mode = init or starthere
4271 atom_codes(F,FORMULA),
4272 (cli_ltl_model_check(F,Mode,_,Status)
4273 -> (Status=no -> write_history_to_user_output([show_init,show_states]) ; true)
4274 ; print('LTL Operators: G,F,X,U,W,R,not,&,or,=>,<=>'),nl,
4275 print('LTL Propositions: {B-Pred}, e(Op), [Op], true, false, sink'),nl,
4276 print('Past-LTL Operators: Y,H,O,S,T (dual to X,G,F,U,R)'),nl
4277 ).
4278 exec_eval_command(pctl(Mode),FORMULA) :- % :pctl or :pctlh with Mode = init or starthere
4279 atom_codes(F,FORMULA),
4280 (cli_pctl_model_check(F,Mode,_,Status)
4281 -> (Status=no -> write_history_to_user_output([show_init,show_states]) ; true)
4282 ; print('PCTL Propositional Operators: not, &, or, =>'),nl,
4283 print('PCTL State Formula: P op {Exp} [PathFormula] with op in {<,<=,>=,>,=}'),nl,
4284 print('PCTL Path Formulas: X phi, phi1 U phi2, F phi, G phi'),nl,
4285 print('PCTL Bounded Path Formulas: phi1 U<=Bound phi2, F<=Bound phi, G<=Bound phi'),nl,
4286 print('PCTL Propositions: {B-Pred}, e(Op), [Op], true, false, sink'),nl
4287 ).
4288 exec_eval_command(reset_animator(Hard),_) :- !,
4289 get_state_space_stats(TotalNodeSum,TotalTransSum,_,_),
4290 (Hard=hard ->
4291 format('Resetting statespace (~w states, ~w transitions)~n',[TotalNodeSum,TotalTransSum]),
4292 reset_animator
4293 ; format('Resetting animation history (keeping statespace: ~w states, ~w transitions)~n',[TotalNodeSum,TotalTransSum]),
4294 tcltk_reset % only resets animation history,...
4295 ).
4296 exec_eval_command(statistics,_) :- !, print_last_info.
4297 exec_eval_command(state_space_stats,_) :- !, % :states
4298 get_state_space_stats(TotalNodeSum,TotalTransSum,Processed,Ignored),
4299 (Ignored>0
4300 -> format('Statespace: ~w states (~w processed, ~w ignored) and ~w transitions.~n',
4301 [TotalNodeSum,Processed,Ignored,TotalTransSum])
4302 ; format('Statespace: ~w states (~w processed) and ~w transitions.~n',[TotalNodeSum,Processed,TotalTransSum])).
4303 exec_eval_command(state_space_display,_) :- !, % :statespace
4304 ( visited_expression(ID,State),
4305 functor(State,F,N),
4306 format('State ID ~w (~w/~w)~n',[ID,F,N]),
4307 transition(ID,OperationTerm,_OpID,ToID),
4308 get_operation_name(OperationTerm,OpName),
4309 format(' -> ~w (~w)~n',[ToID,OpName]),
4310 fail
4311 ;
4312 current_state_id(ID),
4313 format('Current State ID ~w~n',[ID])
4314 ).
4315 exec_eval_command(show_state_info(Limit),_) :- !, % :state
4316 current_expression(ID,CurState),
4317 expand_const_and_vars_to_full_store(CurState,EState),
4318 format('Current state id ~w : ~n',[ID]), % MAX_DISPLAY_SET
4319 translate:print_bstate_limited(EState,Limit,-1),nl,
4320 (\+ not_all_transitions_added(ID),
4321 format('Outgoing transitions of state id ~w:~n',[ID]),
4322 transition(ID,OperationTerm,_OpID,ToID),
4323 get_operation_name(OperationTerm,OpName),
4324 format(' -> ~w (~w)~n',[ToID,OpName]),
4325 fail
4326 ; true).
4327 exec_eval_command(unsat_core,_) :- !, % :core :u
4328 unsat_core_last_expression.
4329 exec_eval_command(trimcore,_) :- !, % :trim
4330 prob_trimcore_verbose.
4331 exec_eval_command(show_last_as_table,_) :- !, % :show
4332 show_last_expression_as_table.
4333 exec_eval_command(syntax_help,_) :- !, % :syntax
4334 syntax_help.
4335 exec_eval_command(show_last_as_dot(Show),Arg) :- !,
4336 (Arg = [] -> print('*** :dot requires an expression or predicate as argument.'),nl
4337 ; safe_absolute_file_name('~/probcli_repl.dot',AFile),
4338 set_eval_dot_file(AFile),
4339 format('Displaying evaluation result in: ~w~n',[AFile]),
4340 (eval_codes(Arg,exists,_,_,_,_) -> true ; true), unset_eval_dot_file,
4341 ( Show=no_dot_viewing -> true
4342 ; Show=dotty -> show_dot_file(AFile)
4343 ; safe_absolute_file_name('~/probcli_repl.pdf',PDFFile),
4344 gen_dot_output(AFile,Show,pdf,PDFFile),
4345 show_pdf_file(PDFFile)
4346 )).
4347 exec_eval_command(replay_repl_file,FILEC) :- !, % :replay
4348 atom_codes(File,FILEC),
4349 set_repl_input_file(not_verbose,File).
4350 exec_eval_command(show_source,IDC) :- !, % :src
4351 trim_id_back_quotes(IDC,TIDC),atom_codes(ID,TIDC),
4352 show_source(ID).
4353 exec_eval_command(show_origin,IDC) :- !, % :origin
4354 trim_id_back_quotes(IDC,TIDC),atom_codes(ID,TIDC),
4355 show_origin(ID).
4356 exec_eval_command(show_machine_info(X),_) :- !, % :machine
4357 cli_print_machine_info(X).
4358 exec_eval_command(edit_main_file,Arg) :- !, % :e
4359 (Arg=[] -> edit_main_file
4360 ; trim_quotes(Arg,FC), atom_codes(File,FC), file_exists(File) -> edit_file(File,unknown)
4361 ; exec_eval_command(show_origin,Arg)).
4362 exec_eval_command(open_file,FILEC) :- !, % :open
4363 (FILEC=[] -> open_file('.')
4364 ; atom_codes(File,FILEC),
4365 open_file(File)
4366 ).
4367 exec_eval_command(comment,_Arg) :- !. % do nothing; argument was a comment; mainly useful for :replay files
4368
4369
4370 trim_id_back_quotes([96|T],Res) :- append(Res,[96],T),!.
4371 trim_id_back_quotes(R,R).
4372
4373 trim_quotes([34|T],Res) :- append(Res,[34],T),!. % double quotes
4374 trim_quotes([39|T],Res) :- append(Res,[39],T),!. % single quotes
4375 trim_quotes(R,R).
4376
4377 :- use_module(tools_commands,[edit_file/2, open_file/1]).
4378 edit_main_file :- last_repl_error(File,Line),
4379 \+ functor(File,unknown,_), % File \= unknown(_),
4380 !,
4381 format('Showing first error from last command~n',[]),
4382 edit_file(File,Line).
4383 % Note: for the bbedit command we can also specify line numbers bbedit +LINE FILE
4384 edit_main_file :- file_loaded(_,MainFile), \+ empty_machine_loaded,
4385 !,edit_file(MainFile,unknown).
4386 edit_main_file :- format_with_colour_nl(user_error,[red],'No file loaded, cannot open EDITOR!',[]).
4387
4388
4389
4390 :- use_module(probsrc(error_manager),[extract_file_line_col/6]).
4391 open_file_at_position(OriginTerm) :-
4392 extract_file_line_col(OriginTerm,FILE,LINE,_COL,_Erow,_Ecol),
4393 edit_file(FILE,LINE).
4394
4395
4396 :- use_module(probsrc(bmachine),[source_code_for_identifier/6]).
4397 show_source(ID) :- source_code_for_identifier(ID,Kind,_Type,OriginStr,OriginTerm,Source),!,
4398 translate:translate_subst_or_bexpr(Source,PPS),
4399 %format('~w: ~w (Type: ~w)~norigin: ~w~nsource: ~w~n',[Kind,ID,_Type,Origin,PPS]).
4400 format('~w: ~w~norigin: ~w~nsource: ~w~n',[Kind,ID,OriginStr,PPS]),
4401 (OriginTerm=b(_,_,_),get_texpr_description(OriginTerm,Description)
4402 -> format('description: ~w~n',[Description]) ; true).
4403 show_source(ID) :- format_error_with_nl('! Could not find source for ~w',[ID]).
4404
4405 show_origin('') :- last_repl_error(_,_),!, % error occured: show error in editor like :e would
4406 edit_main_file.
4407 show_origin('') :- !,format_error_with_nl('! You need to provided an identifier',[]).
4408 show_origin(ID) :- source_code_for_identifier(ID,Kind,_Type,OriginStr,OriginTerm,_Source),!,
4409 format('~w: ~w~norigin: ~w~n',[Kind,ID,OriginStr]),
4410 open_file_at_position(OriginTerm).
4411 show_origin(ID) :- format_error_with_nl('! Could not find origin for ~w',[ID]).
4412
4413 profiling_on :- set_prolog_flag(profiling,on), print('% PROFILING ON'),nl.
4414
4415 % find a state satisfying LTL atomic property
4416 cli_find_ltl_ap(APF) :-
4417 if(ltl:find_atomic_property_formula(APF,ID),
4418 (format('Found state (id = ~w) satisfying LTL atomic property.~n',[ID]),
4419 tcltk_goto_state('LTL FIND',ID)),
4420 format('No explored state satsifies LTL atomic property.~n',[])).
4421
4422 eval_help :-
4423 print('ProB Interactive Expression and Predicate Evaluator '), nl,
4424 print('Type a valid B expressions or predicates, followed by RETURN or ENTER.'),nl,
4425 print('You can spread input over multiple lines by ending lines with "\\".'),nl,
4426 browse_machine([]),
4427 print('You can also type one of the following commands: '),nl,
4428 (option_verbose ->
4429 print(' + to save last expression to ProB unit tests.'),nl,
4430 print(' ! to go to deterministic propagation only mode.'),nl,
4431 print(' $ to print evaluation time for last expression.'),nl,
4432 print(' $$ to pretty-print last expression and its type.'),nl,
4433 print(' $$$ to pretty-print last expression in nested fashion.'),nl,
4434 print(' !p to toggle performance messages.'),nl,
4435 print(' !norm to toggle normalisation of results.'),nl,
4436 print(' :col to toggle colorizing of results.'),nl
4437 ; true),
4438 print(' :let x = E to define a new local variable x'),nl, % : optional for let
4439 print(' :unlet x to un-define a local variable'),nl,
4440 print(' #file=MYFILE to evaluate the formula in MYFILE'),nl,
4441 print(' @INVARIANT to evaluate or obtain invariant predicate'),nl,
4442 print(' @PROPERTIES, @GUARD-OpName ditto for properties and guards'),nl, % @FUZZ, @RANDOMISE also exist
4443 print(' :b or :b Prefix to browse the available identifiers'),nl,
4444 print(' :t E to get the type of an expression'),nl,
4445 print(' :r to reload the machine'),nl,
4446 print(' :show to display the last result as a table (if possible)'),nl,
4447 print(' :list CAT to display information with CAT : {files,variables,help,...}'),nl,
4448 print(' :* P to display constants/variables containing pattern P'),nl,
4449 print(' :core Pred to compute the unsat core for Pred'),nl,
4450 print(' :u to compute the unsat core for last evaluated result'),nl,
4451 print(' :stats to print the type and evaluation time for last query'),nl,
4452 print(' -PROBCLIARGS to pass command-line probcli arguments to the REPL'),nl,
4453 print(' (e.g., -v to switch to verbose mode or -p PREF VAL to set a preference)'),nl,
4454 print(' :ctl F or :ltl F to check a CTL or LTL formula.'),nl,
4455 print(' :f F to find a state satisfying LTL atomic property.'),nl,
4456 print(' :find-value PAT to find a value in current state matching PAT.'),nl,
4457 print(' :exec S to execute an operation or substitution S.'),nl,
4458 print(' :replay FILE to replay a file of commands.'),nl,
4459 print(' :z3 P, :cvc4 P, :kodkod P to solve predicate P using alternate solver'),nl,
4460 print(' :forall P to prove predicate P as universally quantified with default solver'),nl,
4461 print(' :prove P to prove predicate P using ProB\'s own WD prover'),nl,
4462 (option_verbose ->
4463 print(' :krt P, :pp P, :ml P to prove predicate P using Atelier-B provers if installed'),nl
4464 ; true),
4465 print(' :print P to pretty print predicate in a nested fashion'),nl,
4466 print(' :min P, :max P to find a minimal/maximal model for predicate P or %x.(P|E)'),nl,
4467 print(' :prefs to print current value of preferences'),nl,
4468 print(' :reset to reset the state space of the animator.'),nl, % :reset-history only resets history
4469 print(' :help CMD to obtain more help about a command.'),nl,
4470 print(' :state, :statespace, :states,'),nl,
4471 print(' :machine, :files, :source, :orgin, :machine-stats,'),nl,
4472 print(' :apropos, :hbrowse, :abstract_constants, :det_check_constants,'),nl,
4473 print(' :dot, :dotty, :sfdp, :trim, :comp - use :help CMD for more info'),nl,
4474 print(' :syntax to show a summary of the B syntax accepted by the REPL'),nl,
4475 print(' :q to exit.'),nl.
4476
4477 :- use_module(tools,[read_atom_from_file/3]).
4478 :- dynamic prob_summary/1.
4479
4480 :- read_atom_from_file(tclsrc('prob_summary.txt'),utf8,T), assertz(prob_summary(T)).
4481 % TODO: we could just include a shorter version with predicates and expressions
4482 % TODO: provide :syntax LTL or :syntax CTL help commands
4483 syntax_help :- prob_summary(S),
4484 format(user_output,'~w',S).
4485
4486
4487 browse :- browse_machine([]), browse_repl_lets.
4488
4489 :- use_module(bmachine,[get_machine_identifiers/2]).
4490 % the CodesToMatch parameters mimics the apropos command of the Clojure-REPL
4491 browse_machine(CodesToMatch) :-
4492 get_machine_identifiers(machines,MN), display_match('MACHINES',CodesToMatch,MN),
4493 (CodesToMatch =[] -> print_sets
4494 ; get_machine_identifiers(sets,SN), display_match('SETS',CodesToMatch,SN),
4495 get_machine_identifiers(set_constants,SCN), display_match('SETS-ELEMENTS',CodesToMatch,SCN)
4496 ),
4497 get_machine_identifiers(definition_files,DFN),
4498 (DFN=[] -> true ; display_match('DEFINITIONS FILES',CodesToMatch,DFN)),
4499 get_machine_identifiers(definitions,DN),
4500 (DN=[] -> true ; display_match('DEFINITIONS',CodesToMatch,DN)),
4501 get_machine_identifiers(constants,CN),
4502 display_match('CONSTANTS',CodesToMatch,CN),
4503 get_machine_identifiers(variables,VN),
4504 display_match('VARIABLES',CodesToMatch,VN),
4505 get_machine_identifiers(operations,Ops),
4506 display_match('OPERATIONS',CodesToMatch,Ops).
4507
4508 display_match(KIND,CodesToMatch,Ids) :- display_match(KIND,CodesToMatch,Ids,show_empty).
4509 display_match(KIND,CodesToMatch,Ids,ShowEmpty) :-
4510 include(prob_cli:atom_contains_codes(CodesToMatch),Ids,MatchingIds),
4511 length(MatchingIds,LenMIds),
4512 (LenMIds=0, ShowEmpty=show_only_if_match -> true
4513 ; sort(MatchingIds,SMatchingIds),
4514 (CodesToMatch=[]
4515 -> format(' ~w: ~w ~w~n',[KIND,LenMIds,SMatchingIds])
4516 ; length(Ids,LenIds),
4517 format('Matching ~w: ~w/~w ~w~n',[KIND,LenMIds,LenIds,SMatchingIds]))
4518 ).
4519
4520 % check if an atom contains a list of codes in its name
4521 atom_contains_codes([],_) :- !.
4522 atom_contains_codes(Codes,Name) :- atom_codes(Name,NC),
4523 append([_,Codes,_],NC).
4524
4525 :- use_module(b_global_sets,[b_global_set/1]).
4526 print_sets :- print('Available SETS: '), b_global_set(GS), print_set(GS),fail.
4527 print_sets :- nl.
4528
4529 :- use_module(probsrc(b_global_sets),[is_b_global_constant/3]).
4530 print_set(GS) :- print(GS), \+ is_b_global_constant(GS,_,_),!, print(' ').
4531 print_set(GS) :- print(' = {'), is_b_global_constant(GS,_,Cst), print(Cst), print(' '),fail.
4532 print_set(_) :- print(' } ').
4533
4534 :- use_module(b_machine_hierarchy,[get_machine_identifier_names/7]).
4535 % browse all machines, shows identifiers maybe not visible at top-level
4536 browse_all_machines(CodesToMatch) :-
4537 format('Searching machine hierarchy for identifiers matching ~s~n',[CodesToMatch]),
4538 get_machine_identifier_names(Name,Params,Sets,AVars,CVars,AConsts,CConsts),
4539 format('~nMACHINE ~w~n',[Name]),
4540 display_match('PARAMS',CodesToMatch,Params,show_only_if_match),
4541 display_match('SETS',CodesToMatch,Sets,show_only_if_match),
4542 display_match('ABSTRACT_VARIABLES',CodesToMatch,AVars,show_only_if_match),
4543 display_match('CONCRETE_VARIABLES',CodesToMatch,CVars,show_only_if_match),
4544 display_match('ABSTRACT_CONSTANTS',CodesToMatch,AConsts,show_only_if_match),
4545 display_match('CONCRETE_CONSTANTS',CodesToMatch,CConsts,show_only_if_match),
4546 fail.
4547 browse_all_machines(_).
4548
4549
4550 :- use_module(bmachine,[b_get_properties_from_machine/1]).
4551 print_property_partitions :- print('PARTITIONS OF PROPERTIES'),nl,
4552 b_get_properties_from_machine(Properties),
4553 predicate_components(Properties,Comp),
4554 length(Comp,Len), print(Len), print(' components found in PROPERTIES'),nl,
4555 nth1(Nr,Comp,component(P,Vars)),
4556 format('~n& // Component ~w/~w over identifiers ~w~n',[Nr,Len,Vars]),
4557 translate:print_bexpr(P),nl,fail.
4558 print_property_partitions :- nl, print(' ============== '),nl.
4559
4560 :- use_module(store,[lookup_value_for_existing_id/3]).
4561 :- use_module(b_machine_hierarchy,[abstract_constant/2]).
4562 check_abstract_constants :-
4563 format('Checking whether abstract constants can be expanded:~n',[]),
4564 current_expression(_ID,CurState),
4565 expand_const_and_vars_to_full_store(CurState,EState),
4566 abstract_constant(AID,_),
4567 lookup_value_for_existing_id(AID,EState,Val),
4568 get_value_type(Val,VF),
4569 format(user_output,'~n*** Evaluating ABSTRACT_CONSTANT (stored value: ~w):~n',[VF]),
4570 format_with_colour_nl(user_output,[blue],' ~w',[AID]),
4571 (debug_mode(off) -> true
4572 ; translate:translate_bvalue(Val,VS), format_with_colour_nl(user_output,[blue],' Stored value = ~w',[VS])),
4573 atom_codes(AID,C),
4574 % TO DO: provide info if value symbolic and can be expanded fully + add timing
4575 % term_size, unique in state space
4576 % this command is deprecated compared to -csv constants_analysis (i.e., tcltk_analyse_constants)
4577 eval_codes(C,exists,_,_EnumWarning,_LS,_),nl, % TO DO: call try_expand_and_convert_to_avl_with_check(Val)
4578 fail.
4579 check_abstract_constants.
4580
4581 :- use_module(probsrc(custom_explicit_sets),[is_interval_closure/3]).
4582 get_value_type(CS, Res) :- is_interval_closure(CS,_,_),!, Res = 'interval closure'.
4583 get_value_type(closure(_,_,_),Res) :- !, Res= 'symbolic closure'.
4584 get_value_type(avl_set(_), Res) :- !, Res= 'explicit AVL set'.
4585 get_value_type(Val,VF) :- functor(Val,VF,_).
4586
4587 :- use_module(b_state_model_check,[cbc_constants_det_check/1]).
4588 det_check_constants :- \+ current_state_corresponds_to_setup_constants_b_machine, !,
4589 format_with_colour_nl(user_error,[red],'This command requires to setup the constants first!',[]).
4590 det_check_constants :-
4591 current_state_id(ID),
4592 %format('Checking whether constants are forced in state ~w:~n',[ID]),
4593 cbc_constants_det_check(ID).
4594
4595 % showing relations as tables:
4596
4597 :- use_module(extrasrc(table_tools),[print_value_as_table/2]).
4598 show_last_expression_as_table :- \+ last_expression(_,_Expr),!,
4599 print_red('Please evaluate an expression or predicate first.'),nl.
4600 show_last_expression_as_table :-
4601 get_last_result_value(Expr,_,Value),
4602 print_value_as_table(Expr,Value).
4603
4604
4605 % a few definitions so that probcli commands work in REPL:
4606 :- use_module(translate,[set_unicode_mode/0, unset_unicode_mode/0, set_atelierb_mode/1, unset_atelierb_mode/0]).
4607 :- public pretty_print_internal_rep/4, pretty_print_internal_rep_to_B/1.
4608 pretty_print_internal_rep(PPFILE,MachName,TYPES,unicode) :- !,
4609 set_unicode_mode,
4610 call_cleanup(b_write_machine_representation_to_file(MachName,TYPES,PPFILE),unset_unicode_mode).
4611 pretty_print_internal_rep(PPFILE,'$auto',_TYPES,atelierb) :- animation_minor_mode(eventb),!,
4612 b_write_eventb_machine_to_classicalb_to_file(PPFILE). % old -ppB option:
4613 pretty_print_internal_rep(PPFILE,MachName,TYPES,atelierb) :- !,
4614 set_atelierb_mode(native),
4615 call_cleanup(b_write_machine_representation_to_file(MachName,TYPES,PPFILE),unset_atelierb_mode).
4616 pretty_print_internal_rep(PPFILE,MachName,TYPES,_) :- b_write_machine_representation_to_file(MachName,TYPES,PPFILE).
4617
4618 % -ppB option:
4619 pretty_print_internal_rep_to_B(PPFILE) :- b_write_eventb_machine_to_classicalb_to_file(PPFILE).
4620
4621 :- use_module(tools_printing,[tcltk_nested_read_prolog_file_as_codes/2]).
4622 % -pppl option: internal developer utility to pretty-print a Prolog file in nested fashion
4623 % can be useful to inspecting .prob AST files or .P XTL files
4624 pretty_print_prolog_file(PPFILE) :-
4625 file_loaded(_,MainFile),
4626 (loaded_main_file(Ext,_), \+( (Ext='P' ; Ext='prob' ; Ext= 'pl') )
4627 -> add_warning(probcli,'The -pppl command is designed to work with Prolog files (.P, .prob or .pl), not with: ',Ext) ; true),
4628 pretty_print_prolog_file(MainFile,PPFILE).
4629
4630 pretty_print_prolog_file(File,File) :- !,
4631 add_error(probcli,'Output file must be different from input Prolog file:',File).
4632 pretty_print_prolog_file(MainFile,PPFILE) :-
4633 format('Pretty-Printing Prolog file ~w to ~w~n',[MainFile,PPFILE]),
4634 tcltk_nested_read_prolog_file_as_codes(MainFile,list(Codes)),
4635 safe_intelligent_open_file(PPFILE,write,Stream),
4636 format(Stream,'~s~n',[Codes]),
4637 close(Stream).
4638
4639 :- use_module(extrasrc(source_indenter),[indent_b_file/3]).
4640 indent_main_b_file(PPFILE) :-
4641 file_loaded(_,MainFile),
4642 indent_b_file_to_file(MainFile,PPFILE,[]).
4643
4644 indent_b_file_to_file(File,File,_) :- !,
4645 add_error(probcli,'Output file must be different from input B file:',File).
4646 indent_b_file_to_file(MainFile,PPFILE,Options) :-
4647 format('Indenting B file ~w to ~w~n',[MainFile,PPFILE]), flush_output,
4648 safe_intelligent_open_file(PPFILE,write,OutStream),
4649 call_cleanup(indent_b_file(MainFile,OutStream,Options),close(OutStream)).
4650
4651
4652 % Simple Animator
4653
4654 interactive_animate_machine :-
4655 nl,print('IMPORTANT: Do not use this mode for automatic tools.'),nl,
4656 print('The output format can change arbitrarily in future versions.'),nl,
4657 print('Please terminate your input with a dot (.) and then type return.'),nl,nl,
4658 animate_machine2.
4659 animate_machine2 :-
4660 print_current_state,
4661 cli_computeOperations(Ops),
4662 length(Ops,Max),
4663 print('Enabled Operations: '),nl,
4664 print_options(Ops,1),
4665 print(' ==> '),!,
4666 read(Nr),
4667 (number(Nr),Nr>0,Nr=<Max
4668 -> cli_animateOperationNr(Nr,Ops,0)
4669 ; fail
4670 ),!,
4671 animate_machine2.
4672 animate_machine2.
4673
4674 print_current_state :- current_state_id(CurID), print('ID ==> '), print(CurID),nl,
4675 getStateValues(CurID,State),
4676 print_bindings(State),
4677 (specfile:b_or_z_mode,\+is_initialised_state(CurID)
4678 -> print_red(' Not yet initialised.'),print_mode_info, debug_println(10,state(State)) ; nl).
4679
4680 print_mode_info :- animation_mode(M), (animation_minor_mode(MM) -> true ; MM=''),
4681 format('Animation Mode = ~w [~w]~n',[M,MM]).
4682
4683 cli_computeOperations(Ops) :- option(animate_stats),!, % provide statistics about the animation
4684 nl,
4685 start_probcli_timer(Timer),
4686 current_state_id(CurID),
4687 tcltk_get_options(list(Ops)),
4688 ajoin(['Time to compute all operations in state ',CurID,': '],Msg),
4689 stop_probcli_timer(Timer,Msg).
4690 cli_computeOperations(Ops) :- tcltk_get_options(list(Ops)).
4691
4692 cli_animateOperationNr(Nr,Options,StepNr) :-
4693 (option(animate_stats)
4694 -> nth1(Nr,Options,Action),
4695 truncate_animate_action(Action,TA),
4696 (StepNr>1 -> format('performing step ~w : ~w~n',[StepNr,TA])
4697 ; format('performing ~w~n',[TA]))
4698 ; true),
4699 tcltk_perform_nr(Nr).
4700
4701 :- use_module(tools_strings,[truncate_atom/3]).
4702 % optionally truncate animation action atom for printing:
4703 truncate_animate_action(Action,TA) :-
4704 (option_verbose -> TA = Action
4705 ; \+ atom(Action) -> TA = Action
4706 ; truncate_atom(Action,100,TA)).
4707
4708 perform_random_step(StepNr) :- perform_random_step(_Ops,_Len,_RanChoice,StepNr).
4709 perform_random_step(Ops,Len,RanChoice,StepNr) :-
4710 cli_computeOperations(Ops),
4711 current_state_id(CurID), check_for_errors(CurID,StepNr),
4712 length(Ops,Len), Len>0,
4713 debug_println(20,perform_random_step(Len,StepNr)),
4714 L1 is Len+1,
4715 (do_det_checking, Len>1
4716 -> print_error('Non-deterministic step in animate or init'),
4717 print_error('State:'),
4718 print_current_state, print_error('Enabled Operations: '), print_options(Ops,1),
4719 error_occurred(det_check)
4720 ; true),
4721 random(1,L1,RanChoice),
4722 debug_println(20,random(L1,RanChoice)),
4723 cli_animateOperationNr(RanChoice,Ops,StepNr).
4724
4725 :- use_module(state_space,[visited_expression/2]).
4726 check_for_errors(CurID,StepNr) :- invariant_violated(CurID),
4727 \+ option(no_invariant_violations),
4728 get_preference(do_invariant_checking,true),
4729 ajoin(['INVARIANT VIOLATED after ',StepNr,' steps (state id ',CurID,').'],ErrMsg),
4730 format('~w~n',[ErrMsg]),
4731 visited_expression(CurID,CurState), print_state_silent(CurState),
4732 error_occurred_with_msg(invariant_violation,ErrMsg),
4733 fail.
4734 check_for_errors(CurID,_) :- get_state_errors(CurID).
4735 % TO DO: also check for assertion errors, goal, state_errors with abort
4736
4737 :- use_module(bmachine,[b_machine_has_constants_or_properties/0]).
4738 do_det_checking :- option(det_check),!.
4739 do_det_checking :- option(det_constants_check),current_state_id(root),
4740 b_or_z_mode, b_machine_has_constants_or_properties.
4741
4742 perform_random_steps(Nr,_) :- \+ number(Nr),!,
4743 print_error('Argument to animate not a number'), print_error(Nr),error_occurred(animate).
4744 perform_random_steps(Nr,_) :- Nr<0, !,
4745 print_error('Argument to animate is a negative number'), print_error(Nr),error_occurred(animate).
4746 perform_random_steps(0,_) :- !.
4747 perform_random_steps(Nr,ErrorOnDeadlock) :-
4748 (perform_random_initialisation_if_necessary(Steps) % if Nr=1 we currently will also execute the INITIALISATION ! TO DO: fix
4749 -> perform_random_steps_aux(Steps,Nr,ErrorOnDeadlock)
4750 ; % we have setup_constants_fails or initialisation_fails
4751 print_error('Could not initialise model for animation')
4752 ).
4753
4754 perform_random_steps_aux(Nr,Max,_) :- Nr >= Max,!, debug_println(9,performed_random_steps(Nr)).
4755 perform_random_steps_aux(Nr,Max,ErrorOnDeadlock) :-
4756 N1 is Nr+1,
4757 (perform_random_step(N1)
4758 -> perform_random_steps_aux(N1,Max,ErrorOnDeadlock)
4759 ; /* deadlock */
4760 write_xml_element_to_log(deadlock_found,[step/Nr]),
4761 (ErrorOnDeadlock=true, \+ option(no_deadlocks)) ->
4762 print_error('Deadlock occurred during -animate, at step number:'), print_error(Nr),
4763 error_occurred(animate)
4764 ; print('% Deadlock occurred during -animate, at step number:'), print(Nr),nl
4765 ).
4766
4767 perform_random_initialisation_if_necessary(Steps) :-
4768 b_or_z_mode, current_state_id(State), State=root,!, perform_random_initialisation(Steps).
4769 perform_random_initialisation_if_necessary(0).
4770
4771 perform_random_initialisation :- perform_random_initialisation(_).
4772 perform_random_initialisation(Steps) :- current_state_id(State), State \= root, !,
4773 print_error('init can only be used in initial state'), print_error(State),error_occurred(initialisation),
4774 Steps=0.
4775 perform_random_initialisation(Steps) :- b_mode, b_machine_has_constants_or_properties,!,
4776 (perform_random_step(Ops,_Len,RanChoice,1)
4777 -> nth1(RanChoice,Ops,Choice), %print(Choice),nl,
4778 (Choice = 'PARTIAL_SETUP_CONSTANTS'
4779 -> error_occurred(setup_constants_inconsistent)
4780 ; true)
4781 ; error_occurred(setup_constants_fails),fail), % $setup_constants TODO: properties unknown or unsat
4782 perform_random_init_after_setup_constants, Steps=2. % $initialise_machine
4783 perform_random_initialisation(Steps) :- (perform_random_step(1) -> Steps=1 ; error_occurred(initialisation_fails),fail).
4784
4785
4786 perform_random_init_after_setup_constants :- \+ option(initialise), we_need_only_static_assertions(_),!,
4787 printsilent('% NOT INITIALISING MACHINE (not required)'),nls.
4788 % debug_println(20,'% NOT INITIALISING MACHINE (not required)').
4789 perform_random_init_after_setup_constants :-
4790 (perform_random_step(2) % 2 is the step nr not the number of steps
4791 -> true
4792 ; error_occurred(initialisation_fails),
4793 fail).
4794
4795 :- use_module(cbcsrc(enabling_analysis),[tcltk_cbc_enabling_analysis/1, print_enable_table/1, is_timeout_enabling_result/1]).
4796 do_enabling_analysis_csv(EnablingCsvFile,NOW) :-
4797 start_probcli_timer(Timer1),
4798 start_xml_feature(enabling_analysis,file,EnablingCsvFile,FINFO),
4799 tcltk_cbc_enabling_analysis(list(R)),
4800 stop_probcli_timer(Timer1,'% Finished CBC Enabling Analysis',_TotWallTime),
4801 print_cbc_stats(R,NOW),
4802 debug_println(9,writing_to_file(EnablingCsvFile)),
4803 my_tell(EnablingCsvFile),
4804 print_enable_table(R),
4805 told,!,
4806 stop_xml_feature(enabling_analysis,FINFO).
4807 do_enabling_analysis_csv(EnablingCsvFile,_) :-
4808 add_error(enabling_analysis,'Enabling analysis failed',EnablingCsvFile),
4809 stop_xml_group_in_log(enabling_analysis).
4810
4811 print_cbc_stats(Res,_NOW) :- length(Res,Len), Ops is Len-2, % Header + Init
4812 CBC_Calls is Ops*(Ops+1), % +1 for INITIALISATION
4813 findall(TO,(member(list([_|T]),Res), member(TO,T),is_timeout_enabling_result(TO)),TOS),
4814 length(TOS,NrTOS),
4815 format('% CBC Enabling Stats:~n% Nr of events: ~w~n% Nr of cbc calls: ~w, Timeout results: ~w~n',[Ops,CBC_Calls,NrTOS]),
4816 write_xml_element_to_log(cbc_enabling_stats,[nr_events/Ops,cbc_calls/CBC_Calls,nr_timeouts/NrTOS]).
4817
4818
4819 :- use_module(cbcsrc(enabling_analysis),[feasible_operation_with_timeout/3]).
4820 do_feasibility_analysis(ATimeOut,EnablingCsvFile) :-
4821 arg_is_number(ATimeOut,TimeOut),
4822 start_xml_feature(feasibility_analysis,file,EnablingCsvFile,FINFO),
4823 findall(list([Op,Res]),feasible_operation_with_timeout(Op,TimeOut,Res),R),
4824 debug_println(9,writing_to_file(EnablingCsvFile)),
4825 my_tell(EnablingCsvFile),
4826 print_enable_table([list(['Event','Feasibility'])|R]),
4827 told,!,
4828 stop_xml_feature(feasibility_analysis,FINFO).
4829 do_feasibility_analysis(_,EnablingCsvFile) :-
4830 add_error(feasibility_analysis,'Feasibility analysis failed',EnablingCsvFile),
4831 stop_xml_group_in_log(feasibility_analysis).
4832
4833 :- use_module(b_read_write_info,[tcltk_read_write_matrix/1]).
4834 generate_read_write_matrix(CsvFile) :-
4835 tcltk_read_write_matrix(list(Matrix)),
4836 my_tell(CsvFile),
4837 print_enable_table(Matrix),
4838 told,!.
4839 generate_read_write_matrix(CsvFile) :-
4840 add_error(read_write_matrix,'Generating Read-Write-Matrix failed',CsvFile).
4841
4842
4843 my_tell(File) :-
4844 catch(
4845 tell(File),
4846 error(_E,_), % existence_error(_,_)
4847 add_error_fail(tell,'File cannot be written to: ',File)).
4848
4849 print_options([],_).
4850 print_options([H|T],N) :-
4851 print(' '), print(N), print(':'), print(H),nl,
4852 N1 is N+1,
4853 print_options(T,N1).
4854
4855 print_nr_list(List) :- print_nr_list(List,0,1,no_repeats).
4856
4857 print_nr_list([],NM1,_,Repeats) :- !, print_repeats(NM1,Repeats).
4858 print_nr_list([H|T],_,N,repeated(H,SinceN)) :- !, N1 is N+1,
4859 print_nr_list(T,N,N1,repeated(H,SinceN)).
4860 print_nr_list([H|T],NM1,N,Repeats) :- !,
4861 print_repeats(NM1,Repeats),
4862 N1 is N+1,
4863 print_nr_list(T,N,N1,repeated(H,N)).
4864 print_nr_list(X,_,_,_) :- print('### not a list: '), print(X),nl.
4865
4866 print_repeats(N,repeated(H,N)) :- !,
4867 format(' ~w: ~w~n',[N,H]).
4868 print_repeats(N,repeated(H,Since)) :- !, Repeats is 1+N-Since,
4869 format(' ~w - ~w: ~w (~w repetitions)~n',[Since,N,H,Repeats]).
4870 print_repeats(_,_).
4871
4872 print_bindings([]) :- !.
4873 print_bindings([binding(Var,_,PPV)|T]) :- !, print(Var),print('='),print(PPV),
4874 (T=[] -> true ; print(', '), print_bindings(T)).
4875 print_bindings([binding(Var,_,PPV,_Tag)|T]) :- !, print(Var),print('='),print(PPV),
4876 (T=[] -> true ; print(', '), print_bindings(T)).
4877 print_bindings(X) :- print('### Internal Error: illegal binding list: '), print(X),nl.
4878
4879 :- dynamic expected_error_occurred/1.
4880 :- dynamic error_did_not_occur/1.
4881 reset_expected_error_occurred :- retractall(expected_error_occurred(_)).
4882 check_all_expected_errors_occurred(NOW) :-
4883 %error_manager:display_error_statistics,
4884 get_errors, get_state_space_errors,
4885 retractall(error_did_not_occur(_)),
4886 expected_error(Type),
4887 \+ expected_error_occurred(Type),
4888 print('*** Expected Error of following type to occur: '), print(Type),nl,
4889 writeln_log_time(expected_error_did_not_occur(NOW,Type)),
4890 assertz(error_did_not_occur(Type)),
4891 (option(strict_raise_error) -> definite_error_occurred ; fail).
4892 check_all_expected_errors_occurred(_NOW) :-
4893 (expected_error(_)
4894 -> (error_did_not_occur(_) -> print('*** Some expected errors did NOT occur !')
4895 ; print('All expected errors occurred.')),nl
4896 ; true).
4897
4898 expected_error(Type) :- option(expect_error(Type)).
4899 expected_error(Type) :- option(expect_error_pos(Type,_Line,_Col)).
4900
4901 error_occurred(warning(Type)) :- !, error_occurred(Type,warning).
4902 error_occurred(Type) :- error_occurred(Type,error).
4903
4904 get_error_category_and_type(warning(Cat),Category,Type) :- !, Category=Cat,Type=warning.
4905 get_error_category_and_type(C,C,error).
4906
4907 error_occurred_with_msg(Type,Msg) :- error_occurred_with_msg(Type,Msg,not_yet_extracted).
4908 error_occurred_with_msg(warning(Type),Msg,Span) :- !, error_occurred(Type,warning,Span,Msg).
4909 error_occurred_with_msg(Type,Msg,Span) :- error_occurred(Type,error,Span,Msg).
4910
4911 error_occurred(Type,ErrOrWarn) :- error_occurred(Type,ErrOrWarn,not_yet_extracted,'').
4912
4913 error_occurred(Type,ErrOrWarning,ExtractedSpan,Msg) :-
4914 option(expect_error_pos(Type,Line,Col)),!,
4915 write_xml_element_to_log(expected_error_occurred,[category/Type, (type)/ErrOrWarning, message/Msg]),
4916 assertz(expected_error_occurred(Type)),
4917 (get_error_or_warning_span(ExtractedSpan,Type,EL,EC)
4918 -> (option(expect_error_pos(Type,EL,EC))
4919 -> debug_println(9,expect_error_pos_ok(Type,EL,EC))
4920 ; format('*** Unexpected line ~w and column ~w for error ~w!~n*** Expected line ~w and column ~w.~n',[EL,EC,Type,Line,Col]),
4921 definite_error_occurred
4922 )
4923 ; format('*** Could not obtain position information for error ~w! Expected line ~w and column ~w.~n',[Type,Line,Col]),
4924 %display_error_statistics,
4925 definite_error_occurred).
4926 error_occurred(Type,ErrOrWarning,ExtractedSpan,Msg) :-
4927 option(expect_error(Type)),!,
4928 inc_counter(cli_expected_errors),
4929 get_xml_span(ExtractedSpan,XML),
4930 write_xml_element_to_log(expected_error_occurred,[category/Type, (type)/ErrOrWarning, message/Msg|XML]),
4931 assertz(expected_error_occurred(Type)).
4932 error_occurred(Type,ErrOrWarning,ExtractedSpan,Msg) :-
4933 (probcli_time_stamp(NOW) -> true ; NOW=unknown),
4934 writeln_log(error_occurred(NOW,Type)),
4935 get_xml_span(ExtractedSpan,XML),
4936 (option(optional_error(Type)) ->
4937 write_xml_element_to_log(optional_error_occurred,[category/Type, (type)/ErrOrWarning, message/Msg|XML]),
4938 formatsilent('% Optional error occured: ~w~n',[Type])
4939 ;
4940 write_xml_element_to_log(error_occurred,[category/Type, (type)/ErrOrWarning, message/Msg|XML]),
4941 (ErrOrWarning = warning -> safe_inc_counter(cli_warnings) ; safe_inc_counter(cli_errors)),
4942 flush_output, % ensure we can later associate position of error message
4943 (option(strict_raise_error) ->
4944 print_error('*** Unexpected error occurred ***'),
4945 print_error(Type),
4946 findall(Err,option(expect_error(Err)),Ls), (Ls=[] -> true ; print_error(expected(Ls))),
4947 definite_error_occurred
4948 ; ErrOrWarning=error,serious_error(Type)
4949 -> print_error('*** Serious error occurred ***'),
4950 print_error(Type),
4951 definite_error_occurred
4952 ; print_probcli_error_non_strict(Type,ErrOrWarning)
4953 )
4954 ).
4955
4956 safe_inc_counter(Counter) :-
4957 catch(inc_counter(Counter), E,
4958 format(user_error,'~n*** Exception in counter library, probably not yet initialized: ~w.~n~n',[E])).
4959
4960
4961 get_xml_span(Span,XML) :- extract_file_line_col(Span,FullFilename,Line,Col,EndLine,EndCol),!,
4962 XML = [file/FullFilename,start_line/Line,end_line/EndLine,start_col/Col,end_col/EndCol|XT],
4963 get_xml_add_description(Span,XT).
4964 get_xml_span(Span,XML) :- get_xml_add_description(Span,XML).
4965
4966 get_xml_add_description(Span,XML) :-
4967 extract_additional_description(Span,Msg),!,
4968 XML = [additional_description/Msg].
4969 get_xml_add_description(_,[]).
4970
4971 get_error_or_warning_span(not_yet_extracted,Type,EL,EC) :- check_error_span_file_linecol(Type,_File,EL,EC,_,_).
4972 get_error_or_warning_span(not_yet_extracted,Type,EL,EC) :- check_error_span_file_linecol(warning(Type),_File,EL,EC,_,_).
4973 get_error_or_warning_span(Span,_,EL,EC) :- Span \= not_yet_extracted, extract_line_col(Span,EL,EC,_,_).
4974
4975
4976 % a list of serious errors: if these occur; then return code different from 0 even in non-strict mode
4977 serious_error(get_java_command_path).
4978 serious_error(internal_error(_)).
4979
4980 print_probcli_error_non_strict(parse_machine_predicate_error,_) :-
4981 !. % have already been reported
4982 print_probcli_error_non_strict(Type,ErrOrWarning) :-
4983 (ErrOrWarning=warning -> print_error('*** warning occurred ***')
4984 ; print_error('*** error occurred ***')),
4985 print_error(Type).
4986
4987 definite_error_occurred :- print_error('*** Abnormal termination of probcli !'),
4988 (file_loaded(_,File) -> print_error('*** for_file'(File)) ; true),
4989 (current_probcli_command(Cmd) -> print_error('*** for_command'(Cmd)) ; true),
4990 (probcli_time_stamp(NOW) -> halt_prob(NOW,1)
4991 ; writeln_log(halt(1)),
4992 halt_exception(1)
4993 ).
4994
4995 :- dynamic current_probcli_command/1.
4996 set_current_probcli_command(X) :- retractall(current_probcli_command(_)),
4997 assertz(current_probcli_command(X)).
4998 unset_current_probcli_command :- retractall(current_probcli_command(_)).
4999
5000 halt_prob(ExitCode) :-
5001 (probcli_time_stamp(NOW) -> halt_prob(NOW,ExitCode) ; halt_prob(0,ExitCode)).
5002 halt_prob(NOW,ExitCode) :-
5003 write_xml_element_to_log(probcli_halted_prematurely,[now/NOW]),
5004 close_all_xml_groups_in_log_until('probcli-run'),
5005 stop_xml_probcli_run(NOW),
5006 halt_exception(ExitCode).
5007
5008
5009 :- dynamic accumulated_infos/3, individual_file_infos/3, merged_individual_file_infos/3.
5010 accumulate_infos(Context,Infos) :- option(benchmark_info_csv_output(_,_,_)), % -bench_csv
5011 file_loaded(_,File),
5012 get_additional_infos(Infos,Infos2), % additional infos if -machine_stats provided
5013 sort(Infos2,SInfos), % infos is a list of the form Info-Value
5014 debug_println(19,assert_file_infos(File,Context,SInfos)),
5015 assertz(individual_file_infos(File,Context,SInfos)), % store for later csv summary printing
5016 fail.
5017 accumulate_infos(Context,Infos) :- accumulate_infos_2(Context,Infos).
5018
5019 % useful if this is not related to a loaded file, like -eval_file:
5020 accumulate_file_infos(File,Context,Infos) :-
5021 get_additional_stats(Infos,Infos2),
5022 sort(Infos2,SInfos), % infos is a list of the form Info-Value
5023 assertz(individual_file_infos(File,Context,SInfos)).
5024
5025 % join/merge accumulated infos for multiple runs (benchmarking) for a particular context/category
5026 % currently we support this for model-checking
5027 merge_accumulated_infos(Context) :- individual_file_infos(File,Context,_),!,
5028 findall(Infos,individual_file_infos(File,Context,Infos),[Infos1|RestInfos]),
5029 merge_acc(Infos1,RestInfos,1,Result),
5030 assertz(merged_individual_file_infos(File,Context,Result)).
5031
5032 merge_acc(Cur,[],_,Cur).
5033 merge_acc(Cur,[Next|T],Nr,Res) :-
5034 N1 is Nr+1,
5035 merge_acc_infos(Cur,Next,N1,NextCur),
5036 merge_acc(NextCur,T,N1,Res).
5037
5038 % merge two accumulated infos lists
5039 merge_acc_infos([],S,_,Res) :- !, Res=S.
5040 merge_acc_infos(S,[],_,Res) :- !, Res=S.
5041 merge_acc_infos([C1|T1],[C2|T2],Nr,[Cat-ResVal|MT]) :-
5042 get_info(C1,Cat,Val1), get_info(C2,Cat,Val2),
5043 merge_value(Cat,Val1,Val2,Nr,ResVal),!,
5044 merge_acc_infos(T1,T2,Nr,MT).
5045 merge_acc_infos([C1|T1],T2,Nr,[C1|MT]) :-
5046 add_warning(merge_acc_infos,'Missing value: ',C1),
5047 merge_acc_infos(T1,T2,Nr,MT).
5048
5049 % merge individual values
5050 merge_value(Cat,Val1,_Val2,_,ResVal) :- keep_first_value(Cat),!, ResVal=Val1.
5051 merge_value(_,Val,Val,_,ResVal) :- !, ResVal=Val.
5052 merge_value(Cat,Val1,Val2,Nr,ResVal) :- compute_average(Cat),!, ResVal is (Val1*(Nr-1)/Nr) + (Val2 / Nr).
5053 merge_value(Cat,Val1,Val2,Nr,ResVal) :-
5054 add_warning(merge_value,'Differing values: ',val(Cat,Val1,Val2)),
5055 ResVal is (Val1*(Nr-1)/Nr) + (Val2 / Nr).
5056
5057 compute_average(runtime).
5058 compute_average(total_runtime).
5059 compute_average(walltime).
5060
5061 keep_first_value(memory_used). % memory consumption of the first run is relevant
5062
5063
5064 % also store additional infos if -machine_stats provided; useful for benchmarking/articles
5065 :- use_module(covsrc(hit_profiler),[retract_profile_stats/2]).
5066 get_additional_infos(I,Res) :- option(cli_print_machine_info(statistics)),!,
5067 findall(Key-Nr,b_machine_statistics(Key,Nr),I2,I),
5068 get_additional_stats(I2,Res).
5069 get_additional_infos(I,Res) :- get_additional_stats(I,Res).
5070 get_additional_stats(I,Res) :-
5071 findall(Key-Nr,retract_profile_stats(Key,Nr),Res,I). % include additional profiling stats and retract/reset them
5072
5073 accumulate_infos_2(_,[]).
5074 accumulate_infos_2(Context,[Info|T]) :- get_info(Info,FF,Nr),
5075 (number(Nr) -> Nr>0 ; add_internal_error('Can only accumulate numbers:',FF-Nr),fail), !,
5076 (retract(accumulated_infos(Context,FF,OldNr)) ->true ; OldNr=0),
5077 N1 is OldNr+Nr,
5078 assertz(accumulated_infos(Context,FF,N1)),
5079 accumulate_infos_2(Context,T).
5080 accumulate_infos_2(Context,[_|T]) :- accumulate_infos_2(Context,T).
5081 get_info(FF-Nr,FF,Nr).
5082 get_info(FF/Nr,FF,Nr).
5083
5084 :- use_module(tools_io,[safe_intelligent_open_file/3]).
5085 print_accumulated_infos(NrFilesProcessed) :-
5086 (option(benchmark_info_csv_output(File,FileMode,CSVMode)) % TODO: allow multiple entries
5087 -> safe_intelligent_open_file(File,FileMode,Stream) % FileMode is write or append
5088 ; Stream=user_output, CSVMode=csv
5089 ),
5090 call_cleanup(pr_acc_infos_aux(Stream,NrFilesProcessed,FileMode,CSVMode),
5091 close(Stream)), !.
5092 print_accumulated_infos(NrFilesProcessed) :-
5093 add_internal_error('Call failed:',print_accumulated_infos(NrFilesProcessed)).
5094
5095 get_csv_mode(csv,csv).
5096 get_csv_mode(tex,latex).
5097 get_csv_mode(latex,latex).
5098
5099 %:- use_module(library(system),[ datime/1]).
5100 pr_acc_infos_aux(Stream,NrFilesProcessed,FileMode,CSVMode) :-
5101 (NrFilesProcessed>1,accumulated_infos(_,_,_) -> true ; option(benchmark_info_csv_output(_,_,_))),!,
5102 print_individual_file_infos_csv(Stream,FileMode,CSVMode),
5103 start_xml_group_in_log(summary,files_processed,NrFilesProcessed),
5104 ((FileMode = append ; NrFilesProcessed = 1)
5105 -> true % do not print accumulated info line
5106 ; format(Stream,'Analysis summary (~w files processed): ',[NrFilesProcessed]),
5107 findall(Context-F-Nr,accumulated_infos(Context,F,Nr),L), sort(L,SL),
5108 maplist(prob_cli:pracc(Stream),SL),nl(Stream)
5109 ),
5110 % TO DO: write infos to XML log
5111 (option(print_version(VERSIONKIND)) ->
5112 datime(datime(Year,Month,Day,Hour,Min,_Sec)),
5113 format(Stream,'CSV file generated at ~w:~w on the date ~w/~w/~w using probcli:~n',[Hour,Min,Year,Month,Day]),
5114 print_version(VERSIONKIND,Stream),
5115 print_csv_prefs(Stream)
5116 ; true),
5117 (option(cli_print_statistics(memory)) -> print_memory_statistics(Stream) ; true),
5118 stop_xml_group_in_log_no_statistics(summary).
5119 pr_acc_infos_aux(_,_NrFilesProcessed,_Mode,_).
5120
5121 print_csv_prefs(Stream) :- \+ \+ option(set_preference_group(_,_)),
5122 format(Stream,'PREFERENCE GROUP,Setting~n',[]),
5123 option(set_preference_group(P,V)),
5124 format(Stream,'~w,~w~n',[P,V]),
5125 fail.
5126 print_csv_prefs(Stream) :- \+ \+ option(set_pref(_,_)),
5127 format(Stream,'PREFERENCE,Value~n',[]),
5128 option(set_pref(P,V)),
5129 format(Stream,'~w,~w~n',[P,V]),
5130 fail.
5131 print_csv_prefs(_).
5132
5133 pracc(Stream,Context-F-Nr) :- format(Stream,'~w:~w:~w ',[Context,F,Nr]).
5134 :- use_module(probsrc(tools),[gen_relative_path_to_cur_dir/2]).
5135 % print CSV summary of run
5136 print_individual_file_infos_csv(Stream,FileMode,CSVMode) :-
5137 findall(C,individual_file_infos(_,C,_),All), sort(All,AllContexts),
5138 member(Context,AllContexts), % iterate over all Contexts
5139 (individual_file_infos(_,Context,HInfos) -> true), % pick one as header
5140 (FileMode=append
5141 -> true % do not print header line, we append to an existing table
5142 ; format(Stream,'~nFILE,ANALYSIS,',[]),
5143 print_titles(HInfos,CSVMode,Stream),nl(Stream)
5144 ),
5145 % TO DO: ensure Infos and SHInfos identical, else add 0 for missing categories
5146 (merged_individual_file_infos(File,Context,Infos)
5147 -> true % just print averages
5148 ; individual_file_infos(File,Context,Infos)
5149 ),
5150 gen_relative_path_to_cur_dir(File,RelFile),
5151 format(Stream,'~w,~w,',[RelFile,Context]),
5152 print_vals(Infos,HInfos,CSVMode,Stream),nl(Stream),
5153 fail.
5154 print_individual_file_infos_csv(_,_,_).
5155
5156
5157
5158 print_vals(_,[],_,_) :- !.
5159 print_vals([H|T],[Header|HT],Mode,Stream) :- get_info(Header,Title,_),
5160 get_info(H,Title,Nr), !,
5161 write_atom(Mode,Stream,Nr),
5162 (T=[] -> write_csv_terminator(Mode,Stream) ; write_csv_sep(Mode,Stream), print_vals(T,HT,Mode,Stream)).
5163 print_vals(Vals,[_|HT],Mode,Stream) :- % a value is missing for this file
5164 write(Stream,'-'),
5165 (HT=[] -> write_csv_terminator(Mode,Stream) ; write_csv_sep(Mode,Stream), print_vals(Vals,HT,Mode,Stream)).
5166 print_titles([],_,_).
5167 print_titles([H|T],Mode,Stream) :- get_info(H,FF,_),
5168 write_atom(Mode,Stream,FF),
5169 (T=[] -> write_csv_terminator(Mode,Stream) ; write_csv_sep(Mode,Stream), print_titles(T,Mode,Stream)).
5170
5171 :- use_module(probsrc(tools),[latex_escape_atom/2]).
5172 write_atom(latex,Stream,Atom) :- atom(Atom), latex_escape_atom(Atom,EAtom),!,
5173 write(Stream,EAtom).
5174 write_atom(_,Stream,Term) :- write(Stream,Term).
5175
5176 write_csv_sep(latex,Stream) :- !,write(Stream,' & ').
5177 write_csv_sep(_,Stream) :- write(Stream,',').
5178 write_csv_terminator(latex,Stream) :- !,write(Stream,' \\\\').
5179 write_csv_terminator(_,_).
5180
5181 write_important_xml_element_to_log(Category,Infos) :-
5182 include(prob_cli:important_info,Infos,II),
5183 write_xml_element_to_log(Category,II).
5184 important_info(FF/Nr) :-
5185 \+ irrelevant_xml_info(FF),
5186 (Nr=0 -> \+ irrelevant_xml_if_zero(FF) ; true).
5187 irrelevant_xml_info(true_after_expansion).
5188 irrelevant_xml_info(false_after_expansion).
5189 irrelevant_xml_info(unknown_after_expansion).
5190 irrelevant_xml_info(total_after_expansion).
5191 irrelevant_xml_if_zero(timeout).
5192 irrelevant_xml_if_zero(enum_warning).
5193
5194
5195 % check_required_infos(ExpectedInfos,ActualInfos,ErrType)
5196 check_required_infos([],_,_).
5197 check_required_infos([H|T],Infos,ErrType) :-
5198 (check_single_info(H,Infos)
5199 -> check_required_infos(T,Infos,ErrType)
5200 ; translate_err_type(ErrType,ES),
5201 format_with_colour_nl(user_error,[red],
5202 '*** Unexpected result while checking: ~w~n*** expected : ~w~n*** in : ~w',
5203 [ES,H,Infos]),
5204 error_occurred(ErrType)).
5205 translate_err_type(check_assertions,'ASSERTIONS') :- !.
5206 translate_err_type(cli_check_assertions,'ASSERTIONS') :- !.
5207 translate_err_type(check_goal,'GOAL') :- !.
5208 translate_err_type(load_po_file,'PROOF OBLIGATIONS') :- !.
5209 translate_err_type(cli_wd_check,'WD PROOF OBLIGATIONS') :- !.
5210 translate_err_type(check_cache_stats,'CACHE STATISTICS') :- !.
5211 translate_err_type(X,X).
5212
5213 check_single_info(Label-Nr,Infos) :- !, member(Label-ActualNr,Infos),
5214 match_info(Nr,ActualNr).
5215 check_single_info(H,List) :- member(H,List).
5216 match_info(X,X).
5217 match_info(comparison_operator(Comp,Nr),ActualNr) :-
5218 number(Nr), number(ActualNr),call(Comp,ActualNr,Nr).
5219
5220 :- use_module(tools_platform, [max_tagged_integer/1]).
5221 :- public mc_ok_arg/2.
5222 mc_ok_arg(Arg,X) :- Arg==all,!,max_tagged_integer(X).
5223 mc_ok_arg(Arg,N) :- arg_is_number(Arg,N).
5224
5225
5226 :- dynamic option/1.
5227 assert_all_options([]).
5228 assert_all_options([Opt|T]) :- assert_option(Opt),
5229 assert_all_options(T).
5230
5231 :- use_module(pathes_extensions_db,[probcli_command_requires_extension/2]).
5232 cli_option_not_available(Opt,ProBExtension,Reason) :-
5233 probcli_command_requires_extension(Opt,ProBExtension),
5234 unavailable_extension(ProBExtension,Reason).
5235
5236 check_unavailable_options :-
5237 ? option(Opt),
5238 cli_option_not_available(Opt,ProBExtension,Reason),
5239 (recognised_option(Name,Opt,_,_) -> true ; Name=Opt),
5240 ajoin(['probcli command ', Name,' cannot be performed because extension not available (',Reason,'):'],Msg),
5241 add_error(probcli,Msg,ProBExtension),
5242 fail.
5243 check_unavailable_options.
5244
5245 assert_option(silent) :- option(force_no_silent),!. % ignoring silent flag
5246 assert_option(Opt) :- assertz(option(Opt)), treat_option(Opt).
5247
5248 :- use_module(tools_printing,[set_no_color/1, reset_no_color_to_default/0]).
5249 treat_option(silent) :- !, set_silent_mode(on),set_error_manager_silent_mode(on).
5250 treat_option(force_no_silent) :- !, set_silent_mode(off),set_error_manager_silent_mode(off).
5251 treat_option(no_color) :- !, set_no_color(true).
5252 treat_option(_).
5253
5254 reset_options :- retractall(option(_)),
5255 set_silent_mode(off), set_error_manager_silent_mode(off),
5256 reset_no_color_to_default.
5257
5258 % replace a leading double-dash -- by a single dash and replace inner dashes by underscores
5259 normalise_option_atom(X,RX) :- atom(X),!,
5260 atom_codes(X,CodesX),
5261 % remove leading dash
5262 (CodesX=[45,45,H|T], H\=45 % Double dash --Option
5263 -> maplist(prob_cli:convert_dash_to_underscore,[H|T],HT2),
5264 RXCodes=[45|HT2]
5265 ; CodesX = [Dash|T], is_dash(Dash) % single dash
5266 -> maplist(prob_cli:convert_dash_to_underscore,T,T2),
5267 RXCodes=[45|T2]
5268 ; maplist(prob_cli:convert_dash_to_underscore,CodesX,RXCodes)
5269 ),
5270 atom_codes(RX,RXCodes).
5271 normalise_option_atom(T,T).
5272
5273 is_dash(45). % regular dash
5274 is_dash(8212). % Unicode double dash; sometimes automatically generated from -- by e.g., macOS Mail program
5275
5276 :- public normalise_pref_name/2. % called via recognised_option
5277 % replace dashes by underscores
5278 normalise_pref_name(X,RX) :- atom(X),!,
5279 atom_codes(X,CodesX),
5280 maplist(prob_cli:convert_dash_to_underscore,CodesX,C2),
5281 atom_codes(RX,C2).
5282 normalise_pref_name(T,T).
5283
5284 convert_dash_to_underscore(45,R) :- !, R=95.
5285 convert_dash_to_underscore(X,X).
5286
5287 recognised_cli_option(X,Opt,Args,Condition) :- normalise_option_atom(X,RX),
5288 ? recognised_option(RX,Opt,Args,Condition).
5289
5290 % get a list of all options
5291 get_all_options(SOpts) :-
5292 findall(O, recognised_option(O,_,_,_), Opts),
5293 sort(Opts,SOpts).
5294
5295 :- use_module(tools_matching,[fuzzy_match_codes_lower_case/2]).
5296 % compute a set of possible fuzzy matches
5297 get_possible_fuzzy_match_options(Option,FuzzyMatches) :-
5298 normalise_option_atom(Option,RX),
5299 atom_codes(RX,OCodes),
5300 get_all_options(SOpts),
5301 findall(Target,(member(Target,SOpts),atom_codes(Target,TargetCodes),
5302 fuzzy_match_codes_lower_case(OCodes,TargetCodes)),FuzzyMatches).
5303
5304 :- use_module(tools_matching,[get_possible_completions_msg/3]).
5305 get_possible_options_completion_msg(Option,Msg) :-
5306 normalise_option_atom(Option,RX),
5307 get_all_options(SOpts),
5308 get_possible_completions_msg(RX,SOpts,Msg).
5309
5310 recognised_option(X,Opt,[],true) :- recognised_option(X,Opt). % options without arguments
5311 recognised_option(X,Opt,Args,true) :- recognised_option(X,Opt,Args). % options with arguments but no code needed to check arguments
5312
5313 recognised_option('-mc',cli_mc(N,[]),[Arg],prob_cli:mc_ok_arg(Arg,N)).
5314 recognised_option('-bench_model_check',cli_mc(LimitNr,[reset_state_space,repeat(Rep)]),[Arg],tools:arg_is_number(Arg,Rep)) :- max_tagged_integer(LimitNr).
5315 recognised_option('-model_check',cli_mc(LimitNr,[]),[],true) :- max_tagged_integer(LimitNr).
5316 recognised_option('-timeout',timeout(N),[Arg],tools:arg_is_number(Arg,N)). % for model checking, refinement checking and for disprover per PO
5317 recognised_option('-time_out',timeout(N),[Arg],tools:arg_is_number(Arg,N)).
5318 recognised_option('-global_time_out',timeout(N),[Arg],tools:arg_is_number(Arg,N)). % better name, to avoid conflict with -p timeout N which also works
5319 recognised_option('-s',socket(S,true),[Arg],tools:arg_is_number(Arg,S)).
5320 recognised_option('-cc',coverage(N,N2,just_check_stats),[Arg,Arg2],
5321 (arg_is_number_or_wildcard(Arg,N),arg_is_number_or_wildcard(Arg2,N2))).
5322 recognised_option('-csp_guide',add_csp_guide(File),[File],
5323 prob_cli:check_file_arg(File,'csp_guide')).
5324 recognised_option('-prologOut',csp_translate_to_file(PlFile),[PlFile],
5325 prob_cli:check_file_arg(PlFile,'prologOut')).
5326 recognised_option('-load_state',load_state(Filename),[Filename],
5327 prob_cli:check_file_arg(Filename,'load_state')).
5328 recognised_option('-refchk',refinement_check(Filename,trace,100000),[Filename],
5329 prob_cli:check_file_arg(Filename,'refchk')).
5330 recognised_option('-ref_check',refinement_check(Filename,FailuresModel,100000),[Shortcut,Filename],
5331 (prob_cli:check_file_arg(Filename,'ref_check'),
5332 prob_cli:check_failures_mode(Shortcut,FailuresModel))).
5333 recognised_option('-refinement_check',Option,Args,Code) :- recognised_option('-refchk',Option,Args,Code).
5334 recognised_option('-hash',check_statespace_hash(H,_),[Arg],tools:arg_is_number(Arg,H)).
5335 recognised_option('-hash64',check_statespace_hash(H,'64bit'),[Arg],tools:arg_is_number(Arg,H)).
5336 recognised_option('-hash32',check_statespace_hash(H,'32bit'),[Arg],tools:arg_is_number(Arg,H)).
5337 recognised_option('-check_op_cache_stats',
5338 check_op_cache([next_state_calls-H1,inv_check_calls-H2,
5339 operations_cached-H3,invariants_cached-H4]),[Arg1,Arg2,Arg3,Arg4],
5340 (tools:arg_is_number_or_wildcard(Arg1,H1), tools:arg_is_number_or_wildcard(Arg2,H2),
5341 tools:arg_is_number_or_wildcard(Arg3,H3), tools:arg_is_number_or_wildcard(Arg4,H4))).
5342 recognised_option('-ltllimit',ltl_limit(Nr),[Arg], tools:arg_is_number(Arg,Nr)).
5343 recognised_option('-ltlfile',ltl_file(Filename),[Filename],
5344 prob_cli:check_file_arg(Filename,'ltlfile')).
5345 recognised_option('-check_disprover_result',cli_check_disprover_result([true-TNr,false-FNr,unknown-UNr,failure-0]),[T,F,U],
5346 (arg_is_number_or_wildcard(T,TNr),arg_is_number_or_wildcard(F,FNr),arg_is_number_or_wildcard(U,UNr))).
5347 recognised_option('-aa',cli_check_assertions(all,[true/TNr,false/FNr,unknown/UNr]),[T,F,U],
5348 (arg_is_number_or_wildcard(T,TNr),arg_is_number_or_wildcard(F,FNr),arg_is_number_or_wildcard(U,UNr))).
5349 recognised_option('-ma',cli_check_assertions(main,[true/TNr,false/FNr,unknown/UNr]),[T,F,U],
5350 (arg_is_number_or_wildcard(T,TNr),arg_is_number_or_wildcard(F,FNr),arg_is_number_or_wildcard(U,UNr))).
5351 recognised_option('-wd',cli_wd_check(DNr,TNr),[D,T],
5352 (arg_is_number_or_wildcard(T,TNr),arg_is_number_or_wildcard(D,DNr))).
5353 recognised_option('-check_cache_stats',cli_cache_stats_check([value_persistance_reused_transitions-RNr,
5354 value_persistance_stored_transitions-SNr]),[R,S],
5355 (arg_is_number_or_wildcard(S,SNr),arg_is_number_or_wildcard(R,RNr))).
5356 recognised_option('-kodkod_comparision',kodkod_comparision(Nr),[Arg],tools:arg_is_number(Arg,Nr)).
5357 recognised_option('-kodkod_performance',kodkod_performance(File,Nr),[File,Arg],tools:arg_is_number(Arg,Nr)).
5358 recognised_option('-animate',cli_random_animate(N,true),[Steps],tools:arg_is_number(Steps,N)).
5359 recognised_option('-execute',execute(N,true,current_state(1)),[Steps],tools:arg_is_number(Steps,N)).
5360 recognised_option('-execute_repeat',execute(N,true,current_state(R)),[Steps,Rep],
5361 (tools:arg_is_number(Steps,N),tools:arg_is_number(Rep,R))).
5362 recognised_option('-execute_expect_steps',execute_expect_steps(N),[Steps],tools:arg_is_number(Steps,N)).
5363 recognised_option('-logxml_write_vars',logxml_write_ids(variables,Prefix),[Prefix],true).
5364 recognised_option('-logxml_write_ids',logxml_write_ids(all,Prefix),[Prefix],true).
5365 recognised_option('-zmq_master',zmq_master(Identifier),[Identifier], true).
5366 recognised_option('-cbc_tests', cbc_tests(Depth,EndPred,Output),[Depth,EndPred,Output],
5367 prob_cli:check_file_arg(Output,'cbc_tests')).
5368 recognised_option('-mcm_tests', mcm_tests(Depth,MaxStates,EndPred,Output),[Depth,MaxStates,EndPred,Output],
5369 prob_cli:check_file_arg(Output,'mcm_tests')).
5370 recognised_option('-test_description', test_description(File), [File],
5371 prob_cli:check_file_arg(File,'test_description')).
5372 recognised_option('-all_paths', all_deadlocking_paths(File), [File],
5373 prob_cli:check_file_arg(File,'all_paths')).
5374 recognised_option('-dot',dot_command(Category,File,default),[Category,File],
5375 prob_cli:check_file_arg(File,'dot')).
5376 recognised_option('-spdot',dot_command(state_space,File,default),[File], prob_cli:check_file_arg(File,'spdot')). % we keep this : it is shown in Wiki
5377 % recognised_option('-spmdot',dot_command(signature_merge,File,default),[File], prob_cli:check_file_arg(File,'spmdot')).
5378 % recognised_option('-spddot',dot_command(dfa_merge,File,default),[File], prob_cli:check_file_arg(File,'spddot')).
5379 % recognised_option('-sgdot',dot_command(state_as_graph,File,default),[File], prob_cli:check_file_arg(File,'sgdot')).
5380 recognised_option('-dotexpr',dot_command_for_expr(Category,Expr,File,[],default),[Category,Expr,File],
5381 prob_cli:check_file_arg(File,'dotexpr')).
5382 recognised_option('-dot_expr',Opt,Args,Call) :- recognised_option('-dotexpr',Opt,Args,Call).
5383 %recognised_option('-sgedot',dot_command_for_expr(expr_as_graph,Expr,File,[],default),[Expr,File], prob_cli:check_file_arg(File,'sgedot')).
5384 % recognised_option('-sptdot',dot_command_for_expr(transition_diagram,Expr,File,[],default),[Expr,File],prob_cli:check_file_arg(File,'sptdot')).
5385 %recognised_option('-invdot',dot_command(invariant,File,default),[File], prob_cli:check_file_arg(File,'invdot')).
5386 %recognised_option('-propdot',dot_command(properties,File,default),[File], prob_cli:check_file_arg(File,'propdot')).
5387 %recognised_option('-assdot',dot_command(assertions,File,default),[File], prob_cli:check_file_arg(File,'assdot')).
5388 %recognised_option('-deaddot',dot_command(deadlock,File,default)(File),[File], prob_cli:check_file_arg(File,'deaddot')).
5389 recognised_option('-puml',plantuml_command(Category,File),[Category,File],
5390 prob_cli:check_file_arg(File,'plantuml')).
5391 recognised_option('-pumlexpr',plantuml_command(Category,File,[Expr]),[Category,Expr,File],
5392 prob_cli:check_file_arg(File,'plantuml')).
5393 recognised_option('-puml_expr',Opt,Args,Call) :- recognised_option('-pumlexpr',Opt,Args,Call).
5394 recognised_option('-csv',csv_table_command(Category,[],[],File),[Category,File],
5395 prob_cli:check_file_arg(File,'csv')).
5396 recognised_option('-csvexpr',csv_table_command(Category,[Expr],[],File),[Category,Expr,File],
5397 prob_cli:check_file_arg(File,'csvexpr')).
5398 recognised_option('-csv_expr',Opt,Args,Call) :- recognised_option('-csvexpr',Opt,Args,Call).
5399 recognised_option('-csv_hist',Opt,Args,Call) :- recognised_option('-csvhist',Opt,Args,Call).
5400 recognised_option('-csvhist',evaluate_expression_over_history_to_csv_file(Expr,File),[Expr,File],
5401 prob_cli:check_file_arg(File,'csvhist')).
5402 %recognised_option('-get_min_max_coverage',csv_table_command(minmax_table,[],[text_output],File),[File]). % deprecated
5403 recognised_option('-min_max_coverage',csv_table_command(minmax_table,[],[text_output],File),[File],
5404 prob_cli:check_file_arg(File,'min_max_coverage')).
5405 recognised_option('-get_coverage_information',get_coverage_information(File),[File],
5406 prob_cli:check_file_arg(File,'get_coverage_information')).
5407 %recognised_option('-vc',csv_table_command(minmax_table,[],[text_output],user_output)).
5408 recognised_option('-read_write_matrix_csv',generate_read_write_matrix_csv(CsvFile),
5409 [CsvFile],
5410 prob_cli:check_file_arg(CsvFile,'read_write_matrix_csv')).
5411 recognised_option('-feasibility_analysis_csv',feasibility_analysis_csv(TimeOut,EnablingCsvFile),
5412 [TimeOut,EnablingCsvFile],
5413 prob_cli:check_file_arg(EnablingCsvFile,'feasibility_analysis_csv')).
5414 recognised_option('-l',log(Log,prolog),[Log],
5415 prob_cli:check_file_arg(Log,'l')).
5416 recognised_option('-log',log(Log,prolog),[Log],
5417 prob_cli:check_file_arg(Log,'log')).
5418 recognised_option('-logxml',log(Log,xml),[Log],
5419 prob_cli:check_file_arg(Log,'logxml')). % see cli_start_logging
5420 recognised_option('-logtlc',logtlc(Log),[Log],
5421 prob_cli:check_file_arg(Log,'logtlc')).
5422 recognised_option('-pp',pretty_print_internal_rep(File,'$auto',needed,ascii),[File],
5423 prob_cli:check_file_arg(File,'pp')).
5424 recognised_option('-ppunicode',pretty_print_internal_rep(File,'$auto',needed,unicode),[File],
5425 prob_cli:check_file_arg(File,'pp')).
5426 recognised_option('-ppf',pretty_print_internal_rep(File,'$auto',all,ascii),[File],
5427 prob_cli:check_file_arg(File,'ppf')).
5428 recognised_option('-ppAB',pretty_print_internal_rep(File,'$auto',all,atelierb),[File],
5429 prob_cli:check_file_arg(File,'ppAB')).
5430 recognised_option('-pp_with_name',pretty_print_internal_rep(File,MachName,all,ascii),[MachName,File],
5431 prob_cli:check_file_arg(File,'pp_with_name')). % provide explicit machine name
5432 recognised_option('-ppB',pretty_print_internal_rep_to_B(File),[File],
5433 prob_cli:check_file_arg(File,'ppB')). % deprecated; is now superseded by ppAB for Event-B machines
5434 recognised_option('-pppl',pretty_print_prolog_file(File),[File],
5435 prob_cli:check_file_arg(File,'pppl')).
5436 recognised_option('-pp_pl_file',pretty_print_prolog_file(File,OutFile),[File,OutFile],
5437 (prob_cli:check_file_arg(File,'pp_pl_file'),prob_cli:check_file_arg(OutFile,'pp_pl_file'))).
5438 recognised_option('-ppi',indent_main_b_file(File),[File],
5439 prob_cli:check_file_arg(File,'ppi')).
5440 recognised_option('-indent_b_file',indent_b_file_to_file(BFile,OutFile,[]),[BFile,OutFile], % indent some other file
5441 (prob_cli:check_file_arg(BFile,'indent_b_file'),prob_cli:check_file_arg(OutFile,'indent_b_file'))).
5442 recognised_option('-reformat_b_file',indent_b_file_to_file(BFile,OutFile,
5443 [insert_new_lines_before_keywords,insert_new_lines_after_keywords]),[BFile,OutFile], % reformat some other file
5444 (prob_cli:check_file_arg(BFile,'indent_b_file'),prob_cli:check_file_arg(OutFile,'indent_b_file'))).
5445 recognised_option('-save_state',save_state_space(Filename),[Filename],
5446 prob_cli:check_file_arg(Filename,'save_state')). % possibly save_state_space would be a better name
5447 recognised_option('-save',save_state_for_refinement(Filename),[Filename],
5448 prob_cli:check_file_arg(Filename,'save')).
5449 recognised_option('-sptxt',print_values(Filename),[Filename],
5450 prob_cli:check_file_arg(Filename,'sptxt')).
5451 recognised_option('-sstxt',print_all_values(Dirname),[Dirname],
5452 prob_cli:check_file_arg(Dirname,'sstxt')).
5453 recognised_option('-latex',process_latex_file(In,Out),[In,Out],
5454 (prob_cli:check_file_arg(In,'latex'),prob_cli:check_file_arg(Out,'latex'))).
5455 recognised_option('-bench_csv',benchmark_info_csv_output(File,write,csv),[File],prob_cli:check_file_arg(File,'bench_csv')).
5456 recognised_option('-bench_csv_append',benchmark_info_csv_output(File,append,csv),[File],prob_cli:check_file_arg(File,'bench_csv')).
5457 recognised_option('-bench_tex',benchmark_info_csv_output(File,write,latex),[File],prob_cli:check_file_arg(File,'bench_tex')).
5458 recognised_option('-trace_replay',trace_check(Style,File,default_trace_replay),[Style,File],prob_cli:check_file_arg(File,'trace_replay')). % can be json, ..
5459 recognised_option('-det_trace_replay',trace_check(Style,File,deterministic_trace_replay),[Style,File],prob_cli:check_file_arg(File,'det_trace_replay')).
5460 recognised_option('-replay',eval_repl([File]),[File],prob_cli:check_file_arg(File,'replay')). % used to be -eval
5461 recognised_option('-state_trace',state_trace(File),[File],prob_cli:check_file_arg(File,'state_trace')).
5462 recognised_option('-typecheckertest',typechecker_test(File),[File],prob_cli:check_file_arg(File,'typecheckertest')).
5463 recognised_option('-enabling_analysis_csv',enabling_analysis_csv(EnablingCsvFile),[EnablingCsvFile],
5464 prob_cli:check_file_arg(EnablingCsvFile,'enabling_analysis_csv')).
5465 recognised_option('-dot_output',dot_analyse_output_prefix(Path),[Path],prob_cli:check_file_arg(Path,'dot_output')).
5466 recognised_option('-evaldot',evaldot(File),[File],prob_cli:check_file_arg(File,'evaldot')).
5467 recognised_option('-his',history(File),[File],prob_cli:check_file_arg(File,'his')).
5468 recognised_option('-visb_click',visb_click(SVGID),[SVGID],true).
5469 recognised_option('-visb',visb_history(JSONFile,HTMLFile,[]),[JSONFile,HTMLFile],
5470 (prob_cli:check_file_arg(JSONFile,'visb'),prob_cli:check_file_arg(HTMLFile,'visb'))).
5471 recognised_option('-visb_with_vars',
5472 visb_history(JSONFile,HTMLFile,[show_constants(all),show_sets(all),show_variables(all)]),
5473 [JSONFile,HTMLFile],
5474 (prob_cli:check_file_arg(JSONFile,'visb_with_vars'),prob_cli:check_file_arg(HTMLFile,'visb_with_vars'))).
5475 recognised_option('-rule_report',rule_report(File), [File], prob_cli:check_file_arg(File,'rule_report')).
5476 recognised_option('-bench_alloy_cmd',run_benchmark(alloy,CmdNames,AlloyFilePath),[CmdNames,AlloyFilePath],prob_cli:check_file_arg(AlloyFilePath,'bench_alloy_cmd')).
5477 recognised_option('-bench_smt_cbc_inv',run_benchmark(smt,cbc_inv,Folder),[Folder],prob_cli:check_file_arg(Folder,'bench_smt_cbc_inv')).
5478 recognised_option('-bench_smt_cbc_deadlock',run_benchmark(smt,cbc_deadlock,Folder),[Folder],prob_cli:check_file_arg(Folder,'bench_smt_cbc_deadlock')).
5479 recognised_option('-bench_smt_bmc',run_benchmark(smt,bmc,Folder),[Folder],prob_cli:check_file_arg(Folder,'bench_smt_bmc')).
5480 recognised_option('-eval_file',eval_string_or_file(file(default),F,exists,_ANY,norecheck),[F],prob_cli:check_file_arg(F,'eval_file')).
5481 recognised_option('-evalt_file',eval_string_or_file(file(default),F,exists,'TRUE',norecheck),[F],prob_cli:check_file_arg(F,'evalt_file')).
5482 recognised_option('-eval_rule_file',eval_string_or_file(file(default),F,forall,_ANY,norecheck),[F],prob_cli:check_file_arg(F,'eval_rule_file')).
5483 recognised_option('-solve_file',eval_string_or_file(file(Solver),F,exists,_ANY,norecheck),[Solver,F],prob_cli:check_file_arg(F,'eval_file')).
5484
5485 recognised_option('-zmq_assertions',zmq_assertion(Identifier),[Identifier],true).
5486 recognised_option('-zmq_worker',zmq_worker(Identifier),[Identifier], true).
5487 %recognised_option('-zmq_worker2',zmq_worker2(MasterIP, Port, ProxyID, Logfile),[MasterIP, SPort, SProxyID, Logfile],
5488 % tools:(arg_is_number(SPort,Port), arg_is_number(SProxyID, ProxyID))).
5489 recognised_option('-p',set_pref(NPREF,PREFVAL),[PREF,PREFVAL],prob_cli:normalise_pref_name(PREF,NPREF)).
5490 recognised_option('-pref',set_pref(NPREF,PREFVAL),[PREF,PREFVAL],prob_cli:normalise_pref_name(PREF,NPREF)).
5491 recognised_option('-prob_application_type',set_application_type(T),[T],true).
5492 recognised_option('-cbc_redundant_invariants',cbc_redundant_invariants(Nr),[X],tools:arg_is_number(X,Nr)).
5493 recognised_option('-expcterrpos',expect_error_pos(Type,LNr,CNr),[Type,Line,Col],
5494 (tools:arg_is_number(Line,LNr),tools:arg_is_number(Col,CNr))).
5495 recognised_option('-pref_group',set_preference_group(NGroup,Val),[Group,Val],
5496 (prob_cli:normalise_option_atom(Group,NGroup))).
5497 recognised_option('-save_all_traces_until',generate_all_traces_until(Formula,FilePrefix),
5498 [Formula,FilePrefix],
5499 true). % we could check LTL formula and FilePrefix
5500 recognised_option('-check_machine_file_sha',check_machine_file_sha(FILE,SHA1),[FILE,SHA1],
5501 prob_cli:check_file_arg(FILE,'check_machine_file_sha')).
5502 recognised_option('-sha1sum',Command,Args,Call) :-
5503 recognised_option('-check_machine_file_sha',Command,Args,Call).
5504 recognised_option('-animate_until_ltl_steps',animate_until_ltl(Formula,no_loop,ltl_found,Steps),[Formula,A],
5505 tools:arg_is_number(A,Steps)).
5506 recognised_option('-gc_margin',set_gc_margin(Nr),[X], tools:arg_is_number(X,Nr)).
5507
5508 % recognised_option/3
5509 recognised_option('-prefs',set_prefs_from_file(PREFFILE),[PREFFILE]).
5510 %recognised_option('-plugin',plugin(Plugin), [Plugin]).
5511 recognised_option('-card',set_card(SET,SCOPE),[SET,SCOPE]).
5512 recognised_option('-argv',set_argv(ARGV),[ARGV]).
5513 recognised_option('-goal',set_goal(GOAL),[GOAL]).
5514 recognised_option('-property',add_additional_property(PRED),[PRED]).
5515 recognised_option('-scope',set_searchscope(GOAL),[GOAL]).
5516 recognised_option('-searchscope',set_searchscope(GOAL),[GOAL]).
5517 recognised_option('-search_scope',set_searchscope(GOAL),[GOAL]).
5518 recognised_option('-eval',eval_string_or_file(string,E,exists,_,norecheck),[E]).
5519 recognised_option('-evalt',eval_string_or_file(string,E,exists,'TRUE',norecheck),[E]).
5520 recognised_option('-evalf',eval_string_or_file(string,E,exists,'FALSE',norecheck),[E]).
5521 recognised_option('-evalt_rc',eval_string_or_file(string,E,exists,'TRUE',recheck(ascii)),[E]).
5522 recognised_option('-evalf_rc',eval_string_or_file(string,E,exists,'FALSE',recheck(ascii)),[E]).
5523 recognised_option('-evalu',eval_string_or_file(string,E,exists,'UNKNOWN',norecheck),[E]).
5524 recognised_option('-evalnwd',eval_string_or_file(string,E,exists,'NOT-WELL-DEFINED',norecheck),[E]).
5525 recognised_option('-parsercp',parsercp(L),[L]). % deprecated
5526 recognised_option('-parserport',parserport(L),[L]).
5527 recognised_option('-expcterr',expect_error(Type),[Type]).
5528 recognised_option('-expecterr',expect_error(Type),[Type]).
5529 recognised_option('-expect',expect_error(Type),[Type]).
5530 recognised_option('-opterr',optional_error(Type),[Type]).
5531 recognised_option('-his_option',history_option(Option),[Option]). % trace_file, json, show_init, show_states
5532 recognised_option('-cache',cache_storage(D,strict),[D]). % for value_persistance caching
5533 recognised_option('-ccache',cache_storage(D,create_if_needed),[D]). % ditto
5534 recognised_option('-show_cache',show_cache(default),[]).
5535 recognised_option('-show_cache_verbose',show_cache(verbose),[]).
5536 recognised_option('-cache_statistics',cli_print_statistics(value_persistance_stats),[]).
5537 recognised_option('-cache_stats',cli_print_statistics(value_persistance_stats),[]). % synonym
5538 % see also -check_cache_stats
5539 recognised_option('-clear_cache',clear_value_persistance_cache,[]).
5540 recognised_option('-clear_cache_for',clear_value_persistance_cache(Machine),[Machine]).
5541 recognised_option('-hshow',cli_print_statistics(hshow),[]). % machine inclusion hierarchy
5542 recognised_option('-show_inclusion_hierarchy',cli_print_statistics(hshow),[]). % machine inclusion hierarchy
5543
5544 recognised_option('-MAIN',csp_main(ProcessName),[ProcessName]).
5545
5546 recognised_option('-ltlformula',ltl_formula_model_check(Formula,_),[Formula]).
5547 recognised_option('-ltlformulat',ltl_formula_model_check(Formula,true),[Formula]).
5548 recognised_option('-ltlformulaf',ltl_formula_model_check(Formula,false),[Formula]).
5549 recognised_option('-ctlformula',ctl_formula_model_check(Formula,_),[Formula]).
5550 recognised_option('-ctlformulat',ctl_formula_model_check(Formula,true),[Formula]).
5551 recognised_option('-ctlformulaf',ctl_formula_model_check(Formula,false),[Formula]).
5552 recognised_option('-pctlformula',pctl_formula_model_check(Formula,_),[Formula]).
5553 recognised_option('-pctlformulat',pctl_formula_model_check(Formula,true),[Formula]).
5554 recognised_option('-pctlformulaf',pctl_formula_model_check(Formula,false),[Formula]).
5555 recognised_option('-animate_until_ltl',animate_until_ltl(Formula,no_loop,_,_),[Formula]).
5556 recognised_option('-animate_until_ltl_state_property',animate_until_ltl(Formula,ltl_state_property,_,_),[Formula]).
5557
5558
5559 %recognised_option('-cspref',csp_in_situ_refinement_check(assertRef('False',val_of(AbsP1,no_loc_info_available),Type,val_of(ImplP2,no_loc_info_available),no_loc_info_available),'False'),[AbsP1,Type,ImplP2]).
5560 recognised_option('-cspref',csp_in_situ_refinement_check(AbsP1,Type,ImplP2),[AbsP1,Type,ImplP2]).
5561 % -cspref R [F= Q
5562 recognised_option('-cspdeadlock',csp_checkAssertion(Proc,Model,'deadlock free'),[Proc,Model]).
5563 % -cspdeadlock R F
5564 recognised_option('-cspdeterministic',csp_checkAssertion(Proc,Model,'deterministic'),[Proc,Model]).
5565 % -cspdeterministic R F
5566 recognised_option('-csplivelock',csp_checkAssertion(Proc,'FD','livelock free'),[Proc]).
5567 % -csplivelock R
5568 % -csp_assertion "P [F= Q"
5569 recognised_option('-csp_assertion',check_csp_assertion(Assertion),[Assertion]).
5570 recognised_option('-csp_eval', eval_csp_expression(Expr),[Expr]).
5571 recognised_option('-get_csp_assertions_as_string',csp_get_assertions,[]).
5572
5573 recognised_option('-variable_coverage',csv_table_command(variable_coverage,[],[text_output],user_output),[]).
5574 recognised_option('-vacuity_check',vacuity_check,[]).
5575 recognised_option('-wd_check',cli_wd_check(_,_),[]).
5576 recognised_option('-wd_check_all',cli_wd_check(X,X),[]).
5577 recognised_option('-well_definedness_check',cli_wd_check(_,_),[]).
5578 recognised_option('-wd_inv_proof',cli_wd_inv_proof(_,_,_),[]).
5579 recognised_option('-lint',cli_lint,[]). % extended static check (ESC, esc)
5580 recognised_option('-lint_operations',cli_lint(operations),[]).
5581 recognised_option('-lint_variables',cli_lint(variables),[]).
5582 recognised_option('-cbc',constraint_based_check(OpName),[OpName]). % cbc invariant checking
5583 recognised_option('-cbc_invariant',constraint_based_check(OpName),[OpName]).
5584 recognised_option('-cbc_deadlock',cbc_deadlock_check(true),[]).
5585 recognised_option('-cbc_assertions',cbc_assertions(true,[]),[]).
5586 recognised_option('-cbc_main_assertions',cbc_assertions(true,[main_assertions]),[]).
5587 recognised_option('-cbc_assertions_proof',cbc_assertions(false,[]),[]). % do not allow enumeration warnings
5588 recognised_option('-cbc_assertions_tautology_proof',cbc_assertions(false,[tautology_check]),[]). % do not allow enumeration warnings + disregard PROPERTIES, used for Atelier-B proof/disproof; TO DO: also call WD prover
5589 recognised_option('-cbc_assertions_tautology_proof_check',cbc_assertions(false,[tautology_check,contradiction_check]),[]).
5590 recognised_option('-cbc_option',cbc_option(OPT),[OPT]). % should be tautology_check,contradiction_check, unsat_core
5591 recognised_option('-cbc_result_file',cbc_result_file(FILE),[FILE]). % write result to FILE
5592 recognised_option('-cbc_refinement',cbc_refinement,[]).
5593 recognised_option('-cbc_deadlock_pred',cbc_deadlock_check(GoalPred),[GoalPred]).
5594 recognised_option('-cbc_sequence',cbc_sequence(OpSequence,'',single_solution),[OpSequence]).
5595 recognised_option('-cbc_sequence_all',cbc_sequence(OpSequence,'',findall),[OpSequence]).
5596 recognised_option('-cbc_sequence_with_target',cbc_sequence(OpSequence,TargetPredString,single_solution),[OpSequence,TargetPredString]).
5597 recognised_option('-cbc_sequence_with_target_all',cbc_sequence(OpSequence,TargetPredString,findall),[OpSequence,TargetPredString]).
5598 recognised_option('-comment',comment(UserComment),[UserComment]). % not processed by tool, but will be stored in log-file and used by log_analyser
5599 recognised_option('-junit',junit(Dir),[Dir]).
5600 recognised_option('-mcm_cover', mcm_cover(Event),[Event]).
5601 recognised_option('-cbc_cover', cbc_cover(Event),[Event]).
5602 recognised_option('-cbc_cover_match', cbc_cover(match_event(Event)),[Event]). % find events which have Event String occuring somewhere in name
5603 recognised_option('-cbc_cover_all', cbc_cover_all,[]). % is now default if no cbc_cover provided
5604 recognised_option('-cbc_cover_final', cbc_cover_final,[]).
5605 recognised_option('-bmc', cbc_tests(Depth,'#not_invariant',''),[Depth]).
5606 recognised_option('-bdc', cbc_tests(Depth,'#deadlock',''),[Depth]).
5607 recognised_option('-enabling_analysis',enabling_analysis_csv(user_output),[]).
5608 recognised_option('-feasibility_analysis',feasibility_analysis_csv(1000,user_output),[]).
5609 recognised_option('-read_write_matrix',generate_read_write_matrix_csv(user_output),[]).
5610 recognised_option('-scc_trace',check_scc_for_ltl_formula(LtlFormula,SCC),[LtlFormula,SCC]).
5611 recognised_option('-selfcheck_module',selfcheck(M,[]),[M]).
5612 recognised_option('-mc_mode',depth_breadth_first_mode(M),[M]). % can be mixed, hash, heuristic
5613 recognised_option('-assertion',cli_check_assertions(specific(X),[false/0,unknown/0]),[X]).
5614 recognised_option('-cbc_assertion',cbc_assertions(true,[specific(X)]),[X]). % check only a specific assertion
5615 recognised_option('-symbolic_model_check', cli_symbolic_model_check(Algorithm), [Algorithm]).
5616 recognised_option('-ltsmin2',ltsmin2(EndpointPath), [EndpointPath]).
5617 recognised_option('-ltsmin_ltl_output',ltsmin_ltl_output(Path), [Path]).
5618 recognised_option('-ltsmin_option', ltsmin_option(X),[X]).
5619 recognised_option('-machine_hash_check',cli_print_machine_info(hash(X)),[X]).
5620 recognised_option('-install',install_prob_lib(X,[]),[X]).
5621 recognised_option('-install_dry_run',install_prob_lib(X,[dryrun]),[X]).
5622
5623
5624 recognised_option('-dot_all',dot_generate_for_all_formulas). % generate dot also for true formulas
5625 recognised_option('-animate_all',cli_random_animate(2147483647,false)).
5626 recognised_option('-execute_all',execute(2147483647,false,current_state(1))).
5627 recognised_option('-execute_all_inits',execute(2147483647,false,from_all_initial_states)).
5628 recognised_option('-animate_stats',animate_stats).
5629 recognised_option('-execute_monitor',execute_monitoring).
5630 recognised_option('-check_goal',check_goal).
5631 recognised_option('-ltlassertions',ltl_assertions).
5632 recognised_option('-assertions',cli_check_assertions(all,[false/0,unknown/0])).
5633 recognised_option('-main_assertions',cli_check_assertions(main,[false/0,unknown/0])).
5634 recognised_option('-properties',cli_check_properties).
5635 recognised_option('-properties_core',cli_core_properties(_)). % variable as arg: try various algorithms in order
5636 recognised_option('-properties_core_wd',cli_core_properties(wd_prover)).
5637 recognised_option('-properties_core_z2',cli_core_properties(z3_bup(2))).
5638 recognised_option('-properties_core_z3',cli_core_properties(z3_bup(3))).
5639 recognised_option('-selfcheck',selfcheck(_,[])).
5640 recognised_option('-pacheck',pa_check). % predicate analysis for Kodkod
5641 recognised_option('-det_check',det_check). % check if animation is deterministic
5642 recognised_option('-det_constants',det_constants_check). % check if animation for setup_constants is deterministic
5643 recognised_option('-bf',breadth_first).
5644 recognised_option('-breadth',breadth_first).
5645 recognised_option('-df',depth_first).
5646 recognised_option('-depth',depth_first).
5647 recognised_option('-strict',strict_raise_error).
5648 recognised_option('-silent',silent).
5649 recognised_option('-quiet',silent).
5650 recognised_option('-q',silent).
5651 recognised_option('-force_no_silent',force_no_silent). % override provided silent flag; useful for gitlab test debugging
5652 recognised_option('-statistics',cli_print_statistics(full)).
5653 recognised_option('-stats',cli_print_statistics(full)).
5654 recognised_option('-memory_stats',cli_print_statistics(memory)).
5655 recognised_option('-memory_statistics',cli_print_statistics(memory)).
5656 recognised_option('-memory',cli_print_statistics(memory)).
5657 recognised_option('-profile_stats',cli_print_statistics(sicstus_profile)).
5658 recognised_option('-profile_statistics',cli_print_statistics(sicstus_profile)).
5659 recognised_option('-op_cache_profile',cli_print_statistics(op_cache_profile)).
5660 recognised_option('-hit_profile',cli_print_statistics(hit_profile)). % mainly for ProB developers
5661 recognised_option('-reset_profile_statistics',reset_profiler). % mainly for use in REPL
5662 recognised_option('-nodead',no_deadlocks).
5663 recognised_option('-no_dead',no_deadlocks).
5664 recognised_option('-no_deadlocks',no_deadlocks).
5665 recognised_option('-noinv',no_invariant_violations).
5666 recognised_option('-no_inv',no_invariant_violations).
5667 recognised_option('-no_invariant_violations',no_invariant_violations).
5668 recognised_option('-nogoal',no_goal).
5669 recognised_option('-no_goal',no_goal).
5670 recognised_option('-noltl',no_ltl). % just used for TLC at the moment
5671 recognised_option('-no_ltl',no_ltl).
5672 recognised_option('-noass',no_assertion_violations).
5673 recognised_option('-no_ass',no_assertion_violations).
5674 recognised_option('-no_assertion_violations',no_assertion_violations).
5675 recognised_option('-no_state_errors',no_state_errors). % disable checking for general_errors and transition related state_errors
5676 recognised_option('-nocounter',no_counter_examples).
5677 recognised_option('-no_counter_examples',no_counter_examples).
5678 recognised_option('-nocolor',no_color).
5679 recognised_option('-no_color',no_color).
5680 recognised_option('-no_colour',no_color).
5681 recognised_option('-disable_time_out',set_preference_group(time_out,disable_time_out)).
5682 recognised_option('-disable_timeout',set_preference_group(time_out,disable_time_out)).
5683 %recognised_option('-POR',with_reduction).
5684 recognised_option('-i',animate).
5685 recognised_option('-repl',eval_repl([])). % used to be -eval
5686 recognised_option('-c',coverage(false)).
5687 recognised_option('-cs',coverage(just_summary)).
5688 recognised_option('-coverage',coverage(false)).
5689 recognised_option('-coverage_summary',coverage(just_summary)).
5690 recognised_option('-machine_stats',cli_print_machine_info(statistics)).
5691 recognised_option('-machine_statistics',cli_print_machine_info(statistics)).
5692 recognised_option('-machine_files',cli_print_machine_info(files(no_sha))).
5693 recognised_option('-machine_files_sha',cli_print_machine_info(files(with_sha))).
5694 recognised_option('-machine_hash',cli_print_machine_info(hash(_))).
5695 recognised_option('-check_abstract_constants',check_abstract_constants).
5696 recognised_option('-op_cache_stats',check_op_cache([])).
5697 recognised_option('-op_cache_statistics',check_op_cache([])).
5698 recognised_option('-cv',coverage(true)).
5699 recognised_option('-v',verbose(19)).
5700 recognised_option('-vv',verbose(5)).
5701 recognised_option('-vvv',verbose(1)).
5702 recognised_option('-verbose',verbose(19)).
5703 recognised_option('-debug',verbose(19)).
5704 recognised_option('-verbose_off',verbose_off). % mainly useful in REPL
5705 recognised_option('-voff',verbose_off). % mainly useful in REPL
5706 recognised_option('-very_verbose',verbose(5)).
5707 recognised_option('-gc_trace',set_gc_trace(verbose)).
5708 recognised_option('-gc_off',set_gc_on_off(off)).
5709 recognised_option('-gc_on',set_gc_on_off(on)).
5710 recognised_option('-profiling_on',profiling_on). % Prolog profiling
5711 recognised_option('-profile',cli_print_statistics(prob_profile)). % ProB Operation profiling
5712 recognised_option('-prob_profile',cli_print_statistics(prob_profile)). % ProB Operation profiling
5713 recognised_option('-prob_statistics',cli_print_statistics(prob_profile)). % synonym
5714 recognised_option('-prob_stats',cli_print_statistics(prob_profile)). % synonym
5715 recognised_option('-version',print_version(full)).
5716 recognised_option('-cpp_version',print_version(cpp)).
5717 recognised_option('-V',print_version(full)).
5718 recognised_option('-svers',print_version(short)).
5719 recognised_option('-short_version',print_version(short)).
5720 recognised_option('-check_lib',print_version(lib)).
5721 recognised_option('-check_java_version',check_java_version).
5722 recognised_option('-java_version',print_version(java)).
5723 recognised_option('-release_java_parser',release_java_parser).
5724 recognised_option('-fast_read_prob',fast_read_prob).
5725 recognised_option('-file_info',file_info).
5726 recognised_option('-t',default_trace_check).
5727 recognised_option('-init',initialise).
5728 recognised_option('-initialise',initialise).
5729 recognised_option('-ll',log('/tmp/prob_cli_debug.log',prolog)). % see cli_start_logging
5730 recognised_option('-ss',socket(9000,true)). % standard socket 9000
5731 recognised_option('-sf',socket(_,true)). % free socket
5732 recognised_option('-local_socketserver',socket(_,true)). % do not allow remote socket connections
5733 recognised_option('-remote_socketserver',socket(_,false)). % allow remote socket connections
5734 recognised_option('-help',help).
5735 recognised_option('-h',help).
5736 recognised_option('-rc',runtimechecking).
5737 recognised_option('-test_mode',test_mode).
5738 recognised_option('-check_complete',check_complete).
5739 recognised_option('-check_complete_operation_coverage', check_complete_operation_coverage).
5740 recognised_option('-mc_with_tlc', cli_start_mc_with_tlc).
5741 recognised_option('-mc_with_lts_sym', cli_start_sym_mc_with_lts(symbolic)).
5742 recognised_option('-mc_with_lts_seq', cli_start_sym_mc_with_lts(sequential)).
5743 recognised_option('-core',disprover_options([disprover_option(unsat_core),unsat_core_algorithm/linear])).
5744 recognised_option('-export_po',disprover_options([disprover_option(export_po_as_machine(user_output))])).
5745 recognised_option('-ltsmin',ltsmin).
5746 recognised_option('-trace',prolog_trace). % enter Prolog debugger on development system after starting up ProB
5747
5748 % some utilities to be able to call the above options directly from repl:
5749 :- public silent/0, coverage/1, help/0.
5750 % predicate to set_verbose_mode
5751 %verbose :- tcltk_turn_debugging_on(19).
5752 %very_verbose :- tcltk_turn_debugging_on(5).
5753 verbose(Nr) :- tcltk_turn_debugging_on(Nr),
5754 (Nr<10 -> set_gc_trace(verbose) ; true). % terse is another option for gc_trace
5755 verbose_off :- set_gc_trace(off), tcltk_turn_debugging_off.
5756 file_info :- file_loaded(true,MainFile), print_file_info(MainFile).
5757 coverage(ShowEnabledInfo) :- probcli_time_stamp(NOW), cli_show_coverage(ShowEnabledInfo,NOW).
5758
5759 % Governs global stack garbage collection trace messages
5760 set_gc_trace(X) :- member(X,[off,terse,verbose]),!,set_prolog_flag(gc_trace,X).
5761 set_gc_trace(X) :- add_error(prob_cli,'Illegal value for gc_trace:',X).
5762
5763 % At least Margin kilobytes of free global stack space are guaranteed to exist after a garbage collection
5764 set_gc_margin(Margin) :- set_prolog_flag(gc_margin,Margin).
5765 set_gc_on_off(OnOff) :- set_prolog_flag(gc,OnOff).
5766
5767 silent :- (option(silent) -> true ; assert_option(silent)).
5768 help :- eval_help.
5769 dot_command(DCommand,DotFile,DotEngine) :- call_dot_command_with_engine(DCommand,DotFile,[],DotEngine).
5770 dot_command_for_expr(DECommand,Expr,DotFile,Opts,DotEngine) :-
5771 call_dot_command_with_engine_for_expr(DECommand,Expr,DotFile,Opts,DotEngine).
5772
5773 plantuml_command(PCommand,UmlFile) :- call_plantuml_command(PCommand,UmlFile).
5774 plantuml_command_for_expr(PECommand,Expr,UmlFile,Opts) :-
5775 call_plantuml_command_for_expr(PECommand,Expr,UmlFile,Opts).
5776
5777 :- use_module(tools_io,[safe_intelligent_open_file/3]).
5778 csv_table_command(TCommand,Formulas,Options,CSVFile) :-
5779 append(Formulas,[TableResult],ActualArgs),
5780 OptionalArgs=[],
5781 format_with_colour_nl(user_output,[blue],'Calling table command ~w',[TCommand]),
5782 call_command(table,TCommand,_,ActualArgs,OptionalArgs),
5783 write_table_to_csv_file(CSVFile,Options,TableResult),
5784 format_with_colour_nl(user_output,[blue],'Finished exporting ~w to ~w',[TCommand,CSVFile]).
5785
5786
5787 save_state_space(StateFile) :- debug_println(20,'% Saving state space to file'),
5788 state_space:tcltk_save_state_space(StateFile).
5789 :- public load_state/1. % for REPL
5790 load_state(StateFile) :- debug_println(20,'% Loading state space from file'),
5791 state_space:tcltk_load_state(StateFile).
5792 :- public execute/3. % for REPL
5793 execute(ESteps,ErrOnDeadlock,From) :- cli_execute(ESteps,ErrOnDeadlock,From).
5794
5795 option_verbose :- option(verbose(_)).
5796 option_very_verbose :- debug_level_active_for(5).
5797
5798 set_random_seed_to_deterministic_start_seed :-
5799 % in test_mode we do not change the random number generator's initial seed
5800 true. %getrand(CurrState),setrand(CurrState). % this seems to be a no-op
5801
5802 :- if(predicate_property(set_random(_), _)).
5803 % SWI-Prolog's native API for reinitializing the RNG state.
5804 % The equivalent of this call is also performed automatically by SWI
5805 % when a random number is requested for the first time.
5806 set_new_random_seed :- set_random(seed(random)).
5807 :- else.
5808 % SICStus way of (re)initializing the RNG state.
5809 % Note that on SICStus, the initial RNG state after startup is always the same,
5810 % so it *must* be manually reinitialized like this to get actually random results!
5811 %:- use_module(library(random),[setrand/1]).
5812 set_new_random_seed :-
5813 now(TimeStamp), % getting the unix time
5814 setrand(TimeStamp). % setting new random seed by every execution of probcli
5815 :- endif.
5816
5817 halt_exception :- halt_exception(0).
5818 halt_exception(Code) :- throw(halt(Code)).
5819
5820 % -----------------
5821
5822 start_xml_feature(FeatureName,[CErrs1,CWarns1,CEErrs1]) :-
5823 debug_format(20,'% Starting ~w~n',[FeatureName]),
5824 get_counter(cli_errors,CErrs1), get_counter(cli_warnings,CWarns1), get_counter(cli_expected_errors,CEErrs1),
5825 start_xml_group_in_log(FeatureName).
5826
5827 start_xml_feature(FeatureName,Attr,Value,[CErrs1,CWarns1,CEErrs1]) :-
5828 debug_format(20,'% Starting ~w (~w=~w)~n',[FeatureName,Attr,Value]),
5829 get_counter(cli_errors,CErrs1), get_counter(cli_warnings,CWarns1), get_counter(cli_expected_errors,CEErrs1),
5830 start_xml_group_in_log(FeatureName,Attr,Value).
5831
5832 stop_xml_feature(FeatureName,[CErrs1,CWarns1,CEErrs1]) :-
5833 get_counter(cli_errors,CErrs2), get_counter(cli_warnings,CWarns2), get_counter(cli_expected_errors,CEErrs2),
5834 CErrs is CErrs2-CErrs1, CWarns is CWarns2-CWarns1, CEErrs is CEErrs2-CEErrs1,
5835 (CEErrs>0
5836 -> write_xml_element_to_log('probcli-errors',[errors/CErrs,warnings/CWarns,expected_errors/CEErrs])
5837 ; write_xml_element_to_log('probcli-errors',[errors/CErrs,warnings/CWarns])
5838 ),
5839 debug_format(20,'% Finished ~w (errors=~w, warnings=~w, expected_errors=~w)~n',[FeatureName,CErrs,CWarns,CEErrs]),
5840 stop_xml_group_in_log(FeatureName),
5841 !.
5842 stop_xml_feature(FeatureName,L) :-
5843 add_internal_error('Illegal or failed call:',stop_xml_feature(FeatureName,L)).
5844
5845 %(CErrs>0 -> (file_loaded(_,MainFile) -> true ; MainFile=unknown), Time=unknown, % TO DO: determine time
5846 % create_and_print_junit_result(['Feature',MainFile], FeatureName, Time, error) ; true).
5847 % Note: call stop_xml_group_in_log if the feature stops unexpectedly and you do not have the Info list available
5848
5849 % -----------------
5850
5851 :- public user:runtime_entry/1.
5852 user:runtime_entry(start) :- go_cli.
5853
5854 %save :- save_program('probcli.sav').
5855
5856 :- use_module(eventhandling,[announce_event/1]).
5857 :- announce_event(compile_prob).