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

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

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

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

Sylvain Dailler's avatar
Sylvain Dailler committed
22

23 24
exception Noprogress

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

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

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

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

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

68 69 70 71
type strategy_status = STSgoto of proofNodeID * int | STShalt

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


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

86

87
let create_controller config env ses =
88 89
  let c =
    {
90
      controller_session = ses;
91 92 93
      controller_config = config;
      controller_env = env;
      controller_provers = Whyconf.Hprover.create 7;
94
      controller_strategies = Stdlib.Hstr.create 7;
95 96 97 98 99 100
    }
  in
  let provers = Whyconf.get_provers config in
  Whyconf.Mprover.iter
    (fun _ p ->
     try
101
       let d = Whyconf.load_driver (Whyconf.get_main config) env p.Whyconf.driver [] in
102 103
       Whyconf.Hprover.add c.controller_provers p.Whyconf.prover (p,d)
     with e ->
Sylvain Dailler's avatar
Sylvain Dailler committed
104
       Debug.dprintf debug_call_prover
105 106 107 108 109 110
         "[Controller_itp] error while loading driver for prover %a: %a@."
         Whyconf.print_prover p.Whyconf.prover
         Exn_printer.exn_printer e)
    provers;
  c

Sylvain Dailler's avatar
Sylvain Dailler committed
111
let remove_subtree c = Session_itp.remove_subtree c.controller_session
112

113 114 115
(* Get children of any without proofattempts *)
let get_undetached_children_no_pa s any : any list =
  match any with
116
  | AFile f -> List.map (fun th -> ATh th) (file_theories f)
117 118 119
  | 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
120
  | APa _ -> []
121

122 123


124 125 126 127 128 129 130 131 132 133 134 135
(* printing *)

module PSession = struct

  open Stdlib

  type any =
    | Session
    | File of file
    | Theory of theory
    | Goal of proofNodeID
    | Transf of transID
136
    | ProofAttempt of proof_attempt_node
137 138 139 140 141 142 143 144 145 146

  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 ->
147
       (file_name f),
148
       List.fold_right (fun th -> n (Theory th)) (file_theories f) []
149 150 151
    | Theory th ->
       let id = theory_name th in
       let name = id.Ident.id_string in
152
       let name = if th_proved s th then name^"!" else name^"?" in
153
       name,
Sylvain Dailler's avatar
Sylvain Dailler committed
154 155 156 157
       List.fold_right
         (fun g -> n (Goal g))
         (theory_goals th)
         (List.fold_right (fun g -> n (Goal g)) (theory_detached_goals th) [])
158 159 160
    | Goal id ->
       let gid = get_proof_name s id in
       let name = gid.Ident.id_string in
161
       let name = if pn_proved s id then name^"!" else name^"?" in
162 163 164 165 166 167 168
       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
169 170 171 172 173
          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 ""), []
174 175
    | Transf id ->
       let name = get_transf_name s id in
176
       let name = if tn_proved s id then name^"!" else name^"?" in
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
       let sts = get_sub_tasks s id in
       let dsts = get_detached_sub_tasks s id in
       name,
       List.fold_right (fun g -> n (Goal g)) sts
                       (List.fold_right (fun g -> n (Goal g)) dsts [])

end

module P = Print_tree.PMake(PSession)

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

(*********)



194 195 196 197 198 199

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

200
let reload_files (c : controller) ~use_shapes =
201
  let old_ses = c.controller_session in
Sylvain Dailler's avatar
Sylvain Dailler committed
202 203
  c.controller_session <-
    empty_session ~shape_version:(get_shape_version old_ses) (get_dir old_ses);
204
  try
205
    merge_files ~use_shapes c.controller_env c.controller_session old_ses
206 207 208
  with e ->
    c.controller_session <- old_ses;
    raise e
209 210

let add_file c ?format fname =
211 212 213
  let theories = Session_itp.read_file c.controller_env ?format fname in
  let (_ : file) = add_file_section c.controller_session fname theories format in
  ()
214

215 216

module type Scheduler = sig
217
  val multiplier: int
218 219 220 221
  val timeout: ms:int -> (unit -> bool) -> unit
  val idle: prio:int -> (unit -> bool) -> unit
end

222 223
module Make(S : Scheduler) = struct

