controller_itp.ml 39.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 blocking: bool
214
  val multiplier: int
215 216 217 218
  val timeout: ms:int -> (unit -> bool) -> unit
  val idle: prio:int -> (unit -> bool) -> unit
end

219 220
module Make(S : Scheduler) = struct

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

223 224 225 226 227 228
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
229 230 231 232 233

let timeout_handler_running = ref false

let max_number_of_running_provers = ref 1

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

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

let register_observer = (:=) observer

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

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

339 340
let update_observer () =
  let scheduled = Queue.length scheduled_proof_attempts in
341
  let waiting_or_running = Hashtbl.length prover_tasks_in_progress in
342 343 344
  let running = !number_of_running_provers in
  !observer scheduled (waiting_or_running - running) running

MARCHE Claude's avatar
MARCHE Claude committed
345 346
let timeout_handler () =
  (* examine all the prover tasks in progress *)
347 348 349
  (* 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
350
    let results = Call_provers.forward_results ~blocking:S.blocking in
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 383 384 385 386 387 388 389 390
    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;

391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
  (* 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 *)
      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
      | Call_provers.NoUpdates -> Queue.add c q
      | Call_provers.ProverFinished res ->
          let res = Opt.fold fuzzy_proof_time res ores in
          (* inform the callback *)
          callback (Done res)
      | _ -> assert (false) (* An edition can only return Noupdates or finished *)
    done;
    Queue.transfer q prover_tasks_edited;
  end;
411 412

  (* if the number of prover tasks is less than S.multiplier times the maximum
MARCHE Claude's avatar
MARCHE Claude committed
413 414
     number of running provers, then we heuristically decide to add
     more tasks *)
415 416
  begin
    try
417
      for _i = Hashtbl.length prover_tasks_in_progress
418
          to S.multiplier * !max_number_of_running_provers do
419 420
        let (c,id,pr,limit,proof_script,callback,cntexample,ores) =
          Queue.pop scheduled_proof_attempts in
421
        try
422
          build_prover_call ?proof_script ~cntexample c id pr limit callback ores
423
        with e when not (Debug.test_flag Debug.stack_trace) ->
424
          (*Format.eprintf
425
            "@[Exception raised in Controller_itp.build_prover_call:@ %a@.@]"
426
            Exn_printer.exn_printer e;*)
427 428 429 430
          callback (InternalFailure e)
      done
  with Queue.Empty -> ()
  end;
431
  update_observer ();
432
  true
MARCHE Claude's avatar
MARCHE Claude committed
433

434
let interrupt () =
435 436 437 438 439 440 441
  (* 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
442
    let (_ses,_id,_pr,callback,_started,_call,_ores) =
443
      Queue.pop prover_tasks_edited in
444 445
    callback Interrupted
  done;
446
  *)
447 448
  number_of_running_provers := 0;
  while not (Queue.is_empty scheduled_proof_attempts) do
449 450
    let (_c,_id,_pr,_limit,_proof_script,callback,_cntexample,_ores) =
      Queue.pop scheduled_proof_attempts in
451 452 453 454
    callback Interrupted
  done;
  !observer 0 0 0

MARCHE Claude's avatar
MARCHE Claude committed
455 456 457 458
let run_timeout_handler () =
  if not !timeout_handler_running then
    begin
      timeout_handler_running := true;
459
      S.timeout ~ms:default_delay_ms timeout_handler;
MARCHE Claude's avatar
MARCHE Claude committed
460 461
    end

462 463 464 465 466 467 468
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 ->
469
        update_proof_attempt ~obsolete:false notification ses id pr res;
470 471 472 473 474
        update_goal_node notification ses id
    | _ -> ());
    callback panid s
  in
  let adaptlimit,ores,proof_script =
475
    try
476
      let h = get_proof_attempt_ids ses id in
477
      let pa = Hprover.find h pr in
478
      let a = get_proof_attempt_node ses pa in
479 480 481 482 483
      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
484 485 486 487 488 489
      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
490
  in
491
  let panid = graft_proof_attempt ~limit ses id pr in
492
  Queue.add (c,id,pr,adaptlimit,proof_script,callback panid,counterexmp,ores)
493
            scheduled_proof_attempts;
494
  callback panid Scheduled;
MARCHE Claude's avatar
MARCHE Claude committed
495
  run_timeout_handler ()
