1 (* Copyright (C) 2000, HELM Team.
3 * This file is part of HELM, an Hypertextual, Electronic
4 * Library of Mathematics, developed at the Computer Science
5 * Department, University of Bologna, Italy.
7 * HELM is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
12 * HELM is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with HELM; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
22 * For details, see the HELM World-Wide-Web page,
23 * http://cs.unibo.it/helm/.
26 (*****************************************************************************)
30 (* Claudio Sacerdoti Coen <sacerdot@cs.unibo.it> *)
33 (* This module implements a trival cache system (an hash-table) for cic *)
34 (* objects. Uses the getter (getter.ml) and the parser (cicParser.ml) *)
36 (*****************************************************************************)
39 (* ************************************************************************** *
40 CicEnvironment SETTINGS (trust and clean_tmp)
41 * ************************************************************************** *)
43 let cleanup_tmp = true;;
44 let trust = ref (fun _ -> true);;
45 let set_trust f = trust := f
46 let trust_obj uri = !trust uri
47 let debug_print = fun _ -> ()
49 (* ************************************************************************** *
51 * ************************************************************************** *)
53 type type_checked_obj =
54 CheckedObj of (Cic.obj * CicUniv.universe_graph) (* cooked obj *)
55 | UncheckedObj of Cic.obj (* uncooked obj to proof-check *)
58 exception AlreadyCooked of string;;
59 exception CircularDependency of string;;
60 exception CouldNotFreeze of string;;
61 exception CouldNotUnfreeze of string;;
62 exception Object_not_found of UriManager.uri;;
65 (* ************************************************************************** *
66 HERE STARTS THE CACHE MODULE
67 * ************************************************************************** *)
69 (* I think this should be the right place to implement mecanisms and
73 (* Cache that uses == instead of = for testing equality *)
74 (* Invariant: an object is always in at most one of the *)
75 (* following states: unchecked, frozen and cooked. *)
78 val find_or_add_to_unchecked :
81 (UriManager.uri -> Cic.obj * CicUniv.universe_graph option) ->
82 Cic.obj * CicUniv.universe_graph
84 UriManager.uri -> bool
85 val unchecked_to_frozen :
86 UriManager.uri -> unit
87 val frozen_to_cooked :
88 uri:UriManager.uri -> unit
90 UriManager.uri -> CicUniv.universe_graph -> unit
92 key:UriManager.uri -> Cic.obj * CicUniv.universe_graph
94 key:UriManager.uri -> (Cic.obj * CicUniv.universe_graph) -> unit
95 val remove: UriManager.uri -> unit
96 val dump_to_channel : ?callback:(string -> unit) -> out_channel -> unit
97 val restore_from_channel : ?callback:(string -> unit) -> in_channel -> unit
98 val empty : unit -> unit
99 val is_in_frozen: UriManager.uri -> bool
100 val is_in_unchecked: UriManager.uri -> bool
101 val is_in_cooked: UriManager.uri -> bool
102 val list_all_cooked_uris: unit -> UriManager.uri list
106 (*************************************************************************
108 The cacheOfCookedObjects will contain only objects with a valid universe
109 graph. valid means that not None (used if there is no universe file
110 in the universe generation phase).
111 **************************************************************************)
113 (* DATA: the data structure that implements the CACHE *)
116 type t = UriManager.uri
117 let equal = UriManager.eq
118 let hash = Hashtbl.hash
122 module HT = Hashtbl.Make(HashedType);;
124 let cacheOfCookedObjects = HT.create 1009;;
126 (* DATA: The parking lists
127 * the lists elements are (uri * (obj * universe_graph option))
128 * ( u, ( o, None )) means that the object has no universes file, this
129 * should happen only in the universe generation phase.
130 * FIXME: if the universe generation is integrated in the library
131 * exportation phase, the 'option' MUST be removed.
132 * ( u, ( o, Some g)) means that the object has a universes file,
136 (* frozen is used to detect circular dependency. *)
137 let frozen_list = ref [];;
138 (* unchecked is used to store objects just fetched, nothing more. *)
139 let unchecked_list = ref [];;
141 (* FIXED: should be ok even if not touched *)
142 (* used to hash cons uris on restore to grant URI structure unicity *)
144 let module C = Cic in
146 UriManager.uri_of_string (UriManager.string_of_uri uri)
148 let rec restore_in_term =
151 | C.Var (uri,exp_named_subst) ->
152 let uri' = recons uri in
153 let exp_named_subst' =
155 (function (uri,t) ->(recons uri,restore_in_term t))
158 C.Var (uri',exp_named_subst')
164 | Some t -> Some (restore_in_term t)
168 | C.Sort (C.Type u) ->
169 CicUniv.assert_univ u;
170 C.Sort (C.Type (CicUniv.recons_univ u))
172 | C.Implicit _ as t -> t
173 | C.Cast (te,ty) -> C.Cast (restore_in_term te, restore_in_term ty)
174 | C.Prod (n,s,t) -> C.Prod (n, restore_in_term s, restore_in_term t)
175 | C.Lambda (n,s,t) -> C.Lambda (n, restore_in_term s, restore_in_term t)
176 | C.LetIn (n,s,t) -> C.LetIn (n, restore_in_term s, restore_in_term t)
177 | C.Appl l -> C.Appl (List.map restore_in_term l)
178 | C.Const (uri,exp_named_subst) ->
179 let uri' = recons uri in
180 let exp_named_subst' =
182 (function (uri,t) -> (recons uri,restore_in_term t)) exp_named_subst
184 C.Const (uri',exp_named_subst')
185 | C.MutInd (uri,tyno,exp_named_subst) ->
186 let uri' = recons uri in
187 let exp_named_subst' =
189 (function (uri,t) -> (recons uri,restore_in_term t)) exp_named_subst
191 C.MutInd (uri',tyno,exp_named_subst')
192 | C.MutConstruct (uri,tyno,consno,exp_named_subst) ->
193 let uri' = recons uri in
194 let exp_named_subst' =
196 (function (uri,t) -> (recons uri,restore_in_term t)) exp_named_subst
198 C.MutConstruct (uri',tyno,consno,exp_named_subst')
199 | C.MutCase (uri,i,outty,t,pl) ->
200 C.MutCase (recons uri, i, restore_in_term outty, restore_in_term t,
201 List.map restore_in_term pl)
203 let len = List.length fl in
206 (fun (name, i, ty, bo) ->
207 (name, i, restore_in_term ty, restore_in_term bo))
212 let len = List.length fl in
215 (fun (name, ty, bo) -> (name, restore_in_term ty, restore_in_term bo))
218 C.CoFix (i, liftedfl)
221 C.Constant (name,bo,ty,params,attrs) ->
225 | Some bo -> Some (restore_in_term bo)
227 let ty' = restore_in_term ty in
228 let params' = List.map recons params in
229 C.Constant (name, bo', ty', params',attrs)
230 | C.CurrentProof (name,conjs,bo,ty,params,attrs) ->
233 (function (i,hyps,ty) ->
237 | Some (name,C.Decl t) ->
238 Some (name,C.Decl (restore_in_term t))
239 | Some (name,C.Def (bo,ty)) ->
243 | Some ty'' -> Some (restore_in_term ty'')
245 Some (name,C.Def (restore_in_term bo, ty'))) hyps,
249 let bo' = restore_in_term bo in
250 let ty' = restore_in_term ty in
251 let params' = List.map recons params in
252 C.CurrentProof (name, conjs', bo', ty', params',attrs)
253 | C.Variable (name,bo,ty,params,attrs) ->
257 | Some bo -> Some (restore_in_term bo)
259 let ty' = restore_in_term ty in
260 let params' = List.map recons params in
261 C.Variable (name, bo', ty', params',attrs)
262 | C.InductiveDefinition (tl,params,paramsno,attrs) ->
263 let params' = List.map recons params in
265 List.map (function (name, inductive, ty, constructors) ->
270 (function (name, ty) -> name, restore_in_term ty)
274 C.InductiveDefinition (tl', params', paramsno, attrs)
278 HT.clear cacheOfCookedObjects;
279 unchecked_list := [] ;
283 (* FIX: universe stuff?? *)
284 let dump_to_channel ?(callback = ignore) oc =
285 HT.iter (fun uri _ -> callback (UriManager.string_of_uri uri))
286 cacheOfCookedObjects;
287 Marshal.to_channel oc cacheOfCookedObjects []
290 (* FIX: universes stuff?? *)
291 let restore_from_channel ?(callback = ignore) ic =
292 let restored = Marshal.from_channel ic in
293 (* FIXME: should this empty clean the frozen and unchecked?
294 * if not, the only-one-empty-end-not-3 patch is wrong
299 callback (UriManager.string_of_uri k);
300 HT.add cacheOfCookedObjects
301 (UriManager.uri_of_string (UriManager.string_of_uri k))
302 (***********************************************
303 TSSI: FIXME add channel stuff for universes
304 ************************************************)
305 (restore_uris v, CicUniv.recons_graph u))
310 let is_in_frozen uri =
311 List.mem_assoc uri !frozen_list
314 let is_in_unchecked uri =
315 List.mem_assoc uri !unchecked_list
318 let is_in_cooked uri =
319 HT.mem cacheOfCookedObjects uri
323 (*******************************************************************
325 we need, in the universe generation phase, to traverse objects
326 that are not yet committed, so we search them in the frozen list.
327 Only uncommitted objects without a universe file (see the assertion)
328 can be searched with method
329 *******************************************************************)
331 let find_or_add_to_unchecked uri ~get_object_to_add =
333 let o,g = List.assq uri !unchecked_list in
335 (* FIXME: we accept both cases, as at the end of this function
336 * maybe the None universe outside the cache module should be
339 * another thing that should be removed if univ generation phase
340 * and lib exportation are unified.
342 None -> o,CicUniv.empty_ugraph
346 if List.mem_assq uri !frozen_list then
347 (* CIRCULAR DEPENDENCY DETECTED, print the error and raise *)
349 print_endline "\nCircularDependency!\nfrozen list: \n";
352 let su = UriManager.string_of_uri u in
353 let univ = if o = None then "NO_UNIV" else "" in
354 print_endline (su^" "^univ))
356 raise (CircularDependency (UriManager.string_of_uri uri))
359 if HT.mem cacheOfCookedObjects uri then
360 (* DOUBLE COOK DETECTED, raise the exception *)
361 raise (AlreadyCooked (UriManager.string_of_uri uri))
363 (* OK, it is not already frozen nor cooked *)
364 let obj,ugraph = get_object_to_add uri in
367 (* FIXME: not sure it is OK*)
368 None -> CicUniv.empty_ugraph
371 unchecked_list := (uri,(obj,ugraph))::!unchecked_list ;
375 let unchecked_to_frozen uri =
377 let obj,ugraph = List.assq uri !unchecked_list in
378 unchecked_list := List.remove_assq uri !unchecked_list ;
379 frozen_list := (uri,(obj,ugraph))::!frozen_list
381 Not_found -> raise (CouldNotFreeze (UriManager.string_of_uri uri))
385 (************************************************************
387 only object with a valid universe graph can be committed
389 this should disappear if the universe generation phase and the
390 library exportation are unified.
391 *************************************************************)
392 let frozen_to_cooked ~uri =
394 let obj,ugraph = List.assq uri !frozen_list in
397 assert false (* only NON dummy universes can be committed *)
399 CicUniv.assert_univs_have_uri g;
400 frozen_list := List.remove_assq uri !frozen_list ;
401 HT.add cacheOfCookedObjects uri (obj,g)
403 Not_found -> raise (CouldNotUnfreeze (UriManager.string_of_uri uri))
406 let can_be_cooked uri =
408 let obj,ugraph = List.assq uri !frozen_list in
409 (* FIXME: another thing to remove if univ generation phase and lib
410 * exportation are unified.
419 (* this function injects a real universe graph in a (uri, (obj, None))
420 * element of the frozen list.
422 * FIXME: another thing to remove if univ generation phase and lib
423 * exportation are unified.
425 let hack_univ uri real_ugraph =
427 let o,g = List.assq uri !frozen_list in
430 frozen_list := List.remove_assoc uri !frozen_list;
431 frozen_list := (uri,(o,Some real_ugraph))::!frozen_list;
434 "You are probably hacking an object already hacked or an"^
435 " object that has the universe file but is not"^
441 "You are hacking an object that is not in the"^
442 " frozen_list, this means you are probably generating an"^
443 " universe file for an object that already"^
444 " as an universe file");
448 let find_cooked ~key:uri = HT.find cacheOfCookedObjects uri ;;
450 let add_cooked ~key:uri (obj,ugraph) =
451 HT.add cacheOfCookedObjects uri (obj,ugraph)
456 * an object can be romeved from the cache only if we are not typechecking
457 * something. this means check and frozen must be empty.
460 if !frozen_list <> [] then
461 failwith "CicEnvironment.remove while type checking"
464 HT.remove cacheOfCookedObjects uri;
466 List.filter (fun (uri',_) -> not (UriManager.eq uri uri')) !unchecked_list
470 let list_all_cooked_uris () =
471 HT.fold (fun u _ l -> u::l) cacheOfCookedObjects []
477 (* ************************************************************************
478 HERE ENDS THE CACHE MODULE
479 * ************************************************************************ *)
481 (* exported cache functions *)
482 let dump_to_channel = Cache.dump_to_channel;;
483 let restore_from_channel = Cache.restore_from_channel;;
484 let empty = Cache.empty;;
486 let total_parsing_time = ref 0.0
488 let get_object_to_add uri =
490 let filename = Http_getter.getxml' uri in
492 match UriManager.bodyuri_of_uri uri with
495 if Http_getter.exists' bodyuri then
496 Some (Http_getter.getxml' bodyuri)
500 (* restarts the numbering of named universes (the ones inside the cic) *)
501 let _ = CicUniv.restart_numbering () in
504 let time = Unix.gettimeofday() in
505 let rc = CicParser.obj_of_xml uri filename bodyfilename in
506 total_parsing_time :=
507 !total_parsing_time +. ((Unix.gettimeofday()) -. time );
511 | CicParser.Getter_failure ("key_not_found", uri) ->
512 raise (Object_not_found (UriManager.uri_of_string uri))
515 let ugraph,filename_univ =
516 (* FIXME: decomment this when the universes will be part of the library
519 Http_getter.getxml' (
520 UriManager.uri_of_string (
521 (UriManager.string_of_uri uri) ^ ".univ"))
523 (Some (CicUniv.ugraph_of_xml filename_univ),Some filename_univ)
527 "WE HAVE NO UNIVERSE FILE FOR " ^ (UriManager.string_of_uri uri));
531 (**********************************************
532 TASSI: should fail when universes will be ON
533 ***********************************************)
534 (Some CicUniv.empty_ugraph,None)
537 with Http_getter_types.Key_not_found _ -> raise (Object_not_found uri)
540 (* this is the function to fetch the object in the unchecked list and
541 * nothing more (except returning it)
543 let find_or_add_to_unchecked uri =
544 Cache.find_or_add_to_unchecked uri ~get_object_to_add
546 (* set_type_checking_info uri *)
547 (* must be called once the type-checking of uri is finished *)
548 (* The object whose uri is uri is unfreezed *)
550 (* the replacement ugraph must be the one returned by the *)
551 (* typechecker, restricted with the CicUnivUtils.clean_and_fill *)
552 let set_type_checking_info ?(replace_ugraph=None) uri =
554 if not (Cache.can_be_cooked uri) && replace_ugraph <> None then begin
556 "?replace_ugraph must be None if you are not committing an "^
557 "object that has a universe graph associated "^
558 "(can happen only in the fase of universes graphs generation).");
562 match Cache.can_be_cooked uri, replace_ugraph with
566 "?replace_ugraph must be (Some ugraph) when committing an object that "^
567 "has no associated universe graph. If this is in make_univ phase you "^
568 "should drop this exception and let univ_make commit thi object with "^
572 (match replace_ugraph with
574 | Some g -> Cache.hack_univ uri g);
575 Cache.frozen_to_cooked uri
578 (* fetch, unfreeze and commit an uri to the cacheOfCookedObjects and
579 * return the object,ugraph
581 let add_trusted_uri_to_cache uri =
582 let o,u = find_or_add_to_unchecked uri in
583 Cache.unchecked_to_frozen uri;
584 set_type_checking_info uri;
586 Cache.find_cooked uri
587 with Not_found -> assert false
590 (* get the uri, if we trust it will be added to the cacheOfCookedObjects *)
591 let get_cooked_obj ?(trust=true) base_univ uri =
593 (* the object should be in the cacheOfCookedObjects *)
594 let o,u = Cache.find_cooked uri in
595 o,(CicUniv.merge_ugraphs base_univ u)
597 (* this should be an error case, but if we trust the uri... *)
598 if trust && trust_obj uri then
599 (* trusting means that we will fetch cook it on the fly *)
600 let o,u = add_trusted_uri_to_cache uri in
601 o,(CicUniv.merge_ugraphs base_univ u)
603 (* we don't trust the uri, so we fail *)
605 debug_print ("CACHE MISS: " ^ (UriManager.string_of_uri uri));
609 (* This has not the old semantic :( but is what the name suggests
611 * let is_type_checked ?(trust=true) uri =
613 * let _ = Cache.find_cooked uri in
617 * trust && trust_obj uri
620 * as the get_cooked_obj but returns a type_checked_obj
623 let is_type_checked ?(trust=true) base_univ uri =
625 let o,u = Cache.find_cooked uri in
626 CheckedObj (o,(CicUniv.merge_ugraphs base_univ u))
628 (* this should return UncheckedObj *)
629 if trust && trust_obj uri then
630 (* trusting means that we will fetch cook it on the fly *)
631 let o,u = add_trusted_uri_to_cache uri in
632 CheckedObj ( o, CicUniv.merge_ugraphs u base_univ )
634 let o,u = find_or_add_to_unchecked uri in
635 Cache.unchecked_to_frozen uri;
639 (* as the get cooked, but if not present the object is only fetched,
640 * not unfreezed and committed
642 let get_obj base_univ uri =
644 (* the object should be in the cacheOfCookedObjects *)
645 let o,u = Cache.find_cooked uri in
646 o,(CicUniv.merge_ugraphs base_univ u)
648 (* this should be an error case, but if we trust the uri... *)
649 let o,u = find_or_add_to_unchecked uri in
650 o,(CicUniv.merge_ugraphs base_univ u)
654 Cache.is_in_cooked uri || Cache.is_in_frozen uri || Cache.is_in_unchecked uri
656 let add_type_checked_obj uri (obj,ugraph) =
657 Cache.add_cooked ~key:uri (obj,ugraph)
659 let in_library uri = in_cache uri || Http_getter.exists' uri
661 let remove_obj = Cache.remove
664 Cache.list_all_cooked_uris ()
670 let o,ug = get_obj CicUniv.empty_ugraph u in
675 debug_print "Who has removed the uri in the meanwhile?";