session_scheduler.ml 33.8 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

open Format
13
open Why3
François Bobot's avatar
François Bobot committed
14 15
open Session

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

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

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 49
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
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
(***************************)
(*     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

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

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



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

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

type action =
83
  | Action_proof_attempt of int * int * string option * bool * string *
François Bobot's avatar
François Bobot committed
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 113
      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
114
  (* TODO dequeue actions if maximum_running_proofs increase *)
François Bobot's avatar
François Bobot committed
115 116 117
  sched.maximum_running_proofs <- max

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

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

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

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

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

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

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

(* idle handler *)

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


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


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

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

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

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

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

316
let update_session ~use_shapes ?release ~allow_obsolete old_session env whyconf  =
François Bobot's avatar
François Bobot committed
317
  O.reset ();
318
  let (env_session,_,_) as res =
319
    update_session ~use_shapes ?release
MARCHE Claude's avatar
MARCHE Claude committed
320
      ~keygen:O.create ~allow_obsolete old_session env whyconf
MARCHE Claude's avatar
MARCHE Claude committed
321
  in
322
  Debug.dprintf debug "Init_session@\n";
François Bobot's avatar
François Bobot committed
323 324 325
  init_session env_session.session;
  res

326 327
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
328 329 330 331 332 333 334 335
  let any_file = (File mfile) in
  init_any any_file;
  O.notify any_file;
  mfile

(*****************************************************)
(* method: run a given prover on each unproved goals *)
(*****************************************************)
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355

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

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

388 389 390 391
(* 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 =
392
  match a.proof_state with
393 394 395 396 397 398
  | 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 =
399 400
      let t = truncate (1.0 +. 2.0 *. t) in
      max a.proof_timelimit (min t (2 * a.proof_timelimit))
401 402 403 404 405 406 407 408 409 410 411 412 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
      | 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

418

419
type run_external_status =
420 421 422 423
| Starting
| MissingProver
| MissingFile of string
| StatusChange of proof_attempt_status
424 425 426

exception NoFile of string

427 428 429
(* 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 *)
430 431 432 433
let fuzzy_proof_time nres ores =
  match ores, nres with
  | Done { Call_provers.pr_time = told },
    Done ({ Call_provers.pr_time = tnew } as res')
434
  when tnew >= told *. 0.9 -. 0.1 && tnew <= told *. 1.1 +. 0.1 ->
435 436 437
    Done { res' with Call_provers.pr_time = told }
  | _, _ -> nres

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

480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
(** 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;
501
    callback a ap timelimit previous state
MARCHE Claude's avatar
MARCHE Claude committed
502
  in
503 504
  run_external_proof_v3 eS eT a callback

MARCHE Claude's avatar
MARCHE Claude committed
505 506 507 508 509
let running = function
  | Scheduled | Running -> true
  | Unedited | JustEdited | Interrupted
  | Done _ | InternalFailure _ -> false

510 511 512 513
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
514

515
let run_external_proof eS eT ?callback a =
516 517 518 519 520 521 522 523
  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
524
      | StatusChange s -> c a s
MARCHE Claude's avatar
MARCHE Claude committed
525
  in
526
  run_external_proof_v2 eS eT a callback
François Bobot's avatar
François Bobot committed
527

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

544
let prover_on_goal_or_children eS eT
545
    ~context_unproved_goals_only ~timelimit ~memlimit p g =
546
  goal_iter_leaf_goal ~unproved_only:context_unproved_goals_only
547
    (prover_on_goal eS eT ~timelimit ~memlimit p) g
François Bobot's avatar
François Bobot committed
548

549
let run_prover eS eT ~context_unproved_goals_only ~timelimit ~memlimit pr a =
François Bobot's avatar
François Bobot committed
550 551 552
  match a with
    | Goal g ->
        prover_on_goal_or_children eS eT
553
          ~context_unproved_goals_only ~timelimit ~memlimit pr g
François Bobot's avatar
François Bobot committed
554 555 556
    | Theory th ->
        List.iter
          (prover_on_goal_or_children eS eT
557
             ~context_unproved_goals_only ~timelimit ~memlimit pr)
François Bobot's avatar
François Bobot committed
558 559 560 561 562 563
          th.theory_goals
    | File file ->
        List.iter
          (fun 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
               th.theory_goals)
          file.file_theories
    | Proof_attempt a ->
        prover_on_goal_or_children eS eT
569
          ~context_unproved_goals_only ~timelimit ~memlimit pr a.proof_parent
François Bobot's avatar
François Bobot committed
570 571 572
    | Transf tr ->
        List.iter
          (prover_on_goal_or_children eS eT
573
             ~context_unproved_goals_only ~timelimit ~memlimit pr)
François Bobot's avatar
François Bobot committed
574
          tr.transf_goals
François Bobot's avatar
François Bobot committed
575 576 577
    | 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
578 579 580 581 582

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

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

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
632 633 634 635
    | 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
636 637 638 639 640

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

641 642 643
let cancel_proof a =
  if not a.proof_archived then
    set_obsolete ~notify a
François Bobot's avatar
François Bobot committed
644 645 646

let cancel = iter_proof_attempt cancel_proof

647 648
(** Set or unset archive *)

649
let set_archive a b = set_archived a b; notify (Proof_attempt a)
650

François Bobot's avatar
François Bobot committed
651 652 653 654 655 656 657 658
(*********************************)
(* method: check existing proofs *)
(*********************************)

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

662
let push_report report (g,p,t,r) =
663
  (g.goal_name,p,t,r)::report
François Bobot's avatar
François Bobot committed
664 665

let check_external_proof eS eT todo a =
666 667 668 669
  let callback a ap tl old s =
    let g = a.proof_parent in
    match s with
    | Starting ->
670
      Todo.start todo
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
    | 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
686

687 688 689 690 691 692 693
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

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

713 714 715 716 717

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

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


751
let play_all eS eT ~callback ~timelimit ~memlimit l =
752 753
  let todo = Todo.create () (fun () _ -> ()) callback in
  Todo.start todo;
754
  PHstr.iter
755
    (fun _ file ->
756 757 758
      List.iter
        (fun th ->
          List.iter
759
            (play_on_goal_and_children eS eT ~timelimit ~memlimit todo l)
760 761
            th.theory_goals)
        file.file_theories)
762
    eS.session.session_files;
763
  Todo.stop todo
764

765

François Bobot's avatar
François Bobot committed
766 767
(** Transformation *)

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

792 793 794 795 796
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
797
               Opt.apply () callback ntr)
François Bobot's avatar
François Bobot committed
798 799


800 801 802 803 804
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
805

806
let rec transform eS sched ~context_unproved_goals_only ?callback tr a =
François Bobot's avatar
François Bobot committed
807 808
  match a with
    | Goal g | Proof_attempt {proof_parent = g} ->
809 810 811
      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
812 813 814 815 816

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

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

(*************)
(* 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
881 882 883 884
let remove_metas t =
  O.remove t.metas_key;
  remove_metas ~notify t

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

920
  open Strategy
MARCHE Claude's avatar
MARCHE Claude committed
921 922 923 924 925 926 927 928 929 930

  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
931
              | Scheduled | Running ->
MARCHE Claude's avatar
MARCHE Claude committed
932 933 934 935 936 937 938 939 940
                (* 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
941
              | Unedited | JustEdited ->
MARCHE Claude's avatar
MARCHE Claude committed
942 943 944 945
                (* should not happen *)
                assert false
          in
          prover_on_goal es sched ~callback ~timelimit ~memlimit p g
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962
        | 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
963 964 965 966 967 968 969 970
        | 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

971 972 973 974 975 976 977 978 979 980 981 982 983 984 985

  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
986
end
987 988 989 990 991 992 993 994


module Base_scheduler (X : sig end)  =
  (struct

    let idle_handler = ref None
    let timeout_handler = ref None

995 996
    let verbose = ref true

997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
     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 =
1008 1009
       if !verbose then
         Printf.eprintf "Progress: %d/%d/%d                       \r%!" w s r
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057

     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
1058 1059 1060 1061 1062
(*
Local Variables:
compile-command: "unset LANG; make -C ../.. bin/why3ide.byte"
End:
*)