Clément Fumex's avatar
Clément Fumex committed
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 522 523 524 525 526 527 528 529 530 531 532 533 534

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

535
let replay_proof_attempt c pr limit (parid: proofNodeID) id ~callback ~notification =
536 537 538 539 540
  (* 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 ->
541 542
     try
       let _ = get_raw_task c.controller_session parid in
543
       schedule_proof_attempt c parid pr ~counterexmp:false ~limit ~callback ~notification
544 545
     with Not_found ->
       callback id Detached
546 547


548 549
(*** { 2 edition of proof scripts} *)

Sylvain Dailler's avatar
Sylvain Dailler committed
550 551 552
(* 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
553
  let driver = snd (Hprover.find c.controller_provers pr) in
554
  let task = Session_itp.get_raw_task session pn in
Sylvain Dailler's avatar
Sylvain Dailler committed
555 556 557 558
  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
559
  let fn = Filename.chop_extension (Filename.basename (file_name f)) in
Sylvain Dailler's avatar
Sylvain Dailler committed
560 561 562 563 564 565
  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

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

exception Editor_not_found

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

665 666
(*** { 2 transformations} *)

667
let schedule_transformation_r c id name args ~callback =
668
  let apply_trans () =
669 670
    begin
      try
671 672 673
        let subtasks =
          apply_trans_to_goal ~allow_no_effect:false
                              c.controller_session c.controller_env name args id
674
        in
675 676 677 678 679 680 681
        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) ->
682
        (* Format.eprintf
683
          "@[Exception raised in Session_itp.apply_trans_to_goal %s:@ %a@.@]"
684
          name Exn_printer.exn_printer e; TODO *)
685
        callback (TSfailed (id, e))
686 687
    end;
    false
688 689 690
  in
  S.idle ~prio:0 apply_trans;
  callback TSscheduled
Clément Fumex's avatar
Clément Fumex committed
691

692
let schedule_transformation c id name args ~callback ~notification =
693
  let callback s = callback s; (match s with
694
      | TSdone tid -> update_trans_node notification c.controller_session tid
695
      | TSfailed _e -> ()
696
      | _ -> ()) in
697 698 699 700
  schedule_transformation_r c id name args ~callback

open Strategy

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

Sylvain Dailler's avatar
Sylvain Dailler committed
757 758
let schedule_pa_with_same_arguments
    c (pa: proof_attempt_node) (pn: proofNodeID) ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
759 760 761 762
  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
763 764
let schedule_tr_with_same_arguments
    c (tr: transID) (pn: proofNodeID) ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
765 766 767
  let s = c.controller_session in
  let args = get_transf_args s tr in
  let name = get_transf_name s tr in
768
  let callback = callback name args in
Sylvain Dailler's avatar
Sylvain Dailler committed
769 770
  schedule_transformation c pn name args ~callback ~notification

MARCHE Claude's avatar
MARCHE Claude committed
771 772 773 774 775 776 777
let proof_is_complete pa =
  match pa.Session_itp.proof_state with
  | None -> false
  | Some pr ->
     not pa.Session_itp.proof_obsolete &&
       Call_provers.(pr.pr_answer <> Valid)

778 779 780
let clean_session c ~removed =
  (* clean should not change proved status *)
  let notification _ = assert false in
781
  let s = c.controller_session in
782 783 784 785 786
  (* 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 ->
787 788
        let pa = Session_itp.get_proof_attempt_node s pa in
        if pn_proved s pa.parent then
MARCHE Claude's avatar
MARCHE Claude committed
789 790
          if not (proof_is_complete pa) then
            Session_itp.remove_subtree ~notification ~removed s any
791
      | ATn tn ->
792 793
        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
794
          Session_itp.remove_subtree s ~notification ~removed (ATn tn)
795
      | _ -> ())) ()
796

797 798
(* This function folds on any subelements of given node and tries to mark all
   proof attempts it encounters *)
799
let mark_as_obsolete ~notification c any =
800
  let s = c.controller_session in
801
  (* Case for proof attempt only *)
802
  let mark_as_obsolete_pa n =
803 804
    let parent = get_proof_attempt_parent s n in
    Session_itp.mark_obsolete s n;
805
    notification (APa n);
806
    update_goal_node notification s parent
807 808 809
  in
  fold_all_any s
    (fun () any -> match any with
810
    | APa n -> mark_as_obsolete_pa n
811
    | _ -> ()) () any
812

