package octez-internal-libs

  1. Overview
  2. Docs
package octez-internal-libs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file control_file.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
(*
 * Copyright (c) 2022-2022 Tarides <contact@tarides.com>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *)

open Import
include Control_file_intf
module Version = Irmin_pack.Version

module Checksum = struct
  let calculate ~encode_bin ~set_checksum ~payload =
    let open Checkseum in
    let result = ref Adler32.default in
    encode_bin (set_checksum payload Int63.zero) (fun str ->
        result := Adler32.digest_string str 0 (String.length str) !result);
    Int63.of_int (Optint.to_int !result)

  let calculate_and_set ~encode_bin ~set_checksum ~payload =
    calculate ~encode_bin ~set_checksum ~payload |> set_checksum payload

  let is_valid ~encode_bin ~set_checksum ~get_checksum ~payload =
    Int63.equal
      (calculate ~encode_bin ~set_checksum ~payload)
      (get_checksum payload)
end

module Serde = struct
  module type S = sig
    type payload
    type raw_payload

    val of_bin_string :
      string ->
      string ->
      ( payload,
        [> `Corrupted_control_file of string
        | `Unknown_major_pack_version of string ] )
      result

    val raw_of_bin_string :
      string ->
      string ->
      ( raw_payload,
        [> `Corrupted_control_file of string
        | `Unknown_major_pack_version of string ] )
      result

    val to_bin_string : payload -> string
  end

  let extract_version_and_payload ctx s =
    let open Result_syntax in
    let len = String.length s in
    let* left, right =
      try Ok (String.sub s 0 8, String.sub s 8 (len - 8))
      with Invalid_argument _ -> Error (`Corrupted_control_file ctx)
    in
    let+ version =
      match Version.of_bin left with
      | None -> Error (`Unknown_major_pack_version left)
      | Some (`V1 | `V2) -> assert false (* TODO: create specific error *)
      | Some ((`V3 | `V4 | `V5) as x) ->
          if len > Io.Unix.page_size then Error (`Corrupted_control_file ctx)
          else Ok x
    in
    (version, right)

  module Upper :
    S
      with type payload = Payload.Upper.Latest.t
       and type raw_payload = Payload.Upper.raw_payload = struct
    module Data = struct
      module Plv3 = struct
        include Payload.Upper.V3

        let of_bin_string = Irmin.Type.(unstage (of_bin_string t))
      end

      module Plv4 = struct
        include Payload.Upper.V4

        let is_checksum_valid payload =
          let encode_bin = Irmin.Type.(unstage (pre_hash t)) in
          let set_checksum payload checksum = { payload with checksum } in
          let get_checksum payload = payload.checksum in
          Checksum.is_valid ~payload ~encode_bin ~set_checksum ~get_checksum

        let of_bin_string = Irmin.Type.(unstage (of_bin_string t))
      end

      module Plv5 = struct
        include Payload.Upper.V5

        let checksum_encode_bin = Irmin.Type.(unstage (pre_hash t))
        let set_checksum payload checksum = { payload with checksum }
        let get_checksum payload = payload.checksum

        let is_checksum_valid payload =
          Checksum.is_valid ~payload ~encode_bin:checksum_encode_bin
            ~set_checksum ~get_checksum

        let set_checksum payload =
          Checksum.calculate_and_set ~encode_bin:checksum_encode_bin
            ~set_checksum ~payload

        let of_bin_string = Irmin.Type.(unstage (of_bin_string t))
        let to_bin_string = Irmin.Type.(unstage (to_bin_string t))
      end

      type t = Payload.Upper.raw_payload =
        | Valid of version
        | Invalid of version

      and version = Payload.Upper.version =
        | V3 of Plv3.t
        | V4 of Plv4.t
        | V5 of Plv5.t

      let to_bin_string = function
        | Invalid _ | Valid (V3 _) | Valid (V4 _) -> assert false
        | Valid (V5 payload) ->
            let payload = Plv5.set_checksum payload in
            Version.to_bin `V5 ^ Plv5.to_bin_string payload

      let of_bin_string ctx s =
        let open Result_syntax in
        let* version, payload = extract_version_and_payload ctx s in
        let route_version () =
          match version with
          | `V3 ->
              Plv3.of_bin_string payload >>= fun payload ->
              Valid (V3 payload) |> Result.ok
          | `V4 ->
              Plv4.of_bin_string payload >>= fun payload ->
              (match Plv4.is_checksum_valid payload with
              | false -> Invalid (V4 payload)
              | true -> Valid (V4 payload))
              |> Result.ok
          | `V5 ->
              Plv5.of_bin_string payload >>= fun payload ->
              (match Plv5.is_checksum_valid payload with
              | false -> Invalid (V5 payload)
              | true -> Valid (V5 payload))
              |> Result.ok
        in
        match route_version () with
        | Ok _ as x -> x
        | Error _ -> Error (`Corrupted_control_file ctx)
    end

    module Latest = Data.Plv5

    type payload = Latest.t
    type raw_payload = Data.t

    let upgrade_from_v3 (pl : Payload.Upper.V3.t) : payload =
      let chunk_start_idx = ref 0 in
      let status =
        match pl.status with
        | From_v1_v2_post_upgrade x -> Latest.From_v1_v2_post_upgrade x
        | From_v3_no_gc_yet -> No_gc_yet
        | From_v3_used_non_minimal_indexing_strategy ->
            Used_non_minimal_indexing_strategy
        | From_v3_gced x ->
            chunk_start_idx := x.generation;
            Gced
              {
                suffix_start_offset = x.suffix_start_offset;
                generation = x.generation;
                latest_gc_target_offset = x.suffix_start_offset;
                suffix_dead_bytes = Int63.zero;
                mapping_end_poff = None;
              }
        | T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8 | T9 | T10 | T11 | T12 | T13
        | T14 | T15 ->
            (* Unreachable *)
            assert false
      in
      {
        dict_end_poff = pl.dict_end_poff;
        (* When upgrading from v3 to v4, there is only one (appendable) chunk,
           which is the existing suffix, so we set the new [appendable_chunk_poff]
           to [pl.suffix_end_poff]. *)
        appendable_chunk_poff = pl.suffix_end_poff;
        status;
        upgraded_from = Some (Version.to_int `V3);
        checksum = Int63.zero;
        chunk_start_idx = !chunk_start_idx;
        chunk_num = 1;
        volume_num = 0;
      }

    let upgrade_status_from_v4 = function
      | Payload.Upper.V4.From_v1_v2_post_upgrade x ->
          Latest.From_v1_v2_post_upgrade x
      | No_gc_yet -> No_gc_yet
      | Used_non_minimal_indexing_strategy -> Used_non_minimal_indexing_strategy
      | Gced x ->
          Gced
            {
              suffix_start_offset = x.suffix_start_offset;
              generation = x.generation;
              latest_gc_target_offset = x.latest_gc_target_offset;
              suffix_dead_bytes = x.suffix_dead_bytes;
              mapping_end_poff = None;
            }
      | T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8 | T9 | T10 | T11 | T12 | T13 | T14
      | T15 ->
          (* Unreachable *)
          assert false

    let upgrade_from_v4 (pl : Payload.Upper.V4.t) : payload =
      {
        dict_end_poff = pl.dict_end_poff;
        appendable_chunk_poff = pl.appendable_chunk_poff;
        checksum = Int63.zero;
        chunk_start_idx = pl.chunk_start_idx;
        chunk_num = pl.chunk_num;
        status = upgrade_status_from_v4 pl.status;
        upgraded_from = Some (Version.to_int `V4);
        volume_num = 0;
      }

    let of_bin_string ctx string =
      let open Result_syntax in
      let* payload = Data.of_bin_string ctx string in
      match payload with
      | Invalid _ -> Error (`Corrupted_control_file ctx)
      | Valid (V3 payload) -> Ok (upgrade_from_v3 payload)
      | Valid (V4 payload) -> Ok (upgrade_from_v4 payload)
      | Valid (V5 payload) -> Ok payload

    (* Similar yo [of_bin_string] but skips version upgrade *)
    let raw_of_bin_string = Data.of_bin_string
    let to_bin_string payload = Data.(to_bin_string (Valid (V5 payload)))
  end

  module Volume :
    S
      with type payload = Payload.Volume.Latest.t
       and type raw_payload = Payload.Volume.raw_payload = struct
    module Data = struct
      module Plv5 = struct
        include Payload.Volume.V5

        let checksum_encode_bin = Irmin.Type.(unstage (pre_hash t))
        let set_checksum payload checksum = { payload with checksum }
        let get_checksum payload = payload.checksum

        let is_checksum_valid payload =
          Checksum.is_valid ~payload ~encode_bin:checksum_encode_bin
            ~set_checksum ~get_checksum

        let set_checksum payload =
          Checksum.calculate_and_set ~encode_bin:checksum_encode_bin
            ~set_checksum ~payload

        let of_bin_string = Irmin.Type.(unstage (of_bin_string t))
        let to_bin_string = Irmin.Type.(unstage (to_bin_string t))
      end

      type t = Payload.Volume.raw_payload =
        | Valid of version
        | Invalid of version

      and version = Payload.Volume.version = V5 of Plv5.t

      let to_bin_string = function
        | Invalid _ -> assert false
        | Valid (V5 payload) ->
            let payload = Plv5.set_checksum payload in
            Version.to_bin `V5 ^ Plv5.to_bin_string payload

      let of_bin_string ctx s =
        let open Result_syntax in
        let* version, payload = extract_version_and_payload ctx s in
        let route_version () =
          match version with
          | `V3 | `V4 -> assert false
          | `V5 ->
              Plv5.of_bin_string payload >>= fun payload ->
              (match Plv5.is_checksum_valid payload with
              | false -> Invalid (V5 payload)
              | true -> Valid (V5 payload))
              |> Result.ok
        in
        match route_version () with
        | Ok _ as x -> x
        | Error _ -> Error (`Corrupted_control_file ctx)
    end

    module Payload = Data.Plv5

    type payload = Payload.t
    type raw_payload = Data.t

    let of_bin_string ctx string =
      let open Result_syntax in
      let* payload = Data.of_bin_string ctx string in
      match payload with
      | Invalid _ -> Error (`Corrupted_control_file ctx)
      | Valid (V5 payload) -> Ok payload

    let raw_of_bin_string = Data.of_bin_string
    let to_bin_string payload = Data.(to_bin_string (Valid (V5 payload)))
  end
end

module Make (Serde : Serde.S) (Io : Io.S) = struct
  module Io = Io

  type payload = Serde.payload

  type t = {
    mutable io : Io.t;
    mutable payload : payload;
    path : string;
    tmp_path : string option;
  }

  let write io payload =
    let s = Serde.to_bin_string payload in
    Io.write_string io ~off:Int63.zero s

  let set_payload t payload =
    let open Result_syntax in
    if Io.readonly t.io then Error `Ro_not_allowed
    else
      match t.tmp_path with
      | None -> Error `No_tmp_path_provided
      | Some tmp_path ->
          let* () = Io.close t.io in
          let* io_tmp = Io.create ~path:tmp_path ~overwrite:true in
          t.io <- io_tmp;
          let* () = write io_tmp payload in
          let+ () = Io.move_file ~src:tmp_path ~dst:t.path in
          t.payload <- payload

  let read io =
    let open Result_syntax in
    let* string = Io.read_all_to_string io in
    Serde.of_bin_string (Io.path io) string

  let create_rw ~path ~tmp_path ~overwrite (payload : payload) =
    let open Result_syntax in
    let* io = Io.create ~path ~overwrite in
    let+ () = write io payload in
    { io; payload; path; tmp_path }

  let open_ ~path ~tmp_path ~readonly =
    let open Result_syntax in
    let* io = Io.open_ ~path ~readonly in
    let+ payload = read io in
    { io; payload; path; tmp_path }

  let close t = Io.close t.io
  let readonly t = Io.readonly t.io
  let payload t = t.payload

  let reload t =
    let open Result_syntax in
    if not @@ Io.readonly t.io then Error `Rw_not_allowed
    else
      let* () = Io.close t.io in
      let* io = Io.open_ ~path:t.path ~readonly:true in
      t.io <- io;
      let+ payload = read io in
      t.payload <- payload

  let read_payload ~path =
    let open Result_syntax in
    let* io = Io.open_ ~path ~readonly:true in
    let* payload = read io in
    let+ () = Io.close io in
    payload

  let read_raw_payload ~path =
    let open Result_syntax in
    let* io = Io.open_ ~path ~readonly:true in
    let* string = Io.read_all_to_string io in
    let* payload = Serde.raw_of_bin_string path string in
    let+ () = Io.close io in
    payload

  let fsync t = Io.fsync t.io
end

module Upper = Make (Serde.Upper)
module Volume = Make (Serde.Volume)
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct