[thirdparty/util-linux.git] / sys-utils / blkdiscard.c

/*
 * blkdiscard.c -- discard the part (or whole) of the block device.
 *
 * Copyright (C) 2012 Red Hat, Inc. All rights reserved.
 * Written by Lukas Czerner <lczerner@redhat.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * This program uses BLKDISCARD ioctl to discard part or the whole block
 * device if the device supports it. You can specify range (start and
 * length) to be discarded, or simply discard the whole device.
 */


#include <string.h>
#include <unistd.h>
#include <stdlib.h>
#include <stdio.h>
#include <stdint.h>
#include <fcntl.h>
#include <limits.h>
#include <getopt.h>
#include <time.h>

#include <sys/ioctl.h>
#include <sys/stat.h>
#include <sys/time.h>
#include <linux/fs.h>

#include "nls.h"
#include "strutils.h"
#include "c.h"
#include "closestream.h"
#include "monotonic.h"

#ifndef BLKDISCARD
# define BLKDISCARD	_IO(0x12,119)
#endif

#ifndef BLKSECDISCARD
# define BLKSECDISCARD	_IO(0x12,125)
#endif

#ifndef BLKZEROOUT
# define BLKZEROOUT	_IO(0x12,127)
#endif

enum {
	ACT_DISCARD = 0,	/* default */
	ACT_ZEROOUT,
	ACT_SECURE
};

static void print_stats(int act, char *path, uint64_t stats[])
{
	switch (act) {
	case ACT_ZEROOUT:
		printf(_("%s: Zero-filled %" PRIu64 " bytes from the offset %" PRIu64"\n"), \
			path, stats[1], stats[0]);
		break;
	case ACT_SECURE:
	case ACT_DISCARD:
		printf(_("%s: Discarded %" PRIu64 " bytes from the offset %" PRIu64"\n"), \
			path, stats[1], stats[0]);
		break;
	}
}

static void __attribute__((__noreturn__)) usage(void)
{
	FILE *out = stdout;
	fputs(USAGE_HEADER, out);
	fprintf(out,
	      _(" %s [options] <device>\n"), program_invocation_short_name);

	fputs(USAGE_SEPARATOR, out);
	fputs(_("Discard the content of sectors on a device.\n"), out);

	fputs(USAGE_OPTIONS, out);
	fputs(_(" -o, --offset <num>  offset in bytes to discard from\n"), out);
	fputs(_(" -l, --length <num>  length of bytes to discard from the offset\n"), out);
	fputs(_(" -p, --step <num>    size of the discard iterations within the offset\n"), out);
	fputs(_(" -s, --secure        perform secure discard\n"), out);
	fputs(_(" -z, --zeroout       zero-fill rather than discard\n"), out);
	fputs(_(" -v, --verbose       print aligned length and offset\n"), out);

	fputs(USAGE_SEPARATOR, out);
	printf(USAGE_HELP_OPTIONS(21));

	printf(USAGE_MAN_TAIL("blkdiscard(8)"));
	exit(EXIT_SUCCESS);
}


