session_scheduler.ml 34 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 * 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,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 ~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,_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 ?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,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@.";
François Bobot's avatar
François Bobot committed
292 293
  let precall =
    Call_provers.call_on_file ~command ~regexps:[] ~timeregexps:[]
294
      ~exitcodes:[(0,Call_provers.Unknown "")] ~redirect:false filename
François Bobot's avatar
François Bobot committed
295
  in
296
  callback Running;
François Bobot's avatar
François Bobot committed
297 298 299 300
  t.running_proofs <- (Check_prover(callback, precall ())) :: t.running_proofs;
  run_timeout_handler t

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

(**************************)
MARCHE Claude's avatar
MARCHE Claude committed
306
(*  session functions     *)
François Bobot's avatar
François Bobot committed
307 308
(**************************)

MARCHE Claude's avatar
MARCHE Claude committed
309 310 311 312 313 314
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

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

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

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

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

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

395 396 397 398
(* 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 =
399
  match a.proof_state with
400 401 402 403 404 405
  | 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 =
406 407
      let t = truncate (1.0 +. 2.0 *. t) in
      max a.proof_timelimit (min t (2 * a.proof_timelimit))
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
    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

425

426
type run_external_status =
427 428 429 430
| Starting
| MissingProver
| MissingFile of string
| StatusChange of proof_attempt_status
431 432 433

exception NoFile of string

434 435 436
(* 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 *)
437 438 439 440
let fuzzy_proof_time nres ores =
  match ores, nres with
  | Done { Call_provers.pr_time = told },
    Done ({ Call_provers.pr_time = tnew } as res')
441
  when tnew >= told *. 0.9 -. 0.1 && tnew <= told *. 1.1 +. 0.1 ->
442 443 444
    Done { res' with Call_provers.pr_time = told }
  | _, _ -> nres

445 446 447
(** 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 =
448 449
  match find_prover eS a with
  | None ->
450
    callback a a.proof_prover 0 None Starting;
451 452 453
    (* nothing to do *)
    callback a a.proof_prover 0 None MissingProver
  | Some(ap,npc,a) ->
454
    callback a ap 0 None Starting;
455 456 457 458 459
    if a.proof_edited_as = None &&
       npc.prover_config.Whyconf.interactive
    then begin
      callback a ap 0 None (MissingFile "unedited")
    end else begin
460
      let previous_result = a.proof_state in
461
      let timelimit, memlimit = adapt_limits a in
462 463 464
      let inplace = npc.prover_config.Whyconf.in_place in
      let command = Whyconf.get_complete_command npc.prover_config in
      let cb result =
465
        let result = fuzzy_proof_time result previous_result in
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
        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
          ~timelimit ~memlimit
          ?old ~inplace ~command
          ~driver:npc.prover_driver
          ~callback:cb
          eT
482
          (goal_task_or_recover eS a.proof_parent)
483 484 485 486
      with NoFile f ->
        callback a ap 0 None (MissingFile f)
    end

487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
(** 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;
508
    callback a ap timelimit previous state
MARCHE Claude's avatar
MARCHE Claude committed
509
  in
510 511
  run_external_proof_v3 eS eT a callback

MARCHE Claude's avatar
MARCHE Claude committed
512 513 514 515 516
let running = function
  | Scheduled | Running -> true
  | Unedited | JustEdited | Interrupted
  | Done _ | InternalFailure _ -> false

517 518 519 520
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
521

522
let run_external_proof eS eT ?callback a =
523 524 525 526 527 528 529 530
  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
531
      | StatusChange s -> c a s
MARCHE Claude's avatar
MARCHE Claude committed
532
  in
533
  run_external_proof_v2 eS eT a callback
François Bobot's avatar
François Bobot committed
534

535
let prover_on_goal eS eT ?callback ~timelimit ~memlimit p g =
François Bobot's avatar
François Bobot committed
536
  let a =
537 538 539
    try
      let a = PHprover.find g.goal_external_proofs p in
      set_timelimit timelimit a;
540
      set_memlimit memlimit a;
541
      a
François Bobot's avatar
François Bobot committed
542
    with Not_found ->
543
      let ep = add_external_proof ~keygen:O.create ~obsolete:false
Andrei Paskevich's avatar
Andrei Paskevich committed
544
        ~archived:false ~timelimit ~memlimit
545
        ~edit:None g p Interrupted in
François Bobot's avatar
François Bobot committed
546 547 548
      O.init ep.proof_key (Proof_attempt ep);
      ep
  in
549
  run_external_proof eS eT ?callback a
François Bobot's avatar
François Bobot committed
550

551
let prover_on_goal_or_children eS eT
552
    ~context_unproved_goals_only ~timelimit ~memlimit p g =
553
  goal_iter_leaf_goal ~unproved_only:context_unproved_goals_only
554
    (prover_on_goal eS eT ~timelimit ~memlimit p) g
François Bobot's avatar
François Bobot committed
555

556
let run_prover eS eT ~context_unproved_goals_only ~timelimit ~memlimit pr a =
François Bobot's avatar
François Bobot committed
557 558 559
  match a with
    | Goal g ->
        prover_on_goal_or_children eS eT
560
          ~context_unproved_goals_only ~timelimit ~memlimit pr g
François Bobot's avatar
François Bobot committed
561 562 563
    | Theory th ->
        List.iter
          (prover_on_goal_or_children eS eT
564
             ~context_unproved_goals_only ~timelimit ~memlimit pr)
François Bobot's avatar
François Bobot committed
565 566 567 568 569 570
          th.theory_goals
    | File file ->
        List.iter
          (fun th ->
             List.iter
               (prover_on_goal_or_children eS eT
571
                  ~context_unproved_goals_only ~timelimit ~memlimit pr)
François Bobot's avatar
François Bobot committed
572 573 574 575
               th.theory_goals)
          file.file_theories
    | Proof_attempt a ->
        prover_on_goal_or_children eS eT
576
          ~context_unproved_goals_only ~timelimit ~memlimit pr a.proof_parent
François Bobot's avatar
François Bobot committed
577 578 579
    | Transf tr ->
        List.iter
          (prover_on_goal_or_children eS eT
580
             ~context_unproved_goals_only ~timelimit ~memlimit pr)
François Bobot's avatar
François Bobot committed
581
          tr.transf_goals
François Bobot's avatar
François Bobot committed
582 583 584
    | 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
585 586 587 588 589

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

590
let proof_successful_or_just_edited a =
François Bobot's avatar
François Bobot committed
591
  match a.proof_state with
592
    | Done { Call_provers.pr_answer = Call_provers.Valid }
593
    | JustEdited -> true
François Bobot's avatar
François Bobot committed
594 595 596 597
    | _ -> 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
598 599
  iter_goal
    (fun a ->
François Bobot's avatar
François Bobot committed
600
       if not obsolete_only || a.proof_obsolete then
601
         if not context_unproved_goals_only || proof_successful_or_just_edited a
602
         then run_external_proof eS eT a)
François Bobot's avatar
François Bobot committed
603 604 605 606 607 608 609 610 611
    (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
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638

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
639 640 641 642
    | 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
643 644 645 646 647

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

648 649 650
let cancel_proof a =
  if not a.proof_archived then
    set_obsolete ~notify a
François Bobot's avatar
François Bobot committed
651 652 653

let cancel = iter_proof_attempt cancel_proof

654 655
(** Set or unset archive *)

656
let set_archive a b = set_archived a b; notify (Proof_attempt a)
657

François Bobot's avatar
François Bobot committed
658 659 660 661 662 663 664 665
(*********************************)
(* method: check existing proofs *)
(*********************************)

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

669
let push_report report (g,p,t,r) =
670
  (g.goal_name,p,t,r)::report
François Bobot's avatar
François Bobot committed
671 672

let check_external_proof eS eT todo a =
673 674 675 676
  let callback a ap tl old s =
    let g = a.proof_parent in
    match s with
    | Starting ->
677
      Todo.start todo
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
    | 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
693

694 695 696 697 698 699 700
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

701
let check_all ?(release=false) ?filter eS eT ~callback =
702
  Debug.dprintf debug "[Sched] check all@.%a@." print_session eS.session;
703
  let todo = Todo.create [] push_report callback in
704
  Todo.start todo;
705
  let check_top_goal g =
706 707 708 709 710
    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
711
    goal_iter_proof_attempt_with_release ~release check g
712 713
  in
  PHstr.iter (fun _ file ->
714 715
      List.iter (fun t ->
          List.iter check_top_goal t.theory_goals)
716 717
        file.file_theories)
    eS.session.session_files;
718
  Todo.stop todo
François Bobot's avatar
François Bobot committed
719

720 721 722 723 724

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

725
let rec play_on_goal_and_children eS eT ~timelimit ~memlimit todo l g =
726 727 728 729 730 731 732 733 734
  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
735
  let callback _key status =
736
    if not (running status) then Todo._done todo () in
737 738 739 740
  if auto_proved then begin
    List.iter
      (fun p ->
        Todo.start todo;
741 742 743
      (* eprintf "todo increased to %d@." todo.Todo.todo; *)
      (* eprintf "prover %a on goal %s@." *)
      (*   Whyconf.print_prover p g.goal_name.Ident.id_string; *)
744 745 746
        prover_on_goal eS eT ~callback ~timelimit ~memlimit p g)
      l
  end;
François Bobot's avatar
François Bobot committed
747 748 749 750 751 752 753 754 755
  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
756 757


758
let play_all eS eT ~callback ~timelimit ~memlimit l =
759 760
  let todo = Todo.create () (fun () _ -> ()) callback in
  Todo.start todo;
761
  PHstr.iter
762
    (fun _ file ->
763 764 765
      List.iter
        (fun th ->
          List.iter
766
            (play_on_goal_and_children eS eT ~timelimit ~memlimit todo l)
767 768
            th.theory_goals)
        file.file_theories)
769
    eS.session.session_files;
770
  Todo.stop todo
771

772

François Bobot's avatar
François Bobot committed
773 774
(** Transformation *)

775
let transformation_on_goal_aux eS tr keep_dumb_transformation g =
776 777
  let gtask = goal_task_or_recover eS g in
  let subgoals = Trans.apply_transform tr eS.env gtask in
778
  let b = keep_dumb_transformation ||
François Bobot's avatar
François Bobot committed
779 780 781 782 783 784 785 786 787 788 789 790
    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 *)
791
        not (Task.task_equal task gtask)
François Bobot's avatar
François Bobot committed
792 793 794
      | _ -> true
  in
  if b then
795
    let ntr = add_transformation ~init:init_any ~notify ~keygen:O.create eS tr g subgoals in
796 797
    Some ntr
  else None
François Bobot's avatar
François Bobot committed
798

799 800 801 802 803
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
804
               Opt.apply () callback ntr)
François Bobot's avatar
François Bobot committed
805 806


807 808 809 810 811
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
812

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

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

824 825 826
let edit_proof_v3 eS sched ~default_editor callback a =
  match find_prover eS a with
  | None ->
Andrei Paskevich's avatar
Andrei Paskevich committed
827
          (* nothing to do
828 829
             TODO: report an non replayable proof if some option is set
          *)
830 831 832 833 834 835 836 837 838 839 840 841 842
    ()
  | 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
843
    Debug.dprintf debug "[Editing] goal %s with command '%s' on file %s@."
844
      a.proof_parent.goal_name.Ident.id_string editor file;
845 846 847 848 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
    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
874 875 876 877 878 879 880 881 882 883 884 885 886 887

(*************)
(* 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
888 889 890 891
let remove_metas t =
  O.remove t.metas_key;
  remove_metas ~notify t

François Bobot's avatar
François Bobot committed
892 893 894 895
let rec clean = function
  | Goal g when g.goal_verified ->
    iter_goal
      (fun a ->
896
        if a.proof_obsolete || not (proof_successful_or_just_edited a) then
François Bobot's avatar
François Bobot committed
897 898 899
          remove_proof_attempt a)
      (fun t ->
        if not t.transf_verified then remove_transformation t
François Bobot's avatar
François Bobot committed
900 901 902 903 904
        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
905
  | Goal g ->
François Bobot's avatar
François Bobot committed
906 907 908 909
    (** don't iter on proof_attempt if the goal is not proved *)
    iter_goal
      (fun _ -> ())
      (fun t ->
Andrei Paskevich's avatar
Andrei Paskevich committed
910
        (* NO !!!
MARCHE Claude's avatar
MARCHE Claude committed
911
           if not t.transf_verified then remove_transformation t
Andrei Paskevich's avatar
Andrei Paskevich committed
912
        else
MARCHE Claude's avatar
MARCHE Claude committed
913 914
        *)
        transf_iter clean t)
François Bobot's avatar
François Bobot committed
915 916 917 918
      (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
919 920 921 922 923 924 925 926
  | 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

927
  open Strategy
MARCHE Claude's avatar
MARCHE Claude committed
928 929 930 931 932 933 934 935 936 937

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


  let run_strategy_on_goal es sched strat g =
    let callback () = exec_strategy es sched 0 strat g in
    schedule_delayed_action sched callback

978 979 980 981 982 983 984 985 986 987 988 989 990 991 992

  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
993
end
994 995 996 997 998 999 1000 1001


module Base_scheduler (X : sig end)  =
  (struct

    let idle_handler = ref None
    let timeout_handler = ref None

1002 1003
    let verbose = ref true

1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
     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 =
1015 1016
       if !verbose then
         Printf.eprintf "Progress: %d/%d/%d                       \r%!" w s r
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 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064

     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
1065 1066 1067 1068 1069
(*
Local Variables:
compile-command: "unset LANG; make -C ../.. bin/why3ide.byte"
End:
*)