lukechilds
/
lightning
mirror of https://github.com/lukechilds/lightning.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

libplugin: add remaining globals to the global state 

But not the outreqs helpers, which will be moved when passing
send_outreq_ to using ccan/io.
travis-debug
darosior 5 years ago
committed by Rusty Russell
parent
499dce1c38
commit
9ebfdf0b8c
4 changed files with 53 additions and 54 deletions
Unified View
  1. 15
      plugins/autoclean.c
  2. 4
      plugins/fundchannel.c
  3. 69
      plugins/libplugin.c
  4. 19
      plugins/libplugin.h

15
plugins/autoclean.c
View File

@ -10,18 +10,19 @@ static u64 cycle_seconds = 0, expired_by = 86400;
static struct plugin_timer *cleantimer; static struct plugin_timer *cleantimer;
static struct rpc_conn *rpc; static struct rpc_conn *rpc;
static struct command_result *do_clean(void); static struct command_result *do_clean(struct plugin *p);
static struct command_result *ignore(struct command *timer, static struct command_result *ignore(struct command *timer,
const char *buf, const char *buf,
const jsmntok_t *result, const jsmntok_t *result,
void *arg) void *arg)
{ {
cleantimer = plugin_timer(rpc, time_from_sec(cycle_seconds), do_clean); struct plugin *p = arg;
return timer_complete(); cleantimer = plugin_timer(p, time_from_sec(cycle_seconds), do_clean);
return timer_complete(p);
} }
static struct command_result *do_clean(void) static struct command_result *do_clean(struct plugin *p)
{ {
struct json_out *params = json_out_new(NULL); struct json_out *params = json_out_new(NULL);
json_out_start(params, NULL, '{'); json_out_start(params, NULL, '{');
@ -31,7 +32,7 @@ static struct command_result *do_clean(void)
json_out_finished(params); json_out_finished(params);
/* FIXME: delexpiredinvoice should be in our plugin too! */ /* FIXME: delexpiredinvoice should be in our plugin too! */
return send_outreq(NULL, "delexpiredinvoice", ignore, ignore, NULL, return send_outreq(NULL, "delexpiredinvoice", ignore, ignore, p,
take(params)); take(params));
} }
@ -56,7 +57,7 @@ static struct command_result *json_autocleaninvoice(struct command *cmd,
return command_success_str(cmd, "Autoclean timer disabled"); return command_success_str(cmd, "Autoclean timer disabled");
} }
tal_free(cleantimer); tal_free(cleantimer);
cleantimer = plugin_timer(rpc, time_from_sec(cycle_seconds), do_clean); cleantimer = plugin_timer(cmd->plugin, time_from_sec(cycle_seconds), do_clean);
return command_success_str(cmd, return command_success_str(cmd,
tal_fmt(cmd, "Autocleaning %"PRIu64 tal_fmt(cmd, "Autocleaning %"PRIu64
@ -72,7 +73,7 @@ static void init(struct plugin *p,
if (cycle_seconds) { if (cycle_seconds) {
plugin_log(LOG_INFORM, "autocleaning every %"PRIu64" seconds", cycle_seconds); plugin_log(LOG_INFORM, "autocleaning every %"PRIu64" seconds", cycle_seconds);
cleantimer = plugin_timer(rpc, time_from_sec(cycle_seconds), cleantimer = plugin_timer(p, time_from_sec(cycle_seconds),
do_clean); do_clean);
} else } else
plugin_log(LOG_DBG, "autocleaning not active"); plugin_log(LOG_DBG, "autocleaning not active");

4
plugins/fundchannel.c
View File

@ -314,7 +314,7 @@ static struct command_result *fundchannel_start(struct command *cmd,
json_out_start(ret, NULL, '{'); json_out_start(ret, NULL, '{');
json_out_addstr(ret, "id", node_id_to_hexstr(tmpctx, fr->id)); json_out_addstr(ret, "id", node_id_to_hexstr(tmpctx, fr->id));
if (deprecated_apis) if (cmd->plugin->deprecated_apis)
json_out_addstr(ret, "satoshi", fr->funding_str); json_out_addstr(ret, "satoshi", fr->funding_str);
else else
json_out_addstr(ret, "amount", fr->funding_str); json_out_addstr(ret, "amount", fr->funding_str);
@ -446,7 +446,7 @@ static struct command_result *json_fundchannel(struct command *cmd,
struct funding_req *fr = tal(cmd, struct funding_req); struct funding_req *fr = tal(cmd, struct funding_req);
/* For generating help, give new-style. */ /* For generating help, give new-style. */
if (!params || !deprecated_apis || params->type == JSMN_ARRAY) { if (!params || !cmd->plugin->deprecated_apis || params->type == JSMN_ARRAY) {
if (!param(cmd, buf, params, if (!param(cmd, buf, params,
p_req("id", param_node_id, &fr->id), p_req("id", param_node_id, &fr->id),
p_req("amount", param_string_check_sat, &fr->funding_str), p_req("amount", param_string_check_sat, &fr->funding_str),

69
plugins/libplugin.c
View File

@ -4,9 +4,7 @@
#include <ccan/io/io.h> #include <ccan/io/io.h>
#include <ccan/json_out/json_out.h> #include <ccan/json_out/json_out.h>
#include <ccan/read_write_all/read_write_all.h> #include <ccan/read_write_all/read_write_all.h>
#include <ccan/strmap/strmap.h>
#include <ccan/tal/str/str.h> #include <ccan/tal/str/str.h>
#include <ccan/timer/timer.h>
#include <common/daemon.h> #include <common/daemon.h>
#include <common/json_stream.h> #include <common/json_stream.h>
#include <common/utils.h> #include <common/utils.h>
@ -26,21 +24,11 @@
static UINTMAP(struct out_req *) out_reqs; static UINTMAP(struct out_req *) out_reqs;
static u64 next_outreq_id; static u64 next_outreq_id;
/* Map from json command names to usage strings: we don't put this inside const struct chainparams *chainparams;
* struct json_command as it's good practice to have those const. */
static STRMAP(const char *) usagemap;
/* Timers */
static struct timers timers;
static size_t in_timer;
bool deprecated_apis;
extern const struct chainparams *chainparams;
struct plugin_timer { struct plugin_timer {
struct timer timer; struct timer timer;
struct command_result *(*cb)(void); struct command_result *(*cb)(struct plugin *p);
}; };
struct out_req { struct out_req {
@ -247,10 +235,10 @@ struct command_result *command_err_raw(struct command *cmd,
json_str, strlen(json_str)); json_str, strlen(json_str));
} }
struct command_result *timer_complete(void) struct command_result *timer_complete(struct plugin *p)
{ {
assert(in_timer > 0); assert(p->in_timer > 0);
in_timer--; p->in_timer--;
return &complete; return &complete;
} }
@ -302,7 +290,7 @@ bool command_check_only(const struct command *cmd)
void command_set_usage(struct command *cmd, const char *usage TAKES) void command_set_usage(struct command *cmd, const char *usage TAKES)
{ {
usage = tal_strdup(NULL, usage); usage = tal_strdup(NULL, usage);
if (!strmap_add(&usagemap, cmd->methodname, usage)) if (!strmap_add(&cmd->plugin->usagemap, cmd->methodname, usage))
plugin_err("Two usages for command %s?", cmd->methodname); plugin_err("Two usages for command %s?", cmd->methodname);
} }
@ -476,7 +464,7 @@ handle_getmanifest(struct command *getmanifest_cmd)
json_out_start(params, NULL, '{'); json_out_start(params, NULL, '{');
json_out_addstr(params, "name", p->commands[i].name); json_out_addstr(params, "name", p->commands[i].name);
json_out_addstr(params, "usage", json_out_addstr(params, "usage",
strmap_get(&usagemap, p->commands[i].name)); strmap_get(&p->usagemap, p->commands[i].name));
json_out_addstr(params, "description", p->commands[i].description); json_out_addstr(params, "description", p->commands[i].description);
if (p->commands[i].long_description) if (p->commands[i].long_description)
json_out_addstr(params, "long_description", json_out_addstr(params, "long_description",
@ -542,7 +530,7 @@ static struct command_result *handle_init(struct command *cmd,
strerror(errno)); strerror(errno));
param_obj = json_out_obj(NULL, "config", "allow-deprecated-apis"); param_obj = json_out_obj(NULL, "config", "allow-deprecated-apis");
deprecated_apis = streq(rpc_delve(tmpctx, p, "listconfigs", p->deprecated_apis = streq(rpc_delve(tmpctx, p, "listconfigs",
take(param_obj), take(param_obj),
".allow-deprecated-apis"), ".allow-deprecated-apis"),
"true"); "true");
@ -589,46 +577,46 @@ char *charp_option(const char *arg, char **p)
return NULL; return NULL;
} }
static void setup_command_usage(const struct plugin_command *commands, static void setup_command_usage(struct plugin *p)
size_t num_commands)
{ {
struct command *usage_cmd = tal(tmpctx, struct command); struct command *usage_cmd = tal(tmpctx, struct command);
/* This is how common/param can tell it's just a usage request */ /* This is how common/param can tell it's just a usage request */
usage_cmd->usage_only = true; usage_cmd->usage_only = true;
for (size_t i = 0; i < num_commands; i++) { usage_cmd->plugin = p;
for (size_t i = 0; i < p->num_commands; i++) {
struct command_result *res; struct command_result *res;
usage_cmd->methodname = commands[i].name; usage_cmd->methodname = p->commands[i].name;
res = commands[i].handle(usage_cmd, NULL, NULL); res = p->commands[i].handle(usage_cmd, NULL, NULL);
assert(res == &complete); assert(res == &complete);
assert(strmap_get(&usagemap, commands[i].name)); assert(strmap_get(&p->usagemap, p->commands[i].name));
} }
} }
static void call_plugin_timer(struct rpc_conn *rpc, struct timer *timer) static void call_plugin_timer(struct plugin *p, struct timer *timer)
{ {
struct plugin_timer *t = container_of(timer, struct plugin_timer, timer); struct plugin_timer *t = container_of(timer, struct plugin_timer, timer);
in_timer++; p->in_timer++;
/* Free this if they don't. */ /* Free this if they don't. */
tal_steal(tmpctx, t); tal_steal(tmpctx, t);
t->cb(); t->cb(p);
} }
static void destroy_plugin_timer(struct plugin_timer *timer) static void destroy_plugin_timer(struct plugin_timer *timer, struct plugin *p)
{ {
timer_del(&timers, &timer->timer); timer_del(&p->timers, &timer->timer);
} }
struct plugin_timer *plugin_timer(struct rpc_conn *rpc, struct timerel t, struct plugin_timer *plugin_timer(struct plugin *p, struct timerel t,
struct command_result *(*cb)(void)) struct command_result *(*cb)(struct plugin *p))
{ {
struct plugin_timer *timer = tal(NULL, struct plugin_timer); struct plugin_timer *timer = tal(NULL, struct plugin_timer);
timer->cb = cb; timer->cb = cb;
timer_init(&timer->timer); timer_init(&timer->timer);
timer_addrel(&timers, &timer->timer, t); timer_addrel(&p->timers, &timer->timer, t);
tal_add_destructor(timer, destroy_plugin_timer); tal_add_destructor2(timer, destroy_plugin_timer, p);
return timer; return timer;
} }
@ -907,6 +895,8 @@ static struct plugin *new_plugin(const tal_t *ctx,
p->init = init; p->init = init;
p->manifested = p->initialized = false; p->manifested = p->initialized = false;
p->restartability = restartability; p->restartability = restartability;
strmap_init(&p->usagemap);
p->in_timer = 0;
p->commands = commands; p->commands = commands;
p->num_commands = num_commands; p->num_commands = num_commands;
@ -951,16 +941,15 @@ void plugin_main(char *argv[],
/* Note this already prints to stderr, which is enough for now */ /* Note this already prints to stderr, which is enough for now */
daemon_setup(argv[0], NULL, NULL); daemon_setup(argv[0], NULL, NULL);
setup_command_usage(commands, num_commands);
va_start(ap, num_hook_subs); va_start(ap, num_hook_subs);
plugin = new_plugin(NULL, init, restartability, commands, num_commands, plugin = new_plugin(NULL, init, restartability, commands, num_commands,
notif_subs, num_notif_subs, hook_subs, notif_subs, num_notif_subs, hook_subs,
num_hook_subs, ap); num_hook_subs, ap);
va_end(ap); va_end(ap);
uintmap_init(&out_reqs); uintmap_init(&out_reqs);
setup_command_usage(plugin);
timers_init(&timers, time_mono()); timers_init(&plugin->timers, time_mono());
io_new_conn(plugin, STDIN_FILENO, stdin_conn_init, plugin); io_new_conn(plugin, STDIN_FILENO, stdin_conn_init, plugin);
io_new_conn(plugin, STDOUT_FILENO, stdout_conn_init, plugin); io_new_conn(plugin, STDOUT_FILENO, stdout_conn_init, plugin);
@ -976,8 +965,8 @@ void plugin_main(char *argv[],
} }
/* Will only exit if a timer has expired. */ /* Will only exit if a timer has expired. */
io_loop(&timers, &expired); io_loop(&plugin->timers, &expired);
call_plugin_timer(&plugin->rpc_conn, expired); call_plugin_timer(plugin, expired);
} }
tal_free(plugin); tal_free(plugin);

19
plugins/libplugin.h
View File

@ -4,7 +4,9 @@
#include "config.h" #include "config.h"
#include <ccan/ccan/membuf/membuf.h> #include <ccan/ccan/membuf/membuf.h>
#include <ccan/strmap/strmap.h>
#include <ccan/time/time.h> #include <ccan/time/time.h>
#include <ccan/timer/timer.h>
#include <common/errcode.h> #include <common/errcode.h>
#include <common/json.h> #include <common/json.h>
#include <common/json_command.h> #include <common/json_command.h>
@ -55,6 +57,15 @@ struct plugin {
bool manifested; bool manifested;
/* Has init been received ? */ /* Has init been received ? */
bool initialized; bool initialized;
/* Map from json command names to usage strings: we don't put this inside
* struct json_command as it's good practice to have those const. */
STRMAP(const char *) usagemap;
/* Timers */
struct timers timers;
size_t in_timer;
bool deprecated_apis;
}; };
struct command { struct command {
@ -64,8 +75,6 @@ struct command {
struct plugin *plugin; struct plugin *plugin;
}; };
extern bool deprecated_apis;
/* Create an array of these, one for each command you support. */ /* Create an array of these, one for each command you support. */
struct plugin_command { struct plugin_command {
const char *name; const char *name;
@ -191,16 +200,16 @@ struct command_result *forward_result(struct command *cmd,
/* Callback for timer where we expect a 'command_result'. All timers /* Callback for timer where we expect a 'command_result'. All timers
* must return this eventually, though they may do so via a convoluted * must return this eventually, though they may do so via a convoluted
* send_req() path. */ * send_req() path. */
struct command_result *timer_complete(void); struct command_result *timer_complete(struct plugin *p);
/* Access timer infrastructure to add a timer. /* Access timer infrastructure to add a timer.
* *
* Freeing this releases the timer, otherwise it's freed after @cb * Freeing this releases the timer, otherwise it's freed after @cb
* if it hasn't been freed already. * if it hasn't been freed already.
*/ */
struct plugin_timer *plugin_timer(struct rpc_conn *rpc, struct plugin_timer *plugin_timer(struct plugin *p,
struct timerel t, struct timerel t,
struct command_result *(*cb)(void)); struct command_result *(*cb)(struct plugin *p));
/* Log something */ /* Log something */
void plugin_log(enum log_level l, const char *fmt, ...) PRINTF_FMT(2, 3); void plugin_log(enum log_level l, const char *fmt, ...) PRINTF_FMT(2, 3);

Write Preview
Loading…
Cancel
Save