[lvm2.git] / tools / lvrename.c

/*
 * Copyright (C) 2001-2004 Sistina Software, Inc. All rights reserved.
 * Copyright (C) 2004-2007 Red Hat, Inc. All rights reserved.
 *
 * This file is part of LVM2.
 *
 * This copyrighted material is made available to anyone wishing to use,
 * modify, copy, or redistribute it subject to the terms and conditions
 * of the GNU Lesser General Public License v.2.1.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

#include "tools.h"

struct lvrename_params {
	int historical;
	const char *lv_name_old;
	const char *lv_name_new;
};

/*
 * Dummy LV to represent historical LV.
 */
static struct logical_volume _historical_lv = {
        .name = "",
        .major = -1,
        .minor = -1,
        .snapshot_segs = DM_LIST_HEAD_INIT(_historical_lv.snapshot_segs),
        .segments = DM_LIST_HEAD_INIT(_historical_lv.segments),
        .tags = DM_LIST_HEAD_INIT(_historical_lv.tags),
        .segs_using_this_lv = DM_LIST_HEAD_INIT(_historical_lv.segs_using_this_lv),
        .indirect_glvs = DM_LIST_HEAD_INIT(_historical_lv.indirect_glvs),
        .hostname = "",
};

static int _lvrename_single(struct cmd_context *cmd, const char *vg_name,
			    struct volume_group *vg, struct processing_handle *handle)
{
	struct lvrename_params *lp = (struct lvrename_params *) handle->custom_handle;
	struct generic_logical_volume *glv;
	struct logical_volume *lv;
	int ret = ECMD_FAILED;

	if (!lp->historical) {
		if (!(lv = find_lv(vg, lp->lv_name_old))) {
			log_error("Existing logical volume \"%s\" not found in "
				  "volume group \"%s\"", lp->lv_name_old, vg_name);
			goto bad;
		}

		if (lv_is_raid_image(lv) || lv_is_raid_metadata(lv)) {
			log_error("Cannot rename a RAID %s directly",
				  lv_is_raid_image(lv) ? "image" :
				  "metadata area");
			goto bad;
		}

		if (lv_is_raid_with_tracking(lv)) {
			log_error("Cannot rename %s while it is tracking a split image",
				  lv->name);
			goto bad;
		}
	} else {
		if (!(glv = find_historical_glv(vg, lp->lv_name_old, 0, NULL))) {
			log_error("Existing historical logical volume \"%s\" not found in "
				  "volume group \"%s\"", lp->lv_name_old, vg_name);
			goto bad;
		}

		_historical_lv.vg = vg;
		_historical_lv.name = lp->lv_name_old;
		_historical_lv.this_glv = glv;
		lv = &_historical_lv;
	}

	/*
	 * The lvmlockd LV lock is only acquired here to ensure the LV is not
	 * active on another host.  This requests a transient LV lock.
	 * If the LV is active, a persistent LV lock already exists in
	 * lvmlockd, and the transient lock request does nothing.
	 * If the LV is not active, then no LV lock exists and the transient
	 * lock request acquires the LV lock (or fails).  The transient lock
	 * is automatically released when the command exits.
	 */
	if (!lockd_lv(cmd, lv, "ex", 0))
		goto_bad;

	if (!lv_rename(cmd, lv, lp->lv_name_new))
		goto_bad;

	log_print_unless_silent("Renamed \"%s%s\" to \"%s%s\" in volume group \"%s\"",
				lp->historical ? HISTORICAL_LV_PREFIX : "", lp->lv_name_old,
				lp->historical ? HISTORICAL_LV_PREFIX : "", lp->lv_name_new,
				vg_name);

	ret = ECMD_PROCESSED;
bad:
	return ret;
}

/*
 * lvrename command implementation.
 * Check arguments and call lv_rename() to execute the request.
 */
