controller_itp.ml 47.6 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
open Session_itp
Sylvain Dailler's avatar
Sylvain Dailler committed
15 16
open Generic_arg_trans_utils
open Args_wrapper
Clément Fumex's avatar
Clément Fumex committed
17

Sylvain Dailler's avatar
Sylvain Dailler committed
18 19 20 21
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
22
let debug_call_prover = Debug.lookup_flag "call_prover"
23 24
let default_delay_ms = 100 (* 0.1 seconds *)

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

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

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

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

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

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


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

89 90 91 92 93
let session_max_tasks = ref 1

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

95 96 97
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
98 99 100
let load_drivers c =
  let env = c.controller_env in
  let config = c.controller_config in
101 102 103 104
  let provers = Whyconf.get_provers config in
  Whyconf.Mprover.iter
    (fun _ p ->
     try
105
       let d = Whyconf.load_driver (Whyconf.get_main config) env p.Whyconf.driver [] in
106 107
       Whyconf.Hprover.add c.controller_provers p.Whyconf.prover (p,d)
     with e ->
Sylvain Dailler's avatar
Sylvain Dailler committed
108
       Debug.dprintf debug_call_prover
109 110 111
         "[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
112 113 114 115 116 117 118 119 120
    provers

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

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

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

150 151 152
(* Get children of any without proofattempts *)
let get_undetached_children_no_pa s any : any list =
  match any with
153
  | AFile f -> List.map (fun th -> ATh th) (file_theories f)
154 155 156
  | 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
157
  | APa _ -> []
158

159 160


161 162 163 164 165 166 167 168 169 170
(* printing *)

module PSession = struct

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

  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
180
    | Session -> "", Hfile.fold (fun _ f -> n (File f)) (get_files s) []
181
    | File f ->
182
       string_of_file_path (file_path f),
183
       List.fold_right (fun th -> n (Theory th)) (file_theories f) []
184 185 186
    | Theory th ->
       let id = theory_name th in
       let name = id.Ident.id_string in
187
       let name = if th_proved s th then name^"!" else name^"?" in
188
       name,
Sylvain Dailler's avatar
Sylvain Dailler committed
189 190 191
       List.fold_right
         (fun g -> n (Goal g))
         (theory_goals th)
MARCHE Claude's avatar
MARCHE Claude committed
192
         []
193 194 195
    | Goal id ->
       let gid = get_proof_name s id in
       let name = gid.Ident.id_string in
196
       let name = if pn_proved s id then name^"!" else name^"?" in
197 198 199 200 201 202 203
       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
204 205 206 207 208
          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 ""), []
209 210
    | Transf id ->
       let name = get_transf_name s id in
211
       let name = if tn_proved s id then name^"!" else name^"?" in
212 213
       let sts = get_sub_tasks s id in
       name,
MARCHE Claude's avatar
MARCHE Claude committed
214
       List.fold_right (fun g -> n (Goal g)) sts []
215 216 217 218 219 220 221 222 223 224 225 226

end

module P = Print_tree.PMake(PSession)

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

(*********)



227 228 229 230 231 232

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

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

exception Errors_list of exn list

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

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

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

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

270 271
module Make(S : Scheduler) = struct

