#include "jsonrpc.h" #include "lightningd.h" #include "log.h" #include "overflows.h" #include "packets.h" #include "peer.h" #include "pseudorand.h" #include "routing.h" #include #include #include #include #include /* 365.25 * 24 * 60 / 10 */ #define BLOCKS_PER_YEAR 52596 struct routing_state *new_routing_state(const tal_t *ctx, struct log *base_log) { struct routing_state *rstate = tal(ctx, struct routing_state); rstate->base_log = base_log; rstate->nodes = empty_node_map(rstate); return rstate; } static const secp256k1_pubkey *keyof_node(const struct node *n) { return &n->id.pubkey; } static size_t hash_key(const secp256k1_pubkey *key) { return siphash24(siphash_seed(), key, sizeof(*key)); } static bool node_eq(const struct node *n, const secp256k1_pubkey *key) { return structeq(&n->id.pubkey, key); } HTABLE_DEFINE_TYPE(struct node, keyof_node, hash_key, node_eq, node_map); struct node_map *empty_node_map(const tal_t *ctx) { struct node_map *map = tal(ctx, struct node_map); node_map_init(map); return map; } struct node *get_node(struct routing_state *rstate, const struct pubkey *id) { return node_map_get(rstate->nodes, &id->pubkey); } static void destroy_node(struct node *node) { /* These remove themselves from the array. */ while (tal_count(node->in)) tal_free(node->in[0]); while (tal_count(node->out)) tal_free(node->out[0]); } struct node *new_node(struct routing_state *rstate, const struct pubkey *id) { struct node *n; assert(!get_node(rstate, id)); n = tal(rstate, struct node); n->id = *id; n->in = tal_arr(n, struct node_connection *, 0); n->out = tal_arr(n, struct node_connection *, 0); n->port = 0; n->alias = NULL; n->hostname = NULL; n->node_announcement = NULL; node_map_add(rstate->nodes, n); tal_add_destructor(n, destroy_node); return n; } struct node *add_node( struct routing_state *rstate, const struct pubkey *pk, char *hostname, int port) { struct node *n = get_node(rstate, pk); if (!n) { n = new_node(rstate, pk); log_debug_struct(rstate->base_log, "Creating new node %s", struct pubkey, pk); } else { log_debug_struct(rstate->base_log, "Update existing node %s", struct pubkey, pk); } n->hostname = tal_steal(n, hostname); n->port = port; return n; } static bool remove_conn_from_array(struct node_connection ***conns, struct node_connection *nc) { size_t i, n; n = tal_count(*conns); for (i = 0; i < n; i++) { if ((*conns)[i] != nc) continue; n--; memmove(*conns + i, *conns + i + 1, sizeof(**conns) * (n - i)); tal_resize(conns, n); return true; } return false; } static void destroy_connection(struct node_connection *nc) { if (!remove_conn_from_array(&nc->dst->in, nc) || !remove_conn_from_array(&nc->src->out, nc)) fatal("Connection not found in array?!"); } struct node_connection * get_connection(struct routing_state *rstate, const struct pubkey *from_id, const struct pubkey *to_id) { int i, n; struct node *from, *to; from = get_node(rstate, from_id); to = get_node(rstate, to_id); if (!from || ! to) return NULL; n = tal_count(to->in); for (i = 0; i < n; i++) { if (to->in[i]->src == from) return to->in[i]; } return NULL; } struct node_connection *get_connection_by_cid(const struct routing_state *rstate, const struct channel_id *chanid, const u8 direction) { struct node *n; int i, num_conn; struct node_map *nodes = rstate->nodes; struct node_connection *c; struct node_map_iter it; //FIXME(cdecker) We probably want to speed this up by indexing by chanid. for (n = node_map_first(nodes, &it); n; n = node_map_next(nodes, &it)) { num_conn = tal_count(n->out); for (i = 0; i < num_conn; i++){ c = n->out[i]; if (structeq(&c->channel_id, chanid) && (c->flags&0x1) == direction) return c; } } return NULL; } static struct node_connection * get_or_make_connection(struct routing_state *rstate, const struct pubkey *from_id, const struct pubkey *to_id) { size_t i, n; struct node *from, *to; struct node_connection *nc; from = get_node(rstate, from_id); if (!from) from = new_node(rstate, from_id); to = get_node(rstate, to_id); if (!to) to = new_node(rstate, to_id); n = tal_count(to->in); for (i = 0; i < n; i++) { if (to->in[i]->src == from) { log_debug_struct(rstate->base_log, "Updating existing route from %s", struct pubkey, &from->id); log_add_struct(rstate->base_log, " to %s", struct pubkey, &to->id); return to->in[i]; } } log_debug_struct(rstate->base_log, "Creating new route from %s", struct pubkey, &from->id); log_add_struct(rstate->base_log, " to %s", struct pubkey, &to->id); nc = tal(rstate, struct node_connection); nc->src = from; nc->dst = to; nc->channel_announcement = NULL; nc->channel_update = NULL; log_add(rstate->base_log, " = %p (%p->%p)", nc, from, to); /* Hook it into in/out arrays. */ i = tal_count(to->in); tal_resize(&to->in, i+1); to->in[i] = nc; i = tal_count(from->out); tal_resize(&from->out, i+1); from->out[i] = nc; tal_add_destructor(nc, destroy_connection); return nc; } struct node_connection *half_add_connection(struct routing_state *rstate, const struct pubkey *from, const struct pubkey *to, const struct channel_id *chanid, const u16 flags ) { struct node_connection *nc; nc = get_or_make_connection(rstate, from, to); memcpy(&nc->channel_id, chanid, sizeof(nc->channel_id)); nc->active = false; nc->last_timestamp = 0; nc->flags = flags; nc->min_blocks = 0; nc->proportional_fee = 0; nc->base_fee = 0; nc->delay = 0; return nc; } /* Updates existing route if required. */ struct node_connection *add_connection(struct routing_state *rstate, const struct pubkey *from, const struct pubkey *to, u32 base_fee, s32 proportional_fee, u32 delay, u32 min_blocks) { struct node_connection *c = get_or_make_connection(rstate, from, to); c->base_fee = base_fee; c->proportional_fee = proportional_fee; c->delay = delay; c->min_blocks = min_blocks; c->active = true; c->last_timestamp = 0; memset(&c->channel_id, 0, sizeof(c->channel_id)); c->flags = pubkey_cmp(from, to) > 0; return c; } void remove_connection(struct routing_state *rstate, const struct pubkey *src, const struct pubkey *dst) { struct node *from, *to; size_t i, num_edges; log_debug_struct(rstate->base_log, "Removing route from %s", struct pubkey, src); log_add_struct(rstate->base_log, " to %s", struct pubkey, dst); from = get_node(rstate, src); to = get_node(rstate, dst); if (!from || !to) { log_debug(rstate->base_log, "Not found: src=%p dst=%p", from, to); return; } num_edges = tal_count(from->out); for (i = 0; i < num_edges; i++) { if (from->out[i]->dst != to) continue; log_add(rstate->base_log, " Matched route %zu of %zu", i, num_edges); /* Destructor makes it delete itself */ tal_free(from->out[i]); return; } log_add(rstate->base_log, " None of %zu routes matched", num_edges); } /* Too big to reach, but don't overflow if added. */ #define INFINITE 0x3FFFFFFFFFFFFFFFULL static void clear_bfg(struct node_map *nodes) { struct node *n; struct node_map_iter it; for (n = node_map_first(nodes, &it); n; n = node_map_next(nodes, &it)) { size_t i; for (i = 0; i < ARRAY_SIZE(n->bfg); i++) { n->bfg[i].total = INFINITE; n->bfg[i].risk = 0; } } } s64 connection_fee(const struct node_connection *c, u64 msatoshi) { s64 fee; if (mul_overflows_s64(c->proportional_fee, msatoshi)) return INFINITE; fee = (c->proportional_fee * msatoshi) / 1000000; /* This can't overflow: c->base_fee is a u32 */ return c->base_fee + fee; } /* Risk of passing through this channel. We insert a tiny constant here * in order to prefer shorter routes, all things equal. */ static u64 risk_fee(s64 amount, u32 delay, double riskfactor) { /* If fees are so negative we're making money, ignore risk. */ if (amount < 0) return 1; return 1 + amount * delay * riskfactor / BLOCKS_PER_YEAR / 10000; } /* We track totals, rather than costs. That's because the fee depends * on the current amount passing through. */ static void bfg_one_edge(struct node *node, size_t edgenum, double riskfactor) { struct node_connection *c = node->in[edgenum]; size_t h; assert(c->dst == node); for (h = 0; h < ROUTING_MAX_HOPS; h++) { /* FIXME: Bias against smaller channels. */ s64 fee = connection_fee(c, node->bfg[h].total); u64 risk = node->bfg[h].risk + risk_fee(node->bfg[h].total + fee, c->delay, riskfactor); if (node->bfg[h].total + (s64)fee + (s64)risk < c->src->bfg[h+1].total + (s64)c->src->bfg[h+1].risk) { c->src->bfg[h+1].total = node->bfg[h].total + fee; c->src->bfg[h+1].risk = risk; c->src->bfg[h+1].prev = c; } } } struct pubkey *find_route(const tal_t *ctx, struct routing_state *rstate, const struct pubkey *from, const struct pubkey *to, u64 msatoshi, double riskfactor, s64 *fee, struct node_connection ***route) { struct node *n, *src, *dst; struct node_map_iter it; struct pubkey *first; int runs, i, best; /* Note: we map backwards, since we know the amount of satoshi we want * at the end, and need to derive how much we need to send. */ dst = get_node(rstate, from); src = get_node(rstate, to); if (!src) { log_info_struct(rstate->base_log, "find_route: cannot find %s", struct pubkey, to); return NULL; } else if (dst == src) { log_info_struct(rstate->base_log, "find_route: this is %s, refusing to create empty route", struct pubkey, to); return NULL; } /* Reset all the information. */ clear_bfg(rstate->nodes); /* Bellman-Ford-Gibson: like Bellman-Ford, but keep values for * every path length. */ src->bfg[0].total = msatoshi; src->bfg[0].risk = 0; for (runs = 0; runs < ROUTING_MAX_HOPS; runs++) { log_debug(rstate->base_log, "Run %i", runs); /* Run through every edge. */ for (n = node_map_first(rstate->nodes, &it); n; n = node_map_next(rstate->nodes, &it)) { size_t num_edges = tal_count(n->in); for (i = 0; i < num_edges; i++) { if (!n->in[i]->active) continue; bfg_one_edge(n, i, riskfactor); log_debug(rstate->base_log, "We seek %p->%p, this is %p -> %p", dst, src, n->in[i]->src, n->in[i]->dst); log_debug_struct(rstate->base_log, "Checking from %s", struct pubkey, &n->in[i]->src->id); log_add_struct(rstate->base_log, " to %s", struct pubkey, &n->in[i]->dst->id); } } } best = 0; for (i = 1; i <= ROUTING_MAX_HOPS; i++) { if (dst->bfg[i].total < dst->bfg[best].total) best = i; } /* No route? */ if (dst->bfg[best].total >= INFINITE) { log_info_struct(rstate->base_log, "find_route: No route to %s", struct pubkey, to); return NULL; } /* Save route from *next* hop (we return first hop as peer). * Note that we take our own fees into account for routing, even * though we don't pay them: it presumably effects preference. */ dst = dst->bfg[best].prev->dst; best--; first = &dst->id; *fee = dst->bfg[best].total - msatoshi; *route = tal_arr(ctx, struct node_connection *, best); for (i = 0, n = dst; i < best; n = n->bfg[best-i].prev->dst, i++) { (*route)[i] = n->bfg[best-i].prev; } assert(n == src); msatoshi += *fee; log_info(rstate->base_log, "find_route:"); log_add_struct(rstate->base_log, "via %s", struct pubkey, first); /* If there are intermidiaries, dump them, and total fees. */ if (best != 0) { for (i = 0; i < best; i++) { log_add_struct(rstate->base_log, " %s", struct pubkey, &(*route)[i]->dst->id); log_add(rstate->base_log, "(%i+%i=%"PRIu64")", (*route)[i]->base_fee, (*route)[i]->proportional_fee, connection_fee((*route)[i], msatoshi)); msatoshi -= connection_fee((*route)[i], msatoshi); } log_add(rstate->base_log, "=%"PRIi64"(%+"PRIi64")", (*route)[best-1]->dst->bfg[best-1].total, *fee); } return first; } static bool get_slash_u32(const char **arg, u32 *v) { size_t len; char *endp; if (**arg != '/') return false; (*arg)++; len = strcspn(*arg, "/"); *v = strtoul(*arg, &endp, 10); (*arg) += len; return (endp == *arg); } /* srcid/dstid/base/var/delay/minblocks */ char *opt_add_route(const char *arg, struct lightningd_state *dstate) { size_t len; struct pubkey src, dst; u32 base, var, delay, minblocks; len = strcspn(arg, "/"); if (!pubkey_from_hexstr(arg, len, &src)) return "Bad src pubkey"; arg += len + 1; len = strcspn(arg, "/"); if (!pubkey_from_hexstr(arg, len, &dst)) return "Bad dst pubkey"; arg += len; if (!get_slash_u32(&arg, &base) || !get_slash_u32(&arg, &var) || !get_slash_u32(&arg, &delay) || !get_slash_u32(&arg, &minblocks)) return "Bad base/var/delay/minblocks"; if (*arg) return "Data after minblocks"; add_connection(dstate->rstate, &src, &dst, base, var, delay, minblocks); return NULL; } static void json_add_route(struct command *cmd, const char *buffer, const jsmntok_t *params) { jsmntok_t *srctok, *dsttok, *basetok, *vartok, *delaytok, *minblockstok; struct pubkey src, dst; u32 base, var, delay, minblocks; if (!json_get_params(buffer, params, "src", &srctok, "dst", &dsttok, "base", &basetok, "var", &vartok, "delay", &delaytok, "minblocks", &minblockstok, NULL)) { command_fail(cmd, "Need src, dst, base, var, delay & minblocks"); return; } if (!pubkey_from_hexstr(buffer + srctok->start, srctok->end - srctok->start, &src)) { command_fail(cmd, "src %.*s not valid", srctok->end - srctok->start, buffer + srctok->start); return; } if (!pubkey_from_hexstr(buffer + dsttok->start, dsttok->end - dsttok->start, &dst)) { command_fail(cmd, "dst %.*s not valid", dsttok->end - dsttok->start, buffer + dsttok->start); return; } if (!json_tok_number(buffer, basetok, &base) || !json_tok_number(buffer, vartok, &var) || !json_tok_number(buffer, delaytok, &delay) || !json_tok_number(buffer, minblockstok, &minblocks)) { command_fail(cmd, "base, var, delay and minblocks must be numbers"); return; } add_connection(cmd->dstate->rstate, &src, &dst, base, var, delay, minblocks); command_success(cmd, null_response(cmd)); } void sync_routing_table(struct lightningd_state *dstate, struct peer *peer) { struct node *n; struct node_map_iter it; int i; struct node_connection *nc; for (n = node_map_first(dstate->rstate->nodes, &it); n; n = node_map_next(dstate->rstate->nodes, &it)) { size_t num_edges = tal_count(n->out); for (i = 0; i < num_edges; i++) { nc = n->out[i]; if (nc->channel_announcement) queue_pkt_nested(peer, WIRE_CHANNEL_ANNOUNCEMENT, nc->channel_announcement); if (nc->channel_update) queue_pkt_nested(peer, WIRE_CHANNEL_UPDATE, nc->channel_update); } if (n->node_announcement && num_edges > 0) queue_pkt_nested(peer, WIRE_NODE_ANNOUNCEMENT, n->node_announcement); } } static const struct json_command dev_add_route_command = { "dev-add-route", json_add_route, "Add route from {src} to {dst}, {base} rate in msatoshi, {var} rate in msatoshi, {delay} blocks delay and {minblocks} minimum timeout", "Returns an empty result on success" }; AUTODATA(json_command, &dev_add_route_command); static void json_getchannels(struct command *cmd, const char *buffer, const jsmntok_t *params) { struct json_result *response = new_json_result(cmd); struct node_map_iter it; struct node *n; struct node_map *nodes = cmd->dstate->rstate->nodes; struct node_connection *c; int num_conn, i; json_object_start(response, NULL); json_array_start(response, "channels"); for (n = node_map_first(nodes, &it); n; n = node_map_next(nodes, &it)) { num_conn = tal_count(n->out); for (i = 0; i < num_conn; i++){ c = n->out[i]; json_object_start(response, NULL); json_add_pubkey(response, "from", &n->id); json_add_pubkey(response, "to", &c->dst->id); json_add_num(response, "base_fee", c->base_fee); json_add_num(response, "proportional_fee", c->proportional_fee); json_add_num(response, "expiry", c->delay); json_add_bool(response, "active", c->active); json_object_end(response); } } json_array_end(response); json_object_end(response); command_success(cmd, response); } static const struct json_command getchannels_command = { "getchannels", json_getchannels, "List all known channels.", "Returns a 'channels' array with all known channels including their fees." }; AUTODATA(json_command, &getchannels_command); static void json_routefail(struct command *cmd, const char *buffer, const jsmntok_t *params) { jsmntok_t *enabletok; bool enable; if (!json_get_params(buffer, params, "enable", &enabletok, NULL)) { command_fail(cmd, "Need enable"); return; } if (!json_tok_bool(buffer, enabletok, &enable)) { command_fail(cmd, "enable must be true or false"); return; } log_debug(cmd->dstate->base_log, "dev-routefail: routefail %s", enable ? "enabled" : "disabled"); cmd->dstate->dev_never_routefail = !enable; command_success(cmd, null_response(cmd)); } static const struct json_command dev_routefail_command = { "dev-routefail", json_routefail, "FAIL htlcs that we can't route if {enable}", "Returns an empty result on success" }; AUTODATA(json_command, &dev_routefail_command); static void json_getnodes(struct command *cmd, const char *buffer, const jsmntok_t *params) { struct json_result *response = new_json_result(cmd); struct node *n; struct node_map_iter i; n = node_map_first(cmd->dstate->rstate->nodes, &i); json_object_start(response, NULL); json_array_start(response, "nodes"); while (n != NULL) { json_object_start(response, NULL); json_add_pubkey(response, "nodeid", &n->id); json_add_num(response, "port", n->port); if (!n->port) json_add_null(response, "hostname"); else json_add_string(response, "hostname", n->hostname); json_object_end(response); n = node_map_next(cmd->dstate->rstate->nodes, &i); } json_array_end(response); json_object_end(response); command_success(cmd, response); } static const struct json_command getnodes_command = { "getnodes", json_getnodes, "List all known nodes in the network.", "Returns a 'nodes' array" }; AUTODATA(json_command, &getnodes_command);