MAJ terminée. Nous sommes passés en version 14.6.2 . Pour consulter les "releases notes" associées c'est ici :

https://about.gitlab.com/releases/2022/01/11/security-release-gitlab-14-6-2-released/
https://about.gitlab.com/releases/2022/01/04/gitlab-14-6-1-released/

controller_itp.ml 44.4 KB
Newer Older
1
2
3
(********************************************************************)
(*                                                                  *)
(*  The Why3 Verification Platform   /   The Why3 Development Team  *)
Guillaume Melquiond's avatar
Guillaume Melquiond committed
4
(*  Copyright 2010-2018   --   Inria - CNRS - Paris-Sud University  *)
5
6
7
8
9
10
11
(*                                                                  *)
(*  This software is distributed under the terms of the GNU Lesser  *)
(*  General Public License version 2.1, with the special exception  *)
(*  on linking described in file LICENSE.                           *)
(*                                                                  *)
(********************************************************************)

12
open Format
Clément Fumex's avatar
Clément Fumex committed
13
14
open Session_itp

Sylvain Dailler's avatar
Sylvain Dailler committed
15
16
17
18
let debug_sched = Debug.register_info_flag "scheduler"
  ~desc:"Print@ debugging@ messages@ about@ scheduling@ of@ prover@ calls@ \
         and@ transformation@ applications."

Sylvain Dailler's avatar
Sylvain Dailler committed
19
let debug_call_prover = Debug.lookup_flag "call_prover"
20
21
let default_delay_ms = 100 (* 0.1 seconds *)

Sylvain Dailler's avatar
Sylvain Dailler committed
22

23
24
exception Noprogress

25
26
27
let () = Exn_printer.register
    (fun fmt e ->
      match e with
Sylvain Dailler's avatar
Sylvain Dailler committed
28
29
      | Noprogress ->
          Format.fprintf fmt "The transformation made no progress.\n"
30
31
      | _ -> raise e)

Clément Fumex's avatar
Clément Fumex committed
32
33
(** State of a proof *)
type proof_attempt_status =
34
  | Undone   (** prover was never called *)
35
36
37
  | Scheduled (** external proof attempt is scheduled *)
  | Running (** external proof attempt is in progress *)
  | Done of Call_provers.prover_result (** external proof done *)
38
39
  | Interrupted (** external proof has never completed *)
  | Detached (** parent goal has no task, is detached *)
40
41
  | InternalFailure of exn (** external proof aborted by internal error *)
  | Uninstalled of Whyconf.prover (** prover is uninstalled *)
42
  | UpgradeProver of Whyconf.prover (** prover is upgraded *)
Clément Fumex's avatar
Clément Fumex committed
43

MARCHE Claude's avatar
MARCHE Claude committed
44
45
let print_status fmt st =
  match st with
46
  | Undone            -> fprintf fmt "Undone"
Sylvain Dailler's avatar
Sylvain Dailler committed
47
48
49
50
  | Scheduled         -> fprintf fmt "Scheduled"
  | Running           -> fprintf fmt "Running"
  | Done r            ->
      fprintf fmt "Done(%a)" Call_provers.print_prover_result r
51
52
  | Interrupted       -> fprintf fmt "Interrupted"
  | Detached          -> fprintf fmt "Detached"
Sylvain Dailler's avatar
Sylvain Dailler committed
53
54
55
56
  | InternalFailure e ->
      fprintf fmt "InternalFailure(%a)" Exn_printer.exn_printer e
  | Uninstalled pr    ->
      fprintf fmt "Prover %a is uninstalled" Whyconf.print_prover pr
57
58
  | UpgradeProver pr    ->
      fprintf fmt "Prover upgrade to %a" Whyconf.print_prover pr
MARCHE Claude's avatar
MARCHE Claude committed
59
60

type transformation_status =
61
  | TSscheduled | TSdone of transID | TSfailed of (proofNodeID * exn)
62
63
64
65

let print_trans_status fmt st =
  match st with
  | TSscheduled -> fprintf fmt "TScheduled"
MARCHE Claude's avatar
MARCHE Claude committed
66
  | TSdone _tid -> fprintf fmt "TSdone" (* TODO print tid *)
67
  | TSfailed _e -> fprintf fmt "TSfailed"
Clément Fumex's avatar
Clément Fumex committed
68

MARCHE Claude's avatar
MARCHE Claude committed
69
70
71
72
type strategy_status = STSgoto of proofNodeID * int | STShalt

let print_strategy_status fmt st =
  match st with
Sylvain Dailler's avatar
Sylvain Dailler committed
73
74
  | STSgoto(id,n) ->
      fprintf fmt "goto step %d in proofNode %a" n print_proofNodeID id
MARCHE Claude's avatar
MARCHE Claude committed
75
76
77
  | STShalt -> fprintf fmt "halt"


78
type controller =
Sylvain Dailler's avatar
Sylvain Dailler committed
79
  { mutable controller_session: Session_itp.session;
80
    controller_config : Whyconf.config;
MARCHE Claude's avatar
MARCHE Claude committed
81
    mutable controller_env: Env.env;
Sylvain Dailler's avatar
Sylvain Dailler committed
82
83
    controller_provers:
      (Whyconf.config_prover * Driver.driver) Whyconf.Hprover.t;
MARCHE Claude's avatar
MARCHE Claude committed
84
    controller_strategies : (string * string * string * Strategy.instruction array) Stdlib.Hstr.t;
85
    controller_running_proof_attempts : unit Hpan.t;
86
87
  }

88
89
90
91
92
let session_max_tasks = ref 1

let set_session_max_tasks n =
  session_max_tasks := n;
  Prove_client.set_max_running_provers n
93

MARCHE Claude's avatar
MARCHE Claude committed
94
95
96
let load_drivers c =
  let env = c.controller_env in
  let config = c.controller_config in
