session_scheduler.ml 34 KB
Newer Older
François Bobot's avatar
François Bobot committed
1 2
(**************************************************************************)
(*                                                                        *)
MARCHE Claude's avatar
MARCHE Claude committed
3
(*  Copyright (C) 2010-2012                                               *)
François Bobot's avatar
François Bobot committed
4 5 6
(*    François Bobot                                                      *)
(*    Jean-Christophe Filliâtre                                           *)
(*    Claude Marché                                                       *)
MARCHE Claude's avatar
MARCHE Claude committed
7
(*    Guillaume Melquiond                                                 *)
François Bobot's avatar
François Bobot committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
(*    Andrei Paskevich                                                    *)
(*                                                                        *)
(*  This software is free software; you can redistribute it and/or        *)
(*  modify it under the terms of the GNU Library General Public           *)
(*  License version 2.1, with the special exception on linking            *)
(*  described in file LICENSE.                                            *)
(*                                                                        *)
(*  This software is distributed in the hope that it will be useful,      *)
(*  but WITHOUT ANY WARRANTY; without even the implied warranty of        *)
(*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *)
(*                                                                        *)
(**************************************************************************)

open Format
open Session
open Debug

25
let debug = register_info_flag "scheduler"
26 27
  ~desc:"About@ the@ session@ scheduler@ which@ schedules@ the@ application@ \
          of@ transformtions@ or@ the@ call@ of@ provers."
François Bobot's avatar
François Bobot committed
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

(***************************)
(*     main functor        *)
(***************************)

module type OBSERVER = sig
  type key
  val create: ?parent:key -> unit -> key
  val remove: key -> unit
  val reset: unit -> unit

  val timeout: ms:int -> (unit -> bool) -> unit
  val idle: (unit -> bool) -> unit

  val notify_timer_state : int -> int -> int -> unit

  val init : key -> key any -> unit

  val notify : key any -> unit

48
(*
49 50 51 52
  val unknown_prover :
    key env_session -> Whyconf.prover -> Whyconf.prover option

  val replace_prover : key proof_attempt -> key proof_attempt -> bool
53 54 55 56
*)

  val uninstalled_prover :
    key env_session -> Whyconf.prover -> Whyconf.prover_upgrade_policy
57

François Bobot's avatar
François Bobot committed
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
end

module Make(O : OBSERVER) = struct

let notify = O.notify

let rec init_any any =
  O.init (key_any any) any;
  iter init_any any

let init_session session = session_iter init_any session

(***************************)
(*     session state       *)
(***************************)

(* type prover_option = *)
(*   | Detected_prover of prover_data *)
(*   | Undetected_prover of string *)

(* let prover_id p = match p with *)
(*   | Detected_prover p -> p.prover_id *)
(*   | Undetected_prover s -> s *)

let theory_name t = t.theory_name
let theory_key t = t.theory_key
let verified t = t.theory_verified
let goals t = t.theory_goals
let theory_expanded t = t.theory_expanded

let running a = match a.proof_state with
  | Undone (Scheduled | Running) -> true
90 91
  | Undone (Unedited | JustEdited | Interrupted)
  | Done _ | InternalFailure _ -> false
François Bobot's avatar
François Bobot committed
92 93 94 95 96 97

(*************************)
(*         Scheduler     *)
(*************************)

type action =
98
  | Action_proof_attempt of int * int * string option * bool * string *
François Bobot's avatar
François Bobot committed
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 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 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
      Driver.driver * (proof_attempt_status -> unit) * Task.task
  | Action_delayed of (unit -> unit)


type timeout_action =
  | Check_prover of (proof_attempt_status -> unit) * Call_provers.prover_call
  | Any_timeout of (unit -> bool)

type t =
    { (** Actions that wait some idle time *)
      actions_queue : action Queue.t;
      (** Quota of action slot *)
      mutable maximum_running_proofs : int;
      (** Running actions which take one action slot *)
      mutable running_proofs : timeout_action list;
      (** Running check which doesn't take a running slot.
          Check the end of some computation *)
      mutable running_check : (unit -> bool) list;
      (** proof attempt that wait some available action slot *)
      proof_attempts_queue :
        ((proof_attempt_status -> unit) *
            (unit -> Call_provers.prover_call))
        Queue.t;
      (** timeout handler state *)
      mutable timeout_handler_activated : bool;
      mutable timeout_handler_running : bool;
      (** idle handler state *)
      mutable idle_handler_activated : bool;
    }

let set_maximum_running_proofs max sched =
 (** TODO dequeue actions if maximum_running_proofs increase *)
  sched.maximum_running_proofs <- max

let init max =
  dprintf debug "[Sched] init scheduler max=%i@." max;
  { actions_queue = Queue.create ();
    maximum_running_proofs = max;
    running_proofs = [];
    running_check = [];
    proof_attempts_queue = Queue.create ();
    timeout_handler_activated = false;
    timeout_handler_running = false;
    idle_handler_activated = false
  }

(* timeout handler *)

