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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
|
/*-
* Copyright (c) 2005 Ivan Voras <ivoras@freebsd.org>
*
* 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.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS 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 AUTHORS 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 <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#include <sys/param.h>
#include <errno.h>
#include <paths.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
#include <string.h>
#include <strings.h>
#include <fcntl.h>
#include <unistd.h>
#include <libgeom.h>
#include <err.h>
#include <assert.h>
#include <core/geom.h>
#include <misc/subr.h>
#include <geom/virstor/g_virstor_md.h>
#include <geom/virstor/g_virstor.h>
uint32_t lib_version = G_LIB_VERSION;
uint32_t version = G_VIRSTOR_VERSION;
static intmax_t chunk_size = 4 * 1024 * 1024; /* in kB (default: 4 MB) */
static intmax_t vir_size = 2ULL << 40; /* in MB (default: 2 TB) */
#if G_LIB_VERSION == 1
/* Support RELENG_6 */
#define G_TYPE_BOOL G_TYPE_NONE
#endif
/*
* virstor_main gets called by the geom(8) utility
*/
static void virstor_main(struct gctl_req *req, unsigned flags);
struct g_command class_commands[] = {
{"clear", G_FLAG_VERBOSE, virstor_main, G_NULL_OPTS, NULL,
"[-v] prov ..."
},
{"dump", 0, virstor_main, G_NULL_OPTS, NULL,
"prov ..."
},
{"label", G_FLAG_VERBOSE | G_FLAG_LOADKLD, virstor_main,
{
{'h', "hardcode", NULL, G_TYPE_BOOL},
{'m', "chunk_size", &chunk_size, G_TYPE_NUMBER},
{'s', "vir_size", &vir_size, G_TYPE_NUMBER},
G_OPT_SENTINEL
},
NULL, "[-h] [-v] [-m chunk_size] [-s vir_size] name provider0 [provider1 ...]"
},
{"destroy", G_FLAG_VERBOSE, NULL,
{
{'f', "force", NULL, G_TYPE_BOOL},
G_OPT_SENTINEL
},
NULL, "[-fv] name ..."
},
{"stop", G_FLAG_VERBOSE, NULL,
{
{'f', "force", NULL, G_TYPE_BOOL},
G_OPT_SENTINEL
},
NULL, "[-fv] name ... (alias for \"destroy\")"
},
{"add", G_FLAG_VERBOSE, NULL,
{
{'h', "hardcode", NULL, G_TYPE_BOOL},
G_OPT_SENTINEL
},
NULL, "[-vh] name prov [prov ...]"
},
{"remove", G_FLAG_VERBOSE, NULL, G_NULL_OPTS, NULL,
"[-v] name ..."
},
G_CMD_SENTINEL
};
static int verbose = 0;
/* Helper functions' declarations */
static void virstor_clear(struct gctl_req *req);
static void virstor_dump(struct gctl_req *req);
static void virstor_label(struct gctl_req *req);
/* Dispatcher function (no real work done here, only verbose flag recorder) */
static void
virstor_main(struct gctl_req *req, unsigned flags)
{
const char *name;
if ((flags & G_FLAG_VERBOSE) != 0)
verbose = 1;
name = gctl_get_ascii(req, "verb");
if (name == NULL) {
gctl_error(req, "No '%s' argument.", "verb");
return;
}
if (strcmp(name, "label") == 0)
virstor_label(req);
else if (strcmp(name, "clear") == 0)
virstor_clear(req);
else if (strcmp(name, "dump") == 0)
virstor_dump(req);
else
gctl_error(req, "%s: Unknown command: %s.", __func__, name);
/* No CTASSERT in userland
CTASSERT(VIRSTOR_MAP_BLOCK_ENTRIES*VIRSTOR_MAP_ENTRY_SIZE == MAXPHYS);
*/
}
static void
pathgen(const char *name, char *path, size_t size)
{
if (strncmp(name, _PATH_DEV, strlen(_PATH_DEV)) != 0)
snprintf(path, size, "%s%s", _PATH_DEV, name);
else
strlcpy(path, name, size);
}
static int
my_g_metadata_store(const char *name, u_char *md, size_t size)
{
char path[MAXPATHLEN];
unsigned sectorsize;
off_t mediasize;
u_char *sector;
int error, fd;
ssize_t abc;
pathgen(name, path, sizeof(path));
sector = NULL;
error = 0;
fd = open(path, O_RDWR);
if (fd == -1)
return (errno);
mediasize = g_get_mediasize(name);
if (mediasize == 0) {
error = errno;
goto out;
}
sectorsize = g_get_sectorsize(name);
if (sectorsize == 0) {
error = errno;
goto out;
}
assert(sectorsize >= size);
sector = malloc(sectorsize);
if (sector == NULL) {
error = ENOMEM;
goto out;
}
bcopy(md, sector, size);
if ((abc = pwrite(fd, sector, sectorsize, mediasize - sectorsize)) !=
(ssize_t)sectorsize) {
error = errno;
goto out;
}
out:
if (sector != NULL)
free(sector);
close(fd);
return (error);
}
/*
* Labels a new geom Meaning: parses and checks the parameters, calculates &
* writes metadata to the relevant providers so when the next round of
* "tasting" comes (which will be just after the provider(s) are closed) geom
* can be instantiated with the tasted metadata.
*/
static void
virstor_label(struct gctl_req *req)
{
struct g_virstor_metadata md;
off_t msize;
unsigned char *sect;
unsigned int i;
size_t ssize, secsize;
const char *name;
char param[32];
int hardcode, nargs, error;
struct virstor_map_entry *map;
size_t total_chunks; /* We'll run out of memory if
this needs to be bigger. */
unsigned int map_chunks; /* Chunks needed by the map (map size). */
size_t map_size; /* In bytes. */
ssize_t written;
int fd;
nargs = gctl_get_int(req, "nargs");
if (nargs < 2) {
gctl_error(req, "Too few arguments (%d): expecting: name "
"provider0 [provider1 ...]", nargs);
return;
}
hardcode = gctl_get_int(req, "hardcode");
/*
* Initialize constant parts of metadata: magic signature, version,
* name.
*/
bzero(&md, sizeof(md));
strlcpy(md.md_magic, G_VIRSTOR_MAGIC, sizeof(md.md_magic));
md.md_version = G_VIRSTOR_VERSION;
name = gctl_get_ascii(req, "arg0");
if (name == NULL) {
gctl_error(req, "No 'arg%u' argument.", 0);
return;
}
strlcpy(md.md_name, name, sizeof(md.md_name));
md.md_virsize = (off_t)gctl_get_intmax(req, "vir_size");
md.md_chunk_size = gctl_get_intmax(req, "chunk_size");
md.md_count = nargs - 1;
if (md.md_virsize == 0 || md.md_chunk_size == 0) {
gctl_error(req, "Virtual size and chunk size must be non-zero");
return;
}
if (md.md_chunk_size % MAXPHYS != 0) {
/* XXX: This is not strictly needed, but it's convenient to
* impose some limitations on it, so why not MAXPHYS. */
size_t new_size = (md.md_chunk_size / MAXPHYS) * MAXPHYS;
if (new_size < md.md_chunk_size)
new_size += MAXPHYS;
fprintf(stderr, "Resizing chunk size to be a multiple of "
"MAXPHYS (%d kB).\n", MAXPHYS / 1024);
fprintf(stderr, "New chunk size: %zu kB\n", new_size / 1024);
md.md_chunk_size = new_size;
}
if (md.md_virsize % md.md_chunk_size != 0) {
off_t chunk_count = md.md_virsize / md.md_chunk_size;
md.md_virsize = chunk_count * md.md_chunk_size;
fprintf(stderr, "Resizing virtual size to be a multiple of "
"chunk size.\n");
fprintf(stderr, "New virtual size: %zu MB\n",
(size_t)(md.md_virsize/(1024 * 1024)));
}
msize = secsize = ssize = 0;
for (i = 1; i < (unsigned)nargs; i++) {
snprintf(param, sizeof(param), "arg%u", i);
name = gctl_get_ascii(req, param);
ssize = g_get_sectorsize(name);
if (ssize == 0)
fprintf(stderr, "%s for %s\n", strerror(errno), name);
msize += g_get_mediasize(name);
if (secsize == 0)
secsize = ssize;
else if (secsize != ssize) {
gctl_error(req, "Devices need to have same sector size "
"(%u on %s needs to be %u).",
(u_int)ssize, name, (u_int)secsize);
return;
}
}
if (md.md_chunk_size % secsize != 0) {
fprintf(stderr, "Error: chunk size is not a multiple of sector "
"size.");
gctl_error(req, "Chunk size (in bytes) must be multiple of %u.",
(unsigned int)secsize);
return;
}
total_chunks = md.md_virsize / md.md_chunk_size;
map_size = total_chunks * sizeof(*map);
assert(md.md_virsize % md.md_chunk_size == 0);
ssize = map_size % secsize;
if (ssize != 0) {
size_t add_chunks = (secsize - ssize) / sizeof(*map);
total_chunks += add_chunks;
md.md_virsize = (off_t)total_chunks * (off_t)md.md_chunk_size;
map_size = total_chunks * sizeof(*map);
fprintf(stderr, "Resizing virtual size to fit virstor "
"structures.\n");
fprintf(stderr, "New virtual size: %ju MB (%zu new chunks)\n",
(uintmax_t)(md.md_virsize / (1024 * 1024)), add_chunks);
}
if (verbose)
printf("Total virtual chunks: %zu (%zu MB each), %ju MB total "
"virtual size.\n",
total_chunks, (size_t)(md.md_chunk_size / (1024 * 1024)),
md.md_virsize/(1024 * 1024));
if ((off_t)md.md_virsize < msize)
fprintf(stderr, "WARNING: Virtual storage size < Physical "
"available storage (%ju < %ju)\n", md.md_virsize, msize);
/* Clear last sector first to spoil all components if device exists. */
if (verbose)
printf("Clearing metadata on");
for (i = 1; i < (unsigned)nargs; i++) {
snprintf(param, sizeof(param), "arg%u", i);
name = gctl_get_ascii(req, param);
if (verbose)
printf(" %s", name);
msize = g_get_mediasize(name);
ssize = g_get_sectorsize(name);
if (msize == 0 || ssize == 0) {
gctl_error(req, "Can't retrieve information about "
"%s: %s.", name, strerror(errno));
return;
}
if (msize < MAX(md.md_chunk_size*4, map_size))
gctl_error(req, "Device %s is too small", name);
error = g_metadata_clear(name, NULL);
if (error != 0) {
gctl_error(req, "Can't clear metadata on %s: %s.", name,
strerror(error));
return;
}
}
/* Write allocation table to the first provider - this needs to be done
* before metadata is written because when kernel tastes it it's too
* late */
name = gctl_get_ascii(req, "arg1"); /* device with metadata */
if (verbose)
printf(".\nWriting allocation table to %s...", name);
/* How many chunks does the map occupy? */
map_chunks = map_size/md.md_chunk_size;
if (map_size % md.md_chunk_size != 0)
map_chunks++;
if (verbose) {
printf(" (%zu MB, %d chunks) ", map_size/(1024*1024), map_chunks);
fflush(stdout);
}
if (strncmp(name, _PATH_DEV, strlen(_PATH_DEV)) == 0)
fd = open(name, O_RDWR);
else {
sprintf(param, "%s%s", _PATH_DEV, name);
fd = open(param, O_RDWR);
}
if (fd < 0)
gctl_error(req, "Cannot open provider %s to write map", name);
/* Do it with calloc because there might be a need to set up chunk flags
* in the future */
map = calloc(total_chunks, sizeof(*map));
if (map == NULL) {
gctl_error(req,
"Out of memory (need %zu bytes for allocation map)",
map_size);
}
written = pwrite(fd, map, map_size, 0);
free(map);
if ((size_t)written != map_size) {
if (verbose) {
fprintf(stderr, "\nTried to write %zu, written %zd (%s)\n",
map_size, written, strerror(errno));
}
gctl_error(req, "Error writing out allocation map!");
return;
}
close (fd);
if (verbose)
printf("\nStoring metadata on ");
/*
* ID is randomly generated, unique for a geom. This is used to
* recognize all providers belonging to one geom.
*/
md.md_id = arc4random();
/* Ok, store metadata. */
for (i = 1; i < (unsigned)nargs; i++) {
snprintf(param, sizeof(param), "arg%u", i);
name = gctl_get_ascii(req, param);
msize = g_get_mediasize(name);
ssize = g_get_sectorsize(name);
if (verbose)
printf("%s ", name);
/* this provider's position/type in geom */
md.no = i - 1;
/* this provider's size */
md.provsize = msize;
/* chunk allocation info */
md.chunk_count = md.provsize / md.md_chunk_size;
if (verbose)
printf("(%u chunks) ", md.chunk_count);
/* Check to make sure last sector is unused */
if ((off_t)(md.chunk_count) * md.md_chunk_size > msize-ssize)
md.chunk_count--;
md.chunk_next = 0;
if (i != 1) {
md.chunk_reserved = 0;
md.flags = 0;
} else {
md.chunk_reserved = map_chunks * 2;
md.flags = VIRSTOR_PROVIDER_ALLOCATED |
VIRSTOR_PROVIDER_CURRENT;
md.chunk_next = md.chunk_reserved;
if (verbose)
printf("(%u reserved) ", md.chunk_reserved);
}
if (!hardcode)
bzero(md.provider, sizeof(md.provider));
else {
/* convert "/dev/something" to "something" */
if (strncmp(name, _PATH_DEV, strlen(_PATH_DEV)) == 0) {
strlcpy(md.provider, name + strlen(_PATH_DEV),
sizeof(md.provider));
} else
strlcpy(md.provider, name, sizeof(md.provider));
}
sect = malloc(ssize);
bzero(sect, ssize);
if (sect == NULL)
err(1, "Cannot allocate sector of %zu bytes", ssize);
virstor_metadata_encode(&md, sect);
error = my_g_metadata_store(name, sect, ssize);
free(sect);
if (error != 0) {
if (verbose)
printf("\n");
fprintf(stderr, "Can't store metadata on %s: %s.\n",
name, strerror(error));
gctl_error(req,
"Not fully done (error storing metadata).");
return;
}
}
#if 0
if (verbose)
printf("\n");
#endif
}
/* Clears metadata on given provider(s) IF it's owned by us */
static void
virstor_clear(struct gctl_req *req)
{
const char *name;
char param[32];
unsigned i;
int nargs, error;
int fd;
nargs = gctl_get_int(req, "nargs");
if (nargs < 1) {
gctl_error(req, "Too few arguments.");
return;
}
for (i = 0; i < (unsigned)nargs; i++) {
snprintf(param, sizeof(param), "arg%u", i);
name = gctl_get_ascii(req, param);
error = g_metadata_clear(name, G_VIRSTOR_MAGIC);
if (error != 0) {
fprintf(stderr, "Can't clear metadata on %s: %s "
"(do I own it?)\n", name, strerror(error));
gctl_error(req,
"Not fully done (can't clear metadata).");
continue;
}
if (strncmp(name, _PATH_DEV, strlen(_PATH_DEV)) == 0)
fd = open(name, O_RDWR);
else {
sprintf(param, "%s%s", _PATH_DEV, name);
fd = open(param, O_RDWR);
}
if (fd < 0) {
gctl_error(req, "Cannot clear header sector for %s",
name);
continue;
}
if (verbose)
printf("Metadata cleared on %s.\n", name);
}
}
/* Print some metadata information */
static void
virstor_metadata_dump(const struct g_virstor_metadata *md)
{
printf(" Magic string: %s\n", md->md_magic);
printf(" Metadata version: %u\n", (u_int) md->md_version);
printf(" Device name: %s\n", md->md_name);
printf(" Device ID: %u\n", (u_int) md->md_id);
printf(" Provider index: %u\n", (u_int) md->no);
printf(" Active providers: %u\n", (u_int) md->md_count);
printf(" Hardcoded provider: %s\n",
md->provider[0] != '\0' ? md->provider : "(not hardcoded)");
printf(" Virtual size: %u MB\n",
(unsigned int)(md->md_virsize/(1024 * 1024)));
printf(" Chunk size: %u kB\n", md->md_chunk_size / 1024);
printf(" Chunks on provider: %u\n", md->chunk_count);
printf(" Chunks free: %u\n", md->chunk_count - md->chunk_next);
printf(" Reserved chunks: %u\n", md->chunk_reserved);
}
/* Called by geom(8) via gvirstor_main() to dump metadata information */
static void
virstor_dump(struct gctl_req *req)
{
struct g_virstor_metadata md;
u_char tmpmd[512]; /* temporary buffer */
const char *name;
char param[16];
int nargs, error, i;
assert(sizeof(tmpmd) >= sizeof(md));
nargs = gctl_get_int(req, "nargs");
if (nargs < 1) {
gctl_error(req, "Too few arguments.");
return;
}
for (i = 0; i < nargs; i++) {
snprintf(param, sizeof(param), "arg%u", i);
name = gctl_get_ascii(req, param);
error = g_metadata_read(name, (u_char *) & tmpmd, sizeof(tmpmd),
G_VIRSTOR_MAGIC);
if (error != 0) {
fprintf(stderr, "Can't read metadata from %s: %s.\n",
name, strerror(error));
gctl_error(req,
"Not fully done (error reading metadata).");
continue;
}
virstor_metadata_decode((u_char *) & tmpmd, &md);
printf("Metadata on %s:\n", name);
virstor_metadata_dump(&md);
printf("\n");
}
}
|