97
98
99
100
  let provers = Whyconf.get_provers config in
  Whyconf.Mprover.iter
    (fun _ p ->
     try
MARCHE Claude's avatar
MARCHE Claude committed
101
       let d = Whyconf.load_driver (Whyconf.get_main config) env p.Whyconf.driver [] in
102
103
       Whyconf.Hprover.add c.controller_provers p.Whyconf.prover (p,d)
     with e ->
Sylvain Dailler's avatar
Sylvain Dailler committed
104
       Debug.dprintf debug_call_prover
105
106
107
         "[Controller_itp] error while loading driver for prover %a: %a@."
         Whyconf.print_prover p.Whyconf.prover
         Exn_printer.exn_printer e)
MARCHE Claude's avatar
MARCHE Claude committed
108
109
110
111
112
113
114
115
116
117
118
119
120
121
    provers

let create_controller config env ses =
  let c =
    {
      controller_session = ses;
      controller_config = config;
      controller_env = env;
      controller_provers = Whyconf.Hprover.create 7;
      controller_strategies = Stdlib.Hstr.create 7;
      controller_running_proof_attempts = Hpan.create 17;
    }
  in
  load_drivers c;
122
123
  c

124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

(* Cannot remove a proof_attempt that was scheduled but did not finish yet.
   It can be interrupted though. *)
let removable_proof_attempt c pa =
  try let () = Hpan.find c.controller_running_proof_attempts pa in false
  with Not_found -> true

let any_removable c any =
  match any with
  | APa pa -> removable_proof_attempt c pa
  | _ -> true

(* Check whether the subtree [n] contains an unremovable proof_attempt
   (ie: scheduled or running) *)
let check_removable c (n: any) =
  fold_all_any c.controller_session (fun acc any -> acc && any_removable c any) true n


let remove_subtree ~(notification:notifier) ~(removed:notifier) c (n: any) =
  if check_removable c n then
    Session_itp.remove_subtree ~notification ~removed c.controller_session n
145

146
147
148
(* Get children of any without proofattempts *)
let get_undetached_children_no_pa s any : any list =
  match any with
149
  | AFile f -> List.map (fun th -> ATh th) (file_theories f)
150
151
152
  | ATh th  -> List.map (fun g -> APn g) (theory_goals th)
  | ATn tn  -> List.map (fun pn -> APn pn) (get_sub_tasks s tn)
  | APn pn  -> List.map (fun tn -> ATn tn) (get_transformations s pn)
Sylvain Dailler's avatar
Sylvain Dailler committed
153
  | APa _ -> []
154

155
156


157
158
159
160
161
162
163
164
165
166
167
168
(* printing *)

module PSession = struct

  open Stdlib

  type any =
    | Session
    | File of file
    | Theory of theory
    | Goal of proofNodeID
    | Transf of transID
169
    | ProofAttempt of proof_attempt_node
170
171
172
173
174
175
176
177
178
179

  type 'a t = { tcont : controller;
                tkind : any }

  let decomp x =
    let s = x.tcont.controller_session in
    let n y acc = { x with tkind = y } :: acc in
    match x.tkind with
    | Session -> "", Hstr.fold (fun _ f -> n (File f)) (get_files s) []
    | File f ->
180
       (file_name f),
181
       List.fold_right (fun th -> n (Theory th)) (file_theories f) []
182
183
184
    | Theory th ->
       let id = theory_name th in
       let name = id.Ident.id_string in
185
       let name = if th_proved s th then name^"!" else name^"?" in
186
       name,
Sylvain Dailler's avatar
Sylvain Dailler committed
187
188
189
       List.fold_right
         (fun g -> n (Goal g))
         (theory_goals th)
MARCHE Claude's avatar
MARCHE Claude committed
190
         []
191
192
193
    | Goal id ->
       let gid = get_proof_name s id in
       let name = gid.Ident.id_string in
194
       let name = if pn_proved s id then name^"!" else name^"?" in
195
196
197
198
199
200
201
       let pas = get_proof_attempts s id in
       let trs = get_transformations s id in
       name,
       List.fold_right (fun g -> n (Transf g)) trs
                       (List.fold_right (fun g -> n (ProofAttempt g)) pas [])
    | ProofAttempt pa ->
       Pp.sprintf_wnl "%a%s%s"
Sylvain Dailler's avatar
Sylvain Dailler committed
202
203
204
205
206
          Whyconf.print_prover pa.prover
          (match pa.Session_itp.proof_state with
          | Some { Call_provers.pr_answer = Call_provers.Valid} -> ""
          | _ -> "?")
          (if pa.proof_obsolete then "O" else ""), []
207
208
    | Transf id ->
       let name = get_transf_name s id in
209
       let name = if tn_proved s id then name^"!" else name^"?" in
210
211
       let sts = get_sub_tasks s id in
       name,
MARCHE Claude's avatar
MARCHE Claude committed
212
       List.fold_right (fun g -> n (Goal g)) sts []
213
214
215
216
217
218
219
220
221
222
223
224

end

module P = Print_tree.PMake(PSession)

let print_session fmt c =
  P.print fmt { PSession.tcont = c; PSession.tkind = PSession.Session }

(*********)



225
226
227
228
229
230

(** reload files, associating old proof attempts and transformations
    to the new goals.  old theories and old goals for which we cannot
    find a corresponding new theory resp. old goal are kept, with
    tasks associated to them *)

231
let reload_files (c : controller) ~use_shapes =
232
  let old_ses = c.controller_session in
MARCHE Claude's avatar
MARCHE Claude committed
233
  c.controller_env <- Env.create_env (Env.get_loadpath c.controller_env);
MARCHE Claude's avatar
MARCHE Claude committed
234
235
  Whyconf.Hprover.reset c.controller_provers;
  load_drivers c;
236
  c.controller_session <- empty_session ~from:old_ses (get_dir old_ses);
MARCHE Claude's avatar
MARCHE Claude committed
237
238
(*  try
 *)
239
    merge_files ~use_shapes c.controller_env c.controller_session old_ses
MARCHE Claude's avatar
MARCHE Claude committed
240
(* not need_anymore
241
242
243
  with e ->
    c.controller_session <- old_ses;
    raise e
MARCHE Claude's avatar
MARCHE Claude committed
244
 *)
245
246

let add_file c ?format fname =
247
248
249
250
251
252
  let theories,errors =
    try Some (Session_itp.read_file c.controller_env ?format fname), None
    with e -> None, Some e
  in
  let (_ : file) = add_file_section c.controller_session fname theories format in
  errors