let timeout_handler t =
  dprintf debug "[Sched] Timeout handler called@.";
  assert (not t.timeout_handler_running);
  t.timeout_handler_running <- true;
  (** Check if some action ended *)
  let l = List.fold_left
    (fun acc c ->
       match c with
         | Check_prover(callback,call)  ->
             (match Call_provers.query_call call with
               | None -> c::acc
               | Some post ->
                   let res = post () in callback (Done res);
                   acc)
         | Any_timeout callback ->
             let b = callback () in
             if b then c::acc else acc)
    [] t.running_proofs
  in
  (** Check if some new actions must be started *)
  let l =
    if List.length l < t.maximum_running_proofs then
      begin try
        let (callback,pre_call) = Queue.pop t.proof_attempts_queue in
        callback (Undone Running);
        dprintf debug "[Sched] proof attempts started@.";
        let call = pre_call () in
        (Check_prover(callback,call))::l
      with Queue.Empty -> l
      end
    else l
  in
  t.running_proofs <- l;
  (** Call the running check *)
  t.running_check <- List.fold_left
    (fun acc check -> if check () then check::acc else acc)
    [] t.running_check;
  let continue =
    match l with
      | [] ->
          dprintf debug "[Sched] Timeout handler stopped@.";
          false
      | _ -> true
  in
  O.notify_timer_state
    (Queue.length t.actions_queue)
    (Queue.length t.proof_attempts_queue) (List.length l);
  t.timeout_handler_activated <- continue;
  t.timeout_handler_running <- false;
  continue

let run_timeout_handler t =
  if t.timeout_handler_activated then () else
    begin
      t.timeout_handler_activated <- true;
      dprintf debug "[Sched] Timeout handler started@.";
      O.timeout ~ms:100 (fun () -> timeout_handler t)
    end

let schedule_any_timeout t callback =
  dprintf debug "[Sched] schedule a new timeout@.";
  t.running_proofs <- (Any_timeout callback) :: t.running_proofs;
  run_timeout_handler t

let add_a_check t callback =
  dprintf debug "[Sched] add a new check@.";
  t.running_check <- callback :: t.running_check;
  run_timeout_handler t

(* idle handler *)


let idle_handler t =
  try
    begin
      match Queue.pop t.actions_queue with
223
        | Action_proof_attempt(timelimit,memlimit,old,inplace,command,driver,
François Bobot's avatar
François Bobot committed
224 225 226 227 228 229
                               callback,goal) ->
            callback (Undone Scheduled);
            begin
              try
                let pre_call =
                  Driver.prove_task
230
                    ?old ~inplace ~command ~timelimit ~memlimit driver goal
François Bobot's avatar
François Bobot committed
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
                in
                Queue.push (callback,pre_call) t.proof_attempts_queue;
                run_timeout_handler t
              with e ->
                Format.eprintf "@[Exception raise in Session.idle_handler:@ \
%a@.@]"
                  Exn_printer.exn_printer e;
                callback (InternalFailure e)
            end
        | Action_delayed callback -> callback ()
    end;
    true
  with Queue.Empty ->
    t.idle_handler_activated <- false;
    dprintf debug "[Sched] idle_handler stopped@.";
    false
    | e ->
      Format.eprintf "@[Exception raise in Session.idle_handler:@ %a@.@]"
        Exn_printer.exn_printer e;
      eprintf "Session.idle_handler stopped@.";
      false


let run_idle_handler t =
  if t.idle_handler_activated then () else
    begin
      t.idle_handler_activated <- true;
      dprintf debug "[Sched] idle_handler started@.";
      O.idle (fun () -> idle_handler t)
    end

(* main scheduling functions *)

let cancel_scheduled_proofs t =
  let new_queue = Queue.create () in
  try
    while true do
      match Queue.pop t.actions_queue with
269
        | Action_proof_attempt(_timelimit,_memlimit,_old,_inplace,_command,
François Bobot's avatar
François Bobot committed
270 271 272 273 274 275 276 277 278 279 280 281 282
                               _driver,callback,_goal) ->
            callback (Undone Interrupted)
        | Action_delayed _ as a->
            Queue.push a new_queue
    done
  with Queue.Empty ->
    Queue.transfer new_queue t.actions_queue;
    try
      while true do
        let (callback,_) = Queue.pop t.proof_attempts_queue in
        callback (Undone Interrupted)
      done
    with
283
      | Queue.Empty ->
François Bobot's avatar
François Bobot committed
284 285 286
          O.notify_timer_state 0 0 (List.length t.running_proofs)


287
let schedule_proof_attempt ~timelimit ~memlimit ?old ~inplace
François Bobot's avatar
François Bobot committed
288 289 290 291 292
    ~command ~driver ~callback t goal =
    dprintf debug "[Sched] Scheduling a new proof attempt (goal : %a)@."
      (fun fmt g -> Format.pp_print_string fmt
       (Task.task_goal g).Decl.pr_name.Ident.id_string) goal;
  Queue.push
