summaryrefslogtreecommitdiffstats
path: root/sys-utils/blkreport.c
blob: c8d0a63acef89f02357ab94cfc953270fce55757 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
/*
 * blkreport.c -- request a zone report on part (or all) of the block device.
 *
 * Copyright (C) 2015,2016 Seagate Technology PLC
 * Written by Shaun Tancheff <shaun.tancheff@seagate.com>
 *
 * Copyright (C) 2017 Karel Zak <kzak@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 BLKREPORT ioctl to query zone information about part of
 * or a whole block device, if the device supports it.
 * You can specify range (start and length) to be queried.
 */

#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 <linux/blkzoned.h>

#include "nls.h"
#include "strutils.h"
#include "xalloc.h"
#include "c.h"
#include "closestream.h"
#include "blkdev.h"

static const char *type_text[] = {
	"RESERVED",
	"CONVENTIONAL",
	"SEQ_WRITE_REQUIRED",
	"SEQ_WRITE_PREFERRED",
};

static const char *condition_str[] = {
	"cv", /* conventional zone */
	"e0", /* empty */
	"Oi", /* open implicit */
	"Oe", /* open explicit */
	"Cl", /* closed */
	"x5", "x6", "x7", "x8", "x9", "xA", "xB", /* xN: reserved */
	"ro", /* read only */
	"fu", /* full */
	"OL"  /* offline */
};

static void print_zones(const struct blk_zone *info, const uint32_t count)
{
	uint32_t iter;

	printf(_("Zones returned: %u\n"), count);

	for (iter = 0; iter < count; iter++) {
		const struct blk_zone *entry = &info[iter];
		unsigned int type = entry->type;
		uint64_t start = entry->start;
		uint64_t wp = entry->wp;
		uint8_t cond = entry->cond;
		uint64_t len = entry->len;

		if (!len)
			break;

		printf(_("  start: %9lx, len %6lx, wptr %6lx"
			 " reset:%u non-seq:%u, zcond:%2u(%s) [type: %u(%s)]\n"),
			start, len, wp - start,
			entry->reset, entry->non_seq,
			cond, condition_str[cond & ARRAY_SIZE(condition_str)],
			type, type_text[type]);
	}
}

static int do_report(const int fd, const uint64_t lba, uint32_t len, const int verbose)
{
	int rc;
	struct blk_zone_report *zi;

	zi = xmalloc(sizeof(struct blk_zone_report) + (len * sizeof(struct blk_zone)));
	zi->nr_zones = len;
	zi->sector = lba; /* maybe shift 4Kn -> 512e */
	rc = ioctl(fd, BLKREPORTZONE, zi);
	if (rc != -1) {
		if (verbose)
			printf(_("Found %d zones\n"), zi->nr_zones);
		print_zones(zi->zones, zi->nr_zones);
	}
	free(zi);

	return rc;
}

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

	fputs(USAGE_SEPARATOR, out);
	fputs(_("Report zone information about the given device.\n"), out);

	fputs(USAGE_OPTIONS, out);
	fputs(_(" -z, --zone <offset>    start sector of first zone (in 512-byte sectors)\n"), out);
	fputs(_(" -c, --count <number>   maximum number of zones in the report\n"), out);
	fputs(_(" -v, --verbose          display the number of reported zones"), out);
	fputs(USAGE_SEPARATOR, out);
	fputs(USAGE_HELP, out);
	fputs(USAGE_VERSION, out);

	fprintf(out, USAGE_MAN_TAIL("blkreport(8)"));
	exit(out == stderr ? EXIT_FAILURE : EXIT_SUCCESS);
}

#define DEF_REPORT_LEN		(1 << 12) /* 4k zones (256k kzalloc) */
#define MAX_REPORT_LEN		(1 << 16) /* 64k zones */

int main(int argc, char **argv)
{
	char *path;
	int c;
	int fd;
	int secsize;
	uint64_t blksectors = 0;
	struct stat sb;
	int verbose = 0;
	uint64_t offset = 0ul;
	uint32_t length = DEF_REPORT_LEN;
	static const struct option longopts[] = {
	    { "help",    no_argument,       NULL, 'h' },
	    { "version", no_argument,       NULL, 'V' },
	    { "zone",    required_argument, NULL, 'z' }, /* starting LBA */
	    { "count",   required_argument, NULL, 'c' }, /* max #of zones (entries) for result */
	    { "verbose", no_argument,       NULL, 'v' },
	    { NULL, 0, NULL, 0 }
	};

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

	while ((c = getopt_long(argc, argv, "hc:z:vV", longopts, NULL)) != -1) {
		switch (c) {
		case 'h':
			usage(stdout);
			break;
		case 'c':
			length = strtosize_or_err(optarg,
					_("failed to parse number of zones"));
			break;
		case 'z':
			offset = strtosize_or_err(optarg,
					_("failed to parse zone offset"));
			break;
		case 'v':
			verbose = 1;
			break;
		case 'V':
			printf(UTIL_LINUX_VERSION);
			return EXIT_SUCCESS;
		default:
			usage(stderr);
			break;
		}
	}

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

	path = argv[optind++];

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

	fd = open(path, O_RDONLY);
	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 (blkdev_get_sectors(fd, (unsigned long long *) &blksectors))
		err(EXIT_FAILURE, _("%s: blkdev_get_sectors ioctl failed"), path);
	if (blkdev_get_sector_size(fd, &secsize))
		err(EXIT_FAILURE, _("%s: BLKSSZGET ioctl failed"), path);

	if (offset > blksectors)
		errx(EXIT_FAILURE, _("%s: offset is greater than device size"), path);
	if (length < 1)
		length = 1;
	if (length > MAX_REPORT_LEN) {
		length = MAX_REPORT_LEN;
		warnx(_("limiting report to %u entries"), length);
	}

	if (do_report(fd, offset, length, verbose))
		 err(EXIT_FAILURE, _("%s: BLKREPORTZONE ioctl failed"), path);

	close(fd);
	return EXIT_SUCCESS;
}