session_scheduler.ml 34.4 KB
Newer Older
Andrei Paskevich's avatar
Andrei Paskevich committed
1 2 3
(********************************************************************)
(*                                                                  *)
(*  The Why3 Verification Platform   /   The Why3 Development Team  *)
Jean-Christophe Filliâtre's avatar
Jean-Christophe Filliâtre committed
4
(*  Copyright 2010-2014   --   INRIA - CNRS - Paris-Sud University  *)
Andrei Paskevich's avatar
Andrei Paskevich committed
5 6 7 8 9 10
(*                                                                  *)
(*  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.                           *)
(*                                                                  *)
(********************************************************************)
François Bobot's avatar
François Bobot committed
11 12 13 14

open Format
open Session

15
let debug = Debug.register_info_flag "scheduler"
Andrei Paskevich's avatar
Andrei Paskevich committed
16
  ~desc:"Print@ debugging@ messages@ about@ scheduling@ of@ prover@ calls@ \
MARCHE Claude's avatar
MARCHE Claude committed
17
         and@ transformation@ applications."
François Bobot's avatar
François Bobot committed
18

19 20 21
let usleep t = ignore (Unix.select [] [] [] t)
let default_delay_ms = 100 (* 0.1 seconds *)

22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
module Todo = struct
  type ('a,'b) todo =
      {mutable todo : int;
       mutable report : 'a;
       push_report : 'a -> 'b -> 'a;
       callback : 'a -> unit}

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

  let stop todo =
    todo.todo <- todo.todo - 1;
    if todo.todo=0 then todo.callback todo.report

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

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

(** dead code
  let print todo =
    dprintf debug "[Sched] todo : %i@." todo.todo
*)
end

François Bobot's avatar
François Bobot committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
(***************************)
(*     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

68 69
  val uninstalled_prover :
    key env_session -> Whyconf.prover -> Whyconf.prover_upgrade_policy
70

François Bobot's avatar
François Bobot committed
71 72 73 74
end



MARCHE Claude's avatar
MARCHE Claude committed
75
module Make(O : OBSERVER) = struct
François Bobot's avatar
François Bobot committed
76 77 78 79 80 81

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

type action =
82
  | Action_proof_attempt of int * int * int * string option * bool * string *
François Bobot's avatar
François Bobot committed
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
      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 =
MARCHE Claude's avatar
MARCHE Claude committed
113
  (* TODO dequeue actions if maximum_running_proofs increase *)
François Bobot's avatar
François Bobot committed
114 115 116
  sched.maximum_running_proofs <- max

let init max =
117
  Debug.dprintf debug "[Sched] init scheduler max=%i@." max;
François Bobot's avatar
François Bobot committed
118 119 120 121 122 123 124 125 126 127
  { 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
  }

128 129 130
let notify_timer_state t continue =
  O.notify_timer_state
    (Queue.length t.actions_queue)
131
    (Queue.length t.proof_attempts_queue)
132 133 134
    (List.length t.running_proofs);
  continue

François Bobot's avatar
François Bobot committed
135 136 137
(* timeout handler *)

let timeout_handler t =
138
  Debug.dprintf debug "[Sched] Timeout handler called@.";
François Bobot's avatar
François Bobot committed
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
  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
161
        callback Running;
162
        Debug.dprintf debug "[Sched] proof attempts started@.";
François Bobot's avatar
François Bobot committed
163 164 165 166 167 168 169 170 171 172 173 174 175 176
        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
      | [] ->
177
          Debug.dprintf debug "[Sched] Timeout handler stopped@.";
François Bobot's avatar
François Bobot committed
178 179 180 181 182
          false
      | _ -> true
  in
  t.timeout_handler_activated <- continue;
  t.timeout_handler_running <- false;
183
  notify_timer_state t continue
François Bobot's avatar
François Bobot committed
184 185 186 187 188

let run_timeout_handler t =
  if t.timeout_handler_activated then () else
    begin
      t.timeout_handler_activated <- true;
189
      Debug.dprintf debug "[Sched] Timeout handler started@.";
190
      O.timeout ~ms:default_delay_ms (fun () -> timeout_handler t)
François Bobot's avatar
François Bobot committed
191 192 193
    end

let schedule_any_timeout t callback =
194
  Debug.dprintf debug "[Sched] schedule a new timeout@.";
François Bobot's avatar
François Bobot committed
195 196 197
  t.running_proofs <- (Any_timeout callback) :: t.running_proofs;
  run_timeout_handler t

MARCHE Claude's avatar
MARCHE Claude committed
198
(* unused
199
let schedule_check t callback =
200
  Debug.dprintf debug "[Sched] add a new check@.";
François Bobot's avatar
François Bobot committed
201 202
  t.running_check <- callback :: t.running_check;
  run_timeout_handler t
MARCHE Claude's avatar
MARCHE Claude committed
203
*)
François Bobot's avatar
François Bobot committed
204 205 206 207 208

(* idle handler *)

let idle_handler t =
  try
MARCHE Claude's avatar
MARCHE Claude committed
209 210
    if Queue.length t.proof_attempts_queue < 3 * t.maximum_running_proofs then
      begin
François Bobot's avatar
François Bobot committed
211
      match Queue.pop t.actions_queue with
212
        | Action_proof_attempt(timelimit,memlimit,stepslimit,old,inplace,command,driver,
François Bobot's avatar
François Bobot committed
213 214 215 216 217
                               callback,goal) ->
            begin
              try
                let pre_call =
                  Driver.prove_task
218
                    ?old ~inplace ~command ~timelimit ~stepslimit ~memlimit driver goal
François Bobot's avatar
François Bobot committed
219 220 221
                in
                Queue.push (callback,pre_call) t.proof_attempts_queue;
                run_timeout_handler t
222
              with e when not (Debug.test_flag Debug.stack_trace) ->
MARCHE Claude's avatar
MARCHE Claude committed
223 224
                Format.eprintf
                  "@[Exception raise in Session.idle_handler:@ %a@.@]"
François Bobot's avatar
François Bobot committed
225 226 227 228
                  Exn_printer.exn_printer e;
                callback (InternalFailure e)
            end
        | Action_delayed callback -> callback ()
MARCHE Claude's avatar
MARCHE Claude committed
229 230
    end
    else
231
      usleep (float default_delay_ms /. 1000.);
232
    notify_timer_state t true
MARCHE Claude's avatar
MARCHE Claude committed
233 234 235 236
  with
    | Queue.Empty ->
      t.idle_handler_activated <- false;
      Debug.dprintf debug "[Sched] idle_handler stopped@.";
237
      notify_timer_state t false
238
    | e when not (Debug.test_flag Debug.stack_trace) ->
François Bobot's avatar
François Bobot committed
239 240 241
      Format.eprintf "@[Exception raise in Session.idle_handler:@ %a@.@]"
        Exn_printer.exn_printer e;
      eprintf "Session.idle_handler stopped@.";
242
      notify_timer_state t false
François Bobot's avatar
François Bobot committed
243 244 245 246 247 248


let run_idle_handler t =
  if t.idle_handler_activated then () else
    begin
      t.idle_handler_activated <- true;
249
      Debug.dprintf debug "[Sched] idle_handler started@.";
François Bobot's avatar
François Bobot committed
250 251 252 253 254 255 256 257 258 259
      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
260
        | Action_proof_attempt(_timelimit,_memlimit,_stepslimit,_old,_inplace,_command,
François Bobot's avatar
François Bobot committed
261
                               _driver,callback,_goal) ->
262
            callback Interrupted
François Bobot's avatar
François Bobot committed
263 264 265 266 267 268 269 270
        | 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
271
        callback Interrupted
François Bobot's avatar
François Bobot committed
272 273
      done
    with
274
      | Queue.Empty ->
François Bobot's avatar
François Bobot committed
275 276 277
          O.notify_timer_state 0 0 (List.length t.running_proofs)


278
let schedule_proof_attempt ~timelimit ~memlimit ~stepslimit ?old ~inplace
François Bobot's avatar
François Bobot committed
279
    ~command ~driver ~callback t goal =
280
  Debug.dprintf debug "[Sched] Scheduling a new proof attempt (goal : %a)@."
281 282
    (fun fmt g -> Format.pp_print_string fmt
      (Task.task_goal g).Decl.pr_name.Ident.id_string) goal;
283
  callback Scheduled;
François Bobot's avatar
François Bobot committed
284
  Queue.push
285
    (Action_proof_attempt(timelimit,memlimit,stepslimit,old,inplace,command,driver,
François Bobot's avatar
François Bobot committed
286 287 288 289 290
                        callback,goal))
    t.actions_queue;
  run_idle_handler t

let schedule_edition t command filename callback =
291
  Debug.dprintf debug "[Sched] Scheduling an edition@.";
292 293 294
  let res_parser =
    { Call_provers.prp_exitcodes = [(0,Call_provers.Unknown "")];
      Call_provers.prp_regexps = [];
295 296
      Call_provers.prp_timeregexps = [];
      Call_provers.prp_stepsregexp = [];
297
    } in
François Bobot's avatar
François Bobot committed
298
  let precall =
299
    Call_provers.call_on_file ~command ~res_parser ~redirect:false filename in
300
  callback Running;
François Bobot's avatar
François Bobot committed
301 302 303 304
  t.running_proofs <- (Check_prover(callback, precall ())) :: t.running_proofs;
  run_timeout_handler t

let schedule_delayed_action t callback =
305
  Debug.dprintf debug "[Sched] Scheduling a delayed action@.";
François Bobot's avatar
François Bobot committed
306 307 308 309
  Queue.push (Action_delayed callback) t.actions_queue;
  run_idle_handler t

(**************************)
MARCHE Claude's avatar
MARCHE Claude committed
310
(*  session functions     *)
François Bobot's avatar
François Bobot committed
311 312
(**************************)

MARCHE Claude's avatar
MARCHE Claude committed
313 314 315 316 317 318
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

319 320
let update_session ~allow_obsolete ~release ~use_shapes
    old_session env whyconf  =
François Bobot's avatar
François Bobot committed
321
  O.reset ();
322 323 324 325 326 327 328
  let ctxt = {
    allow_obsolete_goals = allow_obsolete;
    release_tasks = release;
    use_shapes_for_pairing_sub_goals = use_shapes;
    keygen = O.create;
  }
  in
329
  let (env_session,_,_) as res =
330
    update_session ~ctxt old_session env whyconf
MARCHE Claude's avatar
MARCHE Claude committed
331
  in
332
  Debug.dprintf debug "Init_session@\n";
François Bobot's avatar
François Bobot committed
333 334 335
  init_session env_session.session;
  res

336 337
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
338 339 340 341 342 343 344 345
  let any_file = (File mfile) in
  init_any any_file;
  O.notify any_file;
  mfile

(*****************************************************)
(* method: run a given prover on each unproved goals *)
(*****************************************************)
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365

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)
Andrei Paskevich's avatar
Andrei Paskevich committed
366
                  | None ->
367 368 369 370 371 372
                    (* should never happen because at loading, config
                       ignores uninstalled prover targets.
                       Nevertheless, we can safely return None.
                    *)
                    None
            end
Andrei Paskevich's avatar
Andrei Paskevich committed
373
          | Whyconf.CPU_duplicate new_p ->
374 375 376 377 378 379 380 381 382 383
            (* 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
Andrei Paskevich's avatar
Andrei Paskevich committed
384
                  ~notify ~keygen:O.create ~prover:new_p ~env_session:eS a
385 386 387 388
                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)
Andrei Paskevich's avatar
Andrei Paskevich committed
389
                  | None ->
390 391 392 393 394 395
                    (* should never happen because at loading, config
                       ignores uninstalled prover targets.
                       Nevertheless, we can safely return None.
                    *)
                    None
            end
396

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

398 399 400 401
(* 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 a =
402
  match a.proof_state with
403 404 405 406 407 408
  | Done { Call_provers.pr_answer = r;
           Call_provers.pr_time = t } ->
    (* 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 increased_time =
409 410
      let t = truncate (1.0 +. 2.0 *. t) in
      max a.proof_timelimit (min t (2 * a.proof_timelimit))
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
    in
    (* increased mem limit is just 1.5 times the previous mem limit *)
    let increased_mem = 3 * a.proof_memlimit / 2 in
    begin
      match r with
      | Call_provers.OutOfMemory -> increased_time, a.proof_memlimit
      | Call_provers.Timeout -> a.proof_timelimit, increased_mem
      | Call_provers.Valid
      | Call_provers.Unknown _
      | Call_provers.Invalid -> increased_time, increased_mem
      | Call_provers.Failure _
      | Call_provers.HighFailure ->
        (* correct ? failures are supposed to appear quickly anyway... *)
        a.proof_timelimit, a.proof_memlimit
    end
  | _ -> a.proof_timelimit, a.proof_memlimit

428

429
type run_external_status =
430 431 432 433
| Starting
| MissingProver
| MissingFile of string
| StatusChange of proof_attempt_status
434 435 436

exception NoFile of string

437 438 439
(* do not modify the proof duration stored in proof sessions if it
   changed by less than 10% or 0.1s, so as to avoid diff noise in
   session files *)
440 441 442 443
let fuzzy_proof_time nres ores =
  match ores, nres with
  | Done { Call_provers.pr_time = told },
    Done ({ Call_provers.pr_time = tnew } as res')
444
  when tnew >= told *. 0.9 -. 0.1 && tnew <= told *. 1.1 +. 0.1 ->
445 446 447
    Done { res' with Call_provers.pr_time = told }
  | _, _ -> nres

448 449 450
(** run_external_proof_v3 doesn't modify existing proof attempt, it can just
    create new one by find_prover *)
let run_external_proof_v3 eS eT a callback =
451 452
  match find_prover eS a with
  | None ->
453
    callback a a.proof_prover 0 None Starting;
454 455 456
    (* nothing to do *)
    callback a a.proof_prover 0 None MissingProver
  | Some(ap,npc,a) ->
457
    callback a ap 0 None Starting;
458 459 460 461 462
    if a.proof_edited_as = None &&
       npc.prover_config.Whyconf.interactive
    then begin
      callback a ap 0 None (MissingFile "unedited")
    end else begin
463
      let previous_result = a.proof_state in
464
      let timelimit, memlimit = adapt_limits a in
465
      let stepslimit =
466
	match a with
467 468 469
	| { proof_state =
            Done { Call_provers.pr_answer = Call_provers.Valid;
                   Call_provers.pr_steps = s };
470 471
	    proof_obsolete = false } when s >= 0 -> s
	| _ -> -1
472
      in
473 474 475
      let inplace = npc.prover_config.Whyconf.in_place in
      let command = Whyconf.get_complete_command npc.prover_config in
      let cb result =
476
        let result = fuzzy_proof_time result previous_result in
477 478 479 480 481 482 483 484 485 486 487
        callback a ap timelimit
          (match previous_result with Done res -> Some res | _ -> None)
          (StatusChange result) in
      try
        let old =
          match get_edited_as_abs eS.session a with
          | None -> None
          | Some f ->
            if Sys.file_exists f then Some f
            else raise (NoFile f) in
        schedule_proof_attempt
488
          ~timelimit ~memlimit ~stepslimit
489 490 491 492
          ?old ~inplace ~command
          ~driver:npc.prover_driver
          ~callback:cb
          eT
493
          (goal_task_or_recover eS a.proof_parent)
494 495 496 497
      with NoFile f ->
        callback a ap 0 None (MissingFile f)
    end

498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
(** run_external_proof_v2 modify the session according to the current state *)
let run_external_proof_v2 eS eT a callback =
  let previous_res = ref (a.proof_state,a.proof_obsolete) in
  let callback a ap timelimit previous state =
    begin match state with
    | Starting -> previous_res := (a.proof_state,a.proof_obsolete)
    | MissingFile _ ->
      set_proof_state ~notify ~obsolete:false ~archived:false
        Unedited a
    | StatusChange result ->
      begin match result with
      | Interrupted ->
        let previous_result,obsolete = !previous_res in
        set_proof_state ~notify ~obsolete
          ~archived:false previous_result a
      | _ ->
        set_proof_state ~notify ~obsolete:false
          ~archived:false result a
      end
    | _ -> ()
    end;
519
    callback a ap timelimit previous state
MARCHE Claude's avatar
MARCHE Claude committed
520
  in
521 522
  run_external_proof_v3 eS eT a callback

MARCHE Claude's avatar
MARCHE Claude committed
523 524 525 526 527
let running = function
  | Scheduled | Running -> true
  | Unedited | JustEdited | Interrupted
  | Done _ | InternalFailure _ -> false

528 529 530 531
let run_external_proof_v2 eS eT a callback =
  (* Perhaps the test a.proof_archived should be done somewhere else *)
  if a.proof_archived || running a.proof_state then () else
  run_external_proof_v2 eS eT a callback
532

533
let run_external_proof eS eT ?callback a =
534 535 536 537 538 539 540 541
  let callback =
    match callback with
    | None -> fun _ _ _ _ _ -> ()
    | Some c -> fun a _ _ _ s ->
      match s with
      | Starting -> ()
      | MissingProver -> c a Interrupted
      | MissingFile _ -> c a a.proof_state
542
      | StatusChange s -> c a s
MARCHE Claude's avatar
MARCHE Claude committed
543
  in
544
  run_external_proof_v2 eS eT a callback
François Bobot's avatar
François Bobot committed
545

546
let prover_on_goal eS eT ?callback ~timelimit ~memlimit p g =
François Bobot's avatar
François Bobot committed
547
  let a =
548 549 550
    try
      let a = PHprover.find g.goal_external_proofs p in
      set_timelimit timelimit a;
551
      set_memlimit memlimit a;
552
      a
François Bobot's avatar
François Bobot committed
553
    with Not_found ->
554
      let ep = add_external_proof ~keygen:O.create ~obsolete:false
Andrei Paskevich's avatar
Andrei Paskevich committed
555
        ~archived:false ~timelimit ~memlimit
556
        ~edit:None g p Interrupted in
François Bobot's avatar
François Bobot committed
557 558 559
      O.init ep.proof_key (Proof_attempt ep);
      ep
  in
560
  run_external_proof eS eT ?callback a
François Bobot's avatar
François Bobot committed
561

562
let prover_on_goal_or_children eS eT
563
    ~context_unproved_goals_only ~timelimit ~memlimit p g =
564
  goal_iter_leaf_goal ~unproved_only:context_unproved_goals_only
565
    (prover_on_goal eS eT ~timelimit ~memlimit p) g
François Bobot's avatar
François Bobot committed
566

567
let run_prover eS eT ~context_unproved_goals_only ~timelimit ~memlimit pr a =
François Bobot's avatar
François Bobot committed
568 569 570
  match a with
    | Goal g ->
        prover_on_goal_or_children eS eT
571
          ~context_unproved_goals_only ~timelimit ~memlimit pr g
François Bobot's avatar
François Bobot committed
572 573 574
    | Theory th ->
        List.iter
          (prover_on_goal_or_children eS eT
575
             ~context_unproved_goals_only ~timelimit ~memlimit pr)
François Bobot's avatar
François Bobot committed
576 577 578 579 580 581
          th.theory_goals
    | File file ->
        List.iter
          (fun th ->
             List.iter
               (prover_on_goal_or_children eS eT
582
                  ~context_unproved_goals_only ~timelimit ~memlimit pr)
François Bobot's avatar
François Bobot committed
583 584 585 586
               th.theory_goals)
          file.file_theories
    | Proof_attempt a ->
        prover_on_goal_or_children eS eT
587
          ~context_unproved_goals_only ~timelimit ~memlimit pr a.proof_parent
François Bobot's avatar
François Bobot committed
588 589 590
    | Transf tr ->
        List.iter
          (prover_on_goal_or_children eS eT
591
             ~context_unproved_goals_only ~timelimit ~memlimit pr)
François Bobot's avatar
François Bobot committed
592
          tr.transf_goals
François Bobot's avatar
François Bobot committed
593 594 595
    | 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
596 597 598 599 600

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

601 602 603 604 605
(* in the default context, a proof should be replayed if
   . it was successful or
   . it was just edited
*)
let proof_should_be_replayed a =
François Bobot's avatar
François Bobot committed
606
  match a.proof_state with
607
    | Done { Call_provers.pr_answer = Call_provers.Valid }
608
    | JustEdited -> true
François Bobot's avatar
François Bobot committed
609 610 611 612
    | _ -> 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
613 614
  iter_goal
    (fun a ->
François Bobot's avatar
François Bobot committed
615
       if not obsolete_only || a.proof_obsolete then
616
         if not context_unproved_goals_only || proof_should_be_replayed a
617
         then run_external_proof eS eT a)
François Bobot's avatar
François Bobot committed
618 619 620 621 622 623 624 625 626
    (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
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653

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
654 655 656 657
    | 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
658 659 660 661 662

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

663 664 665
let cancel_proof a =
  if not a.proof_archived then
    set_obsolete ~notify a
François Bobot's avatar
François Bobot committed
666 667 668

let cancel = iter_proof_attempt cancel_proof

669 670
(** Set or unset archive *)

671
let set_archive a b = set_archived a b; notify (Proof_attempt a)
672

François Bobot's avatar
François Bobot committed
673 674 675 676 677 678 679 680
(*********************************)
(* method: check existing proofs *)
(*********************************)

type report =
  | Result of Call_provers.prover_result * Call_provers.prover_result
  | CallFailed of exn
  | Prover_not_installed
681
  | Edited_file_absent of string
François Bobot's avatar
François Bobot committed
682 683
  | No_former_result of Call_provers.prover_result

684
let push_report report (g,p,t,r) =
685
  (g.goal_name,p,t,r)::report
François Bobot's avatar
François Bobot committed
686 687

let check_external_proof eS eT todo a =
688 689 690 691
  let callback a ap tl old s =
    let g = a.proof_parent in
    match s with
    | Starting ->
692
      Todo.start todo
693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
    | MissingFile f ->
      Todo._done todo (g, ap, tl, Edited_file_absent f)
    | MissingProver ->
      Todo._done todo (g, ap, tl, Prover_not_installed)
    | StatusChange (Scheduled | Running) -> ()
    | StatusChange (Interrupted | Unedited | JustEdited) -> assert false
    | StatusChange (InternalFailure e) ->
      Todo._done todo (g, ap, tl, CallFailed e)
    | StatusChange (Done res) ->
      let r =
        match old with
        | None -> No_former_result res
        | Some old -> Result (res, old) in
      Todo._done todo (g, ap, tl, r) in
  run_external_proof_v2 eS eT a callback
François Bobot's avatar
François Bobot committed
708

709 710 711 712 713 714 715
let rec goal_iter_proof_attempt_with_release ~release f g =
  let iter g = goal_iter_proof_attempt_with_release ~release f g in
  PHprover.iter (fun _ a -> f a) g.goal_external_proofs;
  PHstr.iter (fun _ t -> List.iter iter t.transf_goals) g.goal_transformations;
  Mmetas_args.iter (fun _ t -> iter t.metas_goal) g.goal_metas;
  if release then release_task g

716
let check_all ?(release=false) ?filter eS eT ~callback =
717
  Debug.dprintf debug "[Sched] check all@.%a@." print_session eS.session;
718
  let todo = Todo.create [] push_report callback in
719
  Todo.start todo;
720
  let check_top_goal g =
721 722 723 724 725
    let check a =
      let c = match filter with
        | None -> true
        | Some f -> f a in
      if c then check_external_proof eS eT todo a in
726
    goal_iter_proof_attempt_with_release ~release check g
727 728
  in
  PHstr.iter (fun _ file ->
729 730
      List.iter (fun t ->
          List.iter check_top_goal t.theory_goals)
731 732
        file.file_theories)
    eS.session.session_files;
733
  Todo.stop todo
François Bobot's avatar
François Bobot committed
734

735 736 737 738 739

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

740
let rec play_on_goal_and_children eS eT ~timelimit ~memlimit todo l g =
741 742 743 744 745 746 747 748 749
  let timelimit, memlimit, auto_proved =
    PHprover.fold (fun _ pa (timelimit, memlimit, _ as acc) ->
      match pa.proof_edited_as, pa.proof_state with
        | None, Done { Call_provers.pr_answer = Call_provers.Valid } ->
            max timelimit pa.proof_timelimit,
            max memlimit pa.proof_memlimit,
            true
        | _ -> acc)
      g.goal_external_proofs (timelimit, memlimit, false) in
750
  let callback _key status =
751
    if not (running status) then Todo._done todo () in
752 753 754 755
  if auto_proved then begin
    List.iter
      (fun p ->
        Todo.start todo;
756 757 758
      (* eprintf "todo increased to %d@." todo.Todo.todo; *)
      (* eprintf "prover %a on goal %s@." *)
      (*   Whyconf.print_prover p g.goal_name.Ident.id_string; *)
759 760 761
        prover_on_goal eS eT ~callback ~timelimit ~memlimit p g)
      l
  end;
François Bobot's avatar
François Bobot committed
762 763 764 765 766 767 768 769 770
  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
771 772


773
let play_all eS eT ~callback ~timelimit ~memlimit l =
774 775
  let todo = Todo.create () (fun () _ -> ()) callback in
  Todo.start todo;
776
  PHstr.iter
777
    (fun _ file ->
778 779 780
      List.iter
        (fun th ->
          List.iter
781
            (play_on_goal_and_children eS eT ~timelimit ~memlimit todo l)
782 783
            th.theory_goals)
        file.file_theories)
784
    eS.session.session_files;
785
  Todo.stop todo
786

787

François Bobot's avatar
François Bobot committed
788 789
(** Transformation *)

790
let transformation_on_goal_aux eS tr keep_dumb_transformation g =
791 792
  let gtask = goal_task_or_recover eS g in
  let subgoals = Trans.apply_transform tr eS.env gtask in
793
  let b = keep_dumb_transformation ||
François Bobot's avatar
François Bobot committed
794
    match subgoals with
795
      | [task] -> not (Task.task_equal task gtask)
François Bobot's avatar
François Bobot committed
796 797 798
      | _ -> true
  in
  if b then
799
    let ntr = add_transformation ~init:init_any ~notify ~keygen:O.create eS tr g subgoals in
800 801
    Some ntr
  else None
François Bobot's avatar
François Bobot committed
802

803 804 805 806 807
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
808
               Opt.apply () callback ntr)
François Bobot's avatar
François Bobot committed
809 810


811 812 813 814 815
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
816

817
let rec transform eS sched ~context_unproved_goals_only ?callback tr a =
François Bobot's avatar
François Bobot committed
818 819
  match a with
    | Goal g | Proof_attempt {proof_parent = g} ->
820 821 822
      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
823 824 825 826 827

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

828 829 830
let edit_proof_v3 eS sched ~default_editor callback a =
  match find_prover eS a with
  | None ->
Andrei Paskevich's avatar
Andrei Paskevich committed
831
          (* nothing to do
832 833
             TODO: report an non replayable proof if some option is set
          *)
834 835 836 837 838 839 840 841 842 843 844 845 846
    ()
  | Some(_,npc,a) ->
    let editor =
      match npc.prover_config.Whyconf.editor with
      | "" -> 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
    in
    let file = update_edit_external_proof eS a in
847
    Debug.dprintf debug "[Editing] goal %s with command '%s' on file %s@."
848
      a.proof_parent.goal_name.Ident.id_string editor file;
849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
    schedule_edition sched editor file (fun res -> callback a res)

let edit_proof eS sched ~default_editor a =
  (* check that the state is not Scheduled or Running *)
  if a.proof_archived || running a.proof_state then ()
(*
    info_window `ERROR "Edition already in progress"
*)
  else
    let callback a res =
      match res with
      | Done {Call_provers.pr_answer = Call_provers.Unknown ""} ->
        set_proof_state ~notify ~obsolete:true ~archived:false
          JustEdited a
      | _ ->
        set_proof_state ~notify ~obsolete:false ~archived:false
          res a
    in
    edit_proof_v3 eS sched ~default_editor callback a

let edit_proof_v3 eS sched ~default_editor ~callback a =
  let callback a res =
    match res with
    | Done {Call_provers.pr_answer = Call_provers.Unknown ""} ->
      callback a
    | _ -> ()
  in
  edit_proof_v3 eS sched ~default_editor callback a

François Bobot's avatar
François Bobot committed
878 879 880 881 882 883 884 885 886 887 888 889 890 891

(*************)
(* 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
892 893 894 895
let remove_metas t =
  O.remove t.metas_key;
  remove_metas ~notify t

896 897 898 899 900 901 902 903 904 905 906
(* a proof is removable if
    . it is not in progress and
    . it is obsolete or not successful
*)
let proof_removable a =
  match a.proof_state with
  | Done pr ->
    a.proof_obsolete || pr.Call_provers.pr_answer <> Call_provers.Valid
  | _ -> false


François Bobot's avatar
François Bobot committed
907
let rec clean = function
908
  | Goal g when Opt.inhabited g.goal_verified ->
François Bobot's avatar
François Bobot committed
909
    iter_goal
910
      (fun a -> if proof_removable a then remove_proof_attempt a)
François Bobot's avatar
François Bobot committed
911
      (fun t ->
912
        if not (Opt.inhabited t.transf_verified) then remove_transformation t
François Bobot's avatar
François Bobot committed
913 914
        else transf_iter clean t)
      (fun m ->
915
        if not (Opt.inhabited m.metas_verified) then remove_metas m
François Bobot's avatar
François Bobot committed
916 917
        else metas_iter clean m)
      g
François Bobot's avatar
François Bobot committed
918
  | Goal g ->
François Bobot's avatar
François Bobot committed
919
    (** don't iter on proof_attempt if the goal is not proved *)
920
    iter_goal (fun _ -> ()) (transf_iter clean) (metas_iter clean) g
François Bobot's avatar
François Bobot committed
921 922 923 924 925 926 927 928
  | 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

929
  open Strategy
MARCHE Claude's avatar
MARCHE Claude committed
930

931
  let rec exec_strategy ~todo es sched pc strat g =
MARCHE Claude's avatar
MARCHE Claude committed
932 933
    if pc < 0 || pc >= Array.length strat then
      (* halt the strategy *)
934
      Todo._done todo ()
MARCHE Claude's avatar
MARCHE Claude committed
935 936 937 938 939
    else
      match Array.get strat pc with
        | Icall_prover(p,timelimit,memlimit) ->
          let callback _pa res =
            match res with
940
              | Scheduled | Running ->
MARCHE Claude's avatar
MARCHE Claude committed
941 942 943 944
                (* nothing to do yet *)
                ()
              | Done { Call_provers.pr_answer = Call_provers.Valid } ->
                (* proof succeeded, nothing more to do *)
945
                Todo._done todo ()
MARCHE Claude's avatar
MARCHE Claude committed
946 947
              | Interrupted | InternalFailure _ | Done _ ->
                (* proof did not succeed, goto to next step *)
948
                let callback () = exec_strategy ~todo es sched (pc+1) strat g in
MARCHE Claude's avatar
MARCHE Claude committed
949
                schedule_delayed_action sched callback
950
              | Unedited | JustEdited ->
MARCHE Claude's avatar
MARCHE Claude committed
951 952 953 954
                (* should not happen *)
                assert false
          in
          prover_on_goal es sched ~callback ~timelimit ~memlimit p g
955 956 957 958
        | Itransform(trname,pcsuccess) ->
          let callback ntr =
            match ntr with
              | None -> (* transformation failed *)
959
                let callback () = exec_strategy ~todo es sched (pc+1) strat g in
960 961 962 963
                schedule_delayed_action sched callback
              | Some tr ->
                List.iter
                  (fun g ->
964
                    Todo.start todo;
965
                    let callback () =
966
                      exec_strategy ~todo es sched pcsuccess strat g
967 968 969
                    in
                    schedule_delayed_action sched callback
                  )
970 971
                tr.transf_goals;
                Todo._done todo ()
972 973
          in
          transform_goal es sched ~callback trname g
MARCHE Claude's avatar
MARCHE Claude committed
974
        | Igoto pc ->
975
          exec_strategy ~todo es sched pc strat g
MARCHE Claude's avatar
MARCHE Claude committed
976 977


978 979 980 981 982 983 984 985 986
  let run_strategy_on_goal
      ?(intermediate_callback=fun () -> ())
      ?(final_callback=fun () -> ())
      es sched strat g =
    let todo =
      Todo.create () (fun () -> intermediate_callback) final_callback
    in
    Todo.start todo;
    let callback () = exec_strategy ~todo es sched 0 strat g in
MARCHE Claude's avatar
MARCHE Claude committed
987 988
    schedule_delayed_action sched callback

989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003

  let run_strategy_on_goal_or_children ~context_unproved_goals_only
      eS sched strat g =
    goal_iter_leaf_goal ~unproved_only:context_unproved_goals_only
      (run_strategy_on_goal eS sched strat) g

  let rec run_strategy eS sched ~context_unproved_goals_only strat a =
    match a with
    | Goal g | Proof_attempt {proof_parent = g} ->
      run_strategy_on_goal_or_children ~context_unproved_goals_only
        eS sched strat g
    | _ ->
      iter (run_strategy ~context_unproved_goals_only eS sched strat) a


François Bobot's avatar
François Bobot committed
1004
end
1005 1006 1007 1008 1009 1010 1011 1012


module Base_scheduler (X : sig end)  =
  (struct

    let idle_handler = ref None
    let timeout_handler = ref None

1013 1014
    let verbose = ref true

1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
     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 =
1026 1027
       if !verbose then
         Printf.eprintf "Progress: %d/%d/%d                       \r%!" w s r
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049