293
    (Action_proof_attempt(timelimit,memlimit,old,inplace,command,driver,
François Bobot's avatar
François Bobot committed
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
                        callback,goal))
    t.actions_queue;
  run_idle_handler t

let schedule_edition t command filename callback =
  dprintf debug "[Sched] Scheduling an edition@.";
  let precall =
    Call_provers.call_on_file ~command ~regexps:[] ~timeregexps:[]
      ~exitcodes:[(0,Call_provers.Unknown "")] filename
  in
  callback (Undone Running);
  t.running_proofs <- (Check_prover(callback, precall ())) :: t.running_proofs;
  run_timeout_handler t

let schedule_delayed_action t callback =
  dprintf debug "[Sched] Scheduling a delayed action@.";
  Queue.push (Action_delayed callback) t.actions_queue;
  run_idle_handler t

(**************************)
(*  session function      *)
(**************************)

let update_session ~allow_obsolete old_session env whyconf  =
  O.reset ();
  let (env_session,_) as res =
    update_session ~keygen:O.create ~allow_obsolete old_session env whyconf in
François Bobot's avatar
François Bobot committed
321
  dprintf debug "Init_session@\n";
François Bobot's avatar
François Bobot committed
322 323 324
  init_session env_session.session;
  res

325 326
let add_file env_session ?format f =
  let mfile = add_file ~keygen:O.create env_session ?format f in
François Bobot's avatar
François Bobot committed
327 328 329 330 331 332 333 334
  let any_file = (File mfile) in
  init_any any_file;
  O.notify any_file;
  mfile

(*****************************************************)
(* method: run a given prover on each unproved goals *)
(*****************************************************)
335
(*
336 337 338 339 340 341 342 343 344 345
let rec find_loadable_prover eS prover =
  (** try the default one *)
  match load_prover eS prover with
    | None -> begin
      (** If its not loadable ask for one*)
      match O.unknown_prover eS prover with
        | None -> None
        | Some prover -> find_loadable_prover eS prover
    end
    | Some npc -> Some (prover,npc)
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
*)

let find_prover eS a =
  match load_prover eS a.proof_prover with
    | Some p -> Some (a.proof_prover, p,a)
    | None ->
        match O.uninstalled_prover eS a.proof_prover with
          | Whyconf.CPU_keep -> None
          | Whyconf.CPU_upgrade new_p ->
            (* does a proof using new_p already exists ? *)
            let g = a.proof_parent in
            begin
              try
                let _ = PHprover.find g.goal_external_proofs new_p in
                (* yes, then we do nothing *)
                None
              with Not_found ->
                (* we modify the prover in-place *)
                Session.change_prover a new_p;
                match load_prover eS new_p with
                  | Some p -> Some (new_p,p,a)
                  | None -> 
                    (* should never happen because at loading, config
                       ignores uninstalled prover targets.
                       Nevertheless, we can safely return None.
                    *)
                    None
            end
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
          | Whyconf.CPU_duplicate new_p -> 
            (* does a proof using new_p already exists ? *)
            let g = a.proof_parent in
            begin
              try
                let _ = PHprover.find g.goal_external_proofs new_p in
                (* yes, then we do nothing *)
                None
              with Not_found ->
                (* we duplicate the proof_attempt *)
                let new_a = copy_external_proof
                  ~notify ~keygen:O.create ~prover:new_p ~env_session:eS a 
                in
                O.init new_a.proof_key (Proof_attempt new_a);
                match load_prover eS new_p with
                  | Some p -> Some (new_p,p,new_a)
                  | None -> 
                    (* should never happen because at loading, config
                       ignores uninstalled prover targets.
                       Nevertheless, we can safely return None.
                    *)
                    None
            end
397

François Bobot's avatar
François Bobot committed
398

399 400
let adapt_timelimit a =
  match a.proof_state with
401 402
    | Done { Call_provers.pr_answer = 
        (Call_provers.Valid | Call_provers.Unknown _ | Call_provers.Invalid);
403 404 405 406 407 408
             Call_provers.pr_time = t } ->
      let time = max a.proof_timelimit (1 + truncate (2.0 *. t)) in
      set_timelimit time a;
      time
    | _ -> a.proof_timelimit

409

410
let run_external_proof eS eT ?callback a =
411 412
  (* check that the state is not Scheduled or Running *)
  (* Perhaps this test, a.proof_archived, should be done somewhere else *)
413
  if a.proof_archived || running a then ()
François Bobot's avatar
François Bobot committed
414
  else
415 416 417 418 419 420
    match find_prover eS a with
      | None ->
        (* nothing to do *)
        Util.apply_option2 () callback a a.proof_state
      | Some(_,npc,a) ->
