diff options
| author | Pierre-Marie Pédrot | 2014-04-25 19:46:30 +0200 |
|---|---|---|
| committer | Pierre-Marie Pédrot | 2014-04-25 21:17:11 +0200 |
| commit | 8330f5cfd6a332df10fc806b0c0bdab6e0abe8e7 (patch) | |
| tree | 56ab646154a576454a1ee34ad1cc0a8c6e7a70fe /stm/stm.ml | |
| parent | 9e36fa1e7460d256a4f9f37571764f79050688e2 (diff) | |
Adding a stm/ folder, as asked during last workgroup. It was essentially moving
files around. A bunch of files from lib/ that were only used in the STM were
moved, as well as part of toplevel/ related to the STM.
Diffstat (limited to 'stm/stm.ml')
| -rw-r--r-- | stm/stm.ml | 2075 |
1 files changed, 2075 insertions, 0 deletions
diff --git a/stm/stm.ml b/stm/stm.ml new file mode 100644 index 0000000000..e791e37cfc --- /dev/null +++ b/stm/stm.ml @@ -0,0 +1,2075 @@ +(************************************************************************) +(* v * The Coq Proof Assistant / The Coq Development Team *) +(* <O___,, * INRIA - CNRS - LIX - LRI - PPS - Copyright 1999-2013 *) +(* \VV/ **************************************************************) +(* // * This file is distributed under the terms of the *) +(* * GNU Lesser General Public License Version 2.1 *) +(************************************************************************) + +let process_id () = + match !Flags.async_proofs_mode with + | Flags.APoff | Flags.APonLazy | Flags.APonParallel 0 -> + "master" ^ string_of_int (Thread.id (Thread.self ())) + | Flags.APonParallel n -> "worker" ^ string_of_int n + +let pr_err s = Printf.eprintf "%s] %s\n" (process_id ()) s; flush stderr + +let prerr_endline s = if !Flags.debug then begin pr_err s end else () + +let (f_process_error, process_error_hook) = Hook.make () +let ((f_interp : (?verbosely:bool -> ?proof:Proof_global.closed_proof -> + Loc.t * Vernacexpr.vernac_expr -> unit) Hook.value), interp_hook) = Hook.make () + +open Vernacexpr +open Errors +open Pp +open Names +open Util +open Ppvernac +open Vernac_classifier + +(* During interactive use we cache more states so that Undoing is fast *) +let interactive () = + if !Flags.ide_slave || !Flags.print_emacs || not !Flags.batch_mode then `Yes + else `No + +let fallback_to_lazy_if_marshal_error = ref true +let fallback_to_lazy_if_slave_dies = ref true +let async_proofs_workers_extra_env = ref [||] + +type ast = { verbose : bool; loc : Loc.t; mutable expr : vernac_expr } +let pr_ast { expr } = pr_vernac expr + +(* Wrapper for Vernacentries.interp to set the feedback id *) +let vernac_interp ?proof id { verbose; loc; expr } = + let internal_command = function + | VernacResetName _ | VernacResetInitial | VernacBack _ + | VernacBackTo _ | VernacRestart | VernacUndo _ | VernacUndoTo _ + | VernacBacktrack _ | VernacAbortAll | VernacAbort _ -> true | _ -> false in + if internal_command expr then begin + prerr_endline ("ignoring " ^ string_of_ppcmds(pr_vernac expr)) + end else begin + Pp.set_id_for_feedback (Interface.State id); + Aux_file.record_in_aux_set_at loc; + prerr_endline ("interpreting " ^ string_of_ppcmds(pr_vernac expr)); + let interp = Hook.get f_interp in + try interp ~verbosely:verbose ?proof (loc, expr) + with e -> + let e = Errors.push e in + raise (Hook.get f_process_error e) + end + +(* Wrapper for Vernac.parse_sentence to set the feedback id *) +let vernac_parse eid s = + set_id_for_feedback (Interface.Edit eid); + let pa = Pcoq.Gram.parsable (Stream.of_string s) in + Flags.with_option Flags.we_are_parsing (fun () -> + match Pcoq.Gram.entry_parse Pcoq.main_entry pa with + | None -> raise (Invalid_argument "vernac_parse") + | Some ast -> ast) + () + +module Vcs_ = Vcs.Make(Stateid) +type future_proof = Entries.proof_output list Future.computation +type proof_mode = string +type depth = int +type cancel_switch = bool ref +type branch_type = + [ `Master + | `Proof of proof_mode * depth + | `Edit of proof_mode * Stateid.t * Stateid.t ] +type cmd_t = ast * Id.t list +type fork_t = ast * Vcs_.Branch.t * Vernacexpr.opacity_guarantee * Id.t list +type qed_t = { + qast : ast; + keep : vernac_qed_type; + mutable fproof : (future_proof * cancel_switch) option; + brname : Vcs_.Branch.t; + brinfo : branch_type Vcs_.branch_info +} +type seff_t = ast option +type alias_t = Stateid.t +type transaction = + | Cmd of cmd_t + | Fork of fork_t + | Qed of qed_t + | Sideff of seff_t + | Alias of alias_t + | Noop +type step = + [ `Cmd of cmd_t + | `Fork of fork_t + | `Qed of qed_t * Stateid.t + | `Sideff of [ `Ast of ast * Stateid.t | `Id of Stateid.t ] + | `Alias of alias_t ] +type visit = { step : step; next : Stateid.t } + +type state = { + system : States.state; + proof : Proof_global.state; + shallow : bool +} +type branch = Vcs_.Branch.t * branch_type Vcs_.branch_info +type backup = { mine : branch; others : branch list } +type 'vcs state_info = { (* Make private *) + mutable n_reached : int; + mutable n_goals : int; + mutable state : state option; + mutable vcs_backup : 'vcs option * backup option; +} +let default_info () = + { n_reached = 0; n_goals = 0; state = None; vcs_backup = None,None } + +(* Functions that work on a Vcs with a specific branch type *) +module Vcs_aux : sig + + val proof_nesting : (branch_type, 't,'i) Vcs_.t -> int + val find_proof_at_depth : + (branch_type, 't, 'i) Vcs_.t -> int -> + Vcs_.Branch.t * branch_type Vcs_.branch_info + exception Expired + val visit : (branch_type, transaction,'i) Vcs_.t -> Vcs_.Dag.node -> visit + +end = struct (* {{{ *) + + let proof_nesting vcs = + List.fold_left max 0 + (List.map_filter + (function + | { Vcs_.kind = `Proof (_,n) } -> Some n + | { Vcs_.kind = `Edit _ } -> Some 1 + | _ -> None) + (List.map (Vcs_.get_branch vcs) (Vcs_.branches vcs))) + + let find_proof_at_depth vcs pl = + try List.find (function + | _, { Vcs_.kind = `Proof(m, n) } -> Int.equal n pl + | _, { Vcs_.kind = `Edit _ } -> anomaly(str"find_proof_at_depth") + | _ -> false) + (List.map (fun h -> h, Vcs_.get_branch vcs h) (Vcs_.branches vcs)) + with Not_found -> failwith "find_proof_at_depth" + + exception Expired + let visit vcs id = + if Stateid.equal id Stateid.initial then + anomaly(str"Visiting the initial state id") + else if Stateid.equal id Stateid.dummy then + anomaly(str"Visiting the dummy state id") + else + try + match Vcs_.Dag.from_node (Vcs_.dag vcs) id with + | [n, Cmd x] -> { step = `Cmd x; next = n } + | [n, Alias x] -> { step = `Alias x; next = n } + | [n, Fork x] -> { step = `Fork x; next = n } + | [n, Qed x; p, Noop] + | [p, Noop; n, Qed x] -> { step = `Qed (x,p); next = n } + | [n, Sideff None; p, Noop] + | [p, Noop; n, Sideff None]-> { step = `Sideff (`Id p); next = n } + | [n, Sideff (Some x); p, Noop] + | [p, Noop; n, Sideff (Some x)]-> { step = `Sideff(`Ast (x,p)); next = n } + | [n, Sideff (Some x)]-> {step = `Sideff(`Ast (x,Stateid.dummy)); next=n} + | _ -> anomaly (str ("Malformed VCS at node "^Stateid.to_string id)) + with Not_found -> raise Expired + +end (* }}} *) + +(* Imperative wrap around VCS to obtain _the_ VCS *) +module VCS : sig + + exception Expired + + module Branch : (module type of Vcs_.Branch with type t = Vcs_.Branch.t) + type id = Stateid.t + type 'branch_type branch_info = 'branch_type Vcs_.branch_info = { + kind : [> `Master] as 'branch_type; + root : id; + pos : id; + } + + type vcs = (branch_type, transaction, vcs state_info) Vcs_.t + + val init : id -> unit + + val current_branch : unit -> Branch.t + val checkout : Branch.t -> unit + val branches : unit -> Branch.t list + val get_branch : Branch.t -> branch_type branch_info + val get_branch_pos : Branch.t -> id + val new_node : unit -> id + val merge : id -> ours:transaction -> ?into:Branch.t -> Branch.t -> unit + val rewrite_merge : id -> ours:transaction -> at:id -> Branch.t -> unit + val delete_branch : Branch.t -> unit + val commit : id -> transaction -> unit + val mk_branch_name : ast -> Branch.t + val edit_branch : Branch.t + val branch : ?root:id -> ?pos:id -> Branch.t -> branch_type -> unit + val reset_branch : Branch.t -> id -> unit + val reachable : id -> Vcs_.NodeSet.t + val cur_tip : unit -> id + + val get_info : id -> vcs state_info + val reached : id -> bool -> unit + val goals : id -> int -> unit + val set_state : id -> state -> unit + val get_state : id -> state option + val forget_state : id -> unit + + (* cuts from start -> stop, raising Expired if some nodes are not there *) + val slice : start:id -> stop:id -> vcs + + val create_cluster : id list -> tip:id -> unit + val cluster_of : id -> id option + val delete_cluster_of : id -> unit + + val proof_nesting : unit -> int + val checkout_shallowest_proof_branch : unit -> unit + val propagate_sideff : ast option -> unit + + val gc : unit -> unit + + val visit : id -> visit + + val print : ?now:bool -> unit -> unit + + val backup : unit -> vcs + val restore : vcs -> unit + +end = struct (* {{{ *) + + include Vcs_ + exception Expired = Vcs_aux.Expired + + module StateidSet = Set.Make(Stateid) + open Printf + + let print_dag vcs () = (* {{{ *) + let fname = "stm_" ^ process_id () in + let string_of_transaction = function + | Cmd (t, _) | Fork (t, _,_,_) -> + (try string_of_ppcmds (pr_ast t) with _ -> "ERR") + | Sideff (Some t) -> + sprintf "Sideff(%s)" + (try string_of_ppcmds (pr_ast t) with _ -> "ERR") + | Sideff None -> "EnvChange" + | Noop -> " " + | Alias id -> sprintf "Alias(%s)" (Stateid.to_string id) + | Qed { qast } -> string_of_ppcmds (pr_ast qast) in + let is_green id = + match get_info vcs id with + | Some { state = Some _ } -> true + | _ -> false in + let is_red id = + match get_info vcs id with + | Some s -> Int.equal s.n_reached ~-1 + | _ -> false in + let head = current_branch vcs in + let heads = + List.map (fun x -> x, (get_branch vcs x).pos) (branches vcs) in + let graph = dag vcs in + let quote s = + Str.global_replace (Str.regexp "\n") "<BR/>" + (Str.global_replace (Str.regexp "<") "<" + (Str.global_replace (Str.regexp ">") ">" + (Str.global_replace (Str.regexp "\"") """ + (Str.global_replace (Str.regexp "&") "&" + (String.sub s 0 (min (String.length s) 20)))))) in + let fname_dot, fname_ps = + let f = "/tmp/" ^ Filename.basename fname in + f ^ ".dot", f ^ ".pdf" in + let node id = "s" ^ Stateid.to_string id in + let edge tr = + sprintf "<<FONT POINT-SIZE=\"12\" FACE=\"sans\">%s</FONT>>" + (quote (string_of_transaction tr)) in + let ids = ref StateidSet.empty in + let clus = Hashtbl.create 13 in + let node_info id = + match get_info vcs id with + | None -> "" + | Some info -> + sprintf "<<FONT POINT-SIZE=\"12\">%s</FONT>" (Stateid.to_string id) ^ + sprintf " <FONT POINT-SIZE=\"11\">r:%d g:%d</FONT>>" + info.n_reached info.n_goals in + let color id = + if is_red id then "red" else if is_green id then "green" else "white" in + let nodefmt oc id = + fprintf oc "%s [label=%s,style=filled,fillcolor=%s];\n" + (node id) (node_info id) (color id) in + let add_to_clus_or_ids from cf = + match cf with + | None -> ids := StateidSet.add from !ids; false + | Some c -> Hashtbl.replace clus c + (try let n = Hashtbl.find clus c in from::n + with Not_found -> [from]); true in + let oc = open_out fname_dot in + output_string oc "digraph states {\nsplines=ortho\n"; + Dag.iter graph (fun from cf _ l -> + let c1 = add_to_clus_or_ids from cf in + List.iter (fun (dest, trans) -> + let c2 = add_to_clus_or_ids dest (Dag.cluster_of graph dest) in + fprintf oc "%s -> %s [label=%s,labelfloat=%b];\n" + (node from) (node dest) (edge trans) (c1 && c2)) l + ); + StateidSet.iter (nodefmt oc) !ids; + Hashtbl.iter (fun c nodes -> + fprintf oc "subgraph cluster_%s {\n" (Dag.Cluster.to_string c); + List.iter (nodefmt oc) nodes; + fprintf oc "color=blue; }\n" + ) clus; + List.iteri (fun i (b,id) -> + let shape = if Branch.equal head b then "box3d" else "box" in + fprintf oc "b%d -> %s;\n" i (node id); + fprintf oc "b%d [shape=%s,label=\"%s\"];\n" i shape + (Branch.to_string b); + ) heads; + output_string oc "}\n"; + close_out oc; + ignore(Sys.command + ("dot -Tpdf -Gcharset=latin1 " ^ fname_dot ^ " -o" ^ fname_ps)) + (* }}} *) + + type vcs = (branch_type, transaction, vcs state_info) t + let vcs : vcs ref = ref (empty Stateid.dummy) + + let init id = + vcs := empty id; + vcs := set_info !vcs id (default_info ()) + + let current_branch () = current_branch !vcs + + let checkout head = vcs := checkout !vcs head + let branches () = branches !vcs + let get_branch head = get_branch !vcs head + let get_branch_pos head = (get_branch head).pos + let new_node () = + let id = Stateid.fresh () in + vcs := set_info !vcs id (default_info ()); + id + let merge id ~ours ?into branch = + vcs := merge !vcs id ~ours ~theirs:Noop ?into branch + let delete_branch branch = vcs := delete_branch !vcs branch + let reset_branch branch id = vcs := reset_branch !vcs branch id + let commit id t = vcs := commit !vcs id t + let rewrite_merge id ~ours ~at branch = + vcs := rewrite_merge !vcs id ~ours ~theirs:Noop ~at branch + let reachable id = reachable !vcs id + let mk_branch_name { expr = x } = Branch.make + (match x with + | VernacDefinition (_,(_,i),_) -> string_of_id i + | VernacStartTheoremProof (_,[Some (_,i),_],_) -> string_of_id i + | _ -> "branch") + let edit_branch = Branch.make "edit" + let branch ?root ?pos name kind = vcs := branch !vcs ?root ?pos name kind + let get_info id = + match get_info !vcs id with + | Some x -> x + | None -> raise Vcs_aux.Expired + let set_state id s = (get_info id).state <- Some s + let get_state id = (get_info id).state + let forget_state id = (get_info id).state <- None + let reached id b = + let info = get_info id in + if b then info.n_reached <- info.n_reached + 1 + else info.n_reached <- -1 + let goals id n = (get_info id).n_goals <- n + let cur_tip () = get_branch_pos (current_branch ()) + + let proof_nesting () = Vcs_aux.proof_nesting !vcs + + let checkout_shallowest_proof_branch () = + if List.mem edit_branch (Vcs_.branches !vcs) then begin + checkout edit_branch; + match get_branch edit_branch with + | { kind = `Edit (mode, _, _) } -> Proof_global.activate_proof_mode mode + | _ -> assert false + end else + let pl = proof_nesting () in + try + let branch, mode = match Vcs_aux.find_proof_at_depth !vcs pl with + | h, { Vcs_.kind = `Proof (m, _) } -> h, m | _ -> assert false in + checkout branch; + prerr_endline ("mode:" ^ mode); + Proof_global.activate_proof_mode mode + with Failure _ -> + checkout Branch.master; + Proof_global.disactivate_proof_mode "Classic" + + (* copies the transaction on every open branch *) + let propagate_sideff t = + List.iter (fun b -> + checkout b; + let id = new_node () in + merge id ~ours:(Sideff t) ~into:b Branch.master) + (List.filter (fun b -> not (Branch.equal b Branch.master)) (branches ())) + + let visit id = Vcs_aux.visit !vcs id + + let slice ~start ~stop = + let l = + let rec aux id = + if Stateid.equal id stop then [] else + match visit id with + | { next = n; step = `Cmd x } -> (id,Cmd x) :: aux n + | { next = n; step = `Alias x } -> (id,Alias x) :: aux n + | { next = n; step = `Sideff (`Ast (x,_)) } -> + (id,Sideff (Some x)) :: aux n + | _ -> anomaly(str("Cannot slice from "^ Stateid.to_string start ^ + " to "^Stateid.to_string stop)) + in aux start in + let copy_info v id = + Vcs_.set_info v id + { (get_info id) with state = None; vcs_backup = None,None } in + let copy_info_w_state v id = + Vcs_.set_info v id { (get_info id) with vcs_backup = None,None } in + let v = Vcs_.empty stop in + let v = copy_info v stop in + let v = List.fold_right (fun (id,tr) v -> + let v = Vcs_.commit v id tr in + let v = copy_info v id in + v) l v in + (* Stm should have reached the beginning of proof *) + assert (not (Option.is_empty (get_info stop).state)); + (* We put in the new dag the most recent state known to master *) + let rec fill id = + if (get_info id).state = None then fill (Vcs_aux.visit v id).next + else copy_info_w_state v id in + fill start + + let create_cluster l ~tip = vcs := create_cluster !vcs l tip + let cluster_of id = Option.map Dag.Cluster.data (cluster_of !vcs id) + let delete_cluster_of id = + Option.iter (fun x -> vcs := delete_cluster !vcs x) (Vcs_.cluster_of !vcs id) + + let gc () = + let old_vcs = !vcs in + let new_vcs, erased_nodes = gc old_vcs in + Vcs_.NodeSet.iter (fun id -> + match (Vcs_aux.visit old_vcs id).step with + | `Qed ({ fproof = Some (_, cancel_switch) }, _) -> + cancel_switch := true + | _ -> ()) + erased_nodes; + vcs := new_vcs + + module NB : sig (* Non blocking Sys.command *) + + val command : now:bool -> (unit -> unit) -> unit + + end = struct (* {{{ *) + + let m = Mutex.create () + let c = Condition.create () + let job = ref None + let worker = ref None + + let set_last_job j = + Mutex.lock m; + job := Some j; + Condition.signal c; + Mutex.unlock m + + let get_last_job () = + Mutex.lock m; + while Option.is_empty !job do Condition.wait c m; done; + match !job with + | None -> assert false + | Some x -> job := None; Mutex.unlock m; x + + let run_command () = + try while true do get_last_job () () done + with e -> () (* No failure *) + + let command ~now job = + if now then job () + else begin + set_last_job job; + if Option.is_empty !worker then + worker := Some (Thread.create run_command ()) + end + + end (* }}} *) + + let print ?(now=false) () = + if not !Flags.debug && not now then () else NB.command ~now (print_dag !vcs) + + let backup () = !vcs + let restore v = vcs := v + +end (* }}} *) + +(* Fills in the nodes of the VCS *) +module State : sig + + (** The function is from unit, so it uses the current state to define + a new one. I.e. one may been to install the right state before + defining a new one. + Warning: an optimization in installed_cached requires that state + modifying functions are always executed using this wrapper. *) + val define : + ?redefine:bool -> ?cache:Summary.marshallable -> (unit -> unit) -> Stateid.t -> unit + + val install_cached : Stateid.t -> unit + val is_cached : Stateid.t -> bool + + + val exn_on : Stateid.t -> ?valid:Stateid.t -> exn -> exn + (* to send states across worker/master *) + type frozen_state + val get_cached : Stateid.t -> frozen_state + val assign : Stateid.t -> frozen_state -> unit + +end = struct (* {{{ *) + + (* cur_id holds Stateid.dummy in case the last attempt to define a state + * failed, so the global state may contain garbage *) + let cur_id = ref Stateid.dummy + + (* helpers *) + let freeze_global_state marshallable = + { system = States.freeze ~marshallable; + proof = Proof_global.freeze ~marshallable; + shallow = (marshallable = `Shallow) } + let unfreeze_global_state { system; proof } = + States.unfreeze system; Proof_global.unfreeze proof + + (* hack to make futures functional *) + let in_t, out_t = Dyn.create "state4future" + let () = Future.set_freeze + (fun () -> in_t (freeze_global_state `No, !cur_id)) + (fun t -> let s,i = out_t t in unfreeze_global_state s; cur_id := i) + + let is_cached id = + Stateid.equal id !cur_id || + match VCS.get_info id with + | { state = Some _ } -> true + | _ -> false + + let install_cached id = + if Stateid.equal id !cur_id then () else (* optimization *) + let s = + match VCS.get_info id with + | { state = Some s } -> s + | _ -> anomaly (str "unfreezing a non existing state") in + unfreeze_global_state s; cur_id := id + + type frozen_state = state + + let get_cached id = + try match VCS.get_info id with + | { state = Some s } -> s + | _ -> anomaly (str "not a cached state") + with VCS.Expired -> anomaly (str "not a cached state (expired)") + + let assign id s = + try if VCS.get_state id = None then VCS.set_state id s + with VCS.Expired -> () + + let freeze marhallable id = VCS.set_state id (freeze_global_state marhallable) + + let exn_on id ?valid e = + match Stateid.get e with + | Some _ -> e + | None -> + let loc = Option.default Loc.ghost (Loc.get_loc e) in + let msg = string_of_ppcmds (print e) in + Pp.feedback ~state_id:id (Interface.ErrorMsg (loc, msg)); + Stateid.add (Hook.get f_process_error e) ?valid id + + let define ?(redefine=false) ?(cache=`No) f id = + let str_id = Stateid.to_string id in + if is_cached id && not redefine then + anomaly (str"defining state "++str str_id++str" twice"); + try + prerr_endline("defining "^str_id^" (cache="^ + if cache = `Yes then "Y)" else if cache = `Shallow then "S)" else "N)"); + f (); + if cache = `Yes then freeze `No id + else if cache = `Shallow then freeze `Shallow id; + prerr_endline ("setting cur id to "^str_id); + cur_id := id; + feedback ~state_id:id Interface.Processed; + VCS.reached id true; + if Proof_global.there_are_pending_proofs () then + VCS.goals id (Proof_global.get_open_goals ()); + with e -> + let e = Errors.push e in + let good_id = !cur_id in + cur_id := Stateid.dummy; + VCS.reached id false; + match Stateid.get e with + | Some _ -> raise e + | None -> raise (exn_on id ~valid:good_id e) + +end +(* }}} *) + +let hints = ref Aux_file.empty_aux_file +let set_compilation_hints file = + hints := Aux_file.load_aux_file_for file +let get_hint_ctx loc = + let s = Aux_file.get !hints loc "context_used" in + let ids = List.map Names.Id.of_string (Str.split (Str.regexp " ") s) in + let ids = List.map (fun id -> Loc.ghost, id) ids in + SsExpr (SsSet ids) + +let get_hint_bp_time proof_name = + try float_of_string (Aux_file.get !hints Loc.ghost proof_name) + with Not_found -> 1.0 + +module Worker = Spawn.Sync(struct + let add_timeout ~sec f = + ignore(Thread.create (fun () -> + while true do + Unix.sleep sec; + if not (f ()) then Thread.exit () + done) + ()) +end) + +module WorkersPool = WorkerPool.Make(Worker) + +let record_pb_time proof_name loc time = + let proof_build_time = Printf.sprintf "%.3f" time in + Aux_file.record_in_aux_at loc "proof_build_time" proof_build_time; + if proof_name <> "" then begin + Aux_file.record_in_aux_at Loc.ghost proof_name proof_build_time; + hints := Aux_file.set !hints Loc.ghost proof_name proof_build_time + end + +(* Slave processes (if initialized, otherwise local lazy evaluation) *) +module Slaves : sig + + (* (eventually) remote calls *) + val build_proof : loc:Loc.t -> + exn_info:(Stateid.t * Stateid.t) -> start:Stateid.t -> stop:Stateid.t -> + name:string -> future_proof * cancel_switch + + (* blocking function that waits for the task queue to be empty *) + val wait_all_done : unit -> unit + + (* initialize the whole machinery (optional) *) + val init : unit -> unit + + (* slave process main loop *) + val slave_main_loop : (unit -> unit) -> unit + val slave_init_stdout : unit -> unit + + (* to disentangle modules *) + val set_reach_known_state : + (?redefine_qed:bool -> cache:Summary.marshallable -> Stateid.t -> unit) -> unit + + type tasks + val dump : (Future.UUID.t * int) list -> tasks + val check_task : string -> tasks -> int -> bool + val info_tasks : tasks -> (string * float * int) list + val finish_task : + string -> + Library.seg_univ -> Library.seg_discharge -> Library.seg_proofs -> + tasks -> int -> Library.seg_univ + + val cancel_worker : int -> unit + + val set_perspective : Stateid.t list -> unit + +end = struct (* {{{ *) + + + let cancel_worker n = WorkersPool.cancel (n-1) + + let reach_known_state = ref (fun ?redefine_qed ~cache id -> ()) + let set_reach_known_state f = reach_known_state := f + + type 'a request = + ReqBuildProof of + (Stateid.t * Stateid.t) * Stateid.t * VCS.vcs * Loc.t * 'a * string + + let name_of_request (ReqBuildProof (_,_,_,_,_,s)) = s + + type response = + | RespBuiltProof of Entries.proof_output list * float + | RespError of (* err, safe, msg, safe_states *) + Stateid.t * Stateid.t * std_ppcmds * + (Stateid.t * State.frozen_state) list + | RespFeedback of Interface.feedback + | RespGetCounterFreshLocalUniv + | RespGetCounterNewUnivLevel + let pr_response = function + | RespBuiltProof _ -> "Sucess" + | RespError _ -> "Error" + | RespFeedback { Interface.id = Interface.State id } -> + "Feedback on " ^ Stateid.to_string id + | RespFeedback _ -> assert false + | RespGetCounterFreshLocalUniv -> "GetCounterFreshLocalUniv" + | RespGetCounterNewUnivLevel -> "GetCounterNewUnivLevel" + + type more_data = + | MoreDataLocalUniv of Univ.universe list + | MoreDataUnivLevel of Univ.universe_level list + + type task = + | TaskBuildProof of (Stateid.t * Stateid.t) * Stateid.t * Stateid.t * + (Entries.proof_output list Future.assignement -> unit) * cancel_switch + * Loc.t * Future.UUID.t * string + let pr_task = function + | TaskBuildProof(_,bop,eop,_,_,_,_,s) -> + "TaskBuilProof("^Stateid.to_string bop^","^Stateid.to_string eop^ + ","^s^")" + + let request_of_task task : Future.UUID.t request = + match task with + | TaskBuildProof (exn_info,bop,eop,_,_,loc,uuid,s) -> + ReqBuildProof(exn_info,eop,VCS.slice ~start:eop ~stop:bop,loc,uuid,s) + + let cancel_switch_of_task = function + | TaskBuildProof (_,_,_,_,c,_,_,_) -> c + + let build_proof_here_core loc eop () = + let wall_clock1 = Unix.gettimeofday () in + if !Flags.batch_mode then !reach_known_state ~cache:`No eop + else !reach_known_state ~cache:`Shallow eop; + let wall_clock2 = Unix.gettimeofday () in + Aux_file.record_in_aux_at loc "proof_build_time" + (Printf.sprintf "%.3f" (wall_clock2 -. wall_clock1)); + Proof_global.return_proof () + let build_proof_here (id,valid) loc eop = + Future.create (State.exn_on id ~valid) (build_proof_here_core loc eop) + + let slave_respond msg = + match msg with + | ReqBuildProof(exn_info,eop,vcs,loc,_,_) -> + VCS.restore vcs; + VCS.print (); + let rc, time = + let wall_clock = Unix.gettimeofday () in + let l = Future.force (build_proof_here exn_info loc eop) in + List.iter (fun (_,se) -> Declareops.iter_side_effects (function + | Declarations.SEsubproof(_, + { Declarations.const_body = Declarations.OpaqueDef f } ) -> + Opaqueproof.join_opaque f + | _ -> ()) + se) l; + l, Unix.gettimeofday () -. wall_clock in + VCS.print (); + RespBuiltProof(rc,time) + + let check_task_aux extra name l i = + match List.nth l i with + | ReqBuildProof ((id,valid),eop,vcs,loc,_,s) -> + Pp.msg_info( + str(Printf.sprintf "Checking task %d (%s%s) of %s" i s extra name)); + VCS.restore vcs; + try + !reach_known_state ~cache:`No eop; + (* The original terminator, a hook, has not been saved in the .vi*) + Proof_global.set_terminator + (Lemmas.standard_proof_terminator [] (fun _ _ -> ())); + let proof = Proof_global.close_proof (fun x -> x) in + vernac_interp eop ~proof + { verbose = false; loc; + expr = (VernacEndProof (Proved (true,None))) }; + Some proof + with e -> + let e = Errors.push e in + (try match Stateid.get e with + | None -> + Pp.pperrnl Pp.( + str"File " ++ str name ++ str ": proof of " ++ str s ++ + spc () ++ print e) + | Some (_, cur) -> + match VCS.visit cur with + | { step = `Cmd ( { loc }, _) } + | { step = `Fork ( { loc }, _, _, _) } + | { step = `Qed ( { qast = { loc } }, _) } + | { step = `Sideff (`Ast ( { loc }, _)) } -> + let start, stop = Loc.unloc loc in + Pp.pperrnl Pp.( + str"File " ++ str name ++ str ": proof of " ++ str s ++ + str ": chars " ++ int start ++ str "-" ++ int stop ++ + spc () ++ print e) + | _ -> + Pp.pperrnl Pp.( + str"File " ++ str name ++ str ": proof of " ++ str s ++ + spc () ++ print e) + with e -> + Pp.msg_error (str"unable to print error message: " ++ + str (Printexc.to_string e))); None + + let finish_task name (u,cst,_) d p l i = + let bucket = + match List.nth l i with ReqBuildProof (_,_,_,_,bucket,_) -> bucket in + match check_task_aux (Printf.sprintf ", bucket %d" bucket) name l i with + | None -> exit 1 + | Some (po,pt) -> + let discharge c = List.fold_right Cooking.cook_constr d.(bucket) c in + let con = + Nametab.locate_constant + (Libnames.qualid_of_ident po.Proof_global.id) in + let c = Global.lookup_constant con in + match c.Declarations.const_body with + | Declarations.OpaqueDef lc -> + let uc = Option.get (Opaqueproof.get_constraints lc) in + let uc = + Future.chain ~greedy:true ~pure:true uc Univ.hcons_constraints in + let pr = Opaqueproof.get_proof lc in + let pr = Future.chain ~greedy:true ~pure:true pr discharge in + let pr = Future.chain ~greedy:true ~pure:true pr Constr.hcons in + Future.sink pr; + let extra = Future.join uc in + u.(bucket) <- uc; + p.(bucket) <- pr; + u, Univ.union_constraints cst extra, false + | _ -> assert false + + let check_task name l i = + match check_task_aux "" name l i with + | Some _ -> true + | None -> false + + let info_tasks l = + CList.map_i (fun i (ReqBuildProof(_,_,_,loc,_,s)) -> + let time1 = + try float_of_string (Aux_file.get !hints loc "proof_build_time") + with Not_found -> 0.0 in + let time2 = + try float_of_string (Aux_file.get !hints loc "proof_check_time") + with Not_found -> 0.0 in + s,max (time1 +. time2) 0.0001,i) 0 l + + open Interface + + exception MarshalError of string + + let marshal_to_channel oc data = + Marshal.to_channel oc data []; + flush oc + + let marshal_err s = raise (MarshalError s) + + let marshal_request oc (req : Future.UUID.t request) = + try marshal_to_channel oc req + with Failure s | Invalid_argument s | Sys_error s -> + marshal_err ("marshal_request: "^s) + + let unmarshal_request ic = + try (Marshal.from_channel ic : Future.UUID.t request) + with Failure s | Invalid_argument s | Sys_error s -> + marshal_err ("unmarshal_request: "^s) + + let marshal_response oc (res : response) = + try marshal_to_channel oc res + with Failure s | Invalid_argument s | Sys_error s -> + marshal_err ("marshal_response: "^s) + + let unmarshal_response ic = + try (CThread.thread_friendly_input_value ic : response) + with Failure s | Invalid_argument s | Sys_error s -> + marshal_err ("unmarshal_response: "^s) + + let marshal_more_data oc (res : more_data) = + try marshal_to_channel oc res + with Failure s | Invalid_argument s | Sys_error s -> + marshal_err ("marshal_more_data: "^s) + + let unmarshal_more_data ic = + try (Marshal.from_channel ic : more_data) + with Failure s | Invalid_argument s | Sys_error s -> + marshal_err ("unmarshal_more_data: "^s) + + let queue : task TQueue.t = TQueue.create () + + let set_perspective idl = + let open Stateid in + let p = List.fold_right Set.add idl Set.empty in + TQueue.reorder queue (fun task1 task2 -> + let TaskBuildProof (_, a1, b1, _, _,_,_,_) = task1 in + let TaskBuildProof (_, a2, b2, _, _,_,_,_) = task2 in + match Set.mem a1 p || Set.mem b1 p, Set.mem a2 p || Set.mem b2 p with + | true, true | false, false -> 0 + | true, false -> -1 + | false, true -> 1) + + let wait_all_done () = + if not (WorkersPool.is_empty ()) then + TQueue.wait_until_n_are_waiting_and_queue_empty + (WorkersPool.n_workers ()) queue + + let build_proof ~loc ~exn_info:(id,valid as exn_info) ~start ~stop ~name = + let cancel_switch = ref false in + if WorkersPool.is_empty () then + if !Flags.compilation_mode = Flags.BuildVi then begin + let force () : Entries.proof_output list Future.assignement = + try `Val (build_proof_here_core loc stop ()) + with e -> let e = Errors.push e in `Exn e in + let f,assign = Future.create_delegate ~force (State.exn_on id ~valid) in + let uuid = Future.uuid f in + TQueue.push queue (TaskBuildProof + (exn_info,start,stop,assign,cancel_switch,loc,uuid,name)); + f, cancel_switch + end else + build_proof_here exn_info loc stop, cancel_switch + else + let f, assign = Future.create_delegate (State.exn_on id ~valid) in + let uuid = Future.uuid f in + Pp.feedback (Interface.InProgress 1); + TQueue.push queue (TaskBuildProof + (exn_info,start,stop,assign,cancel_switch,loc,uuid,name)); + f, cancel_switch + + exception RemoteException of std_ppcmds + let _ = Errors.register_handler (function + | RemoteException ppcmd -> ppcmd + | _ -> raise Unhandled) + + exception KillRespawn + + let report_status ?id s = + let id = + match id with + | Some n -> n + | None -> + match !Flags.async_proofs_mode with + | Flags.APonParallel n -> n + | _ -> assert false in + Pp.feedback ~state_id:Stateid.initial (Interface.SlaveStatus(id, s)) + + let rec manage_slave ~cancel:cancel_user_req id_slave respawn = + let ic, oc, proc = + let rec set_slave_opt = function + | [] -> ["-async-proofs"; "worker"; string_of_int id_slave; "-feedback-glob"] + | ("-ideslave"|"-emacs"|"-emacs-U")::tl -> set_slave_opt tl + | ("-async-proofs" + |"-compile" + |"-compile-verbose")::_::tl -> set_slave_opt tl + | x::tl -> x :: set_slave_opt tl in + let args = + Array.of_list (set_slave_opt (List.tl (Array.to_list Sys.argv))) in + let env = + Array.append !async_proofs_workers_extra_env (Unix.environment ()) in + respawn ~args ~env () in + let last_task = ref None in + let task_expired = ref false in + let task_cancelled = ref false in + CThread.prepare_in_channel_for_thread_friendly_io ic; + try + while true do + prerr_endline "waiting for a task"; + report_status ~id:id_slave "Idle"; + let task = TQueue.pop queue in + prerr_endline ("got task: "^pr_task task); + last_task := Some task; + try + marshal_request oc (request_of_task task); + let cancel_switch = cancel_switch_of_task task in + Worker.kill_if proc ~sec:1 (fun () -> + task_expired := !cancel_switch; + task_cancelled := !cancel_user_req; + if !cancel_user_req then cancel_user_req := false; + !task_expired || !task_cancelled); + let rec loop () = + let response = unmarshal_response ic in + match task, response with + | TaskBuildProof(_,_,_, assign,_,loc,_,s), + RespBuiltProof(pl, time)-> + assign (`Val pl); + (* We restart the slave, to avoid memory leaks. We could just + Pp.feedback (Interface.InProgress ~-1) *) + record_pb_time s loc time; + last_task := None; + raise KillRespawn + | TaskBuildProof(_,_,_, assign,_,_,_,_), + RespError(err_id,valid,e,valid_states) -> + let e = Stateid.add ~valid (RemoteException e) err_id in + assign (`Exn e); + List.iter (fun (id,s) -> State.assign id s) valid_states; + (* We restart the slave, to avoid memory leaks. We could just + Pp.feedback (Interface.InProgress ~-1) *) + last_task := None; + raise KillRespawn + | _, RespGetCounterFreshLocalUniv -> + marshal_more_data oc (MoreDataLocalUniv + (CList.init 10 (fun _ -> Univ.fresh_local_univ ()))); + if !cancel_switch then raise KillRespawn else loop () + | _, RespGetCounterNewUnivLevel -> + marshal_more_data oc (MoreDataUnivLevel + (CList.init 10 (fun _ -> Termops.new_univ_level ()))); + loop () + | _, RespFeedback {id = State state_id; content = msg} -> + Pp.feedback ~state_id msg; + loop () + | _, RespFeedback _ -> assert false (* Parsing in master process *) + in + loop () + with + | VCS.Expired -> (* task cancelled: e.g. the user did backtrack *) + Pp.feedback (Interface.InProgress ~-1); + prerr_endline ("Task expired: " ^ pr_task task) + | (Sys_error _ | Invalid_argument _ | End_of_file | KillRespawn) as e -> + raise e (* we pass the exception to the external handler *) + | MarshalError s when !fallback_to_lazy_if_marshal_error -> + msg_warning(strbrk("Marshalling error: "^s^". "^ + "The system state could not be sent to the worker process. "^ + "Falling back to local, lazy, evaluation.")); + let TaskBuildProof (exn_info, _, stop, assign,_,loc,_,_) = task in + assign(`Comp(build_proof_here exn_info loc stop)); + Pp.feedback (Interface.InProgress ~-1) + | MarshalError s -> + pr_err ("Fatal marshal error: " ^ s); + flush_all (); exit 1 + | e -> + pr_err ("Uncaught exception in worker manager: "^ + string_of_ppcmds (print e)); + flush_all () + done + with + | KillRespawn -> + Pp.feedback (Interface.InProgress ~-1); + Worker.kill proc; ignore(Worker.wait proc); + manage_slave ~cancel:cancel_user_req id_slave respawn + | Sys_error _ | Invalid_argument _ | End_of_file when !task_expired -> + Pp.feedback (Interface.InProgress ~-1); + ignore(Worker.wait proc); + manage_slave ~cancel:cancel_user_req id_slave respawn + | Sys_error _ | Invalid_argument _ | End_of_file when !task_cancelled -> + msg_warning(strbrk "The worker was cancelled."); + Option.iter (fun task -> + let TaskBuildProof (_, start, _, assign, _,_,_,_) = task in + let s = "Worker cancelled by the user" in + let e = Stateid.add ~valid:start (RemoteException (strbrk s)) start in + assign (`Exn e); + Pp.feedback ~state_id:start (Interface.ErrorMsg (Loc.ghost, s)); + Pp.feedback (Interface.InProgress ~-1); + ) !last_task; + Worker.kill proc; ignore(Worker.wait proc); + manage_slave ~cancel:cancel_user_req id_slave respawn + | Sys_error _ | Invalid_argument _ | End_of_file + when !fallback_to_lazy_if_slave_dies -> + msg_warning(strbrk "The worker process died badly."); + Option.iter (fun task -> + msg_warning(strbrk "Falling back to local, lazy, evaluation."); + let TaskBuildProof (exn_info, _, stop, assign,_,loc,_,_) = task in + assign(`Comp(build_proof_here exn_info loc stop)); + Pp.feedback (Interface.InProgress ~-1); + ) !last_task; + Worker.kill proc; ignore(Worker.wait proc); + manage_slave ~cancel:cancel_user_req id_slave respawn + | Sys_error _ | Invalid_argument _ | End_of_file -> + Worker.kill proc; + let exit_status proc = match Worker.wait proc with + | Unix.WEXITED 0x400 -> "exit code unavailable" + | Unix.WEXITED i -> Printf.sprintf "exit(%d)" i + | Unix.WSIGNALED sno -> Printf.sprintf "signalled(%d)" sno + | Unix.WSTOPPED sno -> Printf.sprintf "stopped(%d)" sno in + pr_err ("Fatal worker error: " ^ (exit_status proc)); + flush_all (); exit 1 + + let init () = WorkersPool.init !Flags.async_proofs_n_workers manage_slave + + let slave_ic = ref stdin + let slave_oc = ref stdout + + let slave_init_stdout () = + let ic, oc = Spawned.get_channels () in + slave_oc := oc; slave_ic := ic + + let bufferize f = + let l = ref [] in + fun () -> + match !l with + | [] -> let data = f () in l := List.tl data; List.hd data + | x::tl -> l := tl; x + + let slave_handshake () = WorkersPool.worker_handshake !slave_ic !slave_oc + + let slave_main_loop reset = + let slave_feeder oc fb = + Marshal.to_channel oc (RespFeedback fb) []; + flush oc in + Pp.set_feeder (slave_feeder !slave_oc); + Termops.set_remote_new_univ_level (bufferize (fun () -> + marshal_response !slave_oc RespGetCounterNewUnivLevel; + match unmarshal_more_data !slave_ic with + | MoreDataUnivLevel l -> l | _ -> assert false)); + Univ.set_remote_fresh_local_univ (bufferize (fun () -> + marshal_response !slave_oc RespGetCounterFreshLocalUniv; + match unmarshal_more_data !slave_ic with + | MoreDataLocalUniv l -> l | _ -> assert false)); + let working = ref false in + slave_handshake (); + while true do + try + working := false; + let request = unmarshal_request !slave_ic in + working := true; + report_status (name_of_request request); + let response = slave_respond request in + report_status "Idle"; + marshal_response !slave_oc response; + reset () + with + | MarshalError s -> + pr_err ("Fatal marshal error: " ^ s); flush_all (); exit 2 + | End_of_file -> + prerr_endline "connection lost"; flush_all (); exit 2 + | e when Errors.noncritical e -> + (* This can happen if the proof is broken. The error has also been + * signalled as a feedback, hence we can silently recover *) + let err_id, safe_id = match Stateid.get e with + | Some (safe, err) -> err, safe + | None -> Stateid.dummy, Stateid.dummy in + prerr_endline "failed with the following exception:"; + prerr_endline (string_of_ppcmds (print e)); + prerr_endline ("last safe id is: " ^ Stateid.to_string safe_id); + prerr_endline ("cached? " ^ string_of_bool (State.is_cached safe_id)); + let prog old_v n = + if n < 3 then n else old_v + n/3 + if n mod 3 > 0 then 1 else 0 in + let states = + let open State in + let rec aux n m prev_id = + let next = + try Some (VCS.visit prev_id).next + with VCS.Expired -> None in + match next with + | None -> [] + | Some id when n = m -> + prerr_endline ("sending back state " ^ string_of_int m); + let tail = aux (n+1) (prog m (n+1)) id in + if is_cached id then (id, get_cached id) :: tail else tail + | Some id -> aux (n+1) m id in + (if is_cached safe_id then [safe_id,get_cached safe_id] else []) + @ aux 1 (prog 1 1) safe_id in + marshal_response !slave_oc (RespError(err_id, safe_id, print e, states)) + | e -> + pr_err ("Slave: critical exception: " ^ Pp.string_of_ppcmds (print e)); + flush_all (); exit 1 + done + + (* For external users this name is nicer than request *) + type tasks = int request list + let dump f2t_map = + assert(WorkersPool.is_empty ()); (* ATM, we allow that only if no slaves *) + let tasks = TQueue.dump queue in + prerr_endline (Printf.sprintf "dumping %d\n" (List.length tasks)); + let tasks = List.map request_of_task tasks in + List.map (function ReqBuildProof(a,b,c,d,x,e) -> + ReqBuildProof(a,b,c,d,List.assoc x f2t_map,e)) tasks + +end (* }}} *) + +(* Runs all transactions needed to reach a state *) +module Reach : sig + + val known_state : + ?redefine_qed:bool -> cache:Summary.marshallable -> Stateid.t -> unit + +end = struct (* {{{ *) + +let pstate = ["meta counter"; "evar counter"; "program-tcc-table"] + +let delegate_policy_check time = + if interactive () = `Yes then + (!Flags.async_proofs_mode = Flags.APonParallel 0 || + !Flags.async_proofs_mode = Flags.APonLazy) && time >= 1.0 + else if !Flags.compilation_mode = Flags.BuildVi then true + else !Flags.async_proofs_mode <> Flags.APoff && time >= 1.0 + +let collect_proof cur hd brkind id = + prerr_endline ("Collecting proof ending at "^Stateid.to_string id); + let no_name = "" in + let name = function + | [] -> no_name + | id :: _ -> Id.to_string id in + let loc = (snd cur).loc in + let is_defined = function + | _, { expr = VernacEndProof (Proved (false,_)) } -> true + | _ -> false in + let rec collect last accn id = + let view = VCS.visit id in + match last, view.step with + | _, `Cmd (x, _) -> collect (Some (id,x)) (id::accn) view.next + | _, `Alias _ -> `Sync (no_name,`Alias) + | _, `Fork(_,_,_,_::_::_)-> `Sync (no_name,`MutualProofs) + | _, `Fork(_,_,Doesn'tGuaranteeOpacity,_) -> + `Sync (no_name,`Doesn'tGuaranteeOpacity) + | Some (parent, ({ expr = VernacProof(_,Some _)} as v)), + `Fork (_, hd', GuaranteesOpacity, ids) -> + let name = name ids in + let time = get_hint_bp_time name in + assert (VCS.Branch.equal hd hd' || VCS.Branch.equal hd VCS.edit_branch); + if delegate_policy_check time + then `ASync (parent,Some v,accn,name) + else `Sync (name,`Policy) + | Some (parent, ({ expr = VernacProof(t,None)} as v)), + `Fork (_, hd', GuaranteesOpacity, ids) when + not (State.is_cached parent) && + !Flags.compilation_mode = Flags.BuildVi -> + (try + let name = name ids in + let hint, time = get_hint_ctx loc, get_hint_bp_time name in + assert (VCS.Branch.equal hd hd'||VCS.Branch.equal hd VCS.edit_branch); + v.expr <- VernacProof(t, Some hint); + if delegate_policy_check time + then `ASync (parent,Some v,accn,name) + else `Sync (name,`Policy) + with Not_found -> `Sync (no_name,`NoHint)) + | Some (parent, _), `Fork (_, hd', GuaranteesOpacity, ids) -> + assert (VCS.Branch.equal hd hd' || VCS.Branch.equal hd VCS.edit_branch); + let name = name ids in + let time = get_hint_bp_time name in + if delegate_policy_check time + then `MaybeASync (parent, accn, name) + else `Sync (name,`Policy) + | _, `Sideff _ -> `Sync (no_name,`NestedProof) + | _ -> `Sync (no_name,`Unknown) in + match cur, (VCS.visit id).step, brkind with + |( parent, { expr = VernacExactProof _ }), `Fork _, _ -> + `Sync (no_name,`Immediate) + | _, _, { VCS.kind = `Edit _ } -> collect (Some cur) [] id + | _ -> + if is_defined cur then `Sync (no_name,`Transparent) + else + let rc = collect (Some cur) [] id in + if not (State.is_cached id) then rc + else (* we already have the proof, no gain in delaying *) + match rc with + | `Sync(name,_) -> `Sync (name,`AlreadyEvaluated) + | `MaybeASync(_,_,name) -> `Sync (name,`AlreadyEvaluated) + | `ASync(_,_,_,name) -> `Sync (name,`AlreadyEvaluated) + +let string_of_reason = function + | `Transparent -> "Transparent" + | `AlreadyEvaluated -> "AlreadyEvaluated" + | `Policy -> "Policy" + | `NestedProof -> "NestedProof" + | `Immediate -> "Immediate" + | `Alias -> "Alias" + | `NoHint -> "NoHint" + | `Doesn'tGuaranteeOpacity -> "Doesn'tGuaranteeOpacity" + | _ -> "Unknown Reason" + +let wall_clock_last_fork = ref 0.0 + +let known_state ?(redefine_qed=false) ~cache id = + + (* ugly functions to process nested lemmas, i.e. hard to reproduce + * side effects *) + let cherry_pick_non_pstate () = + Summary.freeze_summary ~marshallable:`No ~complement:true pstate, + Lib.freeze ~marshallable:`No in + let inject_non_pstate (s,l) = Summary.unfreeze_summary s; Lib.unfreeze l in + + let rec pure_cherry_pick_non_pstate id = Future.purify (fun id -> + prerr_endline ("cherry-pick non pstate " ^ Stateid.to_string id); + reach id; + cherry_pick_non_pstate ()) id + + (* traverses the dag backward from nodes being already calculated *) + and reach ?(redefine_qed=false) ?(cache=cache) id = + prerr_endline ("reaching: " ^ Stateid.to_string id); + if not redefine_qed && State.is_cached id then begin + State.install_cached id; + feedback ~state_id:id Interface.Processed; + prerr_endline ("reached (cache)") + end else + let step, cache_step = + let view = VCS.visit id in + match view.step with + | `Alias id -> (fun () -> + reach view.next; reach id + ), cache + | `Cmd (x,_) -> (fun () -> + reach view.next; vernac_interp id x + ), cache + | `Fork (x,_,_,_) -> (fun () -> + reach view.next; vernac_interp id x; + wall_clock_last_fork := Unix.gettimeofday () + ), `Yes + | `Qed ({ qast = x; keep; brinfo; brname } as qed, eop) -> + let rec aux = function + | `ASync (start, proof_using_ast, nodes, name) -> (fun () -> + prerr_endline ("Asynchronous " ^ Stateid.to_string id); + VCS.create_cluster nodes ~tip:id; + begin match keep, brinfo, qed.fproof with + | VtKeep, { VCS.kind = `Edit _ }, None -> assert false + | VtKeep, { VCS.kind = `Edit _ }, Some (ofp, cancel) -> + assert(redefine_qed = true); + VCS.create_cluster nodes ~tip:id; + let fp, cancel = Slaves.build_proof + ~loc:x.loc ~exn_info:(id,eop) ~start ~stop:eop ~name in + Future.replace ofp fp; + qed.fproof <- Some (fp, cancel) + | VtKeep, { VCS.kind = `Proof _ }, Some _ -> assert false + | VtKeep, { VCS.kind = `Proof _ }, None -> + reach ~cache:`Shallow start; + let fp, cancel = Slaves.build_proof + ~loc:x.loc ~exn_info:(id,eop) ~start ~stop:eop ~name in + qed.fproof <- Some (fp, cancel); + let proof = + Proof_global.close_future_proof ~feedback_id:id fp in + reach view.next; + vernac_interp id ~proof x; + feedback ~state_id:id Interface.Incomplete + | VtDrop, _, _ -> + reach view.next; + Option.iter (vernac_interp start) proof_using_ast; + vernac_interp id x + | _, { VCS.kind = `Master }, _ -> assert false + end; + Proof_global.discard_all () + ), if redefine_qed then `No else `Yes + | `Sync (name, `Immediate) -> (fun () -> + assert (Stateid.equal view.next eop); + reach eop; vernac_interp id x; Proof_global.discard_all () + ), `Yes + | `Sync (name, reason) -> (fun () -> + prerr_endline ("Synchronous " ^ Stateid.to_string id ^ " " ^ + string_of_reason reason); + reach eop; + let wall_clock = Unix.gettimeofday () in + record_pb_time name x.loc (wall_clock -. !wall_clock_last_fork); + begin match keep with + | VtKeep -> + let proof = + Proof_global.close_proof (State.exn_on id ~valid:eop) in + reach view.next; + let wall_clock2 = Unix.gettimeofday () in + vernac_interp id ~proof x; + let wall_clock3 = Unix.gettimeofday () in + Aux_file.record_in_aux_at x.loc "proof_check_time" + (Printf.sprintf "%.3f" (wall_clock3 -. wall_clock2)) + | VtDrop -> + reach view.next; + vernac_interp id x + end; + Proof_global.discard_all () + ), `Yes + | `MaybeASync (start, nodes, name) -> (fun () -> + prerr_endline ("MaybeAsynchronous " ^ Stateid.to_string id); + reach ~cache:`Shallow start; + (* no sections *) + if List.is_empty (Environ.named_context (Global.env ())) + then fst (aux (`ASync (start, None, nodes, name))) () + else fst (aux (`Sync (name, `Unknown))) () + ), if redefine_qed then `No else `Yes + in + aux (collect_proof (view.next, x) brname brinfo eop) + | `Sideff (`Ast (x,_)) -> (fun () -> + reach view.next; vernac_interp id x + ), cache + | `Sideff (`Id origin) -> (fun () -> + let s = pure_cherry_pick_non_pstate origin in + reach view.next; + inject_non_pstate s + ), cache + in + if !Flags.async_proofs_mode = Flags.APonParallel 0 then + Pp.feedback ~state_id:id Interface.ProcessingInMaster; + State.define ~cache:cache_step ~redefine:redefine_qed step id; + prerr_endline ("reached: "^ Stateid.to_string id) in + reach ~redefine_qed id + +end (* }}} *) +let _ = Slaves.set_reach_known_state Reach.known_state + +(* The backtrack module simulates the classic behavior of a linear document *) +module Backtrack : sig + + val record : unit -> unit + val backto : Stateid.t -> unit + val back_safe : unit -> unit + + (* we could navigate the dag, but this ways easy *) + val branches_of : Stateid.t -> backup + + (* To be installed during initialization *) + val undo_vernac_classifier : vernac_expr -> vernac_classification + +end = struct (* {{{ *) + + let record () = + let current_branch = VCS.current_branch () in + let mine = current_branch, VCS.get_branch current_branch in + let info = VCS.get_info (VCS.get_branch_pos current_branch) in + let others = + CList.map_filter (fun b -> + if Vcs_.Branch.equal b current_branch then None + else Some(b, VCS.get_branch b)) (VCS.branches ()) in + info.vcs_backup <- Some (VCS.backup ()), Some { mine; others } + + let backto oid = + let info = VCS.get_info oid in + match info.vcs_backup with + | None, _ -> + anomaly(str"Backtrack.backto "++str(Stateid.to_string oid)++ + str": a state with no vcs_backup") + | Some vcs, _ -> + VCS.restore vcs; + let id = VCS.get_branch_pos (VCS.current_branch ()) in + if not (Stateid.equal id oid) then + anomaly (str "Backtrack.backto did not jump to the right state") + + let branches_of id = + let info = VCS.get_info id in + match info.vcs_backup with + | _, None -> + anomaly(str"Backtrack.backto "++str(Stateid.to_string id)++ + str": a state with no vcs_backup") + | _, Some x -> x + + let rec fold_until f acc id = + let next acc = + if id = Stateid.initial then raise Not_found + else fold_until f acc (VCS.visit id).next in + let info = VCS.get_info id in + match info.vcs_backup with + | None, _ -> next acc + | Some vcs, _ -> + let ids = + if id = Stateid.initial || id = Stateid.dummy then [] else + match VCS.visit id with + | { step = `Fork (_,_,_,l) } -> l + | { step = `Cmd (_,l) } -> l + | _ -> [] in + match f acc (id, vcs, ids) with + | `Stop x -> x + | `Cont acc -> next acc + + let back_safe () = + let id = + fold_until (fun n (id,_,_) -> + if n >= 0 && State.is_cached id then `Stop id else `Cont (succ n)) + 0 (VCS.get_branch_pos (VCS.current_branch ())) in + backto id + + let undo_vernac_classifier v = + try + match v with + | VernacResetInitial -> + VtStm (VtBack Stateid.initial, true), VtNow + | VernacResetName (_,name) -> + msg_warning + (str"Reset not implemented for automatically generated constants"); + let id = VCS.get_branch_pos (VCS.current_branch ()) in + (try + let oid = + fold_until (fun b (id,_,label) -> + if b then `Stop id else `Cont (List.mem name label)) + false id in + VtStm (VtBack oid, true), VtNow + with Not_found -> + VtStm (VtBack id, true), VtNow) + | VernacBack n -> + let id = VCS.get_branch_pos (VCS.current_branch ()) in + let oid = fold_until (fun n (id,_,_) -> + if Int.equal n 0 then `Stop id else `Cont (n-1)) n id in + VtStm (VtBack oid, true), VtNow + | VernacUndo n -> + let id = VCS.get_branch_pos (VCS.current_branch ()) in + let oid = fold_until (fun n (id,_,_) -> + if Int.equal n 0 then `Stop id else `Cont (n-1)) n id in + VtStm (VtBack oid, true), VtLater + | VernacUndoTo _ + | VernacRestart as e -> + let m = match e with VernacUndoTo m -> m | _ -> 0 in + let id = VCS.get_branch_pos (VCS.current_branch ()) in + let vcs = + match (VCS.get_info id).vcs_backup with + | None, _ -> anomaly(str"Backtrack: tip with no vcs_backup") + | Some vcs, _ -> vcs in + let cb, _ = + Vcs_aux.find_proof_at_depth vcs (Vcs_aux.proof_nesting vcs) in + let n = fold_until (fun n (_,vcs,_) -> + if List.mem cb (Vcs_.branches vcs) then `Cont (n+1) else `Stop n) + 0 id in + let oid = fold_until (fun n (id,_,_) -> + if Int.equal n 0 then `Stop id else `Cont (n-1)) (n-m-1) id in + VtStm (VtBack oid, true), VtLater + | VernacAbortAll -> + let id = VCS.get_branch_pos (VCS.current_branch ()) in + let oid = fold_until (fun () (id,vcs,_) -> + match Vcs_.branches vcs with [_] -> `Stop id | _ -> `Cont ()) + () id in + VtStm (VtBack oid, true), VtLater + | VernacBacktrack (id,_,_) + | VernacBackTo id -> + VtStm (VtBack (Stateid.of_int id), true), VtNow + | _ -> VtUnknown, VtNow + with + | Not_found -> + msg_warning(str"undo_vernac_classifier: going back to the initial state."); + VtStm (VtBack Stateid.initial, true), VtNow + +end (* }}} *) + +let init () = + VCS.init Stateid.initial; + set_undo_classifier Backtrack.undo_vernac_classifier; + State.define ~cache:`Yes (fun () -> ()) Stateid.initial; + Backtrack.record (); + if !Flags.async_proofs_mode = Flags.APonParallel 0 then begin + Slaves.init (); + let opts = match !Flags.async_proofs_worker_flags with + | None -> [] + | Some s -> Str.split_delim (Str.regexp ",") s in + if String.List.mem "fallback-to-lazy-if-marshal-error=no" opts then + fallback_to_lazy_if_marshal_error := false; + if String.List.mem "fallback-to-lazy-if-slave-dies=no" opts then + fallback_to_lazy_if_slave_dies := false; + begin try + let env_opt = Str.regexp "^extra-env=" in + let env = List.find (fun s -> Str.string_match env_opt s 0) opts in + async_proofs_workers_extra_env := Array.of_list + (Str.split_delim (Str.regexp ";") (Str.replace_first env_opt "" env)) + with Not_found -> () end; + end + +let slave_main_loop () = Slaves.slave_main_loop Ephemeron.clear + +let slave_init_stdout () = Slaves.slave_init_stdout () + +let observe id = + let vcs = VCS.backup () in + try + Reach.known_state ~cache:(interactive ()) id; + VCS.print () + with e -> + let e = Errors.push e in + VCS.print (); + VCS.restore vcs; + raise e + +let finish () = + observe (VCS.get_branch_pos (VCS.current_branch ())); + VCS.print () + +let wait () = + Slaves.wait_all_done (); + VCS.print () + +let join () = + let rec jab id = + if Stateid.equal id Stateid.initial then () + else + let view = VCS.visit id in + match view.step with + | `Qed ({ keep = VtDrop }, eop) -> + Future.purify observe eop; jab view.next + | _ -> jab view.next in + finish (); + wait (); + prerr_endline "Joining the environment"; + Global.join_safe_environment (); + VCS.print (); + prerr_endline "Joining the aborted proofs"; + jab (VCS.get_branch_pos VCS.Branch.master); + VCS.print () + +type tasks = Slaves.tasks * RemoteCounter.remote_counters_status +let dump x = Slaves.dump x, RemoteCounter.backup () +let check_task name (tasks,_) i = + let vcs = VCS.backup () in + try + let rc = Future.purify (Slaves.check_task name tasks) i in + Pp.pperr_flush (); + VCS.restore vcs; + rc + with e when Errors.noncritical e -> VCS.restore vcs; false +let info_tasks (tasks,_) = Slaves.info_tasks tasks +let finish_tasks name u d p (t,rcbackup as tasks) = + RemoteCounter.restore rcbackup; + let finish_task u (_,_,i) = + let vcs = VCS.backup () in + let u = Future.purify (Slaves.finish_task name u d p t) i in + Pp.pperr_flush (); + VCS.restore vcs; + u in + try + let u, a, _ = List.fold_left finish_task u (info_tasks tasks) in + (u,a,true), p + with e -> + let e = Errors.push e in + Pp.pperrnl Pp.(str"File " ++ str name ++ str ":" ++ spc () ++ print e); + exit 1 + +let merge_proof_branch qast keep brname = + let brinfo = VCS.get_branch brname in + let qed fproof = { qast; keep; brname; brinfo; fproof } in + match brinfo with + | { VCS.kind = `Proof _ } -> + VCS.checkout VCS.Branch.master; + let id = VCS.new_node () in + VCS.merge id ~ours:(Qed (qed None)) brname; + VCS.delete_branch brname; + if keep == VtKeep then VCS.propagate_sideff None; + `Ok + | { VCS.kind = `Edit (mode, qed_id, master_id) } -> + let ofp = + match VCS.visit qed_id with + | { step = `Qed ({ fproof }, _) } -> fproof + | _ -> assert false in + VCS.rewrite_merge qed_id ~ours:(Qed (qed ofp)) ~at:master_id brname; + VCS.delete_branch brname; + VCS.gc (); + Reach.known_state ~redefine_qed:true ~cache:`No qed_id; + VCS.checkout VCS.Branch.master; + `Unfocus qed_id + | { VCS.kind = `Master } -> + raise (State.exn_on Stateid.dummy Proof_global.NoCurrentProof) + +(* When tty is true, this code also does some of the job of the user interface: + jump back to a state that is valid *) +let handle_failure e vcs tty = + match Stateid.get e with + | None -> + VCS.restore vcs; + VCS.print (); + if tty && interactive () = `Yes then begin + (* Hopefully the 1 to last state is valid *) + Backtrack.back_safe (); + VCS.checkout_shallowest_proof_branch (); + end; + VCS.print (); + anomaly(str"error with no safe_id attached:" ++ spc() ++ + Errors.print_no_report e) + | Some (safe_id, id) -> + prerr_endline ("Failed at state " ^ Stateid.to_string id); + VCS.restore vcs; + if tty && interactive () = `Yes then begin + (* We stay on a valid state *) + Backtrack.backto safe_id; + VCS.checkout_shallowest_proof_branch (); + Reach.known_state ~cache:(interactive ()) safe_id; + end; + VCS.print (); + raise e + +let process_transaction ~tty verbose c (loc, expr) = + let warn_if_pos a b = + if b then msg_warning(pr_ast a ++ str" should not be part of a script") in + let v, x = expr, { verbose = verbose && Flags.is_verbose(); loc; expr } in + prerr_endline ("{{{ processing: "^ string_of_ppcmds (pr_ast x)); + let vcs = VCS.backup () in + try + let head = VCS.current_branch () in + VCS.checkout head; + let rc = begin + prerr_endline (" classified as: " ^ string_of_vernac_classification c); + match c with + (* PG stuff *) + | VtStm(VtPG,false), VtNow -> vernac_interp Stateid.dummy x; `Ok + | VtStm(VtPG,_), _ -> anomaly(str "PG command in script or VtLater") + (* Joining various parts of the document *) + | VtStm (VtJoinDocument, b), VtNow -> warn_if_pos x b; join (); `Ok + | VtStm (VtFinish, b), VtNow -> warn_if_pos x b; finish (); `Ok + | VtStm (VtWait, b), VtNow -> warn_if_pos x b; finish (); wait (); `Ok + | VtStm (VtPrintDag, b), VtNow -> + warn_if_pos x b; VCS.print ~now:true (); `Ok + | VtStm (VtObserve id, b), VtNow -> warn_if_pos x b; observe id; `Ok + | VtStm ((VtObserve _ | VtFinish | VtJoinDocument + |VtPrintDag |VtWait),_), VtLater -> + anomaly(str"classifier: join actions cannot be classified as VtLater") + + (* Back *) + | VtStm (VtBack oid, true), w -> + let id = VCS.new_node () in + let { mine; others } = Backtrack.branches_of oid in + List.iter (fun branch -> + if not (List.mem_assoc branch (mine::others)) then + ignore(merge_proof_branch x VtDrop branch)) + (VCS.branches ()); + VCS.checkout_shallowest_proof_branch (); + let head = VCS.current_branch () in + List.iter (fun b -> + if not(VCS.Branch.equal b head) then begin + VCS.checkout b; + VCS.commit (VCS.new_node ()) (Alias oid); + end) + (VCS.branches ()); + VCS.checkout_shallowest_proof_branch (); + VCS.commit id (Alias oid); + Backtrack.record (); if w == VtNow then finish (); `Ok + | VtStm (VtBack id, false), VtNow -> + prerr_endline ("undo to state " ^ Stateid.to_string id); + Backtrack.backto id; + VCS.checkout_shallowest_proof_branch (); + Reach.known_state ~cache:(interactive ()) id; `Ok + | VtStm (VtBack id, false), VtLater -> + anomaly(str"classifier: VtBack + VtLater must imply part_of_script") + + (* Query *) + | VtQuery false, VtNow when tty = true -> + finish (); + (try Future.purify (vernac_interp Stateid.dummy) + { verbose = true; loc; expr } + with e when Errors.noncritical e -> + let e = Errors.push e in + raise(State.exn_on Stateid.dummy e)); `Ok + | VtQuery false, VtNow -> + (try vernac_interp Stateid.dummy x + with e when Errors.noncritical e -> + let e = Errors.push e in + raise(State.exn_on Stateid.dummy e)); `Ok + | VtQuery true, w -> + let id = VCS.new_node () in + VCS.commit id (Cmd (x,[])); + Backtrack.record (); if w == VtNow then finish (); `Ok + | VtQuery false, VtLater -> + anomaly(str"classifier: VtQuery + VtLater must imply part_of_script") + + (* Proof *) + | VtStartProof (mode, guarantee, names), w -> + let id = VCS.new_node () in + let bname = VCS.mk_branch_name x in + VCS.checkout VCS.Branch.master; + VCS.commit id (Fork (x, bname, guarantee, names)); + VCS.branch bname (`Proof (mode, VCS.proof_nesting () + 1)); + Proof_global.activate_proof_mode mode; + Backtrack.record (); if w == VtNow then finish (); `Ok + | VtProofMode _, VtLater -> + anomaly(str"VtProofMode must be executed VtNow") + | VtProofMode mode, VtNow -> + let id = VCS.new_node () in + VCS.checkout VCS.Branch.master; + VCS.commit id (Cmd (x,[])); + VCS.propagate_sideff (Some x); + List.iter + (fun bn -> match VCS.get_branch bn with + | { VCS.root; kind = `Master; pos } -> () + | { VCS.root; kind = `Proof(_,d); pos } -> + VCS.delete_branch bn; + VCS.branch ~root ~pos bn (`Proof(mode,d)) + | { VCS.root; kind = `Edit(_,f,q); pos } -> + VCS.delete_branch bn; + VCS.branch ~root ~pos bn (`Edit(mode,f,q))) + (VCS.branches ()); + VCS.checkout_shallowest_proof_branch (); + Backtrack.record (); + finish (); + `Ok + | VtProofStep, w -> + let id = VCS.new_node () in + VCS.commit id (Cmd (x,[])); + Backtrack.record (); if w == VtNow then finish (); `Ok + | VtQed keep, w -> + let rc = merge_proof_branch x keep head in + VCS.checkout_shallowest_proof_branch (); + Backtrack.record (); if w == VtNow then finish (); + rc + + (* Side effect on all branches *) + | VtSideff l, w -> + let id = VCS.new_node () in + VCS.checkout VCS.Branch.master; + VCS.commit id (Cmd (x,l)); + VCS.propagate_sideff (Some x); + VCS.checkout_shallowest_proof_branch (); + Backtrack.record (); if w == VtNow then finish (); `Ok + + (* Unknown: we execute it, check for open goals and propagate sideeff *) + | VtUnknown, VtNow -> + let id = VCS.new_node () in + let step () = + VCS.checkout VCS.Branch.master; + let mid = VCS.get_branch_pos VCS.Branch.master in + Reach.known_state ~cache:(interactive ()) mid; + vernac_interp id x; + (* Vernac x may or may not start a proof *) + if VCS.Branch.equal head VCS.Branch.master && + Proof_global.there_are_pending_proofs () + then begin + let bname = VCS.mk_branch_name x in + VCS.commit id (Fork (x,bname,Doesn'tGuaranteeOpacity,[])); + VCS.branch bname (`Proof ("Classic", VCS.proof_nesting () + 1)); + Proof_global.activate_proof_mode "Classic"; + end else begin + VCS.commit id (Cmd (x,[])); + VCS.propagate_sideff (Some x); + VCS.checkout_shallowest_proof_branch (); + end in + State.define ~cache:`Yes step id; + Backtrack.record (); `Ok + + | VtUnknown, VtLater -> + anomaly(str"classifier: VtUnknown must imply VtNow") + end in + (* Proof General *) + begin match v with + | VernacStm (PGLast _) -> + if not (VCS.Branch.equal head VCS.Branch.master) then + vernac_interp Stateid.dummy + { verbose = true; loc = Loc.ghost; + expr = VernacShow (ShowGoal OpenSubgoals) } + | _ -> () + end; + prerr_endline "processed }}}"; + VCS.print (); + rc + with e -> + let e = Errors.push e in + handle_failure e vcs tty + +(** STM interface {{{******************************************************* **) + +let stop_worker n = Slaves.cancel_worker n + +let query ~at s = + Future.purify (fun s -> + if Stateid.equal at Stateid.dummy then finish () + else Reach.known_state ~cache:`Yes at; + let _, ast as loc_ast = vernac_parse 0 s in + let clas = classify_vernac ast in + match clas with + | VtStm (w,_), _ -> + ignore(process_transaction + ~tty:false true (VtStm (w,false), VtNow) loc_ast) + | _ -> + ignore(process_transaction + ~tty:false true (VtQuery false, VtNow) loc_ast)) + s + +let add ~ontop ?(check=ignore) verb eid s = + let cur_tip = VCS.cur_tip () in + if Stateid.equal ontop cur_tip then begin + let _, ast as loc_ast = vernac_parse eid s in + check(loc_ast); + let clas = classify_vernac ast in + match process_transaction ~tty:false verb clas loc_ast with + | `Ok -> VCS.cur_tip (), `NewTip + | `Unfocus qed_id -> qed_id, `Unfocus (VCS.cur_tip ()) + end else begin + (* For now, arbitrary edits should be announced with edit_at *) + anomaly(str"Not yet implemented, the GUI should not try this") + end + +let set_perspective id_list = Slaves.set_perspective id_list + +type focus = { + start : Stateid.t; + stop : Stateid.t; + tip : Stateid.t +} + +let edit_at id = + if Stateid.equal id Stateid.dummy then anomaly(str"edit_at dummy") else + let vcs = VCS.backup () in + let on_cur_branch id = + let rec aux cur = + if id = cur then true + else match VCS.visit cur with + | { step = `Fork _ } -> false + | { next } -> aux next in + aux (VCS.get_branch_pos (VCS.current_branch ())) in + let is_ancestor_of_cur_branch id = + Vcs_.NodeSet.mem id + (VCS.reachable (VCS.get_branch_pos (VCS.current_branch ()))) in + let has_failed qed_id = + match VCS.visit qed_id with + | { step = `Qed ({ fproof = Some (fp,_) }, _) } -> Future.is_exn fp + | _ -> false in + let rec master_for_br root tip = + if Stateid.equal tip Stateid.initial then tip else + match VCS.visit tip with + | { next } when next = root -> root + | { step = `Fork _ } -> tip + | { step = `Sideff (`Ast(_,id)|`Id id) } -> id + | { next } -> master_for_br root next in + let reopen_branch at_id mode qed_id tip = + VCS.delete_cluster_of id; + let master_id = + match VCS.visit qed_id with + | { step = `Qed _; next = master_id } -> master_id + | _ -> anomaly (str "Cluster not ending with Qed") in + VCS.branch ~root:master_id ~pos:id + VCS.edit_branch (`Edit (mode, qed_id, master_id)); + Reach.known_state ~cache:(interactive ()) id; + VCS.checkout_shallowest_proof_branch (); + `Focus { stop = qed_id; start = master_id; tip } in + let backto id = + List.iter VCS.delete_branch (VCS.branches ()); + let ancestors = VCS.reachable id in + let { mine = brname, brinfo; others } = Backtrack.branches_of id in + List.iter (fun (name,{ VCS.kind = k; root; pos }) -> + if not(VCS.Branch.equal name VCS.Branch.master) && + Vcs_.NodeSet.mem root ancestors then + VCS.branch ~root ~pos name k) + others; + VCS.reset_branch VCS.Branch.master (master_for_br brinfo.VCS.root id); + VCS.branch ~root:brinfo.VCS.root ~pos:brinfo.VCS.pos brname brinfo.VCS.kind; + VCS.delete_cluster_of id; + VCS.gc (); + Reach.known_state ~cache:(interactive ()) id; + VCS.checkout_shallowest_proof_branch (); + `NewTip in + try + let rc = + let focused = List.exists ((=) VCS.edit_branch) (VCS.branches ()) in + let branch_info = + match snd (VCS.get_info id).vcs_backup with + | Some{ mine = _, { VCS.kind = (`Proof(m,_)|`Edit(m,_,_)) }} -> Some m + | _ -> None in + match focused, VCS.cluster_of id, branch_info with + | _, Some _, None -> assert false + | false, Some qed_id, Some mode -> + let tip = VCS.cur_tip () in + if has_failed qed_id then reopen_branch id mode qed_id tip + else backto id + | true, Some qed_id, Some mode -> + if on_cur_branch id then begin + assert false + end else if is_ancestor_of_cur_branch id then begin + backto id + end else begin + anomaly(str"Cannot leave an `Edit branch open") + end + | true, None, _ -> + if on_cur_branch id then begin + VCS.reset_branch (VCS.current_branch ()) id; + Reach.known_state ~cache:(interactive ()) id; + VCS.checkout_shallowest_proof_branch (); + `NewTip + end else if is_ancestor_of_cur_branch id then begin + backto id + end else begin + anomaly(str"Cannot leave an `Edit branch open") + end + | false, None, _ -> backto id + in + VCS.print (); + rc + with e -> + let e = Errors.push e in + match Stateid.get e with + | None -> + VCS.print (); + anomaly (str ("edit_at: "^string_of_ppcmds (Errors.print_no_report e))) + | Some (_, id) -> + prerr_endline ("Failed at state " ^ Stateid.to_string id); + VCS.restore vcs; + VCS.print (); + raise e +(* }}} *) + +(** Old tty interface {{{*************************************************** **) + +let interp verb (_,e as lexpr) = + let clas = classify_vernac e in + let rc = process_transaction ~tty:true verb clas lexpr in + if rc <> `Ok then anomaly(str"tty loop can't be mixed with the STM protocol"); + if interactive () = `Yes || + (!Flags.async_proofs_mode = Flags.APoff && + !Flags.compilation_mode = Flags.BuildVo) then + let vcs = VCS.backup () in + try finish () + with e -> + let e = Errors.push e in + handle_failure e vcs true + +let get_current_state () = VCS.cur_tip () + +let current_proof_depth () = + let head = VCS.current_branch () in + match VCS.get_branch head with + | { VCS.kind = `Master } -> 0 + | { VCS.pos = cur; VCS.kind = (`Proof _ | `Edit _); VCS.root = root } -> + let rec distance root = + if Stateid.equal cur root then 0 + else 1 + distance (VCS.visit cur).next in + distance cur + +let unmangle n = + let n = VCS.Branch.to_string n in + let idx = String.index n '_' + 1 in + Names.id_of_string (String.sub n idx (String.length n - idx)) + +let proofname b = match VCS.get_branch b with + | { VCS.kind = (`Proof _| `Edit _) } -> Some b + | _ -> None + +let get_all_proof_names () = + List.map unmangle (List.map_filter proofname (VCS.branches ())) + +let get_current_proof_name () = + Option.map unmangle (proofname (VCS.current_branch ())) + +let get_script prf = + let branch, test = + match prf with + | None -> VCS.Branch.master, fun _ -> true + | Some name -> VCS.current_branch (), List.mem name in + let rec find acc id = + if Stateid.equal id Stateid.initial || + Stateid.equal id Stateid.dummy then acc else + let view = VCS.visit id in + match view.step with + | `Fork (_,_,_,ns) when test ns -> acc + | `Qed (qed, proof) -> find [qed.qast.expr, (VCS.get_info id).n_goals] proof + | `Sideff (`Ast (x,_)) -> + find ((x.expr, (VCS.get_info id).n_goals)::acc) view.next + | `Sideff (`Id id) -> find acc id + | `Cmd (x,_) -> find ((x.expr, (VCS.get_info id).n_goals)::acc) view.next + | `Alias id -> find acc id + | `Fork _ -> find acc view.next + in + find [] (VCS.get_branch_pos branch) + +(* indentation code for Show Script, initially contributed + by D. de Rauglaudre *) + +let indent_script_item ((ng1,ngl1),nl,beginend,ppl) (cmd,ng) = + (* ng1 : number of goals remaining at the current level (before cmd) + ngl1 : stack of previous levels with their remaining goals + ng : number of goals after the execution of cmd + beginend : special indentation stack for { } *) + let ngprev = List.fold_left (+) ng1 ngl1 in + let new_ngl = + if ng > ngprev then + (* We've branched *) + (ng - ngprev + 1, ng1 - 1 :: ngl1) + else if ng < ngprev then + (* A subgoal have been solved. Let's compute the new current level + by discarding all levels with 0 remaining goals. *) + let rec loop = function + | (0, ng2::ngl2) -> loop (ng2,ngl2) + | p -> p + in loop (ng1-1, ngl1) + else + (* Standard case, same goal number as before *) + (ng1, ngl1) + in + (* When a subgoal have been solved, separate this block by an empty line *) + let new_nl = (ng < ngprev) + in + (* Indentation depth *) + let ind = List.length ngl1 + in + (* Some special handling of bullets and { }, to get a nicer display *) + let pred n = max 0 (n-1) in + let ind, nl, new_beginend = match cmd with + | VernacSubproof _ -> pred ind, nl, (pred ind)::beginend + | VernacEndSubproof -> List.hd beginend, false, List.tl beginend + | VernacBullet _ -> pred ind, nl, beginend + | _ -> ind, nl, beginend + in + let pp = + (if nl then fnl () else mt ()) ++ + (hov (ind+1) (str (String.make ind ' ') ++ Ppvernac.pr_vernac cmd)) + in + (new_ngl, new_nl, new_beginend, pp :: ppl) + +let show_script ?proof () = + try + let prf = + try match proof with + | None -> Some (Pfedit.get_current_proof_name ()) + | Some (p,_) -> Some (p.Proof_global.id) + with Proof_global.NoCurrentProof -> None + in + let cmds = get_script prf in + let _,_,_,indented_cmds = + List.fold_left indent_script_item ((1,[]),false,[],[]) cmds + in + let indented_cmds = List.rev (indented_cmds) in + msg_notice (v 0 (Pp.prlist_with_sep Pp.fnl (fun x -> x) indented_cmds)) + with Vcs_aux.Expired -> () + +(* }}} *) + +(* vim:set foldmethod=marker: *) |
