9981e238a3
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: tools: `lightningd-downgrade` can downgrade your database from v25.12 to v25.09 if something goes wrong.
263 lines
11 KiB
C
263 lines
11 KiB
C
/* Tool for limited downgrade of an offline node */
|
|
#include "config.h"
|
|
#include <bitcoin/chainparams.h>
|
|
#include <ccan/array_size/array_size.h>
|
|
#include <ccan/err/err.h>
|
|
#include <ccan/opt/opt.h>
|
|
#include <ccan/tal/path/path.h>
|
|
#include <ccan/tal/str/str.h>
|
|
#include <common/configdir.h>
|
|
#include <common/utils.h>
|
|
#include <db/bindings.h>
|
|
#include <db/common.h>
|
|
#include <db/exec.h>
|
|
#include <db/utils.h>
|
|
#include <stdio.h>
|
|
#include <unistd.h>
|
|
#include <wallet/migrations.h>
|
|
|
|
#define ERROR_DBVERSION 1
|
|
#define ERROR_DBFAIL 2
|
|
#define ERROR_USAGE 3
|
|
#define ERROR_INTERNAL 99
|
|
|
|
#define PREV_VERSION stringify(CLN_PREV_VERSION)
|
|
|
|
struct db_version {
|
|
const char *name;
|
|
size_t db_height;
|
|
bool gossip_store_compatible;
|
|
};
|
|
|
|
static const struct db_version db_versions[] = {
|
|
{ "v25.09", 276, false },
|
|
/* When we implement v25.12 downgrade: { "v25.12", 280, ???}, */
|
|
};
|
|
|
|
static const struct db_version *version_db(const char *version)
|
|
{
|
|
for (size_t i = 0; i < ARRAY_SIZE(db_versions); i++) {
|
|
if (streq(db_versions[i].name, version))
|
|
return &db_versions[i];
|
|
}
|
|
errx(ERROR_INTERNAL, "Unknown version %s", version);
|
|
}
|
|
|
|
static void db_error(void *unused, bool fatal, const char *fmt, va_list ap)
|
|
{
|
|
vfprintf(stderr, fmt, ap);
|
|
fprintf(stderr, "\n");
|
|
if (fatal)
|
|
exit(ERROR_DBFAIL);
|
|
}
|
|
|
|
/* The standard opt_log_stderr_exit exits with status 1 */
|
|
static void opt_log_stderr_exit_usage(const char *fmt, ...)
|
|
{
|
|
va_list ap;
|
|
|
|
va_start(ap, fmt);
|
|
vfprintf(stderr, fmt, ap);
|
|
fprintf(stderr, "\n");
|
|
va_end(ap);
|
|
exit(ERROR_USAGE);
|
|
}
|
|
|
|
int main(int argc, char *argv[])
|
|
{
|
|
char *config_filename, *base_dir, *net_dir, *rpc_filename, *wallet_dsn = NULL;
|
|
size_t current, prev_version_height, num_migrations;
|
|
struct db *db;
|
|
const struct db_migration *migrations;
|
|
struct db_stmt *stmt;
|
|
|
|
setup_locale();
|
|
err_set_progname(argv[0]);
|
|
|
|
minimal_config_opts(tmpctx, argc, argv, &config_filename, &base_dir,
|
|
&net_dir, &rpc_filename);
|
|
opt_register_early_arg("--wallet", opt_set_talstr, NULL,
|
|
&wallet_dsn,
|
|
"Location of the wallet database.");
|
|
opt_register_noarg("--help|-h", opt_usage_and_exit,
|
|
"A tool to downgrade an offline Core Lightning Node to " PREV_VERSION,
|
|
"Print this message.");
|
|
opt_early_parse(argc, argv, opt_log_stderr_exit_usage);
|
|
opt_parse(&argc, argv, opt_log_stderr_exit_usage);
|
|
|
|
if (argc != 1)
|
|
opt_usage_exit_fail("No arguments expected");
|
|
|
|
if (!wallet_dsn)
|
|
wallet_dsn = tal_fmt(tmpctx, "sqlite3://%s/lightningd.sqlite3", net_dir);
|
|
|
|
if (path_is_file(path_join(tmpctx, base_dir,
|
|
tal_fmt(tmpctx, "lightningd-%s.pid",
|
|
chainparams->network_name)))) {
|
|
errx(ERROR_USAGE,
|
|
"Lightningd PID file exists, aborting: lightningd must not be running");
|
|
}
|
|
|
|
migrations = get_db_migrations(&num_migrations);
|
|
prev_version_height = version_db(PREV_VERSION)->db_height;
|
|
|
|
/* Open db, check it's the expected version */
|
|
db = db_open(tmpctx, wallet_dsn, false, false, db_error, NULL);
|
|
if (!db)
|
|
err(1, "Could not open database %s", wallet_dsn);
|
|
db->report_changes_fn = NULL;
|
|
|
|
db_begin_transaction(db);
|
|
db->data_version = db_data_version_get(db);
|
|
current = db_get_version(db);
|
|
|
|
if (current < prev_version_height)
|
|
errx(ERROR_DBVERSION, "Database version %zu already less than %zu expected for %s",
|
|
current, prev_version_height, PREV_VERSION);
|
|
if (current == prev_version_height) {
|
|
printf("Already compatible with %s\n", PREV_VERSION);
|
|
exit(0);
|
|
}
|
|
if (current >= num_migrations)
|
|
errx(ERROR_DBVERSION, "Unknown database version %zu: I only know up to %zu (%s)",
|
|
current, num_migrations, stringify(CLN_NEXT_VERSION));
|
|
|
|
/* current version is the last migration we did. */
|
|
while (current > prev_version_height) {
|
|
if (migrations[current].revertsql) {
|
|
stmt = db_prepare_v2(db, migrations[current].revertsql);
|
|
db_exec_prepared_v2(stmt);
|
|
tal_free(stmt);
|
|
}
|
|
if (migrations[current].revertfn) {
|
|
const char *error = migrations[current].revertfn(tmpctx, db);
|
|
if (error)
|
|
errx(ERROR_DBFAIL, "Downgrade failed: %s", error);
|
|
}
|
|
current--;
|
|
}
|
|
|
|
/* Finally update the version number in the version table */
|
|
stmt = db_prepare_v2(db, SQL("UPDATE version SET version=?;"));
|
|
db_bind_int(stmt, current);
|
|
db_exec_prepared_v2(stmt);
|
|
tal_free(stmt);
|
|
|
|
printf("Downgrade to %s succeeded. Committing.\n", PREV_VERSION);
|
|
db_commit_transaction(db);
|
|
tal_free(db);
|
|
|
|
if (!version_db(PREV_VERSION)->gossip_store_compatible) {
|
|
printf("Deleting incompatible gossip_store\n");
|
|
unlink(path_join(tmpctx, net_dir, "gossip_store"));
|
|
}
|
|
}
|
|
|
|
/*** We don't actually perform migrations, so these are stubs which abort. ***/
|
|
/* Remake with `make update-mocks` or `make update-mocks/tools/lightning-downgrade.c` */
|
|
|
|
/* AUTOGENERATED MOCKS START */
|
|
/* Generated stub for fillin_missing_channel_blockheights */
|
|
void fillin_missing_channel_blockheights(struct lightningd *ld UNNEEDED,
|
|
struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "fillin_missing_channel_blockheights called!\n"); abort(); }
|
|
/* Generated stub for fillin_missing_channel_id */
|
|
void fillin_missing_channel_id(struct lightningd *ld UNNEEDED, struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "fillin_missing_channel_id called!\n"); abort(); }
|
|
/* Generated stub for fillin_missing_lease_satoshi */
|
|
void fillin_missing_lease_satoshi(struct lightningd *ld UNNEEDED,
|
|
struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "fillin_missing_lease_satoshi called!\n"); abort(); }
|
|
/* Generated stub for fillin_missing_local_basepoints */
|
|
void fillin_missing_local_basepoints(struct lightningd *ld UNNEEDED,
|
|
struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "fillin_missing_local_basepoints called!\n"); abort(); }
|
|
/* Generated stub for fillin_missing_scriptpubkeys */
|
|
void fillin_missing_scriptpubkeys(struct lightningd *ld UNNEEDED, struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "fillin_missing_scriptpubkeys called!\n"); abort(); }
|
|
/* Generated stub for insert_addrtype_to_addresses */
|
|
void insert_addrtype_to_addresses(struct lightningd *ld UNNEEDED,
|
|
struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "insert_addrtype_to_addresses called!\n"); abort(); }
|
|
/* Generated stub for migrate_channels_scids_as_integers */
|
|
void migrate_channels_scids_as_integers(struct lightningd *ld UNNEEDED,
|
|
struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_channels_scids_as_integers called!\n"); abort(); }
|
|
/* Generated stub for migrate_convert_old_channel_keyidx */
|
|
void migrate_convert_old_channel_keyidx(struct lightningd *ld UNNEEDED,
|
|
struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_convert_old_channel_keyidx called!\n"); abort(); }
|
|
/* Generated stub for migrate_datastore_commando_runes */
|
|
void migrate_datastore_commando_runes(struct lightningd *ld UNNEEDED, struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_datastore_commando_runes called!\n"); abort(); }
|
|
/* Generated stub for migrate_fail_pending_payments_without_htlcs */
|
|
void migrate_fail_pending_payments_without_htlcs(struct lightningd *ld UNNEEDED,
|
|
struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_fail_pending_payments_without_htlcs called!\n"); abort(); }
|
|
/* Generated stub for migrate_fill_in_channel_type */
|
|
void migrate_fill_in_channel_type(struct lightningd *ld UNNEEDED,
|
|
struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_fill_in_channel_type called!\n"); abort(); }
|
|
/* Generated stub for migrate_forwards_add_rowid */
|
|
void migrate_forwards_add_rowid(struct lightningd *ld UNNEEDED,
|
|
struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_forwards_add_rowid called!\n"); abort(); }
|
|
/* Generated stub for migrate_from_account_db */
|
|
void migrate_from_account_db(struct lightningd *ld UNNEEDED, struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_from_account_db called!\n"); abort(); }
|
|
/* Generated stub for migrate_inflight_last_tx_to_psbt */
|
|
void migrate_inflight_last_tx_to_psbt(struct lightningd *ld UNNEEDED, struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_inflight_last_tx_to_psbt called!\n"); abort(); }
|
|
/* Generated stub for migrate_initialize_alias_local */
|
|
void migrate_initialize_alias_local(struct lightningd *ld UNNEEDED,
|
|
struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_initialize_alias_local called!\n"); abort(); }
|
|
/* Generated stub for migrate_initialize_channel_htlcs_wait_indexes_and_fixup_forwards */
|
|
void migrate_initialize_channel_htlcs_wait_indexes_and_fixup_forwards(struct lightningd *ld UNNEEDED,
|
|
struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_initialize_channel_htlcs_wait_indexes_and_fixup_forwards called!\n"); abort(); }
|
|
/* Generated stub for migrate_initialize_forwards_wait_indexes */
|
|
void migrate_initialize_forwards_wait_indexes(struct lightningd *ld UNNEEDED,
|
|
struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_initialize_forwards_wait_indexes called!\n"); abort(); }
|
|
/* Generated stub for migrate_initialize_invoice_wait_indexes */
|
|
void migrate_initialize_invoice_wait_indexes(struct lightningd *ld UNNEEDED,
|
|
struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_initialize_invoice_wait_indexes called!\n"); abort(); }
|
|
/* Generated stub for migrate_initialize_payment_wait_indexes */
|
|
void migrate_initialize_payment_wait_indexes(struct lightningd *ld UNNEEDED,
|
|
struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_initialize_payment_wait_indexes called!\n"); abort(); }
|
|
/* Generated stub for migrate_invalid_last_tx_psbts */
|
|
void migrate_invalid_last_tx_psbts(struct lightningd *ld UNNEEDED,
|
|
struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_invalid_last_tx_psbts called!\n"); abort(); }
|
|
/* Generated stub for migrate_invoice_created_index_var */
|
|
void migrate_invoice_created_index_var(struct lightningd *ld UNNEEDED,
|
|
struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_invoice_created_index_var called!\n"); abort(); }
|
|
/* Generated stub for migrate_last_tx_to_psbt */
|
|
void migrate_last_tx_to_psbt(struct lightningd *ld UNNEEDED, struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_last_tx_to_psbt called!\n"); abort(); }
|
|
/* Generated stub for migrate_normalize_invstr */
|
|
void migrate_normalize_invstr(struct lightningd *ld UNNEEDED,
|
|
struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_normalize_invstr called!\n"); abort(); }
|
|
/* Generated stub for migrate_our_funding */
|
|
void migrate_our_funding(struct lightningd *ld UNNEEDED, struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_our_funding called!\n"); abort(); }
|
|
/* Generated stub for migrate_payments_scids_as_integers */
|
|
void migrate_payments_scids_as_integers(struct lightningd *ld UNNEEDED,
|
|
struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_payments_scids_as_integers called!\n"); abort(); }
|
|
/* Generated stub for migrate_pr2342_feerate_per_channel */
|
|
void migrate_pr2342_feerate_per_channel(struct lightningd *ld UNNEEDED, struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_pr2342_feerate_per_channel called!\n"); abort(); }
|
|
/* Generated stub for migrate_remove_chain_moves_duplicates */
|
|
void migrate_remove_chain_moves_duplicates(struct lightningd *ld UNNEEDED, struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_remove_chain_moves_duplicates called!\n"); abort(); }
|
|
/* Generated stub for migrate_runes_idfix */
|
|
void migrate_runes_idfix(struct lightningd *ld UNNEEDED, struct db *db UNNEEDED)
|
|
{ fprintf(stderr, "migrate_runes_idfix called!\n"); abort(); }
|
|
/* AUTOGENERATED MOCKS END */
|