hashtree-lmdb 0.2.91

LMDB-backed content-addressed blob storage for hashtree
Documentation
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
use super::member::{open_member_reader, verify_member_path};
use super::{
    decode_manifest, map_heed, validate_controlled_manifest, LocationRecord, PoolCatalogLocation,
    PoolManifest, PoolMemberConfig, PoolMemberId, PoolMemberState, PoolStoreConfig,
    CATALOG_DATABASES, CATALOG_MAX_READERS, EXTERNAL_MARKER_NAME, MANIFEST_KEY, MEMBER_MARKER_NAME,
};
use crate::{managed_env::ManagedEnv, ExternalBlobOptions, LmdbBlobReader};
use async_trait::async_trait;
use hashtree_core::store::{slice_blob_range, Store, StoreError, StoreStats};
use hashtree_core::{sha256, to_hex, types::Hash};
use heed::types::Bytes;
use heed::{Database, EnvFlags};
use sha2::{Digest, Sha256};
use std::collections::HashMap;
use std::path::Path;
use std::sync::Arc;

struct ReadOnlyPoolStoreInner {
    // Keep the catalog environment alive for the named database handle.
    _env: ManagedEnv,
    manifest: Database<Bytes, Bytes>,
    opened_manifest_bytes: Vec<u8>,
    opened_manifest_sha256: String,
    locations: Database<Bytes, Bytes>,
    members: HashMap<PoolMemberId, Arc<LmdbBlobReader>>,
    manifest_snapshot: ReadOnlyPoolManifestSnapshot,
}

/// Strictly read-only view of an existing PoolStore catalog and its members.
///
/// Unlike [`super::PoolStore::open`], this constructor never creates a path,
/// opens a write transaction, repairs pending records, records temperature
/// samples, or starts a worker. It is intended for live-data verification.
/// LMDB can still update reader bookkeeping in `lock.mdb`; `data.mdb` remains
/// read-only. On Windows, catalog growth requires reopening the reader after
/// a `MapResized` error because its mapping covers the file size at open.
#[derive(Clone)]
pub struct ReadOnlyPoolStore {
    inner: Arc<ReadOnlyPoolStoreInner>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ReadOnlyPoolCatalogAudit {
    pub stored_locations: u64,
    pub sha256: String,
    pub manifest_sha256: String,
}

/// One exact member record from a read-only Pool manifest snapshot.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ReadOnlyPoolManifestMember {
    pub id: PoolMemberId,
    pub state: PoolMemberState,
    pub config: PoolMemberConfig,
}

/// The exact stored Pool manifest observed while opening a read-only reader.
///
/// `sha256` covers the stored manifest bytes, including generation, member
/// ordering, member states, and every member configuration field.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ReadOnlyPoolManifestSnapshot {
    pub generation: u64,
    pub sha256: Hash,
    pub members: Vec<ReadOnlyPoolManifestMember>,
}

fn require_opened_manifest(
    current: &[u8],
    opened: &[u8],
    opened_sha256: &str,
) -> Result<(), StoreError> {
    if current != opened {
        return Err(StoreError::Other(format!(
            "pool manifest changed after read-only members were opened: expected {opened_sha256}, found {}",
            to_hex(&sha256(current))
        )));
    }
    Ok(())
}

impl ReadOnlyPoolStore {
    pub fn open<P: AsRef<Path>>(path: P) -> Result<Self, StoreError> {
        Self::open_inner(path.as_ref(), None)
    }

    /// Open an exact, read-only Pool authority captured by a controller.
    ///
    /// A controlled open requires a pinned catalog LMDB identity, the exact
    /// manifest SHA-256, one exact runtime binding for every manifest member,
    /// and disabled temperature tracking. Member readers use only those
    /// runtime paths and pinned LMDB identities.
    pub fn open_controlled<P: AsRef<Path>>(
        path: P,
        config: PoolStoreConfig,
    ) -> Result<Self, StoreError> {
        if config.temperature.enabled {
            return Err(StoreError::Other(
                "controlled read-only Pool open requires temperature tracking to be disabled"
                    .into(),
            ));
        }
        if config.catalog_lmdb_identity.is_none()
            || config.expected_manifest_sha256.is_none()
            || config.member_runtime_paths.is_empty()
        {
            return Err(StoreError::Other(
                "controlled read-only Pool open requires catalog identity, exact manifest SHA-256, and every member runtime binding".into(),
            ));
        }
        Self::open_inner(path.as_ref(), Some(config))
    }

