controller_itp.ml 28.1 KB
Newer Older
1
open Format
Clément Fumex's avatar
Clément Fumex committed
2 3
open Session_itp

Sylvain Dailler's avatar
Sylvain Dailler committed
4 5 6 7 8

let debug_sched = Debug.register_info_flag "scheduler"
  ~desc:"Print@ debugging@ messages@ about@ scheduling@ of@ prover@ calls@ \
         and@ transformation@ applications."

9 10
exception Noprogress

11 12 13
let () = Exn_printer.register
    (fun fmt e ->
      match e with
Sylvain Dailler's avatar
Sylvain Dailler committed
14 15
      | Noprogress ->
          Format.fprintf fmt "The transformation made no progress.\n"
16 17
      | _ -> raise e)

Clément Fumex's avatar
Clément Fumex committed
18 19 20 21 22 23 24 25 26
(** State of a proof *)
type proof_attempt_status =
    | Unedited (** editor not yet run for interactive proof *)
    | JustEdited (** edited but not run yet *)
    | 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 *)
27
    | Uninstalled of Whyconf.prover (** prover is uninstalled *)
Clément Fumex's avatar
Clément Fumex committed
28

MARCHE Claude's avatar
MARCHE Claude committed
29 30
let print_status fmt st =
  match st with
Sylvain Dailler's avatar
Sylvain Dailler committed
31 32 33 34 35 36 37 38 39 40 41
  | Unedited          -> fprintf fmt "Unedited"
  | JustEdited        -> fprintf fmt "JustEdited"
  | 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
42 43

type transformation_status =
44
  | TSscheduled | TSdone of transID | TSfailed of (proofNodeID * exn)
45 46 47 48

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

52 53 54 55
type strategy_status = STSgoto of proofNodeID * int | STShalt

let print_strategy_status fmt st =
  match st with
Sylvain Dailler's avatar
Sylvain Dailler committed
56 57
  | STSgoto(id,n) ->
      fprintf fmt "goto step %d in proofNode %a" n print_proofNodeID id
58 59 60
  | STShalt -> fprintf fmt "halt"


61
type controller =
Sylvain Dailler's avatar
Sylvain Dailler committed
62
  { mutable controller_session: Session_itp.session;
63
    controller_config : Whyconf.config;
Sylvain Dailler's avatar
Sylvain Dailler committed
64 65 66
    controller_env: Env.env;
    controller_provers:
      (Whyconf.config_prover * Driver.driver) Whyconf.Hprover.t;
67 68
  }

69

70
let create_controller config env ses =
71 72
  let c =
    {
73
      controller_session = ses;
74 75 76 77 78 79 80 81 82
      controller_config = config;
      controller_env = env;
      controller_provers = Whyconf.Hprover.create 7;
    }
  in
  let provers = Whyconf.get_provers config in
  Whyconf.Mprover.iter
    (fun _ p ->
     try
83
       let d = Whyconf.load_driver (Whyconf.get_main config) env p.Whyconf.driver [] in
84 85 86 87 88 89 90 91 92
       Whyconf.Hprover.add c.controller_provers p.Whyconf.prover (p,d)
     with e ->
       Format.eprintf
         "[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
93
let remove_subtree c = Session_itp.remove_subtree c.controller_session
94

95 96 97
(* Get children of any without proofattempts *)
let get_undetached_children_no_pa s any : any list =
  match any with
98
  | AFile f -> List.map (fun th -> ATh th) (file_theories f)
99 100 101
  | 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
102
  | APa _ -> []
103

104 105 106



107 108 109 110 111 112 113 114 115 116 117 118
(* printing *)

module PSession = struct

  open Stdlib

  type any =
    | Session
    | File of file
    | Theory of theory
    | Goal of proofNodeID
    | Transf of transID
119
    | ProofAttempt of proof_attempt_node
120 121 122 123 124 125 126 127 128 129

  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 ->
130
       (file_name f),
Sylvain Dailler's avatar
Sylvain Dailler committed
131 132
       List.fold_right
          (fun th -> n (Theory th))
133 134
          (file_detached_theories f)
          (List.fold_right (fun th -> n (Theory th)) (file_theories f) [])
135 136 137
    | Theory th ->
       let id = theory_name th in
       let name = id.Ident.id_string in
138
       let name = if th_proved s th then name^"!" else name^"?" in
139
       name,
Sylvain Dailler's avatar
Sylvain Dailler committed
140 141 142 143
       List.fold_right
         (fun g -> n (Goal g))
         (theory_goals th)
         (List.fold_right (fun g -> n (Goal g)) (theory_detached_goals th) [])
144 145 146
    | Goal id ->
       let gid = get_proof_name s id in
       let name = gid.Ident.id_string in
147
       let name = if pn_proved s id then name^"!" else name^"?" in
148 149 150 151 152 153 154
       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
155 156 157 158 159
          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 ""), []