(* 
421 422
    let ap = a.proof_prover in
    match find_loadable_prover eS a.proof_prover with
423
      | None ->
424 425 426
        Debug.dprintf debug
          "[Info] Can't redo an external proof since the prover %a is not loaded@."
          Whyconf.print_prover a.proof_prover;
427
        Util.apply_option2 () callback a a.proof_state
428
      | Some (nap,npc) ->
429 430
        (* eprintf "prover %a on goal %s@." *)
        (*   Whyconf.print_prover a.proof_prover a.proof_parent.goal_name.Ident.id_string; *)
431 432 433 434
        let g = a.proof_parent in
        try
          if nap == ap then raise Not_found;
          let np_a = PHprover.find g.goal_external_proofs nap in
435
          if O.replace_prover np_a a then
436
            begin
437
            (** The notification will be done by the new proof_attempt *)
438
              O.remove np_a.proof_key;
439
              raise Not_found
440
            end
441 442 443 444 445 446 447 448
        with Not_found ->
          (** replace [a] by a new_proof attempt if [a.proof_prover] was not
              loadable *)
        let a = if nap == ap then a
          else
            let a = copy_external_proof
              ~notify ~keygen:O.create ~prover:nap ~env_session:eS a in
            O.init a.proof_key (Proof_attempt a);
449
            a
450
        in
451 452
*)
        let g = a.proof_parent in
453 454
        if a.proof_edited_as = None &&
          npc.prover_config.Whyconf.interactive then
455 456 457 458 459
          begin
            set_proof_state ~notify ~obsolete:false ~archived:false
              (Undone Unedited) a;
            Util.apply_option2 () callback a a.proof_state
          end
460
        else
461
          begin
462
          let previous_result,previous_obs = a.proof_state,a.proof_obsolete in
463
          let timelimit = adapt_timelimit a in
464
          let memlimit = a.proof_memlimit in
François Bobot's avatar
François Bobot committed
465
          let callback result =
466
            begin match result with
François Bobot's avatar
François Bobot committed
467 468
              | Undone Interrupted ->
                  set_proof_state ~notify
469
                    ~obsolete:previous_obs ~archived:false previous_result a
François Bobot's avatar
François Bobot committed
470
              | _ ->
471
                  set_proof_state ~notify ~obsolete:false
472 473
                    ~archived:false result a end;
            Util.apply_option2 () callback a result
François Bobot's avatar
François Bobot committed
474 475
          in
          let old =
476
            match get_edited_as_abs eS.session a with
François Bobot's avatar
François Bobot committed
477
              | None -> None
478 479 480
              | Some f ->
                if Sys.file_exists f then begin
                  dprintf debug "Info: proving using edited file %s@." f;
481
                  (Some f)
482 483 484 485 486
                end
                else begin
                  dprintf debug "Warning: the file %s is not found@." f;
                  None
                end
François Bobot's avatar
François Bobot committed
487
          in
488
          let inplace = npc.prover_config.Whyconf.in_place in
François Bobot's avatar
François Bobot committed
489
          let command = Whyconf.get_complete_command npc.prover_config in
490
          (* eprintf "scheduling it...@."; *)
François Bobot's avatar
François Bobot committed
491
          schedule_proof_attempt
492
            ~timelimit ~memlimit
493
            ?old ~inplace ~command
494
            ~driver:npc.prover_driver
François Bobot's avatar
François Bobot committed
495 496 497 498 499
            ~callback
            eT
            (goal_task g)
        end

500
let prover_on_goal eS eT ?callback ~timelimit ~memlimit p g =
François Bobot's avatar
François Bobot committed
501
  let a =
502 503 504
    try
      let a = PHprover.find g.goal_external_proofs p in
      set_timelimit timelimit a;
505
      set_memlimit memlimit a;
506
      a
François Bobot's avatar
François Bobot committed
507
    with Not_found ->
508
      let ep = add_external_proof ~keygen:O.create ~obsolete:false
509
        ~archived:false ~timelimit ~memlimit 
François Bobot's avatar
François Bobot committed
510 511 512 513
        ~edit:None g p (Undone Interrupted) in
      O.init ep.proof_key (Proof_attempt ep);
      ep
  in
514
  run_external_proof eS eT ?callback a
François Bobot's avatar
François Bobot committed
515

516
let prover_on_goal_or_children eS eT
517
    ~context_unproved_goals_only ~timelimit ~memlimit p g =
518
  goal_iter_leaf_goal ~unproved_only:context_unproved_goals_only
519
    (prover_on_goal eS eT ~timelimit ~memlimit p) g
François Bobot's avatar
François Bobot committed
520

521
let run_prover eS eT ~context_unproved_goals_only ~timelimit ~memlimit pr a =
François Bobot's avatar
François Bobot committed
522 523 524
  match a with
    | Goal g ->
        prover_on_goal_or_children eS eT
525
          ~context_unproved_goals_only ~timelimit ~memlimit pr g
François Bobot's avatar
François Bobot committed
526 527 528
    | Theory th ->
        List.iter
          (prover_on_goal_or_children eS eT
529
             ~context_unproved_goals_only ~timelimit ~memlimit pr)
François Bobot's avatar
François Bobot committed
530 531 532 533 534 535
          th.theory_goals
    | File file ->
        List.iter
          (fun th ->
             List.iter
               (prover_on_goal_or_children eS eT
536
                  ~context_unproved_goals_only ~timelimit ~memlimit pr)
François Bobot's avatar
François Bobot committed
537 538 539 540
               th.theory_goals)
          file.file_theories
    | Proof_attempt a ->
        prover_on_goal_or_children eS eT
