controller_itp.ml 47.1 KB
Newer Older
1 2 3
(********************************************************************)
(*                                                                  *)
(*  The Why3 Verification Platform   /   The Why3 Development Team  *)
Guillaume Melquiond's avatar
Guillaume Melquiond committed
4
(*  Copyright 2010-2019   --   Inria - CNRS - Paris-Sud University  *)
5 6 7 8 9 10 11
(*                                                                  *)
(*  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.                           *)
(*                                                                  *)
(********************************************************************)

12
open Format
13
open Wstdlib
Clément Fumex's avatar
Clément Fumex committed
14 15
open Session_itp

Sylvain Dailler's avatar
Sylvain Dailler committed
16 17 18 19
let debug_sched = Debug.register_info_flag "scheduler"
  ~desc:"Print@ debugging@ messages@ about@ scheduling@ of@ prover@ calls@ \
         and@ transformation@ applications."

Sylvain Dailler's avatar
Sylvain Dailler committed
20
let debug_call_prover = Debug.lookup_flag "call_prover"
21 22
let default_delay_ms = 100 (* 0.1 seconds *)

Clément Fumex's avatar
Clément Fumex committed
23 24
(** State of a proof *)
type proof_attempt_status =
25
  | Undone   (** prover was never called *)
26 27 28
  | Scheduled (** external proof attempt is scheduled *)
  | Running (** external proof attempt is in progress *)
  | Done of Call_provers.prover_result (** external proof done *)
29 30
  | Interrupted (** external proof has never completed *)
  | Detached (** parent goal has no task, is detached *)
31 32
  | InternalFailure of exn (** external proof aborted by internal error *)
  | Uninstalled of Whyconf.prover (** prover is uninstalled *)
33
  | UpgradeProver of Whyconf.prover (** prover is upgraded *)
34
  | Removed of Whyconf.prover (** prover has been removed or upgraded *)
Clément Fumex's avatar
Clément Fumex committed
35

MARCHE Claude's avatar
MARCHE Claude committed
36 37
let print_status fmt st =
  match st with
38
  | Undone            -> fprintf fmt "Undone"
Sylvain Dailler's avatar
Sylvain Dailler committed
39 40 41
  | Scheduled         -> fprintf fmt "Scheduled"
  | Running           -> fprintf fmt "Running"
  | Done r            ->
42 43
      fprintf fmt "Done(%a)"
        (Call_provers.print_prover_result ~json_model:false) r
44 45
  | Interrupted       -> fprintf fmt "Interrupted"
  | Detached          -> fprintf fmt "Detached"
Sylvain Dailler's avatar
Sylvain Dailler committed
46 47 48 49
  | InternalFailure e ->
      fprintf fmt "InternalFailure(%a)" Exn_printer.exn_printer e
  | Uninstalled pr    ->
      fprintf fmt "Prover %a is uninstalled" Whyconf.print_prover pr
50 51
  | UpgradeProver pr    ->
      fprintf fmt "Prover upgrade to %a" Whyconf.print_prover pr
52 53
  | Removed pr    ->
      fprintf fmt "Prover %a removed" Whyconf.print_prover pr
MARCHE Claude's avatar
MARCHE Claude committed
54 55

type transformation_status =
56
  | TSscheduled | TSdone of transID | TSfailed of (proofNodeID * exn)
Sylvain Dailler's avatar
Sylvain Dailler committed
57
  | TSfatal of (proofNodeID * exn)
58 59 60 61

let print_trans_status fmt st =
  match st with
  | TSscheduled -> fprintf fmt "TScheduled"
62
  | TSdone _tid -> fprintf fmt "TSdone" (* TODO print tid *)
63
  | TSfailed _e -> fprintf fmt "TSfailed"
Sylvain Dailler's avatar
Sylvain Dailler committed
64
  | TSfatal _e -> fprintf fmt "TSfatal"
Clément Fumex's avatar
Clément Fumex committed
65

66
type strategy_status = STSgoto of proofNodeID * int | STShalt
Sylvain Dailler's avatar
Sylvain Dailler committed
67
                     | STSfatal of string * proofNodeID * exn
68 69 70

let print_strategy_status fmt st =
  match st with
Sylvain Dailler's avatar
Sylvain Dailler committed
71 72
  | STSgoto(id,n) ->
      fprintf fmt "goto step %d in proofNode %a" n print_proofNodeID id
73
  | STShalt -> fprintf fmt "halt"
Sylvain Dailler's avatar
Sylvain Dailler committed
74
  | STSfatal _ -> fprintf fmt "fatal"
75 76


77
type controller =
Sylvain Dailler's avatar
Sylvain Dailler committed
78
  { mutable controller_session: Session_itp.session;
79
    mutable controller_config : Whyconf.config;
MARCHE Claude's avatar
MARCHE Claude committed
80
    mutable controller_env: Env.env;
Sylvain Dailler's avatar
Sylvain Dailler committed
81 82
    controller_provers:
      (Whyconf.config_prover * Driver.driver) Whyconf.Hprover.t;
83
    controller_strategies : (string * string * string * Strategy.instruction array) Hstr.t;
84
    controller_running_proof_attempts : unit Hpan.t;
85 86
  }

87 88 89 90 91
let session_max_tasks = ref 1

let set_session_max_tasks n =
  session_max_tasks := n;
  Prove_client.set_max_running_provers n
92

93 94 95
let set_session_prover_upgrade_policy c p u =
  c.controller_config <- Whyconf.set_prover_upgrade_policy c.controller_config p u

MARCHE Claude's avatar
MARCHE Claude committed
96 97 98
let load_drivers c =
  let env = c.controller_env in
  let config = c.controller_config in
99 100 101 102
  let provers = Whyconf.get_provers config in
  Whyconf.Mprover.iter
    (fun _ p ->
     try
103
       let d = Whyconf.load_driver (Whyconf.get_main config) env p.Whyconf.driver [] in
104 105
       Whyconf.Hprover.add c.controller_provers p.Whyconf.prover (p,d)
     with e ->
Sylvain Dailler's avatar
Sylvain Dailler committed
106
       Debug.dprintf debug_call_prover
107 108 109
         "[Controller_itp] error while loading driver for prover %a: %a@."
         Whyconf.print_prover p.Whyconf.prover
         Exn_printer.exn_printer e)
