core-lightning/plugins/askrene/layer.c
Rusty Russell fcc0d2bad8 askrene: remove unused parameter in layer_add_localmods.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2024-10-04 11:27:53 +09:30

481 lines
13 KiB
C

#include "config.h"
#include <ccan/array_size/array_size.h>
#include <ccan/htable/htable_type.h>
#include <ccan/tal/str/str.h>
#include <common/gossmap.h>
#include <common/json_stream.h>
#include <common/memleak.h>
#include <plugins/askrene/askrene.h>
#include <plugins/askrene/layer.h>
/* A channels which doesn't (necessarily) exist in the gossmap. */
struct local_channel {
/* Canonical order, n1 < n2 */
struct node_id n1, n2;
struct short_channel_id scid;
struct amount_msat capacity;
struct added_channel_half {
/* Other fields only valid if this is true */
bool enabled;
u16 delay;
u32 proportional_fee;
struct amount_msat base_fee;
struct amount_msat htlc_min, htlc_max;
} half[2];
};
static const struct short_channel_id_dir *
constraint_scidd(const struct constraint *c)
{
return &c->scidd;
}
static inline bool constraint_eq_scidd(const struct constraint *c,
const struct short_channel_id_dir *scidd)
{
return short_channel_id_dir_eq(scidd, &c->scidd);
}
HTABLE_DEFINE_TYPE(struct constraint, constraint_scidd, hash_scidd,
constraint_eq_scidd, constraint_hash);
static struct short_channel_id
local_channel_scid(const struct local_channel *lc)
{
return lc->scid;
}
static size_t hash_scid(const struct short_channel_id scid)
{
/* scids cost money to generate, so simple hash works here */
return (scid.u64 >> 32) ^ (scid.u64 >> 16) ^ scid.u64;
}
static inline bool local_channel_eq_scid(const struct local_channel *lc,
const struct short_channel_id scid)
{
return short_channel_id_eq(scid, lc->scid);
}
HTABLE_DEFINE_TYPE(struct local_channel, local_channel_scid, hash_scid,
local_channel_eq_scid, local_channel_hash);
struct layer {
/* Inside global list of layers */
struct list_node list;
/* Unique identifiers */
const char *name;
/* Completely made up local additions, indexed by scid */
struct local_channel_hash *local_channels;
/* Additional info, indexed by scid+dir */
struct constraint_hash *constraints;
/* Nodes to completely disable (tal_arr) */
struct node_id *disabled_nodes;
/* Channels to completely disable (tal_arr) */
struct short_channel_id_dir *disabled_channels;
};
struct layer *new_temp_layer(const tal_t *ctx, const char *name)
{
struct layer *l = tal(ctx, struct layer);
l->name = tal_strdup(l, name);
l->local_channels = tal(l, struct local_channel_hash);
local_channel_hash_init(l->local_channels);
l->constraints = tal(l, struct constraint_hash);
constraint_hash_init(l->constraints);
l->disabled_nodes = tal_arr(l, struct node_id, 0);
l->disabled_channels = tal_arr(l, struct short_channel_id_dir, 0);
return l;
}
static void destroy_layer(struct layer *l, struct askrene *askrene)
{
list_del_from(&askrene->layers, &l->list);
}
struct layer *new_layer(struct askrene *askrene, const char *name)
{
struct layer *l = new_temp_layer(askrene, name);
list_add(&askrene->layers, &l->list);
tal_add_destructor2(l, destroy_layer, askrene);
return l;
}
/* Swap if necessary to make into BOLT-7 order. Return direction. */
static int canonicalize_node_order(const struct node_id **n1,
const struct node_id **n2)
{
const struct node_id *tmp;
if (node_id_cmp(*n1, *n2) < 0)
return 0;
tmp = *n2;
*n2 = *n1;
*n1 = tmp;
return 1;
}
struct layer *find_layer(struct askrene *askrene, const char *name)
{
struct layer *l;
list_for_each(&askrene->layers, l, list) {
if (streq(l->name, name))
return l;
}
return NULL;
}
const char *layer_name(const struct layer *layer)
{
return layer->name;
}
static struct local_channel *new_local_channel(struct layer *layer,
const struct node_id *n1,
const struct node_id *n2,
struct short_channel_id scid,
struct amount_msat capacity)
{
struct local_channel *lc = tal(layer, struct local_channel);
lc->n1 = *n1;
lc->n2 = *n2;
lc->scid = scid;
lc->capacity = capacity;
for (size_t i = 0; i < ARRAY_SIZE(lc->half); i++)
lc->half[i].enabled = false;
local_channel_hash_add(layer->local_channels, lc);
return lc;
}
bool layer_check_local_channel(const struct local_channel *lc,
const struct node_id *n1,
const struct node_id *n2,
struct amount_msat capacity)
{
canonicalize_node_order(&n1, &n2);
return node_id_eq(&lc->n1, n1)
&& node_id_eq(&lc->n2, n2)
&& amount_msat_eq(lc->capacity, capacity);
}
/* Update a local channel to a layer: fails if you try to change capacity or nodes! */
void layer_update_local_channel(struct layer *layer,
const struct node_id *src,
const struct node_id *dst,
struct short_channel_id scid,
struct amount_msat capacity,
struct amount_msat base_fee,
u32 proportional_fee,
u16 delay,
struct amount_msat htlc_min,
struct amount_msat htlc_max)
{
struct local_channel *lc = local_channel_hash_get(layer->local_channels, scid);
int dir = canonicalize_node_order(&src, &dst);
struct short_channel_id_dir scidd;
if (lc) {
assert(layer_check_local_channel(lc, src, dst, capacity));
} else {
lc = new_local_channel(layer, src, dst, scid, capacity);
}
lc->half[dir].enabled = true;
lc->half[dir].htlc_min = htlc_min;
lc->half[dir].htlc_max = htlc_max;
lc->half[dir].base_fee = base_fee;
lc->half[dir].proportional_fee = proportional_fee;
lc->half[dir].delay = delay;
/* We always add an explicit constraint for local channels, to simplify
* lookups. You can tell it's a fake one by the timestamp. */
scidd.scid = scid;
scidd.dir = dir;
layer_update_constraint(layer, &scidd, UINT64_MAX, NULL, &capacity);
}
struct amount_msat local_channel_capacity(const struct local_channel *lc)
{
return lc->capacity;
}
const struct local_channel *layer_find_local_channel(const struct layer *layer,
struct short_channel_id scid)
{
return local_channel_hash_get(layer->local_channels, scid);
}
static struct constraint *layer_find_constraint_nonconst(const struct layer *layer,
const struct short_channel_id_dir *scidd)
{
return constraint_hash_get(layer->constraints, scidd);
}
/* Public one returns const */
const struct constraint *layer_find_constraint(const struct layer *layer,
const struct short_channel_id_dir *scidd)
{
return layer_find_constraint_nonconst(layer, scidd);
}
const struct constraint *layer_update_constraint(struct layer *layer,
const struct short_channel_id_dir *scidd,
u64 timestamp,
const struct amount_msat *min,
const struct amount_msat *max)
{
struct constraint *c = layer_find_constraint_nonconst(layer, scidd);
if (!c) {
c = tal(layer, struct constraint);
c->scidd = *scidd;
c->min = AMOUNT_MSAT(0);
c->max = AMOUNT_MSAT(UINT64_MAX);
constraint_hash_add(layer->constraints, c);
}
/* Increase minimum? */
if (min && amount_msat_greater(*min, c->min))
c->min = *min;
/* Decrease maximum? */
if (max && amount_msat_less(*max, c->max))
c->max = *max;
c->timestamp = timestamp;
return c;
}
void layer_clear_overridden_capacities(const struct layer *layer,
const struct gossmap *gossmap,
fp16_t *capacities)
{
struct constraint_hash_iter conit;
struct constraint *con;
for (con = constraint_hash_first(layer->constraints, &conit);
con;
con = constraint_hash_next(layer->constraints, &conit)) {
struct gossmap_chan *c = gossmap_find_chan(gossmap, &con->scidd.scid);
size_t idx;
if (!c)
continue;
idx = gossmap_chan_idx(gossmap, c);
if (idx < tal_count(capacities))
capacities[idx] = 0;
}
}
size_t layer_trim_constraints(struct layer *layer, u64 cutoff)
{
size_t num_removed = 0;
struct constraint_hash_iter conit;
struct constraint *con;
for (con = constraint_hash_first(layer->constraints, &conit);
con;
con = constraint_hash_next(layer->constraints, &conit)) {
if (con->timestamp < cutoff) {
constraint_hash_delval(layer->constraints, &conit);
tal_free(con);
num_removed++;
}
}
return num_removed;
}
void layer_add_disabled_node(struct layer *layer, const struct node_id *node)
{
tal_arr_expand(&layer->disabled_nodes, *node);
}
void layer_add_disabled_channel(struct layer *layer, const struct short_channel_id_dir *scidd)
{
tal_arr_expand(&layer->disabled_channels, *scidd);
}
void layer_add_localmods(const struct layer *layer,
const struct gossmap *gossmap,
struct gossmap_localmods *localmods)
{
const struct local_channel *lc;
struct local_channel_hash_iter lcit;
/* First, disable all channels into blocked nodes (local updates
* can add new ones)! */
for (size_t i = 0; i < tal_count(layer->disabled_nodes); i++) {
const struct gossmap_node *node;
node = gossmap_find_node(gossmap, &layer->disabled_nodes[i]);
if (!node)
continue;
for (size_t n = 0; n < node->num_chans; n++) {
struct short_channel_id scid;
struct gossmap_chan *c;
int dir;
c = gossmap_nth_chan(gossmap, node, n, &dir);
scid = gossmap_chan_scid(gossmap, c);
/* Disabled zero-capacity on incoming */
gossmap_local_updatechan(localmods,
scid,
AMOUNT_MSAT(0),
AMOUNT_MSAT(0),
0,
0,
0,
false,
!dir);
}
}
for (lc = local_channel_hash_first(layer->local_channels, &lcit);
lc;
lc = local_channel_hash_next(layer->local_channels, &lcit)) {
gossmap_local_addchan(localmods,
&lc->n1, &lc->n2, lc->scid, NULL);
for (size_t i = 0; i < ARRAY_SIZE(lc->half); i++) {
if (!lc->half[i].enabled)
continue;
gossmap_local_updatechan(localmods, lc->scid,
lc->half[i].htlc_min,
lc->half[i].htlc_max,
lc->half[i].base_fee.millisatoshis, /* Raw: gossmap */
lc->half[i].proportional_fee,
lc->half[i].delay,
true,
i);
}
}
/* Now disable any channels they asked us to */
for (size_t i = 0; i < tal_count(layer->disabled_channels); i++) {
gossmap_local_updatechan(localmods,
layer->disabled_channels[i].scid,
AMOUNT_MSAT(0),
AMOUNT_MSAT(0),
0,
0,
0,
false,
layer->disabled_channels[i].dir);
}
}
static void json_add_local_channel(struct json_stream *response,
const char *fieldname,
const struct local_channel *lc,
int dir)
{
json_object_start(response, fieldname);
if (dir == 0) {
json_add_node_id(response, "source", &lc->n1);
json_add_node_id(response, "destination", &lc->n2);
} else {
json_add_node_id(response, "source", &lc->n2);
json_add_node_id(response, "destination", &lc->n1);
}
json_add_short_channel_id(response, "short_channel_id", lc->scid);
json_add_amount_msat(response, "capacity_msat", lc->capacity);
json_add_amount_msat(response, "htlc_minimum_msat", lc->half[dir].htlc_min);
json_add_amount_msat(response, "htlc_maximum_msat", lc->half[dir].htlc_max);
json_add_amount_msat(response, "fee_base_msat", lc->half[dir].base_fee);
json_add_u32(response, "fee_proportional_millionths", lc->half[dir].proportional_fee);
json_add_u32(response, "delay", lc->half[dir].delay);
json_object_end(response);
}
void json_add_constraint(struct json_stream *js,
const char *fieldname,
const struct constraint *c,
const struct layer *layer)
{
json_object_start(js, fieldname);
if (layer)
json_add_string(js, "layer", layer->name);
json_add_short_channel_id_dir(js, "short_channel_id_dir", c->scidd);
json_add_u64(js, "timestamp", c->timestamp);
if (!amount_msat_is_zero(c->min))
json_add_amount_msat(js, "minimum_msat", c->min);
if (!amount_msat_eq(c->max, AMOUNT_MSAT(UINT64_MAX)))
json_add_amount_msat(js, "maximum_msat", c->max);
json_object_end(js);
}
static void json_add_layer(struct json_stream *js,
const char *fieldname,
const struct layer *layer)
{
struct local_channel_hash_iter lcit;
const struct local_channel *lc;
struct constraint_hash_iter conit;
const struct constraint *c;
json_object_start(js, fieldname);
json_add_string(js, "layer", layer->name);
json_array_start(js, "disabled_nodes");
for (size_t i = 0; i < tal_count(layer->disabled_nodes); i++)
json_add_node_id(js, NULL, &layer->disabled_nodes[i]);
json_array_end(js);
json_array_start(js, "disabled_channels");
for (size_t i = 0; i < tal_count(layer->disabled_channels); i++)
json_add_short_channel_id_dir(js, NULL, layer->disabled_channels[i]);
json_array_end(js);
json_array_start(js, "created_channels");
for (lc = local_channel_hash_first(layer->local_channels, &lcit);
lc;
lc = local_channel_hash_next(layer->local_channels, &lcit)) {
for (size_t i = 0; i < ARRAY_SIZE(lc->half); i++) {
if (lc->half[i].enabled)
json_add_local_channel(js, NULL, lc, i);
}
}
json_array_end(js);
json_array_start(js, "constraints");
for (c = constraint_hash_first(layer->constraints, &conit);
c;
c = constraint_hash_next(layer->constraints, &conit)) {
/* Don't show ones we generated internally */
if (c->timestamp == UINT64_MAX)
continue;
json_add_constraint(js, NULL, c, NULL);
}
json_array_end(js);
json_object_end(js);
}
void json_add_layers(struct json_stream *js,
struct askrene *askrene,
const char *fieldname,
const struct layer *layer)
{
struct layer *l;
json_array_start(js, fieldname);
list_for_each(&askrene->layers, l, list) {
if (layer && l != layer)
continue;
json_add_layer(js, NULL, l);
}
json_array_end(js);
}
void layer_memleak_mark(struct askrene *askrene, struct htable *memtable)
{
struct layer *l;
list_for_each(&askrene->layers, l, list) {
memleak_scan_htable(memtable, &l->constraints->raw);
memleak_scan_htable(memtable, &l->local_channels->raw);
}
}