controller_itp.ml 46.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) ~shape_version =
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
  merge_files ~shape_version c.controller_env c.controller_session old_ses
233 234 235

exception Errors_list of exn list

236 237
let reload_files (c: controller) ~shape_version =
  let errors, b1, b2 = reload_files c ~shape_version in
238 239 240
  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

Sylvain Dailler's avatar
Sylvain Dailler committed
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
(* type for scheduled proof attempts *)
type sched_pa_rec =
  { spa_contr    : controller;
    spa_id       : proofNodeID;
    spa_pr       : Whyconf.prover;
    spa_limit    : Call_provers.resource_limit;
    spa_pr_scr   : string option;
    spa_callback : (proof_attempt_status -> unit);
    spa_ores     : Call_provers.prover_result option;
  }

let scheduled_proof_attempts : sched_pa_rec Queue.t = Queue.create ()

(* type for prover tasks in progress *)
type tasks_prog_rec =
  {
    tp_session  : Session_itp.session;
    tp_id       : proofNodeID;
    tp_pr       : Whyconf.prover;
    tp_callback : (proof_attempt_status -> unit);
    tp_started  : bool;
    tp_call     : Call_provers.prover_call;
    tp_ores     : Call_provers.prover_result option;
  }
MARCHE Claude's avatar
MARCHE Claude committed
289

Sylvain Dailler's avatar
Sylvain Dailler committed
290 291 292
let prover_tasks_in_progress :
    (Call_provers.prover_call,tasks_prog_rec) Hashtbl.t =
  Hashtbl.create 17
293 294 295 296 297

