rgb-cln/gossipd/broadcast.h

#ifndef LIGHTNING_GOSSIPD_BROADCAST_H
#define LIGHTNING_GOSSIPD_BROADCAST_H
#include "config.h"

#include <ccan/intmap/intmap.h>
#include <ccan/list/list.h>
#include <ccan/short_types/short_types.h>
#include <ccan/tal/tal.h>

/* Common functionality to implement staggered broadcasts with replacement. */

struct routing_state;

/* This is nested inside a node, chan or half_chan; rewriting the store can
 * cause it to change! */
struct broadcastable {
	/* This is also the offset within the gossip_store; even with 1M
	 * channels we still have a factor of 8 before this wraps. */
	u32 index;
	u32 timestamp;
};

struct broadcast_state {
	UINTMAP(struct broadcastable *) broadcasts;
	size_t count;
	struct gossip_store *gs;
	struct list_head *peers;
};

static inline void broadcastable_init(struct broadcastable *bcast)
{
	bcast->index = 0;
}

struct broadcast_state *new_broadcast_state(struct routing_state *rstate,
					    struct gossip_store *gs,
					    struct list_head *peers);

/**
 * Append a queued message for broadcast.
 * @bstate: the broadcast state, will be replaced if we compact the store.
 * @msg: the message to append.
 * @addendum: an extra message (for GOSSIP_STORE_CHANNEL_AMOUNT after announce)
 * @bcast: broadcast location.
 *
 * If @bcast.index is 0, it is written into the store and set.
 * @bcast.timestamp must be set, and non-zero.
 */
void insert_broadcast(struct broadcast_state **bstate,
		      const u8 *msg,
		      const u8 *addendum,
		      struct broadcastable *bcast);

/* Add to broadcast, but not store: for gossip store compaction. */
void insert_broadcast_nostore(struct broadcast_state *bstate,
			      struct broadcastable *bcast);

/* Delete a broadcast: not usually needed, since destructor does it */
void broadcast_del(struct broadcast_state *bstate,
		   struct broadcastable *bcast);

/* Return the next broadcastable entry; doesn't load it. */
struct broadcastable *next_broadcast_raw(struct broadcast_state *bstate,
					 u32 *last_index);

/* Return the broadcast with index >= *last_index, timestamp >= min and <= max
 * and update *last_index.
 * There's no broadcast with index 0. */
struct broadcastable *next_broadcast(struct broadcast_state *bstate,
				     u32 timestamp_min, u32 timestamp_max,
				     u32 *last_index);

/* index of last entry. */
u64 broadcast_final_index(const struct broadcast_state *bstate);

/* Returns b if all OK, otherwise aborts if abortstr non-NULL, otherwise returns
 * NULL. */
struct broadcast_state *broadcast_state_check(struct broadcast_state *b,
					      const char *abortstr);

/* Callback for after we compacted the store */
void update_peers_broadcast_index(struct list_head *peers, u32 offset);
#endif /* LIGHTNING_GOSSIPD_BROADCAST_H */