int lvrename(struct cmd_context *cmd, int argc, char **argv)
{
	struct processing_handle *handle = NULL;
	struct lvrename_params lp = { 0 };
	size_t maxlen;
	char *lv_name_old, *lv_name_new;
	const char *vg_name, *vg_name_new, *vg_name_old;
	int historical = 0;
	char *st;
	int ret;

	cmd->include_historical_lvs = 1;

	if (argc == 3) {
		vg_name = skip_dev_dir(cmd, argv[0], NULL);
		lv_name_old = argv[1];
		lv_name_new = argv[2];
		if (strchr(lv_name_old, '/') &&
		    (vg_name_old = extract_vgname(cmd, lv_name_old)) &&
		    strcmp(vg_name_old, vg_name)) {
			log_error("Please use a single volume group name "
				  "(\"%s\" or \"%s\")", vg_name, vg_name_old);
			return EINVALID_CMD_LINE;
		}
	} else if (argc == 2) {
		lv_name_old = argv[0];
		lv_name_new = argv[1];
		vg_name = extract_vgname(cmd, lv_name_old);
	} else {
		log_error("Old and new logical volume names required");
		return EINVALID_CMD_LINE;
	}

	if (!validate_name(vg_name)) {
		log_error("Please provide a valid volume group name");
		return EINVALID_CMD_LINE;
	}

	if (strchr(lv_name_new, '/') &&
	    (vg_name_new = extract_vgname(cmd, lv_name_new)) &&
	    strcmp(vg_name, vg_name_new)) {
		log_error("Logical volume names must "
			  "have the same volume group (\"%s\" or \"%s\")",
			  vg_name, vg_name_new);
		return EINVALID_CMD_LINE;
	}

	if ((st = strrchr(lv_name_old, '/')))
		lv_name_old = st + 1;

	if ((st = strrchr(lv_name_new, '/')))
		lv_name_new = st + 1;

	if (!strncmp(lv_name_old, HISTORICAL_LV_PREFIX, strlen(HISTORICAL_LV_PREFIX))) {
		lv_name_old = lv_name_old + strlen(HISTORICAL_LV_PREFIX);
		historical = 1;
	}

	if (!strncmp(lv_name_new, HISTORICAL_LV_PREFIX, strlen(HISTORICAL_LV_PREFIX))) {
		if (historical)
			lv_name_new = lv_name_old + strlen(HISTORICAL_LV_PREFIX);
		else {
			log_error("Old name references live LV while "
				  "new name is for historical LV.");
			return EINVALID_CMD_LINE;
		}
	}

	/* Check sanity of new name */
	maxlen = NAME_LEN - strlen(vg_name) - 3;
	if (strlen(lv_name_new) > maxlen) {
		log_error("New logical volume name \"%s\" may not exceed %"
			  PRIsize_t " characters.", lv_name_new, maxlen);
		return EINVALID_CMD_LINE;
	}

	if (!*lv_name_new) {
		log_error("New logical volume name may not be blank");
		return EINVALID_CMD_LINE;
	}

	if (!apply_lvname_restrictions(lv_name_new)) {
		stack;
		return EINVALID_CMD_LINE;
	}

	if (!validate_name(lv_name_new)) {
		log_error("New logical volume name \"%s\" is invalid",
			  lv_name_new);
		return EINVALID_CMD_LINE;
	}

	if (!strcmp(lv_name_old, lv_name_new)) {
		log_error("Old and new logical volume names must differ");
		return EINVALID_CMD_LINE;
	}

	lp.historical = historical;

	if (!(lp.lv_name_old = dm_pool_strdup(cmd->mem, lv_name_old)))
		return ECMD_FAILED;

	if (!(lp.lv_name_new = dm_pool_strdup(cmd->mem, lv_name_new)))
		return ECMD_FAILED;

	if (!(handle = init_processing_handle(cmd, NULL))) {
		log_error("Failed to initialize processing handle.");
		return ECMD_FAILED;
	}

	handle->custom_handle = &lp;

	ret = process_each_vg(cmd, 0, NULL, vg_name, NULL, READ_FOR_UPDATE, 0, handle,
			      _lvrename_single);

	destroy_processing_handle(cmd, handle);

	return ret;
}
Commit	Line	Data
d9bc7ffe	1	/*
67cdbd7e	2	* Copyright (C) 2001-2004 Sistina Software, Inc. All rights reserved.
be684599	3	* Copyright (C) 2004-2007 Red Hat, Inc. All rights reserved.
d9bc7ffe	4	*
6606c3ae	5	* This file is part of LVM2.
d9bc7ffe	6	*
6606c3ae AK	7	* This copyrighted material is made available to anyone wishing to use,
6606c3ae AK	8	* modify, copy, or redistribute it subject to the terms and conditions
be684599	9	* of the GNU Lesser General Public License v.2.1.
d9bc7ffe	10	*
be684599	11	* You should have received a copy of the GNU Lesser General Public License
6606c3ae	12	* along with this program; if not, write to the Free Software Foundation,
fcbef05a	13	* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
d9bc7ffe AK	14	*/
	15
	16	#include "tools.h"
	17
5bbbd37f	18	struct lvrename_params {
27245d97	19	int historical;
5bbbd37f DT	20	const char *lv_name_old;
	21	const char *lv_name_new;
	22	};
	23
27245d97 PR	24	/*
	25	* Dummy LV to represent historical LV.
	26	*/
	27	static struct logical_volume _historical_lv = {
	28	.name = "",
	29	.major = -1,
	30	.minor = -1,
	31	.snapshot_segs = DM_LIST_HEAD_INIT(_historical_lv.snapshot_segs),
	32	.segments = DM_LIST_HEAD_INIT(_historical_lv.segments),
	33	.tags = DM_LIST_HEAD_INIT(_historical_lv.tags),
	34	.segs_using_this_lv = DM_LIST_HEAD_INIT(_historical_lv.segs_using_this_lv),
	35	.indirect_glvs = DM_LIST_HEAD_INIT(_historical_lv.indirect_glvs),
	36	.hostname = "",
	37	};
	38
