controller_itp.ml 45.5 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
13
open Wstdlib
Clément Fumex's avatar
Clément Fumex committed
14 15
open Session_itp

Sylvain Dailler's avatar
Sylvain Dailler committed
16 17 18 19
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
20
let debug_call_prover = Debug.lookup_flag "call_prover"
21 22
let default_delay_ms = 100 (* 0.1 seconds *)

Clément Fumex's avatar
Clément Fumex committed
23 24
(** State of a proof *)
type proof_attempt_status =
25
  | Undone   (** prover was never called *)
26 27 28
  | Scheduled (** external proof attempt is scheduled *)
  | Running (** external proof attempt is in progress *)
  | Done of Call_provers.prover_result (** external proof done *)
29 30
  | Interrupted (** external proof has never completed *)
  | Detached (** parent goal has no task, is detached *)
31 32
  | InternalFailure of exn (** external proof aborted by internal error *)
  | Uninstalled of Whyconf.prover (** prover is uninstalled *)
33
  | UpgradeProver of Whyconf.prover (** prover is upgraded *)
34
  | Removed of Whyconf.prover (** prover has been removed or upgraded *)
Clément Fumex's avatar
Clément Fumex committed
35

MARCHE Claude's avatar
MARCHE Claude committed
36 37
let print_status fmt st =
  match st with
38
  | Undone            -> fprintf fmt "Undone"
Sylvain Dailler's avatar
Sylvain Dailler committed
39 40 41 42
  | Scheduled         -> fprintf fmt "Scheduled"
  | Running           -> fprintf fmt "Running"
  | Done r            ->
      fprintf fmt "Done(%a)" Call_provers.print_prover_result r
43 44
  | Interrupted       -> fprintf fmt "Interrupted"
  | Detached          -> fprintf fmt "Detached"
Sylvain Dailler's avatar
Sylvain Dailler committed
45 46 47 48
  | InternalFailure e ->
      fprintf fmt "InternalFailure(%a)" Exn_printer.exn_printer e
  | Uninstalled pr    ->
      fprintf fmt "Prover %a is uninstalled" Whyconf.print_prover pr
49 50
  | UpgradeProver pr    ->
      fprintf fmt "Prover upgrade to %a" Whyconf.print_prover pr
51 52
  | Removed pr    ->
      fprintf fmt "Prover %a removed" Whyconf.print_prover pr
MARCHE Claude's avatar
MARCHE Claude committed
53 54

type transformation_status =
55
  | TSscheduled | TSdone of transID | TSfailed of (proofNodeID * exn)
56 57 58 59

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

63 64 65 66
type strategy_status = STSgoto of proofNodeID * int | STShalt

let print_strategy_status fmt st =
  match st with
Sylvain Dailler's avatar
Sylvain Dailler committed
67 68
  | STSgoto(id,n) ->
      fprintf fmt "goto step %d in proofNode %a" n print_proofNodeID id
69 70 71
  | STShalt -> fprintf fmt "halt"


72
type controller =
Sylvain Dailler's avatar
Sylvain Dailler committed
73
  { mutable controller_session: Session_itp.session;
74
    mutable controller_config : Whyconf.config;
MARCHE Claude's avatar
MARCHE Claude committed
75
    mutable controller_env: Env.env;
Sylvain Dailler's avatar
Sylvain Dailler committed
76 77
    controller_provers:
      (Whyconf.config_prover * Driver.driver) Whyconf.Hprover.t;
78
    controller_strategies : (string * string * string * Strategy.instruction array) Hstr.t;
79
    controller_running_proof_attempts : unit Hpan.t;
80 81
  }

82 83 84 85 86
let session_max_tasks = ref 1

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

88 89 90
let set_session_prover_upgrade_policy c p u =
  c.controller_config <- Whyconf.set_prover_upgrade_policy c.controller_config p u