MARCHE Claude's avatar
MARCHE Claude committed
110 111 112 113 114 115 116 117 118
    provers

let create_controller config env ses =
  let c =
    {
      controller_session = ses;
      controller_config = config;
      controller_env = env;
      controller_provers = Whyconf.Hprover.create 7;
119
      controller_strategies = Hstr.create 7;
MARCHE Claude's avatar
MARCHE Claude committed
120 121 122 123
      controller_running_proof_attempts = Hpan.create 17;
    }
  in
  load_drivers c;
124 125
  c

126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146

(* Cannot remove a proof_attempt that was scheduled but did not finish yet.
   It can be interrupted though. *)
let removable_proof_attempt c pa =
  try let () = Hpan.find c.controller_running_proof_attempts pa in false
  with Not_found -> true

let any_removable c any =
  match any with
  | APa pa -> removable_proof_attempt c pa
  | _ -> true

(* Check whether the subtree [n] contains an unremovable proof_attempt
   (ie: scheduled or running) *)
let check_removable c (n: any) =
  fold_all_any c.controller_session (fun acc any -> acc && any_removable c any) true n


let remove_subtree ~(notification:notifier) ~(removed:notifier) c (n: any) =
  if check_removable c n then
    Session_itp.remove_subtree ~notification ~removed c.controller_session n
147

148 149 150
(* Get children of any without proofattempts *)
let get_undetached_children_no_pa s any : any list =
  match any with
151
  | AFile f -> List.map (fun th -> ATh th) (file_theories f)
152 153 154
  | ATh th  -> List.map (fun g -> APn g) (theory_goals th)
  | ATn tn  -> List.map (fun pn -> APn pn) (get_sub_tasks s tn)
  | APn pn  -> List.map (fun tn -> ATn tn) (get_transformations s pn)
Sylvain Dailler's avatar
Sylvain Dailler committed
155
  | APa _ -> []
156

157 158


159 160 161 162 163 164 165 166 167 168
(* printing *)

module PSession = struct

  type any =
    | Session
    | File of file
    | Theory of theory
    | Goal of proofNodeID
    | Transf of transID
169
    | ProofAttempt of proof_attempt_node
170 171 172 173 174 175 176 177

  type 'a t = { tcont : controller;
                tkind : any }

  let decomp x =
    let s = x.tcont.controller_session in
    let n y acc = { x with tkind = y } :: acc in
    match x.tkind with
178
    | Session -> "", Hfile.fold (fun _ f -> n (File f)) (get_files s) []
179
    | File f ->
180
       string_of_file_path (file_path f),
181
       List.fold_right (fun th -> n (Theory th)) (file_theories f) []
182 183 184
    | Theory th ->
       let id = theory_name th in
       let name = id.Ident.id_string in
185
       let name = if th_proved s th then name^"!" else name^"?" in
186
       name,
Sylvain Dailler's avatar
Sylvain Dailler committed
187 188 189
       List.fold_right
         (fun g -> n (Goal g))
         (theory_goals th)
MARCHE Claude's avatar
MARCHE Claude committed
190
         []
191 192 193
    | Goal id ->
       let gid = get_proof_name s id in
       let name = gid.Ident.id_string in
194
       let name = if pn_proved s id then name^"!" else name^"?" in
195 196 197 198 199 200 201
       let pas = get_proof_attempts s id in
       let trs = get_transformations s id in
       name,
       List.fold_right (fun g -> n (Transf g)) trs
                       (List.fold_right (fun g -> n (ProofAttempt g)) pas [])
    | ProofAttempt pa ->
       Pp.sprintf_wnl "%a%s%s"
Sylvain Dailler's avatar
Sylvain Dailler committed
202 203 204 205 206
          Whyconf.print_prover pa.prover
          (match pa.Session_itp.proof_state with
          | Some { Call_provers.pr_answer = Call_provers.Valid} -> ""
          | _ -> "?")
          (if pa.proof_obsolete then "O" else ""), []
207 208
    | Transf id ->
       let name = get_transf_name s id in
209
       let name = if tn_proved s id then name^"!" else name^"?" in
210 211
       let sts = get_sub_tasks s id in
       name,
MARCHE Claude's avatar
MARCHE Claude committed
212
       List.fold_right (fun g -> n (Goal g)) sts []
213 214 215 216 217 218 219 220 221 222 223 224

end

module P = Print_tree.PMake(PSession)

let print_session fmt c =
  P.print fmt { PSession.tcont = c; PSession.tkind = PSession.Session }

(*********)



225 226 227 228 229 230

(** reload files, associating old proof attempts and transformations
    to the new goals.  old theories and old goals for which we cannot
    find a corresponding new theory resp. old goal are kept, with
    tasks associated to them *)

231
let reload_files (c : controller) ~shape_version =
232
  let old_ses = c.controller_session in
MARCHE Claude's avatar
MARCHE Claude committed
233
  c.controller_env <- Env.create_env (Env.get_loadpath c.controller_env);
MARCHE Claude's avatar
MARCHE Claude committed
234 235
  Whyconf.Hprover.reset c.controller_provers;
  load_drivers c;
236
  c.controller_session <- empty_session ~from:old_ses (get_dir old_ses);
237
  merge_files ~shape_version c.controller_env c.controller_session old_ses
238 239 240

exception Errors_list of exn list

241 242
let reload_files (c: controller) ~shape_version =
  let errors, b1, b2 = reload_files c ~shape_version in
243 244 245
  match errors with
  | [] -> b1, b2
  | _ -> raise (Errors_list errors)
246 247

let add_file c ?format fname =
248 249 250
  let file_is_detached,theories,errors =
    try false,(Session_itp.read_file c.controller_env ?format fname), None
    with e -> true,[], Some e
251
  in
252
  let (_ : file) = add_file_section c.controller_session fname ~file_is_detached theories format in
253
  errors
254

255 256 257 258 259
let add_file c ?format fname =
  let errors = add_file c ?format fname in
  match errors with
  | None -> ()
  | Some error -> raise (Errors_list [error])
260 261