160 161
    | Transf id ->
       let name = get_transf_name s id in
162
       let name = if tn_proved s id then name^"!" else name^"?" in
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
       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 }

(*********)



180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
let read_file env ?format fn =
  let theories = Env.read_file Env.base_language env ?format fn in
  let ltheories =
    Stdlib.Mstr.fold
      (fun name th acc ->
        (* Hack : with WP [name] and [th.Theory.th_name.Ident.id_string] *)
        let th_name =
          Ident.id_register (Ident.id_derive name th.Theory.th_name) in
         match th.Theory.th_name.Ident.id_loc with
           | Some l -> (l,th_name,th)::acc
           | None   -> (Loc.dummy_position,th_name,th)::acc)
      theories []
  in
  let th =  List.sort
      (fun (l1,_,_) (l2,_,_) -> Loc.compare l1 l2)
      ltheories
  in
  List.map (fun (_,_,a) -> a) th


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

205
let merge_file (old_ses : session) (c : controller) ~use_shapes _ file =
206 207 208
  let format = file_format file in
  let old_theories = file_theories file in
  let file_name = Filename.concat (get_dir old_ses) (file_name file) in
209 210 211
  let new_theories =
    try
      read_file c.controller_env file_name ?format
212 213
    with e -> (* TODO: filter only syntax error and typing errors *)
      raise e
214
  in
215
  merge_file_section
216
    c.controller_session ~use_shapes ~old_ses ~old_theories
217
    ~env:c.controller_env file_name new_theories format
218

219
let reload_files (c : controller) ~use_shapes =
220
  let old_ses = c.controller_session in
Sylvain Dailler's avatar
Sylvain Dailler committed
221 222
  c.controller_session <-
    empty_session ~shape_version:(get_shape_version old_ses) (get_dir old_ses);
223 224 225
  try
    Stdlib.Hstr.iter
      (fun f -> merge_file old_ses c ~use_shapes f)
226
      (get_files old_ses);
227 228 229
  with e ->
    c.controller_session <- old_ses;
    raise e
230 231 232

let add_file c ?format fname =
  let theories = read_file c.controller_env ?format fname in
233
  add_file_section c.controller_session fname theories format
234

235 236 237 238 239 240

module type Scheduler = sig
  val timeout: ms:int -> (unit -> bool) -> unit
  val idle: prio:int -> (unit -> bool) -> unit
end

241 242
module Make(S : Scheduler) = struct

MARCHE Claude's avatar
MARCHE Claude committed
243 244 245 246 247 248 249 250
let scheduled_proof_attempts = Queue.create ()

let prover_tasks_in_progress = Queue.create ()

let timeout_handler_running = ref false

let max_number_of_running_provers = ref 1

251 252 253 254
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
255
let number_of_running_provers = ref 0
256

257 258 259 260
let observer = ref (fun _ _ _ -> ())

let register_observer = (:=) observer

261
module Hprover = Whyconf.Hprover
MARCHE Claude's avatar
MARCHE Claude committed
262

263
let build_prover_call ?proof_script ~cntexample c id pr limit callback =
264 265
  let (config_pr,driver) = Hprover.find c.controller_provers pr in
  let command =
Sylvain Dailler's avatar
Sylvain Dailler committed
266 267 268
    Whyconf.get_complete_command
      config_pr
      ~with_steps:Call_provers.(limit.limit_steps <> empty_limit.limit_steps) in
269
  let task = Session_itp.get_task c.controller_session id in
270
  let table = Session_itp.get_table c.controller_session id in
271
  let call =
272
    Driver.prove_task ?old:proof_script ~cntexample:cntexample ~inplace:false ~command
273
                      ~limit ?name_table:table driver task
274
  in
275
  let pa = (c.controller_session,id,pr,proof_script,callback,false,call) in
MARCHE Claude's avatar
MARCHE Claude committed
276 277 278 279 280 281
  Queue.push pa prover_tasks_in_progress

let timeout_handler () =
  (* examine all the prover tasks in progress *)
  let q = Queue.create () in
  while not (Queue.is_empty prover_tasks_in_progress) do