Sylvain Dailler's avatar
Sylvain Dailler committed
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
(* 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
296

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

(* 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
305 306 307

let timeout_handler_running = ref false

308

MARCHE Claude's avatar
MARCHE Claude committed
309
let number_of_running_provers = ref 0
310

311 312 313 314
let observer = ref (fun _ _ _ -> ())

let register_observer = (:=) observer

315
module Hprover = Whyconf.Hprover
MARCHE Claude's avatar
MARCHE Claude committed
316

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


(* 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
328
    let steplimit = limits.Call_provers.limit_steps in
329 330 331 332 333 334 335
    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 *)
336
       let t = truncate (1.5 +. 2.0 *. t) in
337
       let increased_time = if interactive then 0
338 339 340 341 342
                            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
343 344
         | Call_provers.OutOfMemory -> increased_time, memlimit, steplimit
         | Call_provers.Timeout -> timelimit, increased_mem, steplimit
345 346
         | Call_provers.Valid ->
            let steplimit =
347 348 349 350 351 352 353 354 355
              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
356 357 358 359
            in
            increased_time, increased_mem, steplimit
         | Call_provers.Unknown _
         | Call_provers.StepLimitExceeded
360
         | Call_provers.Invalid -> increased_time, increased_mem, steplimit
361 362 363
         | Call_provers.Failure _
         | Call_provers.HighFailure ->
            (* correct ? failures are supposed to appear quickly anyway... *)
364
            timelimit, memlimit, steplimit
365 366
       end
    | None when interactive -> 0, 0, 0
367
    | None -> timelimit, memlimit, steplimit
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
  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
383
  if ansnew <> Call_provers.Timeout && group_answer ansold = group_answer ansnew &&
384 385 386 387 388
       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
389 390 391 392 393 394
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
395
  let command =
396
    Whyconf.get_complete_command config_pr ~with_steps in
397
  try
Sylvain Dailler's avatar
Sylvain Dailler committed
398
    let task = Session_itp.get_task c.controller_session spa.spa_id in
399
    Debug.dprintf debug_sched "[build_prover_call] Script file = %a@."
Sylvain Dailler's avatar
Sylvain Dailler committed
400
                  (Pp.print_option Pp.string) spa.spa_pr_scr;
401
    let inplace = config_pr.Whyconf.in_place in
402
    let interactive = config_pr.Whyconf.interactive in
403 404
    try
      let call =
Sylvain Dailler's avatar
Sylvain Dailler committed
405 406
        Driver.prove_task ?old:spa.spa_pr_scr ~inplace ~command
                        ~limit ~interactive driver task
407
      in
Sylvain Dailler's avatar
Sylvain Dailler committed
408 409 410 411 412 413 414 415
      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
416 417
      Hashtbl.replace prover_tasks_in_progress call pa
    with Sys_error _ as e ->
Sylvain Dailler's avatar
Sylvain Dailler committed
418
      spa.spa_callback (InternalFailure e)
419
  with Not_found (* goal has no task, it is detached *) ->
Sylvain Dailler's avatar
Sylvain Dailler committed
420
       spa.spa_callback Detached
MARCHE Claude's avatar
MARCHE Claude committed
421

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

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

469 470 471 472 473 474 475
  (* 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 *)
476
      let (callback,call,ores) as c =
477 478 479 480
        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
481
      | Call_provers.ProverFinished res ->
482 483
          (* res is meaningless for edition, we returned the old result *)
          (* inform the callback *)
484
          callback (match ores with None -> Done res | Some r -> Done r)
485 486 487 488
      | _ -> assert (false) (* An edition can only return Noupdates or finished *)
    done;
    Queue.transfer q prover_tasks_edited;
  end;
489 490

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

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

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

536
let schedule_proof_attempt c id pr ?save_to ~limit ~callback ~notification =
537 538
  let ses = c.controller_session in
  let callback panid s =
539 540
    begin
      match s with
541
      | UpgradeProver _ | Removed _ -> ()
542 543 544 545 546 547 548 549
      | 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
550 551
      | Interrupted
      | InternalFailure _ ->
552 553 554 555 556
         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
557 558
      | Detached -> assert false
      | Uninstalled _ -> assert false
559
      | Undone -> assert false
560
    end;
561 562 563
    callback panid s
  in
  let adaptlimit,ores,proof_script =
564
    try
565
      let h = get_proof_attempt_ids ses id in
566
      let pa = Hprover.find h pr in
567
      let a = get_proof_attempt_node ses pa in
568 569 570 571 572
      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
573 574 575
      let script =
        if save_to = None then
          Opt.map (fun s ->
576 577
                            Debug.dprintf debug_sched "Script file = %s@." s;
                            Filename.concat (get_dir ses) s) a.proof_script
578 579
        else
          save_to
580 581
      in
      limit, old_res, script
582
    with Not_found | Session_itp.BadID -> limit,None,save_to
583
  in
584
  let panid = graft_proof_attempt ~limit ses id pr in
Sylvain Dailler's avatar
Sylvain Dailler committed
585 586 587 588 589 590 591 592 593
  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;
594
  callback panid Scheduled;
MARCHE Claude's avatar
MARCHE Claude committed
595
  run_timeout_handler ()
Clément Fumex's avatar
Clément Fumex committed
596

597

598 599


600 601
(*** { 2 edition of proof scripts} *)

Sylvain Dailler's avatar
Sylvain Dailler committed
602 603 604
(* 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
605
  let driver = snd (Hprover.find c.controller_provers pr) in
606
  let task = Session_itp.get_task session pn in
Sylvain Dailler's avatar
Sylvain Dailler committed
607 608 609 610
  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
611
  let fn = Filename.chop_extension (Session_itp.basename (file_path f)) in
Sylvain Dailler's avatar
Sylvain Dailler committed
612 613 614 615
  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
616 617 618
  match file with
  | [f] -> f
  | _ -> assert false
Sylvain Dailler's avatar
Sylvain Dailler committed
619

620
let prepare_edition c ?file pn pr ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
621
  let session = c.controller_session in
622 623 624
  let proof_attempts_id = get_proof_attempt_ids session pn in
  let panid =
    try
625 626 627 628 629 630 631 632 633 634 635 636 637 638
      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
639
    with Not_found ->
640 641 642 643
      let file = match file with
        | Some f -> f
        | None -> create_file_rel_path c pr pn
      in
644 645
      let limit = Call_provers.empty_limit in
      graft_proof_attempt session pn pr ~file ~limit
Sylvain Dailler's avatar
Sylvain Dailler committed
646
  in
647
  update_goal_node notification session pn;
648 649
  let pa = get_proof_attempt_node session panid in
  let file = Opt.get pa.proof_script in
650
  let old_res = pa.proof_state in
651
  let session_dir = Session_itp.get_dir session in
Sylvain Dailler's avatar
Sylvain Dailler committed
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
  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
667
  let task = Session_itp.get_task session pn in
668
  let driver = snd (Hprover.find c.controller_provers pr) in
669
  Driver.print_task ?old driver fmt task;
Sylvain Dailler's avatar
Sylvain Dailler committed
670 671
  Opt.iter close_in old;
  close_out ch;
672
  panid,file,old_res
Sylvain Dailler's avatar
Sylvain Dailler committed
673 674 675

exception Editor_not_found

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

722
exception TransAlreadyExists of string * string
723
exception GoalNodeDetached of proofNodeID
724

725 726
(*** { 2 transformations} *)

727 728 729 730 731
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
732
          | TSfailed _ | TSfatal _  -> ()
733 734 735
    end;
    callback s
  in
736
  let apply_trans () =
737 738
    begin
      try
739 740 741
        let subtasks =
          apply_trans_to_goal ~allow_no_effect:false
                              c.controller_session c.controller_env name args id
742
        in
743 744 745
        let tid = graft_transf c.controller_session id name args subtasks in
        callback (TSdone tid)
      with
746
      | NoProgress ->
747
         (* if result is same as input task, consider it as a failure *)
748
         callback (TSfailed (id, NoProgress))
749
      | (Arg_trans _ | Arg_trans_decl _ | Arg_trans_missing _
750
        | Arg_trans_term _ | Arg_trans_term2 _ | Arg_trans_term3 _
Sylvain Dailler's avatar
Sylvain Dailler committed
751 752 753 754
        | Arg_trans_pattern _ | Arg_trans_type _ | Arg_bad_hypothesis _
        | Cannot_infer_type _ | Unnecessary_terms _ | Parse_error _
        | Arg_expected _ | Arg_theory_not_found _ | Arg_expected_none _
        | Arg_qid_not_found _ | Arg_pr_not_found _ | Arg_error _
Sylvain Dailler's avatar
Sylvain Dailler committed
755
        | Arg_parse_type_error _ | Trans.Unnecessary_arguments _
756
        | Reflection.NoReification ) as e ->
Sylvain Dailler's avatar
Sylvain Dailler committed
757
          callback (TSfailed (id, e))
758
      | e when not (Debug.test_flag Debug.stack_trace) ->
759
          (* "@[Exception raised in Session_itp.apply_trans_to_goal %s:@ %a@.@]"
760
          name Exn_printer.exn_printer e; TODO *)
Sylvain Dailler's avatar
Sylvain Dailler committed
761
        callback (TSfatal (id, e))
762 763
    end;
    false
764
  in
765 766
  if Session_itp.is_detached c.controller_session (APn id) then
    raise (GoalNodeDetached id);
767 768
  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));
769 770
  S.idle ~prio:0 apply_trans;
  callback TSscheduled
Clément Fumex's avatar
Clément Fumex committed
771

772 773 774

open Strategy

Sylvain Dailler's avatar
Sylvain Dailler committed
775
let run_strategy_on_goal
776
    c id strat ~callback_pa ~callback_tr ~callback ~notification =
777 778 779 780 781 782
  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
783 784
         let callback panid res =
           callback_pa panid res;
785
           match res with
786
           | UpgradeProver _ | Scheduled | Running -> (* nothing to do yet *) ()
787 788 789
           | Done { Call_provers.pr_answer = Call_provers.Valid } ->
              (* proof succeeded, nothing more to do *)
              callback STShalt
790 791
           | Interrupted | InternalFailure _ ->
              callback STShalt
792 793 794 795 796
           | 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
797
           | Undone | Detached | Uninstalled _ | Removed _ ->
798 799 800 801 802 803
                         (* should not happen *)
                         assert false
         in
         let limit = { Call_provers.empty_limit with
                       Call_provers.limit_time = timelimit;
                       limit_mem  = memlimit} in
804
         schedule_proof_attempt c g p ?save_to:None ~limit ~callback ~notification
805 806
      | Itransform(trname,pcsuccess) ->
         let callback ntr =
807
           callback_tr trname [] ntr;
808
           match ntr with
Sylvain Dailler's avatar
Sylvain Dailler committed
809 810
           | TSfatal (id, e) ->
               callback (STSfatal (trname, id, e))
811
           | TSfailed _e -> (* transformation failed *)
812 813 814 815 816 817 818 819 820 821 822 823
              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
824
                (get_sub_tasks c.controller_session tid)
825
         in
826
         schedule_transformation c g trname [] ~callback ~notification
827 828 829 830 831 832
      | Igoto pc ->
         callback (STSgoto (g,pc));
         exec_strategy pc strat g
  in
  exec_strategy 0 strat id

Sylvain Dailler's avatar
Sylvain Dailler committed
833 834
let schedule_pa_with_same_arguments
    c (pa: proof_attempt_node) (pn: proofNodeID) ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
835 836 837 838
  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
839 840
let schedule_tr_with_same_arguments
    c (tr: transID) (pn: proofNodeID) ~callback ~notification =
Sylvain Dailler's avatar
Sylvain Dailler committed
841 842 843
  let s = c.controller_session in
  let args = get_transf_args s tr in
  let name = get_transf_name s tr in
844
  let callback = callback name args in
845

Sylvain Dailler's avatar
Sylvain Dailler committed
846 847
  schedule_transformation c pn name args ~callback ~notification

MARCHE Claude's avatar
MARCHE Claude committed
848 849 850 851 852
let proof_is_complete pa =
  match pa.Session_itp.proof_state with
  | None -> false
  | Some pr ->
     not pa.Session_itp.proof_obsolete &&
853
       Call_provers.(pr.pr_answer = Valid)
MARCHE Claude's avatar
MARCHE Claude committed
854

855

Sylvain Dailler's avatar
Sylvain Dailler committed
856
let clean c ~removed nid =
857

858
  (* clean should not change proved status *)
859 860 861
  let notification any =
    Format.eprintf "Cleaning error: cleaning attempts to change status of node %a@." fprintf_any any
  in
862
  let s = c.controller_session in
863
  (* This function is applied on leafs first for the case of removes *)
864
  let clean_aux () any =
865 866 867 868 869 870
    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)