(* 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
298 299 300

let timeout_handler_running = ref false

301

MARCHE Claude's avatar
MARCHE Claude committed
302
let number_of_running_provers = ref 0
303

304 305 306 307
let observer = ref (fun _ _ _ -> ())

let register_observer = (:=) observer

308
module Hprover = Whyconf.Hprover
MARCHE Claude's avatar
MARCHE Claude committed
309

Sylvain Dailler's avatar
Sylvain Dailler committed
310
(* calling provers, with limits adaptation *)
311 312 313 314 315 316 317 318 319 320


(* 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
321
    let steplimit = limits.Call_provers.limit_steps in
322 323 324 325 326 327 328 329
    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
330
       let increased_time = if interactive then 0
331 332 333 334 335
                            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
336 337
         | Call_provers.OutOfMemory -> increased_time, memlimit, steplimit
         | Call_provers.Timeout -> timelimit, increased_mem, steplimit
338 339
         | Call_provers.Valid ->
            let steplimit =
340 341 342 343 344 345 346 347 348
              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
349 350 351 352
            in
            increased_time, increased_mem, steplimit
         | Call_provers.Unknown _
         | Call_provers.StepLimitExceeded
353
         | Call_provers.Invalid -> increased_time, increased_mem, steplimit
354 355 356
         | Call_provers.Failure _
         | Call_provers.HighFailure ->
            (* correct ? failures are supposed to appear quickly anyway... *)
357
            timelimit, memlimit, steplimit
358 359
       end
    | None when interactive -> 0, 0, 0
360
    | None -> timelimit, memlimit, steplimit
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
  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
376
  if ansnew <> Call_provers.Timeout && group_answer ansold = group_answer ansnew &&
377 378 379 380 381
       tnew >= told *. 0.9 -. 0.1 && tnew <= told *. 1.1 +. 0.1
  then { nres with Call_provers.pr_time = told }
  else nres


Sylvain Dailler's avatar
Sylvain Dailler committed
382 383 384 385 386 387
let build_prover_call spa =
  let c = spa.spa_contr in
  let limit = spa.spa_limit in
  let (config_pr,driver) = Hprover.find c.controller_provers spa.spa_pr in
  let with_steps =
    Call_provers.(limit.limit_steps <> empty_limit.limit_steps) in
388
  let command =
389
    Whyconf.get_complete_command config_pr ~with_steps in
390
  try
Sylvain Dailler's avatar
Sylvain Dailler committed
391
    let task = Session_itp.get_task c.controller_session spa.spa_id in
392
    Debug.dprintf debug_sched "[build_prover_call] Script file = %a@."
Sylvain Dailler's avatar
Sylvain Dailler committed
393
                  (Pp.print_option Pp.string) spa.spa_pr_scr;
394
    let inplace = config_pr.Whyconf.in_place in
395
    let interactive = config_pr.Whyconf.interactive in
396 397
    try
      let call =
Sylvain Dailler's avatar
Sylvain Dailler committed
398 399
        Driver.prove_task ?old:spa.spa_pr_scr ~inplace ~command
                        ~limit ~interactive driver task
400
      in
Sylvain Dailler's avatar
Sylvain Dailler committed
401 402 403 404 405 406 407 408
      let pa =
        { tp_session  = c.controller_session;
          tp_id       = spa.spa_id;
          tp_pr       = spa.spa_pr;
          tp_callback = spa.spa_callback;
          tp_started  = false;
          tp_call     = call;
          tp_ores     = spa.spa_ores } in
409 410
      Hashtbl.replace prover_tasks_in_progress call pa
    with Sys_error _ as e ->
Sylvain Dailler's avatar
Sylvain Dailler committed
411
      spa.spa_callback (InternalFailure e)
412
  with Not_found (* goal has no task, it is detached *) ->
Sylvain Dailler's avatar
Sylvain Dailler committed
413
       spa.spa_callback Detached
MARCHE Claude's avatar
MARCHE Claude committed
414

415 416
let update_observer () =
  let scheduled = Queue.length scheduled_proof_attempts in
417
  let waiting_or_running = Hashtbl.length prover_tasks_in_progress in
418 419 420
  let running = !number_of_running_provers in
  !observer scheduled (waiting_or_running - running) running

MARCHE Claude's avatar
MARCHE Claude committed
421 422
let timeout_handler () =
  (* examine all the prover tasks in progress *)
423 424 425
  (* 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
426
    let results = Call_provers.get_new_results ~blocking:S.blocking in
427 428
    List.iter (fun (call, prover_update) ->
      match Hashtbl.find prover_tasks_in_progress call with
Sylvain Dailler's avatar
Sylvain Dailler committed
429
      | ptp ->
430
        begin match prover_update with
431 432
        | Call_provers.NoUpdates -> ()
        | Call_provers.ProverStarted ->
Sylvain Dailler's avatar
Sylvain Dailler committed
433 434
            assert (not ptp.tp_started);
            ptp.tp_callback Running;
435
            incr number_of_running_provers;
Sylvain Dailler's avatar
Sylvain Dailler committed
436 437
            Hashtbl.replace prover_tasks_in_progress ptp.tp_call
              {ptp with tp_started = true}
438
        | Call_provers.ProverFinished res ->
Sylvain Dailler's avatar
Sylvain Dailler committed
439 440 441
            Hashtbl.remove prover_tasks_in_progress ptp.tp_call;
            if ptp.tp_started then decr number_of_running_provers;
            let res = Opt.fold fuzzy_proof_time res ptp.tp_ores in
442
            (* inform the callback *)
Sylvain Dailler's avatar
Sylvain Dailler committed
443
            ptp.tp_callback (Done res)
444
        | Call_provers.ProverInterrupted ->
Sylvain Dailler's avatar
Sylvain Dailler committed
445 446
            Hashtbl.remove prover_tasks_in_progress ptp.tp_call;
            if ptp.tp_started then decr number_of_running_provers;
447
            (* inform the callback *)
Sylvain Dailler's avatar
Sylvain Dailler committed
448
            ptp.tp_callback (Interrupted)
449
        | Call_provers.InternalFailure exn ->
Sylvain Dailler's avatar
Sylvain Dailler committed
450 451
            Hashtbl.remove prover_tasks_in_progress ptp.tp_call;
            if ptp.tp_started then decr number_of_running_provers;
452
            (* inform the callback *)
Sylvain Dailler's avatar
Sylvain Dailler committed
453
            ptp.tp_callback (InternalFailure (exn))
454 455 456 457 458 459
        end
      | exception Not_found -> ()
        (* We probably received ProverStarted after ProverFinished,
           because what is sent to and received from the server is
           not ordered. *)
    ) results;
460 461
  end;

462 463 464 465 466 467 468
  (* 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 *)
469
      let (callback,call,ores) as c =
470 471 472 473
        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
474
      | Call_provers.ProverFinished res ->
475 476
          (* res is meaningless for edition, we returned the old result *)
          (* inform the callback *)
477
          callback (match ores with None -> Done res | Some r -> Done r)
478 479 480 481
      | _ -> assert (false) (* An edition can only return Noupdates or finished *)
    done;
    Queue.transfer q prover_tasks_edited;
  end;
482 483

  (* if the number of prover tasks is less than S.multiplier times the maximum
MARCHE Claude's avatar
MARCHE Claude committed
484 485
     number of running provers, then we heuristically decide to add
     more tasks *)
486 487
  begin
    try
488
      for _i = Hashtbl.length prover_tasks_in_progress
489
          to S.multiplier * !session_max_tasks do
Sylvain Dailler's avatar
Sylvain Dailler committed
490 491
        let spa = Queue.pop scheduled_proof_attempts in
        try build_prover_call spa
492
        with e when not (Debug.test_flag Debug.stack_trace) ->
Sylvain Dailler's avatar
Sylvain Dailler committed
493
          spa.spa_callback (InternalFailure e)
494 495 496
      done
  with Queue.Empty -> ()
  end;
497
  update_observer ();
498
  true
MARCHE Claude's avatar
MARCHE Claude committed
499

500
let interrupt () =
501
  (* Interrupt provers *)
Sylvain Dailler's avatar
Sylvain Dailler committed
502
  Hashtbl.iter (fun _k e -> e.tp_callback Interrupted)
503 504 505 506
    prover_tasks_in_progress;
  Hashtbl.clear prover_tasks_in_progress;
  (* Do not interrupt editors
  while not (Queue.is_empty prover_tasks_edited) do
507
    let (_ses,_id,_pr,callback,_started,_call,_ores) =
508
      Queue.pop prover_tasks_edited in
509 510
    callback Interrupted
  done;
511
  *)
512 513
  number_of_running_provers := 0;
  while not (Queue.is_empty scheduled_proof_attempts) do
Sylvain Dailler's avatar
Sylvain Dailler committed
514 515
    let spa = Queue.pop scheduled_proof_attempts in
    spa.spa_callback Interrupted
516 517 518
  done;
  !observer 0 0 0

MARCHE Claude's avatar
MARCHE Claude committed
519 520 521 522
let run_timeout_handler () =
  if not !timeout_handler_running then
    begin
      timeout_handler_running := true;
523
      S.timeout ~ms:default_delay_ms timeout_handler;
MARCHE Claude's avatar
MARCHE Claude committed
524 525
    end

526
let schedule_proof_attempt c id pr ?save_to ~limit ~callback ~notification =
527 528
  let ses = c.controller_session in
  let callback panid s =
529 530
    begin
      match s with
531
      | UpgradeProver _ | Removed _ -> ()
532 533 534 535 536 537 538 539
      | 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
540 541
      | Interrupted
      | InternalFailure _ ->
542 543 544 545 546
         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
547 548
      | Detached -> assert false
      | Uninstalled _ -> assert false
549
      | Undone -> assert false
550
    end;
551 552 553
    callback panid s
  in
  let adaptlimit,ores,proof_script =
554
    try
555
      let h = get_proof_attempt_ids ses id in
556
      let pa = Hprover.find h pr in
557
      let a = get_proof_attempt_node ses pa in
558 559 560 561 562
      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
563 564 565
      let script =
        if save_to = None then
          Opt.map (fun s ->
566 567
                            Debug.dprintf debug_sched "Script file = %s@." s;
                            Filename.concat (get_dir ses) s) a.proof_script
568 569
        else
          save_to
570 571
      in
      limit, old_res, script
572
    with Not_found | Session_itp.BadID -> limit,None,save_to
573
  in
574
  let panid = graft_proof_attempt ~limit ses id pr in
Sylvain Dailler's avatar
Sylvain Dailler committed
575 576 577 578 579 580 581 582 583
  let spa =
    { spa_contr    = c;
      spa_id       = id;
      spa_pr       = pr;
      spa_limit    = adaptlimit;
      spa_pr_scr   = proof_script;
      spa_callback = callback panid;
      spa_ores     = ores } in
  Queue.add spa scheduled_proof_attempts;
584
  callback panid Scheduled;
MARCHE Claude's avatar
MARCHE Claude committed
585
  run_timeout_handler ()
Clément Fumex's avatar
Clément Fumex committed
586

587

588 589


590 591
(*** { 2 edition of proof scripts} *)

Sylvain Dailler's avatar
Sylvain Dailler committed
592 593 594
(* 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
595
  let driver = snd (Hprover.find c.controller_provers pr) in
596
  let task = Session_itp.get_task session pn in
Sylvain Dailler's avatar
Sylvain Dailler committed
597 598 599 600
  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
601
  let fn = Filename.chop_extension (Filename.basename (file_name f)) in
Sylvain Dailler's avatar
Sylvain Dailler committed
602 603 604 605 606 607
  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

608
let prepare_edition c ?file pn pr ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
609
  let session = c.controller_session in
610 611 612
  let proof_attempts_id = get_proof_attempt_ids session pn in
  let panid =
    try
613 614 615 616 617 618 619 620 621 622 623 624 625 626
      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
627
    with Not_found ->
628 629 630 631
      let file = match file with
        | Some f -> f
        | None -> create_file_rel_path c pr pn
      in
632 633
      let limit = Call_provers.empty_limit in
      graft_proof_attempt session pn pr ~file ~limit
Sylvain Dailler's avatar
Sylvain Dailler committed
634
  in
635
  update_goal_node notification session pn;
636 637
  let pa = get_proof_attempt_node session panid in
  let file = Opt.get pa.proof_script in
638
  let old_res = pa.proof_state in
639
  let session_dir = Session_itp.get_dir session in
Sylvain Dailler's avatar
Sylvain Dailler committed
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
  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
655
  let task = Session_itp.get_task session pn in
656
  let driver = snd (Hprover.find c.controller_provers pr) in
657
  Driver.print_task ?old driver fmt task;
Sylvain Dailler's avatar
Sylvain Dailler committed
658 659
  Opt.iter close_in old;
  close_out ch;
660
  panid,file,old_res
Sylvain Dailler's avatar
Sylvain Dailler committed
661 662 663

exception Editor_not_found

664
let schedule_edition c id pr ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
665 666 667 668
  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
669
  (* Make sure editor exists. Fails otherwise *)
Sylvain Dailler's avatar
Sylvain Dailler committed
670 671
  let editor =
    match prover_conf.Whyconf.editor with
672
    | "" -> Whyconf.(default_editor (get_main config))
Sylvain Dailler's avatar
Sylvain Dailler committed
673
    | s ->
674 675 676 677 678
       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
679
  in
680
  let panid,file,old_res = prepare_edition c id pr ~notification in
681
  (* Notification node *)
682 683 684
  let callback panid s =
    begin
      match s with
685
      | UpgradeProver _ -> ()
686
      | Running -> ()
687 688
      | Done res ->
         (* set obsolete to true since we do not know if the manual
689
            proof was completed or not *)
690 691 692 693 694
         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
695 696 697
      | Interrupted
      | InternalFailure _ ->
         update_goal_node notification session id
698
      | Undone | Detached | Uninstalled _ | Scheduled | Removed _ -> assert false
699 700
    end;
    callback panid s
701
  in
Sylvain Dailler's avatar
Sylvain Dailler committed
702
  Debug.dprintf debug_sched "[Editing] goal %s with command '%s' on file %s@."
703 704
                (Session_itp.get_proof_name session id).Ident.id_string
                editor file;
705 706
  let call = Call_provers.call_editor ~command:editor file in
  callback panid Running;
707
  Queue.add (callback panid,call,old_res) prover_tasks_edited;
708
  run_timeout_handler ()
709

710 711
exception TransAlreadyExists of string * string

712 713
(*** { 2 transformations} *)

714 715 716 717 718 719 720 721 722
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
723
  let apply_trans () =
724 725
    begin
      try
726 727 728
        let subtasks =
          apply_trans_to_goal ~allow_no_effect:false
                              c.controller_session c.controller_env name args id
729
        in
730 731 732
        let tid = graft_transf c.controller_session id name args subtasks in
        callback (TSdone tid)
      with
733
      | NoProgress ->
734
         (* if result is same as input task, consider it as a failure *)
735
         callback (TSfailed (id, NoProgress))
736
      | e when not (Debug.test_flag Debug.stack_trace) ->
737
          (* "@[Exception raised in Session_itp.apply_trans_to_goal %s:@ %a@.@]"
738
          name Exn_printer.exn_printer e; TODO *)
739
        callback (TSfailed (id, e))
740 741
    end;
    false
742
  in
743 744
  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));
745 746
  S.idle ~prio:0 apply_trans;
  callback TSscheduled
Clément Fumex's avatar
Clément Fumex committed
747

748 749 750

open Strategy

Sylvain Dailler's avatar
Sylvain Dailler committed
751
let run_strategy_on_goal
752
    c id strat ~callback_pa ~callback_tr ~callback ~notification =
753 754 755 756 757 758
  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
759 760
         let callback panid res =
           callback_pa panid res;
761
           match res with
762
           | UpgradeProver _ | Scheduled | Running -> (* nothing to do yet *) ()
763 764 765
           | Done { Call_provers.pr_answer = Call_provers.Valid } ->
              (* proof succeeded, nothing more to do *)
              callback STShalt
766 767
           | Interrupted | InternalFailure _ ->
              callback STShalt
768 769 770 771 772
           | 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
773
           | Undone | Detached | Uninstalled _ | Removed _ ->
774 775 776 777 778 779
                         (* should not happen *)
                         assert false
         in
         let limit = { Call_provers.empty_limit with
                       Call_provers.limit_time = timelimit;
                       limit_mem  = memlimit} in
780
         schedule_proof_attempt c g p ?save_to:None ~limit ~callback ~notification
781 782
      | Itransform(trname,pcsuccess) ->
         let callback ntr =
783
           callback_tr trname [] ntr;
784
           match ntr with
785
           | TSfailed _e -> (* transformation failed *)
786 787 788 789 790 791 792 793 794 795 796 797
              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
798
                (get_sub_tasks c.controller_session tid)
799
         in
800
         schedule_transformation c g trname [] ~callback ~notification
801 802 803 804 805 806
      | Igoto pc ->
         callback (STSgoto (g,pc));
         exec_strategy pc strat g
  in
  exec_strategy 0 strat id

Sylvain Dailler's avatar
Sylvain Dailler committed
807 808
let schedule_pa_with_same_arguments
    c (pa: proof_attempt_node) (pn: proofNodeID) ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
809 810 811 812
  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
813 814
let schedule_tr_with_same_arguments
    c (tr: transID) (pn: proofNodeID) ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
815 816 817
  let s = c.controller_session in
  let args = get_transf_args s tr in
  let name = get_transf_name s tr in
818
  let callback = callback name args in
819

Sylvain Dailler's avatar
Sylvain Dailler committed
820 821
  schedule_transformation c pn name args ~callback ~notification

MARCHE Claude's avatar
MARCHE Claude committed
822 823 824 825 826
let proof_is_complete pa =
  match pa.Session_itp.proof_state with
  | None -> false
  | Some pr ->
     not pa.Session_itp.proof_obsolete &&
827
       Call_provers.(pr.pr_answer = Valid)
MARCHE Claude's avatar
MARCHE Claude committed
828

829

Sylvain Dailler's avatar
Sylvain Dailler committed
830
let clean c ~removed nid =
831

832
  (* clean should not change proved status *)
833 834 835
  let notification any =
    Format.eprintf "Cleaning error: cleaning attempts to change status of node %a@." fprintf_any any
  in
836
  let s = c.controller_session in
837
  (* This function is applied on leafs first for the case of removes *)
838
  let clean_aux () any =
839 840 841 842 843 844
    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)
845
      | ATn tn ->
846 847 848 849 850 851
         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
852 853 854 855 856 857 858
  in

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

860 861
(* This function folds on any subelements of given node and tries to mark all
   proof attempts it encounters *)
862
let mark_as_obsolete ~notification c any =
863
  let s = c.controller_session in
864
  (* Case for proof attempt only *)
865
  let mark_as_obsolete_pa n =
866 867
    let parent = get_proof_attempt_parent s n in
    Session_itp.mark_obsolete s n;
868
    notification (APa n);
869
    update_goal_node notification s parent
870
  in
871 872 873 874 875 876 877 878 879 880
  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
881

Sylvain Dailler's avatar
Sylvain Dailler committed
882 883 884
exception BadCopyPaste

(* Reproduce the transformation made on node on an other one *)
885
let rec copy_rec ~notification ~callback_pa ~callback_tr c from_any to_any =
Sylvain Dailler's avatar
Sylvain Dailler committed
886
  let s = c.controller_session in
887 888
  match from_any, to_any with
(*
Sylvain Dailler's avatar
Sylvain Dailler committed
889 890 891 892
    | AFile _, AFile _ ->
        raise BadCopyPaste
    | ATh _from_th, ATh _to_th ->
        raise BadCopyPaste
893
 *)
Sylvain Dailler's avatar
Sylvain Dailler committed
894 895
    | APn from_pn, APn to_pn ->
      let from_pa_list = get_proof_attempts s from_pn in
896
      List.iter (fun x -> schedule_pa_with_same_arguments ?save_to:None c x to_pn
Sylvain Dailler's avatar
Sylvain Dailler committed
897 898
          ~callback:callback_pa ~notification) from_pa_list;
      let from_tr_list = get_transformations s from_pn in
899
      let callback x tr args st = callback_tr tr args st;
Sylvain Dailler's avatar
Sylvain Dailler committed
900
        match st with
Sylvain Dailler's avatar
Sylvain Dailler committed
901
        | TSdone tid ->
902
          copy_rec c (ATn x) (ATn tid) ~notification ~callback_pa ~callback_tr
Sylvain Dailler's avatar
Sylvain Dailler committed
903 904 905 906 907 908 909
        | _ -> ()
      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
910 911 912 913 914 915 916 917
        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
918 919 920
    | _ -> raise BadCopyPaste


921 922
let copy_paste ~notification ~callback_pa ~callback_tr c from_any to_any =
  let s = c.controller_session in
923 924
  if is_below s to_any from_any then
    raise BadCopyPaste;
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
  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
941 942 943 944 945 946 947 948





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


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

951
let find_prover notification c goal_id pr =
952
  if Hprover.mem c.controller_provers pr then `Found pr else
953
   match Whyconf.get_prover_upgrade_policy c.controller_config pr with
954 955
   | exception Not_found -> `Keep
   | Whyconf.CPU_keep -> `Keep
956
   | Whyconf.CPU_remove -> `Remove
957 958 959
   | 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
960
      then (* yes, then we remove the attempt *)
961
        `Remove
962 963 964 965
      else
        begin
          (* we modify the prover in-place *)
          Session_itp.change_prover notification c.controller_session goal_id pr new_pr;
966
          `Found new_pr
967
        end
968 969 970
   | Whyconf.CPU_duplicate new_pr ->
      (* does a proof using new_pr already exists ? *)
      if Hprover.mem (get_proof_attempt_ids c.controller_session goal_id) new_pr
971
      then (* yes, then we do nothing *)
972
        `Keep
973 974
      else
        begin
975 976
          (* we duplicate the proof attempt *)
          `Found new_pr
977
        end
978

979 980 981 982 983

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
984 985
  | `Keep -> callback id (Uninstalled pr)
  | `Remove ->
986 987 988
     (* 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
989
  | `Found pr' ->
990 991
     try
       if pr' <> pr then callback id (UpgradeProver pr');
992
       let _ = get_task c.controller_session parid in
993
       schedule_proof_attempt ?save_to:None c parid pr' ~limit ~callback ~notification
994 995 996 997 998
     with Not_found ->
       callback id Detached



999 1000 1001 1002
type report =
  | Result of Call_provers.prover_result * Call_provers.prover_result
  (** Result(new_result,old_result) *)
  | CallFailed of exn
1003
  | Replay_interrupted
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
  | 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
1015 1016 1017 1018
  | CallFailed e ->
    Format.fprintf fmt "Callfailed %a@." Exn_printer.exn_printer e
  | Replay_interrupted ->
    Format.fprintf fmt "Interrupted@."
1019 1020 1021 1022 1023 1024 1025 1026 1027
  | 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 *)
1028
let replay_print fmt (lr: (proofNodeID * Whyconf.prover * Call_provers.resource_limit * report) list) =
1029 1030
  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
1031 1032
      (Obj.magic id) Whyconf.print_prover pr
      rl.Call_provers.limit_time print_report report
1033
  in
1034
  Format.fprintf fmt "%a@." (Pp.print_list Pp.newline pp_elem) lr
1035

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

1039 1040 1041 1042 1043
  let session = c.controller_session in
  let count = ref 0 in
  let report = ref [] in
  let found_upgraded_prover = ref false in

1044 1045
  let craft_report s id limits pa =
    let pr = pa.Session_itp.prover in
1046
    match s with
1047 1048 1049 1050
    | UpgradeProver _ -> found_upgraded_prover := true
    | Removed _ ->
       found_upgraded_prover := true;
       decr count
1051
    | Scheduled | Running -> ()
1052
    | Undone | Interrupted ->
1053
       decr count;
1054
       report := (id, pr, limits, Replay_interrupted ) :: !report
1055
    | Done new_r ->
1056
       decr count;
1057 1058 1059 1060 1061
       begin
         match pa.Session_itp.proof_state with
         | None -> (report := (id, pr, limits, No_former_result new_r) :: !report)
         | Some old_r -> report := (id, pr, limits, Result (new_r, old_r)) :: !report
       end
1062
    | InternalFailure e ->
1063
       decr count;
1064
       report := (id, pr, limits, CallFailed (e)) :: !report
1065 1066
    | Uninstalled _ ->
       decr count;
1067
       report := (id, pr, limits, Prover_not_installed) :: !report;