282
    let (ses,id,pr,pr_script,callback,started,call) as c =
Sylvain Dailler's avatar
Sylvain Dailler committed
283
      Queue.pop prover_tasks_in_progress in
284
    match Call_provers.query_call call with
MARCHE Claude's avatar
MARCHE Claude committed
285 286 287 288 289
    | Call_provers.NoUpdates -> Queue.add c q
    | Call_provers.ProverStarted ->
       assert (not started);
       callback Running;
       incr number_of_running_provers;
290 291
       Queue.add (ses,id,pr,pr_script,callback,true,call) q
    | Call_provers.ProverFinished res when pr_script = None ->
MARCHE Claude's avatar
MARCHE Claude committed
292
       if started then decr number_of_running_provers;
293 294 295
       (* update the session *)
       update_proof_attempt ses id pr res;
       (* inform the callback *)
MARCHE Claude's avatar
MARCHE Claude committed
296
       callback (Done res)
297 298 299 300 301 302
    | Call_provers.ProverFinished res (* when pr_script <> None *) ->
       if started then decr number_of_running_provers;
       (* update the session *)
       update_proof_attempt ~obsolete:true ses id pr res;
       (* inform the callback *)
       callback (Done res)
303 304 305 306 307 308 309 310
    | Call_provers.ProverInterrupted ->
       if started then decr number_of_running_provers;
       (* inform the callback *)
       callback (Interrupted)
    | Call_provers.InternalFailure exn ->
       if started then decr number_of_running_provers;
       (* inform the callback *)
       callback (InternalFailure (exn))
MARCHE Claude's avatar
MARCHE Claude committed
311 312
  done;
  Queue.transfer q prover_tasks_in_progress;
313
  (* if the number of prover tasks is less than 3 times the maximum
MARCHE Claude's avatar
MARCHE Claude committed
314 315
     number of running provers, then we heuristically decide to add
     more tasks *)
316 317 318 319
  begin
    try
      for _i = Queue.length prover_tasks_in_progress
          to 3 * !max_number_of_running_provers do
320
        let (c,id,pr,limit,proof_script,callback,cntexample) = Queue.pop scheduled_proof_attempts in
321
        try
322
          build_prover_call ?proof_script ~cntexample c id pr limit callback
323
        with e when not (Debug.test_flag Debug.stack_trace) ->
324
          (*Format.eprintf
325
            "@[Exception raised in Controller_itp.build_prover_call:@ %a@.@]"
326
            Exn_printer.exn_printer e;*)
327 328 329 330 331 332 333 334 335
          callback (InternalFailure e)
      done
  with Queue.Empty -> ()
  end;
  let scheduled = Queue.length scheduled_proof_attempts in
  let waiting_or_running = Queue.length prover_tasks_in_progress in
  let running = !number_of_running_provers in
  !observer scheduled (waiting_or_running - running) running;
  true
MARCHE Claude's avatar
MARCHE Claude committed
336

337 338
let interrupt () =
  while not (Queue.is_empty prover_tasks_in_progress) do
339
    let (_ses,_id,_pr,_proof_script,callback,_started,_call) =
340 341 342 343 344 345
      Queue.pop prover_tasks_in_progress in
    (* TODO: apply some Call_provers.interrupt_call call *)
    callback Interrupted
  done;
  number_of_running_provers := 0;
  while not (Queue.is_empty scheduled_proof_attempts) do
346
    let (_c,_id,_pr,_limit,_proof_script,callback,_cntexample) = Queue.pop scheduled_proof_attempts in
347 348 349 350
    callback Interrupted
  done;
  !observer 0 0 0

MARCHE Claude's avatar
MARCHE Claude committed
351 352 353 354 355 356 357
let run_timeout_handler () =
  if not !timeout_handler_running then
    begin
      timeout_handler_running := true;
      S.timeout ~ms:125 timeout_handler;
    end

358
let schedule_proof_attempt_r ?proof_script c id pr ~counterexmp ~limit ~callback =
359
  let panid =
360
    graft_proof_attempt c.controller_session id pr ~limit
361
  in
362 363
  Queue.add (c,id,pr,limit,proof_script,callback panid,counterexmp)
            scheduled_proof_attempts;
364
  callback panid Scheduled;
MARCHE Claude's avatar
MARCHE Claude committed
365
  run_timeout_handler ()
Clément Fumex's avatar
Clément Fumex committed
366

367 368
let schedule_proof_attempt ?proof_script c id pr
                           ~counterexmp ~limit ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