871
      | ATn tn ->
872 873 874 875 876 877
         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
878 879 880 881 882 883 884
  in

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

886 887
(* This function folds on any subelements of given node and tries to mark all
   proof attempts it encounters *)
888
let mark_as_obsolete ~notification c any =
889
  let s = c.controller_session in
890
  (* Case for proof attempt only *)
891
  let mark_as_obsolete_pa n =
892 893
    let parent = get_proof_attempt_parent s n in
    Session_itp.mark_obsolete s n;
894
    notification (APa n);
895
    update_goal_node notification s parent
896
  in
897 898 899 900 901 902 903 904 905 906
  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
907

Sylvain Dailler's avatar
Sylvain Dailler committed
908 909 910
exception BadCopyPaste

(* Reproduce the transformation made on node on an other one *)
911
let rec copy_rec ~notification ~callback_pa ~callback_tr c from_any to_any =
Sylvain Dailler's avatar
Sylvain Dailler committed
912
  let s = c.controller_session in
913 914
  match from_any, to_any with
(*
Sylvain Dailler's avatar
Sylvain Dailler committed
915 916 917 918
    | AFile _, AFile _ ->
        raise BadCopyPaste
    | ATh _from_th, ATh _to_th ->
        raise BadCopyPaste
919
 *)
Sylvain Dailler's avatar
Sylvain Dailler committed
920 921
    | APn from_pn, APn to_pn ->
      let from_pa_list = get_proof_attempts s from_pn in
