session_scheduler.ml 35.5 KB
Newer Older
1 2 3
(********************************************************************)
(*                                                                  *)
(*  The Why3 Verification Platform   /   The Why3 Development Team  *)
4
(*  Copyright 2010-2015   --   INRIA - CNRS - Paris-Sud University  *)
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 =
David Hauzar's avatar
David Hauzar committed
82
  | Action_proof_attempt of bool * int * int * int * string option * bool * string *
François Bobot's avatar
François Bobot committed
83 84 85 86 87 88 89 90
      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 =
91
    { (* Actions that wait some idle time *)
François Bobot's avatar
François Bobot committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
      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
  assert (not t.timeout_handler_running);
  t.timeout_handler_running <- true;
141
  (* Check if some action ended *)
François Bobot's avatar
François Bobot committed
142 143 144 145 146 147 148 149 150 151 152 153 154 155
  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
156
  (* Check if some new actions must be started *)
François Bobot's avatar
François Bobot committed
157 158 159 160
  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
        let call = pre_call () in
        (Check_prover(callback,call))::l
      with Queue.Empty -> l
      end
    else l
  in
  t.running_proofs <- l;
170
  (* Call the running check *)
François Bobot's avatar
François Bobot committed
171 172 173 174 175 176
  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
David Hauzar's avatar
David Hauzar committed
212
        | Action_proof_attempt(cntexample,timelimit,memlimit,steplimit,
213
              old,inplace,command,driver,callback,goal) ->
François Bobot's avatar
François Bobot committed
214 215 216
            begin
              try
                let pre_call =
David Hauzar's avatar
David Hauzar committed
217
                  Driver.prove_task ?old ~cntexample ~inplace ~command
218
                    ~timelimit ~steplimit ~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
David Hauzar's avatar
David Hauzar committed
260
        | Action_proof_attempt(_cntexample,_timelimit,_memlimit,_steplimit,
261
              _old,_inplace,_command,_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)


David Hauzar's avatar
David Hauzar committed
278
let schedule_proof_attempt ~cntexample ~timelimit ~memlimit ~steplimit ?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
David Hauzar's avatar
David Hauzar committed
285
    (Action_proof_attempt(cntexample,timelimit,memlimit,steplimit,
286
      old,inplace,command,driver,callback,goal))
François Bobot's avatar
François Bobot committed
287 288 289 290
    t.actions_queue;
  run_idle_handler t

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

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

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

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

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

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

(*****************************************************)
(* method: run a given prover on each unproved goals *)
(*****************************************************)
347

348 349
let find_prover eS a =
  match load_prover eS a.proof_prover with
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
    | 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;
365
                match load_prover eS new_p with
366
                  | Some p -> Some (new_p,p,a)
367
                  | None ->
368 369 370 371 372 373
                    (* should never happen because at loading, config
                       ignores uninstalled prover targets.
                       Nevertheless, we can safely return None.
                    *)
                    None
            end
374
          | Whyconf.CPU_duplicate new_p ->
375 376 377 378 379 380 381 382 383 384
            (* 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
385
                  ~notify ~keygen:O.create ~prover:new_p ~env_session:eS a
386 387
                in
                O.init new_a.proof_key (Proof_attempt new_a);
388
                match load_prover eS new_p with
389
                  | Some p -> Some (new_p,p,new_a)
390
                  | None ->
391 392 393 394 395 396
                    (* 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 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 *)
402
let adapt_limits ~use_steps a =
403
  match a.proof_state with
404
  | Done { Call_provers.pr_answer = r;
405 406
           Call_provers.pr_time = t;
           Call_provers.pr_steps = s } ->
407 408 409 410
    (* 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 =
411 412
      let t = truncate (1.0 +. 2.0 *. t) in
      max a.proof_timelimit (min t (2 * a.proof_timelimit))
413 414 415 416 417
    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
418 419 420 421 422 423 424
      | Call_provers.OutOfMemory -> increased_time, a.proof_memlimit, -1
      | Call_provers.Timeout -> a.proof_timelimit, increased_mem, -1
      | Call_provers.Valid ->
        let steplimit =
          if use_steps && not a.proof_obsolete then s else -1
        in
        increased_time, increased_mem, steplimit
425
      | Call_provers.Unknown _
426 427
      | Call_provers.StepLimitExceeded
      | Call_provers.Invalid -> increased_time, increased_mem, -1
428 429 430
      | Call_provers.Failure _
      | Call_provers.HighFailure ->
        (* correct ? failures are supposed to appear quickly anyway... *)
431
        a.proof_timelimit, a.proof_memlimit, -1
432
    end
433 434
  | _ -> a.proof_timelimit, a.proof_memlimit, -1

435

436

437
type run_external_status =
438 439 440 441
| Starting
| MissingProver
| MissingFile of string
| StatusChange of proof_attempt_status
442 443 444

exception NoFile of string

445 446 447
(* 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 *)
448 449 450 451
let fuzzy_proof_time nres ores =
  match ores, nres with
  | Done { Call_provers.pr_time = told },
    Done ({ Call_provers.pr_time = tnew } as res')
452
  when tnew >= told *. 0.9 -. 0.1 && tnew <= told *. 1.1 +. 0.1 ->
453 454 455
    Done { res' with Call_provers.pr_time = told }
  | _, _ -> nres

456 457
let dummy_limits = (0,0,0)

458 459
(** run_external_proof_v3 doesn't modify existing proof attempt, it can just
    create new one by find_prover *)
460
let run_external_proof_v3 ~use_steps eS eT a ?(cntexample=false) callback =
461
  match find_prover eS a with
462
  | None ->
463
    callback a a.proof_prover dummy_limits None Starting;
464
    (* nothing to do *)
465
    callback a a.proof_prover dummy_limits None MissingProver
466
  | Some(ap,npc,a) ->
467
    callback a ap dummy_limits None Starting;
468 469 470
    if a.proof_edited_as = None &&
       npc.prover_config.Whyconf.interactive
    then begin
471
      callback a ap dummy_limits None (MissingFile "unedited")
472
    end else begin
473
      let previous_result = a.proof_state in
474
      let timelimit, memlimit, steplimit = adapt_limits ~use_steps a in
475
      let inplace = npc.prover_config.Whyconf.in_place in
476
      let command = Whyconf.get_complete_command npc.prover_config steplimit in
477
      let cb result =
478
        let result = fuzzy_proof_time result previous_result in
479
        callback a ap (timelimit,memlimit,steplimit)
480 481 482 483 484 485 486 487 488 489
          (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
David Hauzar's avatar
David Hauzar committed
490
          ~cntexample ~timelimit ~memlimit ~steplimit
491 492 493 494
          ?old ~inplace ~command
          ~driver:npc.prover_driver
          ~callback:cb
          eT
495
          (goal_task_or_recover eS a.proof_parent)
496
      with NoFile f ->
497
        callback a ap dummy_limits None (MissingFile f)
498 499
    end

500
(** run_external_proof_v2 modify the session according to the current state *)
501
let run_external_proof_v2 ~use_steps eS eT a ~cntexample callback =
502
  let previous_res = ref (a.proof_state,a.proof_obsolete) in
503
  let callback a ap limits previous state =
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
    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;
521
    callback a ap limits previous state
MARCHE Claude's avatar
MARCHE Claude committed
522
  in
523
  run_external_proof_v3 ~use_steps eS eT a ~cntexample callback
524

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

530
let run_external_proof_v2 ~use_steps eS eT a ?(cntexample=false) callback =
531 532
  (* Perhaps the test a.proof_archived should be done somewhere else *)
  if a.proof_archived || running a.proof_state then () else
533
  run_external_proof_v2 ~use_steps eS eT a ~cntexample callback
534

David Hauzar's avatar
David Hauzar committed
535
let run_external_proof eS eT ?(cntexample=false) ?callback a =
536 537 538 539 540 541 542 543
  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
544
      | StatusChange s -> c a s
MARCHE Claude's avatar
MARCHE Claude committed
545
  in
546
  run_external_proof_v2 ~use_steps:false eS eT a ~cntexample callback
François Bobot's avatar
François Bobot committed
547

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

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

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

599

François Bobot's avatar
François Bobot committed
600 601 602 603 604

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

605 606 607
let cancel_proof a =
  if not a.proof_archived then
    set_obsolete ~notify a
François Bobot's avatar
François Bobot committed
608 609 610

let cancel = iter_proof_attempt cancel_proof

611 612
(** Set or unset archive *)

613
let set_archive a b = set_archived a b; notify (Proof_attempt a)
614

François Bobot's avatar
François Bobot committed
615 616 617 618 619 620 621 622
(*********************************)
(* method: check existing proofs *)
(*********************************)

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

626 627
let push_report report (g,p,limits,r) =
  (g.goal_name,p,limits,r)::report
François Bobot's avatar
François Bobot committed
628

629
let check_external_proof ~use_steps eS eT todo a =
630
  let callback a ap limits old s =
631 632 633
    let g = a.proof_parent in
    match s with
    | Starting ->
634
      Todo.start todo
635
    | MissingFile f ->
636
      Todo._done todo (g, ap, limits, Edited_file_absent f)
637
    | MissingProver ->
638
      Todo._done todo (g, ap, limits, Prover_not_installed)
639 640 641
    | StatusChange (Scheduled | Running) -> ()
    | StatusChange (Interrupted | Unedited | JustEdited) -> assert false
    | StatusChange (InternalFailure e) ->
642
      Todo._done todo (g, ap, limits, CallFailed e)
643 644 645 646 647
    | StatusChange (Done res) ->
      let r =
        match old with
        | None -> No_former_result res
        | Some old -> Result (res, old) in
648
      Todo._done todo (g, ap, limits, r) in
649
  run_external_proof_v2 ~use_steps eS eT a callback
François Bobot's avatar
François Bobot committed
650

651 652 653 654 655 656 657
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

658
let check_all ?(release=false) ~use_steps ?filter eS eT ~callback =
659
  Debug.dprintf debug "[Sched] check all@.%a@." print_session eS.session;
660
  let todo = Todo.create [] push_report callback in
661
  Todo.start todo;
662
  let check_top_goal g =
663 664 665 666
    let check a =
      let c = match filter with
        | None -> true
        | Some f -> f a in
667
      if c then check_external_proof ~use_steps eS eT todo a in
668
    goal_iter_proof_attempt_with_release ~release check g
669 670
  in
  PHstr.iter (fun _ file ->
671 672
      List.iter (fun t ->
          List.iter check_top_goal t.theory_goals)
673 674
        file.file_theories)
    eS.session.session_files;
675
  Todo.stop todo
François Bobot's avatar
François Bobot committed
676

677

678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
(**********************************)
(* method: replay obsolete proofs *)
(**********************************)

(* in the default context, a proof should be replayed if
   . it was successful or
   . it was just edited
*)
let proof_should_be_replayed a =
  match a.proof_state with
    | Done { Call_provers.pr_answer = Call_provers.Valid }
    | JustEdited -> true
    | _ -> false

let rec replay_on_goal_or_children eS eT
    ~obsolete_only ~context_unproved_goals_only g =
  iter_goal
    (fun a ->
       if not obsolete_only || a.proof_obsolete then
         if not context_unproved_goals_only || proof_should_be_replayed a
         then run_external_proof eS eT a)
    (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

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
    | Metas m ->
      replay_on_goal_or_children eS eT
        ~obsolete_only ~context_unproved_goals_only m.metas_goal


740 741 742 743
(***********************************)
(* play all                        *)
(***********************************)

744 745 746
let rec play_on_goal_and_children eS eT ~timelimit ~steplimit ~memlimit todo l g =
  let timelimit, steplimit, memlimit, auto_proved =
    PHprover.fold (fun _ pa (timelimit, steplimit, memlimit, _ as acc) ->
747 748 749
      match pa.proof_edited_as, pa.proof_state with
        | None, Done { Call_provers.pr_answer = Call_provers.Valid } ->
            max timelimit pa.proof_timelimit,
750
	    max steplimit pa.proof_steplimit,
751 752 753
            max memlimit pa.proof_memlimit,
            true
        | _ -> acc)
754
      g.goal_external_proofs (timelimit, steplimit, memlimit, false) in
755
  let callback _key status =
756
    if not (running status) then Todo._done todo () in
757 758 759 760
  if auto_proved then begin
    List.iter
      (fun p ->
        Todo.start 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 ~steplimit ~memlimit p g)
765 766
      l
  end;
767 768 769
  iter_goal
    (fun _ -> ())
    (iter_transf
770
       (play_on_goal_and_children eS eT ~timelimit ~steplimit ~memlimit todo l)
771 772
    )
    (iter_metas
773
       (play_on_goal_and_children eS eT ~timelimit ~steplimit ~memlimit todo l)
774 775
    )
    g
776 777


778
let play_all eS eT ~callback ~timelimit ~steplimit ~memlimit l =
779 780
  let todo = Todo.create () (fun () _ -> ()) callback in
  Todo.start todo;
781
  PHstr.iter
782
    (fun _ file ->
783 784 785
      List.iter
        (fun th ->
          List.iter
786
            (play_on_goal_and_children eS eT ~timelimit ~steplimit ~memlimit todo l)
787 788
            th.theory_goals)
        file.file_theories)
789
    eS.session.session_files;
790
  Todo.stop todo
791

792

François Bobot's avatar
François Bobot committed
793 794
(** Transformation *)

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

808 809 810 811 812
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
813
               Opt.apply () callback ntr)
François Bobot's avatar
François Bobot committed
814 815


816 817 818 819 820
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
821

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

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

833
let edit_proof_v3 ~cntexample eS sched ~default_editor callback a =
834 835
  match find_prover eS a with
  | None ->
836
          (* nothing to do
837 838
             TODO: report an non replayable proof if some option is set
          *)
839 840 841 842 843 844 845 846 847 848 849 850
    ()
  | 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
851
    let file = update_edit_external_proof ~cntexample eS a in
852
    Debug.dprintf debug "[Editing] goal %s with command '%s' on file %s@."
853
      a.proof_parent.goal_name.Ident.id_string editor file;
854 855
    schedule_edition sched editor file (fun res -> callback a res)

856
let edit_proof ~cntexample eS sched ~default_editor a =
857 858 859 860 861 862 863 864
  (* 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
865
      | Done {Call_provers.pr_answer = Call_provers.Unknown ("", _)} ->
866 867 868 869 870 871
        set_proof_state ~notify ~obsolete:true ~archived:false
          JustEdited a
      | _ ->
        set_proof_state ~notify ~obsolete:false ~archived:false
          res a
    in
872
    edit_proof_v3 ~cntexample eS sched ~default_editor callback a
873

874
let edit_proof_v3 ~cntexample eS sched ~default_editor ~callback a =
875 876
  let callback a res =
    match res with
877
    | Done {Call_provers.pr_answer = Call_provers.Unknown ("", _)} ->
878 879 880
      callback a
    | _ -> ()
  in
881
  edit_proof_v3 ~cntexample eS sched ~default_editor callback a
882

François Bobot's avatar
François Bobot committed
883 884 885 886 887 888 889 890 891 892 893 894 895 896

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

897 898 899 900
let remove_metas t =
  O.remove t.metas_key;
  remove_metas ~notify t

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
907
  | Scheduled | Running -> false
908 909
  | Done pr ->
    a.proof_obsolete || pr.Call_provers.pr_answer <> Call_provers.Valid
910
  | Unedited | JustEdited | Interrupted | InternalFailure _ -> true
911 912


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

935
  open Strategy
MARCHE Claude's avatar
MARCHE Claude committed
936

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


984 985 986 987 988 989 990 991 992
  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
993 994
    schedule_delayed_action sched callback

995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009

  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
1010
end
1011 1012 1013 1014 1015 1016 1017 1018


module Base_scheduler (X : sig end)  =
  (struct

    let idle_handler = ref None
    let timeout_handler = ref None

1019 1020
    let verbose = ref true

1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
     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 =
1032 1033
       if !verbose then
         Printf.eprintf "Progress: %d/%d/%d                       \r%!" w s r
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 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081

     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
1082 1083 1084 1085 1086
(*
Local Variables:
compile-command: "unset LANG; make -C ../.. bin/why3ide.byte"
End:
*)