541
          ~context_unproved_goals_only ~timelimit ~memlimit pr a.proof_parent
François Bobot's avatar
François Bobot committed
542 543 544
    | Transf tr ->
        List.iter
          (prover_on_goal_or_children eS eT
545
             ~context_unproved_goals_only ~timelimit ~memlimit pr)
François Bobot's avatar
François Bobot committed
546
          tr.transf_goals
François Bobot's avatar
François Bobot committed
547 548 549
    | Metas m ->
      prover_on_goal_or_children eS eT
        ~context_unproved_goals_only ~timelimit ~memlimit pr m.metas_goal
François Bobot's avatar
François Bobot committed
550 551 552 553 554

(**********************************)
(* method: replay obsolete proofs *)
(**********************************)

555
let proof_successful_or_just_edited a =
François Bobot's avatar
François Bobot committed
556
  match a.proof_state with
557
    | Done { Call_provers.pr_answer = Call_provers.Valid }
558
    | Undone JustEdited -> true
François Bobot's avatar
François Bobot committed
559 560 561 562
    | _ -> false

let rec replay_on_goal_or_children eS eT
    ~obsolete_only ~context_unproved_goals_only g =
François Bobot's avatar
François Bobot committed
563 564
  iter_goal
    (fun a ->
François Bobot's avatar
François Bobot committed
565
       if not obsolete_only || a.proof_obsolete then
566
         if not context_unproved_goals_only || proof_successful_or_just_edited a
567
         then run_external_proof eS eT a)
François Bobot's avatar
François Bobot committed
568 569 570 571 572 573 574 575 576
    (iter_transf
       (replay_on_goal_or_children eS eT
          ~obsolete_only ~context_unproved_goals_only)
    )
    (iter_metas
       (replay_on_goal_or_children eS eT
          ~obsolete_only ~context_unproved_goals_only)
    )
    g
François Bobot's avatar
François Bobot committed
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603

let replay eS eT ~obsolete_only ~context_unproved_goals_only a =
  match a with
    | Goal g ->
        replay_on_goal_or_children eS eT
          ~obsolete_only ~context_unproved_goals_only g
    | Theory th ->
        List.iter
          (replay_on_goal_or_children eS eT
             ~obsolete_only ~context_unproved_goals_only)
          th.theory_goals
    | File file ->
        List.iter
          (fun th ->
             List.iter
               (replay_on_goal_or_children eS eT
                  ~obsolete_only ~context_unproved_goals_only)
               th.theory_goals)
          file.file_theories
    | Proof_attempt a ->
        replay_on_goal_or_children eS eT
          ~obsolete_only ~context_unproved_goals_only a.proof_parent
    | Transf tr ->
        List.iter
          (replay_on_goal_or_children eS eT
             ~obsolete_only ~context_unproved_goals_only)
          tr.transf_goals
François Bobot's avatar
François Bobot committed
604 605 606 607
    | Metas m ->
      replay_on_goal_or_children eS eT
        ~obsolete_only ~context_unproved_goals_only m.metas_goal

François Bobot's avatar
François Bobot committed
608 609 610 611 612

(***********************************)
(* method: mark proofs as obsolete *)
(***********************************)

613 614 615
let cancel_proof a =
  if not a.proof_archived then
    set_obsolete ~notify a
François Bobot's avatar
François Bobot committed
616 617 618

let cancel = iter_proof_attempt cancel_proof

619 620
(** Set or unset archive *)

621
let set_archive a b = set_archived a b; notify (Proof_attempt a)
622

François Bobot's avatar
François Bobot committed
623 624 625 626 627 628 629 630
(*********************************)
(* method: check existing proofs *)
(*********************************)

type report =
  | Result of Call_provers.prover_result * Call_provers.prover_result
  | CallFailed of exn
  | Prover_not_installed
631
  | Edited_file_absent of string
François Bobot's avatar
François Bobot committed
632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
  | No_former_result of Call_provers.prover_result

module Todo = struct
  type ('a,'b) todo =
      {mutable todo : int;
       report : 'a;
       push_report : 'a -> 'b -> unit}

  let create init push =
    {todo = 0;  report = init; push_report = push}

  let _done todo v =
    todo.todo <- todo.todo - 1;
    todo.push_report todo.report v

  let stop todo =
    todo.todo <- todo.todo - 1

  let todo todo =
    todo.todo <- todo.todo + 1

  let _end todo =
    if todo.todo<>0 then None else Some todo.report

  let print todo =
    dprintf debug "[Sched] todo : %i@." todo.todo
end

660 661
let push_report report (g,p,t,r) =
  report := (g.goal_name,p,t,r)::!report
François Bobot's avatar
François Bobot committed
662

663 664
exception NoFile of string