922
      List.iter (fun x -> schedule_pa_with_same_arguments ?save_to:None c x to_pn
Sylvain Dailler's avatar
Sylvain Dailler committed
923 924
          ~callback:callback_pa ~notification) from_pa_list;
      let from_tr_list = get_transformations s from_pn in
925
      let callback x tr args st = callback_tr tr args st;
Sylvain Dailler's avatar
Sylvain Dailler committed
926
        match st with
Sylvain Dailler's avatar
Sylvain Dailler committed
927
        | TSdone tid ->
928
          copy_rec c (ATn x) (ATn tid) ~notification ~callback_pa ~callback_tr
Sylvain Dailler's avatar
Sylvain Dailler committed
929 930 931 932 933 934 935
        | _ -> ()
      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
936 937 938 939 940 941 942 943
        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
944 945 946
    | _ -> raise BadCopyPaste


947 948
let copy_paste ~notification ~callback_pa ~callback_tr c from_any to_any =
  let s = c.controller_session in
949 950
  if is_below s to_any from_any then
    raise BadCopyPaste;
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
  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
967 968 969 970 971 972 973 974





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


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

977
let find_prover notification c goal_id pr =
978
  if Hprover.mem c.controller_provers pr then `Found pr else
979
   match Whyconf.get_prover_upgrade_policy c.controller_config pr with
980 981
   | exception Not_found -> `Keep
   | Whyconf.CPU_keep -> `Keep
982
   | Whyconf.CPU_remove -> `Remove