253

254

255
256

module type Scheduler = sig
257
  val blocking: bool
258
  val multiplier: int
259
260
261
262
  val timeout: ms:int -> (unit -> bool) -> unit
  val idle: prio:int -> (unit -> bool) -> unit
end

263
264
module Make(S : Scheduler) = struct

MARCHE Claude's avatar
MARCHE Claude committed
265
266
let scheduled_proof_attempts = Queue.create ()

267
268
269
270
271
272
let prover_tasks_in_progress = Hashtbl.create 17

(* We need to separate tasks that are edited from proofattempt in progress
   because we are not using why3server for the edited proofs and timeout_handler
   rely on a loop on why3server's results. *)
let prover_tasks_edited = Queue.create ()
MARCHE Claude's avatar
MARCHE Claude committed
273
274
275

let timeout_handler_running = ref false

276

MARCHE Claude's avatar
MARCHE Claude committed
277
let number_of_running_provers = ref 0
278

279
280
281
282
let observer = ref (fun _ _ _ -> ())

let register_observer = (:=) observer

283
module Hprover = Whyconf.Hprover
MARCHE Claude's avatar
MARCHE Claude committed
284

285
286
287
288
289
290
291
292
293
294
295
296
297
(* calling provers, with limits adaptation

 *)


(* to avoid corner cases when prover results are obtained very closely
   to the time or mem limits, we adapt these limits when we replay a
   proof *)

let adapt_limits ~interactive ~use_steps limits a =
  let t, m, s =
    let timelimit = limits.Call_provers.limit_time in
    let memlimit = limits.Call_provers.limit_mem in
298
    let steplimit = limits.Call_provers.limit_steps in
299
300
301
302
303
304
305
306
    match a.proof_state with
    | Some { Call_provers.pr_answer = r;
             Call_provers.pr_time = t;
             Call_provers.pr_steps = s } ->
       (* increased time limit is 1 + twice the previous running time,
       but enforced to remain inside the interval [l,2l] where l is
       the previous time limit *)
       let t = truncate (1.0 +. 2.0 *. t) in
307
       let increased_time = if interactive then 0
308
309
310
311
312
                            else max timelimit (min t (2 * timelimit)) in
       (* increased mem limit is just 1.5 times the previous mem limit *)
       let increased_mem = if interactive then 0 else 3 * memlimit / 2 in
       begin
         match r with
313
314
         | Call_provers.OutOfMemory -> increased_time, memlimit, steplimit
         | Call_provers.Timeout -> timelimit, increased_mem, steplimit
315
316
         | Call_provers.Valid ->
            let steplimit =
317
318
319
320
321
322
323
324
325
              if use_steps && not a.proof_obsolete then
                (* We need to allow at least one more step than what was used to
                   prove the same statement. Otherwise, the prover run out of
                   steps: this happens with cvc4 on some very fast proofs
                   (steps = 28).
                *)
                s + 1
              else
                0
326
327
328
329
            in
            increased_time, increased_mem, steplimit
         | Call_provers.Unknown _
         | Call_provers.StepLimitExceeded
330
         | Call_provers.Invalid -> increased_time, increased_mem, steplimit
331
332
333
         | Call_provers.Failure _
         | Call_provers.HighFailure ->
            (* correct ? failures are supposed to appear quickly anyway... *)
334
            timelimit, memlimit, steplimit
335
336
       end
    | None when interactive -> 0, 0, 0
337
    | None -> timelimit, memlimit, steplimit
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
  in
  { Call_provers.limit_time = t; limit_mem = m; limit_steps = s }

let group_answer a =
  match a with
  | Call_provers.OutOfMemory
  | Call_provers.Unknown _
  | Call_provers.Timeout -> Call_provers.Timeout
  | _ -> a

let fuzzy_proof_time nres ores =
  let ansold = ores.Call_provers.pr_answer in
  let told = ores.Call_provers.pr_time in
  let ansnew = nres.Call_provers.pr_answer in
  let tnew = nres.Call_provers.pr_time in
  if group_answer ansold = group_answer ansnew &&
       tnew >= told *. 0.9 -. 0.1 && tnew <= told *. 1.1 +. 0.1
  then { nres with Call_provers.pr_time = told }
  else nres


let build_prover_call ?proof_script ~cntexample c id pr limit callback ores =
360
  let (config_pr,driver) = Hprover.find c.controller_provers pr in
361
  let with_steps = Call_provers.(limit.limit_steps <> empty_limit.limit_steps) in
362
  let command =
363
    Whyconf.get_complete_command config_pr ~with_steps in
364
  try
365
    let task = Session_itp.get_task c.controller_session id in
366
367
368
    Debug.dprintf debug_sched "[build_prover_call] Script file = %a@."
                  (Pp.print_option Pp.string) proof_script;
    let inplace = config_pr.Whyconf.in_place in
369
    let interactive = config_pr.Whyconf.interactive in
370
371
372
    try
      let call =
        Driver.prove_task ?old:proof_script ~cntexample:cntexample ~inplace ~command
373
                          ~limit ~interactive driver task
374
375
376
377
378
      in
      let pa = (c.controller_session,id,pr,callback,false,call,ores) in
      Hashtbl.replace prover_tasks_in_progress call pa
    with Sys_error _ as e ->
      callback (InternalFailure e)
379
380
  with Not_found (* goal has no task, it is detached *) ->
       callback Detached
MARCHE Claude's avatar
MARCHE Claude committed
381

382
383
let update_observer () =
  let scheduled = Queue.length scheduled_proof_attempts in
384
  let waiting_or_running = Hashtbl.length prover_tasks_in_progress in
385
386
387
  let running = !number_of_running_provers in
  !observer scheduled (waiting_or_running - running) running

MARCHE Claude's avatar
MARCHE Claude committed
388
389
let timeout_handler () =
  (* examine all the prover tasks in progress *)
390
391
392
  (* When no tasks are there, probably no tasks were scheduled and the server
     was not launched so getting results could fail. *)
  if Hashtbl.length prover_tasks_in_progress != 0 then begin
393
    let results = Call_provers.get_new_results ~blocking:S.blocking in
394
395
396
397
    List.iter (fun (call, prover_update) ->
      match Hashtbl.find prover_tasks_in_progress call with
      | (ses,id,pr,callback,started,call,ores) ->
        begin match prover_update with
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
        | Call_provers.NoUpdates -> ()
        | Call_provers.ProverStarted ->
            assert (not started);
            callback Running;
            incr number_of_running_provers;
            Hashtbl.replace prover_tasks_in_progress call
              (ses,id,pr,callback,true,call,ores)
        | Call_provers.ProverFinished res ->
            Hashtbl.remove prover_tasks_in_progress call;
            if started then decr number_of_running_provers;
            let res = Opt.fold fuzzy_proof_time res ores in
            (* inform the callback *)
            callback (Done res)
        | Call_provers.ProverInterrupted ->
            Hashtbl.remove prover_tasks_in_progress call;
            if started then decr number_of_running_provers;
            (* inform the callback *)
            callback (Interrupted)
        | Call_provers.InternalFailure exn ->
            Hashtbl.remove prover_tasks_in_progress call;
            if started then decr number_of_running_provers;
            (* inform the callback *)
            callback (InternalFailure (exn))
421
422
423
424
425
426
        end
      | exception Not_found -> ()
        (* We probably received ProverStarted after ProverFinished,
           because what is sent to and received from the server is
           not ordered. *)
    ) results;
427
428
  end;

Sylvain Dailler's avatar
Sylvain Dailler committed
429
430
431
432
433
434
435
  (* When blocking is activated, we are in script mode and we don't want editors
     to be launched so we don't need to go in this loop. *)
  if not S.blocking then begin
    (* Check for editor calls which are not finished *)
    let q = Queue.create () in
    while not (Queue.is_empty prover_tasks_edited) do
      (* call is an EditorCall *)
436
      let (callback,call,ores) as c =
Sylvain Dailler's avatar
Sylvain Dailler committed
437
438
439
440
        Queue.pop prover_tasks_edited in
      let prover_update = Call_provers.query_call call in
      match prover_update with
      | Call_provers.NoUpdates -> Queue.add c q
441
442
443
444
      | Call_provers.ProverFinished _res ->
          (* res is meaningless for edition, we returned the old result *)
          (* inform the callback *)
          callback (match ores with None -> Undone | Some r -> Done r)
Sylvain Dailler's avatar
Sylvain Dailler committed
445
446
447
448
      | _ -> assert (false) (* An edition can only return Noupdates or finished *)
    done;
    Queue.transfer q prover_tasks_edited;
  end;
449
450

  (* if the number of prover tasks is less than S.multiplier times the maximum
MARCHE Claude's avatar
MARCHE Claude committed
451
452
     number of running provers, then we heuristically decide to add
     more tasks *)
453
454
  begin
    try
455
      for _i = Hashtbl.length prover_tasks_in_progress
456
          to S.multiplier * !session_max_tasks do
457
458
        let (c,id,pr,limit,proof_script,callback,cntexample,ores) =
          Queue.pop scheduled_proof_attempts in
459
        try
460
          build_prover_call ?proof_script ~cntexample c id pr limit callback ores
461
462
463
464
465
        with e when not (Debug.test_flag Debug.stack_trace) ->
          callback (InternalFailure e)
      done
  with Queue.Empty -> ()
  end;
466
  update_observer ();
467
  true
MARCHE Claude's avatar
MARCHE Claude committed
468

469
let interrupt () =
470
471
472
473
474
475
476
  (* Interrupt provers *)
  Hashtbl.iter (fun _k e ->
    let (_, _, _, callback, _, _, _) = e in callback Interrupted)
    prover_tasks_in_progress;
  Hashtbl.clear prover_tasks_in_progress;
  (* Do not interrupt editors
  while not (Queue.is_empty prover_tasks_edited) do
477
    let (_ses,_id,_pr,callback,_started,_call,_ores) =
478
      Queue.pop prover_tasks_edited in
479
480
    callback Interrupted
  done;
481
  *)
482
483
  number_of_running_provers := 0;
  while not (Queue.is_empty scheduled_proof_attempts) do
484
485
    let (_c,_id,_pr,_limit,_proof_script,callback,_cntexample,_ores) =
      Queue.pop scheduled_proof_attempts in
486
487
488
489
    callback Interrupted
  done;
  !observer 0 0 0

MARCHE Claude's avatar
MARCHE Claude committed
490
491
492
493
let run_timeout_handler () =
  if not !timeout_handler_running then
    begin
      timeout_handler_running := true;
494
      S.timeout ~ms:default_delay_ms timeout_handler;
MARCHE Claude's avatar
MARCHE Claude committed
495
496
    end

497
let schedule_proof_attempt c id pr ?save_to
498
499
500
                           ~counterexmp ~limit ~callback ~notification =
  let ses = c.controller_session in
  let callback panid s =
501
502
    begin
      match s with
503
      | UpgradeProver _ -> ()
504
505
506
507
508
509
510
511
      | Scheduled ->
         Hpan.add c.controller_running_proof_attempts panid ();
         update_goal_node notification ses id
      | Running -> update_goal_node notification ses id
      | Done res ->
         Hpan.remove c.controller_running_proof_attempts panid;
         update_proof_attempt ~obsolete:false notification ses id pr res;
         update_goal_node notification ses id
512
513
      | Interrupted
      | InternalFailure _ ->
514
515
516
517
518
         Hpan.remove c.controller_running_proof_attempts panid;
         (* what to do ?
         update_proof_attempt ~obsolete:false notification ses id pr res;
          *)
         update_goal_node notification ses id
519
520
      | Detached -> assert false
      | Uninstalled _ -> assert false
521
      | Undone -> assert false
522
    end;
523
524
525
    callback panid s
  in
  let adaptlimit,ores,proof_script =
526
    try
527
      let h = get_proof_attempt_ids ses id in
528
      let pa = Hprover.find h pr in
529
      let a = get_proof_attempt_node ses pa in
530
531
532
533
534
      let old_res = a.proof_state in
      let config_pr,_ = Hprover.find c.controller_provers pr in
      let interactive = config_pr.Whyconf.interactive in
      let use_steps = Call_provers.(limit.limit_steps <> empty_limit.limit_steps) in
      let limit = adapt_limits ~interactive ~use_steps limit a in
535
536
537
      let script =
        if save_to = None then
          Opt.map (fun s ->
538
539
                            Debug.dprintf debug_sched "Script file = %s@." s;
                            Filename.concat (get_dir ses) s) a.proof_script
540
541
        else
          save_to
542
543
      in
      limit, old_res, script
544
    with Not_found | Session_itp.BadID -> limit,None,save_to
545
  in
546
  let panid = graft_proof_attempt ~limit ses id pr in
547
  Queue.add (c,id,pr,adaptlimit,proof_script,callback panid,counterexmp,ores)
548
            scheduled_proof_attempts;
549
  callback panid Scheduled;
MARCHE Claude's avatar
MARCHE Claude committed
550
  run_timeout_handler ()
Clément Fumex's avatar
Clément Fumex committed
551

552

553
554


555
556
(*** { 2 edition of proof scripts} *)

Sylvain Dailler's avatar
Sylvain Dailler committed
557
558
559
(* create the path to a file for saving the external proof script *)
let create_file_rel_path c pr pn =
  let session = c.controller_session in
560
  let driver = snd (Hprover.find c.controller_provers pr) in
561
  let task = Session_itp.get_task session pn in
Sylvain Dailler's avatar
Sylvain Dailler committed
562
563
564
565
  let session_dir = Session_itp.get_dir session in
  let th = get_encapsulating_theory session (APn pn) in
  let th_name = (Session_itp.theory_name th).Ident.id_string in
  let f = get_encapsulating_file session (ATh th) in
MARCHE Claude's avatar
MARCHE Claude committed
566
  let fn = Filename.chop_extension (Filename.basename (file_name f)) in
Sylvain Dailler's avatar
Sylvain Dailler committed
567
568
569
570
571
572
  let file = Driver.file_of_task driver fn th_name task in
  let file = Filename.concat session_dir file in
  let file = Sysutil.uniquify file in
  let file = Sysutil.relativize_filename session_dir file in
  file

573
let prepare_edition c ?file pn pr ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
574
  let session = c.controller_session in
575
576
577
  let proof_attempts_id = get_proof_attempt_ids session pn in
  let panid =
    try
578
579
580
581
582
583
584
585
586
587
588
589
590
591
      let panid = Hprover.find proof_attempts_id pr in
      (* if no proof script yet, we need to add one
         it happens e.g when editing a file for an automatic prover
       *)
      let pa = get_proof_attempt_node session panid in
      match pa.proof_script with
      | None ->
         let file = match file with
           | Some f -> f
           | None -> create_file_rel_path c pr pn
         in
         set_proof_script pa file;
         panid
      | Some _ -> panid
592
    with Not_found ->
593
594
595
596
      let file = match file with
        | Some f -> f
        | None -> create_file_rel_path c pr pn
      in
597
598
      let limit = Call_provers.empty_limit in
      graft_proof_attempt session pn pr ~file ~limit
Sylvain Dailler's avatar
Sylvain Dailler committed
599
  in
600
  update_goal_node notification session pn;
601
602
  let pa = get_proof_attempt_node session panid in
  let file = Opt.get pa.proof_script in
603
  let old_res = pa.proof_state in
604
  let session_dir = Session_itp.get_dir session in
Sylvain Dailler's avatar
Sylvain Dailler committed
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
  let file = Filename.concat session_dir file in
  let old =
    if Sys.file_exists file
    then
      begin
        let backup = file ^ ".bak" in
        if Sys.file_exists backup
        then Sys.remove backup;
        Sys.rename file backup;
        Some(open_in backup)
      end
    else None
  in
  let ch = open_out file in
  let fmt = formatter_of_out_channel ch in
620
  let task = Session_itp.get_task session pn in
621
  let driver = snd (Hprover.find c.controller_provers pr) in
Sylvain Dailler's avatar
Sylvain Dailler committed
622
623
624
  Driver.print_task ~cntexample:false ?old driver fmt task;
  Opt.iter close_in old;
  close_out ch;
625
  panid,file,old_res
Sylvain Dailler's avatar
Sylvain Dailler committed
626
627
628

exception Editor_not_found

629
let schedule_edition c id pr ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
630
631
632
633
  Debug.dprintf debug_sched "[Sched] Scheduling an edition@.";
  let config = c.controller_config in
  let session = c.controller_session in
  let prover_conf = Whyconf.get_prover_config config pr in
634
  (* Make sure editor exists. Fails otherwise *)
Sylvain Dailler's avatar
Sylvain Dailler committed
635
636
  let editor =
    match prover_conf.Whyconf.editor with
637
    | "" -> Whyconf.(default_editor (get_main config))
Sylvain Dailler's avatar
Sylvain Dailler committed
638
    | s ->
639
640
641
642
643
       try
         let ed = Whyconf.editor_by_id config s in
         String.concat " " (ed.Whyconf.editor_command ::
                              ed.Whyconf.editor_options)
       with Not_found -> raise Editor_not_found
Sylvain Dailler's avatar
Sylvain Dailler committed
644
  in
645
  let panid,file,old_res = prepare_edition c id pr ~notification in
646
  (* Notification node *)
647
648
649
  let callback panid s =
    begin
      match s with
650
      | UpgradeProver _ -> ()
651
      | Running -> ()
652
653
      | Done res ->
         (* set obsolete to true since we do not know if the manual
654
            proof was completed or not *)
655
656
657
658
659
         Debug.dprintf debug_sched
                       "Setting status of %a under parent %a to obsolete@."
                       print_proofAttemptID panid print_proofNodeID id;
         update_proof_attempt ~obsolete:true notification session id pr res;
         update_goal_node notification session id
660
661
662
663
      | Interrupted
      | InternalFailure _ ->
         update_goal_node notification session id
      | Undone | Detached | Uninstalled _ | Scheduled -> assert false
664
665
    end;
    callback panid s
666
  in
Sylvain Dailler's avatar
Sylvain Dailler committed
667
  Debug.dprintf debug_sched "[Editing] goal %s with command '%s' on file %s@."
668
669
                (Session_itp.get_proof_name session id).Ident.id_string
                editor file;
670
671
  let call = Call_provers.call_editor ~command:editor file in
  callback panid Running;
672
  Queue.add (callback panid,call,old_res) prover_tasks_edited;
673
  run_timeout_handler ()
674

675
676
exception TransAlreadyExists of string * string

677
678
(*** { 2 transformations} *)

679
680
681
682
683
684
685
686
687
let schedule_transformation c id name args ~callback ~notification =
  let callback s =
    begin match s with
          | TSdone tid -> update_trans_node notification c.controller_session tid
          | TSscheduled
          | TSfailed _ -> ()
    end;
    callback s
  in
688
  let apply_trans () =
MARCHE Claude's avatar
MARCHE Claude committed
689
690
    begin
      try
691
692
693
        let subtasks =
          apply_trans_to_goal ~allow_no_effect:false
                              c.controller_session c.controller_env name args id
694
        in
695
696
697
698
699
700
        let tid = graft_transf c.controller_session id name args subtasks in
        callback (TSdone tid)
      with
      | Exit ->
         (* if result is same as input task, consider it as a failure *)
         callback (TSfailed (id, Noprogress))
701
      | e when not (Debug.test_flag Debug.stack_trace) ->
702
          (* "@[Exception raised in Session_itp.apply_trans_to_goal %s:@ %a@.@]"
703
          name Exn_printer.exn_printer e; TODO *)
704
        callback (TSfailed (id, e))
MARCHE Claude's avatar
MARCHE Claude committed
705
706
    end;
    false
707
  in
708
709
  if Session_itp.check_if_already_exists c.controller_session id name args then
    raise (TransAlreadyExists (name, List.fold_left (fun acc s -> s ^ " " ^ acc) "" args));
710
711
  S.idle ~prio:0 apply_trans;
  callback TSscheduled
Clément Fumex's avatar
Clément Fumex committed
712

MARCHE Claude's avatar
MARCHE Claude committed
713
714
715

open Strategy

Sylvain Dailler's avatar
Sylvain Dailler committed
716
let run_strategy_on_goal
717
    c id strat ~counterexmp ~callback_pa ~callback_tr ~callback ~notification =
MARCHE Claude's avatar
MARCHE Claude committed
718
719
720
721
722
723
  let rec exec_strategy pc strat g =
    if pc < 0 || pc >= Array.length strat then
      callback STShalt
    else
      match Array.get strat pc with
      | Icall_prover(p,timelimit,memlimit) ->
MARCHE Claude's avatar
MARCHE Claude committed
724
725
         let callback panid res =
           callback_pa panid res;
MARCHE Claude's avatar
MARCHE Claude committed
726
           match res with
727
           | UpgradeProver _ | Scheduled | Running -> (* nothing to do yet *) ()
MARCHE Claude's avatar
MARCHE Claude committed
728
729
730
           | Done { Call_provers.pr_answer = Call_provers.Valid } ->
              (* proof succeeded, nothing more to do *)
              callback STShalt
731
732
           | Interrupted | InternalFailure _ ->
              callback STShalt
MARCHE Claude's avatar
MARCHE Claude committed
733
734
735
736
737
           | Done _ ->
              (* proof did not succeed, goto to next step *)
              callback (STSgoto (g,pc+1));
              let run_next () = exec_strategy (pc+1) strat g; false in
              S.idle ~prio:0 run_next
738
           | Undone | Detached | Uninstalled _ ->
MARCHE Claude's avatar
MARCHE Claude committed
739
740
741
742
743
744
                         (* should not happen *)
                         assert false
         in
         let limit = { Call_provers.empty_limit with
                       Call_provers.limit_time = timelimit;
                       limit_mem  = memlimit} in
745
         schedule_proof_attempt c g p ?save_to:None ~counterexmp ~limit ~callback ~notification
MARCHE Claude's avatar
MARCHE Claude committed
746
747
      | Itransform(trname,pcsuccess) ->
         let callback ntr =
748
           callback_tr trname [] ntr;
MARCHE Claude's avatar
MARCHE Claude committed
749
           match ntr with
750
           | TSfailed _e -> (* transformation failed *)
MARCHE Claude's avatar
MARCHE Claude committed
751
752
753
754
755
756
757
758
759
760
761
762
              callback (STSgoto (g,pc+1));
              let run_next () = exec_strategy (pc+1) strat g; false in
              S.idle ~prio:0 run_next
           | TSscheduled -> ()
           | TSdone tid ->
              List.iter
                (fun g ->
                 callback (STSgoto (g,pcsuccess));
                 let run_next () =
                   exec_strategy pcsuccess strat g; false
                 in
                 S.idle ~prio:0 run_next)
MARCHE Claude's avatar
MARCHE Claude committed
763
                (get_sub_tasks c.controller_session tid)
MARCHE Claude's avatar
MARCHE Claude committed
764
         in
765
         schedule_transformation c g trname [] ~callback ~notification
MARCHE Claude's avatar
MARCHE Claude committed
766
767
768
769
770
771
      | Igoto pc ->
         callback (STSgoto (g,pc));
         exec_strategy pc strat g
  in
  exec_strategy 0 strat id

Sylvain Dailler's avatar
Sylvain Dailler committed
772
773
let schedule_pa_with_same_arguments
    c (pa: proof_attempt_node) (pn: proofNodeID) ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
774
775
776
777
  let prover = pa.prover in
  let limit = pa.limit in
  schedule_proof_attempt c pn prover ~limit ~callback ~notification

Sylvain Dailler's avatar
Sylvain Dailler committed
778
779
let schedule_tr_with_same_arguments
    c (tr: transID) (pn: proofNodeID) ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
780
781
782
  let s = c.controller_session in
  let args = get_transf_args s tr in
  let name = get_transf_name s tr in
783
  let callback = callback name args in
784

Sylvain Dailler's avatar
Sylvain Dailler committed
785
786
  schedule_transformation c pn name args ~callback ~notification

MARCHE Claude's avatar
MARCHE Claude committed
787
788
789
790
791
let proof_is_complete pa =
  match pa.Session_itp.proof_state with
  | None -> false
  | Some pr ->
     not pa.Session_itp.proof_obsolete &&
792
       Call_provers.(pr.pr_answer = Valid)
MARCHE Claude's avatar
MARCHE Claude committed
793

794

Sylvain Dailler's avatar
Sylvain Dailler committed
795
let clean c ~removed nid =
796

797
  (* clean should not change proved status *)
798
799
800
  let notification any =
    Format.eprintf "Cleaning error: cleaning attempts to change status of node %a@." fprintf_any any
  in
801
  let s = c.controller_session in
802
  (* This function is applied on leafs first for the case of removes *)
803
  let clean_aux () any =
804
805
806
807
808
809
    let do_remove =
      Session_itp.is_detached s any ||
      match any with
      | APa pa ->
         let pa = Session_itp.get_proof_attempt_node s pa in
         pn_proved s pa.parent && not (proof_is_complete pa)
810
      | ATn tn ->
811
812
813
814
815
816
         let pn = get_trans_parent s tn in
         pn_proved s pn && not (tn_proved s tn)
      | _ -> false
    in
    if do_remove then
      remove_subtree ~notification ~removed c any
817
818
819
820
821
822
823
  in

  match nid with
  | Some nid ->
      Session_itp.fold_all_any s clean_aux () nid
  | None ->
      Session_itp.fold_all_session s clean_aux ()
824

825
826
(* This function folds on any subelements of given node and tries to mark all
   proof attempts it encounters *)
827
let mark_as_obsolete ~notification c any =
828
  let s = c.controller_session in
829
  (* Case for proof attempt only *)
830
  let mark_as_obsolete_pa n =
831
832
    let parent = get_proof_attempt_parent s n in
    Session_itp.mark_obsolete s n;
833
    notification (APa n);
834
    update_goal_node notification s parent
835
  in
836
837
838
839
840
841
842
843
844
845
  match any with
  | Some any ->
      fold_all_any s
        (fun () any -> match any with
        | APa n -> mark_as_obsolete_pa n
        | _ -> ()) () any
  | None ->
      session_iter_proof_attempt
        (fun pa _pan ->
          mark_as_obsolete_pa pa) s
846

Sylvain Dailler's avatar
Sylvain Dailler committed
847
848
849
exception BadCopyPaste

(* Reproduce the transformation made on node on an other one *)
850
let rec copy_rec ~notification ~callback_pa ~callback_tr c from_any to_any =
Sylvain Dailler's avatar
Sylvain Dailler committed
851
  let s = c.controller_session in
852
853
  match from_any, to_any with
(*
Sylvain Dailler's avatar
Sylvain Dailler committed
854
855
856
857
    | AFile _, AFile _ ->
        raise BadCopyPaste
    | ATh _from_th, ATh _to_th ->
        raise BadCopyPaste
858
 *)
Sylvain Dailler's avatar
Sylvain Dailler committed
859
860
    | APn from_pn, APn to_pn ->
      let from_pa_list = get_proof_attempts s from_pn in
861
      List.iter (fun x -> schedule_pa_with_same_arguments ?save_to:None c x to_pn ~counterexmp:false
Sylvain Dailler's avatar
Sylvain Dailler committed
862
863
          ~callback:callback_pa ~notification) from_pa_list;
      let from_tr_list = get_transformations s from_pn in
864
      let callback x tr args st = callback_tr tr args st;
Sylvain Dailler's avatar
Sylvain Dailler committed
865
        match st with
Sylvain Dailler's avatar
Sylvain Dailler committed
866
        | TSdone tid ->
867
          copy_rec c (ATn x) (ATn tid) ~notification ~callback_pa ~callback_tr
Sylvain Dailler's avatar
Sylvain Dailler committed
868
869
870
871
872
873
874
        | _ -> ()
      in
      List.iter (fun x -> schedule_tr_with_same_arguments c x to_pn
          ~callback:(callback x) ~notification) from_tr_list
    | ATn from_tn, ATn to_tn ->
        let from_tn_list = get_sub_tasks s from_tn in
        let to_tn_list = get_sub_tasks s to_tn in
875
876
877
878
879
880
881
882
        let rec iter_copy l1 l2 =
          match l1,l2 with
          | x::r1, y::r2 ->
             copy_rec c (APn x) (APn y)
                      ~notification ~callback_pa ~callback_tr;
             iter_copy r1 r2
          | _ -> ()
        in iter_copy from_tn_list to_tn_list
Sylvain Dailler's avatar
Sylvain Dailler committed
883
884
885
    | _ -> raise BadCopyPaste


886
887
let copy_paste ~notification ~callback_pa ~callback_tr c from_any to_any =
  let s = c.controller_session in
888
889
  if is_below s to_any from_any then
    raise BadCopyPaste;
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
  match from_any, to_any with
  | APn _, APn _ ->
     copy_rec ~notification ~callback_pa ~callback_tr c from_any to_any
  | ATn from_tn, APn to_pn ->
     let callback tr args st =
       callback_tr tr args st;
       match st with
       | TSdone tid ->
          copy_rec c (ATn from_tn) (ATn tid) ~notification ~callback_pa ~callback_tr
       | _ -> ()
     in
     schedule_tr_with_same_arguments c from_tn to_pn ~callback ~notification
  | _ -> raise BadCopyPaste



MARCHE Claude's avatar
MARCHE Claude committed
906
907
908
909
910
911
912
913
914





(***************** {2 replay} ****************)



915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
let find_prover notification c goal_id pr =
  if Hprover.mem c.controller_provers pr then Some pr else
   match Whyconf.get_prover_upgrade_policy c.controller_config pr with
   | exception Not_found -> None
   | Whyconf.CPU_keep -> None
   | Whyconf.CPU_upgrade new_pr ->
      (* does a proof using new_pr already exists ? *)
      if Hprover.mem (get_proof_attempt_ids c.controller_session goal_id) new_pr
      then (* yes, then we do nothing *)
        None
      else
        begin
          (* we modify the prover in-place *)
          Session_itp.change_prover notification c.controller_session goal_id pr new_pr;
          Some new_pr
        end
   | Whyconf.CPU_duplicate _new_pr ->
      assert false (* TODO *)
(*
      (* does a proof using new_p already exists ? *)
      if Hprover.mem (goal_external_proofs parid) new_pr
      then (* yes, then we do nothing *)
        None
      else
        begin
          (* we duplicate the proof_attempt *)
          let new_a = copy_external_proof
                        ~notify ~keygen:O.create ~prover:new_p ~env_session:eS a
          in
          Some new_pr
        end
*)

let replay_proof_attempt c pr limit (parid: proofNodeID) id ~callback ~notification =
  (* The replay can be done on a different machine so we need
     to check more things before giving the attempt to the scheduler *)
  match find_prover notification c parid pr with
  | None -> callback id (Uninstalled pr)
  | Some pr' ->
     try
       if pr' <> pr then callback id (UpgradeProver pr');
956
       let _ = get_task c.controller_session parid in
957
       schedule_proof_attempt ?save_to:None c parid pr' ~counterexmp:false ~limit ~callback ~notification
958
959
960
961
962
     with Not_found ->
       callback id Detached



963
964
965
966
type report =
  | Result of Call_provers.prover_result * Call_provers.prover_result
  (** Result(new_result,old_result) *)
  | CallFailed of exn
967
  | Replay_interrupted
968
969
970
971
972
973
974
975
976
977
978
  | Prover_not_installed
  | Edited_file_absent of string
  | No_former_result of Call_provers.prover_result

(* TODO find a better way to print it *)
let print_report fmt (r: report) =
  match r with
  | Result (new_r, old_r) ->
    Format.fprintf fmt "new_result = %a, old_result = %a@."
      Call_provers.print_prover_result new_r
      Call_provers.print_prover_result old_r
979
980
981
982
  | CallFailed e ->
    Format.fprintf fmt "Callfailed %a@." Exn_printer.exn_printer e
  | Replay_interrupted ->
    Format.fprintf fmt "Interrupted@."
983
984
985
986
987
988
989
990
991
  | Prover_not_installed ->
    Format.fprintf fmt "Prover not installed@."
  | Edited_file_absent _ ->
    Format.fprintf fmt "No edited file@."
  | No_former_result new_r ->
    Format.fprintf fmt "new_result = %a, no former result@."
      Call_provers.print_prover_result new_r

(* TODO to be removed when we have a better way to print *)
992
let replay_print fmt (lr: (proofNodeID * Whyconf.prover * Call_provers.resource_limit * report) list) =
993
994
  let pp_elem fmt (id, pr, rl, report) =
    fprintf fmt "ProofNodeID: %d, Prover: %a, Timelimit?: %d, Result: %a@."
Sylvain Dailler's avatar
Sylvain Dailler committed
995
996
      (Obj.magic id) Whyconf.print_prover pr
      rl.Call_provers.limit_time print_report report
997
  in
998
  Format.fprintf fmt "%a@." (Pp.print_list Pp.newline pp_elem) lr
999

1000
let replay ~valid_only ~obsolete_only ?(use_steps=false) ?(filter=fun _ -> true)
Sylvain Dailler's avatar
Sylvain Dailler committed
1001
           c ~callback ~notification ~final_callback ~any =
1002

1003
1004
1005
1006
1007
1008
  let session = c.controller_session in
  let count = ref 0 in
  let report = ref [] in
  let found_upgraded_prover = ref false in

  let craft_report s id pr limits pa =
1009
    match s with
1010
1011
    | UpgradeProver _ -> found_upgraded_prover := true
    | Scheduled | Running -> ()
1012
    | Undone | Interrupted ->
1013
       decr count;
1014
       report := (id, pr, limits, Replay_interrupted ) :: !report
1015
    | Done new_r ->
1016
       decr count;
1017
        (match pa.Session_itp.proof_state with
1018
1019
        | None -> (report := (id, pr, limits, No_former_result new_r) :: !report)
        | Some old_r -> report := (id, pr, limits, Result (new_r, old_r)) :: !report)
1020
    | InternalFailure e ->
1021
       decr count;
1022
       report := (id, pr, limits, CallFailed (e)) :: !report
1023
1024
    | Uninstalled _ ->
       decr count;
1025
       report := (id, pr, limits, Prover_not_installed) :: !report;
1026
    | Detached -> decr count
1027
  in
1028

1029
  let need_replay pa =
1030
1031
1032
1033
1034
1035
    filter pa &&
      (pa.proof_obsolete || not obsolete_only) &&
        (not valid_only ||
           match pa.Session_itp.proof_state with
           | None -> false
           | Some pr -> Call_provers.(pr.pr_answer = Valid))
1036
1037
  in

1038
1039
1040

  (* TODO count the number of node in a more efficient way *)
  (* Counting the number of proof_attempt to print report only once *)
Sylvain Dailler's avatar
Sylvain Dailler committed
1041
1042
1043
  (match any with
  | None ->
      Session_itp.session_iter_proof_attempt
1044
        (fun _ pa -> if need_replay pa then incr count) session
Sylvain Dailler's avatar
Sylvain Dailler committed
1045
1046
  | Some nid ->
      Session_itp.any_iter_proof_attempt session
1047
        (fun _ pa -> if need_replay pa then incr count) nid);
1048
1049

  (* Replaying function *)
1050
  let replay_pa id pa =
1051
    if need_replay pa then
1052
1053
1054
      begin
        let parid = pa.parent in
        let pr = pa.prover in
1055
1056
1057
1058
        (* TODO: if pr is not installed, lookup for a replacement policy
         OR: delegate this work to the replay_proof_attempt function *)
        (* If use_steps, we give only steps as a limit
         TODO: steps should not be used if prover was replaced above *)
1059
1060
1061
1062
1063
1064
        let limit =
          if use_steps then
            Call_provers.{empty_limit with limit_steps = pa.limit.limit_steps}
          else
            Call_provers.{ pa.limit with limit_steps = empty_limit.limit_steps }
        in
1065
        replay_proof_attempt c pr limit parid id
1066
                             ~callback:(fun id s ->
1067
                                        craft_report s parid pr limit pa;
1068
                                        callback id s;