2 * Copyright (c) 2012 Andrey V. Elsukov <ae@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
32 #include <sys/diskmbr.h>
33 #include <sys/endian.h>
35 #include <sys/kernel.h>
37 #include <sys/limits.h>
39 #include <sys/malloc.h>
40 #include <sys/mutex.h>
41 #include <sys/queue.h>
43 #include <sys/systm.h>
44 #include <sys/sysctl.h>
46 #include <geom/geom.h>
47 #include <geom/part/g_part.h>
49 #include "g_part_if.h"
51 FEATURE(geom_part_ldm, "GEOM partitioning class for LDM support");
53 SYSCTL_DECL(_kern_geom_part);
54 static SYSCTL_NODE(_kern_geom_part, OID_AUTO, ldm, CTLFLAG_RW, 0,
55 "GEOM_PART_LDM Logical Disk Manager");
57 static u_int ldm_debug = 0;
58 SYSCTL_UINT(_kern_geom_part_ldm, OID_AUTO, debug,
59 CTLFLAG_RWTUN, &ldm_debug, 0, "Debug level");
62 * This allows access to mirrored LDM volumes. Since we do not
63 * doing mirroring here, it is not enabled by default.
65 static u_int show_mirrors = 0;
66 SYSCTL_UINT(_kern_geom_part_ldm, OID_AUTO, show_mirrors,
67 CTLFLAG_RWTUN, &show_mirrors, 0, "Show mirrored volumes");
69 #define LDM_DEBUG(lvl, fmt, ...) do { \
70 if (ldm_debug >= (lvl)) { \
71 printf("GEOM_PART: " fmt "\n", __VA_ARGS__); \
74 #define LDM_DUMP(buf, size) do { \
75 if (ldm_debug > 1) { \
76 hexdump(buf, size, NULL, 0); \
81 * There are internal representations of LDM structures.
83 * We do not keep all fields of on-disk structures, only most useful.
84 * All numbers in an on-disk structures are in big-endian format.
88 * Private header is 512 bytes long. There are three copies on each disk.
89 * Offset and sizes are in sectors. Location of each copy:
90 * - the first offset is relative to the disk start;
91 * - the second and third offset are relative to the LDM database start.
93 * On a disk partitioned with GPT, the LDM has not first private header.
95 #define LDM_PH_MBRINDEX 0
96 #define LDM_PH_GPTINDEX 2
97 static const uint64_t ldm_ph_off[] = {6, 1856, 2047};
98 #define LDM_VERSION_2K 0x2000b
99 #define LDM_VERSION_VISTA 0x2000c
100 #define LDM_PH_VERSION_OFF 0x00c
101 #define LDM_PH_DISKGUID_OFF 0x030
102 #define LDM_PH_DGGUID_OFF 0x0b0
103 #define LDM_PH_DGNAME_OFF 0x0f0
104 #define LDM_PH_START_OFF 0x11b
105 #define LDM_PH_SIZE_OFF 0x123
106 #define LDM_PH_DB_OFF 0x12b
107 #define LDM_PH_DBSIZE_OFF 0x133
108 #define LDM_PH_TH1_OFF 0x13b
109 #define LDM_PH_TH2_OFF 0x143
110 #define LDM_PH_CONFSIZE_OFF 0x153
111 #define LDM_PH_LOGSIZE_OFF 0x15b
112 #define LDM_PH_SIGN "PRIVHEAD"
114 struct uuid disk_guid;
117 uint64_t start; /* logical disk start */
118 uint64_t size; /* logical disk size */
119 uint64_t db_offset; /* LDM database start */
120 #define LDM_DB_SIZE 2048
121 uint64_t db_size; /* LDM database size */
122 #define LDM_TH_COUNT 2
123 uint64_t th_offset[LDM_TH_COUNT]; /* TOC header offsets */
124 uint64_t conf_size; /* configuration size */
125 uint64_t log_size; /* size of log */
129 * Table of contents header is 512 bytes long.
130 * There are two identical copies at offsets from the private header.
131 * Offsets are relative to the LDM database start.
133 #define LDM_TH_SIGN "TOCBLOCK"
134 #define LDM_TH_NAME1 "config"
135 #define LDM_TH_NAME2 "log"
136 #define LDM_TH_NAME1_OFF 0x024
137 #define LDM_TH_CONF_OFF 0x02e
138 #define LDM_TH_CONFSIZE_OFF 0x036
139 #define LDM_TH_NAME2_OFF 0x046
140 #define LDM_TH_LOG_OFF 0x050
141 #define LDM_TH_LOGSIZE_OFF 0x058
143 uint64_t conf_offset; /* configuration offset */
144 uint64_t log_offset; /* log offset */
148 * LDM database header is 512 bytes long.
150 #define LDM_VMDB_SIGN "VMDB"
151 #define LDM_DB_LASTSEQ_OFF 0x004
152 #define LDM_DB_SIZE_OFF 0x008
153 #define LDM_DB_STATUS_OFF 0x010
154 #define LDM_DB_VERSION_OFF 0x012
155 #define LDM_DB_DGNAME_OFF 0x016
156 #define LDM_DB_DGGUID_OFF 0x035
158 uint32_t last_seq; /* sequence number of last VBLK */
159 uint32_t size; /* size of VBLK */
163 * The LDM database configuration section contains VMDB header and
164 * many VBLKs. Each VBLK represents a disk group, disk partition,
165 * component or volume.
167 * The most interesting for us are volumes, they are represents
168 * partitions in the GEOM_PART meaning. But volume VBLK does not
169 * contain all information needed to create GEOM provider. And we
170 * should get this information from the related VBLK. This is how
172 * Volumes <- Components <- Partitions -> Disks
174 * One volume can contain several components. In this case LDM
175 * does mirroring of volume data to each component.
177 * Also each component can contain several partitions (spanned or
181 struct ldm_component {
182 uint64_t id; /* object id */
183 uint64_t vol_id; /* parent volume object id */
186 LIST_HEAD(, ldm_partition) partitions;
187 LIST_ENTRY(ldm_component) entry;
191 uint64_t id; /* object id */
192 uint64_t size; /* volume size */
193 uint8_t number; /* used for ordering */
194 uint8_t part_type; /* partition type */
197 LIST_HEAD(, ldm_component) components;
198 LIST_ENTRY(ldm_volume) entry;
202 uint64_t id; /* object id */
203 struct uuid guid; /* disk guid */
205 LIST_ENTRY(ldm_disk) entry;
209 struct ldm_disk_group {
210 uint64_t id; /* object id */
211 struct uuid guid; /* disk group guid */
212 u_char name[32]; /* disk group name */
214 LIST_ENTRY(ldm_disk_group) entry;
218 struct ldm_partition {
219 uint64_t id; /* object id */
220 uint64_t disk_id; /* disk object id */
221 uint64_t comp_id; /* parent component object id */
222 uint64_t start; /* offset relative to disk start */
223 uint64_t offset; /* offset for spanned volumes */
224 uint64_t size; /* partition size */
226 LIST_ENTRY(ldm_partition) entry;
230 * Each VBLK is 128 bytes long and has standard 16 bytes header.
231 * Some of VBLK's fields are fixed size, but others has variable size.
232 * Fields with variable size are prefixed with one byte length marker.
233 * Some fields are strings and also can have fixed size and variable.
234 * Strings with fixed size are NULL-terminated, others are not.
235 * All VBLKs have same several first fields:
236 * Offset Size Description
237 * ---------------+---------------+--------------------------
238 * 0x00 16 standard VBLK header
239 * 0x10 2 update status
242 * 0x18+ PN object name
244 * o Offset 0x18+ means '0x18 + length of all variable-width fields'
245 * o 'P' in size column means 'prefixed' (variable-width),
246 * 'S' - string, 'N' - number.
248 #define LDM_VBLK_SIGN "VBLK"
249 #define LDM_VBLK_SEQ_OFF 0x04
250 #define LDM_VBLK_GROUP_OFF 0x08
251 #define LDM_VBLK_INDEX_OFF 0x0c
252 #define LDM_VBLK_COUNT_OFF 0x0e
253 #define LDM_VBLK_TYPE_OFF 0x13
254 #define LDM_VBLK_OID_OFF 0x18
256 uint32_t seq; /* sequence number */
257 uint32_t group; /* group number */
258 uint16_t index; /* index in the group */
259 uint16_t count; /* number of entries in the group */
262 #define LDM_VBLK_T_COMPONENT 0x32
263 #define LDM_VBLK_T_PARTITION 0x33
264 #define LDM_VBLK_T_DISK 0x34
265 #define LDM_VBLK_T_DISKGROUP 0x35
266 #define LDM_VBLK_T_DISK4 0x44
267 #define LDM_VBLK_T_DISKGROUP4 0x45
268 #define LDM_VBLK_T_VOLUME 0x51
270 uint8_t type; /* VBLK type */
273 struct ldm_volume vol;
274 struct ldm_component comp;
275 struct ldm_disk disk;
276 struct ldm_partition part;
278 struct ldm_disk_group disk_group;
281 LIST_ENTRY(ldm_vblk) entry;
285 * Some VBLKs contains a bit more data than can fit into 128 bytes. These
286 * VBLKs are called eXtended VBLK. Before parsing, the data from these VBLK
287 * should be placed into continuous memory buffer. We can determine xVBLK
288 * by the count field in the standard VBLK header (count > 1).
291 uint32_t group; /* xVBLK group number */
292 uint32_t size; /* the total size of xVBLK */
293 uint8_t map; /* bitmask of currently saved VBLKs */
294 u_char *data; /* xVBLK data */
296 LIST_ENTRY(ldm_xvblk) entry;
299 /* The internal representation of LDM database. */
301 struct ldm_privhdr ph; /* private header */
302 struct ldm_tochdr th; /* TOC header */
303 struct ldm_vmdbhdr dh; /* VMDB header */
305 LIST_HEAD(, ldm_volume) volumes;
306 LIST_HEAD(, ldm_disk) disks;
307 LIST_HEAD(, ldm_vblk) vblks;
308 LIST_HEAD(, ldm_xvblk) xvblks;
311 static struct uuid gpt_uuid_ms_ldm_metadata = GPT_ENT_TYPE_MS_LDM_METADATA;
313 struct g_part_ldm_table {
314 struct g_part_table base;
318 struct g_part_ldm_entry {
319 struct g_part_entry base;
323 static int g_part_ldm_add(struct g_part_table *, struct g_part_entry *,
324 struct g_part_parms *);
325 static int g_part_ldm_bootcode(struct g_part_table *, struct g_part_parms *);
326 static int g_part_ldm_create(struct g_part_table *, struct g_part_parms *);
327 static int g_part_ldm_destroy(struct g_part_table *, struct g_part_parms *);
328 static void g_part_ldm_dumpconf(struct g_part_table *, struct g_part_entry *,
329 struct sbuf *, const char *);
330 static int g_part_ldm_dumpto(struct g_part_table *, struct g_part_entry *);
331 static int g_part_ldm_modify(struct g_part_table *, struct g_part_entry *,
332 struct g_part_parms *);
333 static const char *g_part_ldm_name(struct g_part_table *, struct g_part_entry *,
335 static int g_part_ldm_probe(struct g_part_table *, struct g_consumer *);
336 static int g_part_ldm_read(struct g_part_table *, struct g_consumer *);
337 static const char *g_part_ldm_type(struct g_part_table *, struct g_part_entry *,
339 static int g_part_ldm_write(struct g_part_table *, struct g_consumer *);
341 static kobj_method_t g_part_ldm_methods[] = {
342 KOBJMETHOD(g_part_add, g_part_ldm_add),
343 KOBJMETHOD(g_part_bootcode, g_part_ldm_bootcode),
344 KOBJMETHOD(g_part_create, g_part_ldm_create),
345 KOBJMETHOD(g_part_destroy, g_part_ldm_destroy),
346 KOBJMETHOD(g_part_dumpconf, g_part_ldm_dumpconf),
347 KOBJMETHOD(g_part_dumpto, g_part_ldm_dumpto),
348 KOBJMETHOD(g_part_modify, g_part_ldm_modify),
349 KOBJMETHOD(g_part_name, g_part_ldm_name),
350 KOBJMETHOD(g_part_probe, g_part_ldm_probe),
351 KOBJMETHOD(g_part_read, g_part_ldm_read),
352 KOBJMETHOD(g_part_type, g_part_ldm_type),
353 KOBJMETHOD(g_part_write, g_part_ldm_write),
357 static struct g_part_scheme g_part_ldm_scheme = {
360 sizeof(struct g_part_ldm_table),
361 .gps_entrysz = sizeof(struct g_part_ldm_entry)
363 G_PART_SCHEME_DECLARE(g_part_ldm);
365 static struct g_part_ldm_alias {
368 } ldm_alias_match[] = {
369 { DOSPTYP_NTFS, G_PART_ALIAS_MS_NTFS },
370 { DOSPTYP_FAT32, G_PART_ALIAS_MS_FAT32 },
371 { DOSPTYP_386BSD, G_PART_ALIAS_FREEBSD },
372 { DOSPTYP_LDM, G_PART_ALIAS_MS_LDM_DATA },
373 { DOSPTYP_LINSWP, G_PART_ALIAS_LINUX_SWAP },
374 { DOSPTYP_LINUX, G_PART_ALIAS_LINUX_DATA },
375 { DOSPTYP_LINLVM, G_PART_ALIAS_LINUX_LVM },
376 { DOSPTYP_LINRAID, G_PART_ALIAS_LINUX_RAID },
380 ldm_privhdr_read(struct g_consumer *cp, uint64_t off, int *error)
382 struct g_provider *pp;
386 buf = g_read_data(cp, off, pp->sectorsize, error);
390 if (memcmp(buf, LDM_PH_SIGN, strlen(LDM_PH_SIGN)) != 0) {
391 LDM_DEBUG(1, "%s: invalid LDM private header signature",
401 ldm_privhdr_parse(struct g_consumer *cp, struct ldm_privhdr *hdr,
407 memset(hdr, 0, sizeof(*hdr));
408 version = be32dec(buf + LDM_PH_VERSION_OFF);
409 if (version != LDM_VERSION_2K &&
410 version != LDM_VERSION_VISTA) {
411 LDM_DEBUG(0, "%s: unsupported LDM version %u.%u",
412 cp->provider->name, version >> 16,
416 error = parse_uuid(buf + LDM_PH_DISKGUID_OFF, &hdr->disk_guid);
419 error = parse_uuid(buf + LDM_PH_DGGUID_OFF, &hdr->dg_guid);
422 strncpy(hdr->dg_name, buf + LDM_PH_DGNAME_OFF, sizeof(hdr->dg_name));
423 hdr->start = be64dec(buf + LDM_PH_START_OFF);
424 hdr->size = be64dec(buf + LDM_PH_SIZE_OFF);
425 hdr->db_offset = be64dec(buf + LDM_PH_DB_OFF);
426 hdr->db_size = be64dec(buf + LDM_PH_DBSIZE_OFF);
427 hdr->th_offset[0] = be64dec(buf + LDM_PH_TH1_OFF);
428 hdr->th_offset[1] = be64dec(buf + LDM_PH_TH2_OFF);
429 hdr->conf_size = be64dec(buf + LDM_PH_CONFSIZE_OFF);
430 hdr->log_size = be64dec(buf + LDM_PH_LOGSIZE_OFF);
435 ldm_privhdr_check(struct ldm_db *db, struct g_consumer *cp, int is_gpt)
437 struct g_consumer *cp2;
438 struct g_provider *pp;
439 struct ldm_privhdr hdr;
440 uint64_t offset, last;
447 * The last LBA is used in several checks below, for the
448 * GPT case it should be calculated relative to the whole
451 cp2 = LIST_FIRST(&pp->geom->consumer);
453 cp2->provider->mediasize / cp2->provider->sectorsize - 1;
455 last = pp->mediasize / pp->sectorsize - 1;
456 for (found = 0, i = is_gpt; i < nitems(ldm_ph_off); i++) {
457 offset = ldm_ph_off[i];
459 * In the GPT case consumer is attached to the LDM metadata
460 * partition and we don't need add db_offset.
463 offset += db->ph.db_offset;
464 if (i == LDM_PH_MBRINDEX) {
466 * Prepare to errors and setup new base offset
467 * to read backup private headers. Assume that LDM
468 * database is in the last 1Mbyte area.
470 db->ph.db_offset = last - LDM_DB_SIZE;
472 buf = ldm_privhdr_read(cp, offset * pp->sectorsize, &error);
474 LDM_DEBUG(1, "%s: failed to read private header "
475 "%d at LBA %ju", pp->name, i, (uintmax_t)offset);
478 error = ldm_privhdr_parse(cp, &hdr, buf);
480 LDM_DEBUG(1, "%s: failed to parse private "
481 "header %d", pp->name, i);
482 LDM_DUMP(buf, pp->sectorsize);
487 if (hdr.start > last ||
488 hdr.start + hdr.size - 1 > last ||
489 (hdr.start + hdr.size - 1 > hdr.db_offset && !is_gpt) ||
490 hdr.db_size != LDM_DB_SIZE ||
491 hdr.db_offset + LDM_DB_SIZE - 1 > last ||
492 hdr.th_offset[0] >= LDM_DB_SIZE ||
493 hdr.th_offset[1] >= LDM_DB_SIZE ||
494 hdr.conf_size + hdr.log_size >= LDM_DB_SIZE) {
495 LDM_DEBUG(1, "%s: invalid values in the "
496 "private header %d", pp->name, i);
497 LDM_DEBUG(2, "%s: start: %jd, size: %jd, "
498 "db_offset: %jd, db_size: %jd, th_offset0: %jd, "
499 "th_offset1: %jd, conf_size: %jd, log_size: %jd, "
500 "last: %jd", pp->name, hdr.start, hdr.size,
501 hdr.db_offset, hdr.db_size, hdr.th_offset[0],
502 hdr.th_offset[1], hdr.conf_size, hdr.log_size,
506 if (found != 0 && memcmp(&db->ph, &hdr, sizeof(hdr)) != 0) {
507 LDM_DEBUG(0, "%s: private headers are not equal",
511 * We have different headers in the LDM.
512 * We can not trust this metadata.
514 LDM_DEBUG(0, "%s: refuse LDM metadata",
519 * We already have read primary private header
520 * and it differs from this backup one.
521 * Prefer the backup header and save it.
526 memcpy(&db->ph, &hdr, sizeof(hdr));
530 LDM_DEBUG(1, "%s: valid LDM private header not found",
538 ldm_gpt_check(struct ldm_db *db, struct g_consumer *cp)
540 struct g_part_table *gpt;
541 struct g_part_entry *e;
542 struct g_consumer *cp2;
545 cp2 = LIST_NEXT(cp, consumer);
547 gpt = cp->provider->geom->softc;
549 LIST_FOREACH(e, &gpt->gpt_entry, gpe_entry) {
550 if (cp->provider == e->gpe_pp) {
551 /* ms-ldm-metadata partition */
552 if (e->gpe_start != db->ph.db_offset ||
553 e->gpe_end != db->ph.db_offset + LDM_DB_SIZE - 1)
555 } else if (cp2->provider == e->gpe_pp) {
556 /* ms-ldm-data partition */
557 if (e->gpe_start != db->ph.start ||
558 e->gpe_end != db->ph.start + db->ph.size - 1)
562 LDM_DEBUG(0, "%s: GPT partition %d boundaries "
563 "do not match with the LDM metadata",
564 e->gpe_pp->name, e->gpe_index);
574 ldm_tochdr_check(struct ldm_db *db, struct g_consumer *cp)
576 struct g_provider *pp;
577 struct ldm_tochdr hdr;
578 uint64_t offset, conf_size, log_size;
583 for (i = 0, found = 0; i < LDM_TH_COUNT; i++) {
584 offset = db->ph.db_offset + db->ph.th_offset[i];
585 buf = g_read_data(cp,
586 offset * pp->sectorsize, pp->sectorsize, &error);
588 LDM_DEBUG(1, "%s: failed to read TOC header "
589 "at LBA %ju", pp->name, (uintmax_t)offset);
592 if (memcmp(buf, LDM_TH_SIGN, strlen(LDM_TH_SIGN)) != 0 ||
593 memcmp(buf + LDM_TH_NAME1_OFF, LDM_TH_NAME1,
594 strlen(LDM_TH_NAME1)) != 0 ||
595 memcmp(buf + LDM_TH_NAME2_OFF, LDM_TH_NAME2,
596 strlen(LDM_TH_NAME2)) != 0) {
597 LDM_DEBUG(1, "%s: failed to parse TOC header "
598 "at LBA %ju", pp->name, (uintmax_t)offset);
599 LDM_DUMP(buf, pp->sectorsize);
603 hdr.conf_offset = be64dec(buf + LDM_TH_CONF_OFF);
604 hdr.log_offset = be64dec(buf + LDM_TH_LOG_OFF);
605 conf_size = be64dec(buf + LDM_TH_CONFSIZE_OFF);
606 log_size = be64dec(buf + LDM_TH_LOGSIZE_OFF);
607 if (conf_size != db->ph.conf_size ||
608 hdr.conf_offset + conf_size >= LDM_DB_SIZE ||
609 log_size != db->ph.log_size ||
610 hdr.log_offset + log_size >= LDM_DB_SIZE) {
611 LDM_DEBUG(1, "%s: invalid values in the "
612 "TOC header at LBA %ju", pp->name,
614 LDM_DUMP(buf, pp->sectorsize);
620 memcpy(&db->th, &hdr, sizeof(hdr));
624 LDM_DEBUG(0, "%s: valid LDM TOC header not found.",
632 ldm_vmdbhdr_check(struct ldm_db *db, struct g_consumer *cp)
634 struct g_provider *pp;
642 offset = db->ph.db_offset + db->th.conf_offset;
643 buf = g_read_data(cp, offset * pp->sectorsize, pp->sectorsize,
646 LDM_DEBUG(0, "%s: failed to read VMDB header at "
647 "LBA %ju", pp->name, (uintmax_t)offset);
650 if (memcmp(buf, LDM_VMDB_SIGN, strlen(LDM_VMDB_SIGN)) != 0) {
652 LDM_DEBUG(0, "%s: failed to parse VMDB header at "
653 "LBA %ju", pp->name, (uintmax_t)offset);
657 version = be32dec(buf + LDM_DB_VERSION_OFF);
658 if (version != 0x4000A) {
660 LDM_DEBUG(0, "%s: unsupported VMDB version %u.%u",
661 pp->name, version >> 16, version & 0xFFFF);
665 * Check VMDB update status:
666 * 1 - in a consistent state;
667 * 2 - in a creation phase;
668 * 3 - in a deletion phase;
670 if (be16dec(buf + LDM_DB_STATUS_OFF) != 1) {
672 LDM_DEBUG(0, "%s: VMDB is not in a consistent state",
676 db->dh.last_seq = be32dec(buf + LDM_DB_LASTSEQ_OFF);
677 db->dh.size = be32dec(buf + LDM_DB_SIZE_OFF);
678 error = parse_uuid(buf + LDM_DB_DGGUID_OFF, &dg_guid);
679 /* Compare disk group name and guid from VMDB and private headers */
680 if (error != 0 || db->dh.size == 0 ||
681 pp->sectorsize % db->dh.size != 0 ||
682 strncmp(buf + LDM_DB_DGNAME_OFF, db->ph.dg_name, 31) != 0 ||
683 memcmp(&dg_guid, &db->ph.dg_guid, sizeof(dg_guid)) != 0 ||
684 db->dh.size * db->dh.last_seq >
685 db->ph.conf_size * pp->sectorsize) {
686 LDM_DEBUG(0, "%s: invalid values in the VMDB header",
688 LDM_DUMP(buf, pp->sectorsize);
697 ldm_xvblk_handle(struct ldm_db *db, struct ldm_vblkhdr *vh, const u_char *p)
699 struct ldm_xvblk *blk;
702 size = db->dh.size - 16;
703 LIST_FOREACH(blk, &db->xvblks, entry)
704 if (blk->group == vh->group)
707 blk = g_malloc(sizeof(*blk), M_WAITOK | M_ZERO);
708 blk->group = vh->group;
709 blk->size = size * vh->count + 16;
710 blk->data = g_malloc(blk->size, M_WAITOK | M_ZERO);
711 blk->map = 0xFF << vh->count;
712 LIST_INSERT_HEAD(&db->xvblks, blk, entry);
714 if ((blk->map & (1 << vh->index)) != 0) {
715 /* Block with given index has been already saved. */
718 /* Copy the data block to the place related to index. */
719 memcpy(blk->data + size * vh->index + 16, p + 16, size);
720 blk->map |= 1 << vh->index;
724 /* Read the variable-width numeric field and return new offset */
726 ldm_vnum_get(const u_char *buf, int offset, uint64_t *result, size_t range)
732 if (len > sizeof(uint64_t) || len + offset >= range)
734 for (num = 0; len > 0; len--)
735 num = (num << 8) | buf[offset++];
740 /* Read the variable-width string and return new offset */
742 ldm_vstr_get(const u_char *buf, int offset, u_char *result,
743 size_t maxlen, size_t range)
748 if (len >= maxlen || len + offset >= range)
750 memcpy(result, buf + offset, len);
752 return (offset + len);
755 /* Just skip the variable-width variable and return new offset */
757 ldm_vparm_skip(const u_char *buf, int offset, size_t range)
762 if (offset + len >= range)
765 return (offset + len);
769 ldm_vblk_handle(struct ldm_db *db, const u_char *p, size_t size)
771 struct ldm_vblk *blk;
772 struct ldm_volume *volume, *last;
777 blk = g_malloc(sizeof(*blk), M_WAITOK | M_ZERO);
778 blk->type = p[LDM_VBLK_TYPE_OFF];
779 offset = ldm_vnum_get(p, LDM_VBLK_OID_OFF, &blk->u.id, size);
781 errstr = "object id";
784 offset = ldm_vstr_get(p, offset, vstr, sizeof(vstr), size);
786 errstr = "object name";
791 * Component VBLK fields:
792 * Offset Size Description
793 * ------------+-------+------------------------
794 * 0x18+ PS volume state
795 * 0x18+5 PN component children count
796 * 0x1D+16 PN parent's volume object id
797 * 0x2D+1 PN stripe size
799 case LDM_VBLK_T_COMPONENT:
800 offset = ldm_vparm_skip(p, offset, size);
802 errstr = "volume state";
805 offset = ldm_vparm_skip(p, offset + 5, size);
807 errstr = "children count";
810 offset = ldm_vnum_get(p, offset + 16,
811 &blk->u.comp.vol_id, size);
813 errstr = "volume id";
818 * Partition VBLK fields:
819 * Offset Size Description
820 * ------------+-------+------------------------
821 * 0x18+12 8 partition start offset
822 * 0x18+20 8 volume offset
823 * 0x18+28 PN partition size
824 * 0x34+ PN parent's component object id
825 * 0x34+ PN disk's object id
827 case LDM_VBLK_T_PARTITION:
828 if (offset + 28 >= size) {
829 errstr = "too small buffer";
832 blk->u.part.start = be64dec(p + offset + 12);
833 blk->u.part.offset = be64dec(p + offset + 20);
834 offset = ldm_vnum_get(p, offset + 28, &blk->u.part.size, size);
836 errstr = "partition size";
839 offset = ldm_vnum_get(p, offset, &blk->u.part.comp_id, size);
841 errstr = "component id";
844 offset = ldm_vnum_get(p, offset, &blk->u.part.disk_id, size);
852 * Offset Size Description
853 * ------------+-------+------------------------
856 case LDM_VBLK_T_DISK:
857 errstr = "disk guid";
858 offset = ldm_vstr_get(p, offset, vstr, sizeof(vstr), size);
861 error = parse_uuid(vstr, &blk->u.disk.guid);
864 LIST_INSERT_HEAD(&db->disks, &blk->u.disk, entry);
867 * Disk group VBLK fields:
868 * Offset Size Description
869 * ------------+-------+------------------------
870 * 0x18+ PS disk group GUID
872 case LDM_VBLK_T_DISKGROUP:
874 strncpy(blk->u.disk_group.name, vstr,
875 sizeof(blk->u.disk_group.name));
876 offset = ldm_vstr_get(p, offset, vstr, sizeof(vstr), size);
878 errstr = "disk group guid";
881 error = parse_uuid(name, &blk->u.disk_group.guid);
883 errstr = "disk group guid";
886 LIST_INSERT_HEAD(&db->groups, &blk->u.disk_group, entry);
891 * Offset Size Description
892 * ------------+-------+------------------------
895 case LDM_VBLK_T_DISK4:
896 be_uuid_dec(p + offset, &blk->u.disk.guid);
897 LIST_INSERT_HEAD(&db->disks, &blk->u.disk, entry);
900 * Disk group VBLK fields:
901 * Offset Size Description
902 * ------------+-------+------------------------
905 case LDM_VBLK_T_DISKGROUP4:
907 strncpy(blk->u.disk_group.name, vstr,
908 sizeof(blk->u.disk_group.name));
909 be_uuid_dec(p + offset, &blk->u.disk.guid);
910 LIST_INSERT_HEAD(&db->groups, &blk->u.disk_group, entry);
914 * Volume VBLK fields:
915 * Offset Size Description
916 * ------------+-------+------------------------
917 * 0x18+ PS volume type
919 * 0x18+ 14(S) volume state
920 * 0x18+16 1 volume number
921 * 0x18+21 PN volume children count
922 * 0x2D+16 PN volume size
923 * 0x3D+4 1 partition type
925 case LDM_VBLK_T_VOLUME:
926 offset = ldm_vparm_skip(p, offset, size);
928 errstr = "volume type";
931 offset = ldm_vparm_skip(p, offset, size);
933 errstr = "unknown param";
936 if (offset + 21 >= size) {
937 errstr = "too small buffer";
940 blk->u.vol.number = p[offset + 16];
941 offset = ldm_vparm_skip(p, offset + 21, size);
943 errstr = "children count";
946 offset = ldm_vnum_get(p, offset + 16, &blk->u.vol.size, size);
948 errstr = "volume size";
951 if (offset + 4 >= size) {
952 errstr = "too small buffer";
955 blk->u.vol.part_type = p[offset + 4];
956 /* keep volumes ordered by volume number */
958 LIST_FOREACH(volume, &db->volumes, entry) {
959 if (volume->number > blk->u.vol.number)
964 LIST_INSERT_AFTER(last, &blk->u.vol, entry);
966 LIST_INSERT_HEAD(&db->volumes, &blk->u.vol, entry);
969 LDM_DEBUG(1, "unknown VBLK type 0x%02x\n", blk->type);
972 LIST_INSERT_HEAD(&db->vblks, blk, entry);
975 LDM_DEBUG(0, "failed to parse '%s' in VBLK of type 0x%02x\n",
983 ldm_vmdb_free(struct ldm_db *db)
985 struct ldm_vblk *vblk;
986 struct ldm_xvblk *xvblk;
988 while (!LIST_EMPTY(&db->xvblks)) {
989 xvblk = LIST_FIRST(&db->xvblks);
990 LIST_REMOVE(xvblk, entry);
994 while (!LIST_EMPTY(&db->vblks)) {
995 vblk = LIST_FIRST(&db->vblks);
996 LIST_REMOVE(vblk, entry);
1002 ldm_vmdb_parse(struct ldm_db *db, struct g_consumer *cp)
1004 struct g_provider *pp;
1005 struct ldm_vblk *vblk;
1006 struct ldm_xvblk *xvblk;
1007 struct ldm_volume *volume;
1008 struct ldm_component *comp;
1009 struct ldm_vblkhdr vh;
1011 size_t size, n, sectors;
1016 size = howmany(db->dh.last_seq * db->dh.size, pp->sectorsize);
1017 size -= 1; /* one sector takes vmdb header */
1018 for (n = 0; n < size; n += MAXPHYS / pp->sectorsize) {
1019 offset = db->ph.db_offset + db->th.conf_offset + n + 1;
1020 sectors = (size - n) > (MAXPHYS / pp->sectorsize) ?
1021 MAXPHYS / pp->sectorsize: size - n;
1023 buf = g_read_data(cp, offset * pp->sectorsize,
1024 sectors * pp->sectorsize, &error);
1026 LDM_DEBUG(0, "%s: failed to read VBLK\n",
1030 for (p = buf; p < buf + sectors * pp->sectorsize;
1032 if (memcmp(p, LDM_VBLK_SIGN,
1033 strlen(LDM_VBLK_SIGN)) != 0) {
1034 LDM_DEBUG(0, "%s: no VBLK signature\n",
1036 LDM_DUMP(p, db->dh.size);
1039 vh.seq = be32dec(p + LDM_VBLK_SEQ_OFF);
1040 vh.group = be32dec(p + LDM_VBLK_GROUP_OFF);
1041 /* skip empty blocks */
1042 if (vh.seq == 0 || vh.group == 0)
1044 vh.index = be16dec(p + LDM_VBLK_INDEX_OFF);
1045 vh.count = be16dec(p + LDM_VBLK_COUNT_OFF);
1046 if (vh.count == 0 || vh.count > 4 ||
1047 vh.seq > db->dh.last_seq) {
1048 LDM_DEBUG(0, "%s: invalid values "
1049 "in the VBLK header\n", pp->name);
1050 LDM_DUMP(p, db->dh.size);
1054 error = ldm_xvblk_handle(db, &vh, p);
1056 LDM_DEBUG(0, "%s: xVBLK "
1057 "is corrupted\n", pp->name);
1058 LDM_DUMP(p, db->dh.size);
1063 if (be16dec(p + 16) != 0)
1064 LDM_DEBUG(1, "%s: VBLK update"
1065 " status is %u\n", pp->name,
1067 error = ldm_vblk_handle(db, p, db->dh.size);
1075 while (!LIST_EMPTY(&db->xvblks)) {
1076 xvblk = LIST_FIRST(&db->xvblks);
1077 if (xvblk->map == 0xFF) {
1078 error = ldm_vblk_handle(db, xvblk->data, xvblk->size);
1082 LDM_DEBUG(0, "%s: incomplete or corrupt "
1083 "xVBLK found\n", pp->name);
1086 LIST_REMOVE(xvblk, entry);
1087 g_free(xvblk->data);
1090 /* construct all VBLKs relations */
1091 LIST_FOREACH(volume, &db->volumes, entry) {
1092 LIST_FOREACH(vblk, &db->vblks, entry)
1093 if (vblk->type == LDM_VBLK_T_COMPONENT &&
1094 vblk->u.comp.vol_id == volume->id) {
1095 LIST_INSERT_HEAD(&volume->components,
1096 &vblk->u.comp, entry);
1099 LIST_FOREACH(comp, &volume->components, entry)
1100 LIST_FOREACH(vblk, &db->vblks, entry)
1101 if (vblk->type == LDM_VBLK_T_PARTITION &&
1102 vblk->u.part.comp_id == comp->id) {
1103 LIST_INSERT_HEAD(&comp->partitions,
1104 &vblk->u.part, entry);
1116 g_part_ldm_add(struct g_part_table *basetable, struct g_part_entry *baseentry,
1117 struct g_part_parms *gpp)
1124 g_part_ldm_bootcode(struct g_part_table *basetable, struct g_part_parms *gpp)
1131 g_part_ldm_create(struct g_part_table *basetable, struct g_part_parms *gpp)
1138 g_part_ldm_destroy(struct g_part_table *basetable, struct g_part_parms *gpp)
1140 struct g_part_ldm_table *table;
1141 struct g_provider *pp;
1143 table = (struct g_part_ldm_table *)basetable;
1145 * To destroy LDM on a disk partitioned with GPT we should delete
1146 * ms-ldm-metadata partition, but we can't do this via standard
1151 pp = LIST_FIRST(&basetable->gpt_gp->consumer)->provider;
1153 * To destroy LDM we should wipe MBR, first private header and
1154 * backup private headers.
1156 basetable->gpt_smhead = (1 << ldm_ph_off[0]) | 1;
1158 * Don't touch last backup private header when LDM database is
1159 * not located in the last 1MByte area.
1160 * XXX: can't remove all blocks.
1162 if (table->db_offset + LDM_DB_SIZE ==
1163 pp->mediasize / pp->sectorsize)
1164 basetable->gpt_smtail = 1;
1169 g_part_ldm_dumpconf(struct g_part_table *basetable,
1170 struct g_part_entry *baseentry, struct sbuf *sb, const char *indent)
1172 struct g_part_ldm_entry *entry;
1174 entry = (struct g_part_ldm_entry *)baseentry;
1175 if (indent == NULL) {
1176 /* conftxt: libdisk compatibility */
1177 sbuf_printf(sb, " xs LDM xt %u", entry->type);
1178 } else if (entry != NULL) {
1179 /* confxml: partition entry information */
1180 sbuf_printf(sb, "%s<rawtype>%u</rawtype>\n", indent,
1183 /* confxml: scheme information */
1188 g_part_ldm_dumpto(struct g_part_table *table, struct g_part_entry *baseentry)
1195 g_part_ldm_modify(struct g_part_table *basetable,
1196 struct g_part_entry *baseentry, struct g_part_parms *gpp)
1203 g_part_ldm_name(struct g_part_table *table, struct g_part_entry *baseentry,
1204 char *buf, size_t bufsz)
1207 snprintf(buf, bufsz, "s%d", baseentry->gpe_index);
1212 ldm_gpt_probe(struct g_part_table *basetable, struct g_consumer *cp)
1214 struct g_part_ldm_table *table;
1215 struct g_part_table *gpt;
1216 struct g_part_entry *entry;
1217 struct g_consumer *cp2;
1218 struct gpt_ent *part;
1223 * XXX: We use some knowlege about GEOM_PART_GPT internal
1224 * structures, but it is easier than parse GPT by himself.
1227 gpt = cp->provider->geom->softc;
1228 LIST_FOREACH(entry, &gpt->gpt_entry, gpe_entry) {
1229 part = (struct gpt_ent *)(entry + 1);
1230 /* Search ms-ldm-metadata partition */
1231 if (memcmp(&part->ent_type,
1232 &gpt_uuid_ms_ldm_metadata, sizeof(struct uuid)) != 0 ||
1233 entry->gpe_end - entry->gpe_start < LDM_DB_SIZE - 1)
1236 /* Create new consumer and attach it to metadata partition */
1237 cp2 = g_new_consumer(cp->geom);
1238 error = g_attach(cp2, entry->gpe_pp);
1240 g_destroy_consumer(cp2);
1241 g_topology_unlock();
1244 error = g_access(cp2, 1, 0, 0);
1247 g_destroy_consumer(cp2);
1248 g_topology_unlock();
1251 g_topology_unlock();
1253 LDM_DEBUG(2, "%s: LDM metadata partition %s found in the GPT",
1254 cp->provider->name, cp2->provider->name);
1255 /* Read the LDM private header */
1256 buf = ldm_privhdr_read(cp2,
1257 ldm_ph_off[LDM_PH_GPTINDEX] * cp2->provider->sectorsize,
1260 table = (struct g_part_ldm_table *)basetable;
1263 return (G_PART_PROBE_PRI_HIGH);
1266 /* second consumer is no longer needed. */
1268 g_access(cp2, -1, 0, 0);
1270 g_destroy_consumer(cp2);
1273 g_topology_unlock();
1278 g_part_ldm_probe(struct g_part_table *basetable, struct g_consumer *cp)
1280 struct g_provider *pp;
1281 u_char *buf, type[64];
1286 if (pp->sectorsize != 512)
1289 error = g_getattr("PART::scheme", cp, &type);
1290 if (error == 0 && strcmp(type, "GPT") == 0) {
1291 if (g_getattr("PART::type", cp, &type) != 0 ||
1292 strcmp(type, "ms-ldm-data") != 0)
1294 error = ldm_gpt_probe(basetable, cp);
1298 if (basetable->gpt_depth != 0)
1301 /* LDM has 1M metadata area */
1302 if (pp->mediasize <= 1024 * 1024)
1305 /* Check that there's a MBR */
1306 buf = g_read_data(cp, 0, pp->sectorsize, &error);
1310 if (le16dec(buf + DOSMAGICOFFSET) != DOSMAGIC) {
1315 /* Check that we have LDM partitions in the MBR */
1316 for (idx = 0; idx < NDOSPART && error != 0; idx++) {
1317 if (buf[DOSPARTOFF + idx * DOSPARTSIZE + 4] == DOSPTYP_LDM)
1322 LDM_DEBUG(2, "%s: LDM data partitions found in MBR",
1324 /* Read the LDM private header */
1325 buf = ldm_privhdr_read(cp,
1326 ldm_ph_off[LDM_PH_MBRINDEX] * pp->sectorsize, &error);
1330 return (G_PART_PROBE_PRI_HIGH);
1336 g_part_ldm_read(struct g_part_table *basetable, struct g_consumer *cp)
1338 struct g_part_ldm_table *table;
1339 struct g_part_ldm_entry *entry;
1340 struct g_consumer *cp2;
1341 struct ldm_component *comp;
1342 struct ldm_partition *part;
1343 struct ldm_volume *vol;
1344 struct ldm_disk *disk;
1346 int error, index, skipped;
1348 table = (struct g_part_ldm_table *)basetable;
1349 memset(&db, 0, sizeof(db));
1350 cp2 = cp; /* ms-ldm-data */
1352 cp = LIST_FIRST(&cp->geom->consumer); /* ms-ldm-metadata */
1353 /* Read and parse LDM private headers. */
1354 error = ldm_privhdr_check(&db, cp, table->is_gpt);
1357 basetable->gpt_first = table->is_gpt ? 0: db.ph.start;
1358 basetable->gpt_last = basetable->gpt_first + db.ph.size - 1;
1359 table->db_offset = db.ph.db_offset;
1360 /* Make additional checks for GPT */
1361 if (table->is_gpt) {
1362 error = ldm_gpt_check(&db, cp);
1366 * Now we should reset database offset to zero, because our
1367 * consumer cp is attached to the ms-ldm-metadata partition
1368 * and we don't need add db_offset to read from it.
1370 db.ph.db_offset = 0;
1372 /* Read and parse LDM TOC headers. */
1373 error = ldm_tochdr_check(&db, cp);
1376 /* Read and parse LDM VMDB header. */
1377 error = ldm_vmdbhdr_check(&db, cp);
1380 error = ldm_vmdb_parse(&db, cp);
1382 * For the GPT case we must detach and destroy
1383 * second consumer before return.
1386 if (table->is_gpt) {
1388 g_access(cp, -1, 0, 0);
1390 g_destroy_consumer(cp);
1391 g_topology_unlock();
1396 /* Search current disk in the disk list. */
1397 LIST_FOREACH(disk, &db.disks, entry)
1398 if (memcmp(&disk->guid, &db.ph.disk_guid,
1399 sizeof(struct uuid)) == 0)
1402 LDM_DEBUG(1, "%s: no LDM volumes on this disk",
1403 cp->provider->name);
1408 LIST_FOREACH(vol, &db.volumes, entry) {
1409 LIST_FOREACH(comp, &vol->components, entry) {
1410 /* Skip volumes from different disks. */
1411 part = LIST_FIRST(&comp->partitions);
1412 if (part->disk_id != disk->id)
1415 /* We don't support spanned and striped volumes. */
1416 if (comp->count > 1 || part->offset != 0) {
1417 LDM_DEBUG(1, "%s: LDM volume component "
1418 "%ju has %u partitions. Skipped",
1419 cp->provider->name, (uintmax_t)comp->id,
1424 * Allow mirrored volumes only when they are explicitly
1425 * allowed with kern.geom.part.ldm.show_mirrors=1.
1427 if (vol->count > 1 && show_mirrors == 0) {
1428 LDM_DEBUG(1, "%s: LDM volume %ju has %u "
1429 "components. Skipped",
1430 cp->provider->name, (uintmax_t)vol->id,
1434 entry = (struct g_part_ldm_entry *)g_part_new_entry(
1436 basetable->gpt_first + part->start,
1437 basetable->gpt_first + part->start +
1440 * Mark skipped partition as ms-ldm-data partition.
1441 * We do not support them, but it is better to show
1442 * that we have something there, than just show
1446 entry->type = vol->part_type;
1448 entry->type = DOSPTYP_LDM;
1449 LDM_DEBUG(1, "%s: new volume id: %ju, start: %ju,"
1450 " end: %ju, type: 0x%02x\n", cp->provider->name,
1451 (uintmax_t)part->id,(uintmax_t)part->start +
1452 basetable->gpt_first, (uintmax_t)part->start +
1453 part->size + basetable->gpt_first - 1,
1462 g_part_ldm_type(struct g_part_table *basetable, struct g_part_entry *baseentry,
1463 char *buf, size_t bufsz)
1465 struct g_part_ldm_entry *entry;
1468 entry = (struct g_part_ldm_entry *)baseentry;
1469 for (i = 0; i < nitems(ldm_alias_match); i++) {
1470 if (ldm_alias_match[i].typ == entry->type)
1471 return (g_part_alias_name(ldm_alias_match[i].alias));
1473 snprintf(buf, bufsz, "!%d", entry->type);
1478 g_part_ldm_write(struct g_part_table *basetable, struct g_consumer *cp)