Source file store.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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
open! Import
include Store_intf
open Merge.Infix
let src = Logs.Src.create "irmin" ~doc:"Irmin branch-consistent store"
module Log = (val Logs.src_log src : Logs.LOG)
module Generic_key = struct
module type S = S_generic_key
module type KV = KV_generic_key
module type Maker = Maker_generic_key
module type KV_maker = KV_maker_generic_key
end
module Make (B : Backend.S) = struct
module Schema = B.Schema
module Contents_key = B.Contents.Key
module Node_key = B.Node.Key
module Commit_key = B.Commit.Key
module Metadata = B.Node.Metadata
module Typed = Hash.Typed (B.Hash)
module Hash = B.Hash
module Branch_store = B.Branch
module Path = B.Node.Path
module Commits = Commit.History (B.Commit)
module Backend = B
module T = Tree.Make (B)
module Info = struct
include B.Commit.Info
let pp = Type.pp t
end
module Contents = struct
include B.Contents.Val
module H = Typed (B.Contents.Val)
let of_key r k = B.Contents.find (B.Repo.contents_t r) k
let of_hash r h =
let store = B.Repo.contents_t r in
B.Contents.index store h >>= function
| None -> Lwt.return_none
| Some k -> B.Contents.find store k
let hash c = H.hash c
end
module Tree = struct
include T
let find_key r t =
match key t with
| Some k -> Lwt.return (Some k)
| None -> (
match hash t with
| `Node h -> (
B.Node.index (B.Repo.node_t r) h >|= function
| None -> None
| Some k -> Some (`Node k))
| `Contents (h, m) -> (
B.Contents.index (B.Repo.contents_t r) h >|= function
| None -> None
| Some k -> Some (`Contents (k, m))))
let of_key r k = import r k
let of_hash r = function
| `Node h -> (
B.Node.index (B.Repo.node_t r) h >>= function
| None -> Lwt.return_none
| Some k -> of_key r (`Node k))
| `Contents (h, m) -> (
B.Contents.index (B.Repo.contents_t r) h >>= function
| None -> Lwt.return_none
| Some k -> of_key r (`Contents (k, m)))
let shallow r h = import_no_check r h
let kinded_hash = hash
let hash : ?cache:bool -> t -> hash =
fun ?cache tr ->
match hash ?cache tr with `Node h -> h | `Contents (h, _) -> h
let pp = Type.pp t
end
type branch = Branch_store.Key.t [@@deriving irmin ~equal ~pp]
type contents_key = B.Contents.Key.t [@@deriving irmin ~pp ~equal]
type node_key = B.Node.Key.t [@@deriving irmin ~pp ~equal]
type commit_key = B.Commit.Key.t [@@deriving irmin ~pp ~equal]
type repo = B.Repo.t
type commit = { r : repo; key : commit_key; v : B.Commit.value }
type hash = Hash.t [@@deriving irmin ~equal ~pp ~compare]
type node = Tree.node [@@deriving irmin]
type contents = Contents.t [@@deriving irmin ~equal]
type metadata = Metadata.t [@@deriving irmin]
type tree = Tree.t [@@deriving irmin ~pp]
type path = Path.t [@@deriving irmin ~pp]
type step = Path.step [@@deriving irmin]
type info = Info.t [@@deriving irmin]
type Remote.t += E of B.Remote.endpoint
type lca_error = [ `Max_depth_reached | `Too_many_lcas ] [@@deriving irmin]
type ff_error = [ `Rejected | `No_change | lca_error ]
type write_error =
[ Merge.conflict | `Too_many_retries of int | `Test_was of tree option ]
let write_error_t =
let open Type in
variant "write-error" (fun c m e -> function
| `Conflict x -> c x | `Too_many_retries x -> m x | `Test_was x -> e x)
|~ case1 "conflict" string (fun x -> `Conflict x)
|~ case1 "too-many-retries" int (fun x -> `Too_many_retries x)
|~ case1 "test-got" (option tree_t) (fun x -> `Test_was x)
|> sealv
let ff_error_t =
Type.enum "ff-error"
[
("max-depth-reached", `Max_depth_reached);
("too-many-lcas", `Too_many_lcas);
("no-change", `No_change);
("rejected", `Rejected);
]
let pp_int = Type.pp Type.int
let save_contents b c = B.Contents.add b c
let save_tree ?(clear = true) r x y (tr : Tree.t) =
match Tree.destruct tr with
| `Contents (c, _) ->
let* c = Tree.Contents.force_exn c in
let+ k = save_contents x c in
`Contents k
| `Node n ->
let+ k = Tree.export ~clear r x y n in
`Node k
module Contents_keys = Set.Make (struct
type t = Contents_key.t [@@deriving irmin ~compare]
end)
module Commit = struct
type t = commit
let t r =
let open Type in
record "commit" (fun key v -> { r; key; v })
|+ field "key" B.Commit.Key.t (fun t -> t.key)
|+ field "value" B.Commit.Val.t (fun t -> t.v)
|> sealr
let v ?(clear = true) r ~info ~parents tree =
B.Repo.batch r @@ fun contents_t node_t commit_t ->
let* node =
match Tree.destruct tree with
| `Node t -> Tree.export ~clear r contents_t node_t t
| `Contents _ -> Lwt.fail_invalid_arg "cannot add contents at the root"
in
let v = B.Commit.Val.v ~info ~node ~parents in
let+ key = B.Commit.add commit_t v in
{ r; key; v }
let node t = B.Commit.Val.node t.v
let tree t = Tree.import_no_check t.r (`Node (node t))
let equal x y = equal_commit_key x.key y.key
let key t = t.key
let hash t = B.Commit.Key.to_hash t.key
let info t = B.Commit.Val.info t.v
let parents t = B.Commit.Val.parents t.v
let pp_hash ppf t = Type.pp Hash.t ppf (hash t)
let pp_key ppf t = Type.pp B.Commit.Key.t ppf t.key
let pp ppf commit = Type.pp (t commit.r) ppf commit
let of_key r key =
B.Commit.find (B.Repo.commit_t r) key >|= function
| None -> None
| Some v -> Some { r; key; v }
let of_hash r hash =
B.Commit.index (B.Repo.commit_t r) hash >>= function
| None -> Lwt.return_none
| Some key -> of_key r key
module H = Typed (B.Commit.Val)
let to_backend_commit t = t.v
let of_backend_commit r key v = { r; key; v }
let equal_opt x y =
match (x, y) with
| None, None -> true
| Some x, Some y -> equal x y
| _ -> false
end
let to_backend_portable_node = Tree.to_backend_portable_node
let to_backend_node = Tree.to_backend_node
let of_backend_node = Tree.of_backend_node
let to_backend_commit = Commit.to_backend_commit
let of_backend_commit = Commit.of_backend_commit
type head_ref = [ `Branch of branch | `Head of commit option ref ]
module OCamlGraph = Graph
module Graph = Node.Graph (B.Node)
module KGraph =
Object_graph.Make (B.Contents.Key) (B.Node.Key) (B.Commit.Key)
(Branch_store.Key)
type slice = B.Slice.t [@@deriving irmin]
type watch = unit -> unit Lwt.t
let unwatch w = w ()
module Repo = struct
type t = repo
let v = B.Repo.v
let config = B.Repo.config
let close = B.Repo.close
let branch_t t = B.Repo.branch_t t
let commit_t t = B.Repo.commit_t t
let node_t t = B.Repo.node_t t
let contents_t t = B.Repo.contents_t t
let branches t = B.Branch.list (branch_t t)
let heads repo =
let t = branch_t repo in
let* bs = Branch_store.list t in
Lwt_list.fold_left_s
(fun acc r ->
Branch_store.find t r >>= function
| None -> Lwt.return acc
| Some k -> (
Commit.of_key repo k >|= function
| None -> acc
| Some h -> h :: acc))
[] bs
let export ?(full = true) ?depth ?(min = []) ?(max = `Head) t =
[%log.debug
"export depth=%s full=%b min=%d max=%s"
(match depth with None -> "<none>" | Some d -> string_of_int d)
full (List.length min)
(match max with
| `Head -> "heads"
| `Max m -> string_of_int (List.length m))];
let* max = match max with `Head -> heads t | `Max m -> Lwt.return m in
let* slice = B.Slice.empty () in
let max = List.map (fun x -> `Commit x.key) max in
let min = List.map (fun x -> `Commit x.key) min in
let pred = function
| `Commit k ->
let+ parents = Commits.parents (commit_t t) k in
List.map (fun x -> `Commit x) parents
| _ -> Lwt.return_nil
in
let* g = KGraph.closure ?depth ~pred ~min ~max () in
let keys =
List.fold_left
(fun acc -> function `Commit c -> c :: acc | _ -> acc)
[] (KGraph.vertex g)
in
let root_nodes = ref [] in
let* () =
Lwt_list.iter_p
(fun k ->
B.Commit.find (commit_t t) k >>= function
| None -> Lwt.return_unit
| Some c ->
root_nodes := B.Commit.Val.node c :: !root_nodes;
B.Slice.add slice (`Commit (Commit_key.to_hash k, c)))
keys
in
if not full then Lwt.return slice
else
let* nodes = Graph.closure (node_t t) ~min:[] ~max:!root_nodes in
let contents = ref Contents_keys.empty in
let* () =
Lwt_list.iter_p
(fun k ->
B.Node.find (node_t t) k >>= function
| None -> Lwt.return_unit
| Some v ->
List.iter
(function
| _, `Contents (c, _) ->
contents := Contents_keys.add c !contents
| _ -> ())
(B.Node.Val.list v);
B.Slice.add slice (`Node (Node_key.to_hash k, v)))
nodes
in
let+ () =
Lwt_list.iter_p
(fun k ->
B.Contents.find (contents_t t) k >>= function
| None -> Lwt.return_unit
| Some m ->
B.Slice.add slice (`Contents (Contents_key.to_hash k, m)))
(Contents_keys.elements !contents)
in
slice
exception Import_error of string
let import_error fmt = Fmt.kstr (fun x -> Lwt.fail (Import_error x)) fmt
let import t s =
let aux name key_to_hash add (h, v) =
let* k' = add v in
let h' = key_to_hash k' in
if not (equal_hash h h') then
import_error "%s import error: expected %a, got %a" name pp_hash h
pp_hash h'
else Lwt.return_unit
in
let contents = ref [] in
let nodes = ref [] in
let commits = ref [] in
let* () =
B.Slice.iter s (function
| `Contents c ->
contents := c :: !contents;
Lwt.return_unit
| `Node n ->
nodes := n :: !nodes;
Lwt.return_unit
| `Commit c ->
commits := c :: !commits;
Lwt.return_unit)
in
B.Repo.batch t @@ fun contents_t node_t commit_t ->
Lwt.catch
(fun () ->
let* () =
Lwt_list.iter_p
(aux "Contents" B.Contents.Key.to_hash
(B.Contents.add contents_t))
!contents
in
Lwt_list.iter_p
(aux "Node" B.Node.Key.to_hash (B.Node.add node_t))
!nodes
>>= fun () ->
let+ () =
Lwt_list.iter_p
(aux "Commit" B.Commit.Key.to_hash (B.Commit.add commit_t))
!commits
in
Ok ())
(function
| Import_error e -> Lwt.return (Error (`Msg e))
| e -> Fmt.kstr Lwt.fail_invalid_arg "impot error: %a" Fmt.exn e)
type elt =
[ `Commit of commit_key
| `Node of node_key
| `Contents of contents_key
| `Branch of B.Branch.Key.t ]
[@@deriving irmin]
let ignore_lwt _ = Lwt.return_unit
let return_false _ = Lwt.return false
let default_pred_contents _ _ = Lwt.return []
let default_pred_node t k =
B.Node.find (node_t t) k >|= function
| None -> []
| Some v ->
List.rev_map
(function
| _, `Node n -> `Node n | _, `Contents (c, _) -> `Contents c)
(B.Node.Val.list v)
let default_pred_commit t c =
B.Commit.find (commit_t t) c >|= function
| None ->
[%log.debug "%a: not found" pp_commit_key c];
[]
| Some c ->
let node = B.Commit.Val.node c in
let parents = B.Commit.Val.parents c in
[ `Node node ] @ List.map (fun k -> `Commit k) parents
let default_pred_branch t b =
B.Branch.find (branch_t t) b >|= function
| None ->
[%log.debug "%a: not found" pp_branch b];
[]
| Some b -> [ `Commit b ]
let iter ?cache_size ~min ~max ?edge ?(branch = ignore_lwt)
?(commit = ignore_lwt) ?(node = ignore_lwt) ?(contents = ignore_lwt)
?(skip_branch = return_false) ?(skip_commit = return_false)
?(skip_node = return_false) ?(skip_contents = return_false)
?(pred_branch = default_pred_branch)
?(pred_commit = default_pred_commit) ?(pred_node = default_pred_node)
?(pred_contents = default_pred_contents) ?(rev = true) t =
let node = function
| `Commit x -> commit x
| `Node x -> node x
| `Contents x -> contents x
| `Branch x -> branch x
in
let skip = function
| `Commit x -> skip_commit x
| `Node x -> skip_node x
| `Contents x -> skip_contents x
| `Branch x -> skip_branch x
in
let pred = function
| `Commit x -> pred_commit t x
| `Node x -> pred_node t x
| `Contents x -> pred_contents t x
| `Branch x -> pred_branch t x
in
KGraph.iter ?cache_size ~pred ~min ~max ~node ?edge ~skip ~rev ()
let breadth_first_traversal ?cache_size ~max ?(branch = ignore_lwt)
?(commit = ignore_lwt) ?(node = ignore_lwt) ?(contents = ignore_lwt)
?(pred_branch = default_pred_branch)
?(pred_commit = default_pred_commit) ?(pred_node = default_pred_node)
?(pred_contents = default_pred_contents) t =
let node = function
| `Commit x -> commit x
| `Node x -> node x
| `Contents x -> contents x
| `Branch x -> branch x
in
let pred = function
| `Commit x -> pred_commit t x
| `Node x -> pred_node t x
| `Contents x -> pred_contents t x
| `Branch x -> pred_branch t x
in
KGraph.breadth_first_traversal ?cache_size ~pred ~max ~node ()
end
type t = {
repo : Repo.t;
head_ref : head_ref;
mutable tree : (commit * tree) option;
lock : Lwt_mutex.t;
}
let repo t = t.repo
let branch_store t = Repo.branch_t t.repo
let commit_store t = Repo.commit_t t.repo
let status t =
match t.head_ref with
| `Branch b -> `Branch b
| `Head h -> ( match !h with None -> `Empty | Some c -> `Commit c)
let head_ref t =
match t.head_ref with
| `Branch t -> `Branch t
| `Head h -> ( match !h with None -> `Empty | Some h -> `Head h)
let branch t =
match head_ref t with
| `Branch t -> Lwt.return_some t
| `Empty | `Head _ -> Lwt.return_none
let err_no_head s = Fmt.kstr Lwt.fail_invalid_arg "Irmin.%s: no head" s
let retry_merge name fn =
let rec aux i =
fn () >>= function
| Error _ as c -> Lwt.return c
| Ok true -> Merge.ok ()
| Ok false ->
[%log.debug "Irmin.%s: conflict, retrying (%d)." name i];
aux (i + 1)
in
aux 1
let of_ref repo head_ref =
let lock = Lwt_mutex.create () in
Lwt.return { lock; head_ref; repo; tree = None }
let err_invalid_branch t =
let err = Fmt.str "%a is not a valid branch name." pp_branch t in
Lwt.fail (Invalid_argument err)
let of_branch repo key =
if Branch_store.Key.is_valid key then of_ref repo (`Branch key)
else err_invalid_branch key
let main repo = of_branch repo Branch_store.Key.main
let master = main
let empty repo = of_ref repo (`Head (ref None))
let of_commit c = of_ref c.r (`Head (ref (Some c)))
let skip_key key =
[%log.debug "[watch-key] key %a has not changed" pp_path key];
Lwt.return_unit
let changed_key key old_t new_t =
[%log.debug
fun l ->
let pp = Fmt.option ~none:(Fmt.any "<none>") pp_hash in
let old_h = Option.map Tree.hash old_t in
let new_h = Option.map Tree.hash new_t in
l "[watch-key] key %a has changed: %a -> %a" pp_path key pp old_h pp
new_h]
let with_tree ~key x f =
x >>= function
| None -> skip_key key
| Some x ->
changed_key key None None;
f x
let lift_tree_diff ~key tree fn = function
| `Removed x ->
with_tree ~key (tree x) @@ fun v ->
changed_key key (Some v) None;
fn @@ `Removed (x, v)
| `Added x ->
with_tree ~key (tree x) @@ fun v ->
changed_key key None (Some v);
fn @@ `Added (x, v)
| `Updated (x, y) -> (
assert (not (Commit.equal x y));
let* vx = tree x in
let* vy = tree y in
match (vx, vy) with
| None, None -> skip_key key
| None, Some vy ->
changed_key key None (Some vy);
fn @@ `Added (y, vy)
| Some vx, None ->
changed_key key (Some vx) None;
fn @@ `Removed (x, vx)
| Some vx, Some vy ->
if Tree.equal vx vy then skip_key key
else (
changed_key key (Some vx) (Some vy);
fn @@ `Updated ((x, vx), (y, vy))))
let head t =
let h =
match head_ref t with
| `Head key -> Lwt.return_some key
| `Empty -> Lwt.return_none
| `Branch name -> (
Branch_store.find (branch_store t) name >>= function
| None -> Lwt.return_none
| Some k -> Commit.of_key t.repo k)
in
let+ h = h in
[%log.debug "Head.find -> %a" Fmt.(option Commit.pp_key) h];
h
let tree_and_head t =
head t >|= function
| None -> None
| Some h -> (
match t.tree with
| Some (o, t) when Commit.equal o h -> Some (o, t)
| _ ->
t.tree <- None;
let tree = Tree.import_no_check (repo t) (`Node (Commit.node h)) in
t.tree <- Some (h, tree);
Some (h, tree))
let tree t =
tree_and_head t >|= function
| None -> Tree.empty ()
| Some (_, tree) -> (tree :> tree)
let lift_head_diff repo fn = function
| `Removed x -> (
Commit.of_key repo x >>= function
| None -> Lwt.return_unit
| Some x -> fn (`Removed x))
| `Updated (x, y) -> (
let* x = Commit.of_key repo x in
let* y = Commit.of_key repo y in
match (x, y) with
| None, None -> Lwt.return_unit
| Some x, None -> fn (`Removed x)
| None, Some y -> fn (`Added y)
| Some x, Some y -> fn (`Updated (x, y)))
| `Added x -> (
Commit.of_key repo x >>= function
| None -> Lwt.return_unit
| Some x -> fn (`Added x))
let watch t ?init fn =
branch t >>= function
| None -> failwith "watch a detached head: TODO"
| Some name0 ->
let init =
match init with
| None -> None
| Some head0 -> Some [ (name0, head0.key) ]
in
let+ key =
Branch_store.watch (branch_store t) ?init (fun name head ->
if equal_branch name0 name then lift_head_diff t.repo fn head
else Lwt.return_unit)
in
fun () -> Branch_store.unwatch (branch_store t) key
let watch_key t key ?init fn =
[%log.debug "watch-key %a" pp_path key];
let tree c = Tree.find_tree (Commit.tree c) key in
watch t ?init (lift_tree_diff ~key tree fn)
module Head = struct
let list = Repo.heads
let find = head
let get t =
find t >>= function None -> err_no_head "head" | Some k -> Lwt.return k
let set t c =
match t.head_ref with
| `Head h ->
h := Some c;
Lwt.return_unit
| `Branch name -> Branch_store.set (branch_store t) name c.key
let test_and_set_unsafe t ~test ~set =
match t.head_ref with
| `Head head ->
if Commit.equal_opt !head test then (
head := set;
Lwt.return_true)
else Lwt.return_false
| `Branch name ->
let h = function None -> None | Some c -> Some c.key in
Branch_store.test_and_set (branch_store t) name ~test:(h test)
~set:(h set)
let test_and_set t ~test ~set =
Lwt_mutex.with_lock t.lock (fun () -> test_and_set_unsafe t ~test ~set)
let fast_forward t ?max_depth ?n new_head =
let return x = if x then Ok () else Error (`Rejected :> ff_error) in
find t >>= function
| None -> test_and_set t ~test:None ~set:(Some new_head) >|= return
| Some old_head -> (
[%log.debug
"fast-forward-head old=%a new=%a" Commit.pp_hash old_head
Commit.pp_hash new_head];
if Commit.equal new_head old_head then
Lwt.return (Error `No_change)
else
Commits.lcas (commit_store t) ?max_depth ?n new_head.key
old_head.key
>>= function
| Ok [ x ] when equal_commit_key x old_head.key ->
test_and_set t ~test:(Some old_head) ~set:(Some new_head)
>|= return
| Ok _ -> Lwt.return (Error `Rejected)
| Error e -> Lwt.return (Error (e :> ff_error)))
let three_way_merge t ?max_depth ?n ~info c1 c2 =
B.Repo.batch (repo t) @@ fun _ _ commit_t ->
Commits.three_way_merge commit_t ?max_depth ?n ~info c1.key c2.key
let merge ~into:t ~info ?max_depth ?n c1 =
[%log.debug "merge_head"];
let aux () =
let* head = head t in
match head with
| None -> test_and_set_unsafe t ~test:head ~set:(Some c1) >>= Merge.ok
| Some c2 ->
three_way_merge t ~info ?max_depth ?n c1 c2 >>=* fun c3 ->
let* c3 = Commit.of_key t.repo c3 in
test_and_set_unsafe t ~test:head ~set:c3 >>= Merge.ok
in
Lwt_mutex.with_lock t.lock (fun () -> retry_merge "merge_head" aux)
end
let retry ~retries fn =
let done_once = ref false in
let rec aux i =
if !done_once && i > retries then
Lwt.return (Error (`Too_many_retries retries))
else
fn () >>= function
| Ok (c, true) -> Lwt.return (Ok c)
| Error e -> Lwt.return (Error e)
| Ok (_, false) ->
done_once := true;
aux (i + 1)
in
aux 0
let root_tree = function
| `Node _ as n -> Tree.v n
| `Contents _ -> assert false
let add_commit t old_head ((c, _) as tree) =
match t.head_ref with
| `Head head ->
Lwt_mutex.with_lock t.lock (fun () ->
if not (Commit.equal_opt old_head !head) then Lwt.return_false
else (
head := Some c;
t.tree <- Some tree;
Lwt.return_true))
| `Branch name ->
let test = match old_head with None -> None | Some c -> Some c.key in
let set = Some c.key in
let+ r = Branch_store.test_and_set (branch_store t) name ~test ~set in
if r then t.tree <- Some tree;
r
let pp_write_error ppf = function
| `Conflict e -> Fmt.pf ppf "Got a conflict: %s" e
| `Too_many_retries i ->
Fmt.pf ppf
"Failure after %d attempts to retry the operation: Too many attempts."
i
| `Test_was t ->
Fmt.pf ppf "Test-and-set failed: got %a when reading the store"
Fmt.(Dump.option pp_tree)
t
let write_error e : ('a, write_error) result Lwt.t = Lwt.return (Error e)
let err_test v = write_error (`Test_was v)
type snapshot = {
head : commit option;
root : tree;
tree : tree option;
parents : commit list;
}
let snapshot t key =
tree_and_head t >>= function
| None ->
Lwt.return
{ head = None; root = Tree.empty (); tree = None; parents = [] }
| Some (c, root) ->
let root = (root :> tree) in
let+ tree = Tree.find_tree root key in
{ head = Some c; root; tree; parents = [ c ] }
let same_tree x y =
match (x, y) with
| None, None -> true
| None, _ | _, None -> false
| Some x, Some y -> Tree.equal x y
let update ?(clear = true) ?(allow_empty = false) ~info ?parents t key
merge_tree f =
let* s = snapshot t key in
let* new_tree = f s.tree in
if same_tree s.tree new_tree && (not allow_empty) && s.head <> None then
Lwt.return (Ok (None, true))
else
merge_tree s.root key ~current_tree:s.tree ~new_tree >>= function
| Error e -> Lwt.return (Error e)
| Ok root ->
let info = info () in
let parents = match parents with None -> s.parents | Some p -> p in
let parents = List.map Commit.key parents in
let* c = Commit.v ~clear (repo t) ~info ~parents root in
let* r = add_commit t s.head (c, root_tree (Tree.destruct root)) in
Lwt.return (Ok (Some c, r))
let ok x = Ok x
let fail name = function
| Ok x -> Lwt.return x
| Error e -> Fmt.kstr Lwt.fail_with "%s: %a" name pp_write_error e
let set_tree_once root key ~current_tree:_ ~new_tree =
match new_tree with
| None -> Tree.remove root key >|= ok
| Some tree -> Tree.add_tree root key tree >|= ok
let ignore_commit
(c : (commit option, [> `Too_many_retries of int ]) result Lwt.t) =
Lwt_result.map (fun _ -> ()) c
let set_tree ?clear ?(retries = 13) ?allow_empty ?parents ~info t k v =
[%log.debug "set %a" pp_path k];
ignore_commit
@@ retry ~retries
@@ fun () ->
update t k ?clear ?allow_empty ?parents ~info set_tree_once @@ fun _tree ->
Lwt.return_some v
let set_tree_exn ?clear ?retries ?allow_empty ?parents ~info t k v =
set_tree ?clear ?retries ?allow_empty ?parents ~info t k v
>>= fail "set_exn"
let remove ?clear ?(retries = 13) ?allow_empty ?parents ~info t k =
[%log.debug "debug %a" pp_path k];
ignore_commit
@@ retry ~retries
@@ fun () ->
update t k ?clear ?allow_empty ?parents ~info set_tree_once @@ fun _tree ->
Lwt.return_none
let remove_exn ?clear ?retries ?allow_empty ?parents ~info t k =
remove ?clear ?retries ?allow_empty ?parents ~info t k >>= fail "remove_exn"
let set ?clear ?retries ?allow_empty ?parents ~info t k v =
let v = Tree.of_contents v in
set_tree t k ?clear ?retries ?allow_empty ?parents ~info v
let set_exn ?clear ?retries ?allow_empty ?parents ~info t k v =
set t k ?clear ?retries ?allow_empty ?parents ~info v >>= fail "set_exn"
let test_and_set_tree_once ~test root key ~current_tree ~new_tree =
match (test, current_tree) with
| None, None -> set_tree_once root key ~new_tree ~current_tree
| None, _ | _, None -> err_test current_tree
| Some test, Some v ->
if Tree.equal test v then set_tree_once root key ~new_tree ~current_tree
else err_test current_tree
let test_set_and_get_tree ?clear ?(retries = 13) ?allow_empty ?parents ~info t
k ~test ~set =
[%log.debug "test-and-set %a" pp_path k];
retry ~retries @@ fun () ->
update t k ?clear ?allow_empty ?parents ~info (test_and_set_tree_once ~test)
@@ fun _tree -> Lwt.return set
let test_set_and_get_tree_exn ?clear ?retries ?allow_empty ?parents ~info t k
~test ~set =
test_set_and_get_tree ?clear ?retries ?allow_empty ?parents ~info t k ~test
~set
>>= fail "test_set_and_get_tree_exn"
let test_set_and_get ?clear ?retries ?allow_empty ?parents ~info t k ~test
~set =
let test = Option.map Tree.of_contents test in
let set = Option.map Tree.of_contents set in
test_set_and_get_tree ?clear ?retries ?allow_empty ?parents ~info t k ~test
~set
let test_set_and_get_exn ?clear ?retries ?allow_empty ?parents ~info t k ~test
~set =
test_set_and_get ?clear ?retries ?allow_empty ?parents ~info t k ~test ~set
>>= fail "test_set_and_get_exn"
let test_and_set_tree ?clear ?(retries = 13) ?allow_empty ?parents ~info t k
~test ~set =
[%log.debug "test-and-set %a" pp_path k];
ignore_commit
@@ test_set_and_get_tree ~retries ?clear ?allow_empty ?parents ~info t k
~test ~set
let test_and_set_tree_exn ?clear ?retries ?allow_empty ?parents ~info t k
~test ~set =
test_and_set_tree ?clear ?retries ?allow_empty ?parents ~info t k ~test ~set
>>= fail "test_and_set_tree_exn"
let test_and_set ?clear ?retries ?allow_empty ?parents ~info t k ~test ~set =
ignore_commit
@@ test_set_and_get ?clear ?retries ?allow_empty ?parents ~info t k ~test
~set
let test_and_set_exn ?clear ?retries ?allow_empty ?parents ~info t k ~test
~set =
test_and_set ?clear ?retries ?allow_empty ?parents ~info t k ~test ~set
>>= fail "test_and_set_exn"
let merge_once ~old root key ~current_tree ~new_tree =
let old = Merge.promise old in
Merge.f (Merge.option Tree.merge) ~old current_tree new_tree >>= function
| Ok tr -> set_tree_once root key ~new_tree:tr ~current_tree
| Error e -> write_error (e :> write_error)
let merge_tree ?clear ?(retries = 13) ?allow_empty ?parents ~info ~old t k
tree =
[%log.debug "merge %a" pp_path k];
ignore_commit
@@ retry ~retries
@@ fun () ->
update t k ?clear ?allow_empty ?parents ~info (merge_once ~old)
@@ fun _tree -> Lwt.return tree
let merge_tree_exn ?clear ?retries ?allow_empty ?parents ~info ~old t k tree =
merge_tree ?clear ?retries ?allow_empty ?parents ~info ~old t k tree
>>= fail "merge_tree_exn"
let merge ?clear ?retries ?allow_empty ?parents ~info ~old t k v =
let old = Option.map Tree.of_contents old in
let v = Option.map Tree.of_contents v in
merge_tree ?clear ?retries ?allow_empty ?parents ~info ~old t k v
let merge_exn ?clear ?retries ?allow_empty ?parents ~info ~old t k v =
merge ?clear ?retries ?allow_empty ?parents ~info ~old t k v
>>= fail "merge_exn"
let mem t k = tree t >>= fun tree -> Tree.mem tree k
let mem_tree t k = tree t >>= fun tree -> Tree.mem_tree tree k
let find_all t k = tree t >>= fun tree -> Tree.find_all tree k
let find t k = tree t >>= fun tree -> Tree.find tree k
let get t k = tree t >>= fun tree -> Tree.get tree k
let find_tree t k = tree t >>= fun tree -> Tree.find_tree tree k
let get_tree t k = tree t >>= fun tree -> Tree.get_tree tree k
let key t k =
find_tree t k >|= function
| None -> None
| Some tree -> (
match Tree.key tree with
| Some (`Contents (key, _)) -> Some (`Contents key)
| Some (`Node key) -> Some (`Node key)
| None -> None)
let hash t k =
find_tree t k >|= function
| None -> None
| Some tree -> Some (Tree.hash tree)
let get_all t k = tree t >>= fun tree -> Tree.get_all tree k
let list t k = tree t >>= fun tree -> Tree.list tree k
let kind t k = tree t >>= fun tree -> Tree.kind tree k
let with_tree ?clear ?(retries = 13) ?allow_empty ?parents
?(strategy = `Test_and_set) ~info t key f =
let done_once = ref false in
let rec aux n old_tree =
[%log.debug "with_tree %a (%d/%d)" pp_path key n retries];
if !done_once && n > retries then write_error (`Too_many_retries retries)
else
let* new_tree = f old_tree in
match (strategy, new_tree) with
| `Set, Some tree ->
set_tree ?clear t key ~retries ?allow_empty ?parents tree ~info
| `Set, None -> remove ?clear t key ~retries ?allow_empty ~info ?parents
| `Test_and_set, _ -> (
test_and_set_tree ?clear t key ~retries ?allow_empty ?parents ~info
~test:old_tree ~set:new_tree
>>= function
| Error (`Test_was tr) when retries > 0 && n <= retries ->
done_once := true;
aux (n + 1) tr
| e -> Lwt.return e)
| `Merge, _ -> (
merge_tree ?clear ~old:old_tree ~retries ?allow_empty ?parents ~info
t key new_tree
>>= function
| Ok _ as x -> Lwt.return x
| Error (`Conflict _) when retries > 0 && n <= retries ->
done_once := true;
let* old_tree =
tree_and_head t >>= function
| None -> Lwt.return_none
| Some (_, tr) -> Tree.find_tree (tr :> tree) key
in
aux (n + 1) old_tree
| Error e -> write_error e)
in
let* old_tree = find_tree t key in
aux 0 old_tree
let with_tree_exn ?clear ?retries ?allow_empty ?parents ?strategy ~info f t
key =
with_tree ?clear ?retries ?allow_empty ?strategy ?parents ~info f t key
>>= fail "with_tree_exn"
let clone ~src ~dst =
let* () =
Head.find src >>= function
| None -> Branch_store.remove (branch_store src) dst
| Some h -> Branch_store.set (branch_store src) dst h.key
in
of_branch (repo src) dst
let return_lcas r = function
| Error _ as e -> Lwt.return e
| Ok commits ->
Lwt_list.filter_map_p (Commit.of_key r) commits >|= Result.ok
let lcas ?max_depth ?n t1 t2 =
let* h1 = Head.get t1 in
let* h2 = Head.get t2 in
Commits.lcas (commit_store t1) ?max_depth ?n h1.key h2.key
>>= return_lcas t1.repo
let lcas_with_commit t ?max_depth ?n c =
let* h = Head.get t in
Commits.lcas (commit_store t) ?max_depth ?n h.key c.key
>>= return_lcas t.repo
let lcas_with_branch t ?max_depth ?n b =
let* h = Head.get t in
let* head = Head.get { t with head_ref = `Branch b } in
Commits.lcas (commit_store t) ?max_depth ?n h.key head.key
>>= return_lcas t.repo
type 'a merge =
info:Info.f ->
?max_depth:int ->
?n:int ->
'a ->
(unit, Merge.conflict) result Lwt.t
let merge_with_branch t ~info ?max_depth ?n other =
[%log.debug "merge_with_branch %a" pp_branch other];
Branch_store.find (branch_store t) other >>= function
| None ->
Fmt.kstr Lwt.fail_invalid_arg
"merge_with_branch: %a is not a valid branch ID" pp_branch other
| Some c -> (
Commit.of_key t.repo c >>= function
| None -> Lwt.fail_invalid_arg "invalid commit"
| Some c -> Head.merge ~into:t ~info ?max_depth ?n c)
let merge_with_commit t ~info ?max_depth ?n other =
Head.merge ~into:t ~info ?max_depth ?n other
let merge_into ~into ~info ?max_depth ?n t =
[%log.debug "merge"];
match head_ref t with
| `Branch name -> merge_with_branch into ~info ?max_depth ?n name
| `Head h -> merge_with_commit into ~info ?max_depth ?n h
| `Empty -> Merge.ok ()
module History = OCamlGraph.Persistent.Digraph.ConcreteBidirectional (struct
type t = commit
let hash h = B.Hash.short_hash (Commit.hash h)
let compare_key = Type.(unstage (compare B.Commit.Key.t))
let compare x y = compare_key x.key y.key
let equal x y = equal_commit_key x.key y.key
end)
module Gmap = struct
module Src = KGraph
module Dst = struct
include History
let empty () = empty
end
let filter_map f g =
let t = Dst.empty () in
if Src.nb_vertex g = 1 then
match Src.vertex g with
| [ v ] -> (
f v >|= function Some v -> Dst.add_vertex t v | None -> t)
| _ -> assert false
else
Src.fold_edges
(fun x y t ->
let* t = t in
let* x = f x in
let+ y = f y in
match (x, y) with
| Some x, Some y ->
let t = Dst.add_vertex t x in
let t = Dst.add_vertex t y in
Dst.add_edge t x y
| _ -> t)
g (Lwt.return t)
end
let history ?depth ?(min = []) ?(max = []) t =
[%log.debug "history"];
let pred = function
| `Commit k ->
Commits.parents (commit_store t) k
>>= Lwt_list.filter_map_p (Commit.of_key t.repo)
>|= fun parents -> List.map (fun x -> `Commit x.key) parents
| _ -> Lwt.return_nil
in
let* max = Head.find t >|= function Some h -> [ h ] | None -> max in
let max = List.map (fun k -> `Commit k.key) max in
let min = List.map (fun k -> `Commit k.key) min in
let* g = Gmap.Src.closure ?depth ~min ~max ~pred () in
Gmap.filter_map
(function `Commit k -> Commit.of_key t.repo k | _ -> Lwt.return_none)
g
module Heap = Binary_heap.Make (struct
type t = commit * int
let compare c1 c2 =
-Int64.compare
(Info.date (Commit.info (fst c1)))
(Info.date (Commit.info (fst c2)))
end)
let last_modified ?depth ?(n = 1) t key =
[%log.debug
"last_modified depth=%a n=%d key=%a"
Fmt.(Dump.option pp_int)
depth n pp_path key];
let repo = repo t in
let* commit = Head.get t in
let heap = Heap.create ~dummy:(commit, 0) 0 in
let () = Heap.add heap (commit, 0) in
let rec search acc =
if Heap.is_empty heap || List.length acc = n then Lwt.return acc
else
let current, current_depth = Heap.pop_minimum heap in
let parents = Commit.parents current in
let tree = Commit.tree current in
let* current_value = Tree.find tree key in
if List.length parents = 0 then
if current_value <> None then Lwt.return (current :: acc)
else Lwt.return acc
else
let max_depth =
match depth with
| Some depth -> current_depth >= depth
| None -> false
in
let* found =
Lwt_list.for_all_p
(fun hash ->
Commit.of_key repo hash >>= function
| Some commit -> (
let () =
if not max_depth then
Heap.add heap (commit, current_depth + 1)
in
let tree = Commit.tree commit in
let+ e = Tree.find tree key in
match (e, current_value) with
| Some x, Some y -> not (equal_contents x y)
| Some _, None -> true
| None, Some _ -> true
| _, _ -> false)
| None -> Lwt.return_false)
parents
in
if found then search (current :: acc) else search acc
in
search []
module Branch = struct
include B.Branch.Key
let mem t = B.Branch.mem (B.Repo.branch_t t)
let find t br =
B.Branch.find (Repo.branch_t t) br >>= function
| None -> Lwt.return_none
| Some h -> Commit.of_key t h
let set t br h = B.Branch.set (B.Repo.branch_t t) br h.key
let remove t = B.Branch.remove (B.Repo.branch_t t)
let list = Repo.branches
let watch t k ?init f =
let init = match init with None -> None | Some h -> Some h.key in
let+ w =
B.Branch.watch_key (Repo.branch_t t) k ?init (lift_head_diff t f)
in
fun () -> Branch_store.unwatch (Repo.branch_t t) w
let watch_all t ?init f =
let init =
match init with
| None -> None
| Some i -> Some (List.map (fun (k, v) -> (k, v.key)) i)
in
let f k v = lift_head_diff t (f k) v in
let+ w = B.Branch.watch (Repo.branch_t t) ?init f in
fun () -> Branch_store.unwatch (Repo.branch_t t) w
let err_not_found k =
Fmt.kstr invalid_arg "Branch.get: %a not found" pp_branch k
let get t k =
find t k >>= function None -> err_not_found k | Some v -> Lwt.return v
let pp = pp_branch
end
module Status = struct
type t = [ `Empty | `Branch of branch | `Commit of commit ]
let t r =
let open Type in
variant "status" (fun empty branch commit -> function
| `Empty -> empty | `Branch b -> branch b | `Commit c -> commit c)
|~ case0 "empty" `Empty
|~ case1 "branch" Branch.t (fun b -> `Branch b)
|~ case1 "commit" (Commit.t r) (fun c -> `Commit c)
|> sealv
let pp ppf = function
| `Empty -> Fmt.string ppf "empty"
| `Branch b -> pp_branch ppf b
| `Commit c -> pp_hash ppf (Commit_key.to_hash c.key)
end
let commit_t = Commit.t
end
module Json_tree (Store : S with type Schema.Contents.t = Contents.json) =
struct
include Contents.Json_value
type json = Contents.json
let to_concrete_tree j : Store.Tree.concrete =
let rec obj j acc =
match j with
| [] -> `Tree acc
| (k, v) :: l -> (
match Type.of_string Store.Path.step_t k with
| Ok key -> obj l ((key, node v []) :: acc)
| _ -> obj l acc)
and node j acc =
match j with
| `O j -> obj j acc
| _ -> `Contents (j, Store.Metadata.default)
in
node j []
let of_concrete_tree c : json =
let step = Type.to_string Store.Path.step_t in
let rec tree t acc =
match t with
| [] -> `O acc
| (k, v) :: l -> tree l ((step k, contents v []) :: acc)
and contents t acc =
match t with `Contents (c, _) -> c | `Tree c -> tree c acc
in
contents c []
let set_tree (tree : Store.tree) key j : Store.tree Lwt.t =
let c = to_concrete_tree j in
let c = Store.Tree.of_concrete c in
Store.Tree.add_tree tree key c
let get_tree (tree : Store.tree) key =
let* t = Store.Tree.get_tree tree key in
let+ c = Store.Tree.to_concrete t in
of_concrete_tree c
let set t key j ~info =
set_tree (Store.Tree.empty ()) Store.Path.empty j >>= function
| tree -> Store.set_tree_exn ~info t key tree
let get t key =
let* tree = Store.get_tree t key in
get_tree tree Store.Path.empty
end
type Remote.t +=
| Store : (module Generic_key.S with type t = 'a) * 'a -> Remote.t