    fn open_inner(path: &Path, config: Option<PoolStoreConfig>) -> Result<Self, StoreError> {
        if !path.join("data.mdb").is_file() {
            return Err(StoreError::Other(format!(
                "read-only pool catalog is missing at {}",
                path.display()
            )));
        }

        let mut options = ManagedEnv::read_only_options(path).map_err(map_heed)?;
        options
            .max_dbs(CATALOG_DATABASES)
            .max_readers(CATALOG_MAX_READERS);
        unsafe {
            options.flags(EnvFlags::NO_READ_AHEAD);
        }
        let env = unsafe {
            match config
                .as_ref()
                .and_then(|config| config.catalog_lmdb_identity)
            {
                Some(identity) => ManagedEnv::open_pinned(&options, path, identity),
                None => ManagedEnv::open(&options, path),
            }
        }
        .map_err(|error| {
            StoreError::Other(format!(
                "open read-only pool catalog {}: {error}",
                path.display()
            ))
        })?;
        let rtxn = env.read_txn().map_err(map_heed)?;
        let manifest_db = env
            .open_database::<Bytes, Bytes>(&rtxn, Some("manifest"))
            .map_err(map_heed)?
            .ok_or_else(|| StoreError::Other("pool manifest database is missing".into()))?;
        let locations = env
            .open_database::<Bytes, Bytes>(&rtxn, Some("locations"))
            .map_err(map_heed)?
            .ok_or_else(|| StoreError::Other("pool locations database is missing".into()))?;
        let manifest_bytes = manifest_db
            .get(&rtxn, MANIFEST_KEY)
            .map_err(map_heed)?
            .ok_or_else(|| StoreError::Other("pool manifest is missing".into()))?;
        let opened_manifest_bytes = manifest_bytes.to_vec();
        let opened_manifest_sha256 = to_hex(&sha256(&opened_manifest_bytes));
        let mut member_runtime_paths = config
            .as_ref()
            .map(|config| {
                config
                    .member_runtime_paths
                    .iter()
                    .map(|binding| (binding.id, binding.clone()))
                    .collect::<HashMap<_, _>>()
            })
            .unwrap_or_default();
        if config
            .as_ref()
            .is_some_and(|config| member_runtime_paths.len() != config.member_runtime_paths.len())
        {
            return Err(StoreError::Other(
                "duplicate runtime path binding for controlled read-only Pool open".into(),
            ));
        }
        let manifest = match config
            .as_ref()
            .and_then(|config| config.expected_manifest_sha256)
        {
            Some(expected) => validate_controlled_manifest(
                &opened_manifest_bytes,
                expected,
                &member_runtime_paths,
            )?,
            None => decode_manifest(&opened_manifest_bytes)?,
        };
        let manifest_snapshot = ReadOnlyPoolManifestSnapshot {
            generation: manifest.generation,
            sha256: sha256(&opened_manifest_bytes),
            members: manifest
                .members
                .iter()
                .map(|member| ReadOnlyPoolManifestMember {
                    id: member.id,
                    state: member.state,
                    config: member.config.clone(),
                })
                .collect(),
        };
        // Publish DBI handles before later transactions use them.
        rtxn.commit().map_err(map_heed)?;

        let members = if config.is_some() {
            open_controlled_members(&manifest, &mut member_runtime_paths)?
        } else {
            open_members(&manifest)?
        };
        Ok(Self {
            inner: Arc::new(ReadOnlyPoolStoreInner {
                _env: env,
                manifest: manifest_db,
                opened_manifest_bytes,
                opened_manifest_sha256,
                locations,
                members,
                manifest_snapshot,
            }),
        })
    }

    /// Return the exact manifest snapshot captured by this reader.
    ///
    /// This first proves that the live manifest still matches the opened
    /// bytes, so callers cannot accidentally pin a stale topology.
    pub fn manifest_snapshot(&self) -> Result<ReadOnlyPoolManifestSnapshot, StoreError> {
        let rtxn = self.inner._env.read_txn().map_err(map_heed)?;
        let manifest = self
            .inner
            .manifest
            .get(&rtxn, MANIFEST_KEY)
            .map_err(map_heed)?
            .ok_or_else(|| StoreError::Other("pool manifest is missing".into()))?;
        require_opened_manifest(
            manifest,
            &self.inner.opened_manifest_bytes,
            &self.inner.opened_manifest_sha256,
        )?;
        decode_manifest(manifest)?;
        Ok(self.inner.manifest_snapshot.clone())
    }

    /// Return exact catalog state for many hashes in one read transaction.
    ///
    /// `Pending` and `Moving` are deliberately preserved so crash recovery
    /// cannot mistake physical bytes for committed catalog residency.
    pub fn blob_catalog_locations(
        &self,
        hashes: &[Hash],
    ) -> Result<Vec<PoolCatalogLocation>, StoreError> {
        let rtxn = self.inner._env.read_txn().map_err(map_heed)?;
        let manifest = self
            .inner
            .manifest
            .get(&rtxn, MANIFEST_KEY)
            .map_err(map_heed)?
            .ok_or_else(|| StoreError::Other("pool manifest is missing".into()))?;
        require_opened_manifest(
            manifest,
            &self.inner.opened_manifest_bytes,
            &self.inner.opened_manifest_sha256,
        )?;
        hashes
            .iter()
            .map(|hash| {
                let record = self
                    .inner
                    .locations
                    .get(&rtxn, hash)
                    .map_err(map_heed)?
                    .map(LocationRecord::decode)
                    .transpose()?;
                Ok(match record {
                    None => PoolCatalogLocation::Missing,
                    Some(LocationRecord::Pending { member, size }) => {
                        PoolCatalogLocation::Pending { member, size }
                    }
                    Some(LocationRecord::Stored { member, size }) => {
                        PoolCatalogLocation::Stored { member, size }
                    }
                    Some(LocationRecord::Moving {
                        source,
                        target,
                        size,
                    }) => PoolCatalogLocation::Moving {
                        source,
                        target,
                        size,
                    },
                })
            })
            .collect()
    }

    fn read_location(&self, hash: &Hash) -> Result<Option<LocationRecord>, StoreError> {
        let rtxn = self.inner._env.read_txn().map_err(map_heed)?;
        self.inner
            .locations
            .get(&rtxn, hash)
            .map_err(map_heed)?
            .map(LocationRecord::decode)
            .transpose()
    }

