context_ops.ml1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301(*****************************************************************************) (* *) (* Open Source License *) (* Copyright (c) 2021 Nomadic Labs, <contact@nomadic-labs.com> *) (* *) (* Permission is hereby granted, free of charge, to any person obtaining a *) (* copy of this software and associated documentation files (the "Software"),*) (* to deal in the Software without restriction, including without limitation *) (* the rights to use, copy, modify, merge, publish, distribute, sublicense, *) (* and/or sell copies of the Software, and to permit persons to whom the *) (* Software is furnished to do so, subject to the following conditions: *) (* *) (* The above copyright notice and this permission notice shall be included *) (* in all copies or substantial portions of the Software. *) (* *) (* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*) (* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *) (* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL *) (* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*) (* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING *) (* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER *) (* DEALINGS IN THE SOFTWARE. *) (* *) (*****************************************************************************) (* Backend-agnostic operations on the context *) module Environment_context = Tezos_protocol_environment.Context module Memory_context = Tezos_protocol_environment.Memory_context let err_implementation_mismatch = Tezos_protocol_environment.err_implementation_mismatch (** Values of type [index] are used to [checkout] contexts specified by their hash. *) type index = | Disk_index of Context.index | Memory_index of Tezos_context_memory.Context.index let index (context : Environment_context.t) = match context with | Context {kind = Shell_context.Context; ctxt; _} -> Disk_index (Context.index ctxt) | Context {kind = Memory_context.Context; ctxt; _} -> Memory_index (Tezos_context_memory.Context.index ctxt) | Context t -> err_implementation_mismatch ~expected:"shell or memory" ~got:t.impl_name let mem (context : Environment_context.t) key = match context with | Context {kind = Shell_context.Context; ctxt; _} -> Context.mem ctxt key | Context {kind = Memory_context.Context; ctxt; _} -> Tezos_context_memory.Context.mem ctxt key | Context t -> err_implementation_mismatch ~expected:"shell or memory" ~got:t.impl_name let mem_tree (context : Environment_context.t) key = match context with | Context {kind = Shell_context.Context; ctxt; _} -> Context.mem_tree ctxt key | Context {kind = Memory_context.Context; ctxt; _} -> Tezos_context_memory.Context.mem_tree ctxt key | Context t -> err_implementation_mismatch ~expected:"shell or memory" ~got:t.impl_name let find (context : Environment_context.t) key = match context with | Context {kind = Shell_context.Context; ctxt; _} -> Context.find ctxt key | Context {kind = Memory_context.Context; ctxt; _} -> Tezos_context_memory.Context.find ctxt key | Context t -> err_implementation_mismatch ~expected:"shell or memory" ~got:t.impl_name let add (context : Environment_context.t) key data = let open Lwt_syntax in match context with | Context {kind = Shell_context.Context; ctxt; _} -> let+ ctxt = Context.add ctxt key data in Shell_context.wrap_disk_context ctxt | Context {kind = Memory_context.Context; ctxt; _} -> let+ ctxt = Tezos_context_memory.Context.add ctxt key data in Memory_context.wrap_memory_context ctxt | Context t -> err_implementation_mismatch ~expected:"shell or memory" ~got:t.impl_name let fold_value ?depth (context : Environment_context.t) key ~order ~init ~f = match context with | Context {kind = Shell_context.Context; ctxt; _} -> Context.fold ?depth ctxt key ~order ~init ~f:(fun k tree acc -> let v () = Context.Tree.to_value tree in f k v acc) | Context {kind = Memory_context.Context; ctxt; _} -> let open Tezos_context_memory in Context.fold ?depth ctxt key ~order ~init ~f:(fun k tree acc -> let v () = Context.Tree.to_value tree in f k v acc) | Context t -> err_implementation_mismatch ~expected:"shell or memory" ~got:t.impl_name let add_protocol (context : Environment_context.t) proto_hash = let open Lwt_syntax in match context with | Context {kind = Shell_context.Context; ctxt; _} -> let+ ctxt = Context.add_protocol ctxt proto_hash in Shell_context.wrap_disk_context ctxt | Context {kind = Memory_context.Context; ctxt; _} -> let+ ctxt = Tezos_context_memory.Context.add_protocol ctxt proto_hash in Memory_context.wrap_memory_context ctxt | Context t -> err_implementation_mismatch ~expected:"shell or memory" ~got:t.impl_name let get_protocol (context : Environment_context.t) = match context with | Context {kind = Shell_context.Context; ctxt; _} -> Context.get_protocol ctxt | Context {kind = Memory_context.Context; ctxt; _} -> Tezos_context_memory.Context.get_protocol ctxt | Context t -> err_implementation_mismatch ~expected:"shell or memory" ~got:t.impl_name let add_predecessor_block_metadata_hash (context : Environment_context.t) hash = let open Lwt_syntax in match context with | Context {kind = Shell_context.Context; ctxt; _} -> let+ ctxt = Context.add_predecessor_block_metadata_hash ctxt hash in Shell_context.wrap_disk_context ctxt | Context {kind = Memory_context.Context; ctxt; _} -> let+ ctxt = Tezos_context_memory.Context.add_predecessor_block_metadata_hash ctxt hash in Memory_context.wrap_memory_context ctxt | Context t -> err_implementation_mismatch ~expected:"shell or memory" ~got:t.impl_name let add_predecessor_ops_metadata_hash (context : Environment_context.t) hash = let open Lwt_syntax in match context with | Context {kind = Shell_context.Context; ctxt; _} -> let+ ctxt = Context.add_predecessor_ops_metadata_hash ctxt hash in Shell_context.wrap_disk_context ctxt | Context {kind = Memory_context.Context; ctxt; _} -> let+ ctxt = Tezos_context_memory.Context.add_predecessor_ops_metadata_hash ctxt hash in Memory_context.wrap_memory_context ctxt | Context t -> err_implementation_mismatch ~expected:"shell or memory" ~got:t.impl_name let hash ~time ?message (context : Environment_context.t) = match context with | Context {kind = Shell_context.Context; ctxt; _} -> Context.hash ~time ?message ctxt | Context {kind = Memory_context.Context; ctxt; _} -> Tezos_context_memory.Context.hash ~time ?message ctxt | Context t -> err_implementation_mismatch ~expected:"shell or memory" ~got:t.impl_name let get_test_chain (context : Environment_context.t) = match context with | Context {kind = Shell_context.Context; ctxt; _} -> Context.get_test_chain ctxt | Context {kind = Memory_context.Context; _} -> Lwt.return Test_chain_status.Not_running | Context t -> err_implementation_mismatch ~expected:"shell or memory" ~got:t.impl_name let add_test_chain (context : Environment_context.t) status = let open Lwt_syntax in match context with | Context {kind = Shell_context.Context; ctxt; _} -> let+ ctxt = Context.add_test_chain ctxt status in Shell_context.wrap_disk_context ctxt | Context {kind = Memory_context.Context; ctxt; _} -> let+ ctxt = Tezos_context_memory.Context.add_test_chain ctxt status in Memory_context.wrap_memory_context ctxt | Context t -> err_implementation_mismatch ~expected:"shell or memory" ~got:t.impl_name let fork_test_chain (context : Environment_context.t) ~protocol ~expiration = let open Lwt_syntax in match context with | Context {kind = Shell_context.Context; ctxt; _} -> let+ ctxt = Context.fork_test_chain ctxt ~protocol ~expiration in Shell_context.wrap_disk_context ctxt | Context {kind = Memory_context.Context; ctxt; _} -> let+ ctxt = Tezos_context_memory.Context.fork_test_chain ctxt ~protocol ~expiration in Memory_context.wrap_memory_context ctxt | Context t -> err_implementation_mismatch ~expected:"shell or memory" ~got:t.impl_name let commit ~time ?message (context : Environment_context.t) = match context with | Context {kind = Shell_context.Context; ctxt; _} -> Context.commit ~time ?message ctxt | Context {kind = Memory_context.Context; ctxt; _} -> Tezos_context_memory.Context.commit ~time ?message ctxt | Context t -> err_implementation_mismatch ~expected:"shell or memory" ~got:t.impl_name let gc context_index context_hash = match context_index with | Disk_index index -> Context.gc index context_hash | Memory_index index -> Tezos_context_memory.Context.gc index context_hash let wait_gc_completion context_index = match context_index with | Disk_index index -> Context.wait_gc_completion index | Memory_index index -> Tezos_context_memory.Context.wait_gc_completion index let is_gc_allowed context_index = match context_index with | Disk_index index -> Context.is_gc_allowed index | Memory_index index -> Tezos_context_memory.Context.is_gc_allowed index let split context_index = match context_index with | Disk_index index -> Context.split index | Memory_index index -> Tezos_context_memory.Context.split index let sync = function | Disk_index index -> Context.sync index | Memory_index index -> Tezos_context_memory.Context.sync index let commit_test_chain_genesis (context : Environment_context.t) block_header = match context with | Context {kind = Shell_context.Context; ctxt; _} -> Context.commit_test_chain_genesis ctxt block_header | Context {kind = Memory_context.Context; ctxt; _} -> Tezos_context_memory.Context.commit_test_chain_genesis ctxt block_header | Context t -> err_implementation_mismatch ~expected:"shell or memory" ~got:t.impl_name let compute_testchain_genesis (context : Environment_context.t) block_hash = match context with | Context {kind = Shell_context.Context; _} -> Context.compute_testchain_genesis block_hash | Context {kind = Memory_context.Context; _} -> Tezos_context_memory.Context.compute_testchain_genesis block_hash | Context t -> err_implementation_mismatch ~expected:"shell or memory" ~got:t.impl_name let merkle_tree (context : Environment_context.t) leaf_kind path = match context with | Context {kind = Shell_context.Context; ctxt; _} -> Context.merkle_tree ctxt leaf_kind path | Context {kind = Memory_context.Context; ctxt; _} -> Tezos_context_memory.Context.merkle_tree ctxt leaf_kind path | Context t -> err_implementation_mismatch ~expected:"shell or memory" ~got:t.impl_name let merkle_tree_v2 (context : Environment_context.t) leaf_kind path = match context with | Context {kind = Shell_context.Context; ctxt; _} -> Context.merkle_tree_v2 ctxt leaf_kind path | Context {kind = Memory_context.Context; ctxt; _} -> Tezos_context_memory.Context.merkle_tree_v2 ctxt leaf_kind path | Context t -> err_implementation_mismatch ~expected:"shell or memory" ~got:t.impl_name let commit_genesis context_index ~chain_id ~time ~protocol = match context_index with | Disk_index index -> Context.commit_genesis index ~chain_id ~time ~protocol | Memory_index index -> Tezos_context_memory.Context.commit_genesis index ~chain_id ~time ~protocol let checkout context_index context_hash = let open Lwt_syntax in match context_index with | Disk_index index -> let+ ctxt = Context.checkout index context_hash in Option.map Shell_context.wrap_disk_context ctxt | Memory_index index -> let+ ctxt = Tezos_context_memory.Context.checkout index context_hash in Option.map Memory_context.wrap_memory_context ctxt let checkout_exn context_index context_hash = let open Lwt_syntax in match context_index with | Disk_index index -> let+ ctxt = Context.checkout_exn index context_hash in Shell_context.wrap_disk_context ctxt | Memory_index index -> let+ ctxt = Tezos_context_memory.Context.checkout_exn index context_hash in Memory_context.wrap_memory_context ctxt let exists context_index context_hash = match context_index with | Disk_index index -> Context.exists index context_hash | Memory_index index -> Tezos_context_memory.Context.exists index context_hash let close context_index = match context_index with | Disk_index index -> Context.close index | Memory_index index -> Tezos_context_memory.Context.close index