5bbbd37f DT	39	static int _lvrename_single(struct cmd_context cmd, const char vg_name,
	40	struct volume_group vg, struct processing_handle handle)
	41	{
	42	struct lvrename_params lp = (struct lvrename_params ) handle->custom_handle;
27245d97 PR	43	struct generic_logical_volume *glv;
27245d97 PR	44	struct logical_volume *lv;
5bbbd37f DT	45	int ret = ECMD_FAILED;
5bbbd37f DT	46
27245d97 PR	47	if (!lp->historical) {
	48	if (!(lv = find_lv(vg, lp->lv_name_old))) {
	49	log_error("Existing logical volume \"%s\" not found in "
	50	"volume group \"%s\"", lp->lv_name_old, vg_name);
	51	goto bad;
	52	}
5bbbd37f	53
27245d97 PR	54	if (lv_is_raid_image(lv) \|\| lv_is_raid_metadata(lv)) {
	55	log_error("Cannot rename a RAID %s directly",
	56	lv_is_raid_image(lv) ? "image" :
	57	"metadata area");
	58	goto bad;
	59	}
	60
	61	if (lv_is_raid_with_tracking(lv)) {
	62	log_error("Cannot rename %s while it is tracking a split image",
	63	lv->name);
	64	goto bad;
	65	}
	66	} else {
	67	if (!(glv = find_historical_glv(vg, lp->lv_name_old, 0, NULL))) {
	68	log_error("Existing historical logical volume \"%s\" not found in "
	69	"volume group \"%s\"", lp->lv_name_old, vg_name);
	70	goto bad;
	71	}
5bbbd37f	72
27245d97 PR	73	_historical_lv.vg = vg;
	74	_historical_lv.name = lp->lv_name_old;
	75	_historical_lv.this_glv = glv;
	76	lv = &_historical_lv;
5bbbd37f DT	77	}
5bbbd37f DT	78
bdba4e7a DT	79	/*
	80	* The lvmlockd LV lock is only acquired here to ensure the LV is not
	81	* active on another host. This requests a transient LV lock.
	82	* If the LV is active, a persistent LV lock already exists in
	83	* lvmlockd, and the transient lock request does nothing.
	84	* If the LV is not active, then no LV lock exists and the transient
	85	* lock request acquires the LV lock (or fails). The transient lock
	86	* is automatically released when the command exits.
	87	*/
27245d97	88	if (!lockd_lv(cmd, lv, "ex", 0))
bdba4e7a DT	89	goto_bad;
bdba4e7a DT	90
27245d97	91	if (!lv_rename(cmd, lv, lp->lv_name_new))
5bbbd37f DT	92	goto_bad;
5bbbd37f DT	93
27245d97 PR	94	log_print_unless_silent("Renamed \"%s%s\" to \"%s%s\" in volume group \"%s\"",
	95	lp->historical ? HISTORICAL_LV_PREFIX : "", lp->lv_name_old,
	96	lp->historical ? HISTORICAL_LV_PREFIX : "", lp->lv_name_new,
	97	vg_name);
5bbbd37f DT	98
	99	ret = ECMD_PROCESSED;
	100	bad:
	101	return ret;
	102	}
	103
b7cd307f DW	104	/*
	105	* lvrename command implementation.
	106	* Check arguments and call lv_rename() to execute the request.
	107	*/