MARCHE Claude's avatar
MARCHE Claude committed
224 225 226 227 228 229 230 231
let scheduled_proof_attempts = Queue.create ()

let prover_tasks_in_progress = Queue.create ()

let timeout_handler_running = ref false

let max_number_of_running_provers = ref 1

232 233 234 235
let set_max_tasks n =
  max_number_of_running_provers := n;
  Prove_client.set_max_running_provers n

MARCHE Claude's avatar
MARCHE Claude committed
236
let number_of_running_provers = ref 0
237

238 239 240 241
let observer = ref (fun _ _ _ -> ())

let register_observer = (:=) observer

242
module Hprover = Whyconf.Hprover
MARCHE Claude's avatar
MARCHE Claude committed
243

244 245 246 247 248 249 250 251 252 253 254 255 256
(* 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
257
    let steplimit = limits.Call_provers.limit_steps in
258 259 260 261 262 263 264 265 266 267 268 269 270 271
    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
       let increased_time = if interactive then t
                            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
272 273
         | Call_provers.OutOfMemory -> increased_time, memlimit, steplimit
         | Call_provers.Timeout -> timelimit, increased_mem, steplimit
274 275 276 277 278 279 280
         | Call_provers.Valid ->
            let steplimit =
              if use_steps && not a.proof_obsolete then s else 0
            in
            increased_time, increased_mem, steplimit
         | Call_provers.Unknown _
         | Call_provers.StepLimitExceeded
281
         | Call_provers.Invalid -> increased_time, increased_mem, steplimit
282 283 284
         | Call_provers.Failure _
         | Call_provers.HighFailure ->
            (* correct ? failures are supposed to appear quickly anyway... *)
285
            timelimit, memlimit, steplimit
286 287
       end
    | None when interactive -> 0, 0, 0
288
    | None -> timelimit, memlimit, steplimit
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
  in
  { Call_provers.limit_time = t; limit_mem = m; limit_steps = s }

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

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


let build_prover_call ?proof_script ~cntexample c id pr limit callback ores =
311
  let (config_pr,driver) = Hprover.find c.controller_provers pr in
312
  let with_steps = Call_provers.(limit.limit_steps <> empty_limit.limit_steps) in
313
  let command =
314
    Whyconf.get_complete_command config_pr ~with_steps in
315 316
  try
    let task = Session_itp.get_raw_task c.controller_session id in
317 318 319
    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
320
    let call =
321 322
      Driver.prove_task ?old:proof_script ~cntexample:cntexample ~inplace ~command
                        ~limit driver task
323 324 325 326 327
    in
    let pa = (c.controller_session,id,pr,proof_script,callback,false,call,ores) in
    Queue.push pa prover_tasks_in_progress
  with Not_found (* goal has no task, it is detached *) ->
       callback Detached
MARCHE Claude's avatar
MARCHE Claude committed
328

329 330 331 332 333 334
let update_observer () =
  let scheduled = Queue.length scheduled_proof_attempts in
  let waiting_or_running = Queue.length prover_tasks_in_progress in
  let running = !number_of_running_provers in
  !observer scheduled (waiting_or_running - running) running

MARCHE Claude's avatar
MARCHE Claude committed
335 336 337 338
let timeout_handler () =
  (* examine all the prover tasks in progress *)
  let q = Queue.create () in
  while not (Queue.is_empty prover_tasks_in_progress) do
339
    let (ses,id,pr,pr_script,callback,started,call,ores) as c =
Sylvain Dailler's avatar
Sylvain Dailler committed
340
      Queue.pop prover_tasks_in_progress in
341
    match Call_provers.query_call call with
MARCHE Claude's avatar
MARCHE Claude committed
342 343 344 345 346
    | Call_provers.NoUpdates -> Queue.add c q
    | Call_provers.ProverStarted ->
       assert (not started);
       callback Running;
       incr number_of_running_provers;
347
       Queue.add (ses,id,pr,pr_script,callback,true,call,ores) q
348
    | Call_provers.ProverFinished res ->
MARCHE Claude's avatar
MARCHE Claude committed
349
       if started then decr number_of_running_provers;
350
       let res = Opt.fold fuzzy_proof_time res ores in
351 352 353
       (* update the session *)
       update_proof_attempt ses id pr res;
       (* inform the callback *)
MARCHE Claude's avatar
MARCHE Claude committed
354
       callback (Done res)
355
(*
356 357
    | Call_provers.ProverFinished res (* when pr_script <> None *) ->
       if started then decr number_of_running_provers;
358
       let res = Opt.fold fuzzy_proof_time res ores in
359 360 361 362
       (* update the session *)
       update_proof_attempt ~obsolete:true ses id pr res;
       (* inform the callback *)
       callback (Done res)
363
*)
364 365 366 367 368 369 370 371
    | Call_provers.ProverInterrupted ->
       if started then decr number_of_running_provers;
       (* inform the callback *)
       callback (Interrupted)
    | Call_provers.InternalFailure exn ->
       if started then decr number_of_running_provers;
       (* inform the callback *)
       callback (InternalFailure (exn))
MARCHE Claude's avatar
MARCHE Claude committed
372 373
  done;
  Queue.transfer q prover_tasks_in_progress;
374
  (* if the number of prover tasks is less than 3 times the maximum
MARCHE Claude's avatar
MARCHE Claude committed
375 376
     number of running provers, then we heuristically decide to add
     more tasks *)
377 378 379
  begin
    try
      for _i = Queue.length prover_tasks_in_progress
380
          to S.multiplier * !max_number_of_running_provers do
381 382
        let (c,id,pr,limit,proof_script,callback,cntexample,ores) =
          Queue.pop scheduled_proof_attempts in
383
        try
384
          build_prover_call ?proof_script ~cntexample c id pr limit callback ores
385
        with e when not (Debug.test_flag Debug.stack_trace) ->
386
          (*Format.eprintf
387
            "@[Exception raised in Controller_itp.build_prover_call:@ %a@.@]"
388
            Exn_printer.exn_printer e;*)
389 390 391 392
          callback (InternalFailure e)
      done
  with Queue.Empty -> ()
  end;
393
  update_observer ();
394
  true
MARCHE Claude's avatar
MARCHE Claude committed
395

396 397
let interrupt () =
  while not (Queue.is_empty prover_tasks_in_progress) do
398
    let (_ses,_id,_pr,_proof_script,callback,_started,_call,_ores) =
399 400 401 402 403 404
      Queue.pop prover_tasks_in_progress in
    (* TODO: apply some Call_provers.interrupt_call call *)
    callback Interrupted
  done;
  number_of_running_provers := 0;
  while not (Queue.is_empty scheduled_proof_attempts) do
405 406
    let (_c,_id,_pr,_limit,_proof_script,callback,_cntexample,_ores) =
      Queue.pop scheduled_proof_attempts in
407 408 409 410
    callback Interrupted
  done;
  !observer 0 0 0

MARCHE Claude's avatar
MARCHE Claude committed
411 412 413 414
let run_timeout_handler () =
  if not !timeout_handler_running then
    begin
      timeout_handler_running := true;
415
      S.timeout ~ms:default_delay_ms timeout_handler;
MARCHE Claude's avatar
MARCHE Claude committed
416 417
    end

418 419 420 421 422 423 424 425 426 427 428 429 430
let schedule_proof_attempt c id pr
                           ~counterexmp ~limit ~callback ~notification =
  let ses = c.controller_session in
  let callback panid s =
    (match s with
    | Scheduled | Running -> update_goal_node notification ses id
    | Done res ->
        update_proof_attempt ~obsolete:false ses id pr res;
        update_goal_node notification ses id
    | _ -> ());
    callback panid s
  in
  let adaptlimit,ores,proof_script =
431
    try
432
      let h = get_proof_attempt_ids ses id in
433
      let pa = Hprover.find h pr in
434
      let a = get_proof_attempt_node ses pa in
435 436 437 438 439
      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
440 441 442 443 444 445
      let script = Opt.map (fun s ->
                            Debug.dprintf debug_sched "Script file = %s@." s;
                            Filename.concat (get_dir ses) s) a.proof_script
      in
      limit, old_res, script
    with Not_found | Session_itp.BadID -> limit,None,None
446
  in
447
  let panid = graft_proof_attempt ~limit ses id pr in
448
  Queue.add (c,id,pr,adaptlimit,proof_script,callback panid,counterexmp,ores)
449
            scheduled_proof_attempts;
450
  callback panid Scheduled;
MARCHE Claude's avatar
MARCHE Claude committed
451
  run_timeout_handler ()
Clément Fumex's avatar
Clément Fumex committed
452

453

454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490

(* replay *)


let find_prover notification c goal_id pr =
  if Hprover.mem c.controller_provers pr then Some pr else
   match Whyconf.get_prover_upgrade_policy c.controller_config pr with
   | exception Not_found -> None
   | Whyconf.CPU_keep -> None
   | Whyconf.CPU_upgrade new_pr ->
      (* does a proof using new_pr already exists ? *)
      if Hprover.mem (get_proof_attempt_ids c.controller_session goal_id) new_pr
      then (* yes, then we do nothing *)
        None
      else
        begin
          (* we modify the prover in-place *)
          Session_itp.change_prover notification c.controller_session goal_id pr new_pr;
          Some new_pr
        end
   | Whyconf.CPU_duplicate _new_pr ->
      assert false (* TODO *)
(*
      (* does a proof using new_p already exists ? *)
      if Hprover.mem (goal_external_proofs parid) new_pr
      then (* yes, then we do nothing *)
        None
      else
        begin
          (* we duplicate the proof_attempt *)
          let new_a = copy_external_proof
                        ~notify ~keygen:O.create ~prover:new_p ~env_session:eS a
          in
          Some new_pr
        end
*)

491
let replay_proof_attempt c pr limit (parid: proofNodeID) id ~callback ~notification =
492 493 494 495 496
  (* The replay can be done on a different machine so we need
     to check more things before giving the attempt to the scheduler *)
  match find_prover notification c parid pr with
  | None -> callback id (Uninstalled pr)
  | Some pr ->
497 498
     try
       let _ = get_raw_task c.controller_session parid in
499
       schedule_proof_attempt c parid pr ~counterexmp:false ~limit ~callback ~notification
500 501
     with Not_found ->
       callback id Detached
502 503


504
(* TODO to be simplified *)
Sylvain Dailler's avatar
Sylvain Dailler committed
505 506 507
(* 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
508
  let driver = snd (Hprover.find c.controller_provers pr) in
509
  let task = Session_itp.get_raw_task session pn in
Sylvain Dailler's avatar
Sylvain Dailler committed
510 511 512 513
  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
514
  let fn = Filename.chop_extension (Filename.basename (file_name f)) in
Sylvain Dailler's avatar
Sylvain Dailler committed
515 516 517 518 519 520 521 522
  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

let update_edit_external_proof c pn ?panid pr =
  let session = c.controller_session in
523
  let driver = snd (Hprover.find c.controller_provers pr) in
524
  let task = Session_itp.get_raw_task session pn in
Sylvain Dailler's avatar
Sylvain Dailler committed
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
  let session_dir = Session_itp.get_dir session in
  let file =
    match panid with
    | None ->
        create_file_rel_path c pr pn
    | Some panid ->
        let pa = get_proof_attempt_node session panid in
        Opt.get pa.proof_script
  in
  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
  Driver.print_task ~cntexample:false ?old driver fmt task;
  Opt.iter close_in old;
  close_out ch;
  file

exception Editor_not_found

556
let schedule_edition c id pr ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
557 558 559 560 561 562
  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
  let session_dir = Session_itp.get_dir session in
  let limit = Call_provers.empty_limit in
563
  (* Make sure editor exists. Fails otherwise *)
Sylvain Dailler's avatar
Sylvain Dailler committed
564 565
  let editor =
    match prover_conf.Whyconf.editor with
566
    | "" -> raise Editor_not_found
Sylvain Dailler's avatar
Sylvain Dailler committed
567 568 569
    | s ->
        try
          let ed = Whyconf.editor_by_id config s in
570 571
          String.concat " " (ed.Whyconf.editor_command ::
                             ed.Whyconf.editor_options)
572
        with Not_found -> raise Editor_not_found
Sylvain Dailler's avatar
Sylvain Dailler committed
573 574 575
  in
  let proof_attempts_id = get_proof_attempt_ids session id in
  let panid =
576 577 578 579 580
    try Hprover.find proof_attempts_id pr
    with Not_found ->
         let file = update_edit_external_proof c id pr in
         let filename = Sysutil.relativize_filename session_dir file in
         graft_proof_attempt c.controller_session id pr ~file:filename ~limit
Sylvain Dailler's avatar
Sylvain Dailler committed
581
  in
582 583
  let pa = get_proof_attempt_node c.controller_session panid in
  let file = Opt.get pa.proof_script in
584
  (* Notification node *)
585 586 587 588 589 590 591 592 593 594 595
  let callback panid s =
    begin
      match s with
      | Scheduled | Running ->
                     update_goal_node notification c.controller_session id
      | Done _ ->
         update_goal_node notification c.controller_session id
      | Interrupted | InternalFailure _ -> ()
      | _ -> ()
    end;
    callback panid s
596
  in
Sylvain Dailler's avatar
Sylvain Dailler committed
597 598
  Debug.dprintf debug_sched "[Editing] goal %s with command '%s' on file %s@."
    (Session_itp.get_proof_name session id).Ident.id_string
599
    editor file;
600 601 602 603 604 605
  let call = Call_provers.call_editor ~command:editor file in
  callback panid Running;
  let file = Sysutil.relativize_filename session_dir file in
  Queue.add (c.controller_session,id,pr,Some file,callback panid,false,call,None)
            prover_tasks_in_progress;
  run_timeout_handler ()
606

Sylvain Dailler's avatar
Sylvain Dailler committed
607

608
let schedule_transformation_r c id name args ~callback =
609
  let apply_trans () =
610 611
    begin
      try
612 613 614
        let subtasks =
          apply_trans_to_goal ~allow_no_effect:false
                              c.controller_session c.controller_env name args id
615
        in
616 617 618 619 620 621 622
        let tid = graft_transf c.controller_session id name args subtasks in
        callback (TSdone tid)
      with
      | Exit ->
         (* if result is same as input task, consider it as a failure *)
         callback (TSfailed (id, Noprogress))
      | e when not (Debug.test_flag Debug.stack_trace) ->
623
        (* Format.eprintf
624
          "@[Exception raised in Session_itp.apply_trans_to_goal %s:@ %a@.@]"
625
          name Exn_printer.exn_printer e; TODO *)
626
        callback (TSfailed (id, e))
627 628
    end;
    false
629 630 631
  in
  S.idle ~prio:0 apply_trans;
  callback TSscheduled
Clément Fumex's avatar
Clément Fumex committed
632

633
let schedule_transformation c id name args ~callback ~notification =
634
  let callback s = callback s; (match s with
635
      | TSdone tid -> update_trans_node notification c.controller_session tid
636
      | TSfailed _e -> ()
637
      | _ -> ()) in
638 639 640 641
  schedule_transformation_r c id name args ~callback

open Strategy

Sylvain Dailler's avatar
Sylvain Dailler committed
642
let run_strategy_on_goal
643
    c id strat ~counterexmp ~callback_pa ~callback_tr ~callback ~notification =
644 645 646 647 648 649
  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
650 651
         let callback panid res =
           callback_pa panid res;
652 653 654 655 656
           match res with
           | Scheduled | Running -> (* nothing to do yet *) ()
           | Done { Call_provers.pr_answer = Call_provers.Valid } ->
              (* proof succeeded, nothing more to do *)
              callback STShalt
657 658
           | Interrupted | InternalFailure _ ->
              callback STShalt
659 660 661 662 663
           | 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
664
           | Unedited | JustEdited | Detached | Uninstalled _ ->
665 666 667 668 669 670
                         (* should not happen *)
                         assert false
         in
         let limit = { Call_provers.empty_limit with
                       Call_provers.limit_time = timelimit;
                       limit_mem  = memlimit} in
671
         schedule_proof_attempt c g p ~counterexmp ~limit ~callback ~notification
672 673
      | Itransform(trname,pcsuccess) ->
         let callback ntr =
674
           callback_tr trname [] ntr;
675
           match ntr with
676
           | TSfailed _e -> (* transformation failed *)
677 678 679 680 681 682 683 684 685 686 687 688
              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
689
                (get_sub_tasks c.controller_session tid)
690
         in
691
         schedule_transformation c g trname [] ~callback ~notification
692 693 694 695 696 697
      | Igoto pc ->
         callback (STSgoto (g,pc));
         exec_strategy pc strat g
  in
  exec_strategy 0 strat id

Sylvain Dailler's avatar
Sylvain Dailler committed
698 699
let schedule_pa_with_same_arguments
    c (pa: proof_attempt_node) (pn: proofNodeID) ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
700 701 702 703
  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
704 705
let schedule_tr_with_same_arguments
    c (tr: transID) (pn: proofNodeID) ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
706 707 708
  let s = c.controller_session in
  let args = get_transf_args s tr in
  let name = get_transf_name s tr in
709
  let callback = callback name args in
Sylvain Dailler's avatar
Sylvain Dailler committed
710 711
  schedule_transformation c pn name args ~callback ~notification

712 713 714
let clean_session c ~removed =
  (* clean should not change proved status *)
  let notification _ = assert false in
715
  let s = c.controller_session in
716 717 718 719 720
  (* This function is applied on leafs first for the case of removes *)
  Session_itp.fold_all_session s
    (fun () any ->
      (match any with
      | APa pa ->
721 722
        let pa = Session_itp.get_proof_attempt_node s pa in
        if pn_proved s pa.parent then
723 724 725
          (match pa.Session_itp.proof_state with
          | None -> ()
          | Some pr ->
726 727 728
           if pa.Session_itp.proof_obsolete ||
                Call_provers.(pr.pr_answer <> Valid)
           then
Sylvain Dailler's avatar
Sylvain Dailler committed
729
             Session_itp.remove_subtree ~notification ~removed s any)
730
      | ATn tn ->
731 732
        let pn = get_trans_parent s tn in
        if pn_proved s pn && not (tn_proved s tn) then
Sylvain Dailler's avatar
Sylvain Dailler committed
733
          Session_itp.remove_subtree s ~notification ~removed (ATn tn)
734
      | _ -> ())) ()
735

736 737
(* This function folds on any subelements of given node and tries to mark all
   proof attempts it encounters *)
738
let mark_as_obsolete ~notification c any =
739
  let s = c.controller_session in
740
  (* Case for proof attempt only *)
741
  let mark_as_obsolete_pa n =
742 743
    let parent = get_proof_attempt_parent s n in
    Session_itp.mark_obsolete s n;
744
    notification (APa n);
745
    update_goal_node notification s parent
746 747 748
  in
  fold_all_any s
    (fun () any -> match any with
749
    | APa n -> mark_as_obsolete_pa n
750
    | _ -> ()) () any
751

Sylvain Dailler's avatar
Sylvain Dailler committed
752 753 754 755 756 757 758 759 760 761 762 763 764 765
exception BadCopyPaste

(* Reproduce the transformation made on node on an other one *)
let rec copy_paste ~notification ~callback_pa ~callback_tr c from_any to_any =
  let s = c.controller_session in
  if (not (is_below s from_any to_any) &&
      not (is_below s to_any from_any)) then
    match from_any, to_any with
    | AFile _, AFile _ ->
        raise BadCopyPaste
    | ATh _from_th, ATh _to_th ->
        raise BadCopyPaste
    | APn from_pn, APn to_pn ->
      let from_pa_list = get_proof_attempts s from_pn in
766
      List.iter (fun x -> schedule_pa_with_same_arguments c x to_pn ~counterexmp:false
Sylvain Dailler's avatar
Sylvain Dailler committed
767 768
          ~callback:callback_pa ~notification) from_pa_list;
      let from_tr_list = get_transformations s from_pn in
769
      let callback x tr args st = callback_tr tr args st;
Sylvain Dailler's avatar
Sylvain Dailler committed
770
        match st with
Sylvain Dailler's avatar
Sylvain Dailler committed
771 772
        | TSdone tid ->
          copy_paste c (ATn x) (ATn tid) ~notification ~callback_pa ~callback_tr
Sylvain Dailler's avatar
Sylvain Dailler committed
773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
        | _ -> ()
      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
        if (List.length from_tn_list = List.length to_tn_list) then
          List.iter2 (fun x y -> copy_paste c (APn x) (APn y)
              ~notification ~callback_pa ~callback_tr) from_tn_list to_tn_list
    | _ -> raise BadCopyPaste


let copy_detached ~copy c from_any =
  match from_any with
  | APn from_pn ->
    begin
      let pn_id = copy_proof_node_as_detached c.controller_session from_pn in
      let parent = get_any_parent c.controller_session from_any in
      match parent with
793
      | None -> raise (BadCopyDetached "copy_detached no parent")
Sylvain Dailler's avatar
Sylvain Dailler committed
794 795
      | Some parent ->
          copy ~parent (APn pn_id);
Sylvain Dailler's avatar
Sylvain Dailler committed
796 797
          copy_structure
            ~notification:copy c.controller_session (APn from_pn) (APn pn_id)
Sylvain Dailler's avatar
Sylvain Dailler committed
798
    end
799 800
  (* Only goal can be detached *)
  | _ -> raise (BadCopyDetached "copy_detached. Can only copy goal")
Sylvain Dailler's avatar
Sylvain Dailler committed
801

MARCHE Claude's avatar
MARCHE Claude committed
802 803 804 805 806 807 808 809 810 811 812







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



813 814 815 816
type report =
  | Result of Call_provers.prover_result * Call_provers.prover_result
  (** Result(new_result,old_result) *)
  | CallFailed of exn
817
  | Replay_interrupted
818 819 820 821 822 823 824 825 826 827 828
  | 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
829 830 831 832
  | CallFailed e ->
    Format.fprintf fmt "Callfailed %a@." Exn_printer.exn_printer e
  | Replay_interrupted ->
    Format.fprintf fmt "Interrupted@."
833 834 835 836 837 838 839 840 841
  | 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 *)
842
let replay_print fmt (lr: (proofNodeID * Whyconf.prover * Call_provers.resource_limit * report) list) =
843 844
  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
845 846
      (Obj.magic id) Whyconf.print_prover pr
      rl.Call_provers.limit_time print_report report
847
  in
848
  Format.fprintf fmt "%a@." (Pp.print_list Pp.newline pp_elem) lr
849

850 851
let replay ?(obsolete_only=true) ?(use_steps=false)
           c ~callback ~notification ~final_callback =
852

853
  let craft_report count s r id pr limits pa =
854
    match s with
855 856 857
    | Scheduled | Running -> ()
    | Unedited | JustEdited -> assert false
    | Interrupted ->
858
       decr count;
859
       r := (id, pr, limits, Replay_interrupted ) :: !r
860
    | Done new_r ->
861
       decr count;
862 863 864 865
        (match pa.Session_itp.proof_state with
        | None -> (r := (id, pr, limits, No_former_result new_r) :: !r)
        | Some old_r -> r := (id, pr, limits, Result (new_r, old_r)) :: !r)
    | InternalFailure e ->
866
       decr count;
867
        r := (id, pr, limits, CallFailed (e)) :: !r
868 869 870
    | Uninstalled _ ->
       decr count;
       r := (id, pr, limits, Prover_not_installed) :: !r;
871
    | Detached -> decr count
872
  in
873 874 875 876 877 878 879 880

  let session = c.controller_session in
  let count = ref 0 in
  let report = ref [] in

  (* TODO count the number of node in a more efficient way *)
  (* Counting the number of proof_attempt to print report only once *)
  Session_itp.session_iter_proof_attempt
881
    (fun _ pa -> if pa.proof_obsolete || not obsolete_only then incr count) session;
882 883

  (* Replaying function *)
884
  let replay_pa id pa =
885 886 887 888
    if pa.proof_obsolete || not obsolete_only then
      begin
        let parid = pa.parent in
        let pr = pa.prover in
889 890 891 892
        (* 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 *)
893 894 895 896 897 898
        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
899
        replay_proof_attempt c pr limit parid id
900 901 902 903 904 905
                             ~callback:(fun id s ->
                                        craft_report count s report parid pr limit pa;
                                        callback id s;
                                        if !count = 0 then final_callback !report)
                             ~notification
      end in
906

907
  if !count = 0 then final_callback !report else
908
  (* Calling replay on all the proof_attempts of the session *)
909
  Session_itp.session_iter_proof_attempt replay_pa session
910

MARCHE Claude's avatar
MARCHE Claude committed
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936



(*************** bisect **********)



let debug = Debug.register_flag ~desc:"Task bisection" "bisect"

let bisect_proof_attempt ~notification c pa_id =
  let ses = c.controller_session in
  let pa = get_proof_attempt_node ses pa_id in
  let goal_id = pa.parent in
  let prover = pa.prover in
  let limit = { pa.limit with
                Call_provers.limit_steps =
                  Call_provers.empty_limit.Call_provers.limit_steps }
  in
  let timelimit = ref (-1) in
  let set_timelimit res =
    timelimit := 1 + (int_of_float (floor res.Call_provers.pr_time)) in
  let rec callback kont _pa_id = function
    | Running | Scheduled -> ()
    | Interrupted ->
      Debug.dprintf debug "Bisecting interrupted.@."
    | Unedited | JustEdited -> assert false
937
    | Detached | Uninstalled _ -> assert false
MARCHE Claude's avatar
MARCHE Claude committed
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
    | InternalFailure exn ->
      (* Perhaps the test can be considered false in this case? *)
      Debug.dprintf debug "Bisecting interrupted by an error %a.@."
        Exn_printer.exn_printer exn
    | Done res ->
      let b = res.Call_provers.pr_answer = Call_provers.Valid in
      Debug.dprintf debug "Bisecting: %a.@."
        Call_provers.print_prover_result res;
      if b then set_timelimit res;
      match kont b with
      | Eliminate_definition.BSdone rem ->
         if Decl.Spr.is_empty rem.Eliminate_definition.rem_pr &&
              Term.Sls.is_empty rem.Eliminate_definition.rem_ls &&
                Ty.Sts.is_empty rem.Eliminate_definition.rem_ts
         then
           Debug.dprintf debug "Bisecting doesn't reduced the task.@."
         else
           begin
             Debug.dprintf debug "Bisecting done.@.";
             ()
(*
        begin try
        let keygen = MA.keygen in
        let notify = MA.notify in
        let reml = List.map (fun (m,l) -> m.Theory.meta_name,l) reml in
        let metas = S.add_registered_metas ~keygen ses reml pa.S.proof_parent in
        let trans = S.add_registered_transformation ~keygen
          ses "eliminate_builtin" metas.S.metas_goal in
        let goal = List.hd trans.S.transf_goals in (* only one *)
        let npa = S.copy_external_proof ~notify ~keygen ~obsolete:true
          ~goal ~env_session:ses pa in
        MA.init_any (S.Metas metas);
        M.run_external_proof ses sched ~cntexample npa
        with e ->
          dprintf debug "Bisecting error:@\n%a@."
            Exn_printer.exn_printer e end
 *)
           end
976
      | Eliminate_definition.BSstep (_rem,kont) ->
MARCHE Claude's avatar
MARCHE Claude committed
977 978 979 980 981 982 983 984 985 986

         schedule_proof_attempt
           c goal_id prover
	  ~counterexmp:false
          ~limit:{ limit with Call_provers.limit_time = !timelimit; }
          ~callback:(callback kont)
          ~notification
  in
  (* Run once the complete goal in order to verify its validity and
     update the proof attempt *)
987
  let first_callback _pa_id = function
MARCHE Claude's avatar
MARCHE Claude committed
988 989 990 991
    (* this pa_id can be different from the first pa_id *)
    | Running | Scheduled -> ()
    | Interrupted ->
      Debug.dprintf debug "Bisecting interrupted.@."
992
    | Unedited | JustEdited | Detached | Uninstalled _ -> assert false
MARCHE Claude's avatar
MARCHE Claude committed
993 994 995 996 997 998 999 1000 1001 1002
    | InternalFailure exn ->
        Debug.dprintf debug "proof of the initial task interrupted by an error %a.@."
          Exn_printer.exn_printer exn
    | Done res ->
      if res.Call_provers.pr_answer <> Call_provers.Valid
      then Debug.dprintf debug "Initial task can't be proved.@."
      else
        let t = get_raw_task ses goal_id in
        let r = Eliminate_definition.bisect_step t in
        match r with
1003
        | Eliminate_definition.BSdone _res ->
MARCHE Claude's avatar
MARCHE Claude committed
1004
          Debug.dprintf debug "Task can't be reduced.@."
1005
        | Eliminate_definition.BSstep (_rem,kont) ->
MARCHE Claude's avatar
MARCHE Claude committed
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
          set_timelimit res;
          schedule_proof_attempt
            c goal_id prover
	    ~counterexmp:false
            ~limit:{ limit with Call_provers.limit_time = !timelimit}
            ~callback:(callback kont)
            ~notification
  in
  Debug.dprintf debug "Bisecting with %a started.@."
    Whyconf.print_prover prover;
  schedule_proof_attempt
    c goal_id prover ~counterexmp:false ~limit ~callback:first_callback ~notification

1019
end