xref: /dragonfly/sbin/hammer/hammer.c (revision d50f9ae3)

/*
 * Copyright (c) 2007 The DragonFly Project.  All rights reserved.
 *
 * This code is derived from software contributed to The DragonFly Project
 * by Matthew Dillon <dillon@backplane.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of The DragonFly Project nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific, prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#include "hammer.h"

#include <fstab.h>

static __inline void hammer_parse_blkdevs(const char *blkdevs, int oflags);
static void __hammer_parse_blkdevs(const char *blkdevs, int oflags,
		int verify_volume, int verify_count);
static void sigalrm(int signo);
static void sigintr(int signo);
static void usage(int exit_code) __dead2;

int RecurseOpt;
int VerboseOpt;
int QuietOpt;
int TwoWayPipeOpt;
int TimeoutOpt;
int DelayOpt = 5;
char *SshPort;
int ForceYesOpt;
int CompressOpt;
int ForceOpt;
int RunningIoctl;
int DidInterrupt;
int BulkOpt;
int AllPFS;
uint64_t BandwidthOpt;
uint64_t SplitupOpt = 4ULL * 1024ULL * 1024ULL * 1024ULL;
uint64_t MemoryLimit = 1024LLU * 1024 * 1024;
const char *SplitupOptStr;
const char *CyclePath;

int
main(int ac, char **av)
{
	char *blkdevs = NULL;
	char *ptr;
	char *restrictcmd = NULL;
	int ch;

	while ((ch = getopt(ac, av,
			    "b:c:de:hf:i:m:p:qrt:v2yABC:FR:S:T:X")) != -1) {
		switch(ch) {
		case '2':
			TwoWayPipeOpt = 1;
			break;
		case 'y':
			ForceYesOpt = 1;
			break;
		case 'b':
			BandwidthOpt = strtoull(optarg, &ptr, 0);
			switch(*ptr) {
			case 'g':
			case 'G':
				BandwidthOpt *= 1024;
				/* fall through */
			case 'm':
			case 'M':
				BandwidthOpt *= 1024;
				/* fall through */
			case 'k':
			case 'K':
				BandwidthOpt *= 1024;
				break;
			case '\0':
				/* bytes per second if no suffix */
				break;
			default:
				usage(1);
				/* not reached */
			}
			break;
		case 'S':
			SplitupOptStr = strdup(optarg);
			SplitupOpt = strtoull(optarg, &ptr, 0);
			switch(*ptr) {
			case 'g':
			case 'G':
				SplitupOpt *= 1024;
				/* fall through */
			case 'm':
			case 'M':
				SplitupOpt *= 1024;
				/* fall through */
			case 'k':
			case 'K':
				SplitupOpt *= 1024;
				break;
			case '\0':
				/* bytes per second if no suffix */
				break;
			default:
				usage(1);
				/* not reached */
			}
			break;
		case 'c':
			CyclePath = optarg;
			break;
		case 'd':
			++DebugOpt;
			break;
		case 'e':
			ScoreBoardFile = optarg;
			break;
		case 'h':
			usage(0);
			/* not reached */
		case 'i':
			DelayOpt = strtol(optarg, NULL, 0);
			break;
		case 'm':
			MemoryLimit = strtouq(optarg, &ptr, 0);
			switch(*ptr) {
			case 't':
			case 'T':
				MemoryLimit *= 1024;
				/* fall through */
			case 'g':
			case 'G':
				MemoryLimit *= 1024;
				/* fall through */
			case 'm':
			case 'M':
				MemoryLimit *= 1024;
				/* fall through */
			case 'k':
			case 'K':
				MemoryLimit *= 1024;
				/* fall through */
			default:
				break;
			}

			/* minimum limit */
			if (MemoryLimit < 1024 * 1024)
				MemoryLimit = 1024 * 1024;
			break;
		case 'p':
			SshPort = optarg;
			break;
		case 'r':
			RecurseOpt = 1;
			break;
		case 'f':
			blkdevs = optarg;
			break;
		case 't':
			TimeoutOpt = strtol(optarg, NULL, 0);
			break;
		case 'v':
			if (QuietOpt > 0)
				--QuietOpt;
			else
				++VerboseOpt;
			break;
		case 'q':
			if (VerboseOpt > 0)
				--VerboseOpt;
			else
				++QuietOpt;
			break;
		case 'A':
			AllPFS = 1;
			break;
		case 'B':
			BulkOpt = 1;
			break;
		case 'C':
			if (hammer_parse_cache_size(optarg) == -1) {
				usage(1);
				/* not reached */
			}
			break;
		case 'F':
			ForceOpt = 1;
			break;
		case 'R':
			if (restrictcmd == NULL)
				restrictcmd = optarg;
			break;
		case 'T':
			if (RestrictTarget == NULL)
				RestrictTarget = optarg;
			break;
		case 'X':
			CompressOpt = 1;
			break;
		default:
			usage(1);
			/* not reached */
		}
	}
	ac -= optind;
	av += optind;
	if (ac < 1) {
		usage(1);
		/* not reached */
	}

	signal(SIGALRM, sigalrm);
	signal(SIGINT, sigintr);

	/*
	 * Check command restriction (used by hammer ssh-remote).  Several
	 * commands may be iterated with a comma.
	 */
	if (restrictcmd) {
		char *elm, *dup;

		dup = ptr = strdup(restrictcmd);
		while ((elm = strsep(&ptr, ",")) != NULL) {
			if (strcmp(av[0], elm) == 0)
				break;
		}
		if (elm == NULL) {
			errx(1, "hammer-remote: request does not match "
				"restricted command");
			/* not reached */
		}
		free(dup);
	}

	/*
	 * Lookup the filesystem type
	 */
	if (hammer_uuid_name_lookup(&Hammer_FSType, HAMMER_FSTYPE_STRING)) {
		errx(1, "uuids file does not have the DragonFly "
			"HAMMER filesystem type");
		/* not reached */
	}

	/*
	 * Parse commands
	 */
	if (strcmp(av[0], "synctid") == 0) {
		hammer_cmd_synctid(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "namekey2") == 0) {
		int64_t key;
		int32_t crcx;
		int len;
		const char *aname = av[1];

		if (aname == NULL) {
			usage(1);
			/* not reached */
		}
		len = strlen(aname);
		key = (uint32_t)crc32(aname, len) & 0xFFFFFFFEU;

		switch(len) {
		default:
			crcx = crc32(aname + 3, len - 5);
			crcx = crcx ^ (crcx >> 6) ^ (crcx >> 12);
			key |= (int64_t)(crcx & 0x3F) << 42;
			/* fall through */
		case 5:
		case 4:
			/* fall through */
		case 3:
			key |= ((int64_t)(aname[2] & 0x1F) << 48);
			/* fall through */
		case 2:
			key |= ((int64_t)(aname[1] & 0x1F) << 53) |
			       ((int64_t)(aname[len-2] & 0x1F) << 37);
			/* fall through */
		case 1:
			key |= ((int64_t)(aname[0] & 0x1F) << 58) |
			       ((int64_t)(aname[len-1] & 0x1F) << 32);
			/* fall through */
		case 0:
			break;
		}
		if (key == 0)
			key |= 0x100000000LL;
		printf("0x%016jx\n", (uintmax_t)key);
		exit(0);
	}
	if (strcmp(av[0], "namekey1") == 0) {
		int64_t key;

		if (av[1] == NULL) {
			usage(1);
			/* not reached */
		}
		key = (int64_t)(crc32(av[1], strlen(av[1])) & 0x7FFFFFFF) << 32;
		if (key == 0)
			key |= 0x100000000LL;
		printf("0x%016jx\n", (uintmax_t)key);
		exit(0);
	}
	if (strcmp(av[0], "namekey32") == 0) {
		int32_t key;

		if (av[1] == NULL) {
			usage(1);
			/* not reached */
		}
		key = crc32(av[1], strlen(av[1])) & 0x7FFFFFFF;
		if (key == 0)
			++key;
		printf("0x%08x\n", key);
		exit(0);
	}
	if (strcmp(av[0], "pfs-status") == 0) {
		hammer_cmd_pseudofs_status(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "pfs-master") == 0) {
		hammer_cmd_pseudofs_create(av + 1, ac - 1, 0);
		exit(0);
	}
	if (strcmp(av[0], "pfs-slave") == 0) {
		hammer_cmd_pseudofs_create(av + 1, ac - 1, 1);
		exit(0);
	}
	if (strcmp(av[0], "pfs-update") == 0) {
		hammer_cmd_pseudofs_update(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "pfs-upgrade") == 0) {
		hammer_cmd_pseudofs_upgrade(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "pfs-downgrade") == 0) {
		hammer_cmd_pseudofs_downgrade(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "pfs-destroy") == 0) {
		hammer_cmd_pseudofs_destroy(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "prune") == 0) {
		hammer_cmd_softprune(av + 1, ac - 1, 0);
		exit(0);
	}
	if (strcmp(av[0], "prune-everything") == 0) {
		hammer_cmd_softprune(av + 1, ac - 1, 1);
		exit(0);
	}
	if (strcmp(av[0], "config") == 0) {
		hammer_cmd_config(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "viconfig") == 0) {
		hammer_cmd_viconfig(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "cleanup") == 0) {
		hammer_cmd_cleanup(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "abort-cleanup") == 0) {
		hammer_cmd_abort_cleanup(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "info") == 0) {
		hammer_cmd_info(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "ssh-remote") == 0) {
		if (ac != 3) {
			usage(1);
			/* not reached */
		}
		hammer_cmd_sshremote(av[1], av[2]);
		exit(0);
	}
	if (strcmp(av[0], "snap") == 0) {
		hammer_cmd_snap(av + 1, ac - 1, 0, 1);
		exit(0);
	}
	if (strcmp(av[0], "snaplo") == 0) {
		hammer_cmd_snap(av + 1, ac - 1, 0, 0);
		exit(0);
	}
	if (strcmp(av[0], "snapq") == 0) {
		hammer_cmd_snap(av + 1, ac - 1, 1, 0);
		exit(0);
	}
	if (strcmp(av[0], "snapls") == 0) {
		hammer_cmd_snapls(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "snaprm") == 0) {
		hammer_cmd_snaprm(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "snapshot") == 0) {
		hammer_cmd_snapshot(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "bstats") == 0) {
		hammer_cmd_bstats(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "iostats") == 0) {
		hammer_cmd_iostats(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "stats") == 0) {
		hammer_cmd_stats(av + 1, ac - 1);
		exit(0);
	}

	if (strncmp(av[0], "history", 7) == 0) {
		hammer_cmd_history(av[0] + 7, av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "rebalance") == 0) {
		signal(SIGINT, sigalrm);
		hammer_cmd_rebalance(av + 1, ac - 1);
		exit(0);
	}
	if (strncmp(av[0], "reblock", 7) == 0) {
		signal(SIGINT, sigalrm);
		if (strcmp(av[0], "reblock") == 0)
			hammer_cmd_reblock(av + 1, ac - 1, HAMMER_IOC_DO_FLAGS);
		else if (strcmp(av[0], "reblock-btree") == 0)
			hammer_cmd_reblock(av + 1, ac - 1, HAMMER_IOC_DO_BTREE);
		else if (strcmp(av[0], "reblock-inodes") == 0)
			hammer_cmd_reblock(av + 1, ac - 1, HAMMER_IOC_DO_INODES);
		else if (strcmp(av[0], "reblock-dirs") == 0)
			hammer_cmd_reblock(av + 1, ac - 1, HAMMER_IOC_DO_DIRS);
		else if (strcmp(av[0], "reblock-data") == 0)
			hammer_cmd_reblock(av + 1, ac - 1, HAMMER_IOC_DO_DATA);
		else {
			usage(1);
			/* not reached */
		}
		exit(0);
	}
	if (strncmp(av[0], "mirror", 6) == 0) {
		if (strcmp(av[0], "mirror-read") == 0)
			hammer_cmd_mirror_read(av + 1, ac - 1, 0);
		else if (strcmp(av[0], "mirror-read-stream") == 0)
			hammer_cmd_mirror_read(av + 1, ac - 1, 1);
		else if (strcmp(av[0], "mirror-write") == 0)
			hammer_cmd_mirror_write(av + 1, ac - 1);
		else if (strcmp(av[0], "mirror-copy") == 0)
			hammer_cmd_mirror_copy(av + 1, ac - 1, 0);
		else if (strcmp(av[0], "mirror-stream") == 0)
			hammer_cmd_mirror_copy(av + 1, ac - 1, 1);
		else if (strcmp(av[0], "mirror-dump") == 0)
			hammer_cmd_mirror_dump(av + 1, ac - 1);
		else {
			usage(1);
			/* not reached */
		}
		exit(0);
	}
	if (strcmp(av[0], "dedup-simulate") == 0) {
		hammer_cmd_dedup_simulate(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "dedup") == 0) {
		hammer_cmd_dedup(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "version") == 0) {
		hammer_cmd_get_version(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "version-upgrade") == 0) {
		hammer_cmd_set_version(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "volume-add") == 0) {
		hammer_cmd_volume_add(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "volume-del") == 0) {
		hammer_cmd_volume_del(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "volume-list") == 0) {
		hammer_cmd_volume_list(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "volume-blkdevs") == 0) {
		hammer_cmd_volume_blkdevs(av + 1, ac - 1);
		exit(0);
	}

	if (strcmp(av[0], "show") == 0) {
		const char *arg = NULL;
		char *p, *dup;
		int filter = -1;
		int obfuscate = 0;
		int indent = 0;

		hammer_parse_blkdevs(blkdevs, O_RDONLY);
		if (ac > 3) {
			errx(1, "Too many options specified");
			/* not reached */
		}
		if (ac > 1)
			arg = av[1];
		if (ac > 2) {
			dup = ptr = strdup(av[2]);
			while ((p = strsep(&ptr, ",")) != NULL) {
				if (strcmp(p, "filter") == 0)
					filter = 1;
				else if (strcmp(p, "nofilter") == 0)
					filter = 0;
				else if (strcmp(p, "obfuscate") == 0)
					obfuscate = 1;
				else if (strcmp(p, "indent") == 0)
					indent = 1;
			}
			free(dup);
		}
		hammer_cmd_show(arg, filter, obfuscate, indent);
		exit(0);
	}
	if (strcmp(av[0], "show-undo") == 0) {
		hammer_parse_blkdevs(blkdevs, O_RDONLY);
		hammer_cmd_show_undo();
		exit(0);
	}
	if (strcmp(av[0], "recover") == 0) {
		__hammer_parse_blkdevs(blkdevs, O_RDONLY, 0, 1);
		hammer_cmd_recover(av + 1, ac - 1);
		exit(0);
	}
	if (strcmp(av[0], "blockmap") == 0) {
		hammer_parse_blkdevs(blkdevs, O_RDONLY);
		hammer_cmd_blockmap();
		exit(0);
	}
	if (strcmp(av[0], "checkmap") == 0) {
		hammer_parse_blkdevs(blkdevs, O_RDONLY);
		hammer_cmd_checkmap();
		exit(0);
	}
	if (strcmp(av[0], "strip") == 0) {
		__hammer_parse_blkdevs(blkdevs, O_RDWR, 0, 0);
		hammer_cmd_strip();
		exit(0);
	}

	usage(1);
	/* not reached */
	return(0);
}