Sylvain Dailler's avatar
Sylvain Dailler committed
813 814 815 816 817 818 819 820 821 822 823 824 825 826
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
827
      List.iter (fun x -> schedule_pa_with_same_arguments c x to_pn ~counterexmp:false
Sylvain Dailler's avatar
Sylvain Dailler committed
828 829
          ~callback:callback_pa ~notification) from_pa_list;
      let from_tr_list = get_transformations s from_pn in
830
      let callback x tr args st = callback_tr tr args st;
Sylvain Dailler's avatar
Sylvain Dailler committed
831
        match st with
Sylvain Dailler's avatar
Sylvain Dailler committed
832 833
        | TSdone tid ->
          copy_paste c (ATn x) (ATn tid) ~notification ~callback_pa ~callback_tr
Sylvain Dailler's avatar
Sylvain Dailler committed
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
        | _ -> ()
      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
854
      | None -> raise (BadCopyDetached "copy_detached no parent")
Sylvain Dailler's avatar
Sylvain Dailler committed
855 856
      | Some parent ->
          copy ~parent (APn pn_id);
Sylvain Dailler's avatar
Sylvain Dailler committed
857 858
          copy_structure
            ~notification:copy c.controller_session (APn from_pn) (APn pn_id)
Sylvain Dailler's avatar
Sylvain Dailler committed
859
    end
860 861
  (* Only goal can be detached *)
  | _ -> raise (BadCopyDetached "copy_detached. Can only copy goal")
Sylvain Dailler's avatar
Sylvain Dailler committed
862

MARCHE Claude's avatar
MARCHE Claude committed
863 864 865 866 867 868 869 870 871 872 873







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



874 875 876 877
type report =
  | Result of Call_provers.prover_result * Call_provers.prover_result
  (** Result(new_result,old_result) *)
  | CallFailed of exn
878
  | Replay_interrupted
879 880 881 882 883 884 885 886 887 888 889
  | 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
890 891 892 893
  | CallFailed e ->
    Format.fprintf fmt "Callfailed %a@." Exn_printer.exn_printer e
  | Replay_interrupted ->
    Format.fprintf fmt "Interrupted@."
894 895 896 897 898 899 900 901 902
  | 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 *)
903
let replay_print fmt (lr: (proofNodeID * Whyconf.prover * Call_provers.resource_limit * report) list) =
904 905
  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
906 907
      (Obj.magic id) Whyconf.print_prover pr
      rl.Call_provers.limit_time print_report report
908
  in
909
  Format.fprintf fmt "%a@." (Pp.print_list Pp.newline pp_elem) lr
910

911 912
let replay ?(obsolete_only=true) ?(use_steps=false)
           c ~callback ~notification ~final_callback =
913

914
  let craft_report count s r id pr limits pa =
915
    match s with
916 917
    | Scheduled | Running -> ()
    | Interrupted ->
918
       decr count;
919
       r := (id, pr, limits, Replay_interrupted ) :: !r
920
    | Done new_r ->
921
       decr count;
