d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
master
freebsd-skq/usr.bin/mkimg/vtoc8.c

114 lines
3.5 KiB
C
Raw Permalink Normal View History

Use linker sets to provide build-time selection of the schemes that need to be supported. Each scheme provides data and callbacks for handling the scheme-specifics. To this end, put each scheme in its own source file.
2014-03-20 00:38:17 +00:00
/*-
* Copyright (c) 2014 Juniper Networks, Inc.
* All rights reserved.
*
* 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 AUTHOR 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 AUTHOR 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$");
Add a scheme-specific write callback to write the metadata. While here: 1. Move FreeBSD-specific headers to a more centralized place, so that it's easier to port mkimg. 2. Remove inclusion of <uuid.h> where we don't need it (copy-pasted). 3. Check the partition data given on the command line before we do any I/O. 4. Add scheme_round() for rounding the partition size. 5. Have scheme_write call the scheme-specific write callback and have it propagate errors back to the caller.
2014-03-20 20:14:26 +00:00
#include <sys/errno.h>
Prefer <stdint.h> over <sys/types.h>. While here remove redundant inclusion of <sys/queue.h>. Move the inclusion of the disk partitioning headers out of order and inbetween standard headers and local header. They will change in a subsequent commit.
2016-10-03 02:37:28 +00:00
#include <stdint.h>
Mostly implement the vtoc8 scheme. The vtoc8 scheme uses cylinders for the beginning of partitions, which makes it sensitive to geometry. Again, we'll need to revisit this.
2014-03-25 02:15:19 +00:00
#include <stdio.h>
#include <string.h>
Use linker sets to provide build-time selection of the schemes that need to be supported. Each scheme provides data and callbacks for handling the scheme-specifics. To this end, put each scheme in its own source file.
2014-03-20 00:38:17 +00:00
o Provide a private definition for UUIDs (mkimg_uuid_t) because UUIDs are not portable. o Move mkimg_uuid() to a new file and merge both gpt_uuid_enc() and vhd_uuid_enc() into a single mkimg_uuid_enc() that lives in the same file. o Move the OS-specific implementation of generating a UUID to osdep_uuidgen() and provide the implementations for FreeBSD, macOS and Linux. o Expect the partitioning scheme headers to be found by having a search to the directory in which the headers live. This avoids conflicts on non-FreeBSD machines.
2016-10-18 01:55:07 +00:00
#include <vtoc.h>
Prefer <stdint.h> over <sys/types.h>. While here remove redundant inclusion of <sys/queue.h>. Move the inclusion of the disk partitioning headers out of order and inbetween standard headers and local header. They will change in a subsequent commit.
2016-10-03 02:37:28 +00:00
Avoid depending on the <sys/endian.h> header for le*enc and be*enc. Not only is the header unportable, the encoding/decoding functions are as well. Instead, duplicate the handful of small inlines we need into a private header called endian.h. Aside: an alternative approach is to move the encoding/decoding functions to a separate system header. While the header is still nonportable, such an approach would make it possible to re-use the definitions by playing games with include paths. This may be the preferred approach if more (build) utilities need this. This change does not preclude that. In fact, it makes it easier.
2016-09-26 01:06:32 +00:00
#include "endian.h"
Switch to the image API: 1. Replace calls to mkimg_set_size() with calls to image_set_size() 2. Remove the mkimg_set_size() function 3. As above but for mkimg_write() and image_write() Note that this breaks mkimg(1). The image API has no implementation. Hence doing it on my branch :-)
2014-05-07 17:33:31 +00:00
#include "image.h"
Use linker sets to provide build-time selection of the schemes that need to be supported. Each scheme provides data and callbacks for handling the scheme-specifics. To this end, put each scheme in its own source file.
2014-03-20 00:38:17 +00:00
#include "mkimg.h"
#include "scheme.h"
static struct mkimg_alias vtoc8_aliases[] = {
Mostly implement the vtoc8 scheme. The vtoc8 scheme uses cylinders for the beginning of partitions, which makes it sensitive to geometry. Again, we'll need to revisit this.
2014-03-25 02:15:19 +00:00
{ ALIAS_FREEBSD_NANDFS, ALIAS_INT2TYPE(VTOC_TAG_FREEBSD_NANDFS) },
{ ALIAS_FREEBSD_SWAP, ALIAS_INT2TYPE(VTOC_TAG_FREEBSD_SWAP) },
{ ALIAS_FREEBSD_UFS, ALIAS_INT2TYPE(VTOC_TAG_FREEBSD_UFS) },
{ ALIAS_FREEBSD_VINUM, ALIAS_INT2TYPE(VTOC_TAG_FREEBSD_VINUM) },
{ ALIAS_FREEBSD_ZFS, ALIAS_INT2TYPE(VTOC_TAG_FREEBSD_NANDFS) },
Add more partition types (mostly just the FreeBSD ones) to GPT. Avoid having schemes use literal strings by introducing an enum as the intermediate representation (see geom_part).
2014-03-21 16:11:49 +00:00
{ ALIAS_NONE, 0 }
Use linker sets to provide build-time selection of the schemes that need to be supported. Each scheme provides data and callbacks for handling the scheme-specifics. To this end, put each scheme in its own source file.
2014-03-20 00:38:17 +00:00
};
Fix partition alignment and image rounding when any of -P (block size), -T (track size) or -H (number of heads) is given: o scheme_metadata() always rounded to the block size. This is not always valid (e.g. vtoc8 that must have partitions start at cylinder boundaries). o The bsd and vtoc8 schemes "resized" the image to make it match the geometry, but since the geometry is an approximation and the size of the image computed from cylinders * heads * sectors is always smaller than the original image size, the partition information ran out of bounds. The fix is to have scheme_metadata() simply pass it's arguments to the per-scheme metadata callback, so that schemes not only know where the metadata is to go, but also what the current block address is. It's now up to the per-scheme callback to reserve room for metadata and to make sure alignment and rounding is applied. The BSD scheme now has the most elaborate alignment and rounding. Just to make the point: partitions are aligned on block boundaries, but the image is rounded to the next cyclinder boundary. vtoc8 now properly has all partitions aligned (and rounded) to the cyclinder boundary. Obtained from: Juniper Networks, Inc. MFC after: 3 days
2014-09-19 23:16:02 +00:00
static lba_t
vtoc8_metadata(u_int where, lba_t blk)
Use linker sets to provide build-time selection of the schemes that need to be supported. Each scheme provides data and callbacks for handling the scheme-specifics. To this end, put each scheme in its own source file.
2014-03-20 00:38:17 +00:00
{
Fix partition alignment and image rounding when any of -P (block size), -T (track size) or -H (number of heads) is given: o scheme_metadata() always rounded to the block size. This is not always valid (e.g. vtoc8 that must have partitions start at cylinder boundaries). o The bsd and vtoc8 schemes "resized" the image to make it match the geometry, but since the geometry is an approximation and the size of the image computed from cylinders * heads * sectors is always smaller than the original image size, the partition information ran out of bounds. The fix is to have scheme_metadata() simply pass it's arguments to the per-scheme metadata callback, so that schemes not only know where the metadata is to go, but also what the current block address is. It's now up to the per-scheme callback to reserve room for metadata and to make sure alignment and rounding is applied. The BSD scheme now has the most elaborate alignment and rounding. Just to make the point: partitions are aligned on block boundaries, but the image is rounded to the next cyclinder boundary. vtoc8 now properly has all partitions aligned (and rounded) to the cyclinder boundary. Obtained from: Juniper Networks, Inc. MFC after: 3 days
2014-09-19 23:16:02 +00:00
blk += (where == SCHEME_META_IMG_START) ? 1 : 0;
return (round_cylinder(blk));
Use linker sets to provide build-time selection of the schemes that need to be supported. Each scheme provides data and callbacks for handling the scheme-specifics. To this end, put each scheme in its own source file.
2014-03-20 00:38:17 +00:00
}
Add a scheme-specific write callback to write the metadata. While here: 1. Move FreeBSD-specific headers to a more centralized place, so that it's easier to port mkimg. 2. Remove inclusion of <uuid.h> where we don't need it (copy-pasted). 3. Check the partition data given on the command line before we do any I/O. 4. Add scheme_round() for rounding the partition size. 5. Have scheme_write call the scheme-specific write callback and have it propagate errors back to the caller.
2014-03-20 20:14:26 +00:00
static int
Switch to the image API: 1. Replace calls to mkimg_set_size() with calls to image_set_size() 2. Remove the mkimg_set_size() function 3. As above but for mkimg_write() and image_write() Note that this breaks mkimg(1). The image API has no implementation. Hence doing it on my branch :-)
2014-05-07 17:33:31 +00:00
vtoc8_write(lba_t imgsz, void *bootcode __unused)
Add a scheme-specific write callback to write the metadata. While here: 1. Move FreeBSD-specific headers to a more centralized place, so that it's easier to port mkimg. 2. Remove inclusion of <uuid.h> where we don't need it (copy-pasted). 3. Check the partition data given on the command line before we do any I/O. 4. Add scheme_round() for rounding the partition size. 5. Have scheme_write call the scheme-specific write callback and have it propagate errors back to the caller.
2014-03-20 20:14:26 +00:00
{
Mostly implement the vtoc8 scheme. The vtoc8 scheme uses cylinders for the beginning of partitions, which makes it sensitive to geometry. Again, we'll need to revisit this.
2014-03-25 02:15:19 +00:00
struct vtoc8 vtoc8;
struct part *part;
Give vtoc8 a change to work: when setting the physical block size to 4K, sectors/track to 8 and number or heads to 1, partitions that are block aligned are also cyclinder aligned. With that trick, fix the vtoc8: 1. Set physcyls, ncyls, altcyls, nheads and nsecs appropriately. 2. Truncate the image size to exactly ncyls * nheads * nsecs * secsz. 3. Properly write the cylinder number as the start of the partition. 4. Oh, and actually calculate the checksum of the label...
2014-03-27 22:48:48 +00:00
u_char *p;
Handle the raw partition of the BSD and VTOC schemes.
2014-03-29 03:14:00 +00:00
int error, n;
Give vtoc8 a change to work: when setting the physical block size to 4K, sectors/track to 8 and number or heads to 1, partitions that are block aligned are also cyclinder aligned. With that trick, fix the vtoc8: 1. Set physcyls, ncyls, altcyls, nheads and nsecs appropriately. 2. Truncate the image size to exactly ncyls * nheads * nsecs * secsz. 3. Properly write the cylinder number as the start of the partition. 4. Oh, and actually calculate the checksum of the label...
2014-03-27 22:48:48 +00:00
uint16_t ofs, sum;
Mostly implement the vtoc8 scheme. The vtoc8 scheme uses cylinders for the beginning of partitions, which makes it sensitive to geometry. Again, we'll need to revisit this.
2014-03-25 02:15:19 +00:00
Fix CID 1204379 (vtoc8.c) & CID 1204380 (bsd.c): Cast ncyls to lba_t before multiplying the 32-bit integrals to avoid any possibility of truncation before widening. Not a likely scenario to begin with...
2014-05-21 17:39:49 +00:00
imgsz = (lba_t)ncyls * nheads * nsecs;
Handle the raw partition of the BSD and VTOC schemes.
2014-03-29 03:14:00 +00:00
Mostly implement the vtoc8 scheme. The vtoc8 scheme uses cylinders for the beginning of partitions, which makes it sensitive to geometry. Again, we'll need to revisit this.
2014-03-25 02:15:19 +00:00
memset(&vtoc8, 0, sizeof(vtoc8));
Handle the raw partition of the BSD and VTOC schemes.
2014-03-29 03:14:00 +00:00
sprintf(vtoc8.ascii, "FreeBSD%lldM",
(long long)(imgsz * secsz / 1048576));
Mostly implement the vtoc8 scheme. The vtoc8 scheme uses cylinders for the beginning of partitions, which makes it sensitive to geometry. Again, we'll need to revisit this.
2014-03-25 02:15:19 +00:00
be32enc(&vtoc8.version, VTOC_VERSION);
be16enc(&vtoc8.nparts, VTOC8_NPARTS);
be32enc(&vtoc8.sanity, VTOC_SANITY);
be16enc(&vtoc8.rpm, 3600);
Give vtoc8 a change to work: when setting the physical block size to 4K, sectors/track to 8 and number or heads to 1, partitions that are block aligned are also cyclinder aligned. With that trick, fix the vtoc8: 1. Set physcyls, ncyls, altcyls, nheads and nsecs appropriately. 2. Truncate the image size to exactly ncyls * nheads * nsecs * secsz. 3. Properly write the cylinder number as the start of the partition. 4. Oh, and actually calculate the checksum of the label...
2014-03-27 22:48:48 +00:00
be16enc(&vtoc8.physcyls, ncyls);
be16enc(&vtoc8.ncyls, ncyls);
be16enc(&vtoc8.altcyls, 0);
be16enc(&vtoc8.nheads, nheads);
be16enc(&vtoc8.nsecs, nsecs);
Mostly implement the vtoc8 scheme. The vtoc8 scheme uses cylinders for the beginning of partitions, which makes it sensitive to geometry. Again, we'll need to revisit this.
2014-03-25 02:15:19 +00:00
be16enc(&vtoc8.magic, VTOC_MAGIC);
Handle the raw partition of the BSD and VTOC schemes.
2014-03-29 03:14:00 +00:00
be32enc(&vtoc8.map[VTOC_RAW_PART].nblks, imgsz);
Replace STAILQ with TAILQ. TAILQs are portable enough that they can be used on both macOS and Linux. STAILQs are not. In particular, STAILQ_LAST does not next on Linux. Since neither STAILQ_FOREACH_SAFE nor TAILQ_FOREACH_SAFE exist on Linux, replace its use with a regular TAILQ_FOREACH. The _SAFE variant was only used for having the next pointer in a local variable.
2016-10-03 01:46:47 +00:00
TAILQ_FOREACH(part, &partlist, link) {
Handle the raw partition of the BSD and VTOC schemes.
2014-03-29 03:14:00 +00:00
n = part->index + ((part->index >= VTOC_RAW_PART) ? 1 : 0);
be16enc(&vtoc8.part[n].tag, ALIAS_TYPE2INT(part->type));
be32enc(&vtoc8.map[n].cyl, part->block / (nsecs * nheads));
be32enc(&vtoc8.map[n].nblks, part->size);
Mostly implement the vtoc8 scheme. The vtoc8 scheme uses cylinders for the beginning of partitions, which makes it sensitive to geometry. Again, we'll need to revisit this.
2014-03-25 02:15:19 +00:00
}
Give vtoc8 a change to work: when setting the physical block size to 4K, sectors/track to 8 and number or heads to 1, partitions that are block aligned are also cyclinder aligned. With that trick, fix the vtoc8: 1. Set physcyls, ncyls, altcyls, nheads and nsecs appropriately. 2. Truncate the image size to exactly ncyls * nheads * nsecs * secsz. 3. Properly write the cylinder number as the start of the partition. 4. Oh, and actually calculate the checksum of the label...
2014-03-27 22:48:48 +00:00
/* Calculate checksum. */
sum = 0;
p = (void *)&vtoc8;
for (ofs = 0; ofs < sizeof(vtoc8) - 2; ofs += 2)
sum ^= be16dec(p + ofs);
be16enc(&vtoc8.cksum, sum);
Switch to the image API: 1. Replace calls to mkimg_set_size() with calls to image_set_size() 2. Remove the mkimg_set_size() function 3. As above but for mkimg_write() and image_write() Note that this breaks mkimg(1). The image API has no implementation. Hence doing it on my branch :-)
2014-05-07 17:33:31 +00:00
error = image_write(0, &vtoc8, 1);
Mostly implement the vtoc8 scheme. The vtoc8 scheme uses cylinders for the beginning of partitions, which makes it sensitive to geometry. Again, we'll need to revisit this.
2014-03-25 02:15:19 +00:00
return (error);
Add a scheme-specific write callback to write the metadata. While here: 1. Move FreeBSD-specific headers to a more centralized place, so that it's easier to port mkimg. 2. Remove inclusion of <uuid.h> where we don't need it (copy-pasted). 3. Check the partition data given on the command line before we do any I/O. 4. Add scheme_round() for rounding the partition size. 5. Have scheme_write call the scheme-specific write callback and have it propagate errors back to the caller.
2014-03-20 20:14:26 +00:00
}
Use linker sets to provide build-time selection of the schemes that need to be supported. Each scheme provides data and callbacks for handling the scheme-specifics. To this end, put each scheme in its own source file.
2014-03-20 00:38:17 +00:00
static struct mkimg_scheme vtoc8_scheme = {
.name = "vtoc8",
.description = "SMI VTOC8 disk labels",
.aliases = vtoc8_aliases,
Replace *_get_leader() and *_get_trailer() with a single *_metadata(). This single function takes a where argument to indicate the kind of metadata to "size". This way we can also get rid of the "padding" field in the scheme structure. This should make it a little more understandable what's going on.
2014-03-20 19:37:30 +00:00
.metadata = vtoc8_metadata,
Add a scheme-specific write callback to write the metadata. While here: 1. Move FreeBSD-specific headers to a more centralized place, so that it's easier to port mkimg. 2. Remove inclusion of <uuid.h> where we don't need it (copy-pasted). 3. Check the partition data given on the command line before we do any I/O. 4. Add scheme_round() for rounding the partition size. 5. Have scheme_write call the scheme-specific write callback and have it propagate errors back to the caller.
2014-03-20 20:14:26 +00:00
.write = vtoc8_write,
Handle the raw partition of the BSD and VTOC schemes.
2014-03-29 03:14:00 +00:00
.nparts = VTOC8_NPARTS - 1,
Allow schemes to specify a maximum sector size. The minimum is fixed at 512. This allows checking of the sector size up-front when given on the command line.
2014-03-25 02:32:04 +00:00
.maxsecsz = 512
Use linker sets to provide build-time selection of the schemes that need to be supported. Each scheme provides data and callbacks for handling the scheme-specifics. To this end, put each scheme in its own source file.
2014-03-20 00:38:17 +00:00
};
SCHEME_DEFINE(vtoc8_scheme);
Reference in New Issue Copy Permalink