MARCHE Claude's avatar
MARCHE Claude committed
91 92 93
let load_drivers c =
  let env = c.controller_env in
  let config = c.controller_config in
94 95 96 97
  let provers = Whyconf.get_provers config in
  Whyconf.Mprover.iter
    (fun _ p ->
     try
98
       let d = Whyconf.load_driver (Whyconf.get_main config) env p.Whyconf.driver [] in
99 100
       Whyconf.Hprover.add c.controller_provers p.Whyconf.prover (p,d)
     with e ->
Sylvain Dailler's avatar
Sylvain Dailler committed
101
       Debug.dprintf debug_call_prover
102 103 104
         "[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
105 106 107 108 109 110 111 112 113
    provers

let create_controller config env ses =
  let c =
    {
      controller_session = ses;
      controller_config = config;
      controller_env = env;
      controller_provers = Whyconf.Hprover.create 7;
114
      controller_strategies = Hstr.create 7;
MARCHE Claude's avatar
MARCHE Claude committed
115 116 117 118
      controller_running_proof_attempts = Hpan.create 17;
    }
  in
  load_drivers c;
119 120
  c

121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141

(* 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
142

143 144 145
(* Get children of any without proofattempts *)
let get_undetached_children_no_pa s any : any list =
  match any with
146
  | AFile f -> List.map (fun th -> ATh th) (file_theories f)
147 148 149
  | 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
150
  | APa _ -> []
151

152 153


154 155 156 157 158 159 160 161 162 163
(* printing *)

module PSession = struct

  type any =
    | Session
    | File of file
    | Theory of theory
    | Goal of proofNodeID
    | Transf of transID
164
    | ProofAttempt of proof_attempt_node
165 166 167 168 169 170 171 172 173 174

  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 ->
175
       (file_name f),
176
       List.fold_right (fun th -> n (Theory th)) (file_theories f) []
177 178 179
    | Theory th ->
       let id = theory_name th in
       let name = id.Ident.id_string in
180
       let name = if th_proved s th then name^"!" else name^"?" in
181
       name,
Sylvain Dailler's avatar
Sylvain Dailler committed
182 183 184
       List.fold_right
         (fun g -> n (Goal g))
         (theory_goals th)
MARCHE Claude's avatar
MARCHE Claude committed
185
         []
186 187 188
    | Goal id ->
       let gid = get_proof_name s id in
       let name = gid.Ident.id_string in
189
       let name = if pn_proved s id then name^"!" else name^"?" in
190 191 192 193 194 195 196
       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
197 198 199 200 201
          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 ""), []
202 203
    | Transf id ->
       let name = get_transf_name s id in
204
       let name = if tn_proved s id then name^"!" else name^"?" in
205 206
       let sts = get_sub_tasks s id in
       name,
MARCHE Claude's avatar
MARCHE Claude committed
207
       List.fold_right (fun g -> n (Goal g)) sts []
208 209 210 211 212 213 214 215 216 217 218 219

end

module P = Print_tree.PMake(PSession)

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

(*********)



220 221 222 223 224 225

(** 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 *)

226
let reload_files (c : controller) ~use_shapes =
227
  let old_ses = c.controller_session in
MARCHE Claude's avatar
MARCHE Claude committed
228
  c.controller_env <- Env.create_env (Env.get_loadpath c.controller_env);
MARCHE Claude's avatar
MARCHE Claude committed
229 230
  Whyconf.Hprover.reset c.controller_provers;
  load_drivers c;
231
  c.controller_session <- empty_session ~from:old_ses (get_dir old_ses);
232 233 234 235 236 237 238 239 240
  merge_files ~use_shapes c.controller_env c.controller_session old_ses

exception Errors_list of exn list

let reload_files (c: controller) ~use_shapes =
  let errors, b1, b2 = reload_files c ~use_shapes in
  match errors with
  | [] -> b1, b2
  | _ -> raise (Errors_list errors)
241 242

let add_file c ?format fname =
243 244 245
  let file_is_detached,theories,errors =
    try false,(Session_itp.read_file c.controller_env ?format fname), None
    with e -> true,[], Some e
246
  in
247
  let (_ : file) = add_file_section c.controller_session fname ~file_is_detached theories format in
248
  errors
249

250 251 252 253 254
let add_file c ?format fname =
  let errors = add_file c ?format fname in
  match errors with
  | None -> ()
  | Some error -> raise (Errors_list [error])
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
  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
353
  if ansnew <> Call_provers.Timeout && group_answer ansold = group_answer ansnew &&
354 355 356 357 358
       tnew >= told *. 0.9 -. 0.1 && tnew <= told *. 1.1 +. 0.1
  then { nres with Call_provers.pr_time = told }
  else nres


359
let build_prover_call ?proof_script 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
    try
      let call =
372
        Driver.prove_task ?old:proof_script ~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;

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 =
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
      | Call_provers.ProverFinished res ->
442 443
          (* res is meaningless for edition, we returned the old result *)
          (* inform the callback *)
444
          callback (match ores with None -> Done res | Some r -> Done r)
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
        let (c,id,pr,limit,proof_script,callback,ores) =
458
          Queue.pop scheduled_proof_attempts in
459
        try
460
          build_prover_call ?proof_script 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
    let (_c,_id,_pr,_limit,_proof_script,callback,_ores) =
485
      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 ~limit ~callback ~notification =
498 499
  let ses = c.controller_session in
  let callback panid s =
500 501
    begin
      match s with
502
      | UpgradeProver _ | Removed _ -> ()
503 504 505 506 507 508 509 510
      | 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
511 512
      | Interrupted
      | InternalFailure _ ->
513 514 515 516 517
         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
518 519
      | Detached -> assert false
      | Uninstalled _ -> assert false
520
      | Undone -> assert false
521
    end;
522 523 524
    callback panid s
  in
  let adaptlimit,ores,proof_script =
525
    try
526
      let h = get_proof_attempt_ids ses id in
527
      let pa = Hprover.find h pr in
528
      let a = get_proof_attempt_node ses pa in
529 530 531 532 533
      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
534 535 536
      let script =
        if save_to = None then
          Opt.map (fun s ->
537 538
                            Debug.dprintf debug_sched "Script file = %s@." s;
                            Filename.concat (get_dir ses) s) a.proof_script
539 540
        else
          save_to
541 542
      in
      limit, old_res, script
543
    with Not_found | Session_itp.BadID -> limit,None,save_to
544
  in
545
  let panid = graft_proof_attempt ~limit ses id pr in
546
  Queue.add (c,id,pr,adaptlimit,proof_script,callback panid,ores)
547
            scheduled_proof_attempts;
548
  callback panid Scheduled;
MARCHE Claude's avatar
MARCHE Claude committed
549
  run_timeout_handler ()
Clément Fumex's avatar
Clément Fumex committed
550

551

552 553


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

Sylvain Dailler's avatar
Sylvain Dailler committed
556 557 558
(* 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
559
  let driver = snd (Hprover.find c.controller_provers pr) in
560
  let task = Session_itp.get_task session pn in
Sylvain Dailler's avatar
Sylvain Dailler committed
561 562 563 564
  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
565
  let fn = Filename.chop_extension (Filename.basename (file_name f)) in
Sylvain Dailler's avatar
Sylvain Dailler committed
566 567 568 569 570 571
  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

572
let prepare_edition c ?file pn pr ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
573
  let session = c.controller_session in
574 575 576
  let proof_attempts_id = get_proof_attempt_ids session pn in
  let panid =
    try
577 578 579 580 581 582 583 584 585 586 587 588 589 590
      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
591
    with Not_found ->
592 593 594 595
      let file = match file with
        | Some f -> f
        | None -> create_file_rel_path c pr pn
      in
596 597
      let limit = Call_provers.empty_limit in
      graft_proof_attempt session pn pr ~file ~limit
Sylvain Dailler's avatar
Sylvain Dailler committed
598
  in
599
  update_goal_node notification session pn;
600 601
  let pa = get_proof_attempt_node session panid in
  let file = Opt.get pa.proof_script in
602
  let old_res = pa.proof_state in
603
  let session_dir = Session_itp.get_dir session in
Sylvain Dailler's avatar
Sylvain Dailler committed
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
  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
619
  let task = Session_itp.get_task session pn in
620
  let driver = snd (Hprover.find c.controller_provers pr) in
621
  Driver.print_task ?old driver fmt task;
Sylvain Dailler's avatar
Sylvain Dailler committed
622 623
  Opt.iter close_in old;
  close_out ch;
624
  panid,file,old_res
Sylvain Dailler's avatar
Sylvain Dailler committed
625 626 627

exception Editor_not_found

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

674 675
exception TransAlreadyExists of string * string

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

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

712 713 714

open Strategy

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

Sylvain Dailler's avatar
Sylvain Dailler committed
771 772
let schedule_pa_with_same_arguments
    c (pa: proof_attempt_node) (pn: proofNodeID) ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
773 774 775 776
  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
777 778
let schedule_tr_with_same_arguments
    c (tr: transID) (pn: proofNodeID) ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
779 780 781
  let s = c.controller_session in
  let args = get_transf_args s tr in
  let name = get_transf_name s tr in
782
  let callback = callback name args in
783

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

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

793

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

796
  (* clean should not change proved status *)
797 798 799
  let notification any =
    Format.eprintf "Cleaning error: cleaning attempts to change status of node %a@." fprintf_any any
  in
800
  let s = c.controller_session in
801
  (* This function is applied on leafs first for the case of removes *)
802
  let clean_aux () any =
803 804 805 806 807 808
    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)
809
      | ATn tn ->
810 811 812 813 814 815
         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
816 817 818 819 820 821 822
  in

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

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

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

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


885 886
let copy_paste ~notification ~callback_pa ~callback_tr c from_any to_any =
  let s = c.controller_session in
887 888
  if is_below s to_any from_any then
    raise BadCopyPaste;
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
  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
905 906 907 908 909 910 911 912





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


913
let debug_replay = Debug.register_flag "replay" ~desc:"Debug@ info@ for@ replay"
MARCHE Claude's avatar
MARCHE Claude committed
914

915
let find_prover notification c goal_id pr =
916
  if Hprover.mem c.controller_provers pr then `Found pr else
917
   match Whyconf.get_prover_upgrade_policy c.controller_config pr with
918 919
   | exception Not_found -> `Keep
   | Whyconf.CPU_keep -> `Keep
920 921 922
   | 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
923
      then (* yes, then we remove the attempt *)
924
        `Keep (* `Remove *) (* we keep it for now, because it prevents replay to terminate properly *)
925 926 927 928
      else
        begin
          (* we modify the prover in-place *)
          Session_itp.change_prover notification c.controller_session goal_id pr new_pr;
929
          `Found new_pr
930
        end
931 932
   | Whyconf.CPU_remove -> `Remove
   | Whyconf.CPU_duplicate _ (* _new_pr *) ->
933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
      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
953 954
  | `Keep -> callback id (Uninstalled pr)
  | `Remove ->
955 956 957
     (* it is necessary to call the callback before effectively removing the node, otherwise, a bad id will be used in the callback *)
      callback id (Removed pr);
      remove_proof_attempt c.controller_session parid pr
958
  | `Found pr' ->
959 960
     try
       if pr' <> pr then callback id (UpgradeProver pr');
961
       let _ = get_task c.controller_session parid in
962
       schedule_proof_attempt ?save_to:None c parid pr' ~limit ~callback ~notification
963 964 965 966 967
     with Not_found ->
       callback id Detached



968 969 970 971
type report =
  | Result of Call_provers.prover_result * Call_provers.prover_result
  (** Result(new_result,old_result) *)
  | CallFailed of exn
972
  | Replay_interrupted
973 974 975 976 977 978 979 980 981 982 983
  | 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
984 985 986 987
  | CallFailed e ->
    Format.fprintf fmt "Callfailed %a@." Exn_printer.exn_printer e
  | Replay_interrupted ->
    Format.fprintf fmt "Interrupted@."
988 989 990 991 992 993 994 995 996
  | 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 *)