369
  let callback panid s = callback panid s;
Sylvain Dailler's avatar
Sylvain Dailler committed
370
    (match s with
371 372
    | Scheduled | Running | Done _ ->
                             update_goal_node notification c.controller_session id
Sylvain Dailler's avatar
Sylvain Dailler committed
373
    | _ -> ())
374
  in
375 376
  (* proof_script is specific to interactive manual provers *)
  let session_dir = Session_itp.get_dir c.controller_session in
377 378 379
  let proof_script =
    Opt.map (Sysutil.absolutize_filename session_dir) proof_script
  in
380
  schedule_proof_attempt_r ?proof_script c id pr ~counterexmp ~limit ~callback
381

382
(* TODO to be simplified *)
Sylvain Dailler's avatar
Sylvain Dailler committed
383 384 385
(* 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
386
  let driver = snd (Hprover.find c.controller_provers pr) in
Sylvain Dailler's avatar
Sylvain Dailler committed
387 388 389 390 391
  let task = Session_itp.get_task session pn in
  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
392
  let fn = file_name f in
Sylvain Dailler's avatar
Sylvain Dailler committed
393 394 395 396 397 398 399 400
  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
401
  let driver = snd (Hprover.find c.controller_provers pr) in
Sylvain Dailler's avatar
Sylvain Dailler committed
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
  let task = Session_itp.get_task session pn in
  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
  (* Name table is only used in ITP printing *)
  Driver.print_task ~cntexample:false ?old driver fmt task;
  Opt.iter close_in old;
  close_out ch;
  file

exception Editor_not_found

let schedule_edition c id pr ?file ~callback ~notification =
  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
  (* Notification node *)
  let callback panid s = callback panid s;
    match s with
444
    | Scheduled | Running | Done _ -> update_goal_node notification c.controller_session id
Sylvain Dailler's avatar
Sylvain Dailler committed
445 446 447 448
    | _ -> ()
  in

  let limit = Call_provers.empty_limit in
449
  (* Make sure editor exists. Fails otherwise *)
Sylvain Dailler's avatar
Sylvain Dailler committed
450 451
  let editor =
    match prover_conf.Whyconf.editor with
452
    | "" -> raise Editor_not_found
Sylvain Dailler's avatar
Sylvain Dailler committed
453 454 455
    | s ->
        try
          let ed = Whyconf.editor_by_id config s in
456 457 458
          String.concat " "(ed.Whyconf.editor_command ::
                            ed.Whyconf.editor_options)
        with Not_found -> raise Editor_not_found
Sylvain Dailler's avatar
Sylvain Dailler committed
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
  in
  let proof_attempts_id = get_proof_attempt_ids session id in
  let panid =
    try Some (Hprover.find proof_attempts_id pr) with
    | _ -> None
  in
  (* make sure to actually create the file and the proof attempt *)
  let panid, file =
    match panid, file with
    | None, None ->
        let file = update_edit_external_proof c id pr in
        let filename = Sysutil.relativize_filename session_dir file in
        let panid = graft_proof_attempt c.controller_session id pr ~file:filename ~limit in
        panid, file
    | None, Some file ->
        let panid = graft_proof_attempt c.controller_session id pr ~file ~limit in
        let file = update_edit_external_proof c id ~panid pr in
        panid, file
    | Some panid, _ ->
        let file = update_edit_external_proof c id ~panid pr in
        panid, file
  in

  Debug.dprintf debug_sched "[Editing] goal %s with command '%s' on file %s@."
    (Session_itp.get_proof_name session id).Ident.id_string
484 485 486 487 488 489 490 491
    editor file;
  let call = Call_provers.call_editor ~command:editor file in
  callback panid Running;
  let file = Sysutil.relativize_filename session_dir file in
  Queue.add (c.controller_session,id,pr,Some file,callback panid,false,call)
    prover_tasks_in_progress;
  run_timeout_handler ()

Sylvain Dailler's avatar
Sylvain Dailler committed
492

493
let schedule_transformation_r c id name args ~callback =
494 495
  let apply_trans () =
    let task = get_task c.controller_session id in
496 497 498
    let table = match get_table c.controller_session id with
    | None -> raise (Task.Bad_name_table "Controller_itp.schedule_transformation_r")
    | Some table -> table in
499 500
    begin
      try
Sylvain Dailler's avatar
Sylvain Dailler committed
501
        let subtasks =
502
          Trans.apply_transform_args name c.controller_env args table task in
503 504 505 506
        (* if result is same as input task, consider it as a failure *)
        begin
          match subtasks with
          | [t'] when Task.task_equal t' task ->
507
             callback (TSfailed (id, Noprogress))
508 509 510 511 512
          | _ ->
             let tid = graft_transf c.controller_session id name args subtasks in
             callback (TSdone tid)
        end
      with e when not (Debug.test_flag Debug.stack_trace) ->
513
        (* Format.eprintf
514
          "@[Exception raised in Trans.apply_transform %s:@ %a@.@]"
515
          name Exn_printer.exn_printer e; TODO *)
516
        callback (TSfailed (id, e))
517 518
    end;
    false
519 520 521
  in
  S.idle ~prio:0 apply_trans;
  callback TSscheduled
Clément Fumex's avatar
Clément Fumex committed
522

523
let schedule_transformation c id name args ~callback ~notification =
524
  let callback s = callback s; (match s with
525
      | TSdone tid -> update_trans_node notification c.controller_session tid
526
      | TSfailed _e -> ()
527
      | _ -> ()) in
528 529 530 531
  schedule_transformation_r c id name args ~callback

open Strategy

Sylvain Dailler's avatar
Sylvain Dailler committed
532
let run_strategy_on_goal
533
    c id strat ~counterexmp ~callback_pa ~callback_tr ~callback ~notification =
534 535 536 537 538 539
  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
540 541
         let callback panid res =
           callback_pa panid res;
542 543 544 545 546
           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
547 548
           | Interrupted | InternalFailure _ ->
              callback STShalt
549 550 551 552 553
           | 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
554
           | Unedited | JustEdited | Uninstalled _ ->
555 556 557 558 559 560
                         (* should not happen *)
                         assert false
         in
         let limit = { Call_provers.empty_limit with
                       Call_provers.limit_time = timelimit;
                       limit_mem  = memlimit} in
561
         schedule_proof_attempt c g p ~counterexmp ~limit ~callback ~notification
562 563
      | Itransform(trname,pcsuccess) ->
         let callback ntr =
MARCHE Claude's avatar
MARCHE Claude committed
564
           callback_tr ntr;
565
           match ntr with
566
           | TSfailed _e -> (* transformation failed *)
567 568 569 570 571 572 573 574 575 576 577 578
              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
579
                (get_sub_tasks c.controller_session tid)
580
         in
581
         schedule_transformation c g trname [] ~callback ~notification
582 583 584 585 586 587
      | Igoto pc ->
         callback (STSgoto (g,pc));
         exec_strategy pc strat g
  in
  exec_strategy 0 strat id

Sylvain Dailler's avatar
Sylvain Dailler committed
588 589
let schedule_pa_with_same_arguments
    c (pa: proof_attempt_node) (pn: proofNodeID) ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
590 591 592 593
  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
594 595
let schedule_tr_with_same_arguments
    c (tr: transID) (pn: proofNodeID) ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
596 597 598 599 600
  let s = c.controller_session in
  let args = get_transf_args s tr in
  let name = get_transf_name s tr in
  schedule_transformation c pn name args ~callback ~notification

601 602 603
let clean_session c ~removed =
  (* clean should not change proved status *)
  let notification _ = assert false in
604
  let s = c.controller_session in
605 606 607 608 609
  (* 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 ->
610 611
        let pa = Session_itp.get_proof_attempt_node s pa in
        if pn_proved s pa.parent then
612 613 614
          (match pa.Session_itp.proof_state with
          | None -> ()
          | Some pr ->
615 616 617
           if pa.Session_itp.proof_obsolete ||
                Call_provers.(pr.pr_answer <> Valid)
           then
Sylvain Dailler's avatar
Sylvain Dailler committed
618
             Session_itp.remove_subtree ~notification ~removed s any)
619
      | ATn tn ->
620 621
        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
622
          Session_itp.remove_subtree s ~notification ~removed (ATn tn)
623
      | _ -> ())) ()
624

625 626
(* This function folds on any subelements of given node and tries to mark all
   proof attempts it encounters *)
627
let mark_as_obsolete ~notification c any =
628
  let s = c.controller_session in
629
  (* Case for proof attempt only *)
630
  let mark_as_obsolete_pa n =
631 632
    let parent = get_proof_attempt_parent s n in
    Session_itp.mark_obsolete s n;
633
    notification (APa n);
634
    update_goal_node notification s parent
635 636 637
  in
  fold_all_any s
    (fun () any -> match any with
638
    | APa n -> mark_as_obsolete_pa n
639
    | _ -> ()) () any
640

Sylvain Dailler's avatar
Sylvain Dailler committed
641 642 643 644 645 646 647 648 649 650 651 652 653 654
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
655
      List.iter (fun x -> schedule_pa_with_same_arguments c x to_pn ~counterexmp:false
Sylvain Dailler's avatar
Sylvain Dailler committed
656 657 658 659
          ~callback:callback_pa ~notification) from_pa_list;
      let from_tr_list = get_transformations s from_pn in
      let callback x st = callback_tr st;
        match st with
Sylvain Dailler's avatar
Sylvain Dailler committed
660 661
        | TSdone tid ->
          copy_paste c (ATn x) (ATn tid) ~notification ~callback_pa ~callback_tr
Sylvain Dailler's avatar
Sylvain Dailler committed
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
        | _ -> ()
      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
682
      | None -> raise (BadCopyDetached "copy_detached no parent")
Sylvain Dailler's avatar
Sylvain Dailler committed
683 684
      | Some parent ->
          copy ~parent (APn pn_id);
Sylvain Dailler's avatar
Sylvain Dailler committed
685 686
          copy_structure
            ~notification:copy c.controller_session (APn from_pn) (APn pn_id)
Sylvain Dailler's avatar
Sylvain Dailler committed
687
    end
688 689
  (* Only goal can be detached *)
  | _ -> raise (BadCopyDetached "copy_detached. Can only copy goal")
Sylvain Dailler's avatar
Sylvain Dailler committed
690 691


692
let replay_proof_attempt ?proof_script c pr limit (parid: proofNodeID) id ~callback ~notification =
693 694 695
  (* The replay can be done on a different machine so we need
     to check more things before giving the attempt to the scheduler *)
  if not (Hprover.mem c.controller_provers pr) then
696
    callback id (Uninstalled pr)
697
  else
698
    schedule_proof_attempt ?proof_script c parid pr ~counterexmp:false ~limit ~callback ~notification
699 700 701 702 703

type report =
  | Result of Call_provers.prover_result * Call_provers.prover_result
  (** Result(new_result,old_result) *)
  | CallFailed of exn
704
  | Replay_interrupted
705 706 707 708 709 710 711 712 713 714 715
  | 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
716 717 718 719
  | CallFailed e ->
    Format.fprintf fmt "Callfailed %a@." Exn_printer.exn_printer e
  | Replay_interrupted ->
    Format.fprintf fmt "Interrupted@."
720 721 722 723 724 725 726 727 728
  | 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 *)