983 984 985
   | 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
986
      then (* yes, then we remove the attempt *)
987
        `Remove
988 989 990 991
      else
        begin
          (* we modify the prover in-place *)
          Session_itp.change_prover notification c.controller_session goal_id pr new_pr;
992
          `Found new_pr
993
        end
994 995 996
   | 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
997
      then (* yes, then we do nothing *)
998
        `Keep
999 1000
      else
        begin
1001 1002
          (* we duplicate the proof attempt *)
          `Found new_pr
1003
        end
1004

1005 1006 1007 1008 1009

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
1010 1011
  | `Keep -> callback id (Uninstalled pr)
  | `Remove ->
1012 1013 1014
     (* 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
1015
  | `Found pr' ->
1016 1017
     try
       if pr' <> pr then callback id (UpgradeProver pr');
1018
       let _ = get_task c.controller_session parid in
1019
       schedule_proof_attempt ?save_to:None c parid pr' ~limit ~callback ~notification
1020 1021 1022 1023 1024
     with Not_found ->
       callback id Detached



1025 1026 1027 1028
type report =
  | Result of Call_provers.prover_result * Call_provers.prover_result
  (** Result(new_result,old_result) *)
  | CallFailed of exn
1029
  | Replay_interrupted
1030 1031 1032 1033 1034 1035 1036 1037 1038
  | 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@."
1039 1040
      (Call_provers.print_prover_result ~json_model:false) new_r
      (Call_provers.print_prover_result ~json_model:false) old_r
1041 1042 1043 1044
  | CallFailed e ->
    Format.fprintf fmt "Callfailed %a@." Exn_printer.exn_printer e
  | Replay_interrupted ->
    Format.fprintf fmt "Interrupted@."
1045 1046 1047 1048 1049 1050
  | 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@."
1051
      (Call_provers.print_prover_result ~json_model:false) new_r
1052 1053

(* TODO to be removed when we have a better way to print *)