997
let replay_print fmt (lr: (proofNodeID * Whyconf.prover * Call_provers.resource_limit * report) list) =
998 999
  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
1000 1001
      (Obj.magic id) Whyconf.print_prover pr
      rl.Call_provers.limit_time print_report report
1002
  in
1003
  Format.fprintf fmt "%a@." (Pp.print_list Pp.newline pp_elem) lr
1004

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

1008 1009 1010 1011 1012 1013
  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 =
1014
    match s with
1015
    | UpgradeProver _ | Removed _ -> found_upgraded_prover := true
1016
    (* this is certainly wrong: after removed, there will be no more 'Done' notification, so counter should be decreased *)
1017
    | Scheduled | Running -> ()
1018
    | Undone | Interrupted ->
1019
       decr count;
1020
       report := (id, pr, limits, Replay_interrupted ) :: !report
1021
    | Done new_r ->
1022
       decr count;
1023
        (match pa.Session_itp.proof_state with
1024 1025
        | None -> (report := (id, pr, limits, No_former_result new_r) :: !report)
        | Some old_r -> report := (id, pr, limits, Result (new_r, old_r)) :: !report)
1026
    | InternalFailure e ->
1027
       decr count;
1028
       report := (id, pr, limits, CallFailed (e)) :: !report
1029 1030
    | Uninstalled _ ->
       decr count;
