From 2ddef2b302a68c4ce1d9d302c1cbf24d0011d1e4 Mon Sep 17 00:00:00 2001
From: Rusty Russell <rusty@rustcorp.com.au>
Date: Fri, 9 Feb 2024 15:15:19 +1030
Subject: [PATCH] gossipd: add code to check dying flags are consistent.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
---
 gossipd/gossipd.c        |  3 ++
 gossipd/gossmap_manage.c | 60 ++++++++++++++++++++++++++++++++++++++++
 gossipd/gossmap_manage.h |  6 ++++
 3 files changed, 69 insertions(+)

diff --git a/gossipd/gossipd.c b/gossipd/gossipd.c
index 778e48cd696e..5d1e156a5c1e 100644
--- a/gossipd/gossipd.c
+++ b/gossipd/gossipd.c
@@ -491,6 +491,9 @@ static void dev_gossip_memleak(struct daemon *daemon, const u8 *msg)
 	struct htable *memtable;
 	bool found_leak;
 
+	/* Check this while we're here! */
+	gossmap_check_dying(daemon->gm);
+
 	memtable = memleak_start(tmpctx);
 	memleak_ptr(memtable, msg);
 	/* Now delete daemon and those which it has pointers to. */
diff --git a/gossipd/gossmap_manage.c b/gossipd/gossmap_manage.c
index 365f09e104c2..fb2bc258a5bc 100644
--- a/gossipd/gossmap_manage.c
+++ b/gossipd/gossmap_manage.c
@@ -1396,3 +1396,63 @@ struct wireaddr *gossmap_manage_get_node_addresses(const tal_t *ctx,
 
 	return wireaddrs;
 }
+
+void gossmap_check_dying(struct gossmap_manage *gm)
+{
+	struct gossmap *gossmap;
+
+	/* We reload this every time we delete a channel: that way we can tell if it's
+	 * time to remove a node! */
+	gossmap = gossmap_manage_get_gossmap(gm);
+
+	/* channel_updates should match channel. */
+	for (struct gossmap_chan *c = gossmap_first_chan(gossmap);
+	     c;
+	     c = gossmap_next_chan(gossmap, c)) {
+		bool dying = gossmap_chan_is_dying(gossmap, c);
+
+		for (int dir = 0; dir < 2; dir++) {
+			bool update_dying;
+			if (!gossmap_chan_set(c, dir))
+				continue;
+			update_dying = (gossip_store_get_flags(gm->daemon->gs, c->cupdate_off[dir],
+							       WIRE_CHANNEL_UPDATE) & GOSSIP_STORE_DYING_BIT);
+			if (update_dying != dying) {
+				status_broken("Bad gossip order: "
+					      "channel_update[%i] at %u says %s, channel is %s",
+					      dir, c->cupdate_off[dir],
+					      update_dying ? "dying" : "not dying",
+					      dying ? "dying" : "not dying");
+			}
+		}
+	}
+
+	/* Nodes should match iff no live channels. */
+	for (struct gossmap_node *n = gossmap_first_node(gossmap);
+	     n;
+	     n = gossmap_next_node(gossmap, n)) {
+		bool dying, all_chans_dying = true;
+
+		if (!gossmap_node_announced(n))
+			continue;
+
+		dying = (gossip_store_get_flags(gm->daemon->gs, n->nann_off,
+						WIRE_NODE_ANNOUNCEMENT) & GOSSIP_STORE_DYING_BIT);
+
+		for (size_t i = 0; i < n->num_chans; i++) {
+			struct gossmap_chan *c = gossmap_nth_chan(gossmap, n, i, NULL);
+			bool chan_dying = gossmap_chan_is_dying(gossmap, c);
+
+			if (!chan_dying)
+				all_chans_dying = false;
+		}
+
+		if (all_chans_dying != dying) {
+			status_broken("Bad gossip order: "
+				      "node_announce at %u says %s, all channels %s",
+				      n->nann_off,
+				      dying ? "dying" : "not dying",
+				      all_chans_dying ? "dying" : "not dying");
+		}
+	}
+}
diff --git a/gossipd/gossmap_manage.h b/gossipd/gossmap_manage.h
index 1749f025a83a..d53d5372a353 100644
--- a/gossipd/gossmap_manage.h
+++ b/gossipd/gossmap_manage.h
@@ -123,4 +123,10 @@ struct wireaddr *gossmap_manage_get_node_addresses(const tal_t *ctx,
  */
 void gossmap_manage_tell_lightningd_locals(struct daemon *daemon,
 					   struct gossmap_manage *gm);
+
+/**
+ * gossmap_check_dying: check that we have consistent dying flags.
+ * @gm: the gossmap_manage context.
+ */
+void gossmap_check_dying(struct gossmap_manage *gm);
 #endif /* LIGHTNING_GOSSIPD_GOSSMAP_MANAGE_H */