60274aba	108	int lvrename(struct cmd_context cmd, int argc, char *argv)
d9bc7ffe	109	{
5bbbd37f DT	110	struct processing_handle *handle = NULL;
5bbbd37f DT	111	struct lvrename_params lp = { 0 };
8ef2b021	112	size_t maxlen;
d9bc7ffe	113	char lv_name_old, lv_name_new;
8ef2b021	114	const char vg_name, vg_name_new, *vg_name_old;
27245d97	115	int historical = 0;
d9bc7ffe	116	char *st;
9b92cb27	117	int ret;
d9bc7ffe	118
27245d97 PR	119	cmd->include_historical_lvs = 1;
27245d97 PR	120
faaedea2	121	if (argc == 3) {
9397354a	122	vg_name = skip_dev_dir(cmd, argv[0], NULL);
faaedea2 AK	123	lv_name_old = argv[1];
	124	lv_name_new = argv[2];
	125	if (strchr(lv_name_old, '/') &&
	126	(vg_name_old = extract_vgname(cmd, lv_name_old)) &&
	127	strcmp(vg_name_old, vg_name)) {
	128	log_error("Please use a single volume group name "
	129	"(\"%s\" or \"%s\")", vg_name, vg_name_old);
	130	return EINVALID_CMD_LINE;
	131	}
	132	} else if (argc == 2) {
	133	lv_name_old = argv[0];
	134	lv_name_new = argv[1];
	135	vg_name = extract_vgname(cmd, lv_name_old);
	136	} else {
	137	log_error("Old and new logical volume names required");
d9bc7ffe AK	138	return EINVALID_CMD_LINE;
	139	}
	140
7e4867f7	141	if (!validate_name(vg_name)) {
faaedea2	142	log_error("Please provide a valid volume group name");
d9bc7ffe AK	143	return EINVALID_CMD_LINE;
	144	}
	145
	146	if (strchr(lv_name_new, '/') &&
25b73380	147	(vg_name_new = extract_vgname(cmd, lv_name_new)) &&
d9bc7ffe AK	148	strcmp(vg_name, vg_name_new)) {
d9bc7ffe AK	149	log_error("Logical volume names must "
08907484	150	"have the same volume group (\"%s\" or \"%s\")",
d9bc7ffe AK	151	vg_name, vg_name_new);
	152	return EINVALID_CMD_LINE;
	153	}
	154
	155	if ((st = strrchr(lv_name_old, '/')))
	156	lv_name_old = st + 1;
	157
	158	if ((st = strrchr(lv_name_new, '/')))
	159	lv_name_new = st + 1;
	160
27245d97 PR	161	if (!strncmp(lv_name_old, HISTORICAL_LV_PREFIX, strlen(HISTORICAL_LV_PREFIX))) {
	162	lv_name_old = lv_name_old + strlen(HISTORICAL_LV_PREFIX);
	163	historical = 1;
	164	}
	165
	166	if (!strncmp(lv_name_new, HISTORICAL_LV_PREFIX, strlen(HISTORICAL_LV_PREFIX))) {
	167	if (historical)
	168	lv_name_new = lv_name_old + strlen(HISTORICAL_LV_PREFIX);
	169	else {
	170	log_error("Old name references live LV while "
	171	"new name is for historical LV.");
	172	return EINVALID_CMD_LINE;
	173	}
	174	}
	175
d9bc7ffe	176	/* Check sanity of new name */
d3e4934a	177	maxlen = NAME_LEN - strlen(vg_name) - 3;
d9bc7ffe	178	if (strlen(lv_name_new) > maxlen) {
d3e4934a ZK	179	log_error("New logical volume name \"%s\" may not exceed %"
d3e4934a ZK	180	PRIsize_t " characters.", lv_name_new, maxlen);
28e4bf0b	181	return EINVALID_CMD_LINE;
d9bc7ffe AK	182	}
	183
	184	if (!*lv_name_new) {
	185	log_error("New logical volume name may not be blank");
28e4bf0b	186	return EINVALID_CMD_LINE;
d9bc7ffe AK	187	}
d9bc7ffe AK	188
28e4bf0b ZK	189	if (!apply_lvname_restrictions(lv_name_new)) {
	190	stack;
	191	return EINVALID_CMD_LINE;
	192	}
5a52dca9	193
7e4867f7	194	if (!validate_name(lv_name_new)) {
8387b473	195	log_error("New logical volume name \"%s\" is invalid",
47419d21	196	lv_name_new);
d9bc7ffe AK	197	return EINVALID_CMD_LINE;
	198	}
	199
	200	if (!strcmp(lv_name_old, lv_name_new)) {
	201	log_error("Old and new logical volume names must differ");
	202	return EINVALID_CMD_LINE;
	203	}
	204
27245d97 PR	205	lp.historical = historical;
27245d97 PR	206
5bbbd37f DT	207	if (!(lp.lv_name_old = dm_pool_strdup(cmd->mem, lv_name_old)))
5bbbd37f DT	208	return ECMD_FAILED;
fe70b03d	209
5bbbd37f DT	210	if (!(lp.lv_name_new = dm_pool_strdup(cmd->mem, lv_name_new)))
5bbbd37f DT	211	return ECMD_FAILED;
f53c6aa6	212
f752a953	213	if (!(handle = init_processing_handle(cmd, NULL))) {
5bbbd37f DT	214	log_error("Failed to initialize processing handle.");
5bbbd37f DT	215	return ECMD_FAILED;
d9bc7ffe AK	216	}
d9bc7ffe AK	217
5bbbd37f	218	handle->custom_handle = &lp;
a927e401	219
8cfc3854	220	ret = process_each_vg(cmd, 0, NULL, vg_name, NULL, READ_FOR_UPDATE, 0, handle,
5bbbd37f	221	_lvrename_single);
a927e401	222
5bbbd37f	223	destroy_processing_handle(cmd, handle);
914c9723	224
9b92cb27	225	return ret;
d9bc7ffe	226	}