François Bobot's avatar
François Bobot committed
665 666 667 668 669
let check_external_proof eS eT todo a =
  let g = a.proof_parent in
  dprintf debug "[Sched] Check external proof : %a@."
    (fun fmt g -> pp_print_string fmt g.goal_name.Ident.id_string) g;
  (* check that the state is not Scheduled or Running *)
670
  if a.proof_archived || running a then ()
François Bobot's avatar
François Bobot committed
671 672 673
  else
    begin
      Todo.todo todo;
674 675 676 677 678
      match find_prover eS a with
        | None ->
          (* nothing to do 
             TODO: report an non replayable proof if some option is set
          *)
679
          Todo._done todo (g,a.proof_prover,0,Prover_not_installed);
680
        | Some(ap,npc,a) ->
681
          try
682 683 684 685 686 687 688 689
            let old =
              match a.proof_edited_as with
                | None -> None
                | Some edited_as ->
                  let f = Filename.concat eS.session.session_dir edited_as in
                  if Sys.file_exists f then
                    begin
                    (* Format.eprintf "Info: proving using edited file %s@." f; *)
690
                      (Some f)
691 692 693 694
                    end
                  else
                    raise (NoFile f)
            in
695
            let inplace = npc.prover_config.Whyconf.in_place in
696 697 698
            let timelimit = adapt_timelimit a in
            let memlimit = a.proof_memlimit in
            let callback result =
François Bobot's avatar
François Bobot committed
699 700
              match result with
                | Undone Scheduled | Undone Running | Undone Interrupted -> ()
701
                | Undone (Unedited | JustEdited) -> assert false
François Bobot's avatar
François Bobot committed
702
                | InternalFailure msg ->
703
                  Todo._done todo (g,ap,timelimit,(CallFailed msg));
704 705
                  set_proof_state ~notify ~obsolete:false ~archived:false
                    result a
François Bobot's avatar
François Bobot committed
706 707 708 709
                | Done new_res ->
                  begin
                    match a.proof_state with
                      | Done old_res ->
710 711
                          Todo._done todo
                            (g,ap,timelimit,(Result(new_res,old_res)))
François Bobot's avatar
François Bobot committed
712
                      | _ ->
713 714
                        Todo._done todo
                          (g,ap,timelimit,No_former_result new_res)
François Bobot's avatar
François Bobot committed
715
                  end;
716 717
                  set_proof_state ~notify ~obsolete:false ~archived:false
                    result a
718
            in
François Bobot's avatar
François Bobot committed
719
            let command = Whyconf.get_complete_command npc.prover_config in
720 721
            schedule_proof_attempt eT
              ~timelimit ~memlimit
722
              ?old ~inplace ~command
723 724 725 726 727
              ~driver:npc.prover_driver
              ~callback
              (goal_task g)
          with NoFile f ->
            Todo._done todo (g,a.proof_prover,0,Edited_file_absent f);
François Bobot's avatar
François Bobot committed
728 729 730 731 732 733 734 735 736 737 738 739
    end

let check_goal_and_children eS eT todo g =
  goal_iter_proof_attempt (check_external_proof eS eT todo) g

let check_all eS eT ~callback =
  dprintf debug "[Sched] check all@.%a@." print_session eS.session;
  let todo = Todo.create (ref []) push_report  in
  session_iter_proof_attempt (check_external_proof eS eT todo)
    eS.session;
  let timeout () =
    match Todo._end todo with
740 741
      | None -> true
      | Some reports -> callback !reports;false
François Bobot's avatar
François Bobot committed
742 743 744
  in
  schedule_any_timeout eT timeout

745 746 747 748 749

(***********************************)
(* play all                        *)
(***********************************)

750
let rec play_on_goal_and_children eS eT ~timelimit ~memlimit todo l g =
751
  let callback _key status =
752 753 754 755 756 757
    match status with
      | Undone Running | Undone Scheduled -> ()
      |  _ ->
        Todo._done todo ();
        (* eprintf "todo decreased to %d@." todo.Todo.todo *)
  in
758
  List.iter
759
    (fun p ->
760
      Todo.todo todo;
761 762 763
      (* eprintf "todo increased to %d@." todo.Todo.todo; *)
      (* eprintf "prover %a on goal %s@." *)
      (*   Whyconf.print_prover p g.goal_name.Ident.id_string; *)
764
      prover_on_goal eS eT ~callback ~timelimit ~memlimit p g)
765
    l;
François Bobot's avatar
François Bobot committed
766 767 768 769 770 771 772 773 774
  iter_goal
    (fun _ -> ())
    (iter_transf
       (play_on_goal_and_children eS eT ~timelimit ~memlimit todo l)
    )
    (iter_metas
       (play_on_goal_and_children eS eT ~timelimit ~memlimit todo l)
    )
    g
775 776


777
let play_all eS eT ~callback ~timelimit ~memlimit l =
778
  let todo = Todo.create (ref ()) (fun _ _ -> ())  in
779
  PHstr.iter
