From f62ce16e5c5b6b8dc194c56fb7ae6d940a5240be Mon Sep 17 00:00:00 2001
From: Marco Stronati <marco@stronati.org>
Date: Thu, 25 Jan 2018 12:00:42 +0100
Subject: [PATCH] Locator: rewrote compute to use efficient predecessor from
 state

---
 src/lib_base/block_locator.ml  | 51 ++++++++++++++++++++++------------
 src/lib_base/block_locator.mli |  8 +++---
 src/lib_shell/state.ml         |  7 +++--
 3 files changed, 41 insertions(+), 25 deletions(-)

diff --git a/src/lib_base/block_locator.ml b/src/lib_base/block_locator.ml
index bfe92b9ab..04cca9e96 100644
--- a/src/lib_base/block_locator.ml
+++ b/src/lib_base/block_locator.ml
@@ -23,24 +23,39 @@ let encoding =
      (req "current_head" (dynamic_size Block_header.encoding))
      (req "history" (dynamic_size (list Block_hash.encoding))))
 
-let compute ~pred (h: Block_hash.t) (bh: Block_header.t) sz =
-  let rec loop acc ~sz step cpt b =
-    if sz = 0 then
-      Lwt.return (List.rev acc)
-    else
-      pred b step >>= function
-      | None ->
-          Lwt.return (List.rev (b :: acc))
-      | Some predecessor ->
-          if cpt = 0 then
-            loop (b :: acc) ~sz:(sz - 1) (step * 2) 10 predecessor
-          else
-            loop (b :: acc) ~sz:(sz - 1) step (cpt - 1) predecessor in
-  pred h 1 >>= function
-  | None -> Lwt.return (bh, [])
-  | Some p ->
-      loop [] ~sz 1 9 p >>= fun hist ->
-      Lwt.return (bh, hist)
+(** 
+   Computes a locator for block [b] picking 10 times the immediate
+   predecessors of [b], then 10 times one predecessor every 2, then 
+   10 times one predecessor every 4, ..., until genesis or it reaches 
+   the desired size.
+*)
+let compute ~predecessor ~genesis b header size =
+  if size < 0 then invalid_arg "compute: negative size" else
+    let repeats = 10 in (* number of repetitions for each power of 2 *)
+    let rec loop acc size step cnt b =
+      if size = 0 then
+        Lwt.return (List.rev acc)
+      else
+        predecessor b step >>= function
+        | None ->      (* reached genesis before size *)
+            if Block_hash.equal b genesis then
+              Lwt.return (List.rev acc)
+            else
+              Lwt.return (List.rev (genesis :: acc))
+        | Some pred ->
+            if cnt = 1 then
+              loop (pred :: acc) (size - 1)
+                (step * 2) repeats pred
+            else
+              loop (pred :: acc) (size - 1)
+                step (cnt - 1) pred
+    in
+    if size = 0 then Lwt.return (header, []) else
+      predecessor b 1 >>= function
+      | None -> Lwt.return (header, [])
+      | Some p ->
+          loop [p] (size-1) 1 repeats p >>= fun hist ->
+          Lwt.return (header, hist)
 
 type validity =
   | Unknown
diff --git a/src/lib_base/block_locator.mli b/src/lib_base/block_locator.mli
index 60a8e8578..9a3a15ad2 100644
--- a/src/lib_base/block_locator.mli
+++ b/src/lib_base/block_locator.mli
@@ -17,10 +17,10 @@ val raw: t -> raw
 
 val encoding: t Data_encoding.t
 
-val compute:
-  pred:(Block_hash.t -> int -> Block_hash.t option Lwt.t) ->
-  Block_hash.t -> Block_header.t -> int ->
-  t Lwt.t
+val compute: predecessor: (Block_hash.t -> int -> Block_hash.t option Lwt.t) ->
+  genesis:Block_hash.t -> Block_hash.t -> Block_header.t -> int -> t Lwt.t
+(** [compute block max_length] compute the sparse block locator for
+    the [block]. The locator contains at most [max_length] elements. *)
 
 type validity =
   | Unknown
diff --git a/src/lib_shell/state.ml b/src/lib_shell/state.ml
index f997a2079..6dde27044 100644
--- a/src/lib_shell/state.ml
+++ b/src/lib_shell/state.ml
@@ -243,10 +243,11 @@ let predecessor_n (store: Store.Block.store) (b: Block_hash.t) (distance: int)
     in
     loop b distance
 
-let compute_locator_from_hash (net : net_state) ?(size = 200) head =
+let compute_locator_from_hash (net : net_state) ?(size = 200) head_hash =
   Shared.use net.block_store begin fun block_store ->
-    Store.Block.Contents.read_exn (block_store, head) >>= fun { header } ->
-    Block_locator.compute ~pred:(predecessor block_store) head header size
+    Store.Block.Contents.read_exn (block_store, head_hash) >>= fun { header } ->
+    Block_locator.compute ~predecessor:(predecessor_n block_store)
+      ~genesis:net.genesis.block head_hash header size
   end
 
 let compute_locator net ?size head =