(** Properties about the hashmap *) module Hashmap.Properties open Primitives open FStar.List.Tot open FStar.Mul open Hashmap.Types open Hashmap.Clauses open Hashmap.Funs // To help with the proofs - TODO: remove module InteractiveHelpers = FStar.InteractiveHelpers #set-options "--z3rlimit 50 --fuel 0 --ifuel 1" /// The proofs actually caused a lot more trouble than expected, because of the /// below points. All those are problems I already encountered in the past, but: /// /// - the fact that I spent 9 months mostly focusing on Aeneas made me forget them /// a bit /// - they seem exacerbated by the fact that they really matter when doing /// functional correctness proofs, while Aeneas allows me to focus on the /// functional behaviour of my programs. /// /// As a simple example, when I implemented linked lists (with loops) in Low* /// for Noise*, most of the work consisted in making the Low* proofs work /// (which was painful). /// /// There was a bit of functional reasoning (for which I already encountered the /// below issues), but it was pretty simple and shadowed by the memory management /// part. In the current situation, as we got rid of the memory management annoyance, /// we could move on to the more the complex hash maps where the functional correctness /// proofs *actually* require some work, making extremely obvious the problems F* has /// when dealing with this kind of proofs. /// /// Here, I would like to emphasize the fact that if hash maps *do* have interesting /// functional properties to study, I don't believe those properties are *intrinsically* /// complex. In particular, I am very eager to try to do the same proofs in Coq or /// HOL4, which I believe are more suited to this kind of proofs, and see how things go. /// I'm aware that those provers also suffer from drawbacks, but I believe those are /// less severe than F* in the present case. /// /// The problems I encountered (once again, all this is well known): /// /// - we are blind when doing the proofs. After a very intensive use of F* I got /// used to it meaning I *can* do proofs in F*, but it still takes me a tremendous /// amout of energy to visualize the context in my head and, for instance, /// properly instantiate the lemmas or insert the necessary assertions in the code. /// I actually often write assertions that I assume just to *check* that those /// assertions make the proofs pass and are thus indeed the ones I want to prove, /// which is something very specific to working with F*. /// /// - F* is extremely bad at reasoning with quantifiers, which is made worse by /// the fact we are blind when making proofs. This forced me to be extremely /// careful about the way I wrote the specs/invariants (by writing "functional" /// specs and invariants, mostly, so as not to manipulate quantifiers). /// /// In particular, I had to cut the proofs into many steps just for this reason, /// while if I had been able to properly use quantifiers (I tried: in many /// situations I manage to massage F* to make it work, but in the below proofs /// it was horrific) I would have proven many results in one go. /// /// More specifically: the hash map has an invariant stating that all the keys /// are pairwise disjoint. This invariant is extremely simple to write with /// forall quantifiers and looks like the following: /// `forall i j. i <> j ==> key_at i hm <> key_at j hm` /// /// If you can easily manipulate forall quantifiers, you can prove that the /// invariant is maintained by, say, the insertion functions in one go. /// /// However here, because I couldn't make the quantification work (and I really /// tried hard, because this is a very natural way of doing the proofs), I had /// to resort to invariants written in terms of [pairwise_rel]. This is /// extremely annoying, because then the process becomes: /// - prove that the insertion, etc. functions refine some higher level functions /// (that I have to introduce) /// - prove that those higher level functions preserve the invariants /// /// All this results in a huge amount of intermediary lemmas and definitions... /// Of course, I'm totally fine with introducing refinements steps when the /// proofs are *actually* intrinsically complex, but here we are studying hash /// maps, so come on!! /// /// - the abundance of intermediate definitions and lemmas causes a real problem /// because we then have to remember them, find naming conventions (otherwise /// it is a mess) and go look for them. All in all, it takes engineering time, /// and it can quickly cause scaling issues... /// /// - F* doesn't encode closures properly, the result being that it is very /// awkward to reason about functions like [map] or [find], because we have /// to introduce auxiliary definitions for the parameters we give to those /// functions (if we use anonymous lambda functions, we're screwed by the /// encoding). /// See all the definitions like [same_key], [binding_neq], etc. which cluter /// the file and worsen the problem mentionned in the previous point. /// /// - we can't prove intermediate results which require a *recursive* proof /// inside of other proofs, meaning that whenever we need such a result we need /// to write an intermediate lemma, which is extremely cumbersome. /// /// What is extremely frustrating is that in most situations, those intermediate /// lemmas are extremely simple to prove: they would simply need 2 or 3 tactic /// calls in Coq or HOL4, and in F* the proof is reduced to a recursive call. /// Isolating the lemma (i.e., writing its signature), however, takes some /// non-negligible time, which is made worse by the fact that, once again, /// we don't have proof contexts to stare at which would help figuring out /// how to write such lemmas. /// /// Simple example: see [for_all_binding_neq_find_lem]. This lemma states that: /// "if a key is not in a map, then looking up this key returns None". /// This lemma is used in *exactly* one place, and simply needs a recursive call. /// Stating the lemma took a lot more time (and place) than proving it. /// /// - more generally, it can be difficult to figure out which intermediate results /// to prove. In an interactive theorem prover based on tactics, it often happens /// that we start proving the theorem we target, then get stuck on a proof obligation /// for which we realize we need to prove an intermediate result. /// /// This process is a lot more difficult in F*, and I have to spend a lot of energy /// figuring out what I *might* need in the future. While this is probably a good /// habit, there are many situations where it is really a constraint: I'm often /// reluctant before starting a new proof in F*, because I anticipate on this very /// annoying loop: try to prove something, get an unknown assertion failed error, /// insert a lot of assertions or think *really* deeply to figure out what might /// have happened, etc. All this seems a lot more natural when working with tactics. /// /// Simple example: see [slots_t_inv_implies_slots_s_inv]. This lemma is super /// simple and was probably not required (it is proven with `()`). But I often feel /// forced to anticipate on problems, otherwise proofs become too painful. /// /// - the proofs often fail or succeed for extremely unpredictable reasons, and are /// extremely hard to debug. /// /// 1. See the comments for [hash_map_move_elements_fwd_back_lem_refin], which /// describe the various breakages I encountered, and the different attempts I /// made to fix them (the result is that it now works, but I don't know why, and /// there are still issues so it is maybe unstable).. /// /// Also, I still don't understand why the proof currently works, and failed /// before. One problem I encountered is that when trying to figure out why F* /// fails (and playing with Z3's parameters), we are constantly shooting in the dark. /// /// 2. See [hash_map_is_assoc_list] and [hash_map_move_elements_fwd_back_lem]. /// For this one, I have no clue what's going on. /// /// 3. [hash_map_move_elements_fwd_back_lem] was very painful, with assertions /// directly given by some postconditions which failed for no reasons, or /// "unknown assertion failed" which forced us to manually unfold postconditions... /// /// Finally: remember (again) that we are in a pure setting. Imagine having to /// deal with Low*/separation logic at the same time. (*** List lemmas *) val index_append_lem (#a : Type0) (ls0 ls1 : list a) (i : nat{i < length ls0 + length ls1}) : Lemma ( (i < length ls0 ==> index (ls0 @ ls1) i == index ls0 i) /\ (i >= length ls0 ==> index (ls0 @ ls1) i == index ls1 (i - length ls0))) [SMTPat (index (ls0 @ ls1) i)] #push-options "--fuel 1" let rec index_append_lem #a ls0 ls1 i = match ls0 with | [] -> () | x :: ls0' -> if i = 0 then () else index_append_lem ls0' ls1 (i-1) #pop-options val index_map_lem (#a #b: Type0) (f : a -> Tot b) (ls : list a) (i : nat{i < length ls}) : Lemma ( index (map f ls) i == f (index ls i)) [SMTPat (index (map f ls) i)] #push-options "--fuel 1" let rec index_map_lem #a #b f ls i = match ls with | [] -> () | x :: ls' -> if i = 0 then () else index_map_lem f ls' (i-1) #pop-options // TODO: remove? // Returns the index of the value which satisfies the predicate val find_index : #a:Type -> f:(a -> Tot bool) -> ls:list a{Some? (find f ls)} -> Tot (i:nat{ i < length ls /\ begin match find f ls with | None -> False | Some x -> x == index ls i end}) #push-options "--fuel 1" let rec find_index #a f ls = match ls with | [] -> assert(False); 0 | x :: ls' -> if f x then 0 else 1 + find_index f ls' #pop-options val for_all_append (#a : Type0) (f : a -> Tot bool) (ls0 ls1 : list a) : Lemma (for_all f (ls0 @ ls1) = (for_all f ls0 && for_all f ls1)) #push-options "--fuel 1" let rec for_all_append #a f ls0 ls1 = match ls0 with | [] -> () | x :: ls0' -> for_all_append f ls0' ls1 #pop-options (*** Lemmas about Primitives *) /// TODO: move those lemmas // TODO: rename to 'insert'? val list_update_index_dif_lem (#a : Type0) (ls : list a) (i : nat{i < length ls}) (x : a) (j : nat{j < length ls}) : Lemma (requires (j <> i)) (ensures (index (list_update ls i x) j == index ls j)) [SMTPat (index (list_update ls i x) j)] #push-options "--fuel 1" let rec list_update_index_dif_lem #a ls i x j = match ls with | x' :: ls -> if i = 0 then () else if j = 0 then () else list_update_index_dif_lem ls (i-1) x (j-1) #pop-options val map_list_update_lem (#a #b: Type0) (f : a -> Tot b) (ls : list a) (i : nat{i < length ls}) (x : a) : Lemma (list_update (map f ls) i (f x) == map f (list_update ls i x)) [SMTPat (list_update (map f ls) i (f x))] #push-options "--fuel 1" let rec map_list_update_lem #a #b f ls i x = match ls with | x' :: ls' -> if i = 0 then () else map_list_update_lem f ls' (i-1) x #pop-options val length_flatten_update : #a:Type -> ls:list (list a) -> i:nat{i < length ls} -> x:list a -> Lemma ( // length (flatten (list_update ls i x)) = // length (flatten ls) - length (index ls i) + length x length (flatten (list_update ls i x)) + length (index ls i) = length (flatten ls) + length x) #push-options "--fuel 1" let rec length_flatten_update #a ls i x = match ls with | x' :: ls' -> assert(flatten ls == x' @ flatten ls'); // Triggers patterns assert(length (flatten ls) == length x' + length (flatten ls')); if i = 0 then begin let ls1 = x :: ls' in assert(list_update ls i x == ls1); assert(flatten ls1 == x @ flatten ls'); // Triggers patterns assert(length (flatten ls1) == length x + length (flatten ls')); () end else begin length_flatten_update ls' (i-1) x; let ls1 = x' :: list_update ls' (i-1) x in assert(flatten ls1 == x' @ flatten (list_update ls' (i-1) x)) // Triggers patterns end #pop-options val forall_index_equiv_list_for_all (#a : Type) (pred : a -> Tot bool) (ls : list a) : Lemma ((forall (i:nat{i < length ls}). pred (index ls i)) <==> for_all pred ls) #push-options "--fuel 1" let rec forall_index_equiv_list_for_all pred ls = match ls with | [] -> () | x :: ls' -> assert(forall (i:nat{i < length ls'}). index ls' i == index ls (i+1)); assert(forall (i:nat{0 < i /\ i < length ls}). index ls i == index ls' (i-1)); assert(index ls 0 == x); forall_index_equiv_list_for_all pred ls' #pop-options (*** Utilities *) // TODO: filter the utilities val find_update: #a:Type -> f:(a -> Tot bool) -> ls:list a -> x:a -> ls':list a{length ls' == length ls} #push-options "--fuel 1" let rec find_update #a f ls x = match ls with | [] -> [] | hd::tl -> if f hd then x :: tl else hd :: find_update f tl x #pop-options val pairwise_distinct : #a:eqtype -> ls:list a -> Tot bool let rec pairwise_distinct (#a : eqtype) (ls : list a) : Tot bool = match ls with | [] -> true | x :: ls' -> List.Tot.for_all (fun y -> x <> y) ls' && pairwise_distinct ls' val for_allP: #a:Type -> f:(a -> Tot Type0) -> list a -> Tot Type0 let rec for_allP (f : 'a -> Tot Type0) (l : list 'a) : Tot Type0 = match l with | [] -> True | hd::tl -> f hd /\ for_allP f tl val for_all_i_aux: #a:Type -> f:(nat -> a -> Tot bool) -> list a -> nat -> Tot bool let rec for_all_i_aux (f : nat -> 'a -> Tot bool) (l : list 'a) (i : nat) : Tot bool = match l with | [] -> true | hd::tl -> f i hd && for_all_i_aux f tl (i+1) val for_all_i: #a:Type -> f:(nat -> a -> Tot bool) -> list a -> Tot bool let for_all_i (f : nat -> 'a -> Tot bool) (l : list 'a) : Tot bool = for_all_i_aux f l 0 val pairwise_relP : #a:Type -> pred:(a -> a -> Tot Type0) -> ls:list a -> Tot Type0 let rec pairwise_relP #a pred ls = match ls with | [] -> True | x :: ls' -> for_allP (pred x) ls' /\ pairwise_relP pred ls' val pairwise_rel : #a:Type -> pred:(a -> a -> Tot bool) -> ls:list a -> Tot bool let rec pairwise_rel #a pred ls = match ls with | [] -> true | x :: ls' -> for_all (pred x) ls' && pairwise_rel pred ls' /// The lack of lemmas about list manipulation is really annoying... #push-options "--fuel 1" let rec flatten_append (#a : Type) (l1 l2: list (list a)) : Lemma (flatten (l1 @ l2) == flatten l1 @ flatten l2) = match l1 with | [] -> () | x :: l1' -> flatten_append l1' l2; append_assoc x (flatten l1') (flatten l2) #pop-options /// We don't use anonymous functions as parameters to other functions, but rather /// introduce auxiliary functions instead: otherwise we can't reason (because /// F*'s encoding to the SMT is imprecise for functions) let fst_is_disctinct (#a : eqtype) (#b : Type0) (p0 : a & b) (p1 : a & b) : Type0 = fst p0 <> fst p1 (*** Invariants, models *) (* /// "Natural" length function for [list_t] /// TODO: remove? we can reason simply with [list_t_v] let rec list_t_len (#t : Type0) (ls : list_t t) : nat = match ls with | ListNil -> 0 | ListCons _ _ tl -> 1 + list_t_len tl *) (* /// "Natural" append function for [list_t] /// TODO: remove? we can reason simply with [list_t_v] #push-options "--fuel 1" let rec list_t_append (#t : Type0) (ls0 ls1 : list_t t) : ls:list_t t{list_t_len ls = list_t_len ls0 + list_t_len ls1} = match ls0 with | ListNil -> ls1 | ListCons x v tl -> ListCons x v (list_t_append tl ls1) #pop-options *) /// The "key" type type key : eqtype = usize type hash : eqtype = usize type binding (t : Type0) = key & t type slots_t (t : Type0) = vec (list_t t) /// We represent hash maps as associative lists type assoc_list (t : Type0) = list (binding t) /// Representation function for [list_t] let rec list_t_v (#t : Type0) (ls : list_t t) : assoc_list t = match ls with | ListNil -> [] | ListCons k v tl -> (k,v) :: list_t_v tl let list_t_len (#t : Type0) (ls : list_t t) : nat = length (list_t_v ls) let list_t_index (#t : Type0) (ls : list_t t) (i : nat{i < list_t_len ls}) : binding t = index (list_t_v ls) i // TODO: use more type slot_s (t : Type0) = list (binding t) type slots_s (t : Type0) = list (slot_s t) // TODO: use more type slot_t (t : Type0) = list_t t let slot_t_v (#t : Type0) (slot : slot_t t) : slot_s t = list_t_v slot /// Representation function for the slots. let slots_t_v (#t : Type0) (slots : slots_t t) : slots_s t = map slot_t_v slots /// TODO: remove? let slots_t_al_v (#t : Type0) (slots : slots_t t) : assoc_list t = flatten (map list_t_v slots) /// High-level type for the hash-map, seen as a list of associative lists (one /// list per slot) type hash_map_slots_s t = list (slot_s t) /// High-level type for the hash-map, seen as a an associative list type hash_map_s t = assoc_list t // TODO: move let is_pos_usize (n : nat) : Type0 = 0 < n /\ n <= usize_max // 'nes': "non-empty slots" // TODO: use more type hash_map_slots_s_nes (t : Type0) : Type0 = hm:hash_map_slots_s t{is_pos_usize (length hm)} /// Representation function for [hash_map_t] as a list of slots let hash_map_t_slots_v (#t : Type0) (hm : hash_map_t t) : hash_map_slots_s t = map list_t_v hm.hash_map_slots /// Representation function for [hash_map_t] let hash_map_t_v (#t : Type0) (hm : hash_map_t t) : hash_map_s t = flatten (hash_map_t_slots_v hm) // 'nes': "non-empty slots" // TODO: use more type hash_map_t_nes (t : Type0) : Type0 = hm:hash_map_t t{is_pos_usize (length hm.hash_map_slots)} let hash_key (k : key) : hash = Return?.v (hash_key_fwd k) let hash_mod_key (k : key) (len : usize{len > 0}) : hash = (hash_key k) % len let same_key (#t : Type0) (k : key) (b : binding t) : bool = fst b = k // We take a [nat] instead of a [hash] on purpose let same_hash_mod_key (#t : Type0) (len : usize{len > 0}) (h : nat) (b : binding t) : bool = hash_mod_key (fst b) len = h // We take a [nat] instead of a [hash] on purpose (*let same_hash (#t : Type0) (h : nat) (b : binding t) : bool = hash_key (fst b) = h *) let binding_neq (#t : Type0) (b0 b1 : binding t) : bool = fst b0 <> fst b1 let has_same_binding (#t : Type0) (al : assoc_list t) ((k,v) : binding t) : Type0 = match find (same_key k) al with | None -> False | Some (k',v') -> v' == v let hash_map_t_mem_s (#t : Type0) (hm : hash_map_t t) (k : key) : bool = existsb (same_key k) (hash_map_t_v hm) let hash_map_t_len_s (#t : Type0) (hm : hash_map_t t) : nat = hm.hash_map_num_entries let slot_find (#t : Type0) (k : key) (slot : list (binding t)) : option t = match find (same_key k) slot with | None -> None | Some (_, v) -> Some v let assoc_list_find (#t : Type0) (k : key) (slot : assoc_list t) : option t = slot_find k slot let slot_t_find_s (#t : Type0) (k : key) (slot : list_t t) : option t = match find (same_key k) (list_t_v slot) with | None -> None | Some (_, v) -> Some v // This is a simpler version of the "find" function, which captures the essence // of what happens and operates on [hash_map_slots_s]. // TODO: useful? // TODO: at some point I used hash_map_slots_s_nes and it broke proofs... let hash_map_slots_s_find (#t : Type0) (hm : hash_map_slots_s t{length hm <= usize_max /\ length hm > 0}) (k : key) : option t = let i = hash_mod_key k (length hm) in let slot = index hm i in slot_find k slot // TODO: at some point I used hash_map_slots_s_nes and it broke proofs... let hash_map_slots_s_len (#t : Type0) (hm : hash_map_slots_s t{length hm <= usize_max /\ length hm > 0}) : nat = length (flatten hm) // Same as above, but operates on [hash_map_t] // Note that we don't reuse the above function on purpose: converting to a // [hash_map_slots_s] then looking up an element is not the same as what we // wrote below. let hash_map_t_find_s (#t : Type0) (hm : hash_map_t t{length hm.hash_map_slots > 0}) (k : key) : option t = let slots = hm.hash_map_slots in let i = hash_mod_key k (length slots) in let slot = index slots i in slot_t_find_s k slot (*let hash_map_t_find_s (#t : Type0) (hm : hash_map_t t) (k : key) : option t = match find (same_key k) (hash_map_t_v hm) with | None -> None | Some (_, v) -> Some v*) /// Auxiliary function stating that two associative lists are "equivalent" let assoc_list_equiv (#t : Type0) (al0 al1 : assoc_list t) : Type0 = // All the bindings in al0 can be found in al1 for_allP (has_same_binding al1) al0 /\ // And the reverse is true for_allP (has_same_binding al0) al1 (* // Introducing auxiliary definitions to help deal with the quantifiers let not_same_keys_at_j_k (#t : Type0) (ls : list_t t) (j:nat{j < list_t_len ls}) (k:nat{k < list_t_len ls}) : Type0 = fst (list_t_index ls j) <> fst (list_t_index ls k) (*let not_same_keys_at_j_k (#t : Type0) (ls : list_t t) (j:nat{j < list_t_len ls}) (k:nat{k < list_t_len ls}) : Type0 = fst (list_t_index ls j) <> fst (list_t_index ls k)*) type slot_t_inv_hash_key_f (#t : Type0) (len : usize{len > 0}) (i : usize) (slot : list_t t) = (j:nat{j < list_t_len slot}) -> Lemma (hash_mod_key (fst (list_t_index slot j)) len = i) [SMTPat (hash_mod_key (fst (list_t_index slot j)) len)] type slot_t_inv_not_same_keys_f (#t : Type0) (i : usize) (slot : list_t t) = (j:nat{j < list_t_len slot}) -> (k:nat{k < list_t_len slot /\ j < k}) -> Lemma (not_same_keys_at_j_k slot j k) [SMTPat (not_same_keys_at_j_k slot j k)] *) (**) /// Invariants for the slots let slot_s_inv (#t : Type0) (len : usize{len > 0}) (i : usize) (slot : list (binding t)) : bool = // All the bindings are in the proper slot for_all (same_hash_mod_key len i) slot && // All the keys are pairwise distinct pairwise_rel binding_neq slot let slot_t_inv (#t : Type0) (len : usize{len > 0}) (i : usize) (slot : list_t t) : bool = // All the bindings are in the proper slot for_all (same_hash_mod_key len i) (list_t_v slot) && // All the keys are pairwise distinct pairwise_rel binding_neq (list_t_v slot) (* /// Invariants for the slots /// Rk.: making sure the quantifiers instantiations work was painful. As always. let slot_t_inv (#t : Type0) (len : usize{len > 0}) (i : usize) (slot : list_t t) : Type0 = // All the hashes of the keys are equal to the current hash (forall (j:nat{j < list_t_len slot}). {:pattern (list_t_index slot j)} hash_mod_key (fst (list_t_index slot j)) len = i) /\ // All the keys are pairwise distinct (forall (j:nat{j < list_t_len slot}) (k:nat{k < list_t_len slot /\ j < k}). {:pattern not_same_keys_at_j_k slot j k} k <> j ==> not_same_keys_at_j_k slot j k) /// Helpers to deal with the quantifier proofs let slot_t_inv_to_funs (#t : Type0) (len : usize{len > 0}) (i : usize) (slot : list_t t{slot_t_inv len i slot}) : slot_t_inv_hash_key_f len i slot & slot_t_inv_not_same_keys_f i slot = let f : slot_t_inv_hash_key_f len i slot = fun j -> () in let g : slot_t_inv_not_same_keys_f i slot = fun j k -> () in (f, g) let slot_t_inv_from_funs_lem (#t : Type0) (len : usize{len > 0}) (i : usize) (slot : list_t t) (f : slot_t_inv_hash_key_f len i slot) (g : slot_t_inv_not_same_keys_f i slot) : Lemma (slot_t_inv len i slot) = // Dealing with quantifiers is annoying, like always let f' (j:nat{j < list_t_len slot}) : Lemma (hash_mod_key (fst (list_t_index slot j)) len = i) [SMTPat (hash_mod_key (fst (list_t_index slot j)) len)] = f j in let g' (j:nat{j < list_t_len slot}) (k:nat{k < list_t_len slot /\ j < k}) : Lemma (not_same_keys_at_j_k slot j k) [SMTPat (not_same_keys_at_j_k slot j k)] = g j k in () *) let slots_s_inv (#t : Type0) (slots : slots_s t{length slots <= usize_max}) : Type0 = forall(i:nat{i < length slots}). {:pattern index slots i} slot_s_inv (length slots) i (index slots i) let slots_t_inv (#t : Type0) (slots : slots_t t{length slots <= usize_max}) : Type0 = forall(i:nat{i < length slots}). {:pattern index slots i} slot_t_inv (length slots) i (index slots i) (* type slots_t_inv_f (#t : Type0) (slots : slots_t t{length slots <= usize_max}) = (i:nat{i < length slots}) -> Lemma (slot_t_inv (length slots) i (index slots i)) let slots_t_inv_to_fun (#t : Type0) (slots : slots_t t{length slots <= usize_max /\ slots_t_inv slots}) : slots_t_inv_f slots = fun i -> () let slots_t_from_fun (#t : Type0) (slots : slots_t t{length slots <= usize_max}) (f : slots_t_inv_f slots) : Lemma (slots_t_inv slots) = let f' (i:nat{i < length slots}) : Lemma (slot_t_inv (length slots) i (index slots i)) [SMTPat (slot_t_inv (length slots) i (index slots i))] = f i in () *) // TODO: hash_map_slots -> hash_map_slots_s let hash_map_slots_s_inv (#t : Type0) (hm : hash_map_slots_s t) : Type0 = length hm <= usize_max /\ length hm > 0 /\ slots_s_inv hm /// Base invariant for the hashmap (the complete invariant can be temporarily /// broken between the moment we inserted an element and the moment we resize) let hash_map_t_base_inv (#t : Type0) (hm : hash_map_t t) : Type0 = let al = hash_map_t_v hm in // [num_entries] correctly tracks the number of entries in the table // Note that it gives us that the length of the slots array is <= usize_max hm.hash_map_num_entries = length al /\ // Slots invariant slots_t_inv hm.hash_map_slots /\ // The capacity must be > 0 (otherwise we can't resize, because we // multiply the capacity by two!) length hm.hash_map_slots > 0 /\ // Load computation begin let capacity = length hm.hash_map_slots in let (dividend, divisor) = hm.hash_map_max_load_factor in 0 < dividend /\ dividend < divisor /\ hm.hash_map_max_load = (capacity * dividend) / divisor end /// Invariant for the hashmap let hash_map_t_inv (#t : Type0) (hm : hash_map_t t) : Type0 = // Base invariant hash_map_t_base_inv hm /\ // The hash map is either: not overloaded, or we can't resize it (hm.hash_map_num_entries <= hm.hash_map_max_load || length hm.hash_map_slots * 2 > usize_max) /// The following predicate links the hashmap to an associative list. /// Note that it does not compute the representant: different (permuted) /// lists can be used to represent the same hashmap! let hash_map_t_is_al (#t : Type0) (hm : hash_map_t t) (al : assoc_list t) : Type0 = let hm_al = hash_map_t_v hm in assoc_list_equiv hm_al al /// We often need to frame some values let hash_map_same_params (#t : Type0) (hm0 hm1 : hash_map_t t) : Type0 = length hm0.hash_map_slots = length hm1.hash_map_slots /\ hm0.hash_map_max_load = hm1.hash_map_max_load /\ hm0.hash_map_max_load_factor = hm1.hash_map_max_load_factor (* /// The invariant we reveal to the user let hash_map_t_inv_repr (#t : Type0) (hm : hash_map_t t) (al : assoc_list t) : Type0 = // The hash map invariant is satisfied hash_map_t_inv hm /\ // And it can be seen as the given associative list hash_map_t_is_al hm al *) (*** allocate_slots *) /// Auxiliary lemma val slots_t_all_nil_inv_lem (#t : Type0) (slots : vec (list_t t){length slots <= usize_max}) : Lemma (requires (forall (i:nat{i < length slots}). index slots i == ListNil)) (ensures (slots_t_inv slots)) #push-options "--fuel 1" let slots_t_all_nil_inv_lem #t slots = () #pop-options val slots_t_al_v_all_nil_is_empty_lem (#t : Type0) (slots : vec (list_t t)) : Lemma (requires (forall (i:nat{i < length slots}). index slots i == ListNil)) (ensures (slots_t_al_v slots == [])) #push-options "--fuel 1" let rec slots_t_al_v_all_nil_is_empty_lem #t slots = match slots with | [] -> () | s :: slots' -> assert(forall (i:nat{i < length slots'}). index slots' i == index slots (i+1)); slots_t_al_v_all_nil_is_empty_lem #t slots'; assert(slots_t_al_v slots == list_t_v s @ slots_t_al_v slots'); assert(slots_t_al_v slots == list_t_v s); assert(index slots 0 == ListNil) #pop-options /// [allocate_slots] val hash_map_allocate_slots_fwd_lem (t : Type0) (slots : vec (list_t t)) (n : usize) : Lemma (requires (length slots + n <= usize_max)) (ensures ( match hash_map_allocate_slots_fwd t slots n with | Fail -> False | Return slots' -> length slots' = length slots + n /\ // We leave the already allocated slots unchanged (forall (i:nat{i < length slots}). index slots' i == index slots i) /\ // We allocate n additional empty slots (forall (i:nat{length slots <= i /\ i < length slots'}). index slots' i == ListNil))) (decreases (hash_map_allocate_slots_decreases t slots n)) #push-options "--fuel 1" let rec hash_map_allocate_slots_fwd_lem t slots n = begin match n with | 0 -> () | _ -> begin match vec_push_back (list_t t) slots ListNil with | Fail -> () | Return slots1 -> begin match usize_sub n 1 with | Fail -> () | Return i -> hash_map_allocate_slots_fwd_lem t slots1 i; begin match hash_map_allocate_slots_fwd t slots1 i with | Fail -> () | Return slots2 -> assert(length slots1 = length slots + 1); assert(slots1 == slots @ [ListNil]); // Triggers patterns assert(index slots1 (length slots) == index [ListNil] 0); // Triggers patterns assert(index slots1 (length slots) == ListNil) end end end end #pop-options (*** new_with_capacity *) /// Under proper conditions, [new_with_capacity] doesn't fail and returns an empty hash map. val hash_map_new_with_capacity_fwd_lem (t : Type0) (capacity : usize) (max_load_dividend : usize) (max_load_divisor : usize) : Lemma (requires ( 0 < max_load_dividend /\ max_load_dividend < max_load_divisor /\ 0 < capacity /\ capacity * max_load_dividend < usize_max)) (ensures ( match hash_map_new_with_capacity_fwd t capacity max_load_dividend max_load_divisor with | Fail -> False | Return hm -> // The hash map has the specified capacity - we need to reveal this // otherwise the pre of [hash_map_t_find_s] is not satisfied. length hm.hash_map_slots = capacity /\ // The hash map has 0 values hash_map_t_len_s hm = 0 /\ // It contains no bindings (forall k. hash_map_t_find_s hm k == None) /\ // We need this low-level property for the invariant (forall(i:nat{i < length hm.hash_map_slots}). index hm.hash_map_slots i == ListNil))) #push-options "--z3rlimit 50 --fuel 1" let hash_map_new_with_capacity_fwd_lem (t : Type0) (capacity : usize) (max_load_dividend : usize) (max_load_divisor : usize) = let v = vec_new (list_t t) in assert(length v = 0); hash_map_allocate_slots_fwd_lem t v capacity; begin match hash_map_allocate_slots_fwd t v capacity with | Fail -> assert(False) | Return v0 -> begin match usize_mul capacity max_load_dividend with | Fail -> assert(False) | Return i -> begin match usize_div i max_load_divisor with | Fail -> assert(False) | Return i0 -> let hm = Mkhash_map_t 0 (max_load_dividend, max_load_divisor) i0 v0 in slots_t_all_nil_inv_lem v0 end end end #pop-options (*** new *) /// [new] doesn't fail and returns an empty hash map val hash_map_new_fwd_lem_fun (t : Type0) : Lemma (ensures ( match hash_map_new_fwd t with | Fail -> False | Return hm -> // The hash map invariant is satisfied hash_map_t_inv hm /\ // The hash map has 0 values hash_map_t_len_s hm = 0 /\ // It contains no bindings (forall k. hash_map_t_find_s hm k == None))) #push-options "--fuel 1" let hash_map_new_fwd_lem_fun t = hash_map_new_with_capacity_fwd_lem t 32 4 5; match hash_map_new_with_capacity_fwd t 32 4 5 with | Fail -> () | Return hm -> slots_t_al_v_all_nil_is_empty_lem hm.hash_map_slots #pop-options (*** clear_slots *) /// [clear_slots] doesn't fail and simply clears the slots starting at index i #push-options "--fuel 1" let rec hash_map_clear_slots_fwd_back_lem (t : Type0) (slots : vec (list_t t)) (i : usize) : Lemma (ensures ( match hash_map_clear_slots_fwd_back t slots i with | Fail -> False | Return slots' -> // The length is preserved length slots' == length slots /\ // The slots before i are left unchanged (forall (j:nat{j < i /\ j < length slots}). index slots' j == index slots j) /\ // The slots after i are set to ListNil (forall (j:nat{i <= j /\ j < length slots}). index slots' j == ListNil))) (decreases (hash_map_clear_slots_decreases t slots i)) = let i0 = vec_len (list_t t) slots in let b = i < i0 in if b then begin match vec_index_mut_back (list_t t) slots i ListNil with | Fail -> () | Return v -> begin match usize_add i 1 with | Fail -> () | Return i1 -> hash_map_clear_slots_fwd_back_lem t v i1; begin match hash_map_clear_slots_fwd_back t v i1 with | Fail -> () | Return slots1 -> assert(length slots1 == length slots); assert(forall (j:nat{i+1 <= j /\ j < length slots}). index slots1 j == ListNil); assert(index slots1 i == ListNil) end end end else () #pop-options (*** clear *) /// [clear] doesn't fail and turns the hash map into an empty map val hash_map_clear_fwd_back_lem_fun (t : Type0) (self : hash_map_t t) : Lemma (requires (hash_map_t_base_inv self)) (ensures ( match hash_map_clear_fwd_back t self with | Fail -> False | Return hm -> // The hash map invariant is satisfied hash_map_t_base_inv hm /\ // We preserved the parameters hash_map_same_params hm self /\ // The hash map has 0 values hash_map_t_len_s hm = 0 /\ // It contains no bindings (forall k. hash_map_t_find_s hm k == None))) // Being lazy: fuel 1 helps a lot... #push-options "--fuel 1" let hash_map_clear_fwd_back_lem_fun t self = let p = self.hash_map_max_load_factor in let i = self.hash_map_max_load in let v = self.hash_map_slots in hash_map_clear_slots_fwd_back_lem t v 0; begin match hash_map_clear_slots_fwd_back t v 0 with | Fail -> () | Return slots1 -> slots_t_al_v_all_nil_is_empty_lem slots1; let hm1 = Mkhash_map_t 0 p i slots1 in assert(hash_map_t_base_inv hm1); assert(hash_map_t_inv hm1); assert(hash_map_t_is_al hm1 []) end #pop-options (*** len *) /// [len]: we link it to a non-failing function. /// Rk.: we might want to make an analysis to not use an error monad to translate /// functions which statically can't fail. val hash_map_len_fwd_lem (t : Type0) (self : hash_map_t t) : Lemma ( match hash_map_len_fwd t self with | Fail -> False | Return l -> l = hash_map_t_len_s self) let hash_map_len_fwd_lem t self = () (*** insert_in_list *) (**** insert_in_list'fwd *) /// [insert_in_list_fwd]: returns true iff the key is not in the list (functional version) val hash_map_insert_in_list_fwd_lem (t : Type0) (key : usize) (value : t) (ls : list_t t) : Lemma (ensures ( match hash_map_insert_in_list_fwd t key value ls with | Fail -> False | Return b -> b <==> (slot_t_find_s key ls == None))) (decreases (hash_map_insert_in_list_decreases t key value ls)) #push-options "--fuel 1" let rec hash_map_insert_in_list_fwd_lem t key value ls = begin match ls with | ListCons ckey cvalue ls0 -> let b = ckey = key in if b then () else begin hash_map_insert_in_list_fwd_lem t key value ls0; match hash_map_insert_in_list_fwd t key value ls0 with | Fail -> () | Return b0 -> () end | ListNil -> assert(list_t_v ls == []); assert_norm(find (same_key #t key) [] == None) end #pop-options (**** insert_in_list'back *) /// The proofs about [insert_in_list] backward are easier to do in several steps: /// extrinsic proofs to the rescue! /// We first prove that [insert_in_list] refines the function we wrote above, then /// use this function to prove the invariants, etc. /// We write a helper which "captures" what [insert_in_list] does. /// We then reason about this helper to prove the high-level properties we want /// (functional properties, preservation of invariants, etc.). let hash_map_insert_in_list_s (#t : Type0) (key : usize) (value : t) (ls : list (binding t)) : list (binding t) = // Check if there is already a binding for the key match find (same_key key) ls with | None -> // No binding: append the binding to the end ls @ [(key,value)] | Some _ -> // There is already a binding: update it find_update (same_key key) ls (key,value) /// [insert_in_list]: if the key is not in the map, appends a new bindings (functional version) val hash_map_insert_in_list_back_lem_append_s (t : Type0) (key : usize) (value : t) (ls : list_t t) : Lemma (requires ( slot_t_find_s key ls == None)) (ensures ( match hash_map_insert_in_list_back t key value ls with | Fail -> False | Return ls' -> list_t_v ls' == list_t_v ls @ [(key,value)])) (decreases (hash_map_insert_in_list_decreases t key value ls)) #push-options "--fuel 1" let rec hash_map_insert_in_list_back_lem_append_s t key value ls = begin match ls with | ListCons ckey cvalue ls0 -> let b = ckey = key in if b then () else begin hash_map_insert_in_list_back_lem_append_s t key value ls0; match hash_map_insert_in_list_back t key value ls0 with | Fail -> () | Return l -> () end | ListNil -> () end #pop-options /// [insert_in_list]: if the key is in the map, we update the binding (functional version) val hash_map_insert_in_list_back_lem_update_s (t : Type0) (key : usize) (value : t) (ls : list_t t) : Lemma (requires ( Some? (find (same_key key) (list_t_v ls)))) (ensures ( match hash_map_insert_in_list_back t key value ls with | Fail -> False | Return ls' -> list_t_v ls' == find_update (same_key key) (list_t_v ls) (key,value))) (decreases (hash_map_insert_in_list_decreases t key value ls)) #push-options "--fuel 1" let rec hash_map_insert_in_list_back_lem_update_s t key value ls = begin match ls with | ListCons ckey cvalue ls0 -> let b = ckey = key in if b then () else begin hash_map_insert_in_list_back_lem_update_s t key value ls0; match hash_map_insert_in_list_back t key value ls0 with | Fail -> () | Return l -> () end | ListNil -> () end #pop-options /// Put everything together val hash_map_insert_in_list_back_lem_s (t : Type0) (key : usize) (value : t) (ls : list_t t) : Lemma (ensures ( match hash_map_insert_in_list_back t key value ls with | Fail -> False | Return ls' -> list_t_v ls' == hash_map_insert_in_list_s key value (list_t_v ls))) let hash_map_insert_in_list_back_lem_s t key value ls = match find (same_key key) (list_t_v ls) with | None -> hash_map_insert_in_list_back_lem_append_s t key value ls | Some _ -> hash_map_insert_in_list_back_lem_update_s t key value ls (**** Invariants of insert_in_list_s *) /// Auxiliary lemmas /// We work on [hash_map_insert_in_list_s], the "high-level" version of [insert_in_list'back]. /// /// Note that in F* we can't have recursive proofs inside of other proofs, contrary /// to Coq, which makes it a bit cumbersome to prove auxiliary results like the /// following ones... (** Auxiliary lemmas: append case *) val slot_t_v_for_all_binding_neq_append_lem (t : Type0) (key : usize) (value : t) (ls : list (binding t)) (b : binding t) : Lemma (requires ( fst b <> key /\ for_all (binding_neq b) ls /\ slot_find key ls == None)) (ensures ( for_all (binding_neq b) (ls @ [(key,value)]))) #push-options "--fuel 1" let rec slot_t_v_for_all_binding_neq_append_lem t key value ls b = match ls with | [] -> () | (ck, cv) :: cls -> slot_t_v_for_all_binding_neq_append_lem t key value cls b #pop-options val slot_s_inv_not_find_append_end_inv_lem (t : Type0) (len : usize{len > 0}) (key : usize) (value : t) (ls : list (binding t)) : Lemma (requires ( slot_s_inv len (hash_mod_key key len) ls /\ slot_find key ls == None)) (ensures ( let ls' = ls @ [(key,value)] in slot_s_inv len (hash_mod_key key len) ls' /\ (slot_find key ls' == Some value) /\ (forall k'. k' <> key ==> slot_find k' ls' == slot_find k' ls))) #push-options "--fuel 1" let rec slot_s_inv_not_find_append_end_inv_lem t len key value ls = match ls with | [] -> () | (ck, cv) :: cls -> slot_s_inv_not_find_append_end_inv_lem t len key value cls; let h = hash_mod_key key len in let ls' = ls @ [(key,value)] in assert(for_all (same_hash_mod_key len h) ls'); slot_t_v_for_all_binding_neq_append_lem t key value cls (ck, cv); assert(pairwise_rel binding_neq ls'); assert(slot_s_inv len h ls') #pop-options /// [insert_in_list]: if the key is not in the map, appends a new bindings val hash_map_insert_in_list_s_lem_append (t : Type0) (len : usize{len > 0}) (key : usize) (value : t) (ls : list (binding t)) : Lemma (requires ( slot_s_inv len (hash_mod_key key len) ls /\ slot_find key ls == None)) (ensures ( let ls' = hash_map_insert_in_list_s key value ls in ls' == ls @ [(key,value)] /\ // The invariant is preserved slot_s_inv len (hash_mod_key key len) ls' /\ // [key] maps to [value] slot_find key ls' == Some value /\ // The other bindings are preserved (forall k'. k' <> key ==> slot_find k' ls' == slot_find k' ls))) let hash_map_insert_in_list_s_lem_append t len key value ls = slot_s_inv_not_find_append_end_inv_lem t len key value ls /// [insert_in_list]: if the key is not in the map, appends a new bindings (quantifiers) /// Rk.: we don't use this lemma. /// TODO: remove? val hash_map_insert_in_list_back_lem_append (t : Type0) (len : usize{len > 0}) (key : usize) (value : t) (ls : list_t t) : Lemma (requires ( slot_t_inv len (hash_mod_key key len) ls /\ slot_t_find_s key ls == None)) (ensures ( match hash_map_insert_in_list_back t key value ls with | Fail -> False | Return ls' -> list_t_v ls' == list_t_v ls @ [(key,value)] /\ // The invariant is preserved slot_t_inv len (hash_mod_key key len) ls' /\ // [key] maps to [value] slot_t_find_s key ls' == Some value /\ // The other bindings are preserved (forall k'. k' <> key ==> slot_t_find_s k' ls' == slot_t_find_s k' ls))) let hash_map_insert_in_list_back_lem_append t len key value ls = hash_map_insert_in_list_back_lem_s t key value ls; hash_map_insert_in_list_s_lem_append t len key value (list_t_v ls) (** Auxiliary lemmas: update case *) val slot_find_update_for_all_binding_neq_append_lem (t : Type0) (key : usize) (value : t) (ls : list (binding t)) (b : binding t) : Lemma (requires ( fst b <> key /\ for_all (binding_neq b) ls)) (ensures ( let ls' = find_update (same_key key) ls (key, value) in for_all (binding_neq b) ls')) #push-options "--fuel 1" let rec slot_find_update_for_all_binding_neq_append_lem t key value ls b = match ls with | [] -> () | (ck, cv) :: cls -> slot_find_update_for_all_binding_neq_append_lem t key value cls b #pop-options /// Annoying auxiliary lemma we have to prove because there is no way to reason /// properly about closures. /// I'm really enjoying my time. val for_all_binding_neq_value_indep (#t : Type0) (key : key) (v0 v1 : t) (ls : list (binding t)) : Lemma (for_all (binding_neq (key,v0)) ls = for_all (binding_neq (key,v1)) ls) #push-options "--fuel 1" let rec for_all_binding_neq_value_indep #t key v0 v1 ls = match ls with | [] -> () | _ :: ls' -> for_all_binding_neq_value_indep #t key v0 v1 ls' #pop-options val slot_s_inv_find_append_end_inv_lem (t : Type0) (len : usize{len > 0}) (key : usize) (value : t) (ls : list (binding t)) : Lemma (requires ( slot_s_inv len (hash_mod_key key len) ls /\ Some? (slot_find key ls))) (ensures ( let ls' = find_update (same_key key) ls (key, value) in slot_s_inv len (hash_mod_key key len) ls' /\ (slot_find key ls' == Some value) /\ (forall k'. k' <> key ==> slot_find k' ls' == slot_find k' ls))) #push-options "--z3rlimit 50 --fuel 1" let rec slot_s_inv_find_append_end_inv_lem t len key value ls = match ls with | [] -> () | (ck, cv) :: cls -> let h = hash_mod_key key len in let ls' = find_update (same_key key) ls (key, value) in if ck = key then begin assert(ls' == (ck,value) :: cls); assert(for_all (same_hash_mod_key len h) ls'); // For pairwise_rel: binding_neq (ck, value) is actually independent // of `value`. Slightly annoying to prove in F*... assert(for_all (binding_neq (ck,cv)) cls); for_all_binding_neq_value_indep key cv value cls; assert(for_all (binding_neq (ck,value)) cls); assert(pairwise_rel binding_neq ls'); assert(slot_s_inv len (hash_mod_key key len) ls') end else begin slot_s_inv_find_append_end_inv_lem t len key value cls; assert(for_all (same_hash_mod_key len h) ls'); slot_find_update_for_all_binding_neq_append_lem t key value cls (ck, cv); assert(pairwise_rel binding_neq ls'); assert(slot_s_inv len h ls') end #pop-options /// [insert_in_list]: if the key is in the map, update the bindings val hash_map_insert_in_list_s_lem_update (t : Type0) (len : usize{len > 0}) (key : usize) (value : t) (ls : list (binding t)) : Lemma (requires ( slot_s_inv len (hash_mod_key key len) ls /\ Some? (slot_find key ls))) (ensures ( let ls' = hash_map_insert_in_list_s key value ls in ls' == find_update (same_key key) ls (key,value) /\ // The invariant is preserved slot_s_inv len (hash_mod_key key len) ls' /\ // [key] maps to [value] slot_find key ls' == Some value /\ // The other bindings are preserved (forall k'. k' <> key ==> slot_find k' ls' == slot_find k' ls))) let hash_map_insert_in_list_s_lem_update t len key value ls = slot_s_inv_find_append_end_inv_lem t len key value ls /// [insert_in_list]: if the key is in the map, update the bindings /// TODO: not used: remove? val hash_map_insert_in_list_back_lem_update (t : Type0) (len : usize{len > 0}) (key : usize) (value : t) (ls : list_t t) : Lemma (requires ( slot_t_inv len (hash_mod_key key len) ls /\ Some? (slot_t_find_s key ls))) (ensures ( match hash_map_insert_in_list_back t key value ls with | Fail -> False | Return ls' -> let als = list_t_v ls in list_t_v ls' == find_update (same_key key) als (key,value) /\ // The invariant is preserved slot_t_inv len (hash_mod_key key len) ls' /\ // [key] maps to [value] slot_t_find_s key ls' == Some value /\ // The other bindings are preserved (forall k'. k' <> key ==> slot_t_find_s k' ls' == slot_t_find_s k' ls))) let hash_map_insert_in_list_back_lem_update t len key value ls = hash_map_insert_in_list_back_lem_s t key value ls; hash_map_insert_in_list_s_lem_update t len key value (list_t_v ls) (** Final lemmas about [insert_in_list] *) /// High-level version val hash_map_insert_in_list_s_lem (t : Type0) (len : usize{len > 0}) (key : usize) (value : t) (ls : list (binding t)) : Lemma (requires ( slot_s_inv len (hash_mod_key key len) ls)) (ensures ( let ls' = hash_map_insert_in_list_s key value ls in // The invariant is preserved slot_s_inv len (hash_mod_key key len) ls' /\ // [key] maps to [value] slot_find key ls' == Some value /\ // The other bindings are preserved (forall k'. k' <> key ==> slot_find k' ls' == slot_find k' ls) /\ // The length is incremented, iff we inserted a new key (match slot_find key ls with | None -> length ls' = length ls + 1 | Some _ -> length ls' = length ls))) let hash_map_insert_in_list_s_lem t len key value ls = match slot_find key ls with | None -> assert_norm(length [(key,value)] = 1); hash_map_insert_in_list_s_lem_append t len key value ls | Some _ -> hash_map_insert_in_list_s_lem_update t len key value ls /// [insert_in_list] /// TODO: not used: remove? val hash_map_insert_in_list_back_lem (t : Type0) (len : usize{len > 0}) (key : usize) (value : t) (ls : list_t t) : Lemma (requires (slot_t_inv len (hash_mod_key key len) ls)) (ensures ( match hash_map_insert_in_list_back t key value ls with | Fail -> False | Return ls' -> // The invariant is preserved slot_t_inv len (hash_mod_key key len) ls' /\ // [key] maps to [value] slot_t_find_s key ls' == Some value /\ // The other bindings are preserved (forall k'. k' <> key ==> slot_t_find_s k' ls' == slot_t_find_s k' ls) /\ // The length is incremented, iff we inserted a new key (match slot_t_find_s key ls with | None -> list_t_v ls' == list_t_v ls @ [(key,value)] /\ list_t_len ls' = list_t_len ls + 1 | Some _ -> list_t_v ls' == find_update (same_key key) (list_t_v ls) (key,value) /\ list_t_len ls' = list_t_len ls))) (decreases (hash_map_insert_in_list_decreases t key value ls)) let hash_map_insert_in_list_back_lem t len key value ls = hash_map_insert_in_list_back_lem_s t key value ls; hash_map_insert_in_list_s_lem t len key value (list_t_v ls) (*** insert_no_resize *) (**** Refinement proof *) /// Same strategy as for [insert_in_list]: we introduce a high-level version of /// the function, and reason about it. /// We work on [hash_map_slots_s] (we use a higher-level view of the hash-map, but /// not too high). // TODO: at some point I used hash_map_slots_s_nes and it broke proofs...x let hash_map_insert_no_resize_s (#t : Type0) (hm : hash_map_slots_s t{length hm <= usize_max /\ length hm > 0}) (key : usize) (value : t) : result (hash_map_slots_s t) = // Check if the table is saturated (too many entries, and we need to insert one) let num_entries = length (flatten hm) in if None? (hash_map_slots_s_find hm key) && num_entries = usize_max then Fail else begin let len = length hm in let i = hash_mod_key key len in let slot = index hm i in let slot' = hash_map_insert_in_list_s key value slot in let hm' = list_update hm i slot' in Return hm' end /// Prove that [hash_map_insert_no_resize_s] is a refinement of /// [hash_map_insert_no_resize'fwd_back] val hash_map_insert_no_resize_fwd_back_lem_s (t : Type0) (self : hash_map_t t) (key : usize) (value : t) : Lemma (requires ( hash_map_t_base_inv self /\ hash_map_slots_s_len (hash_map_t_slots_v self) = hash_map_t_len_s self)) (ensures ( begin match hash_map_insert_no_resize_fwd_back t self key value, hash_map_insert_no_resize_s (hash_map_t_slots_v self) key value with | Fail, Fail -> True | Return hm, Return hm_v -> hash_map_t_base_inv hm /\ hash_map_same_params hm self /\ hash_map_t_slots_v hm == hm_v /\ hash_map_slots_s_len hm_v == hash_map_t_len_s hm | _ -> False end)) let hash_map_insert_no_resize_fwd_back_lem_s t self key value = begin match hash_key_fwd key with | Fail -> () | Return i -> let i0 = self.hash_map_num_entries in let p = self.hash_map_max_load_factor in let i1 = self.hash_map_max_load in let v = self.hash_map_slots in let i2 = vec_len (list_t t) v in let len = length v in begin match usize_rem i i2 with | Fail -> () | Return hash_mod -> begin match vec_index_mut_fwd (list_t t) v hash_mod with | Fail -> () | Return l -> begin // Checking that: list_t_v (index ...) == index (hash_map_t_slots_v ...) ... assert(list_t_v l == index (hash_map_t_slots_v self) hash_mod); hash_map_insert_in_list_fwd_lem t key value l; match hash_map_insert_in_list_fwd t key value l with | Fail -> () | Return b -> assert(b = None? (slot_find key (list_t_v l))); hash_map_insert_in_list_back_lem t len key value l; if b then begin match usize_add i0 1 with | Fail -> () | Return i3 -> begin match hash_map_insert_in_list_back t key value l with | Fail -> () | Return l0 -> begin match vec_index_mut_back (list_t t) v hash_mod l0 with | Fail -> () | Return v0 -> let self_v = hash_map_t_slots_v self in let hm = Mkhash_map_t i3 p i1 v0 in let hm_v = hash_map_t_slots_v hm in assert(hm_v == list_update self_v hash_mod (list_t_v l0)); assert_norm(length [(key,value)] = 1); assert(length (list_t_v l0) = length (list_t_v l) + 1); length_flatten_update self_v hash_mod (list_t_v l0); assert(hash_map_slots_s_len hm_v = hash_map_t_len_s hm) end end end else begin match hash_map_insert_in_list_back t key value l with | Fail -> () | Return l0 -> begin match vec_index_mut_back (list_t t) v hash_mod l0 with | Fail -> () | Return v0 -> let self_v = hash_map_t_slots_v self in let hm = Mkhash_map_t i0 p i1 v0 in let hm_v = hash_map_t_slots_v hm in assert(hm_v == list_update self_v hash_mod (list_t_v l0)); assert(length (list_t_v l0) = length (list_t_v l)); length_flatten_update self_v hash_mod (list_t_v l0); assert(hash_map_slots_s_len hm_v = hash_map_t_len_s hm) end end end end end end (**** insert_no_resize: invariants *) val hash_map_insert_no_resize_s_lem (#t : Type0) (hm : hash_map_slots_s_nes t) (key : usize) (value : t) : Lemma (requires ( hash_map_slots_s_inv hm)) (ensures ( match hash_map_insert_no_resize_s hm key value with | Fail -> // Can fail only if we need to create a new binding in // an already saturated map hash_map_slots_s_len hm = usize_max /\ None? (hash_map_slots_s_find hm key) | Return hm' -> // The invariant is preserved hash_map_slots_s_inv hm' /\ // [key] maps to [value] hash_map_slots_s_find hm' key == Some value /\ // The other bindings are preserved (forall k'. k' <> key ==> hash_map_slots_s_find hm' k' == hash_map_slots_s_find hm k') /\ // The length is incremented, iff we inserted a new key (match hash_map_slots_s_find hm key with | None -> hash_map_slots_s_len hm' = hash_map_slots_s_len hm + 1 | Some _ -> hash_map_slots_s_len hm' = hash_map_slots_s_len hm))) let hash_map_insert_no_resize_s_lem #t hm key value = let num_entries = length (flatten hm) in if None? (hash_map_slots_s_find hm key) && num_entries = usize_max then () else begin let len = length hm in let i = hash_mod_key key len in let slot = index hm i in hash_map_insert_in_list_s_lem t len key value slot; let slot' = hash_map_insert_in_list_s key value slot in length_flatten_update hm i slot' end (**** find after insert *) /// Lemmas about what happens if we call [find] after an insertion val hash_map_insert_no_resize_s_get_same_lem (#t : Type0) (hm : hash_map_slots_s t) (key : usize) (value : t) : Lemma (requires (hash_map_slots_s_inv hm)) (ensures ( match hash_map_insert_no_resize_s hm key value with | Fail -> True | Return hm' -> hash_map_slots_s_find hm' key == Some value)) let hash_map_insert_no_resize_s_get_same_lem #t hm key value = let num_entries = length (flatten hm) in if None? (hash_map_slots_s_find hm key) && num_entries = usize_max then () else begin let hm' = Return?.v (hash_map_insert_no_resize_s hm key value) in let len = length hm in let i = hash_mod_key key len in let slot = index hm i in hash_map_insert_in_list_s_lem t len key value slot end val hash_map_insert_no_resize_s_get_diff_lem (#t : Type0) (hm : hash_map_slots_s t) (key : usize) (value : t) (key' : usize{key' <> key}) : Lemma (requires (hash_map_slots_s_inv hm)) (ensures ( match hash_map_insert_no_resize_s hm key value with | Fail -> True | Return hm' -> hash_map_slots_s_find hm' key' == hash_map_slots_s_find hm key')) let hash_map_insert_no_resize_s_get_diff_lem #t hm key value key' = let num_entries = length (flatten hm) in if None? (hash_map_slots_s_find hm key) && num_entries = usize_max then () else begin let hm' = Return?.v (hash_map_insert_no_resize_s hm key value) in let len = length hm in let i = hash_mod_key key len in let slot = index hm i in hash_map_insert_in_list_s_lem t len key value slot; let i' = hash_mod_key key' len in if i <> i' then () else begin () end end (*** move_elements_from_list *) /// Having a great time here: if we use `result (hash_map_slots_s_res t)` as the /// return type for [hash_map_move_elements_from_list_s] instead of having this /// awkward match, the proof of [hash_map_move_elements_fwd_back_lem_refin] fails. /// I guess it comes from F*'s poor subtyping. /// Followingly, I'm not taking any change and using [result_hash_map_slots_s] /// everywhere. type result_hash_map_slots_s_nes (t : Type0) : Type0 = res:result (hash_map_slots_s t) { match res with | Fail -> True | Return hm -> is_pos_usize (length hm) } let rec hash_map_move_elements_from_list_s (#t : Type0) (hm : hash_map_slots_s_nes t) (ls : slot_s t) : // Do *NOT* use `result (hash_map_slots_s t)` Tot (result_hash_map_slots_s_nes t) (decreases ls) = match ls with | [] -> Return hm | (key, value) :: ls' -> match hash_map_insert_no_resize_s hm key value with | Fail -> Fail | Return hm' -> hash_map_move_elements_from_list_s hm' ls' /// Refinement lemma val hash_map_move_elements_from_list_fwd_back_lem (t : Type0) (ntable : hash_map_t_nes t) (ls : list_t t) : Lemma (requires (hash_map_t_base_inv ntable)) (ensures ( match hash_map_move_elements_from_list_fwd_back t ntable ls, hash_map_move_elements_from_list_s (hash_map_t_slots_v ntable) (slot_t_v ls) with | Fail, Fail -> True | Return hm', Return hm_v -> hash_map_t_base_inv hm' /\ hash_map_t_slots_v hm' == hm_v /\ hash_map_same_params hm' ntable | _ -> False)) (decreases (hash_map_move_elements_from_list_decreases t ntable ls)) #push-options "--fuel 1" let rec hash_map_move_elements_from_list_fwd_back_lem t ntable ls = begin match ls with | ListCons k v tl -> assert(list_t_v ls == (k, v) :: list_t_v tl); let ls_v = list_t_v ls in let (_,_) :: tl_v = ls_v in hash_map_insert_no_resize_fwd_back_lem_s t ntable k v; begin match hash_map_insert_no_resize_fwd_back t ntable k v with | Fail -> () | Return h -> let h_v = Return?.v (hash_map_insert_no_resize_s (hash_map_t_slots_v ntable) k v) in assert(hash_map_t_slots_v h == h_v); hash_map_move_elements_from_list_fwd_back_lem t h tl; begin match hash_map_move_elements_from_list_fwd_back t h tl with | Fail -> () | Return h0 -> () end end | ListNil -> () end #pop-options (*** move_elements *) (**** move_elements: refinement 1 *) /// We prove a first refinement lemma: calling [move_elements] refines a function /// which, for every slot, moves the element out of the slot. This first version is /// almost exactly the translated function, it just uses `list` instead of `list_t`. // Note that we ignore the returned slots (we thus don't return a pair: // only the new hash map in which we moved the elements from the slots): // this returned value is not used. let rec hash_map_move_elements_s (#t : Type0) (hm : hash_map_slots_s_nes t) (slots : slots_s t) (i : usize{i <= length slots /\ length slots <= usize_max}) : Tot (result_hash_map_slots_s_nes t) (decreases (length slots - i)) = let len = length slots in if i < len then begin let slot = index slots i in match hash_map_move_elements_from_list_s hm slot with | Fail -> Fail | Return hm' -> let slots' = list_update slots i [] in hash_map_move_elements_s hm' slots' (i+1) end else Return hm val hash_map_move_elements_fwd_back_lem_refin (t : Type0) (ntable : hash_map_t t) (slots : vec (list_t t)) (i : usize{i <= length slots}) : Lemma (requires ( hash_map_t_base_inv ntable)) (ensures ( match hash_map_move_elements_fwd_back t ntable slots i, hash_map_move_elements_s (hash_map_t_slots_v ntable) (slots_t_v slots) i with | Fail, Fail -> True // We will prove later that this is not possible | Return (ntable', _), Return ntable'_v -> hash_map_t_base_inv ntable' /\ hash_map_t_slots_v ntable' == ntable'_v /\ hash_map_same_params ntable' ntable | _ -> False)) (decreases (length slots - i)) // This proof was super unstable for some reasons. // // For instance, using the [hash_map_slots_s_nes] type abbreviation // in some of the above definitions led to a failure (while it was just a type // abbreviation: the signatures were the same if we unfolded this type). This // behaviour led me to the hypothesis that maybe it made F*'s type inference // end up with a different result, which combined with its poor support for // subtyping made the proof failed. // // However, later, unwrapping a definition led to another failure. // // I thus tried to manually unfold some postconditions because it // seemed to work for [hash_map_move_elements_fwd_back_lem] but it didn't // succeed. // // I tried to increase the ifuel to 2, 3: it didn't work, and I fell back to // other methods. Finally out of angriness I swiched the ifuel to 4 for no // specific reason: everything worked fine. // // I have *no clue* why 4 is the magic number. Also: it fails if I remove // the unfolded postconditions (meaning I would probably need to increase // the ifuel to unreasonable amounts). // // Finally, as I had succeeded in fixing the proof, I thought that maybe the // initial problem with the type abbreviations fixed: I thus tried to use // them. Of course, it made the proof fail again, and this time no ifuel setting // seemed to work (maybe my initial guess about the type inferencer was right?...). // // At this point I was just fed up and leave things as they were, without trying // to cleanup the previous definitions. // // The terrible thing is that this refinement proof is conceptually super simple: // - there are maybe two arithmetic proofs, which are directly solved by the // precondition // - we need to refine the call to [hash_map_move_elements_from_list_fwd_back]: // this is proven by another refinement lemma we proved above // - there is the recursive call (trivial) #restart-solver #push-options "--z3rlimit 300 --fuel 1 --ifuel 4" let rec hash_map_move_elements_fwd_back_lem_refin t ntable slots i = assert(hash_map_t_base_inv ntable); let i0 = vec_len (list_t t) slots in let b = i < i0 in if b then begin match vec_index_mut_fwd (list_t t) slots i with | Fail -> () | Return l -> let l0 = mem_replace_fwd (list_t t) l ListNil in assert(l0 == l); hash_map_move_elements_from_list_fwd_back_lem t ntable l0; begin match hash_map_move_elements_from_list_fwd_back t ntable l0, hash_map_move_elements_from_list_s (hash_map_t_slots_v ntable) (slot_t_v l0) with | Fail, Fail -> () | Return hm', Return hm_v -> assert(hash_map_t_base_inv hm'); assert(hash_map_t_slots_v hm' == hm_v); assert(hash_map_same_params hm' ntable) | _ -> assert(False) end; begin match hash_map_move_elements_from_list_fwd_back t ntable l0 with | Fail -> () | Return h -> let l1 = mem_replace_back (list_t t) l ListNil in assert(l1 == ListNil); begin match vec_index_mut_back (list_t t) slots i l1 with | Fail -> () | Return v -> begin match usize_add i 1 with | Fail -> () | Return i1 -> hash_map_move_elements_fwd_back_lem_refin t h v i1; begin match hash_map_move_elements_fwd_back t h v i1, hash_map_move_elements_s (hash_map_t_slots_v h) (slots_t_v v) i1 with | Fail, Fail -> () | Return (ntable', _), Return ntable'_v -> assert(hash_map_t_base_inv ntable'); assert(hash_map_t_slots_v ntable' == ntable'_v); assert(hash_map_same_params ntable' ntable) | _ -> assert(False) end; begin match hash_map_move_elements_fwd_back t h v i1 with | Fail -> assert(hash_map_move_elements_fwd_back t ntable slots i == Fail); () | Return (ntable', v0) -> begin // Trying to prove the postcondition match hash_map_move_elements_fwd_back t ntable slots i with | Fail -> assert(False) | Return (ntable'', _) -> assert(ntable'' == ntable') end end end end end end else () #pop-options (**** move_elements: refinement 2 *) /// We prove a second refinement lemma: calling [move_elements] refines a function /// which which moves every binding of the hash map seen as *one* associative list /// (and not a list of lists). /// [ntable] is the hash map to which we move the elements /// [slots] is the current hash map, from which we remove the elements, and seen /// as a "flat" associative list (and not a list of lists) /// This is actually exactly [hash_map_move_elements_from_list_s]... let rec hash_map_move_elements_s_flat (#t : Type0) (ntable : hash_map_slots_s_nes t) (slots : hash_map_s t) : Tot (result_hash_map_slots_s_nes t) (decreases slots) = match slots with | [] -> Return ntable | (k,v) :: slots' -> match hash_map_insert_no_resize_s ntable k v with | Fail -> Fail | Return ntable' -> hash_map_move_elements_s_flat ntable' slots' /// The refinment lemmas /// First, auxiliary helpers. /// Flatten a list of lists, starting at index i val flatten_i : #a:Type -> l:list (list a) -> i:nat{i <= length l} -> Tot (list a) (decreases (length l - i)) let rec flatten_i l i = if i < length l then index l i @ flatten_i l (i+1) else [] let _ = assert(let l = [1;2] in l == hd l :: tl l) val flatten_i_incr : #a:Type -> l:list (list a) -> i:nat{Cons? l /\ i+1 <= length l} -> Lemma (ensures ( (**) assert_norm(length (hd l :: tl l) == 1 + length (tl l)); flatten_i l (i+1) == flatten_i (tl l) i)) (decreases (length l - (i+1))) #push-options "--fuel 1" let rec flatten_i_incr l i = let x :: tl = l in if i + 1 < length l then begin assert(flatten_i l (i+1) == index l (i+1) @ flatten_i l (i+2)); flatten_i_incr l (i+1); assert(flatten_i l (i+2) == flatten_i tl (i+1)); assert(index l (i+1) == index tl i) end else () #pop-options val flatten_0_is_flatten : #a:Type -> l:list (list a) -> Lemma (ensures (flatten_i l 0 == flatten l)) #push-options "--fuel 1" let rec flatten_0_is_flatten #a l = match l with | [] -> () | x :: l' -> flatten_i_incr l 0; flatten_0_is_flatten l' #pop-options /// Auxiliary lemma val flatten_nil_prefix_as_flatten_i : #a:Type -> l:list (list a) -> i:nat{i <= length l} -> Lemma (requires (forall (j:nat{j < i}). index l j == [])) (ensures (flatten l == flatten_i l i)) #push-options "--fuel 1" let rec flatten_nil_prefix_as_flatten_i #a l i = if i = 0 then flatten_0_is_flatten l else begin let x :: l' = l in assert(index l 0 == []); assert(x == []); assert(flatten l == flatten l'); flatten_i_incr l (i-1); assert(flatten_i l i == flatten_i l' (i-1)); assert(forall (j:nat{j < length l'}). index l' j == index l (j+1)); flatten_nil_prefix_as_flatten_i l' (i-1); assert(flatten l' == flatten_i l' (i-1)) end #pop-options /// The proof is trivial, the functions are the same. /// Just keeping two definitions to allow changes... val hash_map_move_elements_from_list_s_as_flat_lem (#t : Type0) (hm : hash_map_slots_s_nes t) (ls : slot_s t) : Lemma (ensures ( hash_map_move_elements_from_list_s hm ls == hash_map_move_elements_s_flat hm ls)) (decreases ls) #push-options "--fuel 1" let rec hash_map_move_elements_from_list_s_as_flat_lem #t hm ls = match ls with | [] -> () | (key, value) :: ls' -> match hash_map_insert_no_resize_s hm key value with | Fail -> () | Return hm' -> hash_map_move_elements_from_list_s_as_flat_lem hm' ls' #pop-options /// Composition of two calls to [hash_map_move_elements_s_flat] let hash_map_move_elements_s_flat_comp (#t : Type0) (hm : hash_map_slots_s_nes t) (slot0 slot1 : slot_s t) : Tot (result_hash_map_slots_s_nes t) = match hash_map_move_elements_s_flat hm slot0 with | Fail -> Fail | Return hm1 -> hash_map_move_elements_s_flat hm1 slot1 /// High-level desc: /// move_elements (move_elements hm slot0) slo1 == move_elements hm (slot0 @ slot1) val hash_map_move_elements_s_flat_append_lem (#t : Type0) (hm : hash_map_slots_s_nes t) (slot0 slot1 : slot_s t) : Lemma (ensures ( match hash_map_move_elements_s_flat_comp hm slot0 slot1, hash_map_move_elements_s_flat hm (slot0 @ slot1) with | Fail, Fail -> True | Return hm1, Return hm2 -> hm1 == hm2 | _ -> False)) (decreases (slot0)) #push-options "--fuel 1" let rec hash_map_move_elements_s_flat_append_lem #t hm slot0 slot1 = match slot0 with | [] -> () | (k,v) :: slot0' -> match hash_map_insert_no_resize_s hm k v with | Fail -> () | Return hm' -> hash_map_move_elements_s_flat_append_lem hm' slot0' slot1 #pop-options val flatten_i_same_suffix (#a : Type) (l0 l1 : list (list a)) (i : nat) : Lemma (requires ( i <= length l0 /\ length l0 = length l1 /\ (forall (j:nat{i <= j /\ j < length l0}). index l0 j == index l1 j))) (ensures (flatten_i l0 i == flatten_i l1 i)) (decreases (length l0 - i)) #push-options "--fuel 1" let rec flatten_i_same_suffix #a l0 l1 i = if i < length l0 then flatten_i_same_suffix l0 l1 (i+1) else () #pop-options /// Refinement lemma: /// [hash_map_move_elements_s] refines [hash_map_move_elements_s_flat] val hash_map_move_elements_s_lem_refin_flat (#t : Type0) (hm : hash_map_slots_s_nes t) (slots : slots_s t) (i : nat{i <= length slots /\ length slots <= usize_max}) : Lemma (ensures ( match hash_map_move_elements_s hm slots i, hash_map_move_elements_s_flat hm (flatten_i slots i) with | Fail, Fail -> True | Return hm, Return hm' -> hm == hm' | _ -> False)) (decreases (length slots - i)) #push-options "--fuel 1" let rec hash_map_move_elements_s_lem_refin_flat #t hm slots i = let len = length slots in if i < len then begin let slot = index slots i in hash_map_move_elements_from_list_s_as_flat_lem hm slot; match hash_map_move_elements_from_list_s hm slot with | Fail -> assert(flatten_i slots i == slot @ flatten_i slots (i+1)); hash_map_move_elements_s_flat_append_lem hm slot (flatten_i slots (i+1)); assert(hash_map_move_elements_s_flat hm (flatten_i slots i) == Fail) | Return hm' -> let slots' = list_update slots i [] in flatten_i_same_suffix slots slots' (i+1); hash_map_move_elements_s_lem_refin_flat hm' slots' (i+1); hash_map_move_elements_s_flat_append_lem hm slot (flatten_i slots' (i+1)); () end else () #pop-options let assoc_list_inv (#t : Type0) (al : assoc_list t) : Type0 = // All the keys are pairwise distinct pairwise_rel binding_neq al let disjoint_hm_al_on_key (#t : Type0) (hm : hash_map_slots_s_nes t) (al : assoc_list t) (k : key) : Type0 = match hash_map_slots_s_find hm k, assoc_list_find k al with | Some _, None | None, Some _ | None, None -> True | Some _, Some _ -> False /// Playing a dangerous game here: using forall quantifiers let disjoint_hm_al (#t : Type0) (hm : hash_map_slots_s_nes t) (al : assoc_list t) : Type0 = forall (k:key). disjoint_hm_al_on_key hm al k let find_in_union_hm_al (#t : Type0) (hm : hash_map_slots_s_nes t) (al : assoc_list t) (k : key) : option t = match hash_map_slots_s_find hm k with | Some b -> Some b | None -> assoc_list_find k al /// Auxiliary lemma val for_all_binding_neq_find_lem (#t : Type0) (k : key) (v : t) (al : assoc_list t) : Lemma (requires (for_all (binding_neq (k,v)) al)) (ensures (assoc_list_find k al == None)) #push-options "--fuel 1" let rec for_all_binding_neq_find_lem #t k v al = match al with | [] -> () | b :: al' -> for_all_binding_neq_find_lem k v al' #pop-options val hash_map_move_elements_s_flat_lem (#t : Type0) (hm : hash_map_slots_s_nes t) (al : assoc_list t) : Lemma (requires ( // Invariants hash_map_slots_s_inv hm /\ assoc_list_inv al /\ // The two are disjoint disjoint_hm_al hm al /\ // We can add all the elements to the hashmap hash_map_slots_s_len hm + length al <= usize_max)) (ensures ( match hash_map_move_elements_s_flat hm al with | Fail -> False // We can't fail | Return hm' -> // The invariant is preserved hash_map_slots_s_inv hm' /\ // The new hash map is the union of the two maps (forall (k:key). hash_map_slots_s_find hm' k == find_in_union_hm_al hm al k) /\ hash_map_slots_s_len hm' = hash_map_slots_s_len hm + length al)) (decreases al) #restart-solver #push-options "--z3rlimit 200 --fuel 1" let rec hash_map_move_elements_s_flat_lem #t hm al = match al with | [] -> () | (k,v) :: al' -> hash_map_insert_no_resize_s_lem hm k v; match hash_map_insert_no_resize_s hm k v with | Fail -> () | Return hm' -> assert(hash_map_slots_s_inv hm'); assert(assoc_list_inv al'); let disjoint_lem (k' : key) : Lemma (disjoint_hm_al_on_key hm' al' k') [SMTPat (disjoint_hm_al_on_key hm' al' k')] = if k' = k then begin assert(hash_map_slots_s_find hm' k' == Some v); for_all_binding_neq_find_lem k v al'; assert(assoc_list_find k' al' == None) end else begin assert(hash_map_slots_s_find hm' k' == hash_map_slots_s_find hm k'); assert(assoc_list_find k' al' == assoc_list_find k' al) end in assert(disjoint_hm_al hm' al'); assert(hash_map_slots_s_len hm' + length al' <= usize_max); hash_map_move_elements_s_flat_lem hm' al' #pop-options /// We need to prove that the invariants on the "low-level" representations of /// the hash map imply the invariants on the "high-level" representations. val slots_t_inv_implies_slots_s_inv (#t : Type0) (slots : slots_t t{length slots <= usize_max}) : Lemma (requires (slots_t_inv slots)) (ensures (slots_s_inv (slots_t_v slots))) let slots_t_inv_implies_slots_s_inv #t slots = // Ok, works fine: this lemma was useless. // Problem is: I can never really predict for sure with F*... () val hash_map_t_base_inv_implies_hash_map_slots_s_inv (#t : Type0) (hm : hash_map_t t) : Lemma (requires (hash_map_t_base_inv hm)) (ensures (hash_map_slots_s_inv (hash_map_t_slots_v hm))) let hash_map_t_base_inv_implies_hash_map_slots_s_inv #t hm = () // same as previous /// Introducing a "partial" version of the hash map invariant, which operates on /// a suffix of the hash map. let partial_hash_map_slots_s_inv (#t : Type0) (len : usize{len > 0}) (offset : usize) (hm : hash_map_slots_s t{offset + length hm <= usize_max}) : Type0 = forall(i:nat{i < length hm}). {:pattern index hm i} slot_s_inv len (offset + i) (index hm i) /// Auxiliary lemma. /// If a binding comes from a slot i, then its key is different from the keys /// of the bindings in the other slots (because the hashes of the keys are distinct). val binding_in_previous_slot_implies_neq (#t : Type0) (len : usize{len > 0}) (i : usize) (b : binding t) (offset : usize{i < offset}) (slots : hash_map_slots_s t{offset + length slots <= usize_max}) : Lemma (requires ( // The binding comes from a slot not in [slots] hash_mod_key (fst b) len = i /\ // The slots are the well-formed suffix of a hash map partial_hash_map_slots_s_inv len offset slots)) (ensures ( for_all (binding_neq b) (flatten slots))) (decreases slots) #push-options "--z3rlimit 100 --fuel 1" let rec binding_in_previous_slot_implies_neq #t len i b offset slots = match slots with | [] -> () | s :: slots' -> assert(slot_s_inv len offset (index slots 0)); // Triggers patterns assert(slot_s_inv len offset s); // Proving TARGET. We use quantifiers. assert(for_all (same_hash_mod_key len offset) s); forall_index_equiv_list_for_all (same_hash_mod_key len offset) s; assert(forall (i:nat{i < length s}). same_hash_mod_key len offset (index s i)); let aux (i:nat{i < length s}) : Lemma (requires (same_hash_mod_key len offset (index s i))) (ensures (binding_neq b (index s i))) [SMTPat (index s i)] = () in assert(forall (i:nat{i < length s}). binding_neq b (index s i)); forall_index_equiv_list_for_all (binding_neq b) s; assert(for_all (binding_neq b) s); // TARGET // assert(forall (i:nat{i < length slots'}). index slots' i == index slots (i+1)); // Triggers instantiations binding_in_previous_slot_implies_neq len i b (offset+1) slots'; for_all_append (binding_neq b) s (flatten slots') #pop-options val partial_hash_map_slots_s_inv_implies_assoc_list_lem (#t : Type0) (len : usize{len > 0}) (offset : usize) (hm : hash_map_slots_s t{offset + length hm <= usize_max}) : Lemma (requires ( partial_hash_map_slots_s_inv len offset hm)) (ensures (assoc_list_inv (flatten hm))) (decreases (length hm + length (flatten hm))) #push-options "--fuel 1" let rec partial_hash_map_slots_s_inv_implies_assoc_list_lem #t len offset hm = match hm with | [] -> () | slot :: hm' -> assert(flatten hm == slot @ flatten hm'); assert(forall (i:nat{i < length hm'}). index hm' i == index hm (i+1)); // Triggers instantiations match slot with | [] -> assert(flatten hm == flatten hm'); assert(partial_hash_map_slots_s_inv len (offset+1) hm'); // Triggers instantiations partial_hash_map_slots_s_inv_implies_assoc_list_lem len (offset+1) hm' | x :: slot' -> assert(flatten (slot' :: hm') == slot' @ flatten hm'); let hm'' = slot' :: hm' in assert(forall (i:nat{0 < i /\ i < length hm''}). index hm'' i == index hm i); // Triggers instantiations assert(forall (i:nat{0 < i /\ i < length hm''}). slot_s_inv len (offset + i) (index hm'' i)); assert(index hm 0 == slot); // Triggers instantiations assert(slot_s_inv len offset slot); assert(slot_s_inv len offset slot'); assert(partial_hash_map_slots_s_inv len offset hm''); partial_hash_map_slots_s_inv_implies_assoc_list_lem len offset (slot' :: hm'); // Proving that the key in `x` is different from all the other keys in // the flattened map assert(for_all (binding_neq x) slot'); for_all_append (binding_neq x) slot' (flatten hm'); assert(partial_hash_map_slots_s_inv len (offset+1) hm'); binding_in_previous_slot_implies_neq #t len offset x (offset+1) hm'; assert(for_all (binding_neq x) (flatten hm')); assert(for_all (binding_neq x) (flatten (slot' :: hm'))) #pop-options val hash_map_slots_s_inv_implies_assoc_list_lem (#t : Type0) (hm : hash_map_slots_s t) : Lemma (requires (hash_map_slots_s_inv hm)) (ensures (assoc_list_inv (flatten hm))) let hash_map_slots_s_inv_implies_assoc_list_lem #t hm = partial_hash_map_slots_s_inv_implies_assoc_list_lem (length hm) 0 hm val hash_map_t_base_inv_implies_assoc_list_lem (#t : Type0) (hm : hash_map_t t): Lemma (requires (hash_map_t_base_inv hm)) (ensures (assoc_list_inv (hash_map_t_v hm))) let hash_map_t_base_inv_implies_assoc_list_lem #t hm = hash_map_slots_s_inv_implies_assoc_list_lem (hash_map_t_slots_v hm) /// For some reason, we can't write the below [forall] directly in the [ensures] /// clause of the next lemma: it makes Z3 fails even with a huge rlimit. /// I have no idea what's going on. let hash_map_is_assoc_list (#t : Type0) (ntable : hash_map_t t{length ntable.hash_map_slots > 0}) (al : assoc_list t) : Type0 = (forall (k:key). hash_map_t_find_s ntable k == assoc_list_find k al) /// The final lemma about [move_elements]: calling it on an empty hash table moves /// all the elements to this empty table. val hash_map_move_elements_fwd_back_lem (t : Type0) (ntable : hash_map_t t) (slots : vec (list_t t)) : Lemma (requires ( let al = flatten (slots_t_v slots) in hash_map_t_base_inv ntable /\ length al <= usize_max /\ assoc_list_inv al /\ // The table is empty hash_map_t_len_s ntable = 0 /\ (forall (k:key). hash_map_t_find_s ntable k == None))) (ensures ( let al = flatten (slots_t_v slots) in match hash_map_move_elements_fwd_back t ntable slots 0, hash_map_move_elements_s_flat (hash_map_t_slots_v ntable) al with | Return (ntable', _), Return ntable'_v -> // The invariant is preserved hash_map_t_base_inv ntable' /\ // The table has the same number of slots length ntable'.hash_map_slots = length ntable.hash_map_slots /\ // The count is good hash_map_t_len_s ntable' = length al /\ // The table can be linked to its model (not really necessary anymore) hash_map_t_slots_v ntable' == ntable'_v /\ // The new table contains exactly all the bindings from the slots // Rk.: see the comment for [hash_map_is_assoc_list] hash_map_is_assoc_list ntable' al | _ -> False // We can only succeed )) // Weird, dirty things happen below. // Manually unfolding some postconditions allowed to make the proof pass, // and also revealed the reason why some proofs failed with "Unknown assertion // failed" (resulting in the call to [flatten_0_is_flatten] for instance). // I think manually unfolding the postconditions allowed to account for the // lack of ifuel (this kind of proofs is annoying, really). #restart-solver #push-options "--z3rlimit 100" let hash_map_move_elements_fwd_back_lem t ntable slots = let ntable_v = hash_map_t_slots_v ntable in let slots_v = slots_t_v slots in let al = flatten slots_v in hash_map_move_elements_fwd_back_lem_refin t ntable slots 0; begin match hash_map_move_elements_fwd_back t ntable slots 0, hash_map_move_elements_s ntable_v slots_v 0 with | Fail, Fail -> () | Return (ntable', _), Return ntable'_v -> assert(hash_map_t_base_inv ntable'); assert(hash_map_t_slots_v ntable' == ntable'_v) | _ -> assert(False) end; hash_map_move_elements_s_lem_refin_flat ntable_v slots_v 0; begin match hash_map_move_elements_s ntable_v slots_v 0, hash_map_move_elements_s_flat ntable_v (flatten_i slots_v 0) with | Fail, Fail -> () | Return hm, Return hm' -> assert(hm == hm') | _ -> assert(False) end; flatten_0_is_flatten slots_v; // flatten_i slots_v 0 == flatten slots_v hash_map_move_elements_s_flat_lem ntable_v al; match hash_map_move_elements_fwd_back t ntable slots 0, hash_map_move_elements_s_flat ntable_v al with | Return (ntable', _), Return ntable'_v -> assert(hash_map_t_base_inv ntable'); assert(length ntable'.hash_map_slots = length ntable.hash_map_slots); // Rk.: Adding the following let binding makes the proof fails even with a huge // rlitmit. Really having fun here... assert(hash_map_t_len_s ntable' = length al); assert(hash_map_t_slots_v ntable' == ntable'_v); assert(hash_map_is_assoc_list ntable' al) | _ -> assert(False) #pop-options