module type Scheduler = sig
262
  val blocking: bool
263
  val multiplier: int
264 265 266 267
  val timeout: ms:int -> (unit -> bool) -> unit
  val idle: prio:int -> (unit -> bool) -> unit
end

268 269
module Make(S : Scheduler) = struct

Sylvain Dailler's avatar
Sylvain Dailler committed
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
(* type for scheduled proof attempts *)
type sched_pa_rec =
  { spa_contr    : controller;
    spa_id       : proofNodeID;
    spa_pr       : Whyconf.prover;
    spa_limit    : Call_provers.resource_limit;
    spa_pr_scr   : string option;
    spa_callback : (proof_attempt_status -> unit);
    spa_ores     : Call_provers.prover_result option;
  }

let scheduled_proof_attempts : sched_pa_rec Queue.t = Queue.create ()

(* type for prover tasks in progress *)
type tasks_prog_rec =
  {
    tp_session  : Session_itp.session;
    tp_id       : proofNodeID;
    tp_pr       : Whyconf.prover;
    tp_callback : (proof_attempt_status -> unit);
    tp_started  : bool;
    tp_call     : Call_provers.prover_call;
    tp_ores     : Call_provers.prover_result option;
  }
MARCHE Claude's avatar
MARCHE Claude committed
294

Sylvain Dailler's avatar
Sylvain Dailler committed
295 296 297
let prover_tasks_in_progress :
    (Call_provers.prover_call,tasks_prog_rec) Hashtbl.t =
  Hashtbl.create 17
298 299 300 301 302