    /// Prove that the entire catalog contains only committed locations.
    ///
    /// Terminal verification must not silently read through an interrupted
    /// pending write or member move, even when one of its copies happens to
    /// contain valid bytes.
    pub fn validate_committed_catalog(&self) -> Result<ReadOnlyPoolCatalogAudit, StoreError> {
        let rtxn = self.inner._env.read_txn().map_err(map_heed)?;
        let manifest = self
            .inner
            .manifest
            .get(&rtxn, MANIFEST_KEY)
            .map_err(map_heed)?
            .ok_or_else(|| StoreError::Other("pool manifest is missing".into()))?;
        require_opened_manifest(
            manifest,
            &self.inner.opened_manifest_bytes,
            &self.inner.opened_manifest_sha256,
        )?;
        // Decode again so corruption cannot be hidden by byte equality alone.
        decode_manifest(manifest)?;
        let mut digest = Sha256::new();
        digest.update(b"hashtree-read-only-pool-catalog-v1\0");
        digest.update((manifest.len() as u64).to_be_bytes());
        digest.update(manifest);
        let mut stored = 0u64;
        for item in self.inner.locations.iter(&rtxn).map_err(map_heed)? {
            let (hash, encoded) = item.map_err(map_heed)?;
            let hash: Hash = hash
                .try_into()
                .map_err(|_| StoreError::Other("invalid pool catalog hash key".into()))?;
            let location = LocationRecord::decode(encoded)?;
            match location {
                LocationRecord::Stored { member, .. } => {
                    if !self.inner.members.contains_key(&member) {
                        return Err(StoreError::Other(format!(
                            "pool catalog location {} references unknown member {member}",
                            to_hex(&hash)
                        )));
                    }
                    stored = stored.checked_add(1).ok_or_else(|| {
                        StoreError::Other("pool catalog location count overflow".into())
                    })?;
                }
                LocationRecord::Pending { .. } => {
                    return Err(StoreError::Other(format!(
                        "pool catalog contains pending location {}",
                        to_hex(&hash)
                    )));
                }
                LocationRecord::Moving { .. } => {
                    return Err(StoreError::Other(format!(
                        "pool catalog contains moving location {}",
                        to_hex(&hash)
                    )));
                }
            }
            digest.update(hash);
            digest.update((encoded.len() as u64).to_be_bytes());
            digest.update(encoded);
        }
        let digest: Hash = digest.finalize().into();
        Ok(ReadOnlyPoolCatalogAudit {
            stored_locations: stored,
            sha256: to_hex(&digest),
            manifest_sha256: self.inner.opened_manifest_sha256.clone(),
        })
    }

    /// Require every member that stores external blobs to fsync those files
    /// before committing its catalog location. LMDB environment sync alone
    /// cannot make an external file durable when this manifest flag is false.
    pub fn require_durable_external_blob_writes(&self) -> Result<(), StoreError> {
        let manifest = decode_manifest(&self.inner.opened_manifest_bytes)?;
        for member in manifest.members {
            if member.config.external_blob_dir.is_some() && !member.config.external_blob_sync {
                return Err(StoreError::Other(format!(
                    "pool member {} has external_blob_sync disabled",
                    member.id
                )));
            }
        }
        Ok(())
    }

    pub fn get_sync(&self, hash: &Hash) -> Result<Option<Vec<u8>>, StoreError> {
        let Some(location) = self.read_location(hash)? else {
            return Ok(None);
        };
        let id = match location {
            LocationRecord::Stored { member, .. } => member,
            LocationRecord::Pending { .. } => {
                return Err(StoreError::Other(format!(
                    "read-only terminal verification rejected pending pool location {}",
                    to_hex(hash)
                )));
            }
            LocationRecord::Moving { .. } => {
                return Err(StoreError::Other(format!(
                    "read-only terminal verification rejected moving pool location {}",
                    to_hex(hash)
                )));
            }
        };
        let member = self.inner.members.get(&id).ok_or_else(|| {
            StoreError::Other(format!("pool location references unknown member {id}"))
        })?;
        match member.get_sync(hash)? {
            Some(data) if sha256(&data) == *hash && data.len() as u64 == location.size() => {
                Ok(Some(data))
            }
            Some(_) => Err(StoreError::Other(format!(
                "read-only pool member {id} returned corrupt or size-mismatched bytes"
            ))),
            None => Err(StoreError::Other(format!(
                "pool catalog location {} references missing bytes on member {id}",
                to_hex(hash)
            ))),
        }
    }

    pub fn blob_size_sync(&self, hash: &Hash) -> Result<Option<u64>, StoreError> {
        let Some(location) = self.read_location(hash)? else {
            return Ok(None);
        };
        match location {
            LocationRecord::Stored { member, size } => {
                let member_store = self.inner.members.get(&member).ok_or_else(|| {
                    StoreError::Other(format!("pool location references unknown member {member}"))
                })?;
                match member_store.blob_size_sync(hash)? {
                    Some(member_size) if member_size == size => Ok(Some(size)),
                    Some(member_size) => Err(StoreError::Other(format!(
                        "pool catalog size {size} for {} differs from member {member} size {member_size}",
                        to_hex(hash)
                    ))),
                    None => Err(StoreError::Other(format!(
                        "pool catalog location {} references missing bytes on member {member}",
                        to_hex(hash)
                    ))),
                }
            }
            LocationRecord::Pending { .. } => Err(StoreError::Other(format!(
                "read-only terminal verification rejected pending pool location {}",
                to_hex(hash)
            ))),
            LocationRecord::Moving { .. } => Err(StoreError::Other(format!(
                "read-only terminal verification rejected moving pool location {}",
                to_hex(hash)
            ))),
        }
    }