int main(int argc, char **argv)
{
	char *path;
	int c, fd, verbose = 0, secsize;
	uint64_t end, blksize, step, range[2], stats[2];
	struct stat sb;
	struct timeval now, last;
	int act = ACT_DISCARD;

	static const struct option longopts[] = {
	    { "help",      no_argument,       NULL, 'h' },
	    { "version",   no_argument,       NULL, 'V' },
	    { "offset",    required_argument, NULL, 'o' },
	    { "length",    required_argument, NULL, 'l' },
	    { "step",      required_argument, NULL, 'p' },
	    { "secure",    no_argument,       NULL, 's' },
	    { "verbose",   no_argument,       NULL, 'v' },
	    { "zeroout",   no_argument,       NULL, 'z' },
	    { NULL, 0, NULL, 0 }
	};

	setlocale(LC_ALL, "");
	bindtextdomain(PACKAGE, LOCALEDIR);
	textdomain(PACKAGE);
	atexit(close_stdout);

	range[0] = 0;
	range[1] = ULLONG_MAX;
	step = 0;

	while ((c = getopt_long(argc, argv, "hVsvo:l:p:z", longopts, NULL)) != -1) {
		switch(c) {
		case 'h':
			usage();
			break;
		case 'V':
			printf(UTIL_LINUX_VERSION);
			return EXIT_SUCCESS;
		case 'l':
			range[1] = strtosize_or_err(optarg,
					_("failed to parse length"));
			break;
		case 'o':
			range[0] = strtosize_or_err(optarg,
					_("failed to parse offset"));
			break;
		case 'p':
			step = strtosize_or_err(optarg,
					_("failed to parse step"));
			break;
		case 's':
			act = ACT_SECURE;
			break;
		case 'v':
			verbose = 1;
			break;
		case 'z':
			act = ACT_ZEROOUT;
			break;
		default:
			errtryhelp(EXIT_FAILURE);
		}
	}

	if (optind == argc)
		errx(EXIT_FAILURE, _("no device specified"));

	path = argv[optind++];

	if (optind != argc) {
		warnx(_("unexpected number of arguments"));
		errtryhelp(EXIT_FAILURE);
	}

	fd = open(path, O_WRONLY);
	if (fd < 0)
		err(EXIT_FAILURE, _("cannot open %s"), path);

	if (fstat(fd, &sb) == -1)
		err(EXIT_FAILURE, _("stat of %s failed"), path);
	if (!S_ISBLK(sb.st_mode))
		errx(EXIT_FAILURE, _("%s: not a block device"), path);

	if (ioctl(fd, BLKGETSIZE64, &blksize))
		err(EXIT_FAILURE, _("%s: BLKGETSIZE64 ioctl failed"), path);
	if (ioctl(fd, BLKSSZGET, &secsize))
		err(EXIT_FAILURE, _("%s: BLKSSZGET ioctl failed"), path);

	/* check offset alignment to the sector size */
	if (range[0] % secsize)
		errx(EXIT_FAILURE, _("%s: offset %" PRIu64 " is not aligned "
			 "to sector size %i"), path, range[0], secsize);

	/* is the range end behind the end of the device ?*/
	if (range[0] > blksize)
		errx(EXIT_FAILURE, _("%s: offset is greater than device size"), path);
	end = range[0] + range[1];
	if (end < range[0] || end > blksize)
		end = blksize;

	range[1] = (step > 0) ? step : end - range[0];

	/* check length alignment to the sector size */
	if (range[1] % secsize)
		errx(EXIT_FAILURE, _("%s: length %" PRIu64 " is not aligned "
			 "to sector size %i"), path, range[1], secsize);

	stats[0] = range[0], stats[1] = 0;
	gettime_monotonic(&last);

	for (/* nothing */; range[0] < end; range[0] += range[1]) {
		if (range[0] + range[1] > end)
			range[1] = end - range[0];

		switch (act) {
		case ACT_ZEROOUT:
			if (ioctl(fd, BLKZEROOUT, &range))
				 err(EXIT_FAILURE, _("%s: BLKZEROOUT ioctl failed"), path);
			break;
		case ACT_SECURE:
			if (ioctl(fd, BLKSECDISCARD, &range))
				err(EXIT_FAILURE, _("%s: BLKSECDISCARD ioctl failed"), path);
			break;
		case ACT_DISCARD:
			if (ioctl(fd, BLKDISCARD, &range))
				err(EXIT_FAILURE, _("%s: BLKDISCARD ioctl failed"), path);
			break;
		}

		stats[1] += range[1];

		/* reporting progress at most once per second */
		if (verbose && step) {
			gettime_monotonic(&now);
			if (now.tv_sec > last.tv_sec &&
			    (now.tv_usec >= last.tv_usec || now.tv_sec > last.tv_sec + 1)) {
				print_stats(act, path, stats);
				stats[0] += stats[1], stats[1] = 0;
				last = now;
			}
		}
	}

	if (verbose && stats[1])
		print_stats(act, path, stats);

	close(fd);
	return EXIT_SUCCESS;
}
Commit	Line	Data
d964b669 LC	1	/*
	2	* blkdiscard.c -- discard the part (or whole) of the block device.
	3	*
	4	* Copyright (C) 2012 Red Hat, Inc. All rights reserved.
	5	* Written by Lukas Czerner <lczerner@redhat.com>
	6	*
	7	* This program is free software: you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation, either version 2 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	19	*
	20	* This program uses BLKDISCARD ioctl to discard part or the whole block
	21	* device if the device supports it. You can specify range (start and
	22	* length) to be discarded, or simply discard the whole device.
	23	*/
	24
	25
	26	#include <string.h>
	27	#include <unistd.h>
	28	#include <stdlib.h>
	29	#include <stdio.h>
	30	#include <stdint.h>
	31	#include <fcntl.h>
	32	#include <limits.h>
	33	#include <getopt.h>