/*
 * Parse the device specification.
 *
 * Multi-volume hammer devices are colon-separated.  Each element
 * may be further expanded via /etc/devtab.  One may also specify
 * a single element which is expanded into multiple elements via
 * /etc/devtab.
 */
static
void
__hammer_parse_blkdevs(const char *blkdevs, int oflags, int verify_volume,
	int verify_count)
{
	volume_info_t volume = NULL;
	char *copy;
	char *volname;
	int vol_count = 0;

	if (blkdevs == NULL) {
		errx(1, "A -f blkdevs specification is required "
			"for this command");
		/* not reached */
	}

	copy = strdup(blkdevs);
	while ((volname = copy) != NULL) {
		if ((copy = strchr(copy, ':')) != NULL)
			*copy++ = 0;
		volname = getdevpath(volname, 0);
		if (strchr(volname, ':')) {
			__hammer_parse_blkdevs(volname, oflags, verify_volume,
				verify_count);
		} else {
			volume = load_volume(volname, oflags, verify_volume);
			assert(volume);
			++vol_count;
		}
		free(volname);
	}
	free(copy);

	assert(volume);
	if (verify_count) {
		if (vol_count != volume->ondisk->vol_count) {
			errx(1, "Volume header says %d volumes, but %d specified.",
				volume->ondisk->vol_count, vol_count);
			/* not reached */
		}
		if (get_root_volume() == NULL) {
			errx(1, "No root volume found");
			/* not reached */
		}
	}
}

