lightningd: generalize peer_any_channel to filter on entire channel, not just state.

rustyrussell · rustyrussell · commit 64af5db45ca5 · 2024-11-25T15:39:13.000+10:30
We're going to use this to ask if there are any channels which make it
important to reconnect to the peer.

Signed-off-by: Rusty Russell &lt;rusty@rustcorp.com.au&gt;
diff --git a/lightningd/channel.c b/lightningd/channel.c
@@ -653,28 +653,56 @@ const char *channel_state_str(enum channel_state state)
 	return "unknown";
 }
 
-struct channel *peer_any_channel(struct peer *peer,
-				 bool (*channel_state_filter)(enum channel_state),
-				 bool *others)
+#define peer_any_channel(peer, filter, arg, others)		\
+	peer_any_channel_((peer),				\
+			  typesafe_cb_preargs(bool, void *,		\
+					      (filter), (arg),		\
+					      const struct channel *),	\
+			  (arg),					\
+			  others)
+
+struct channel *peer_any_channel_(struct peer *peer,
+				  bool (*filter)(const struct channel *,
+						 void *arg),
+				  void *arg,
+				  bool *others)
 {
 	struct channel *channel, *ret = NULL;
 
 	list_for_each(&peer->channels, channel, list) {
-		if (channel_state_filter && !channel_state_filter(channel->state))
+		if (filter && !filter(channel, arg))
 			continue;
 		/* Already found one? */
 		if (ret) {
-			if (others)
-				*others = true;
+			*others = true;
 		} else {
 			if (others)
 				*others = false;
 			ret = channel;
 		}
+
+		/* Don't keep searching if others is NULL (they don't care). */
+		if (!others)
+			break;
 	}
 	return ret;
 }
 