922 923 924 925
        (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 ->
926
       decr count;
927
        r := (id, pr, limits, CallFailed (e)) :: !r
928 929 930
    | Uninstalled _ ->
       decr count;
       r := (id, pr, limits, Prover_not_installed) :: !r;
931
    | Detached -> decr count
932
  in
933 934 935 936 937 938 939 940

  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
941
    (fun _ pa -> if pa.proof_obsolete || not obsolete_only then incr count) session;
942 943

  (* Replaying function *)
944
  let replay_pa id pa =
945 946 947 948
    if pa.proof_obsolete || not obsolete_only then
      begin
        let parid = pa.parent in
        let pr = pa.prover in
949 950 951 952
        (* 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 *)
953 954 955 956 957 958
        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
959
        replay_proof_attempt c pr limit parid id
960 961 962 963 964 965
                             ~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
966

967
  if !count = 0 then final_callback !report else
968
  (* Calling replay on all the proof_attempts of the session *)
969
  Session_itp.session_iter_proof_attempt replay_pa session
970

MARCHE Claude's avatar
MARCHE Claude committed
971 972 973 974 975 976 977 978 979



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



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

MARCHE Claude's avatar
MARCHE Claude committed
980 981 982 983 984 985 986 987 988 989
let create_rem_list rem =
  let remove_ts acc ts = ts.Ty.ts_name.Ident.id_string :: acc in
  let remove_ls acc ls = ls.Term.ls_name.Ident.id_string :: acc in
  let remove_pr acc pr = pr.Decl.pr_name.Ident.id_string ::acc in
  let acc = Ty.Sts.fold_left remove_ts [] rem.Eliminate_definition.rem_ts in
  let acc = Term.Sls.fold_left remove_ls acc rem.Eliminate_definition.rem_ls in
  let acc = Decl.Spr.fold_left remove_pr acc rem.Eliminate_definition.rem_pr in
  acc


MARCHE Claude's avatar
MARCHE Claude committed
990 991 992
let bisect_proof_attempt ~notification c pa_id =
  let ses = c.controller_session in
  let pa = get_proof_attempt_node ses pa_id in
MARCHE Claude's avatar
MARCHE Claude committed
993 994
  if not (proof_is_complete pa) then
    invalid_arg "bisect: proof attempt should be valid";
MARCHE Claude's avatar
MARCHE Claude committed
995 996 997 998 999 1000 1001 1002 1003
  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
MARCHE Claude's avatar
MARCHE Claude committed
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
  let bisect_end 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 didn't reduce the task.@."
    else
      begin
        Debug.dprintf debug "Bisecting done.@.";
        (* apply again the transformation *)
        let callback = function
          | TSscheduled -> ()
          | TSfailed _ -> assert false
          | TSdone trid ->
             match get_sub_tasks ses trid with
             | [pn] ->
                let limit = { limit with Call_provers.limit_time = !timelimit; } in
                let callback _paid = function
                  | Scheduled | Running -> ()
                  | Detached | Uninstalled _ -> assert false
                  | Interrupted -> Debug.dprintf debug "Bisecting interrupted.@."
                  | 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 ->
                     assert (res.Call_provers.pr_answer = Call_provers.Valid);
                     Debug.dprintf debug "Bisecting: %a.@."
                                   Call_provers.print_prover_result res;
                in
                schedule_proof_attempt c pn prover ~counterexmp:false ~limit ~callback ~notification
             | _ -> assert false
        in
        let rem = create_rem_list rem in
        schedule_transformation c goal_id "remove" rem ~callback ~notification
      end
MARCHE Claude's avatar
MARCHE Claude committed
1040
  in
MARCHE Claude's avatar
MARCHE Claude committed
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
  let rec bisect_step rem kont =
    (* we have to:
       1) apply transformation remove with the given rem
       2) on the generated sub-goal, run the prover with some callback
       3) the callback should :
          compute (next_iter success_value)
          if result is done, do nothing more
          if result is some new rem, remove the previous transformation
           and recursively call bisect_step
     *)
    let callback = function
      | TSscheduled -> ()
      | TSfailed _ -> (* may happen if removing a type or a lsymbol
that is used later on. We do has if proof fails. *)
         begin
           match kont false with
           | Eliminate_definition.BSstep (rem,kont) ->
              bisect_step rem kont
           | Eliminate_definition.BSdone rem ->
              bisect_end rem
         end
      | TSdone trid ->
         match get_sub_tasks ses trid with
         | [pn] ->
            let limit = { limit with Call_provers.limit_time = !timelimit; } in
            let callback _paid = function
              | Scheduled | Running -> ()
              | Detached | Uninstalled _ -> assert false
              | Interrupted -> Debug.dprintf debug "Bisecting interrupted.@."
              | 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.BSstep (rem,kont) ->
                    remove_transformation ses trid;
                    bisect_step rem kont
                 | Eliminate_definition.BSdone rem ->
                    bisect_end rem
            in
            schedule_proof_attempt c pn prover ~counterexmp:false ~limit ~callback ~notification
         | _ -> assert false
    in
    let rem = create_rem_list rem in
    schedule_transformation c goal_id "remove" rem ~callback ~notification
MARCHE Claude's avatar
MARCHE Claude committed
1091 1092
  in
  Debug.dprintf debug "Bisecting with %a started.@."
MARCHE Claude's avatar
MARCHE Claude committed
1093 1094 1095 1096 1097
                Whyconf.print_prover prover;
  let t = get_raw_task ses goal_id in
  match Eliminate_definition.bisect_step t with
  | Eliminate_definition.BSdone _ -> assert false
  | Eliminate_definition.BSstep(rem,kont) -> bisect_step rem kont
MARCHE Claude's avatar
MARCHE Claude committed
1098

1099
end