(* We need to separate tasks that are edited from proofattempt in progress
   because we are not using why3server for the edited proofs and timeout_handler
   rely on a loop on why3server's results. *)
let prover_tasks_edited = Queue.create ()
MARCHE Claude's avatar
MARCHE Claude committed
303 304 305

let timeout_handler_running = ref false

306

MARCHE Claude's avatar
MARCHE Claude committed
307
let number_of_running_provers = ref 0
308

309 310 311 312
let observer = ref (fun _ _ _ -> ())

let register_observer = (:=) observer

313
module Hprover = Whyconf.Hprover
MARCHE Claude's avatar
MARCHE Claude committed
314

Sylvain Dailler's avatar
Sylvain Dailler committed
315
(* calling provers, with limits adaptation *)
316 317 318 319 320 321 322 323 324 325


(* 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 ~interactive ~use_steps limits a =
  let t, m, s =
    let timelimit = limits.Call_provers.limit_time in
    let memlimit = limits.Call_provers.limit_mem in
326
    let steplimit = limits.Call_provers.limit_steps in
327 328 329 330 331 332 333
    match a.proof_state with
    | Some { Call_provers.pr_answer = r;
             Call_provers.pr_time = t;
             Call_provers.pr_steps = s } ->
       (* 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 *)
334
       let t = truncate (1.5 +. 2.0 *. t) in
335
       let increased_time = if interactive then 0
336 337 338 339 340
                            else max timelimit (min t (2 * timelimit)) in
       (* increased mem limit is just 1.5 times the previous mem limit *)
       let increased_mem = if interactive then 0 else 3 * memlimit / 2 in
       begin
         match r with
341 342
         | Call_provers.OutOfMemory -> increased_time, memlimit, steplimit
         | Call_provers.Timeout -> timelimit, increased_mem, steplimit
343 344
         | Call_provers.Valid ->
            let steplimit =
345 346 347 348 349 350 351 352 353
              if use_steps && not a.proof_obsolete then
                (* We need to allow at least one more step than what was used to
                   prove the same statement. Otherwise, the prover run out of
                   steps: this happens with cvc4 on some very fast proofs
                   (steps = 28).
                *)
                s + 1
              else
                0
354 355 356 357
            in
            increased_time, increased_mem, steplimit
         | Call_provers.Unknown _
         | Call_provers.StepLimitExceeded
358
         | Call_provers.Invalid -> increased_time, increased_mem, steplimit
359 360 361
         | Call_provers.Failure _
         | Call_provers.HighFailure ->
            (* correct ? failures are supposed to appear quickly anyway... *)
362
            timelimit, memlimit, steplimit
363 364
       end
    | None when interactive -> 0, 0, 0
365
    | None -> timelimit, memlimit, steplimit
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
  in
  { Call_provers.limit_time = t; limit_mem = m; limit_steps = s }

let group_answer a =
  match a with
  | Call_provers.OutOfMemory
  | Call_provers.Unknown _
  | Call_provers.Timeout -> Call_provers.Timeout
  | _ -> a

let fuzzy_proof_time nres ores =
  let ansold = ores.Call_provers.pr_answer in
  let told = ores.Call_provers.pr_time in
  let ansnew = nres.Call_provers.pr_answer in
  let tnew = nres.Call_provers.pr_time in
381
  if ansnew <> Call_provers.Timeout && group_answer ansold = group_answer ansnew &&
382 383 384 385 386
       tnew >= told *. 0.9 -. 0.1 && tnew <= told *. 1.1 +. 0.1
  then { nres with Call_provers.pr_time = told }
  else nres


Sylvain Dailler's avatar
Sylvain Dailler committed
387 388 389 390 391 392
let build_prover_call spa =
  let c = spa.spa_contr in
  let limit = spa.spa_limit in
  let (config_pr,driver) = Hprover.find c.controller_provers spa.spa_pr in
  let with_steps =
    Call_provers.(limit.limit_steps <> empty_limit.limit_steps) in
393
  let command =
394
    Whyconf.get_complete_command config_pr ~with_steps in
395
  try
Sylvain Dailler's avatar
Sylvain Dailler committed
396
    let task = Session_itp.get_task c.controller_session spa.spa_id in
397
    Debug.dprintf debug_sched "[build_prover_call] Script file = %a@."
Sylvain Dailler's avatar
Sylvain Dailler committed
398
                  (Pp.print_option Pp.string) spa.spa_pr_scr;
399
    let inplace = config_pr.Whyconf.in_place in
400
    let interactive = config_pr.Whyconf.interactive in
401 402
    try
      let call =
Sylvain Dailler's avatar
Sylvain Dailler committed
403 404
        Driver.prove_task ?old:spa.spa_pr_scr ~inplace ~command
                        ~limit ~interactive driver task
405
      in
Sylvain Dailler's avatar
Sylvain Dailler committed
406 407 408 409 410 411 412 413
      let pa =
        { tp_session  = c.controller_session;
          tp_id       = spa.spa_id;
          tp_pr       = spa.spa_pr;
          tp_callback = spa.spa_callback;
          tp_started  = false;
          tp_call     = call;
          tp_ores     = spa.spa_ores } in
414 415
      Hashtbl.replace prover_tasks_in_progress call pa
    with Sys_error _ as e ->
Sylvain Dailler's avatar
Sylvain Dailler committed
416
      spa.spa_callback (InternalFailure e)
417
  with Not_found (* goal has no task, it is detached *) ->
Sylvain Dailler's avatar
Sylvain Dailler committed
418
       spa.spa_callback Detached
MARCHE Claude's avatar
MARCHE Claude committed
419

420 421
let update_observer () =
  let scheduled = Queue.length scheduled_proof_attempts in
422
  let waiting_or_running = Hashtbl.length prover_tasks_in_progress in
423 424 425
  let running = !number_of_running_provers in
  !observer scheduled (waiting_or_running - running) running

MARCHE Claude's avatar
MARCHE Claude committed
426 427
let timeout_handler () =
  (* examine all the prover tasks in progress *)
428 429 430
  (* When no tasks are there, probably no tasks were scheduled and the server
     was not launched so getting results could fail. *)
  if Hashtbl.length prover_tasks_in_progress != 0 then begin
431
    let results = Call_provers.get_new_results ~blocking:S.blocking in
432 433
    List.iter (fun (call, prover_update) ->
      match Hashtbl.find prover_tasks_in_progress call with
Sylvain Dailler's avatar
Sylvain Dailler committed
434
      | ptp ->
435
        begin match prover_update with
436 437
        | Call_provers.NoUpdates -> ()
        | Call_provers.ProverStarted ->
Sylvain Dailler's avatar
Sylvain Dailler committed
438 439
            assert (not ptp.tp_started);
            ptp.tp_callback Running;
440
            incr number_of_running_provers;
Sylvain Dailler's avatar
Sylvain Dailler committed
441 442
            Hashtbl.replace prover_tasks_in_progress ptp.tp_call
              {ptp with tp_started = true}
443
        | Call_provers.ProverFinished res ->
Sylvain Dailler's avatar
Sylvain Dailler committed
444 445 446
            Hashtbl.remove prover_tasks_in_progress ptp.tp_call;
            if ptp.tp_started then decr number_of_running_provers;
            let res = Opt.fold fuzzy_proof_time res ptp.tp_ores in
447
            (* inform the callback *)
Sylvain Dailler's avatar
Sylvain Dailler committed
448
            ptp.tp_callback (Done res)
449
        | Call_provers.ProverInterrupted ->
Sylvain Dailler's avatar
Sylvain Dailler committed
450 451
            Hashtbl.remove prover_tasks_in_progress ptp.tp_call;
            if ptp.tp_started then decr number_of_running_provers;
452
            (* inform the callback *)
Sylvain Dailler's avatar
Sylvain Dailler committed
453
            ptp.tp_callback (Interrupted)
454
        | Call_provers.InternalFailure exn ->
Sylvain Dailler's avatar
Sylvain Dailler committed
455 456
            Hashtbl.remove prover_tasks_in_progress ptp.tp_call;
            if ptp.tp_started then decr number_of_running_provers;
457
            (* inform the callback *)
Sylvain Dailler's avatar
Sylvain Dailler committed
458
            ptp.tp_callback (InternalFailure (exn))
459 460 461 462 463 464
        end
      | exception Not_found -> ()
        (* We probably received ProverStarted after ProverFinished,
           because what is sent to and received from the server is
           not ordered. *)
    ) results;
465 466
  end;

467 468 469 470 471 472 473
  (* When blocking is activated, we are in script mode and we don't want editors
     to be launched so we don't need to go in this loop. *)
  if not S.blocking then begin
    (* Check for editor calls which are not finished *)
    let q = Queue.create () in
    while not (Queue.is_empty prover_tasks_edited) do
      (* call is an EditorCall *)
474
      let (callback,call,ores) as c =
475 476 477 478
        Queue.pop prover_tasks_edited in
      let prover_update = Call_provers.query_call call in
      match prover_update with
      | Call_provers.NoUpdates -> Queue.add c q
479
      | Call_provers.ProverFinished res ->
480 481
          (* res is meaningless for edition, we returned the old result *)
          (* inform the callback *)
482
          callback (match ores with None -> Done res | Some r -> Done r)
483 484 485 486
      | _ -> assert (false) (* An edition can only return Noupdates or finished *)
    done;
    Queue.transfer q prover_tasks_edited;
  end;
487 488

  (* if the number of prover tasks is less than S.multiplier times the maximum
MARCHE Claude's avatar
MARCHE Claude committed
489 490
     number of running provers, then we heuristically decide to add
     more tasks *)
491 492
  begin
    try
493
      for _i = Hashtbl.length prover_tasks_in_progress
494
          to S.multiplier * !session_max_tasks do
Sylvain Dailler's avatar
Sylvain Dailler committed
495 496
        let spa = Queue.pop scheduled_proof_attempts in
        try build_prover_call spa
497
        with e when not (Debug.test_flag Debug.stack_trace) ->
Sylvain Dailler's avatar
Sylvain Dailler committed
498
          spa.spa_callback (InternalFailure e)
499 500 501
      done
  with Queue.Empty -> ()
  end;
502
  update_observer ();
503
  true
MARCHE Claude's avatar
MARCHE Claude committed
504

505
let interrupt () =
506
  (* Interrupt provers *)
MARCHE Claude's avatar
MARCHE Claude committed
507 508 509 510
  Hashtbl.iter
    (fun call e ->
     Call_provers.interrupt_call call;
     e.tp_callback Interrupted)
511 512 513 514
    prover_tasks_in_progress;
  Hashtbl.clear prover_tasks_in_progress;
  (* Do not interrupt editors
  while not (Queue.is_empty prover_tasks_edited) do
515
    let (_ses,_id,_pr,callback,_started,_call,_ores) =
516
      Queue.pop prover_tasks_edited in
517 518
    callback Interrupted
  done;
519
  *)
520 521
  number_of_running_provers := 0;
  while not (Queue.is_empty scheduled_proof_attempts) do
Sylvain Dailler's avatar
Sylvain Dailler committed
522 523
    let spa = Queue.pop scheduled_proof_attempts in
    spa.spa_callback Interrupted
524 525 526
  done;
  !observer 0 0 0

MARCHE Claude's avatar
MARCHE Claude committed
527 528 529 530
let run_timeout_handler () =
  if not !timeout_handler_running then
    begin
      timeout_handler_running := true;
531
      S.timeout ~ms:default_delay_ms timeout_handler;
MARCHE Claude's avatar
MARCHE Claude committed
532 533
    end

534
let schedule_proof_attempt c id pr ?save_to ~limit ~callback ~notification =
535 536
  let ses = c.controller_session in
  let callback panid s =
537 538
    begin
      match s with
539
      | UpgradeProver _ | Removed _ -> ()
540 541 542 543 544 545 546 547
      | Scheduled ->
         Hpan.add c.controller_running_proof_attempts panid ();
         update_goal_node notification ses id
      | Running -> update_goal_node notification ses id
      | Done res ->
         Hpan.remove c.controller_running_proof_attempts panid;
         update_proof_attempt ~obsolete:false notification ses id pr res;
         update_goal_node notification ses id
548 549
      | Interrupted
      | InternalFailure _ ->
550 551 552 553 554
         Hpan.remove c.controller_running_proof_attempts panid;
         (* what to do ?
         update_proof_attempt ~obsolete:false notification ses id pr res;
          *)
         update_goal_node notification ses id
555 556
      | Detached -> assert false
      | Uninstalled _ -> assert false
557
      | Undone -> assert false
558
    end;
559 560 561
    callback panid s
  in
  let adaptlimit,ores,proof_script =
562
    try
563
      let h = get_proof_attempt_ids ses id in
564
      let pa = Hprover.find h pr in
565
      let a = get_proof_attempt_node ses pa in
566 567 568 569 570
      let old_res = a.proof_state in
      let config_pr,_ = Hprover.find c.controller_provers pr in
      let interactive = config_pr.Whyconf.interactive in
      let use_steps = Call_provers.(limit.limit_steps <> empty_limit.limit_steps) in
      let limit = adapt_limits ~interactive ~use_steps limit a in
571 572 573
      let script =
        if save_to = None then
          Opt.map (fun s ->
574 575
                            Debug.dprintf debug_sched "Script file = %s@." s;
                            Filename.concat (get_dir ses) s) a.proof_script
576 577
        else
          save_to
578 579
      in
      limit, old_res, script
580
    with Not_found | Session_itp.BadID -> limit,None,save_to
581
  in
582
  let panid = graft_proof_attempt ~limit ses id pr in
Sylvain Dailler's avatar
Sylvain Dailler committed
583 584 585 586 587 588 589 590 591
  let spa =
    { spa_contr    = c;
      spa_id       = id;
      spa_pr       = pr;
      spa_limit    = adaptlimit;
      spa_pr_scr   = proof_script;
      spa_callback = callback panid;
      spa_ores     = ores } in
  Queue.add spa scheduled_proof_attempts;
592
  callback panid Scheduled;
MARCHE Claude's avatar
MARCHE Claude committed
593
  run_timeout_handler ()
Clément Fumex's avatar
Clément Fumex committed
594

595

596 597


598 599
(*** { 2 edition of proof scripts} *)

Sylvain Dailler's avatar
Sylvain Dailler committed
600 601 602
(* create the path to a file for saving the external proof script *)
let create_file_rel_path c pr pn =
  let session = c.controller_session in
603
  let driver = snd (Hprover.find c.controller_provers pr) in
604
  let task = Session_itp.get_task session pn in
Sylvain Dailler's avatar
Sylvain Dailler committed
605 606 607 608
  let session_dir = Session_itp.get_dir session in
  let th = get_encapsulating_theory session (APn pn) in
  let th_name = (Session_itp.theory_name th).Ident.id_string in
  let f = get_encapsulating_file session (ATh th) in
609
  let fn = Filename.chop_extension (Session_itp.basename (file_path f)) in
Sylvain Dailler's avatar
Sylvain Dailler committed
610 611 612 613
  let file = Driver.file_of_task driver fn th_name task in
  let file = Filename.concat session_dir file in
  let file = Sysutil.uniquify file in
  let file = Sysutil.relativize_filename session_dir file in
614 615 616
  match file with
  | [f] -> f
  | _ -> assert false
Sylvain Dailler's avatar
Sylvain Dailler committed
617

618
let prepare_edition c ?file pn pr ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
619
  let session = c.controller_session in
620 621 622
  let proof_attempts_id = get_proof_attempt_ids session pn in
  let panid =
    try
623 624 625 626 627 628 629 630 631 632 633 634 635 636
      let panid = Hprover.find proof_attempts_id pr in
      (* if no proof script yet, we need to add one
         it happens e.g when editing a file for an automatic prover
       *)
      let pa = get_proof_attempt_node session panid in
      match pa.proof_script with
      | None ->
         let file = match file with
           | Some f -> f
           | None -> create_file_rel_path c pr pn
         in
         set_proof_script pa file;
         panid
      | Some _ -> panid
637
    with Not_found ->
638 639 640 641
      let file = match file with
        | Some f -> f
        | None -> create_file_rel_path c pr pn
      in
642 643
      let limit = Call_provers.empty_limit in
      graft_proof_attempt session pn pr ~file ~limit
Sylvain Dailler's avatar
Sylvain Dailler committed
644
  in
645
  update_goal_node notification session pn;
646 647
  let pa = get_proof_attempt_node session panid in
  let file = Opt.get pa.proof_script in
648
  let old_res = pa.proof_state in
649
  let session_dir = Session_itp.get_dir session in
Sylvain Dailler's avatar
Sylvain Dailler committed
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
  let file = Filename.concat session_dir file in
  let old =
    if Sys.file_exists file
    then
      begin
        let backup = file ^ ".bak" in
        if Sys.file_exists backup
        then Sys.remove backup;
        Sys.rename file backup;
        Some(open_in backup)
      end
    else None
  in
  let ch = open_out file in
  let fmt = formatter_of_out_channel ch in
665
  let task = Session_itp.get_task session pn in
666
  let driver = snd (Hprover.find c.controller_provers pr) in
667
  Driver.print_task ?old driver fmt task;
Sylvain Dailler's avatar
Sylvain Dailler committed
668 669
  Opt.iter close_in old;
  close_out ch;
670
  panid,file,old_res
Sylvain Dailler's avatar
Sylvain Dailler committed
671 672 673

exception Editor_not_found

674
let schedule_edition c id pr ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
675 676 677 678
  Debug.dprintf debug_sched "[Sched] Scheduling an edition@.";
  let config = c.controller_config in
  let session = c.controller_session in
  let prover_conf = Whyconf.get_prover_config config pr in
679
  (* Make sure editor exists. Fails otherwise *)
Sylvain Dailler's avatar
Sylvain Dailler committed
680 681
  let editor =
    match prover_conf.Whyconf.editor with
682
    | "" -> Whyconf.(default_editor (get_main config))
Sylvain Dailler's avatar
Sylvain Dailler committed
683
    | s ->
684 685 686 687 688
       try
         let ed = Whyconf.editor_by_id config s in
         String.concat " " (ed.Whyconf.editor_command ::
                              ed.Whyconf.editor_options)
       with Not_found -> raise Editor_not_found
Sylvain Dailler's avatar
Sylvain Dailler committed
689
  in
690
  let panid,file,old_res = prepare_edition c id pr ~notification in
691
  (* Notification node *)
692 693 694
  let callback panid s =
    begin
      match s with
695
      | UpgradeProver _ -> ()
696
      | Running -> ()
697 698
      | Done res ->
         (* set obsolete to true since we do not know if the manual
699
            proof was completed or not *)
700 701 702 703 704
         Debug.dprintf debug_sched
                       "Setting status of %a under parent %a to obsolete@."
                       print_proofAttemptID panid print_proofNodeID id;
         update_proof_attempt ~obsolete:true notification session id pr res;
         update_goal_node notification session id
705 706 707
      | Interrupted
      | InternalFailure _ ->
         update_goal_node notification session id
708
      | Undone | Detached | Uninstalled _ | Scheduled | Removed _ -> assert false
709 710
    end;
    callback panid s
711
  in
Sylvain Dailler's avatar
Sylvain Dailler committed
712
  Debug.dprintf debug_sched "[Editing] goal %s with command '%s' on file %s@."
713 714
                (Session_itp.get_proof_name session id).Ident.id_string
                editor file;
715 716
  let call = Call_provers.call_editor ~command:editor file in
  callback panid Running;
717
  Queue.add (callback panid,call,old_res) prover_tasks_edited;
718
  run_timeout_handler ()
719

720
exception TransAlreadyExists of string * string
721
exception GoalNodeDetached of proofNodeID
722

723 724
(*** { 2 transformations} *)

725 726 727 728 729
let schedule_transformation c id name args ~callback ~notification =
  let callback s =
    begin match s with
          | TSdone tid -> update_trans_node notification c.controller_session tid
          | TSscheduled
Sylvain Dailler's avatar
Sylvain Dailler committed
730
          | TSfailed _ | TSfatal _  -> ()
731 732 733
    end;
    callback s
  in
734
  let apply_trans () =
735 736
    begin
      try
737 738 739
        let subtasks =
          apply_trans_to_goal ~allow_no_effect:false
                              c.controller_session c.controller_env name args id
740
        in
741 742 743
        let tid = graft_transf c.controller_session id name args subtasks in
        callback (TSdone tid)
      with
744
      | NoProgress ->
745 746 747
          (* if result is same as input task, consider it as a failure *)
          callback (TSfailed (id, NoProgress))
      | e when not (is_fatal e) ->
Sylvain Dailler's avatar
Sylvain Dailler committed
748
          callback (TSfailed (id, e))
749
      | e when not (Debug.test_flag Debug.stack_trace) ->
750
          (* "@[Exception raised in Session_itp.apply_trans_to_goal %s:@ %a@.@]"
751
          name Exn_printer.exn_printer e; TODO *)
752
          callback (TSfatal (id, e))
753 754
    end;
    false
755
  in
756 757
  if Session_itp.is_detached c.controller_session (APn id) then
    raise (GoalNodeDetached id);
758 759
  if Session_itp.check_if_already_exists c.controller_session id name args then
    raise (TransAlreadyExists (name, List.fold_left (fun acc s -> s ^ " " ^ acc) "" args));
760 761
  S.idle ~prio:0 apply_trans;
  callback TSscheduled
Clément Fumex's avatar
Clément Fumex committed
762

763 764 765

open Strategy

Sylvain Dailler's avatar
Sylvain Dailler committed
766
let run_strategy_on_goal
767
    c id strat ~callback_pa ~callback_tr ~callback ~notification =
768 769 770 771 772 773
  let rec exec_strategy pc strat g =
    if pc < 0 || pc >= Array.length strat then
      callback STShalt
    else
      match Array.get strat pc with
      | Icall_prover(p,timelimit,memlimit) ->
MARCHE Claude's avatar
MARCHE Claude committed
774 775
         let callback panid res =
           callback_pa panid res;
776
           match res with
777
           | UpgradeProver _ | Scheduled | Running -> (* nothing to do yet *) ()
778 779 780
           | Done { Call_provers.pr_answer = Call_provers.Valid } ->
              (* proof succeeded, nothing more to do *)
              callback STShalt
781 782
           | Interrupted | InternalFailure _ ->
              callback STShalt
783 784 785 786 787
           | Done _ ->
              (* proof did not succeed, goto to next step *)
              callback (STSgoto (g,pc+1));
              let run_next () = exec_strategy (pc+1) strat g; false in
              S.idle ~prio:0 run_next
788
           | Undone | Detached | Uninstalled _ | Removed _ ->
789 790 791 792 793 794
                         (* should not happen *)
                         assert false
         in
         let limit = { Call_provers.empty_limit with
                       Call_provers.limit_time = timelimit;
                       limit_mem  = memlimit} in
795
         schedule_proof_attempt c g p ?save_to:None ~limit ~callback ~notification
796 797
      | Itransform(trname,pcsuccess) ->
         let callback ntr =
798
           callback_tr trname [] ntr;
799
           match ntr with
Sylvain Dailler's avatar
Sylvain Dailler committed
800 801
           | TSfatal (id, e) ->
               callback (STSfatal (trname, id, e))
802
           | TSfailed _e -> (* transformation failed *)
803 804 805 806 807 808 809 810 811 812 813 814
              callback (STSgoto (g,pc+1));
              let run_next () = exec_strategy (pc+1) strat g; false in
              S.idle ~prio:0 run_next
           | TSscheduled -> ()
           | TSdone tid ->
              List.iter
                (fun g ->
                 callback (STSgoto (g,pcsuccess));
                 let run_next () =
                   exec_strategy pcsuccess strat g; false
                 in
                 S.idle ~prio:0 run_next)
MARCHE Claude's avatar
MARCHE Claude committed
815
                (get_sub_tasks c.controller_session tid)
816
         in
817
         schedule_transformation c g trname [] ~callback ~notification
818 819 820 821 822 823
      | Igoto pc ->
         callback (STSgoto (g,pc));
         exec_strategy pc strat g
  in
  exec_strategy 0 strat id

Sylvain Dailler's avatar
Sylvain Dailler committed
824 825
let schedule_pa_with_same_arguments
    c (pa: proof_attempt_node) (pn: proofNodeID) ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
826 827 828 829
  let prover = pa.prover in
  let limit = pa.limit in
  schedule_proof_attempt c pn prover ~limit ~callback ~notification

Sylvain Dailler's avatar
Sylvain Dailler committed
830 831
let schedule_tr_with_same_arguments
    c (tr: transID) (pn: proofNodeID) ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
832 833 834
  let s = c.controller_session in
  let args = get_transf_args s tr in
  let name = get_transf_name s tr in
835
  let callback = callback name args in
836

Sylvain Dailler's avatar
Sylvain Dailler committed
837 838
  schedule_transformation c pn name args ~callback ~notification

MARCHE Claude's avatar
MARCHE Claude committed
839 840 841 842 843
let proof_is_complete pa =
  match pa.Session_itp.proof_state with
  | None -> false
  | Some pr ->
     not pa.Session_itp.proof_obsolete &&
844
       Call_provers.(pr.pr_answer = Valid)
MARCHE Claude's avatar
MARCHE Claude committed
845

846

Sylvain Dailler's avatar
Sylvain Dailler committed
847
let clean c ~removed nid =
848

849
  (* clean should not change proved status *)
850 851 852
  let notification any =
    Format.eprintf "Cleaning error: cleaning attempts to change status of node %a@." fprintf_any any
  in
853
  let s = c.controller_session in
854
  (* This function is applied on leafs first for the case of removes *)
855
  let clean_aux () any =
856 857 858 859 860 861
    let do_remove =
      Session_itp.is_detached s any ||
      match any with
      | APa pa ->
         let pa = Session_itp.get_proof_attempt_node s pa in
         pn_proved s pa.parent && not (proof_is_complete pa)
862
      | ATn tn ->
863 864 865 866 867 868
         let pn = get_trans_parent s tn in
         pn_proved s pn && not (tn_proved s tn)
      | _ -> false
    in
    if do_remove then
      remove_subtree ~notification ~removed c any
869 870 871 872 873 874 875
  in

  match nid with
  | Some nid ->
      Session_itp.fold_all_any s clean_aux () nid
  | None ->
      Session_itp.fold_all_session s clean_aux ()
876

877 878
(* This function folds on any subelements of given node and tries to mark all
   proof attempts it encounters *)
879
let mark_as_obsolete ~notification c any =
880
  let s = c.controller_session in
881
  (* Case for proof attempt only *)
882
  let mark_as_obsolete_pa n =
883 884
    let parent = get_proof_attempt_parent s n in
    Session_itp.mark_obsolete s n;
885
    notification (APa n);
886
    update_goal_node notification s parent
887
  in
888 889 890 891 892 893 894 895 896 897
  match any with
  | Some any ->
      fold_all_any s
        (fun () any -> match any with
        | APa n -> mark_as_obsolete_pa n
        | _ -> ()) () any
  | None ->
      session_iter_proof_attempt
        (fun pa _pan ->
          mark_as_obsolete_pa pa) s
898

Sylvain Dailler's avatar
Sylvain Dailler committed
899 900 901
exception BadCopyPaste

(* Reproduce the transformation made on node on an other one *)
902
let rec copy_rec ~notification ~callback_pa ~callback_tr c from_any to_any =
Sylvain Dailler's avatar
Sylvain Dailler committed
903
  let s = c.controller_session in
904 905
  match from_any, to_any with
(*
Sylvain Dailler's avatar
Sylvain Dailler committed
906 907 908 909
    | AFile _, AFile _ ->
        raise BadCopyPaste
    | ATh _from_th, ATh _to_th ->
        raise BadCopyPaste
910
 *)
Sylvain Dailler's avatar
Sylvain Dailler committed
911 912
    | APn from_pn, APn to_pn ->
      let from_pa_list = get_proof_attempts s from_pn in
913
      List.iter (fun x -> schedule_pa_with_same_arguments ?save_to:None c x to_pn
Sylvain Dailler's avatar
Sylvain Dailler committed
914 915
          ~callback:callback_pa ~notification) from_pa_list;
      let from_tr_list = get_transformations s from_pn in
916
      let callback x tr args st = callback_tr tr args st;
Sylvain Dailler's avatar
Sylvain Dailler committed
917
        match st with
Sylvain Dailler's avatar
Sylvain Dailler committed
918
        | TSdone tid ->
919
          copy_rec c (ATn x) (ATn tid) ~notification ~callback_pa ~callback_tr
Sylvain Dailler's avatar
Sylvain Dailler committed
920 921 922 923 924 925 926
        | _ -> ()
      in
      List.iter (fun x -> schedule_tr_with_same_arguments c x to_pn
          ~callback:(callback x) ~notification) from_tr_list
    | ATn from_tn, ATn to_tn ->
        let from_tn_list = get_sub_tasks s from_tn in
        let to_tn_list = get_sub_tasks s to_tn in
927 928 929 930 931 932 933 934
        let rec iter_copy l1 l2 =
          match l1,l2 with
          | x::r1, y::r2 ->
             copy_rec c (APn x) (APn y)
                      ~notification ~callback_pa ~callback_tr;
             iter_copy r1 r2
          | _ -> ()
        in iter_copy from_tn_list to_tn_list
Sylvain Dailler's avatar
Sylvain Dailler committed
935 936 937
    | _ -> raise BadCopyPaste


938 939
let copy_paste ~notification ~callback_pa ~callback_tr c from_any to_any =
  let s = c.controller_session in
940 941
  if is_below s to_any from_any then
    raise BadCopyPaste;
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
  match from_any, to_any with
  | APn _, APn _ ->
     copy_rec ~notification ~callback_pa ~callback_tr c from_any to_any
  | ATn from_tn, APn to_pn ->
     let callback tr args st =
       callback_tr tr args st;
       match st with
       | TSdone tid ->
          copy_rec c (ATn from_tn) (ATn tid) ~notification ~callback_pa ~callback_tr
       | _ -> ()
     in
     schedule_tr_with_same_arguments c from_tn to_pn ~callback ~notification
  | _ -> raise BadCopyPaste



MARCHE Claude's avatar
MARCHE Claude committed
958 959 960 961 962 963 964 965





(***************** {2 replay} ****************)


966
let debug_replay = Debug.register_flag "replay" ~desc:"Debug@ info@ for@ replay"
MARCHE Claude's avatar
MARCHE Claude committed
967

968
let find_prover notification c goal_id pr =
969
  if Hprover.mem c.controller_provers pr then `Found pr else
970
   match Whyconf.get_prover_upgrade_policy c.controller_config pr with
971 972
   | exception Not_found -> `Keep
   | Whyconf.CPU_keep -> `Keep
973
   | Whyconf.CPU_remove -> `Remove
974 975 976
   | Whyconf.CPU_upgrade new_pr ->
      (* does a proof using new_pr already exists ? *)
      if Hprover.mem (get_proof_attempt_ids c.controller_session goal_id) new_pr
977
      then (* yes, then we remove the attempt *)
978
        `Remove
979 980 981 982
      else
        begin
          (* we modify the prover in-place *)
          Session_itp.change_prover notification c.controller_session goal_id pr new_pr;
983
          `Found new_pr
984
        end
985 986 987
   | Whyconf.CPU_duplicate new_pr ->
      (* does a proof using new_pr already exists ? *)
      if Hprover.mem (get_proof_attempt_ids c.controller_session goal_id) new_pr
988
      then (* yes, then we do nothing *)
989
        `Keep
990 991
      else
        begin
992 993
          (* we duplicate the proof attempt *)
          `Found new_pr
994
        end
995

996 997 998 999 1000

let replay_proof_attempt c pr limit (parid: proofNodeID) id ~callback ~notification =
  (* The replay can be done on a different machine so we need
     to check more things before giving the attempt to the scheduler *)
  match find_prover notification c parid pr with
1001 1002
  | `Keep -> callback id (Uninstalled pr)
  | `Remove ->
1003 1004 1005
     (* it is necessary to call the callback before effectively removing the node, otherwise, a bad id will be used in the callback *)
      callback id (Removed pr);
      remove_proof_attempt c.controller_session parid pr
1006
  | `Found pr' ->
1007 1008
     try
       if pr' <> pr then callback id (UpgradeProver pr');
1009
       let _ = get_task c.controller_session parid in
1010
       schedule_proof_attempt ?save_to:None c parid pr' ~limit ~callback ~notification
1011 1012 1013 1014 1015
     with Not_found ->
       callback id Detached



1016 1017 1018 1019
type report =
  | Result of Call_provers.prover_result * Call_provers.prover_result
  (** Result(new_result,old_result) *)
  | CallFailed of exn
1020
  | Replay_interrupted
1021 1022 1023 1024 1025 1026 1027 1028 1029
  | Prover_not_installed
  | Edited_file_absent of string
  | No_former_result of Call_provers.prover_result

(* TODO find a better way to print it *)
let print_report fmt (r: report) =
  match r with
  | Result (new_r, old_r) ->
    Format.fprintf fmt "new_result = %a, old_result = %a@."
1030 1031
      (Call_provers.print_prover_result ~json_model:false) new_r
      (Call_provers.print_prover_result ~json_model:false) old_r
1032 1033 1034 1035
  | CallFailed e ->
    Format.fprintf fmt "Callfailed %a@." Exn_printer.exn_printer e
  | Replay_interrupted ->
    Format.fprintf fmt "Interrupted@."
1036 1037 1038 1039 1040 1041
  | Prover_not_installed ->
    Format.fprintf fmt "Prover not installed@."
  | Edited_file_absent _ ->
    Format.fprintf fmt "No edited file@."
  | No_former_result new_r ->
    Format.fprintf fmt "new_result = %a, no former result@."
1042
      (Call_provers.print_prover_result ~json_model:false) new_r
1043 1044

(* TODO to be removed when we have a better way to print *)
1045
let replay_print fmt (lr: (proofNodeID * Whyconf.prover * Call_provers.resource_limit * report) list) =
1046 1047
  let pp_elem fmt (id, pr, rl, report) =
    fprintf fmt "ProofNodeID: %d, Prover: %a, Timelimit?: %d, Result: %a@."
Sylvain Dailler's avatar
Sylvain Dailler committed
1048 1049
      (Obj.magic id) Whyconf.print_prover pr
      rl.Call_provers.limit_time print_report report
1050
  in
1051
  Format.fprintf fmt "%a@." (Pp.print_list Pp.newline pp_elem) lr
1052

1053
let replay ~valid_only ~obsolete_only ?(use_steps=false) ?(filter=fun _ -> true)
Sylvain Dailler's avatar
Sylvain Dailler committed
1054