controller_itp.ml 37.8 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
  | 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
41

MARCHE Claude's avatar
MARCHE Claude committed
42 43
let print_status fmt st =
  match st with
44
  | Detached          -> fprintf fmt "Detached"
Sylvain Dailler's avatar
Sylvain Dailler committed
45 46 47 48 49 50 51 52 53
  | 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
54 55

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

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

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

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


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

82

83
let create_controller config env ses =
84 85
  let c =
    {
86
      controller_session = ses;
87 88 89
      controller_config = config;
      controller_env = env;
      controller_provers = Whyconf.Hprover.create 7;
90
      controller_strategies = Stdlib.Hstr.create 7;
91 92 93 94 95 96
    }
  in
  let provers = Whyconf.get_provers config in
  Whyconf.Mprover.iter
    (fun _ p ->
     try
97
       let d = Whyconf.load_driver (Whyconf.get_main config) env p.Whyconf.driver [] in
98 99
       Whyconf.Hprover.add c.controller_provers p.Whyconf.prover (p,d)
     with e ->
Sylvain Dailler's avatar
Sylvain Dailler committed
100
       Debug.dprintf debug_call_prover
101 102 103 104 105 106
         "[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
107
let remove_subtree c = Session_itp.remove_subtree c.controller_session
108

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

118 119


120 121 122 123 124 125 126 127 128 129 130 131
(* printing *)

module PSession = struct

  open Stdlib

  type any =
    | Session
    | File of file
    | Theory of theory
    | Goal of proofNodeID
    | Transf of transID
132
    | ProofAttempt of proof_attempt_node
133 134 135 136 137 138 139 140 141 142

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

(*********)



190 191 192 193 194 195

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

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

let add_file c ?format fname =
207 208 209
  let theories = Session_itp.read_file c.controller_env ?format fname in
  let (_ : file) = add_file_section c.controller_session fname theories format in
  ()
210

211 212

module type Scheduler = sig
213
  val multiplier: int
214 215 216 217
  val timeout: ms:int -> (unit -> bool) -> unit
  val idle: prio:int -> (unit -> bool) -> unit
end

218 219
module Make(S : Scheduler) = struct

MARCHE Claude's avatar
MARCHE Claude committed
220 221
let scheduled_proof_attempts = Queue.create ()

222 223 224 225 226 227
let prover_tasks_in_progress = Hashtbl.create 17

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

let timeout_handler_running = ref false

let max_number_of_running_provers = ref 1

233 234 235 236
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
237
let number_of_running_provers = ref 0
238

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

let register_observer = (:=) observer

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

245 246 247 248 249 250 251 252 253 254 255 256 257
(* 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
258
    let steplimit = limits.Call_provers.limit_steps in
259 260 261 262 263 264 265 266 267 268 269 270 271 272
    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
273 274
         | Call_provers.OutOfMemory -> increased_time, memlimit, steplimit
         | Call_provers.Timeout -> timelimit, increased_mem, steplimit
275 276 277 278 279 280 281
         | 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
282
         | Call_provers.Invalid -> increased_time, increased_mem, steplimit
283 284 285
         | Call_provers.Failure _
         | Call_provers.HighFailure ->
            (* correct ? failures are supposed to appear quickly anyway... *)
286
            timelimit, memlimit, steplimit
287 288
       end
    | None when interactive -> 0, 0, 0
289
    | None -> timelimit, memlimit, steplimit
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
  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 =
312
  let (config_pr,driver) = Hprover.find c.controller_provers pr in
313
  let with_steps = Call_provers.(limit.limit_steps <> empty_limit.limit_steps) in
314
  let command =
315
    Whyconf.get_complete_command config_pr ~with_steps in
316 317
  try
    let task = Session_itp.get_raw_task c.controller_session id in
318 319 320
    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
321
    let call =
322 323
      Driver.prove_task ?old:proof_script ~cntexample:cntexample ~inplace ~command
                        ~limit driver task
324
    in
325
    let pa = (c.controller_session,id,pr,callback,false,call,ores) in
326
    Hashtbl.replace prover_tasks_in_progress call pa
327 328
  with Not_found (* goal has no task, it is detached *) ->
       callback Detached
MARCHE Claude's avatar
MARCHE Claude committed
329

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

MARCHE Claude's avatar
MARCHE Claude committed
336 337
let timeout_handler () =
  (* examine all the prover tasks in progress *)
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
  (* 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
    let results = Call_provers.forward_results ~blocking:false (* TODO *) in
    while not (Queue.is_empty results) do
      let (call, prover_update) = Queue.pop results in
      let c = try Some (Hashtbl.find prover_tasks_in_progress call)
        with Not_found -> None in
      match c with
      | None -> () (* we do nothing. We probably received ProverStarted after
                      ProverFinished because what is sent to and received from
                      the server is not ordered. *)
      | Some c ->
      begin
        let (ses,id,pr,callback,started,call,ores) = c in

        match prover_update with
        | Call_provers.NoUpdates -> ()
        | Call_provers.ProverStarted ->
            assert (not started);
            callback Running;
            incr number_of_running_provers;
            Hashtbl.replace prover_tasks_in_progress call
              (ses,id,pr,callback,true,call,ores)
        | Call_provers.ProverFinished res ->
            Hashtbl.remove prover_tasks_in_progress call;
            if started then decr number_of_running_provers;
            let res = Opt.fold fuzzy_proof_time res ores in
            (* inform the callback *)
            callback (Done res)
        | Call_provers.ProverInterrupted ->
            Hashtbl.remove prover_tasks_in_progress call;
            if started then decr number_of_running_provers;
            (* inform the callback *)
            callback (Interrupted)
        | Call_provers.InternalFailure exn ->
            Hashtbl.remove prover_tasks_in_progress call;
            if started then decr number_of_running_provers;
            (* inform the callback *)
            callback (InternalFailure (exn))
      end
    done
  end;

  (* Check for editor calls which are not finished *)
MARCHE Claude's avatar
MARCHE Claude committed
383
  let q = Queue.create () in
384 385 386 387 388 389
  while not (Queue.is_empty prover_tasks_edited) do
    (* call is an EditorCall *)
    let (_ses,_id,_pr,callback,_started,call,ores) as c =
      Queue.pop prover_tasks_edited in
    let prover_update = Call_provers.query_call call in
    match prover_update with
MARCHE Claude's avatar
MARCHE Claude committed
390
    | Call_provers.NoUpdates -> Queue.add c q
391
    | Call_provers.ProverFinished res ->
392
       let res = Opt.fold fuzzy_proof_time res ores in
393
       (* inform the callback *)
MARCHE Claude's avatar
MARCHE Claude committed
394
       callback (Done res)
395
    | _ -> assert (false) (* An edition can only return Noupdates or finished *)
MARCHE Claude's avatar
MARCHE Claude committed
396
  done;
397 398 399
  Queue.transfer q prover_tasks_edited;

  (* if the number of prover tasks is less than S.multiplier times the maximum
MARCHE Claude's avatar
MARCHE Claude committed
400 401
     number of running provers, then we heuristically decide to add
     more tasks *)
402 403
  begin
    try
404
      for _i = Hashtbl.length prover_tasks_in_progress
405
          to S.multiplier * !max_number_of_running_provers do
406 407
        let (c,id,pr,limit,proof_script,callback,cntexample,ores) =
          Queue.pop scheduled_proof_attempts in
408
        try
409
          build_prover_call ?proof_script ~cntexample c id pr limit callback ores
410
        with e when not (Debug.test_flag Debug.stack_trace) ->
411
          (*Format.eprintf
412
            "@[Exception raised in Controller_itp.build_prover_call:@ %a@.@]"
413
            Exn_printer.exn_printer e;*)
414 415 416 417
          callback (InternalFailure e)
      done
  with Queue.Empty -> ()
  end;
418
  update_observer ();
419
  true
MARCHE Claude's avatar
MARCHE Claude committed
420

421
let interrupt () =
422 423 424 425 426 427 428
  (* Interrupt provers *)
  Hashtbl.iter (fun _k e ->
    let (_, _, _, callback, _, _, _) = e in callback Interrupted)
    prover_tasks_in_progress;
  Hashtbl.clear prover_tasks_in_progress;
  (* Do not interrupt editors
  while not (Queue.is_empty prover_tasks_edited) do
429
    let (_ses,_id,_pr,callback,_started,_call,_ores) =
430
      Queue.pop prover_tasks_edited in
431 432
    callback Interrupted
  done;
433
  *)
434 435
  number_of_running_provers := 0;
  while not (Queue.is_empty scheduled_proof_attempts) do
436 437
    let (_c,_id,_pr,_limit,_proof_script,callback,_cntexample,_ores) =
      Queue.pop scheduled_proof_attempts in
438 439 440 441
    callback Interrupted
  done;
  !observer 0 0 0

MARCHE Claude's avatar
MARCHE Claude committed
442 443 444 445
let run_timeout_handler () =
  if not !timeout_handler_running then
    begin
      timeout_handler_running := true;
446
      S.timeout ~ms:default_delay_ms timeout_handler;
MARCHE Claude's avatar
MARCHE Claude committed
447 448
    end

449 450 451 452 453 454 455
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 ->
456
        update_proof_attempt ~obsolete:false notification ses id pr res;
457 458 459 460 461
        update_goal_node notification ses id
    | _ -> ());
    callback panid s
  in
  let adaptlimit,ores,proof_script =
462
    try
463
      let h = get_proof_attempt_ids ses id in
464
      let pa = Hprover.find h pr in
465
      let a = get_proof_attempt_node ses pa in
466 467 468 469 470
      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
471 472 473 474 475 476
      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
477
  in
478
  let panid = graft_proof_attempt ~limit ses id pr in
479
  Queue.add (c,id,pr,adaptlimit,proof_script,callback panid,counterexmp,ores)
480
            scheduled_proof_attempts;
481
  callback panid Scheduled;
MARCHE Claude's avatar
MARCHE Claude committed
482
  run_timeout_handler ()
Clément Fumex's avatar
Clément Fumex committed
483

484

485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521

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

522
let replay_proof_attempt c pr limit (parid: proofNodeID) id ~callback ~notification =
523 524 525 526 527
  (* 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 ->
528 529
     try
       let _ = get_raw_task c.controller_session parid in
530
       schedule_proof_attempt c parid pr ~counterexmp:false ~limit ~callback ~notification
531 532
     with Not_found ->
       callback id Detached
533 534


535
(* TODO to be simplified *)
Sylvain Dailler's avatar
Sylvain Dailler committed
536 537 538
(* 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
539
  let driver = snd (Hprover.find c.controller_provers pr) in
540
  let task = Session_itp.get_raw_task session pn in
Sylvain Dailler's avatar
Sylvain Dailler committed
541 542 543 544
  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
545
  let fn = Filename.chop_extension (Filename.basename (file_name f)) in
Sylvain Dailler's avatar
Sylvain Dailler committed
546 547 548 549 550 551 552 553
  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
554
  let driver = snd (Hprover.find c.controller_provers pr) in
555
  let task = Session_itp.get_raw_task session pn in
Sylvain Dailler's avatar
Sylvain Dailler committed
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
  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

587
let schedule_edition c id pr ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
588 589 590 591 592 593
  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
594
  (* Make sure editor exists. Fails otherwise *)
Sylvain Dailler's avatar
Sylvain Dailler committed
595 596
  let editor =
    match prover_conf.Whyconf.editor with
597
    | "" -> raise Editor_not_found
Sylvain Dailler's avatar
Sylvain Dailler committed
598
    | s ->
599 600 601 602 603
       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
604 605 606
  in
  let proof_attempts_id = get_proof_attempt_ids session id in
  let panid =
607 608
    try Hprover.find proof_attempts_id pr
    with Not_found ->
609 610 611
      let file = update_edit_external_proof c id pr in
      let filename = Sysutil.relativize_filename session_dir file in
      graft_proof_attempt session id pr ~file:filename ~limit
Sylvain Dailler's avatar
Sylvain Dailler committed
612
  in
613
  let pa = get_proof_attempt_node session panid in
614
  (* Notification node *)
615 616 617 618
  let callback panid s =
    begin
      match s with
      | Scheduled | Running ->
619 620 621
                     update_goal_node notification session id
      | Done res ->
         (* set obsolete to true since we do not know if the manual
622
            proof was completed or not *)
623 624 625 626 627
         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
628 629 630 631
      | Interrupted | InternalFailure _ -> ()
      | _ -> ()
    end;
    callback panid s
632
  in
633 634
  let file = Opt.get pa.proof_script in
  let file = Filename.concat session_dir file in
Sylvain Dailler's avatar
Sylvain Dailler committed
635
  Debug.dprintf debug_sched "[Editing] goal %s with command '%s' on file %s@."
636 637
                (Session_itp.get_proof_name session id).Ident.id_string
                editor file;
638 639
  let call = Call_provers.call_editor ~command:editor file in
  callback panid Running;
640
  Queue.add (c.controller_session,id,pr,callback panid,false,call,None)
641
            prover_tasks_edited;
642
  run_timeout_handler ()
643

644 645 646 647 648 649 650 651
(* TODO get back no_edit ???
 if no_edit then
    begin
      callback panid Running;
      callback panid Interrupted
    end
*)

Sylvain Dailler's avatar
Sylvain Dailler committed
652

653
let schedule_transformation_r c id name args ~callback =
654
  let apply_trans () =
655 656
    begin
      try
657 658 659
        let subtasks =
          apply_trans_to_goal ~allow_no_effect:false
                              c.controller_session c.controller_env name args id
660
        in
661 662 663 664 665 666 667
        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) ->
668
        (* Format.eprintf
669
          "@[Exception raised in Session_itp.apply_trans_to_goal %s:@ %a@.@]"
670
          name Exn_printer.exn_printer e; TODO *)
671
        callback (TSfailed (id, e))
672 673
    end;
    false
674 675 676
  in
  S.idle ~prio:0 apply_trans;
  callback TSscheduled
Clément Fumex's avatar
Clément Fumex committed
677

678
let schedule_transformation c id name args ~callback ~notification =
679
  let callback s = callback s; (match s with
680
      | TSdone tid -> update_trans_node notification c.controller_session tid
681
      | TSfailed _e -> ()
682
      | _ -> ()) in
683 684 685 686
  schedule_transformation_r c id name args ~callback

open Strategy

Sylvain Dailler's avatar
Sylvain Dailler committed
687
let run_strategy_on_goal
688
    c id strat ~counterexmp ~callback_pa ~callback_tr ~callback ~notification =
689 690 691 692 693 694
  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
695 696
         let callback panid res =
           callback_pa panid res;
697 698 699 700 701
           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
702 703
           | Interrupted | InternalFailure _ ->
              callback STShalt
704 705 706 707 708
           | 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
709
           | Detached | Uninstalled _ ->
710 711 712 713 714 715
                         (* should not happen *)
                         assert false
         in
         let limit = { Call_provers.empty_limit with
                       Call_provers.limit_time = timelimit;
                       limit_mem  = memlimit} in
716
         schedule_proof_attempt c g p ~counterexmp ~limit ~callback ~notification
717 718
      | Itransform(trname,pcsuccess) ->
         let callback ntr =
719
           callback_tr trname [] ntr;
720
           match ntr with
721
           | TSfailed _e -> (* transformation failed *)
722 723 724 725 726 727 728 729 730 731 732 733
              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
734
                (get_sub_tasks c.controller_session tid)
735
         in
736
         schedule_transformation c g trname [] ~callback ~notification
737 738 739 740 741 742
      | Igoto pc ->
         callback (STSgoto (g,pc));
         exec_strategy pc strat g
  in
  exec_strategy 0 strat id

Sylvain Dailler's avatar
Sylvain Dailler committed
743 744
let schedule_pa_with_same_arguments
    c (pa: proof_attempt_node) (pn: proofNodeID) ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
745 746 747 748
  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
749 750
let schedule_tr_with_same_arguments
    c (tr: transID) (pn: proofNodeID) ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
751 752 753
  let s = c.controller_session in
  let args = get_transf_args s tr in
  let name = get_transf_name s tr in
754
  let callback = callback name args in
Sylvain Dailler's avatar
Sylvain Dailler committed
755 756
  schedule_transformation c pn name args ~callback ~notification

757 758 759
let clean_session c ~removed =
  (* clean should not change proved status *)
  let notification _ = assert false in
760
  let s = c.controller_session in
761 762 763 764 765
  (* 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 ->
766 767
        let pa = Session_itp.get_proof_attempt_node s pa in
        if pn_proved s pa.parent then
768 769 770
          (match pa.Session_itp.proof_state with
          | None -> ()
          | Some pr ->
771 772 773
           if pa.Session_itp.proof_obsolete ||
                Call_provers.(pr.pr_answer <> Valid)
           then
Sylvain Dailler's avatar
Sylvain Dailler committed
774
             Session_itp.remove_subtree ~notification ~removed s any)
775
      | ATn tn ->
776 777
        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
778
          Session_itp.remove_subtree s ~notification ~removed (ATn tn)
779
      | _ -> ())) ()
780

781 782
(* This function folds on any subelements of given node and tries to mark all
   proof attempts it encounters *)
783
let mark_as_obsolete ~notification c any =
784
  let s = c.controller_session in
785
  (* Case for proof attempt only *)
786
  let mark_as_obsolete_pa n =
787 788
    let parent = get_proof_attempt_parent s n in
    Session_itp.mark_obsolete s n;
789
    notification (APa n);
790
    update_goal_node notification s parent
791 792 793
  in
  fold_all_any s
    (fun () any -> match any with
794
    | APa n -> mark_as_obsolete_pa n
795
    | _ -> ()) () any
796

Sylvain Dailler's avatar
Sylvain Dailler committed
797 798 799 800 801 802 803 804 805 806 807 808 809 810
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
811
      List.iter (fun x -> schedule_pa_with_same_arguments c x to_pn ~counterexmp:false
Sylvain Dailler's avatar
Sylvain Dailler committed
812 813
          ~callback:callback_pa ~notification) from_pa_list;
      let from_tr_list = get_transformations s from_pn in
814
      let callback x tr args st = callback_tr tr args st;
Sylvain Dailler's avatar
Sylvain Dailler committed
815
        match st with
Sylvain Dailler's avatar
Sylvain Dailler committed
816 817
        | TSdone tid ->
          copy_paste c (ATn x) (ATn tid) ~notification ~callback_pa ~callback_tr
Sylvain Dailler's avatar
Sylvain Dailler committed
818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
        | _ -> ()
      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
838
      | None -> raise (BadCopyDetached "copy_detached no parent")
Sylvain Dailler's avatar
Sylvain Dailler committed
839 840
      | Some parent ->
          copy ~parent (APn pn_id);
Sylvain Dailler's avatar
Sylvain Dailler committed
841 842
          copy_structure
            ~notification:copy c.controller_session (APn from_pn) (APn pn_id)
Sylvain Dailler's avatar
Sylvain Dailler committed
843
    end
844 845
  (* Only goal can be detached *)
  | _ -> raise (BadCopyDetached "copy_detached. Can only copy goal")
Sylvain Dailler's avatar
Sylvain Dailler committed
846

MARCHE Claude's avatar
MARCHE Claude committed
847 848 849 850 851 852 853 854 855 856 857







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



858 859 860 861
type report =
  | Result of Call_provers.prover_result * Call_provers.prover_result
  (** Result(new_result,old_result) *)
  | CallFailed of exn
862
  | Replay_interrupted
863 864 865 866 867 868 869 870 871 872 873
  | 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
874 875 876 877
  | CallFailed e ->
    Format.fprintf fmt "Callfailed %a@." Exn_printer.exn_printer e
  | Replay_interrupted ->
    Format.fprintf fmt "Interrupted@."
878 879 880 881 882 883 884 885 886
  | 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 *)
887
let replay_print fmt (lr: (proofNodeID * Whyconf.prover * Call_provers.resource_limit * report) list) =
888 889
  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
890 891
      (Obj.magic id) Whyconf.print_prover pr
      rl.Call_provers.limit_time print_report report
892
  in
893
  Format.fprintf fmt "%a@." (Pp.print_list Pp.newline pp_elem) lr
894

895 896
let replay ?(obsolete_only=true) ?(use_steps=false)
           c ~callback ~notification ~final_callback =
897

898
  let craft_report count s r id pr limits pa =
899
    match s with
900 901
    | Scheduled | Running -> ()
    | Interrupted ->
902
       decr count;
903
       r := (id, pr, limits, Replay_interrupted ) :: !r
904
    | Done new_r ->
905
       decr count;
906 907 908 909
        (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 ->
910
       decr count;
911
        r := (id, pr, limits, CallFailed (e)) :: !r
912 913 914
    | Uninstalled _ ->
       decr count;
       r := (id, pr, limits, Prover_not_installed) :: !r;
915
    | Detached -> decr count
916
  in
917 918 919 920 921 922 923 924

  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
925
    (fun _ pa -> if pa.proof_obsolete || not obsolete_only then incr count) session;
926 927

  (* Replaying function *)
928
  let replay_pa id pa =
929 930 931 932
    if pa.proof_obsolete || not obsolete_only then
      begin
        let parid = pa.parent in
        let pr = pa.prover in
933 934 935 936
        (* 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 *)
937 938 939 940 941 942
        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
943
        replay_proof_attempt c pr limit parid id
944 945 946 947 948 949
                             ~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
950

951
  if !count = 0 then final_callback !report else
952
  (* Calling replay on all the proof_attempts of the session *)
953
  Session_itp.session_iter_proof_attempt replay_pa session
954

MARCHE Claude's avatar
MARCHE Claude committed
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979



(*************** 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.@."
980
    | Detached | Uninstalled _ -> assert false
MARCHE Claude's avatar
MARCHE Claude committed
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
    | 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
1019
      | Eliminate_definition.BSstep (_rem,kont) ->
MARCHE Claude's avatar
MARCHE Claude committed
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029

         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 *)
1030
  let first_callback _pa_id = function
MARCHE Claude's avatar
MARCHE Claude committed
1031 1032 1033 1034
    (* this pa_id can be different from the first pa_id *)
    | Running | Scheduled -> ()
    | Interrupted ->
      Debug.dprintf debug "Bisecting interrupted.@."
1035
    | Detached | Uninstalled _ -> assert false
MARCHE Claude's avatar
MARCHE Claude committed
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
    | 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
1046
        | Eliminate_definition.BSdone _res ->
MARCHE Claude's avatar
MARCHE Claude committed
1047
          Debug.dprintf debug "Task can't be reduced.@."
1048
        | Eliminate_definition.BSstep (_rem,kont) ->
MARCHE Claude's avatar
MARCHE Claude committed
1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
          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

1062
end