mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-19 18:11:28 +01:00
6bff10cd40
This will allow gossipd to store and persist gossip for channels rather than deleting them entirely when the channels are pruned from the network.
93 lines
2.5 KiB
C
93 lines
2.5 KiB
C
#ifndef LIGHTNING_COMMON_GOSSIP_STORE_H
|
|
#define LIGHTNING_COMMON_GOSSIP_STORE_H
|
|
#include "config.h"
|
|
#include <ccan/endian/endian.h>
|
|
#include <ccan/short_types/short_types.h>
|
|
#include <ccan/tal/tal.h>
|
|
|
|
struct gossip_state;
|
|
struct gossip_rcvd_filter;
|
|
|
|
/**
|
|
* gossip_store -- On-disk storage related information
|
|
*/
|
|
|
|
/* First byte of file is the version.
|
|
*
|
|
* Top three bits mean incompatible change.
|
|
* As of this writing, major == 0, minor == 11.
|
|
*/
|
|
#define GOSSIP_STORE_MAJOR_VERSION_MASK 0xE0
|
|
#define GOSSIP_STORE_MINOR_VERSION_MASK 0x1F
|
|
|
|
/* Extract version from first byte */
|
|
#define GOSSIP_STORE_MAJOR_VERSION(verbyte) (((u8)(verbyte)) >> 5)
|
|
#define GOSSIP_STORE_MINOR_VERSION(verbyte) ((verbyte) & GOSSIP_STORE_MINOR_VERSION_MASK)
|
|
|
|
/**
|
|
* Bit of length we use to mark a deleted record.
|
|
*/
|
|
#define GOSSIP_STORE_LEN_DELETED_BIT 0x80000000U
|
|
|
|
/**
|
|
* Bit of length we use to mark an important record.
|
|
*/
|
|
#define GOSSIP_STORE_LEN_PUSH_BIT 0x40000000U
|
|
|
|
/**
|
|
* Bit of length used to define a rate-limited record (do not rebroadcast)
|
|
*/
|
|
#define GOSSIP_STORE_LEN_RATELIMIT_BIT 0x20000000U
|
|
|
|
/**
|
|
* Bit used to mark a channel announcement as inactive (needs channel updates.)
|
|
*/
|
|
#define GOSSIP_STORE_LEN_ZOMBIE_BIT 0x10000000U
|
|
|
|
/**
|
|
* Full flags mask
|
|
*/
|
|
#define GOSSIP_STORE_FLAGS_MASK 0xFFFF0000U
|
|
|
|
/* Mask for extracting just the length part of len field */
|
|
#define GOSSIP_STORE_LEN_MASK \
|
|
(~(GOSSIP_STORE_FLAGS_MASK))
|
|
|
|
/**
|
|
* gossip_hdr -- On-disk format header.
|
|
*/
|
|
struct gossip_hdr {
|
|
beint32_t len; /* Length of message after header. */
|
|
beint32_t crc; /* crc of message of timestamp, after header. */
|
|
beint32_t timestamp; /* timestamp of msg. */
|
|
};
|
|
|
|
/**
|
|
* Direct store accessor: loads gossip msg from store.
|
|
*
|
|
* Returns NULL if there are no more gossip msgs.
|
|
* Updates *end if the known end of file has moved.
|
|
* Updates *gossip_store_fd if file has been compacted.
|
|
*/
|
|
u8 *gossip_store_next(const tal_t *ctx,
|
|
int *gossip_store_fd,
|
|
u32 timestamp_min, u32 timestamp_max,
|
|
bool push_only,
|
|
bool with_spam,
|
|
size_t *off, size_t *end);
|
|
|
|
/**
|
|
* Gossipd will be writing to this, and it's not atomic! Safest
|
|
* way to find the "end" is to walk through.
|
|
* @old_end: 1 if no previous end.
|
|
*/
|
|
size_t find_gossip_store_end(int gossip_store_fd, size_t old_end);
|
|
|
|
/**
|
|
* Return offset of first entry >= this timestamp.
|
|
*/
|
|
size_t find_gossip_store_by_timestamp(int gossip_store_fd,
|
|
size_t off,
|
|
u32 timestamp);
|
|
#endif /* LIGHTNING_COMMON_GOSSIP_STORE_H */
|