4f55368c	34	#include <time.h>
d964b669 LC	35
	36	#include <sys/ioctl.h>
	37	#include <sys/stat.h>
4f55368c	38	#include <sys/time.h>
d964b669 LC	39	#include <linux/fs.h>
	40
	41	#include "nls.h"
	42	#include "strutils.h"
	43	#include "c.h"
	44	#include "closestream.h"
784467ad	45	#include "monotonic.h"
d964b669 LC	46
d964b669 LC	47	#ifndef BLKDISCARD
7154cc89	48	# define BLKDISCARD _IO(0x12,119)
d964b669 LC	49	#endif
	50
	51	#ifndef BLKSECDISCARD
7154cc89	52	# define BLKSECDISCARD _IO(0x12,125)
d964b669 LC	53	#endif
d964b669 LC	54
7154cc89 KZ	55	#ifndef BLKZEROOUT
	56	# define BLKZEROOUT _IO(0x12,127)
	57	#endif
	58
	59	enum {
	60	ACT_DISCARD = 0, /* default */
	61	ACT_ZEROOUT,
	62	ACT_SECURE
	63	};
	64
	65	static void print_stats(int act, char *path, uint64_t stats[])
	66	{
	67	switch (act) {
	68	case ACT_ZEROOUT:
	69	printf(_("%s: Zero-filled %" PRIu64 " bytes from the offset %" PRIu64"\n"), \
	70	path, stats[1], stats[0]);
	71	break;
	72	case ACT_SECURE:
	73	case ACT_DISCARD:
	74	printf(_("%s: Discarded %" PRIu64 " bytes from the offset %" PRIu64"\n"), \
	75	path, stats[1], stats[0]);
	76	break;
	77	}
	78	}
