davide/palladum-lightning
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

plugins/libplugin.c: Allow freeing notification struct command *.

Browse Source 
We always allocate a new `struct command` when we get a full JSON
object from stdin:

b2df01dc73/plugins/libplugin.c (L1229-L1233)

If it happens to be a notification, we pass the `struct command` to
the handler, and not free it ourselves:

b2df01dc73/plugins/libplugin.c (L1270-L1275)

There are only nine points in `plugins/libplugin.c` where we `tal_free`
anything, and only one of them frees a `struct command`:

b2df01dc73/plugins/libplugin.c (L224-L234)

The above function `command_complete` is not appropriate for
notification handlers; the above function sends out a response
to our stdout, which a notification handler should not do.

However, as-is, it does mean that notification handling leaks
`struct command` objects, which can be problematic if we ever
have future built-in plugins which are significantly more
dependent on notifications.

This commit changes notification handlers to return
`struct command_result *`, because possibly in the future
notification handlers may want to perform `send_outreq`, so we
might as well use our standard convention for callbacks, and
to encourage future developers to check how to properly
terminate notification handlers (and free up the
`struct command`).

We also now provide a `notification_handled` function which a
notification handler must eventually call, as well as a
`notification_handler_pending` which is just a snowclone of
`command_still_pending`.
This commit is contained in:
ZmnSCPxj jxPCSnmZ
2021-10-01 07:59:40 +08:00
committed by Rusty Russell
parent e393791d4b
commit d4690358d9
5 changed files with 46 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
plugins/funder.c
View File

@@ -708,9 +708,9 @@ json_rbf_channel_call(struct command *cmd,
return send_outreq(cmd->plugin, req);
}
static void json_disconnect(struct command *cmd,
const char *buf,
const jsmntok_t *params)
static struct command_result *json_disconnect(struct command *cmd,
const char *buf,
const jsmntok_t *params)
{
struct node_id id;
const char *err;
@@ -730,11 +730,13 @@ static void json_disconnect(struct command *cmd,
type_to_string(tmpctx, struct node_id, &id));
cleanup_peer_pending_opens(&id);
return notification_handled(cmd);
}
static void json_channel_open_failed(struct command *cmd,
const char *buf,
const jsmntok_t *params)
static struct command_result *json_channel_open_failed(struct command *cmd,
const char *buf,
const jsmntok_t *params)
{
struct channel_id cid;
struct pending_open *open;
@@ -758,6 +760,8 @@ static void json_channel_open_failed(struct command *cmd,
open = cleanup_channel_pending_open(&cid);
if (open)
unreserve_psbt(open);
return notification_handled(cmd);
}
static void json_add_policy(struct json_stream *stream,