static __inline
void
hammer_parse_blkdevs(const char *blkdevs, int oflags)
{
	__hammer_parse_blkdevs(blkdevs, oflags, 1, 1);
}

static
void
sigalrm(int signo __unused)
{
	/* do nothing (interrupts HAMMER ioctl) */
}

static
void
sigintr(int signo __unused)
{
	if (RunningIoctl == 0)
		_exit(1);
	DidInterrupt = 1;
	/* do nothing (interrupts HAMMER ioctl) */
}

static
void
usage(int exit_code)
{
	fprintf(stderr,
		"hammer -h\n"
		"hammer [-2ABFqrvXy] [-b bandwidth] [-C cachesize[:readahead]] \n"
		"       [-R restrictcmd] [-T restrictpath] [-c cyclefile]\n"
		"       [-e scoreboardfile] [-f blkdevs] [-i delay] [-p ssh-port]\n"
		"       [-S splitsize] [-t seconds] [-m memlimit] command [argument ...]\n"
		"hammer synctid <filesystem> [quick]\n"
		"hammer bstats [interval]\n"
		"hammer iostats [interval]\n"
		"hammer stats [interval]\n"
		"hammer history[@offset[,len]] <file> ...\n"
		"hammer namekey1 <path>\n"
		"hammer namekey2 <path>\n"
		"hammer namekey32 <path>\n"
		"hammer cleanup [<filesystem> ...]\n"
		"hammer abort-cleanup\n"
		"hammer info [<dirpath> ...]\n"
		"hammer snapshot [<filesystem>] <snapshot-dir>\n"
		"hammer snapshot <filesystem> <snapshot-dir> [<note>]\n"
		"hammer prune <softlink-dir>\n"
		"hammer prune-everything <filesystem>\n"
		"hammer rebalance <filesystem> [saturation_percentage]\n"
		"hammer reblock[-btree|-inodes|-dirs|-data] "
			"<filesystem> [fill_percentage]\n"
		"hammer pfs-status <dirpath> ...\n"
		"hammer pfs-master <dirpath> [options]\n"
		"hammer pfs-slave <dirpath> [options]\n"
		"hammer pfs-update <dirpath> [options]\n"
		"hammer pfs-upgrade <dirpath>\n"
		"hammer pfs-downgrade <dirpath>\n"
		"hammer pfs-destroy <dirpath>\n"
		"hammer mirror-read <filesystem> [begin-tid]\n"
		"hammer mirror-read-stream <filesystem> [begin-tid]\n"
		"hammer mirror-write <filesystem>\n"
		"hammer mirror-dump [header]\n"
		"hammer mirror-copy [[user@]host:]<filesystem>"
				  " [[user@]host:]<filesystem>\n"
		"hammer mirror-stream [[user@]host:]<filesystem>"
				    " [[user@]host:]<filesystem>\n"
		"hammer ssh-remote command filesystem\n"
		"hammer version <filesystem>\n"
		"hammer version-upgrade <filesystem> <version> [force]\n"
		"hammer volume-add <device> <filesystem>\n"
		"hammer volume-del <device> <filesystem>\n"
		"hammer volume-list <filesystem>\n"
		"hammer volume-blkdevs <filesystem>\n"
	);

	fprintf(stderr, "\nHAMMER utility version 3+ commands:\n");

	fprintf(stderr,
		"hammer config [<filesystem> [<configfile>]]\n"
		"hammer viconfig [<filesystem>]\n"
		"hammer snap <path> [<note>]\n"
		"hammer snaplo <path> [<note>]\n"
		"hammer snapq <dir> [<note>]\n"
		"hammer snaprm <path> ...\n"
		"hammer snaprm <transid> ...\n"
		"hammer snaprm <filesystem> <transid> ...\n"
		"hammer snapls [<path> ...]\n"
	);

	fprintf(stderr, "\nHAMMER utility version 4+ commands:\n");

	fprintf(stderr,
		"hammer -f blkdevs blockmap\n"
		"hammer -f blkdevs checkmap\n"
		"hammer -f blkdevs [-qqq] show [lo:objid]\n"
		"hammer -f blkdevs show-undo\n"
		"hammer -f blkdevs recover <target_dir> [full|quick]\n"
		"hammer -f blkdevs strip\n"
	);

	fprintf(stderr, "\nHAMMER utility version 5+ commands:\n");

	fprintf(stderr,
		"hammer dedup-simulate <filesystem>\n"
		"hammer dedup <filesystem>\n"
	);

	exit(exit_code);
}