780
    (fun _ file ->
781 782 783
      List.iter
        (fun th ->
          List.iter
784
            (play_on_goal_and_children eS eT ~timelimit ~memlimit todo l)
785 786
            th.theory_goals)
        file.file_theories)
787 788
    eS.session.session_files;
  let timeout () =
789
    (* eprintf "Timeout handler@."; *)
790 791 792 793 794 795
    match Todo._end todo with
      | None ->  true
      | Some _ -> callback (); false
  in
  schedule_any_timeout eT timeout

796

797

François Bobot's avatar
François Bobot committed
798 799
(** Transformation *)

800
let transformation_on_goal_aux eS tr keep_dumb_transformation g =
François Bobot's avatar
François Bobot committed
801
  let subgoals = Trans.apply_transform tr eS.env (goal_task g) in
802
  let b = keep_dumb_transformation ||
François Bobot's avatar
François Bobot committed
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
    match subgoals with
      | [task] ->
              (* let s1 = task_checksum (get_task g) in *)
              (* let s2 = task_checksum task in *)
              (* (\* *)
              (*   eprintf "Transformation returned only one task.
                   sum before = %s, sum after = %s@." (task_checksum g.task)
                   (task_checksum task); *)
              (*   eprintf "addresses: %x %x@." (Obj.magic g.task)
                   (Obj.magic task); *)
              (* *\) *)
              (* s1 <> s2 *)
        not (Task.task_equal task (goal_task g))
      | _ -> true
  in
  if b then
    let goal_name = g.goal_name.Ident.id_string in
    let i = ref (-1) in
    let ntr = add_transformation
      ~keygen:O.create
      ~goal:(fun subtask ->
        incr i;
        let gid,expl,task = goal_expl_task subtask in
        let gid =
          Ident.id_derive (goal_name ^ "." ^ (string_of_int (!i))) gid in
        let gid = Ident.id_register gid in
        gid,expl,task)
830
      eS tr g subgoals in
831 832 833
    init_any (Transf ntr);
    Some ntr
  else None
François Bobot's avatar
François Bobot committed
834

835 836 837 838 839 840
let transform_goal eS sched ?(keep_dumb_transformation=false)
    ?callback tr g =
  schedule_delayed_action sched
    (fun () -> let ntr = transformation_on_goal_aux eS tr
                 keep_dumb_transformation g in
               Util.apply_option () callback ntr)
François Bobot's avatar
François Bobot committed
841 842


843 844 845 846 847
let transform_goal_or_children ~context_unproved_goals_only eS sched ?callback
    tr g =
  goal_iter_leaf_goal ~unproved_only:context_unproved_goals_only
    (transform_goal eS sched ~keep_dumb_transformation:false
       ?callback tr) g
François Bobot's avatar
François Bobot committed
848

849
let rec transform eS sched ~context_unproved_goals_only ?callback tr a =
François Bobot's avatar
François Bobot committed
850 851
  match a with
    | Goal g | Proof_attempt {proof_parent = g} ->
852 853 854
      transform_goal_or_children ~context_unproved_goals_only eS sched
        ?callback tr g
    | _ -> iter (transform ~context_unproved_goals_only eS sched ?callback tr) a
François Bobot's avatar
François Bobot committed
855 856 857 858 859

(*****************************)
(* method: edit current goal *)
(*****************************)

860
let edit_proof eS sched ~default_editor a =
François Bobot's avatar
François Bobot committed
861
  (* check that the state is not Scheduled or Running *)
862
  if a.proof_archived || running a then ()
