package vscoq-language-server
VSCoq language server
Install
Dune Dependency
Authors
Maintainers
Sources
vscoq-language-server-2.1.7.tar.gz
md5=81c195fcbe9b23c26db9704a0b8e37f8
sha512=9b175796b231e3663b1cdd546fde898c1d19a6a4eb16671970797045e0e29acc008630634f0d15fa34a94ccc14a0c16d3851efbf0b74f3e1ac6ada1f1461f7e1
doc/src/vscoq-language-server.dm/executionManager.ml.html
Source file executionManager.ml
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937
(**************************************************************************) (* *) (* VSCoq *) (* *) (* Copyright INRIA and contributors *) (* (see version control and README file for authors & dates) *) (* *) (**************************************************************************) (* *) (* This file is distributed under the terms of the MIT License. *) (* See LICENSE file. *) (* *) (**************************************************************************) open Protocol open Protocol.LspWrapper open Scheduler open Types let Log log = Log.mk_log "executionManager" type feedback_message = Feedback.level * Loc.t option * Quickfix.t list * Pp.t type execution_status = | Success of Vernacstate.t option | Error of Pp.t Loc.located * Quickfix.t list option * Vernacstate.t option (* State to use for resiliency *) let success vernac_st = Success (Some vernac_st) let error loc qf msg vernac_st = Error ((loc,msg), qf, (Some vernac_st)) type sentence_id = Stateid.t type errored_sentence = sentence_id option module SM = Map.Make (Stateid) type sentence_state = | Done of execution_status | Delegated of DelegationManager.job_handle * (execution_status -> unit) option type delegation_mode = | CheckProofsInMaster | SkipProofs | DelegateProofsToWorkers of { number_of_workers : int } type options = { delegation_mode : delegation_mode; completion_options : Settings.Completion.t; enableDiagnostics : bool } let default_options = { delegation_mode = CheckProofsInMaster; completion_options = { enable = false; algorithm = StructuredSplitUnification; unificationLimit = 100; atomicFactor = 5.; sizeFactor = 5. }; enableDiagnostics = true; } let doc_id = ref (-1) let fresh_doc_id () = incr doc_id; !doc_id type document_id = int type coq_feedback_listener = int type state = { initial : Vernacstate.t; of_sentence : (sentence_state * feedback_message list) SM.t; (* ugly stuff to correctly dispatch Coq feedback *) doc_id : document_id; (* unique number used to interface with Coq's Feedback *) coq_feeder : coq_feedback_listener; sel_feedback_queue : (Feedback.route_id * sentence_id * feedback_message) Queue.t; sel_cancellation_handle : Sel.Event.cancellation_handle; overview: exec_overview; } let print_exec_overview overview = let {processing; processed; prepared } = overview in log @@ "--------- Prepared ranges ---------"; List.iter (fun r -> log @@ Range.to_string r) prepared; log @@ "-------------------------------------"; log @@ "--------- Processing ranges ---------"; List.iter (fun r -> log @@ Range.to_string r) processing; log @@ "-------------------------------------"; log @@ "--------- Processed ranges ---------"; List.iter (fun r -> log @@ Range.to_string r) processed; log @@ "-------------------------------------" let print_exec_overview_of_state st = print_exec_overview st.overview let options = ref default_options let set_options o = options := o let set_default_options () = options := default_options let is_diagnostics_enabled () = !options.enableDiagnostics let get_options () = !options type prepared_task = | PSkip of { id: sentence_id; error: Pp.t option } | PExec of executable_sentence | PQuery of executable_sentence | PDelegate of { terminator_id: sentence_id; opener_id: sentence_id; proof_using: Vernacexpr.section_subset_expr; last_step_id: sentence_id option; (* only for setting a proof remotely *) tasks: prepared_task list; } module ProofJob = struct type update_request = | UpdateExecStatus of sentence_id * execution_status | AppendFeedback of Feedback.route_id * Types.sentence_id * (Feedback.level * Loc.t option * Quickfix.t list * Pp.t) let appendFeedback (rid,sid) fb = AppendFeedback(rid,sid,fb) type t = { tasks : prepared_task list; initial_vernac_state : Vernacstate.t; doc_id : int; terminator_id : sentence_id; } let name = "proof" let binary_name = "vscoqtop_proof_worker.opt" let initial_pool_size = 1 end module ProofWorker = DelegationManager.MakeWorker(ProofJob) type event = | LocalFeedback of (Feedback.route_id * sentence_id * (Feedback.level * Loc.t option * Quickfix.t list * Pp.t)) Queue.t * Feedback.route_id * sentence_id * (Feedback.level * Loc.t option * Quickfix.t list * Pp.t) | ProofWorkerEvent of ProofWorker.delegation type events = event Sel.Event.t list let pr_event = function | LocalFeedback _ -> Pp.str "LocalFeedback" | ProofWorkerEvent event -> ProofWorker.pr_event event let inject_proof_event = Sel.Event.map (fun x -> ProofWorkerEvent x) let inject_proof_events st l = (st, List.map inject_proof_event l) let interp_error_recovery strategy st : Vernacstate.t = match strategy with | RSkip -> st | RAdmitted -> let f = Declare.Proof.save_admitted in let open Vernacstate in (* shadows Declare *) let { Interp.lemmas; program; _ } = st.interp in match lemmas with | None -> (* if Lemma failed *) st | Some lemmas -> let proof = Vernacstate.LemmaStack.get_top lemmas in let pm = NeList.head program in let result = try Ok(f ~pm ~proof) with e -> (* we also catch anomalies *) let e, info = Exninfo.capture e in Error (e, info) in match result with | Ok (pm) -> let lemmas = snd (Vernacstate.LemmaStack.pop lemmas) in let program = NeList.map_head (fun _ -> pm) program in Vernacstate.Declare.set (lemmas,program) [@ocaml.warning "-3"]; let interp = Vernacstate.Interp.freeze_interp_state () in { st with interp } | Error (Sys.Break, _ as exn) -> Exninfo.iraise exn | Error(_,_) -> st (* just a wrapper around vernac interp *) let interp_ast ~doc_id ~state_id ~st ~error_recovery ast = Feedback.set_id_for_feedback doc_id state_id; ParTactic.set_id_for_feedback doc_id state_id; Sys.(set_signal sigint (Signal_handle(fun _ -> raise Break))); let result = try Ok(Vernacinterp.interp_entry ~st ast,[]) with e -> (* we also catch anomalies *) let e, info = Exninfo.capture e in Error (e, info) in Sys.(set_signal sigint Signal_ignore); match result with | Ok (interp, events) -> (* log @@ "Executed: " ^ Stateid.to_string state_id ^ " " ^ (Pp.string_of_ppcmds @@ Ppvernac.pr_vernac ast) ^ " (" ^ (if Option.is_empty vernac_st.Vernacstate.lemmas then "no proof" else "proof") ^ ")"; *) let st = { st with interp } in st, success st, (*List.map inject_pm_event*) events | Error (Sys.Break, _ as exn) -> (* log @@ "Interrupted executing: " ^ (Pp.string_of_ppcmds @@ Ppvernac.pr_vernac ast); *) Exninfo.iraise exn | Error (e, info) -> (* log @@ "Failed to execute: " ^ Stateid.to_string state_id ^ " " ^ (Pp.string_of_ppcmds @@ Ppvernac.pr_vernac ast); *) let loc = Loc.get_loc info in let qf = Result.value ~default:[] @@ Quickfix.from_exception e in let msg = CErrors.iprint (e, info) in let status = error loc (Some qf) msg st in let st = interp_error_recovery error_recovery st in st, status, [] (* This adapts the Future API with our event model *) [%%if coq = "8.18"] let definition_using e s ~fixnames:_ ~using ~terms = Proof_using.definition_using e s ~using ~terms [%%elif coq = "8.19"] let definition_using = Proof_using.definition_using [%%endif] [%%if coq = "8.18" || coq = "8.19"] let add_using proof proof_using lemmas = let env = Global.env () in let sigma, _ = Declare.Proof.get_current_context proof in let initial_goals pf = Proofview.initial_goals Proof.((data pf).entry) in let terms = List.map (fun (_,_,x) -> x) (initial_goals (Declare.Proof.get proof)) in let names = Vernacstate.LemmaStack.get_all_proof_names lemmas in let using = definition_using env sigma ~fixnames:names ~using:proof_using ~terms in let vars = Environ.named_context env in Names.Id.Set.iter (fun id -> if not (List.exists Util.(Context.Named.Declaration.get_id %> Names.Id.equal id) vars) then CErrors.user_err Pp.(str "Unknown variable: " ++ Names.Id.print id ++ str ".")) using; let _, pstate = Declare.Proof.set_used_variables proof ~using in pstate [%%else] let add_using proof proof_using _ = Declare.Proof.set_proof_using proof proof_using |> snd [%%endif] let interp_qed_delayed ~proof_using ~state_id ~st = let lemmas = Option.get @@ st.Vernacstate.interp.lemmas in let f proof = let proof = add_using proof proof_using lemmas in let fix_exn = None in (* FIXME *) let f, assign = Future.create_delegate ~blocking:false ~name:"XX" fix_exn in Declare.Proof.close_future_proof ~feedback_id:state_id proof f, assign in let proof, assign = Vernacstate.LemmaStack.with_top lemmas ~f in let control = [] (* FIXME *) in let opaque = Vernacexpr.Opaque in let pending = CAst.make @@ Vernacexpr.Proved (opaque, None) in (*log "calling interp_qed_delayed done";*) let interp = Vernacinterp.interp_qed_delayed_proof ~proof ~st ~control pending in (*log "interp_qed_delayed done";*) let st = { st with interp } in st, success st, assign let insert_or_merge_range r ranges = let ranges = List.sort Range.compare (r :: ranges) in let rec insert_or_merge_sorted_ranges r1 = function | [] -> [r1] | r2 :: l -> if Range.included ~in_:r1 r2 then (*since the ranges are sorted, only r2 can be included in r1*) insert_or_merge_sorted_ranges r1 l else if Range.prefixes ~in_:r2 r1 then begin let range = Range.{start = r1.Range.start; end_ = r2.Range.end_} in insert_or_merge_sorted_ranges range l end else r1 :: (insert_or_merge_sorted_ranges r2 l) in insert_or_merge_sorted_ranges (List.hd ranges) (List.tl ranges) let rec remove_or_truncate_range r = function | [] -> [] | r1 :: l -> if Range.equals r r1 then l else if Range.strictly_included ~in_: r1 r then Range.{ start = r1.Range.start; end_ = r.Range.start} :: Range.{ start = r.Range.end_; end_ = r1.Range.end_} :: l else if Range.prefixes ~in_:r1 r then Range.{ start = r.Range.end_; end_ = r1.Range.end_} :: l else if Range.postfixes ~in_:r1 r then Range.{ start = r1.Range.start; end_ = r.Range.start} :: l else r1 :: (remove_or_truncate_range r l) let rec cut_from_range r = function | [] -> [] | r1 :: l -> let (<=) x y = Position.compare x y <= 0 in if r.Range.start <= r1.Range.start then l else if r.Range.start <= r1.Range.end_ then Range.{start = r1.Range.start; end_ = r.Range.start} :: l else r1 :: (cut_from_range r l) let cut_overview task state document = let range = match task with | PDelegate { terminator_id } -> Document.range_of_id_with_blank_space document terminator_id | PSkip { id } | PExec { id } | PQuery { id } -> Document.range_of_id_with_blank_space document id in let {prepared; processing; processed} = state.overview in let prepared = cut_from_range range prepared in let processing = cut_from_range range processing in let overview = {prepared; processing; processed} in {state with overview} let update_processed_as_Done s range overview = let {prepared; processing; processed} = overview in match s with | Success _ -> let processed = insert_or_merge_range range processed in let processing = remove_or_truncate_range range processing in let prepared = remove_or_truncate_range range prepared in {prepared; processing; processed} | Error _ -> let processing = remove_or_truncate_range range processing in let prepared = remove_or_truncate_range range prepared in {prepared; processing; processed} let update_processed id state document = let range = Document.range_of_id_with_blank_space document id in match SM.find id state.of_sentence with | (s, _) -> begin match s with | Done s -> let overview = update_processed_as_Done s range state.overview in {state with overview} | _ -> assert false (* delegated sentences born as such, cannot become it later *) end | exception Not_found -> log @@ "Trying to get overview with non-existing state id " ^ Stateid.to_string id; state let invalidate_processed id state document = match SM.find id state.of_sentence with | (s, _) -> begin match s with | Done _ -> let range = Document.range_of_id_with_blank_space document id in let {processed} = state.overview in let processed = remove_or_truncate_range range processed in let overview = {state.overview with processed} in {state with overview} | _ -> assert false (* delegated sentences born as such, cannot become it later *) end | exception Not_found -> log @@ "Trying to get overview with non-existing state id " ^ Stateid.to_string id; state let invalidate_prepared_or_processing task state document = let {prepared; processing} = state.overview in match task with | PDelegate { opener_id; terminator_id; tasks } -> let proof_opener_id = match tasks with | [] -> opener_id | (PSkip { id } | PExec { id } | PQuery { id }) :: _ -> id | PDelegate _ :: _ -> assert false in let proof_closer_id = match List.rev tasks with | [] -> terminator_id | (PSkip { id } | PExec { id } | PQuery { id }) :: _ -> id | PDelegate _ :: _ -> assert false in let proof_begin_range = Document.range_of_id_with_blank_space document proof_opener_id in let proof_end_range = Document.range_of_id_with_blank_space document proof_closer_id in let range = Range.create ~end_:proof_end_range.end_ ~start:proof_begin_range.start in (* When a job is delegated we shouldn't merge ranges (to get the proper progress report) *) let prepared = remove_or_truncate_range range prepared in let processing = remove_or_truncate_range range processing in let overview = {state.overview with prepared; processing} in {state with overview} | PSkip { id } | PExec { id } | PQuery { id } -> let range = Document.range_of_id_with_blank_space document id in let prepared = remove_or_truncate_range range prepared in let processing = remove_or_truncate_range range processing in let overview = {state.overview with prepared; processing} in {state with overview} let update_processing task state document = let {processing; prepared} = state.overview in match task with | PDelegate { opener_id; terminator_id; tasks } -> let proof_opener_id = match tasks with | [] -> opener_id | (PSkip { id } | PExec { id } | PQuery { id }) :: _ -> id | PDelegate _ :: _ -> assert false in let proof_closer_id = match List.rev tasks with | [] -> terminator_id | (PSkip { id } | PExec { id } | PQuery { id }) :: _ -> id | PDelegate _ :: _ -> assert false in let proof_begin_range = Document.range_of_id_with_blank_space document proof_opener_id in let proof_end_range = Document.range_of_id_with_blank_space document proof_closer_id in let range = Range.create ~end_:proof_end_range.end_ ~start:proof_begin_range.start in (* When a job is delegated we shouldn't merge ranges (to get the proper progress report) *) let processing = List.append processing [ range ] in let prepared = remove_or_truncate_range range prepared in let overview = {state.overview with prepared; processing} in {state with overview} | PSkip { id } | PExec { id } | PQuery { id } -> let range = Document.range_of_id_with_blank_space document id in let processing = insert_or_merge_range range processing in let prepared = remove_or_truncate_range range prepared in let overview = {state.overview with processing; prepared} in {state with overview} let update_prepared task document state = let {prepared} = state.overview in match task with | PDelegate { opener_id; terminator_id; tasks } -> let proof_opener_id = match tasks with | [] -> opener_id | (PSkip { id } | PExec { id } | PQuery { id }) :: _ -> id | PDelegate _ :: _ -> assert false in let proof_closer_id = match List.rev tasks with | [] -> terminator_id | (PSkip { id } | PExec { id } | PQuery { id }) :: _ -> id | PDelegate _ :: _ -> assert false in let proof_begin_range = Document.range_of_id_with_blank_space document proof_opener_id in let proof_end_range = Document.range_of_id_with_blank_space document proof_closer_id in let range = Range.create ~end_:proof_end_range.end_ ~start:proof_begin_range.start in (* When a job is delegated we shouldn't merge ranges (to get the proper progress report) *) let prepared = List.append prepared [ range ] in let overview = {state.overview with prepared} in {state with overview} | PSkip { id } | PExec { id } | PQuery { id } -> let range = Document.range_of_id_with_blank_space document id in let prepared = insert_or_merge_range range prepared in let overview = {state.overview with prepared} in {state with overview} let update_overview task todo state document = let state = match task with | PDelegate { terminator_id } -> let range = Document.range_of_id_with_blank_space document terminator_id in let {prepared} = state.overview in let prepared = remove_or_truncate_range range prepared in let overview = update_processed_as_Done (Success None) range state.overview in let overview = {overview with prepared} in {state with overview} | PSkip { id } | PExec { id } | PQuery { id } -> update_processed id state document in match todo with | [] -> state | next :: _ -> update_processing next state document let prepare_overview st prepared = let overview = {st.overview with prepared} in {st with overview} let overview st = st.overview let overview_until_range st range = let find_final_range l = List.find_opt (fun (r: Range.t) -> Range.included ~in_:r range) l in let {processed; processing; prepared} = st.overview in let final_range = find_final_range processed in match final_range with | None -> let final_range = find_final_range processing in begin match final_range with | None -> { processed; processing; prepared } | Some { start } -> let processing = (List.filter (fun (r: Range.t) -> not @@ Range.included ~in_:r range) processing) in let processing = List.append processing [Range.create ~start:start ~end_:range.end_] in {processing; processed; prepared} end | Some { start } -> let processed = (List.filter (fun (r: Range.t) -> (not @@ Range.included ~in_:r range) && (Position.compare r.start range.end_ <= 0)) processed) in let processed = List.append processed [Range.create ~start:start ~end_:range.end_] in print_exec_overview {processing; processed;prepared}; { processing; processed; prepared } let update_all id v fl state = { state with of_sentence = SM.add id (v, fl) state.of_sentence } ;; let update state id v = let fl = try snd (SM.find id state.of_sentence) with Not_found -> [] in update_all id (Done v) fl state ;; let local_feedback feedback_queue : event Sel.Event.t = Sel.On.queue ~name:"feedback" ~priority:PriorityManager.feedback feedback_queue (fun (rid,sid,msg) -> LocalFeedback(feedback_queue,rid,sid,msg)) let install_feedback_listener doc_id send = Log.feedback_add_feeder_on_Message (fun route span doc lvl loc qf msg -> if lvl != Feedback.Debug && doc = doc_id then send (route,span,(lvl,loc, qf, msg))) let init vernac_state = let doc_id = fresh_doc_id () in let sel_feedback_queue = Queue.create () in let coq_feeder = install_feedback_listener doc_id (fun x -> Queue.push x sel_feedback_queue) in let event = local_feedback sel_feedback_queue in let sel_cancellation_handle = Sel.Event.get_cancellation_handle event in { initial = vernac_state; of_sentence = SM.empty; doc_id; coq_feeder; sel_feedback_queue; sel_cancellation_handle; overview = empty_overview; }, event (* called by the forked child. Since the Feedback API is imperative, the feedback pipes have to be modified in place *) let feedback_cleanup { coq_feeder; sel_feedback_queue; sel_cancellation_handle } = Feedback.del_feeder coq_feeder; Queue.clear sel_feedback_queue; Sel.Event.cancel sel_cancellation_handle let handle_feedback id fb state = match fb with | (_, _, _, msg) -> begin match SM.find id state.of_sentence with | (s,fl) -> update_all id s (fb::fl) state | exception Not_found -> log @@ "Received feedback on non-existing state id " ^ Stateid.to_string id ^ ": " ^ Pp.string_of_ppcmds msg; state end let handle_event event state = match event with | LocalFeedback (q,_,id,fb) -> None, Some (handle_feedback id fb state), [local_feedback q] | ProofWorkerEvent event -> let update, events = ProofWorker.handle_event event in let state, id = match update with | None -> None, None | Some (ProofJob.AppendFeedback(_,id,fb)) -> Some (handle_feedback id fb state), None | Some (ProofJob.UpdateExecStatus(id,v)) -> match SM.find id state.of_sentence, v with | (Delegated (_,completion), fl), _ -> Option.default ignore completion v; Some (update_all id (Done v) fl state), Some id | (Done (Success s), fl), Error (err,qf, _) -> (* This only happens when a Qed closing a delegated proof receives an updated by a worker saying that the proof is not completed *) Some (update_all id (Done (Error (err,qf,s))) fl state), Some id | (Done _, _), _ -> None, Some id | exception Not_found -> None, None (* TODO: is this possible? *) in let state, events = inject_proof_events state events in id, state, events let find_fulfilled_opt x m = try let ss,_ = SM.find x m in match ss with | Done x -> Some x | Delegated _ -> None with Not_found -> None let jobs : (DelegationManager.job_handle * Sel.Event.cancellation_handle * ProofJob.t) Queue.t = Queue.create () (* TODO: kill all Delegated... *) let destroy st = feedback_cleanup st; Queue.iter (fun (h,c,_) -> DelegationManager.cancel_job h; Sel.Event.cancel c) jobs let last_opt l = try Some (CList.last l).id with Failure _ -> None let prepare_task task : prepared_task list = match task with | Skip { id; error } -> [PSkip { id; error }] | Exec e -> [PExec e] | Query e -> [PQuery e] | OpaqueProof { terminator; opener_id; tasks; proof_using} -> match !options.delegation_mode with | DelegateProofsToWorkers _ -> log "delegating proofs to workers"; let last_step_id = last_opt tasks in let tasks = List.map (fun x -> PExec x) tasks in [PDelegate {terminator_id = terminator.id; opener_id; last_step_id; tasks; proof_using}] | CheckProofsInMaster -> log "running the proof in master as per config"; List.map (fun x -> PExec x) tasks @ [PExec terminator] | SkipProofs -> log (Printf.sprintf "skipping proof made of %d tasks" (List.length tasks)); [PExec terminator] let id_of_prepared_task = function | PSkip { id } -> id | PExec ex -> ex.id | PQuery ex -> ex.id | PDelegate { terminator_id } -> terminator_id let purge_state = function | Success _ -> Success None | Error(e,_,_) -> Error (e,None,None) (* TODO move to proper place *) let worker_execute ~doc_id ~send_back (vs,events) = function | PSkip { id; error = err } -> let v = match err with | None -> success vs | Some msg -> error None None msg vs in send_back (ProofJob.UpdateExecStatus (id,purge_state v)); (vs, events) | PExec { id; ast; synterp; error_recovery } -> let vs = { vs with Vernacstate.synterp } in log ("worker interp " ^ Stateid.to_string id); let vs, v, ev = interp_ast ~doc_id ~state_id:id ~st:vs ~error_recovery ast in send_back (ProofJob.UpdateExecStatus (id,purge_state v)); (vs, events @ ev) | _ -> assert false (* The execution of Qed for a non-delegated proof checks the proof is completed. When the proof is delegated this step is performed by the worker, which sends back an update on the Qed sentence in case the proof is unfinished *) let worker_ensure_proof_is_over vs send_back terminator_id = let f = Declare.Proof.close_proof in let open Vernacstate in (* shadows Declare *) let { Interp.lemmas } = vs.interp in match lemmas with | None -> assert false | Some lemmas -> let proof = Vernacstate.LemmaStack.get_top lemmas in try let _ = f ~opaque:Vernacexpr.Opaque ~keep_body_ucst_separate:false proof in () with e -> let e, info = Exninfo.capture e in let loc = Loc.get_loc info in let qf = Result.value ~default:[] @@ Quickfix.from_exception e in let msg = CErrors.iprint (e, info) in let status = error loc (Some qf) msg vs in send_back (ProofJob.UpdateExecStatus (terminator_id,status)) let worker_main { ProofJob.tasks; initial_vernac_state = vs; doc_id; terminator_id } ~send_back = try let vs, _ = List.fold_left (worker_execute ~doc_id ~send_back) (vs,[]) tasks in worker_ensure_proof_is_over vs send_back terminator_id; flush_all (); exit 0 with e -> let e, info = Exninfo.capture e in let message = CErrors.iprint_no_report (e, info) in Feedback.msg_debug @@ Pp.str "======================= worker ==========================="; Feedback.msg_debug message; Feedback.msg_debug @@ Pp.str "=========================================================="; exit 1 let execute st (vs, events, interrupted) task = if interrupted then begin let st = update st (id_of_prepared_task task) (Error ((None,Pp.str "interrupted"),None,None)) in (st, vs, events, true, None) end else try match task with | PSkip { id; error = err } -> let v = match err with | None -> success vs | Some msg -> error None None msg vs in let st = update st id v in (st, vs, events, false, None) | PExec { id; ast; synterp; error_recovery } -> let vs = { vs with Vernacstate.synterp } in let vs, v, ev = interp_ast ~doc_id:st.doc_id ~state_id:id ~st:vs ~error_recovery ast in let exec_error = match v with | Success _ -> None | Error _ -> Some id in let st = update st id v in (st, vs, events @ ev, false, exec_error) | PQuery { id; ast; synterp; error_recovery } -> let vs = { vs with Vernacstate.synterp } in let _, v, ev = interp_ast ~doc_id:st.doc_id ~state_id:id ~st:vs ~error_recovery ast in let st = update st id v in (st, vs, events @ ev, false, None) | PDelegate { terminator_id; opener_id; last_step_id; tasks; proof_using } -> begin match find_fulfilled_opt opener_id st.of_sentence with | Some (Success _) -> let job = { ProofJob.tasks; initial_vernac_state = vs; doc_id = st.doc_id; terminator_id } in let job_id = DelegationManager.mk_job_handle (0,terminator_id) in (* The proof was successfully opened *) let last_vs, _v, assign = interp_qed_delayed ~state_id:terminator_id ~proof_using ~st:vs in let complete_job status = try match status with | Success None -> log "Resolved future (without sending back the witness)"; assign (`Exn (Failure "no proof",Exninfo.null)) | Success (Some vernac_st) -> let f proof = log "Resolved future"; assign (`Val (Declare.Proof.return_proof proof)) in Vernacstate.LemmaStack.with_top (Option.get @@ vernac_st.Vernacstate.interp.lemmas) ~f | Error ((loc,err),_,_) -> log "Aborted future"; assign (`Exn (CErrors.UserError err, Option.fold_left Loc.add_loc Exninfo.null loc)) with exn when CErrors.noncritical exn -> assign (`Exn (CErrors.UserError(Pp.str "error closing proof"), Exninfo.null)) in let st = update st terminator_id (success last_vs) in let st = List.fold_left (fun st id -> if Option.equal Stateid.equal (Some id) last_step_id then update_all id (Delegated (job_id,Some complete_job)) [] st else update_all id (Delegated (job_id,None)) [] st) st (List.map id_of_prepared_task tasks) in let e = ProofWorker.worker_available ~jobs ~fork_action:worker_main ~feedback_cleanup:(fun () -> feedback_cleanup st) in Queue.push (job_id, Sel.Event.get_cancellation_handle e, job) jobs; (st, last_vs,events @ [inject_proof_event e] ,false, None) | _ -> (* If executing the proof opener failed, we skip the proof *) let st = update st terminator_id (success vs) in (st, vs,events,false, None) end with Sys.Break -> let st = update st (id_of_prepared_task task) (Error ((None,Pp.str "interrupted"),None,None)) in (st, vs, events, true, None) let build_tasks_for document sch st id block = let rec build_tasks id tasks st = begin match find_fulfilled_opt id st.of_sentence with | Some (Success (Some vs)) -> (* We reached an already computed state *) log @@ "Reached computed state " ^ Stateid.to_string id; vs, tasks, st, None | Some (Error(_,_,Some vs)) -> (* We try to be resilient to an error *) log @@ "Error resiliency on state " ^ Stateid.to_string id; vs, tasks, st, Some id | _ -> log @@ "Non (locally) computed state " ^ Stateid.to_string id; let (base_id, task) = task_for_sentence sch id in begin match base_id with | None -> (* task should be executed in initial state *) st.initial, task :: tasks, st, None | Some base_id -> build_tasks base_id (task::tasks) st end end in let rec build_prepared_overview tasks state = begin match tasks with | [] -> state | task :: l -> build_prepared_overview l (update_prepared task document state) end in let vs, tasks, st, error_id = build_tasks id [] st in match error_id, block with | _, false | None, _ -> let prepared_tasks = List.concat_map prepare_task tasks in let st = build_prepared_overview prepared_tasks st in vs, prepared_tasks, st, None | Some id, true -> vs, [], st, Some id let all_errors st = List.fold_left (fun acc (id, (p,_)) -> match p with | Done (Error ((loc,e),qf,_)) -> (id,(loc,e,qf)) :: acc | _ -> acc) [] @@ SM.bindings st.of_sentence let error st id = match SM.find_opt id st.of_sentence with | Some (Done (Error (err,_,_)), _) -> Some err | _ -> None let feedback st id = match SM.find_opt id st.of_sentence with | None -> [] | Some (_st, l) -> l let all_feedback st = List.fold_left (fun acc (id, (_,l)) -> List.map (fun x -> (id, x)) l @ acc) [] @@ SM.bindings st.of_sentence let shift_overview st ~before ~after ~start ~offset = let shift_loc loc_start loc_end = if loc_start >= start then (loc_start + offset, loc_end + offset) else if loc_end > start then (loc_start, loc_end + offset) else (loc_start, loc_end) in let shift_range range = let r_start = RawDocument.loc_of_position before range.Range.start in let r_stop = RawDocument.loc_of_position before range.Range.end_ in let r_start', r_stop' = shift_loc r_start r_stop in Range.create ~start:(RawDocument.position_of_loc after r_start') ~end_:(RawDocument.position_of_loc after r_stop') in let processed = CList.Smart.map shift_range st.overview.processed in let processing = CList.Smart.map shift_range st.overview.processing in let prepared = CList.Smart.map shift_range st.overview.prepared in let overview = {processed; processing; prepared} in {st with overview} let shift_diagnostics_locs st ~start ~offset = let shift_loc loc = let (loc_start, loc_stop) = Loc.unloc loc in if loc_start >= start then Loc.shift_loc offset offset loc else if loc_stop > start then Loc.shift_loc 0 offset loc else loc in let shift_feedback (level, oloc, qf, msg as feedback) = match oloc with | None -> feedback | Some loc -> let loc' = shift_loc loc in if loc' == loc then feedback else (level, Some loc', qf, msg) in let shift_error (sentence_state, feedbacks as orig) = let sentence_state' = match sentence_state with | Done (Error ((Some loc,e),qf,st)) -> let loc' = shift_loc loc in if loc' == loc then sentence_state else Done (Error ((Some loc',e),qf,st)) | _ -> sentence_state in let feedbacks' = CList.Smart.map shift_feedback feedbacks in if sentence_state' == sentence_state && feedbacks' == feedbacks then orig else (sentence_state', feedbacks') in { st with of_sentence = SM.map shift_error st.of_sentence } let executed_ids st = SM.fold (fun id (p,_) acc -> match p with | Done _ -> id :: acc | _ -> acc) st.of_sentence [] let is_executed st id = match find_fulfilled_opt id st.of_sentence with | Some (Success (Some _) | Error (_,_,Some _)) -> true | _ -> false let is_remotely_executed st id = match find_fulfilled_opt id st.of_sentence with | Some (Success None | Error (_,_,None)) -> true | _ -> false let invalidate1 of_sentence id = try let p,_ = SM.find id of_sentence in match p with | Delegated (job_id,_) -> DelegationManager.cancel_job job_id; SM.remove id of_sentence | _ -> SM.remove id of_sentence with Not_found -> of_sentence let rec invalidate document schedule id st = log @@ "Invalidating: " ^ Stateid.to_string id; let st = invalidate_processed id st document in let of_sentence = invalidate1 st.of_sentence id in let old_jobs = Queue.copy jobs in let removed = ref [] in Queue.clear jobs; Queue.iter (fun ((_, cancellation, { ProofJob.terminator_id; tasks }) as job) -> if terminator_id != id then Queue.push job jobs else begin Sel.Event.cancel cancellation; removed := tasks :: !removed end) old_jobs; let of_sentence = List.fold_left invalidate1 of_sentence List.(concat (map (fun tasks -> map id_of_prepared_task tasks) !removed)) in let rec invalidate_prepared_or_processing_tasks tasks st = begin match tasks with | [] -> st | task :: l -> invalidate_prepared_or_processing_tasks l (invalidate_prepared_or_processing task st document) end in let st = invalidate_prepared_or_processing_tasks (List.concat !removed) st in if of_sentence == st.of_sentence then st else let deps = Scheduler.dependents schedule id in Stateid.Set.fold (invalidate document schedule) deps { st with of_sentence } let context_of_state st = Vernacstate.Interp.unfreeze_interp_state st; begin match st.lemmas with | None -> let env = Global.env () in let sigma = Evd.from_env env in sigma, env | Some lemmas -> let open Declare in let open Vernacstate in lemmas |> LemmaStack.with_top ~f:Proof.get_current_context end let get_context st id = match find_fulfilled_opt id st.of_sentence with | None -> log "Cannot find state for get_context"; None | Some (Error _) -> log "Context requested in error state"; None | Some (Success None) -> log "Context requested in a remotely checked state"; None | Some (Success (Some { interp = st })) -> Some (context_of_state st) let get_initial_context st = context_of_state st.initial.Vernacstate.interp let get_vernac_state st id = match find_fulfilled_opt id st.of_sentence with | None -> log "Cannot find state for get_context"; None | Some (Error (_,_,None)) -> log "State requested after error with no state"; None | Some (Success None) -> log "State requested in a remotely checked state"; None | Some (Success (Some st)) | Some (Error (_,_, Some st)) -> Some st module ProofWorkerProcess = struct type options = ProofWorker.options let parse_options = ProofWorker.parse_options let main ~st:_ options = let send_back, job = ProofWorker.setup_plumbing options in worker_main job ~send_back let log = ProofWorker.log end
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>