    pub fn get_range_sync(
        &self,
        hash: &Hash,
        start: u64,
        end_inclusive: u64,
    ) -> Result<Option<Vec<u8>>, StoreError> {
        self.get_sync(hash)?
            .map(|data| slice_blob_range(&data, start, end_inclusive))
            .transpose()
    }
}

fn open_members(
    manifest: &PoolManifest,
) -> Result<HashMap<PoolMemberId, Arc<LmdbBlobReader>>, StoreError> {
    let mut stores = HashMap::with_capacity(manifest.members.len());
    for member in &manifest.members {
        let config = &member.config;
        verify_member_path(&config.path, MEMBER_MARKER_NAME, member.id)?;
        let external = external_options(member.id, config)?;
        if stores
            .insert(
                member.id,
                Arc::new(LmdbBlobReader::open(&config.path, external)?),
            )
            .is_some()
        {
            return Err(StoreError::Other(format!(
                "pool manifest repeats member {}",
                member.id
            )));
        }
    }
    Ok(stores)
}

fn open_controlled_members(
    manifest: &PoolManifest,
    bindings: &mut HashMap<PoolMemberId, super::PoolMemberRuntimePaths>,
) -> Result<HashMap<PoolMemberId, Arc<LmdbBlobReader>>, StoreError> {
    let mut stores = HashMap::with_capacity(manifest.members.len());
    for member in &manifest.members {
        let binding = bindings.remove(&member.id).ok_or_else(|| {
            StoreError::Other(format!(
                "controlled read-only Pool open has no runtime binding for member {}",
                member.id
            ))
        })?;
        let mut runtime_config = member.config.clone();
        runtime_config.path = binding.runtime_path;
        runtime_config.external_blob_dir = binding.runtime_external_path;
        let reader = open_member_reader(
            member.id,
            &runtime_config,
            Some(binding.lmdb_identity),
            false,
            1,
        )?;
        if stores.insert(member.id, Arc::new(reader)).is_some() {
            return Err(StoreError::Other(format!(
                "pool manifest repeats member {}",
                member.id
            )));
        }
    }
    if let Some(unexpected) = bindings.keys().next() {
        return Err(StoreError::Other(format!(
            "controlled read-only Pool open has runtime binding for unknown member {unexpected}"
        )));
    }
    Ok(stores)
}

fn external_options(
    id: PoolMemberId,
    config: &PoolMemberConfig,
) -> Result<Option<ExternalBlobOptions>, StoreError> {
    match (
        config.external_blob_dir.as_ref(),
        config.external_blob_min_bytes,
    ) {
        (Some(path), Some(min_bytes)) => {
            verify_member_path(path, EXTERNAL_MARKER_NAME, id)?;
            Ok(Some(ExternalBlobOptions {
                base_path: path.clone(),
                min_bytes: usize::try_from(min_bytes).map_err(|_| {
                    StoreError::Other("pool external blob threshold exceeds usize".into())
                })?,
                sync: config.external_blob_sync,
                pack_target_bytes: config
                    .external_pack_target_bytes
                    .map(usize::try_from)
                    .transpose()
                    .map_err(|_| {
                        StoreError::Other("pool external pack target exceeds usize".into())
                    })?,
            }))
        }
        (None, None) => Ok(None),
        _ => Err(StoreError::Other(
            "invalid pool external blob configuration".into(),
        )),
    }
}

fn read_only_error() -> StoreError {
    StoreError::Other("read-only PoolStore does not permit mutation".into())
}

#[async_trait]
impl Store for ReadOnlyPoolStore {
    async fn put(&self, _hash: Hash, _data: Vec<u8>) -> Result<bool, StoreError> {
        Err(read_only_error())
    }

    async fn get(&self, hash: &Hash) -> Result<Option<Vec<u8>>, StoreError> {
        self.get_sync(hash)
    }

    async fn get_range(
        &self,
        hash: &Hash,
        start: u64,
        end_inclusive: u64,
    ) -> Result<Option<Vec<u8>>, StoreError> {
        self.get_sync(hash)?
            .map(|data| slice_blob_range(&data, start, end_inclusive))
            .transpose()
    }

    async fn blob_size(&self, hash: &Hash) -> Result<Option<u64>, StoreError> {
        self.blob_size_sync(hash)
    }

    async fn has(&self, hash: &Hash) -> Result<bool, StoreError> {
        Ok(self.get_sync(hash)?.is_some())
    }

    async fn delete(&self, _hash: &Hash) -> Result<bool, StoreError> {
        Err(read_only_error())
    }

    async fn stats(&self) -> StoreStats {
        StoreStats::default()
    }

    async fn pin(&self, _hash: &Hash) -> Result<(), StoreError> {
        Err(read_only_error())
    }