729
let replay_print fmt (lr: (proofNodeID * Whyconf.prover * Call_provers.resource_limit * report) list) =
730 731
  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
732 733
      (Obj.magic id) Whyconf.print_prover pr
      rl.Call_provers.limit_time print_report report
734
  in
735
  Format.fprintf fmt "%a@." (Pp.print_list Pp.newline pp_elem) lr
736

737 738
let replay ?(obsolete_only=true) ?(use_steps=false)
           c ~callback ~notification ~final_callback =
739

740
  let craft_report count s r id pr limits pa =
741
    match s with
742 743 744
    | Scheduled | Running -> ()
    | Unedited | JustEdited -> assert false
    | Interrupted ->
745
       decr count;
746
       r := (id, pr, limits, Replay_interrupted ) :: !r
747
    | Done new_r ->
748
       decr count;
749 750 751 752
        (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 ->
753
       decr count;
754
        r := (id, pr, limits, CallFailed (e)) :: !r
755 756 757
    | Uninstalled _ ->
       decr count;
       r := (id, pr, limits, Prover_not_installed) :: !r;
758
  in
759 760 761 762 763 764 765 766 767

  (* === replay === *)
  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
768
    (fun _ pa -> if pa.proof_obsolete || not obsolete_only then incr count) session;
769 770

  (* Replaying function *)
771
  let replay_pa id pa =
772 773 774 775
    if pa.proof_obsolete || not obsolete_only then
      begin
        let parid = pa.parent in
        let pr = pa.prover in
776 777 778 779
        (* 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 *)
780 781 782 783 784 785
        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
786 787
        let proof_script = pa.proof_script in
        replay_proof_attempt ?proof_script c pr limit parid id
788 789 790 791 792 793
                             ~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
794 795

  (* Calling replay on all the proof_attempts of the session *)
796
  Session_itp.session_iter_proof_attempt replay_pa session
797

798
end