c472a7e3	79
6e1eda6f	80	static void __attribute__((__noreturn__)) usage(void)
d964b669	81	{
6e1eda6f	82	FILE *out = stdout;
d964b669 LC	83	fputs(USAGE_HEADER, out);
	84	fprintf(out,
	85	_(" %s [options] <device>\n"), program_invocation_short_name);
451dbcfa BS	86
	87	fputs(USAGE_SEPARATOR, out);
	88	fputs(_("Discard the content of sectors on a device.\n"), out);
	89
d964b669	90	fputs(USAGE_OPTIONS, out);
b31fd516 BS	91	fputs(_(" -o, --offset <num> offset in bytes to discard from\n"), out);
	92	fputs(_(" -l, --length <num> length of bytes to discard from the offset\n"), out);
	93	fputs(_(" -p, --step <num> size of the discard iterations within the offset\n"), out);
	94	fputs(_(" -s, --secure perform secure discard\n"), out);
	95	fputs(_(" -z, --zeroout zero-fill rather than discard\n"), out);
	96	fputs(_(" -v, --verbose print aligned length and offset\n"), out);
	97
d964b669	98	fputs(USAGE_SEPARATOR, out);
f45f3ec3	99	printf(USAGE_HELP_OPTIONS(21));
b31fd516	100
f45f3ec3	101	printf(USAGE_MAN_TAIL("blkdiscard(8)"));
6e1eda6f	102	exit(EXIT_SUCCESS);
d964b669 LC	103	}
d964b669 LC	104
7154cc89	105
d964b669 LC	106	int main(int argc, char **argv)
	107	{
	108	char *path;
7154cc89	109	int c, fd, verbose = 0, secsize;
c472a7e3	110	uint64_t end, blksize, step, range[2], stats[2];
d964b669	111	struct stat sb;
700031ad	112	struct timeval now, last;
7154cc89	113	int act = ACT_DISCARD;
d964b669 LC	114
d964b669 LC	115	static const struct option longopts[] = {
87918040 SK	116	{ "help", no_argument, NULL, 'h' },
	117	{ "version", no_argument, NULL, 'V' },
	118	{ "offset", required_argument, NULL, 'o' },
	119	{ "length", required_argument, NULL, 'l' },
	120	{ "step", required_argument, NULL, 'p' },
	121	{ "secure", no_argument, NULL, 's' },
	122	{ "verbose", no_argument, NULL, 'v' },
	123	{ "zeroout", no_argument, NULL, 'z' },
	124	{ NULL, 0, NULL, 0 }
d964b669 LC	125	};
	126
	127	setlocale(LC_ALL, "");
	128	bindtextdomain(PACKAGE, LOCALEDIR);
	129	textdomain(PACKAGE);
	130	atexit(close_stdout);
	131
	132	range[0] = 0;
	133	range[1] = ULLONG_MAX;
c472a7e3	134	step = 0;
d964b669	135
7154cc89	136	while ((c = getopt_long(argc, argv, "hVsvo:l:p:z", longopts, NULL)) != -1) {
d964b669 LC	137	switch(c) {
d964b669 LC	138	case 'h':
6e1eda6f	139	usage();
d964b669 LC	140	break;
	141	case 'V':
	142	printf(UTIL_LINUX_VERSION);
	143	return EXIT_SUCCESS;
	144	case 'l':
	145	range[1] = strtosize_or_err(optarg,
	146	_("failed to parse length"));
	147	break;
	148	case 'o':
	149	range[0] = strtosize_or_err(optarg,
	150	_("failed to parse offset"));
	151	break;
c472a7e3 FS	152	case 'p':
	153	step = strtosize_or_err(optarg,
	154	_("failed to parse step"));
	155	break;
d964b669	156	case 's':
7154cc89	157	act = ACT_SECURE;
d964b669 LC	158	break;
	159	case 'v':
	160	verbose = 1;
	161	break;
7154cc89 KZ	162	case 'z':
	163	act = ACT_ZEROOUT;
	164	break;
d964b669	165	default:
677ec86c	166	errtryhelp(EXIT_FAILURE);
d964b669 LC	167	}
	168	}
	169
	170	if (optind == argc)
4ce393f4	171	errx(EXIT_FAILURE, _("no device specified"));
d964b669 LC	172
	173	path = argv[optind++];
	174
	175	if (optind != argc) {
	176	warnx(_("unexpected number of arguments"));
6e1eda6f	177	errtryhelp(EXIT_FAILURE);
d964b669 LC	178	}
d964b669 LC	179
d964b669 LC	180	fd = open(path, O_WRONLY);
	181	if (fd < 0)
	182	err(EXIT_FAILURE, _("cannot open %s"), path);
	183
77751922	184	if (fstat(fd, &sb) == -1)
fc14ceba	185	err(EXIT_FAILURE, _("stat of %s failed"), path);
77751922 KZ	186	if (!S_ISBLK(sb.st_mode))
	187	errx(EXIT_FAILURE, _("%s: not a block device"), path);
	188
d964b669 LC	189	if (ioctl(fd, BLKGETSIZE64, &blksize))
d964b669 LC	190	err(EXIT_FAILURE, _("%s: BLKGETSIZE64 ioctl failed"), path);
d964b669 LC	191	if (ioctl(fd, BLKSSZGET, &secsize))
	192	err(EXIT_FAILURE, _("%s: BLKSSZGET ioctl failed"), path);
	193
d7ce9acb FS	194	/* check offset alignment to the sector size */
	195	if (range[0] % secsize)
	196	errx(EXIT_FAILURE, _("%s: offset %" PRIu64 " is not aligned "
	197	"to sector size %i"), path, range[0], secsize);
d964b669 LC	198
d964b669 LC	199	/* is the range end behind the end of the device ?*/
303884a4	200	if (range[0] > blksize)
0c75b6a4	201	errx(EXIT_FAILURE, _("%s: offset is greater than device size"), path);
d964b669 LC	202	end = range[0] + range[1];
d964b669 LC	203	if (end < range[0] \|\| end > blksize)
c472a7e3 FS	204	end = blksize;
	205
	206	range[1] = (step > 0) ? step : end - range[0];
d964b669	207
d7ce9acb FS	208	/* check length alignment to the sector size */
	209	if (range[1] % secsize)
	210	errx(EXIT_FAILURE, _("%s: length %" PRIu64 " is not aligned "
	211	"to sector size %i"), path, range[1], secsize);
	212
c472a7e3	213	stats[0] = range[0], stats[1] = 0;
700031ad	214	gettime_monotonic(&last);
c472a7e3	215
ee24ab6f	216	for (/* nothing */; range[0] < end; range[0] += range[1]) {
c472a7e3 FS	217	if (range[0] + range[1] > end)
	218	range[1] = end - range[0];
	219
7154cc89 KZ	220	switch (act) {
	221	case ACT_ZEROOUT:
	222	if (ioctl(fd, BLKZEROOUT, &range))
	223	err(EXIT_FAILURE, _("%s: BLKZEROOUT ioctl failed"), path);
	224	break;
	225	case ACT_SECURE:
c472a7e3 FS	226	if (ioctl(fd, BLKSECDISCARD, &range))
c472a7e3 FS	227	err(EXIT_FAILURE, _("%s: BLKSECDISCARD ioctl failed"), path);
7154cc89 KZ	228	break;
7154cc89 KZ	229	case ACT_DISCARD:
c472a7e3 FS	230	if (ioctl(fd, BLKDISCARD, &range))
c472a7e3 FS	231	err(EXIT_FAILURE, _("%s: BLKDISCARD ioctl failed"), path);
7154cc89	232	break;
c472a7e3 FS	233	}
c472a7e3 FS	234
a3e91e26 RM	235	stats[1] += range[1];
a3e91e26 RM	236
0e765365	237	/* reporting progress at most once per second */
c472a7e3	238	if (verbose && step) {
700031ad	239	gettime_monotonic(&now);
0e765365 RM	240	if (now.tv_sec > last.tv_sec &&
0e765365 RM	241	(now.tv_usec >= last.tv_usec \|\| now.tv_sec > last.tv_sec + 1)) {
7154cc89	242	print_stats(act, path, stats);
a3e91e26	243	stats[0] += stats[1], stats[1] = 0;
c472a7e3 FS	244	last = now;
	245	}
	246	}
d964b669 LC	247	}
d964b669 LC	248
eeae4488	249	if (verbose && stats[1])
7154cc89	250	print_stats(act, path, stats);
d964b669 LC	251
	252	close(fd);
	253	return EXIT_SUCCESS;
	254	}