    async fn unpin(&self, _hash: &Hash) -> Result<(), StoreError> {
        Err(read_only_error())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{
        PinnedLmdbFileIdentity, PinnedLmdbIdentity, PoolMemberRuntimePaths, PoolStore,
        PoolStoreConfig,
    };
    use std::fs;
    #[cfg(unix)]
    use std::fs::File;
    #[cfg(target_os = "linux")]
    use std::os::fd::AsRawFd;
    #[cfg(unix)]
    use std::os::unix::fs::MetadataExt;
    use std::process::Command;
    use tempfile::TempDir;

    const MUTATE_CATALOG_ENV: &str = "HASHTREE_READ_ONLY_MUTATE_CATALOG";
    const MUTATE_MEMBER_ENV: &str = "HASHTREE_READ_ONLY_MUTATE_MEMBER";

    fn file_sha256(path: &Path) -> Hash {
        sha256(&fs::read(path).expect("read LMDB data file"))
    }

    fn file_modified(path: &Path) -> std::time::SystemTime {
        fs::metadata(path)
            .expect("read LMDB data file metadata")
            .modified()
            .expect("read LMDB data file mtime")
    }

    fn pool_config() -> PoolStoreConfig {
        let mut config = PoolStoreConfig::default();
        config.temperature.enabled = false;
        config
    }

    #[cfg(unix)]
    fn lmdb_identity(path: &Path) -> PinnedLmdbIdentity {
        let data = fs::metadata(path.join("data.mdb")).expect("data.mdb metadata");
        let lock = fs::metadata(path.join("lock.mdb")).expect("lock.mdb metadata");
        PinnedLmdbIdentity {
            data: PinnedLmdbFileIdentity {
                device: data.dev(),
                inode: data.ino(),
            },
            lock: PinnedLmdbFileIdentity {
                device: lock.dev(),
                inode: lock.ino(),
            },
        }
    }

    #[cfg(unix)]
    struct PinnedDirectory {
        _directory: File,
        runtime_path: std::path::PathBuf,
    }

    #[cfg(unix)]
    fn pin_directory(path: &Path) -> PinnedDirectory {
        let directory = File::open(path).expect("open directory");
        #[cfg(target_os = "linux")]
        let runtime_path =
            std::path::PathBuf::from(format!("/proc/self/fd/{}", directory.as_raw_fd()));
        #[cfg(not(target_os = "linux"))]
        let runtime_path = path.to_path_buf();
        PinnedDirectory {
            _directory: directory,
            runtime_path,
        }
    }

    #[cfg(unix)]
    #[test]
    fn controlled_open_exposes_exact_manifest_and_catalog_states() {
        let temp = TempDir::new().expect("temp dir");
        let catalog = temp.path().join("catalog");
        let source_path = temp.path().join("source");
        let target_path = temp.path().join("target");
        let source_config = PoolMemberConfig::new(source_path.clone(), 16 * 1024 * 1024);
        let target_config = PoolMemberConfig::new(target_path.clone(), 16 * 1024 * 1024);
        let pool = PoolStore::open(&catalog, pool_config()).expect("open pool");
        let source = pool
            .add_member(source_config.clone())
            .expect("add source member");
        let target = pool
            .add_member(target_config.clone())
            .expect("add target member");

        let stored_data = b"controlled read-only stored bytes";
        let stored_hash = sha256(stored_data);
        pool.put_sync(stored_hash, stored_data)
            .expect("put stored blob");
        let stored_location = pool
            .read_location(&stored_hash)
            .expect("read stored location")
            .expect("stored catalog record");
        let missing_hash = sha256(b"controlled read-only missing");
        let pending_hash = sha256(b"controlled read-only pending");
        let moving_hash = sha256(b"controlled read-only moving");
        let mut wtxn = pool.env.write_txn().expect("catalog write txn");
        pool.set_location_txn(
            &mut wtxn,
            pending_hash,
            Some(LocationRecord::Pending {
                member: source,
                size: 37,
            }),
        )
        .expect("write pending");
        pool.set_location_txn(
            &mut wtxn,
            moving_hash,
            Some(LocationRecord::Moving {
                source,
                target,
                size: 41,
            }),
        )
        .expect("write moving");
        wtxn.commit().expect("commit catalog states");
        pool.force_sync().expect("sync pool");
        drop(pool);

        let ordinary =
            ReadOnlyPoolStore::open(&catalog).expect("open ordinary read-only snapshot reader");
        let expected_snapshot = ordinary.manifest_snapshot().expect("manifest snapshot");
        assert_eq!(
            expected_snapshot.sha256,
            sha256(&ordinary.inner.opened_manifest_bytes)
        );
        assert_eq!(expected_snapshot.members.len(), 2);
        assert_eq!(
            expected_snapshot
                .members
                .iter()
                .find(|member| member.id == source)
                .expect("source snapshot")
                .config,
            source_config
        );
        assert_eq!(
            expected_snapshot
                .members
                .iter()
                .find(|member| member.id == target)
                .expect("target snapshot")
                .config,
            target_config
        );
        drop(ordinary);

        let catalog_identity = lmdb_identity(&catalog);
        let source_identity = lmdb_identity(&source_path);
        let target_identity = lmdb_identity(&target_path);
        let catalog_pin = pin_directory(&catalog);
        let source_pin = pin_directory(&source_path);
        let target_pin = pin_directory(&target_path);
        let mut controlled = pool_config();
        controlled.catalog_lmdb_identity = Some(catalog_identity);
        controlled.expected_manifest_sha256 = Some(expected_snapshot.sha256);
        controlled.member_runtime_paths = vec![
            PoolMemberRuntimePaths {
                id: source,
                configured_path: source_path,
                runtime_path: source_pin.runtime_path.clone(),
                configured_external_path: None,
                runtime_external_path: None,
                lmdb_identity: source_identity,
            },
            PoolMemberRuntimePaths {
                id: target,
                configured_path: target_path,
                runtime_path: target_pin.runtime_path.clone(),
                configured_external_path: None,
                runtime_external_path: None,
                lmdb_identity: target_identity,
            },
        ];

        let mut enabled_temperature = controlled.clone();
        enabled_temperature.temperature.enabled = true;
        assert!(
            ReadOnlyPoolStore::open_controlled(&catalog_pin.runtime_path, enabled_temperature)
                .err()
                .expect("temperature-enabled controlled open must fail")
                .to_string()
                .contains("temperature tracking")
        );

        let mut wrong_manifest = controlled.clone();
        wrong_manifest.expected_manifest_sha256 = Some(sha256(b"wrong manifest authority"));
        assert!(
            ReadOnlyPoolStore::open_controlled(&catalog_pin.runtime_path, wrong_manifest)
                .err()
                .expect("wrong manifest authority must fail")
                .to_string()
                .contains("manifest SHA-256 differs")
        );

        let mut missing_binding = controlled.clone();
        missing_binding.member_runtime_paths.pop();
        assert!(
            ReadOnlyPoolStore::open_controlled(&catalog_pin.runtime_path, missing_binding)
                .err()
                .expect("incomplete member authority must fail")
                .to_string()
                .contains("pinned pool topology")
        );

        let reader = ReadOnlyPoolStore::open_controlled(&catalog_pin.runtime_path, controlled)
            .expect("open controlled read-only Pool");
        assert_eq!(
            reader.manifest_snapshot().expect("controlled snapshot"),
            expected_snapshot
        );
        let expected_stored = match stored_location {
            LocationRecord::Stored { member, size } => PoolCatalogLocation::Stored { member, size },
            other => panic!("put committed unexpected location {other:?}"),
        };
        let locations = reader
            .blob_catalog_locations(&[missing_hash, pending_hash, stored_hash, moving_hash])
            .expect("read exact catalog states");
        assert_eq!(
            locations,
            vec![
                PoolCatalogLocation::Missing,
                PoolCatalogLocation::Pending {
                    member: source,
                    size: 37,
                },
                expected_stored,
                PoolCatalogLocation::Moving {
                    source,
                    target,
                    size: 41,
                },
            ]
        );
        assert_eq!(
            reader.get_sync(&stored_hash).expect("read stored blob"),
            Some(stored_data.to_vec())
        );
    }

    #[tokio::test]
    async fn reads_real_pool_without_mutating_data_files() {
        let temp = TempDir::new().expect("temp dir");
        let catalog = temp.path().join("catalog");
        let member = temp.path().join("member");
        let pool = PoolStore::open(&catalog, pool_config()).expect("open pool");
        pool.add_member(PoolMemberConfig::new(member.clone(), 1024 * 1024))
            .expect("add member");
        let data = b"read-only terminal audit bytes";
        let hash = sha256(data);
        pool.put_sync(hash, data).expect("put blob");
        pool.force_sync().expect("sync pool");
        drop(pool);

        let catalog_data = catalog.join("data.mdb");
        let member_data = member.join("data.mdb");
        let catalog_before = file_sha256(&catalog_data);
        let member_before = file_sha256(&member_data);
        let catalog_mtime_before = file_modified(&catalog_data);
        let member_mtime_before = file_modified(&member_data);
        let reader = ReadOnlyPoolStore::open(&catalog).expect("open read-only pool");
        reader
            .require_durable_external_blob_writes()
            .expect("ordinary pool members use durable external writes");
        let audit = reader
            .validate_committed_catalog()
            .expect("validate catalog");
        assert_eq!(audit.stored_locations, 1);
        assert_eq!(audit.manifest_sha256.len(), 64);
        assert_eq!(
            reader.get_sync(&hash).expect("get blob"),
            Some(data.to_vec())
        );
        assert_eq!(
            reader.blob_size_sync(&hash).expect("blob size"),
            Some(data.len() as u64)
        );
        assert_eq!(
            reader.get_range(&hash, 5, 8).await.expect("blob range"),
            Some(data[5..=8].to_vec())
        );
        assert!(reader.has(&hash).await.expect("has blob"));
        assert!(reader.put(hash, data.to_vec()).await.is_err());
        assert!(reader.delete(&hash).await.is_err());
        assert!(reader.pin(&hash).await.is_err());
        assert!(reader.unpin(&hash).await.is_err());
        drop(reader);

        assert_eq!(file_sha256(&catalog_data), catalog_before);
        assert_eq!(file_sha256(&member_data), member_before);
        assert_eq!(file_modified(&catalog_data), catalog_mtime_before);
        assert_eq!(file_modified(&member_data), member_mtime_before);
    }

    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
    async fn production_pool_read_allows_nested_reader_on_tokio_worker() {
        let temp = TempDir::new().expect("generated Pool root");
        let catalog = temp.path().join("catalog");
        let member = temp.path().join("member");
        let pool = PoolStore::open(&catalog, pool_config()).expect("open generated Pool");
        pool.add_member(PoolMemberConfig::new(member, 16 * 1024 * 1024))
            .expect("add generated member");
        let body = b"real nested Pool reader body";
        let hash = sha256(body);
        pool.put_sync(hash, body).expect("store generated body");
        pool.force_sync().expect("sync generated Pool");
        drop(pool);

        let reader = ReadOnlyPoolStore::open(&catalog).expect("open production Pool reader");
        tokio::task::block_in_place(|| {
            let held = reader
                .inner
                ._env
                .read_txn()
                .expect("hold first catalog read transaction");
            assert_eq!(
                reader
                    .get_sync(&hash)
                    .expect("open nested production catalog transaction"),
                Some(body.to_vec())
            );
            drop(held);
        });
    }

    #[test]
    fn durable_writer_check_rejects_unsynced_external_pool_members() {
        let temp = TempDir::new().expect("temp dir");
        let catalog = temp.path().join("catalog");
        let member = temp.path().join("member");
        let external = temp.path().join("external");
        let pool = PoolStore::open(&catalog, pool_config()).expect("open pool");
        pool.add_member(
            PoolMemberConfig::new(member, 1024 * 1024)
                .with_external_blobs(external, 1, false, None),
        )
        .expect("add unsynced external member");
        pool.force_sync().expect("sync pool manifest");
        drop(pool);

        let reader = ReadOnlyPoolStore::open(&catalog).expect("open read-only pool");
        let error = reader
            .require_durable_external_blob_writes()
            .expect_err("unsynced external member must fail durable writer validation");
        assert!(error.to_string().contains("external_blob_sync disabled"));
    }

    #[test]
    fn rejects_pending_and_moving_catalog_records() {
        let temp = TempDir::new().expect("temp dir");
        let catalog = temp.path().join("catalog");
        let pool = PoolStore::open(&catalog, pool_config()).expect("open pool");
        let source = pool
            .add_member(PoolMemberConfig::new(
                temp.path().join("source"),
                1024 * 1024,
            ))
            .expect("add source");
        let target = pool
            .add_member(PoolMemberConfig::new(
                temp.path().join("target"),
                1024 * 1024,
            ))
            .expect("add target");
        let pending_hash = sha256(b"pending audit record");
        let moving_hash = sha256(b"moving audit record");
        let mut wtxn = pool.env.write_txn().expect("catalog write txn");
        pool.set_location_txn(
            &mut wtxn,
            pending_hash,
            Some(LocationRecord::Pending {
                member: source,
                size: 20,
            }),
        )
        .expect("write pending location");
        pool.set_location_txn(
            &mut wtxn,
            moving_hash,
            Some(LocationRecord::Moving {
                source,
                target,
                size: 19,
            }),
        )
        .expect("write moving location");
        wtxn.commit().expect("commit interrupted records");
        pool.force_sync().expect("sync catalog");
        drop(pool);

        let reader = ReadOnlyPoolStore::open(&catalog).expect("open read-only pool");
        let error = reader
            .validate_committed_catalog()
            .expect_err("catalog with interrupted records must fail");
        assert!(
            error.to_string().contains("pending") || error.to_string().contains("moving"),
            "unexpected catalog error: {error}"
        );
        assert!(reader
            .get_sync(&pending_hash)
            .expect_err("pending read must fail")
            .to_string()
            .contains("pending"));
        assert!(reader
            .get_sync(&moving_hash)
            .expect_err("moving read must fail")
            .to_string()
            .contains("moving"));
        assert!(reader
            .blob_size_sync(&pending_hash)
            .expect_err("pending size must fail")
            .to_string()
            .contains("pending"));
        assert!(reader
            .blob_size_sync(&moving_hash)
            .expect_err("moving size must fail")
            .to_string()
            .contains("moving"));
    }

    #[test]
    fn rejects_stored_location_with_missing_member_bytes() {
        let temp = TempDir::new().expect("temp dir");
        let catalog = temp.path().join("catalog");
        let member_path = temp.path().join("member");
        let pool = PoolStore::open(&catalog, pool_config()).expect("open pool");
        let member = pool
            .add_member(PoolMemberConfig::new(member_path, 1024 * 1024))
            .expect("add member");
        let data = b"catalogued but physically missing";
        let hash = sha256(data);
        pool.put_sync(hash, data).expect("put blob");
        let member_store = pool.get_member(member).expect("open member");
        assert!(member_store
            .delete_sync(&hash)
            .expect("delete only member bytes"));
        pool.force_sync().expect("sync corrupt physical state");
        drop(member_store);
        drop(pool);

        let reader = ReadOnlyPoolStore::open(&catalog).expect("open read-only pool");
        let get_error = reader
            .get_sync(&hash)
            .expect_err("stored location without bytes must fail closed");
        assert!(get_error.to_string().contains(&to_hex(&hash)));
        assert!(get_error.to_string().contains(&member.to_string()));
        assert!(get_error.to_string().contains("missing bytes"));
        let size_error = reader
            .blob_size_sync(&hash)
            .expect_err("size must verify physical bytes");
        assert!(size_error.to_string().contains("missing bytes"));
    }

    #[test]
    fn rejects_catalog_location_for_unknown_member() {
        let temp = TempDir::new().expect("temp dir");
        let catalog = temp.path().join("catalog");
        let pool = PoolStore::open(&catalog, pool_config()).expect("open pool");
        pool.add_member(PoolMemberConfig::new(
            temp.path().join("member"),
            1024 * 1024,
        ))
        .expect("add member");
        let hash = sha256(b"unknown member audit record");
        let unknown = PoolMemberId::new();
        let mut wtxn = pool.env.write_txn().expect("catalog write txn");
        pool.set_location_txn(
            &mut wtxn,
            hash,
            Some(LocationRecord::Stored {
                member: unknown,
                size: 27,
            }),
        )
        .expect("write unknown member location");
        wtxn.commit().expect("commit unknown member record");
        pool.force_sync().expect("sync catalog");
        drop(pool);

        let reader = ReadOnlyPoolStore::open(&catalog).expect("open read-only pool");
        assert!(reader
            .validate_committed_catalog()
            .expect_err("unknown catalog member must fail")
            .to_string()
            .contains("unknown member"));
        assert!(reader
            .get_sync(&hash)
            .expect_err("unknown member read must fail")
            .to_string()
            .contains("unknown member"));
        assert!(reader
            .blob_size_sync(&hash)
            .expect_err("unknown member size must fail")
            .to_string()
            .contains("unknown member"));
    }

    #[test]
    fn rejects_manifest_snapshot_that_differs_from_opened_members() {
        let opened = br#"{"version":1,"members":[]}"#;
        let opened_sha256 = to_hex(&sha256(opened));
        require_opened_manifest(opened, opened, &opened_sha256).unwrap();

        let changed = br#"{"version":1,"members":[{"id":"changed"}]}"#;
        let error = require_opened_manifest(changed, opened, &opened_sha256)
            .expect_err("changed manifest snapshot must fail");
        assert!(error.to_string().contains(&opened_sha256));
        assert!(error.to_string().contains(&to_hex(&sha256(changed))));
    }

    #[test]
    #[ignore = "subprocess entry point for read-only PoolStore manifest mutation"]
    fn read_only_manifest_mutator_helper() {
        let Some(catalog) = std::env::var_os(MUTATE_CATALOG_ENV) else {
            return;
        };
        let member = std::env::var_os(MUTATE_MEMBER_ENV).expect("mutator member path");
        let pool = PoolStore::open(catalog, pool_config()).expect("open catalog writer");
        pool.add_member(PoolMemberConfig::new(member.into(), 1024 * 1024))
            .expect("mutate pool manifest");
        pool.force_sync().expect("sync mutated manifest");
    }

    #[test]
    fn live_catalog_audit_rejects_manifest_changed_after_reader_open() {
        check_live_catalog_manifest_change(true);
    }

    #[test]
    fn live_catalog_growth_invalidates_reader_without_crashing() {
        check_live_catalog_manifest_change(false);
    }

    fn check_live_catalog_manifest_change(reserve_catalog_space: bool) {
        let temp = TempDir::new().expect("temp dir");
        let catalog = temp.path().join("catalog");
        let initial_member = temp.path().join("initial-member");
        let added_member = temp.path().join("added-member");
        let pool = PoolStore::open(&catalog, pool_config()).expect("open pool");
        pool.add_member(PoolMemberConfig::new(initial_member, 1024 * 1024))
            .expect("add initial member");
        pool.force_sync().expect("sync initial manifest");
        drop(pool);

        let catalog_data = catalog.join("data.mdb");
        if reserve_catalog_space {
            // Keep this mutation within the existing mapping so it still
            // exercises the exact manifest comparison on every platform.
            let file = fs::OpenOptions::new()
                .write(true)
                .open(&catalog_data)
                .expect("open closed catalog for preallocation");
            file.set_len(file.metadata().expect("catalog metadata").len() + 128 * 1024)
                .expect("reserve catalog pages");
        }
        let opened_size = fs::metadata(&catalog_data).expect("catalog size").len();
        let reader = ReadOnlyPoolStore::open(&catalog).expect("open pinned read-only pool");
        reader
            .validate_committed_catalog()
            .expect("initial catalog matches opened manifest");

        let output = Command::new(std::env::current_exe().expect("test binary"))
            .arg("--ignored")
            .arg("--exact")
            .arg("pool::read_only::tests::read_only_manifest_mutator_helper")
            .env(MUTATE_CATALOG_ENV, &catalog)
            .env(MUTATE_MEMBER_ENV, &added_member)
            .env("RUST_TEST_THREADS", "1")
            .output()
            .expect("run manifest mutator helper");
        assert!(
            output.status.success(),
            "manifest mutator failed: stdout={} stderr={}",
            String::from_utf8_lossy(&output.stdout),
            String::from_utf8_lossy(&output.stderr)
        );

        let changed_size = fs::metadata(&catalog_data)
            .expect("changed catalog size")
            .len();
        if reserve_catalog_space {
            assert_eq!(
                changed_size, opened_size,
                "manifest change must fit the mapping"
            );
        } else {
            assert!(changed_size > opened_size, "writer must grow the catalog");
        }
        let error = reader
            .validate_committed_catalog()
            .expect_err("changed live manifest must differ from opened member snapshot");
        let expected = if cfg!(windows) && !reserve_catalog_space {
            "MDB_MAP_RESIZED"
        } else {
            "manifest changed after read-only members were opened"
        };
        assert!(
            error.to_string().contains(expected),
            "unexpected live manifest mismatch: {error}"
        );
        drop(reader);
        let reopened = ReadOnlyPoolStore::open(&catalog).expect("reopen changed catalog");
        assert_eq!(
            reopened
                .manifest_snapshot()
                .expect("new manifest")
                .members
                .len(),
            2
        );
    }
}