François Bobot's avatar
François Bobot committed
863 864 865 866
(*
    info_window `ERROR "Edition already in progress"
*)
  else
867 868 869 870 871 872 873 874
      match find_prover eS a with
        | None ->
          (* nothing to do 
             TODO: report an non replayable proof if some option is set
          *)
          ()
        | Some(_,npc,a) ->
(*
875 876
    let ap = a.proof_prover in
    match find_loadable_prover eS a.proof_prover with
François Bobot's avatar
François Bobot committed
877
      | None -> ()
878 879
        (** Perhaps a new prover *)
      | Some (nap,npc) ->
François Bobot's avatar
François Bobot committed
880
          let g = a.proof_parent in
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
          try
            if nap == ap then raise Not_found;
            let np_a = PHprover.find g.goal_external_proofs nap in
            if O.replace_prover np_a a then begin
              (** The notification will be done by the new proof_attempt *)
              O.remove np_a.proof_key;
              raise Not_found end
          with Not_found ->
          (** replace [a] by a new_proof attempt if [a.proof_prover] was not
              loadable *)
          let a = if nap == ap then a
            else
              let a = copy_external_proof
                ~notify ~keygen:O.create ~prover:nap ~env_session:eS a in
              O.init a.proof_key (Proof_attempt a);
              a in
          (** Now [a] is a proof_attempt of the lodable prover [nap] *)
898 899
*)

François Bobot's avatar
François Bobot committed
900 901
          let callback res =
            match res with
902
              | Done {Call_provers.pr_answer = Call_provers.Unknown ""} ->
903 904
                set_proof_state ~notify ~obsolete:true ~archived:false
                  (Undone JustEdited) a
François Bobot's avatar
François Bobot committed
905
              | _ ->
906 907
                  set_proof_state ~notify ~obsolete:false ~archived:false
                    res a
François Bobot's avatar
François Bobot committed
908 909
          in
          let editor =
910
            match npc.prover_config.Whyconf.editor with
911 912 913 914 915 916 917
            | "" -> default_editor
            | s ->
              try
                let ed = Whyconf.editor_by_id eS.whyconf s in
                String.concat " "(ed.Whyconf.editor_command ::
                  ed.Whyconf.editor_options)
              with Not_found -> default_editor
François Bobot's avatar
François Bobot committed
918
          in
919
          let file = update_edit_external_proof eS a in
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
920
          dprintf debug "[Editing] goal %a with command '%s' on file %s@."
921 922 923 924 925
            (fun fmt a -> pp_print_string fmt
              (Task.task_goal (goal_task a.proof_parent))
              . Decl.pr_name.Ident.id_string)
            a editor file;
          schedule_edition sched editor file callback
François Bobot's avatar
François Bobot committed
926 927 928 929 930 931 932 933 934 935 936 937 938 939

(*************)
(* removing  *)
(*************)

let remove_proof_attempt (a:O.key proof_attempt) =
  O.remove a.proof_key;
  let notify = (notify : O.key notify) in
  remove_external_proof ~notify a

let remove_transformation t =
  O.remove t.transf_key;
  remove_transformation ~notify t

François Bobot's avatar
François Bobot committed
940 941 942 943
let remove_metas t =
  O.remove t.metas_key;
  remove_metas ~notify t

François Bobot's avatar
François Bobot committed
944 945 946 947
let rec clean = function
  | Goal g when g.goal_verified ->
    iter_goal
      (fun a ->
948
        if a.proof_obsolete || not (proof_successful_or_just_edited a) then
François Bobot's avatar
François Bobot committed
949 950 951
          remove_proof_attempt a)
      (fun t ->
        if not t.transf_verified then remove_transformation t
François Bobot's avatar
François Bobot committed
952 953 954 955 956
        else transf_iter clean t)
      (fun m ->
        if not m.metas_verified then remove_metas m
        else metas_iter clean m)
      g
François Bobot's avatar
François Bobot committed
957
  | Goal g ->
François Bobot's avatar
François Bobot committed
958 959 960 961
    (** don't iter on proof_attempt if the goal is not proved *)
    iter_goal
      (fun _ -> ())
      (fun t ->
MARCHE Claude's avatar
MARCHE Claude committed
962 963 964 965 966
        (* NO !!! 
           if not t.transf_verified then remove_transformation t
        else 
        *)
        transf_iter clean t)
François Bobot's avatar
François Bobot committed
967 968 969 970
      (fun m ->
        if not m.metas_verified then remove_metas m
        else metas_iter clean m)
      g
François Bobot's avatar
François Bobot committed
971 972 973 974 975 976 977 978 979
  | Proof_attempt a -> clean (Goal a.proof_parent)
  | any -> iter clean any

(**** convert ***)

let convert_unknown_prover =
  Session_tools.convert_unknown_prover ~keygen:O.create

end
980 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 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050


module Base_scheduler (X : sig end)  =
  (struct

    let usleep t = ignore (Unix.select [] [] [] t)


    let idle_handler = ref None
    let timeout_handler = ref None

     let idle f =
       match !idle_handler with
         | None -> idle_handler := Some f;
         | Some _ -> failwith "Replay.idle: already one handler installed"

     let timeout ~ms f =
       match !timeout_handler with
         | None -> timeout_handler := Some(float ms /. 1000.0 ,f);
         | Some _ -> failwith "Replay.timeout: already one handler installed"

     let notify_timer_state w s r =
       Printf.eprintf "Progress: %d/%d/%d                       \r%!" w s r

     let main_loop () =
       let last = ref (Unix.gettimeofday ()) in
       try while true do
           let time = Unix.gettimeofday () -. !last in
           (* attempt to run timeout handler *)
           let timeout =
             match !timeout_handler with
               | None -> false
               | Some(ms,f) ->
                 if time > ms then
                   let b = f () in
                   if b then true else
                     begin
                       timeout_handler := None;
                       true
                     end
                 else false
           in
           if timeout then
             last := Unix.gettimeofday ()
           else
      (* attempt to run the idle handler *)
             match !idle_handler with
               | None ->
                 begin
                   let ms =
                     match !timeout_handler with
                       | None -> raise Exit
                       | Some(ms,_) -> ms
                   in
                   usleep (ms -. time)
                 end
               | Some f ->
                 let b = f () in
                 if b then () else
                   begin
                     idle_handler := None;
                   end
         done
       with Exit -> ()

end)





François Bobot's avatar
François Bobot committed
1051 1052 1053 1054 1055
(*
Local Variables:
compile-command: "unset LANG; make -C ../.. bin/why3ide.byte"
End:
*)