From d150f3ce8c731100bf3604ffc0a34184b01fa0a1 Mon Sep 17 00:00:00 2001
From: Patrick Insinger <patrickinsinger@gmail.com>
Date: Tue, 14 Sep 2021 10:51:17 -0700
Subject: [PATCH] Detect writes on frozen InMemoryLayers

Data written to frozen layers is lost. It will not appear in on-disk
structures or in successor InMemoryLayers. Here we detect this race, and
fail. I think this race is rare, but this should make it easier to track
down when it happens.
---
 .../src/layered_repository/inmemory_layer.rs  | 25 ++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/pageserver/src/layered_repository/inmemory_layer.rs b/pageserver/src/layered_repository/inmemory_layer.rs
index 4a422f242a..453b767bce 100644
--- a/pageserver/src/layered_repository/inmemory_layer.rs
+++ b/pageserver/src/layered_repository/inmemory_layer.rs
@@ -61,9 +61,22 @@ pub struct InMemoryLayerInner {
     /// `segsizes` tracks the size of the segment at different points in time.
     ///
     segsizes: BTreeMap<Lsn, u32>,
+
+    /// True if freeze() has been called on the layer, indicating it no longer
+    /// accepts writes.
+    frozen: bool,
 }
 
 impl InMemoryLayerInner {
+    /// Assert that the layer is not frozen
+    fn assert_writeable(&self) {
+        // TODO current this can happen when a walreceiver thread's
+        // `get_layer_for_write` and InMemoryLayer write calls interleave with
+        // a checkpoint operation, however timing should make this rare.
+        // Assert only so we can identify when the bug triggers more easily.
+        assert!(!self.frozen);
+    }
+
     fn get_seg_size(&self, lsn: Lsn) -> u32 {
         // Scan the BTreeMap backwards, starting from the given entry.
         let mut iter = self.segsizes.range((Included(&Lsn(0)), Included(&lsn)));
@@ -304,6 +317,7 @@ impl InMemoryLayer {
                 drop_lsn: None,
                 page_versions: BTreeMap::new(),
                 segsizes: BTreeMap::new(),
+                frozen: false,
             }),
             predecessor: None,
         })
@@ -349,6 +363,8 @@ impl InMemoryLayer {
         );
         let mut inner = self.inner.lock().unwrap();
 
+        inner.assert_writeable();
+
         let old = inner.page_versions.insert((blknum, lsn), pv);
 
         if old.is_some() {
@@ -415,6 +431,8 @@ impl InMemoryLayer {
     pub fn put_truncation(&self, lsn: Lsn, segsize: u32) -> anyhow::Result<()> {
         let mut inner = self.inner.lock().unwrap();
 
+        inner.assert_writeable();
+
         // check that this we truncate to a smaller size than segment was before the truncation
         let oldsize = inner.get_seg_size(lsn);
         assert!(segsize < oldsize);
@@ -433,6 +451,8 @@ impl InMemoryLayer {
     pub fn drop_segment(&self, lsn: Lsn) -> anyhow::Result<()> {
         let mut inner = self.inner.lock().unwrap();
 
+        inner.assert_writeable();
+
         assert!(inner.drop_lsn.is_none());
         inner.drop_lsn = Some(lsn);
 
@@ -480,6 +500,7 @@ impl InMemoryLayer {
                 drop_lsn: None,
                 page_versions: BTreeMap::new(),
                 segsizes,
+                frozen: false,
             }),
             predecessor: Some(src),
         })
@@ -510,7 +531,9 @@ impl InMemoryLayer {
             self.seg, self.timelineid, cutoff_lsn
         );
 
-        let inner = self.inner.lock().unwrap();
+        let mut inner = self.inner.lock().unwrap();
+        inner.assert_writeable();
+        inner.frozen = true;
 
         // Normally, use the cutoff LSN as the end of the frozen layer.
         // But if the relation was dropped, we know that there are no