1031
       report := (id, pr, limits, Prover_not_installed) :: !report;
1032
    | Detached -> decr count
1033
  in
1034

1035
  let need_replay id pa =
1036 1037
    filter pa &&
      (pa.proof_obsolete || not obsolete_only) &&
1038 1039 1040 1041
        (* When on a single proofattempt node, we want to always replay even non
           valid proofattempts.
        *)
        (any = Some (APa id) || not valid_only ||
1042 1043 1044
           match pa.Session_itp.proof_state with
           | None -> false
           | Some pr -> Call_provers.(pr.pr_answer = Valid))
1045 1046
  in

1047 1048 1049

  (* 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
1050 1051 1052
  (match any with
  | None ->
      Session_itp.session_iter_proof_attempt
1053
        (fun paid pa -> if need_replay paid pa then incr count) session
Sylvain Dailler's avatar
Sylvain Dailler committed
1054 1055
  | Some nid ->
      Session_itp.any_iter_proof_attempt session
1056
        (fun paid pa -> if need_replay paid pa then incr count) nid);
1057 1058

  (* Replaying function *)
1059
  let replay_pa id pa =
1060 1061 1062 1063
    let is_need_replay = need_replay id pa in
    Debug.dprintf debug_replay "Need_replay is set to %b for prover %a@."
      is_need_replay Whyconf.print_prover pa.prover;
    if is_need_replay then
1064 1065 1066
      begin
        let parid = pa.parent in
        let pr = pa.prover in
1067 1068 1069 1070
        (* 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 *)
1071 1072 1073 1074 1075 1076
        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
1077
        replay_proof_attempt c pr limit parid id
1078
                             ~callback:(fun id s ->
1079
                                        craft_report s parid pr limit pa;
1080
                                        callback id s;
1081 1082
                                        if !count = 0 then
                                          final_callback !found_upgraded_prover !report)
1083 1084
                             ~notification
      end in
1085

1086
  if !count