+static bool filter_by_state(const struct channel *c,
+			    bool (*channel_state_filter)(enum channel_state))
+{
+	return channel_state_filter(c->state);
+}
+
+struct channel *peer_any_channel_bystate(struct peer *peer,
+					 bool (*channel_state_filter)(enum channel_state),
+					 bool *others)
+{
+	return peer_any_channel(peer,
+				filter_by_state, channel_state_filter,
+				others);
+}
+
 struct channel_inflight *channel_inflight_find(struct channel *channel,
 					       const struct bitcoin_txid *txid)
 {
diff --git a/lightningd/channel.h b/lightningd/channel.h
@@ -771,9 +771,24 @@ const char *channel_change_state_reason_str(enum state_change reason);
 
 /* Find a channel which is passes filter, if any: sets *others if there
  * is more than one. */
-struct channel *peer_any_channel(struct peer *peer,
-				 bool (*channel_state_filter)(enum channel_state),
-				 bool *others);
+#define peer_any_channel(peer, filter, arg, others)		\
+	peer_any_channel_((peer),				\
+			  typesafe_cb_preargs(bool, void *,		\
+					      (filter), (arg),		\
+					      const struct channel *),	\
+			  (arg),					\
+			  others)
+
+struct channel *peer_any_channel_(struct peer *peer,
+				  bool (*filter)(const struct channel *,
+						 void *arg),
+				  void *arg,
+				  bool *others);
+
+/* More common version for filtering by state */
+struct channel *peer_any_channel_bystate(struct peer *peer,
+					 bool (*channel_state_filter)(enum channel_state),
+					 bool *others);
 
 struct channel *channel_by_dbid(struct lightningd *ld, const u64 dbid);
 
diff --git a/lightningd/channel_control.c b/lightningd/channel_control.c
@@ -2576,7 +2576,8 @@ static struct command_result *json_dev_feerate(struct command *cmd,
 	if (!peer)
 		return command_fail(cmd, LIGHTNINGD, "Peer not connected");
 
-	channel = peer_any_channel(peer, channel_state_can_add_htlc, &more_than_one);
+	channel = peer_any_channel_bystate(peer, channel_state_can_add_htlc,
+					   &more_than_one);
 	if (!channel || !channel->owner)
 		return command_fail(cmd, LIGHTNINGD, "Peer bad state");
 	/* This is a dev command: fix the api if you need this! */
@@ -2628,7 +2629,7 @@ static struct command_result *json_dev_peer_shachain(struct command *cmd,
 	if (!peer)
 		return command_fail(cmd, LIGHTNINGD, "Peer not connected");
 
-	channel = peer_any_channel(peer, channel_state_can_add_htlc, &more_than_one);
+	channel = peer_any_channel_bystate(peer, channel_state_can_add_htlc, &more_than_one);
 	if (!channel || !channel->owner)
 		return command_fail(cmd, LIGHTNINGD, "Peer bad state");
 	/* This is a dev command: fix the api if you need this! */
@@ -2683,7 +2684,8 @@ static struct command_result *json_dev_quiesce(struct command *cmd,
 		return command_fail(cmd, LIGHTNINGD, "Peer not connected");
 
 	/* FIXME: If this becomes a real API, check for OPT_QUIESCE! */
-	channel = peer_any_channel(peer, channel_state_wants_peercomms, &more_than_one);
+	channel = peer_any_channel_bystate(peer, channel_state_wants_peercomms,
+					   &more_than_one);
 	if (!channel || !channel->owner)
 		return command_fail(cmd, LIGHTNINGD, "Peer bad state");
 	/* This is a dev command: fix the api if you need this! */
diff --git a/lightningd/closing_control.c b/lightningd/closing_control.c
@@ -608,7 +608,7 @@ static struct command_result *param_channel_or_peer(struct command *cmd,
 	(*sc)->uc = NULL;
 
 	if (peer) {
-		(*sc)->channel = peer_any_channel(peer, channel_state_can_close, &more_than_one);
+		(*sc)->channel = peer_any_channel_bystate(peer, channel_state_can_close, &more_than_one);
 		if ((*sc)->channel) {
 			if (more_than_one)
 				goto more_than_one;
@@ -632,7 +632,7 @@ static struct command_result *param_channel_or_peer(struct command *cmd,
 	if ((*sc)->uc)
 		return NULL;
 
-	(*sc)->unsaved_channel = peer_any_channel(peer, channel_state_uncommitted, &more_than_one);
+	(*sc)->unsaved_channel = peer_any_channel_bystate(peer, channel_state_uncommitted, &more_than_one);
 	if ((*sc)->unsaved_channel) {
 		if (more_than_one)
 			goto more_than_one;
diff --git a/lightningd/connect_control.c b/lightningd/connect_control.c
@@ -291,7 +291,7 @@ static void do_connect(struct delayed_reconnect *d)
 
 	/* We consider this transient unless we have a channel */
 	peer = peer_by_id(d->ld, &d->id);
-	transient = !peer || !peer_any_channel(peer, channel_state_wants_peercomms, NULL);
+	transient = !peer || !peer_any_channel_bystate(peer, channel_state_wants_peercomms, NULL);
 
 	connectmsg = towire_connectd_connect_to_peer(NULL,
 						     &d->id,
@@ -427,7 +427,7 @@ static void connect_failed(struct lightningd *ld,
 
 	/* If we have an active channel, then reconnect. */
 	peer = peer_by_id(ld, id);
-	if (peer && peer_any_channel(peer, channel_state_wants_peercomms, NULL)) {
+	if (peer && peer_any_channel_bystate(peer, channel_state_wants_peercomms, NULL)) {
 		try_reconnect(peer, peer, addrhint);
 	} else
 		log_peer_debug(ld->log, id, "Not reconnecting: %s",
diff --git a/lightningd/dual_open_control.c b/lightningd/dual_open_control.c
@@ -1387,7 +1387,7 @@ wallet_commit_channel(struct lightningd *ld,
 	bool anysegwit = !chainparams->is_elements && feature_negotiated(channel->peer->ld->our_features,
                         channel->peer->their_features,
                         OPT_SHUTDOWN_ANYSEGWIT);
-	bool any_active = peer_any_channel(channel->peer, channel_state_wants_peercomms, NULL);
+	bool any_active = peer_any_channel_bystate(channel->peer, channel_state_wants_peercomms, NULL);
 
 	if (!amount_sat_to_msat(&our_msat, our_funding)) {
 		log_broken(channel->log, "Unable to convert funds");
diff --git a/lightningd/opening_control.c b/lightningd/opening_control.c
@@ -108,7 +108,7 @@ wallet_commit_channel(struct lightningd *ld,
 	u64 static_remotekey_start;
 	u32 lease_start_blockheight = 0; /* No leases on v1 */
 	struct timeabs timestamp;
-	bool any_active = peer_any_channel(uc->peer, channel_state_wants_peercomms, NULL);
+	bool any_active = peer_any_channel_bystate(uc->peer, channel_state_wants_peercomms, NULL);
 	struct channel_stats zero_channel_stats;
 	enum addrtype addrtype;
 
diff --git a/lightningd/peer_control.c b/lightningd/peer_control.c
@@ -1546,9 +1546,9 @@ static const struct wireaddr *best_remote_addr(const tal_t *ctx,
 			continue;
 		if (peer->remote_addr->type != atype)
 			continue;
-		daddr.preferred = peer_any_channel(peer,
-						   channel_state_relationship,
-						   NULL);
+		daddr.preferred = peer_any_channel_bystate(peer,
+							   channel_state_relationship,
+							   NULL);
 		daddr.addr = *peer->remote_addr;
 		daddr.addr.port = ld->config.ip_discovery_port;
 		log_debug(ld->log, "best_remote_addr: peer %s gave addr %s (%s)",
@@ -2647,7 +2647,8 @@ static struct command_result *json_disconnect(struct command *cmd,
 		return command_fail(cmd, LIGHTNINGD, "Peer not connected");
 	}
 
-	channel = peer_any_channel(peer, channel_state_wants_peercomms, NULL);
+	channel = peer_any_channel_bystate(peer, channel_state_wants_peercomms,
+					   NULL);
 	if (channel && !*force) {
 		return command_fail(cmd, LIGHTNINGD,
 				    "Peer has (at least one) channel in state %s",
@@ -3195,7 +3196,8 @@ static struct command_result *param_dev_channel(struct command *cmd,
 	if (res)
 		return res;
 
-	*channel = peer_any_channel(peer, channel_state_wants_peercomms, &more_than_one);
+	*channel = peer_any_channel_bystate(peer, channel_state_wants_peercomms,
+					    &more_than_one);
 	if (!*channel)
 		return command_fail_badparam(cmd, name, buffer, tok,
 					     "No channel with that peer");
diff --git a/lightningd/test/run-invoice-select-inchan.c b/lightningd/test/run-invoice-select-inchan.c
@@ -875,11 +875,11 @@ struct command_result *param_u64(struct command *cmd UNNEEDED, const char *name
 				 const char *buffer UNNEEDED, const jsmntok_t *tok UNNEEDED,
 				 uint64_t **num UNNEEDED)
 { fprintf(stderr, "param_u64 called!\n"); abort(); }
-/* Generated stub for peer_any_channel */
-struct channel *peer_any_channel(struct peer *peer UNNEEDED,
-				 bool (*channel_state_filter)(enum channel_state) UNNEEDED,
-				 bool *others UNNEEDED)
-{ fprintf(stderr, "peer_any_channel called!\n"); abort(); }
+/* Generated stub for peer_any_channel_bystate */
+struct channel *peer_any_channel_bystate(struct peer *peer UNNEEDED,
+					 bool (*channel_state_filter)(enum channel_state) UNNEEDED,
+					 bool *others UNNEEDED)
+{ fprintf(stderr, "peer_any_channel_bystate called!\n"); abort(); }
 /* Generated stub for peer_restart_dualopend */
 bool peer_restart_dualopend(struct peer *peer UNNEEDED,
 			    struct peer_fd *peer_fd UNNEEDED,
