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

125 lines
3.6 KiB
C
Raw 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>
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 <stdlib.h>
Flesh-out MBR support. The CHS fields need more thought/work...
2014-03-22 23:34:35 +00:00
#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 <mbr.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 mbr_aliases[] = {
Add support for the fat32 and ebr aliases.
2014-03-23 20:15:21 +00:00
{ ALIAS_EBR, ALIAS_INT2TYPE(DOSPTYP_EXT) },
mkimg: Add MBR EFI partition type Sponsored by: The FreeBSD Foundation
2015-01-09 19:34:48 +00:00
{ ALIAS_EFI, ALIAS_INT2TYPE(DOSPTYP_EFI) },
Switch to using the portable partition scheme headers.
2016-10-16 02:55:52 +00:00
{ ALIAS_FAT16B, ALIAS_INT2TYPE(DOSPTYP_FAT16) },
Add support for the fat32 and ebr aliases.
2014-03-23 20:15:21 +00:00
{ ALIAS_FAT32, ALIAS_INT2TYPE(DOSPTYP_FAT32) },
Flesh-out MBR support. The CHS fields need more thought/work...
2014-03-22 23:34:35 +00:00
{ ALIAS_FREEBSD, ALIAS_INT2TYPE(DOSPTYP_386BSD) },
Add the ntfs alias and support it with the MBR and GPT schemes as DOSPTYP_NTFS and GPT_ENT_TYPE_MS_BASIC_DATA (resp).
2015-06-27 03:28:04 +00:00
{ ALIAS_NTFS, ALIAS_INT2TYPE(DOSPTYP_NTFS) },
Add ppcboot FAT type. Needed to create a bootable powerpc image. Differential Review: https://reviews.freebsd.org/D4407
2015-12-11 05:39:42 +00:00
{ ALIAS_PPCBOOT, ALIAS_INT2TYPE(DOSPTYP_PPCBOOT) },
Flesh-out MBR support. The CHS fields need more thought/work...
2014-03-22 23:34:35 +00:00
{ ALIAS_NONE, 0 } /* Keep last! */
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
mbr_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_track(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
}
Move setting CHS fields to mbr_chs() in preparation of ...
2014-03-25 03:58:13 +00:00
static void
Add mkimg_chs() for those schemes that need the LBA broken down into cylinder, head and track numbers. Return ~0U for these values when mkimg wasn't given both -T and -H (i.e. no geometry) or the cylinder would be larger than the provided maximum. Use mkimgs_chs() for the EBR, MBR and PC98 schemes to fill in the appropriate fields. Make sure to use a "rounded" size so that the partition is always a multiple of the track size. We reserved the room for it in the metadata callback so that's a valid thing to do. Bump the mkimg version number. While doing that again: have mkimg.o depend on the Makefile so that a version change triggers a rebuild as needed.
2014-10-03 20:48:11 +00:00
mbr_chs(u_char *cylp, u_char *hdp, u_char *secp, lba_t lba)
Move setting CHS fields to mbr_chs() in preparation of ...
2014-03-25 03:58:13 +00:00
{
Add mkimg_chs() for those schemes that need the LBA broken down into cylinder, head and track numbers. Return ~0U for these values when mkimg wasn't given both -T and -H (i.e. no geometry) or the cylinder would be larger than the provided maximum. Use mkimgs_chs() for the EBR, MBR and PC98 schemes to fill in the appropriate fields. Make sure to use a "rounded" size so that the partition is always a multiple of the track size. We reserved the room for it in the metadata callback so that's a valid thing to do. Bump the mkimg version number. While doing that again: have mkimg.o depend on the Makefile so that a version change triggers a rebuild as needed.
2014-10-03 20:48:11 +00:00
u_int cyl, hd, sec;
Move setting CHS fields to mbr_chs() in preparation of ...
2014-03-25 03:58:13 +00:00
Add mkimg_chs() for those schemes that need the LBA broken down into cylinder, head and track numbers. Return ~0U for these values when mkimg wasn't given both -T and -H (i.e. no geometry) or the cylinder would be larger than the provided maximum. Use mkimgs_chs() for the EBR, MBR and PC98 schemes to fill in the appropriate fields. Make sure to use a "rounded" size so that the partition is always a multiple of the track size. We reserved the room for it in the metadata callback so that's a valid thing to do. Bump the mkimg version number. While doing that again: have mkimg.o depend on the Makefile so that a version change triggers a rebuild as needed.
2014-10-03 20:48:11 +00:00
mkimg_chs(lba, 1023, &cyl, &hd, &sec);
*cylp = cyl;
*hdp = hd;
*secp = (sec & 0x3f) | ((cyl >> 2) & 0xc0);
Move setting CHS fields to mbr_chs() in preparation of ...
2014-03-25 03:58:13 +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
mbr_write(lba_t imgsz __unused, void *bootcode)
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
{
Flesh-out MBR support. The CHS fields need more thought/work...
2014-03-22 23:34:35 +00:00
u_char *mbr;
struct dos_partition *dpbase, *dp;
struct part *part;
Add mkimg_chs() for those schemes that need the LBA broken down into cylinder, head and track numbers. Return ~0U for these values when mkimg wasn't given both -T and -H (i.e. no geometry) or the cylinder would be larger than the provided maximum. Use mkimgs_chs() for the EBR, MBR and PC98 schemes to fill in the appropriate fields. Make sure to use a "rounded" size so that the partition is always a multiple of the track size. We reserved the room for it in the metadata callback so that's a valid thing to do. Bump the mkimg version number. While doing that again: have mkimg.o depend on the Makefile so that a version change triggers a rebuild as needed.
2014-10-03 20:48:11 +00:00
lba_t size;
Revamp: 1. Make secsz globally visible. 2. Have all code use the global secsz and nparts, rather than passing them around. 3. Introduce lba_t as the type to use when talking about block addresses. 4. Work on LBAs instead of offsets. There's just too much division with the sector size and there's really no value to use by offsets other than that is what lseek() wants. For that we now have mkimg_seek(). The bigger picture is that geometry (cylinders, heads, sectors/track) and also a possible physical sector size are to be globals that can be used from anyway. We really don't want to pass all that stuff as arguments to functions and then add __unused for most of them...
2014-03-23 01:10:05 +00:00
int error;
Flesh-out MBR support. The CHS fields need more thought/work...
2014-03-22 23:34:35 +00:00
mbr = malloc(secsz);
if (mbr == NULL)
return (ENOMEM);
if (bootcode != NULL) {
memcpy(mbr, bootcode, DOSPARTOFF);
memset(mbr + DOSPARTOFF, 0, secsz - DOSPARTOFF);
} else
memset(mbr, 0, secsz);
And the magic number is... necessary.
2014-03-23 01:17:02 +00:00
le16enc(mbr + DOSMAGICOFFSET, DOSMAGIC);
Flesh-out MBR support. The CHS fields need more thought/work...
2014-03-22 23:34:35 +00:00
dpbase = (void *)(mbr + DOSPARTOFF);
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) {
Add mkimg_chs() for those schemes that need the LBA broken down into cylinder, head and track numbers. Return ~0U for these values when mkimg wasn't given both -T and -H (i.e. no geometry) or the cylinder would be larger than the provided maximum. Use mkimgs_chs() for the EBR, MBR and PC98 schemes to fill in the appropriate fields. Make sure to use a "rounded" size so that the partition is always a multiple of the track size. We reserved the room for it in the metadata callback so that's a valid thing to do. Bump the mkimg version number. While doing that again: have mkimg.o depend on the Makefile so that a version change triggers a rebuild as needed.
2014-10-03 20:48:11 +00:00
size = round_track(part->size);
Flesh-out MBR support. The CHS fields need more thought/work...
2014-03-22 23:34:35 +00:00
dp = dpbase + part->index;
Add a new flag to mkimg (-a num) to specify the active partition for those partitioning schemes that have this concept. Implement it as an override for mbr's setting 0x80 in the flags for the first partition when we have boot code. Differential Revision: https://reviews.freebsd.org/D4403
2016-10-18 05:43:12 +00:00
if (active_partition != 0)
dp->dp_flag =
(part->index + 1 == active_partition) ? 0x80 : 0;
else
dp->dp_flag =
(part->index == 0 && bootcode != NULL) ? 0x80 : 0;
Move setting CHS fields to mbr_chs() in preparation of ...
2014-03-25 03:58:13 +00:00
mbr_chs(&dp->dp_scyl, &dp->dp_shd, &dp->dp_ssect,
part->block);
Flesh-out MBR support. The CHS fields need more thought/work...
2014-03-22 23:34:35 +00:00
dp->dp_typ = ALIAS_TYPE2INT(part->type);
Move setting CHS fields to mbr_chs() in preparation of ...
2014-03-25 03:58:13 +00:00
mbr_chs(&dp->dp_ecyl, &dp->dp_ehd, &dp->dp_esect,
Add mkimg_chs() for those schemes that need the LBA broken down into cylinder, head and track numbers. Return ~0U for these values when mkimg wasn't given both -T and -H (i.e. no geometry) or the cylinder would be larger than the provided maximum. Use mkimgs_chs() for the EBR, MBR and PC98 schemes to fill in the appropriate fields. Make sure to use a "rounded" size so that the partition is always a multiple of the track size. We reserved the room for it in the metadata callback so that's a valid thing to do. Bump the mkimg version number. While doing that again: have mkimg.o depend on the Makefile so that a version change triggers a rebuild as needed.
2014-10-03 20:48:11 +00:00
part->block + size - 1);
Fix writing the start and size fields.
2014-03-27 21:32:02 +00:00
le32enc(&dp->dp_start, part->block);
Add mkimg_chs() for those schemes that need the LBA broken down into cylinder, head and track numbers. Return ~0U for these values when mkimg wasn't given both -T and -H (i.e. no geometry) or the cylinder would be larger than the provided maximum. Use mkimgs_chs() for the EBR, MBR and PC98 schemes to fill in the appropriate fields. Make sure to use a "rounded" size so that the partition is always a multiple of the track size. We reserved the room for it in the metadata callback so that's a valid thing to do. Bump the mkimg version number. While doing that again: have mkimg.o depend on the Makefile so that a version change triggers a rebuild as needed.
2014-10-03 20:48:11 +00:00
le32enc(&dp->dp_size, size);
Flesh-out MBR support. The CHS fields need more thought/work...
2014-03-22 23:34:35 +00:00
}
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, mbr, 1);
Flesh-out MBR support. The CHS fields need more thought/work...
2014-03-22 23:34:35 +00:00
free(mbr);
Revamp: 1. Make secsz globally visible. 2. Have all code use the global secsz and nparts, rather than passing them around. 3. Introduce lba_t as the type to use when talking about block addresses. 4. Work on LBAs instead of offsets. There's just too much division with the sector size and there's really no value to use by offsets other than that is what lseek() wants. For that we now have mkimg_seek(). The bigger picture is that geometry (cylinders, heads, sectors/track) and also a possible physical sector size are to be globals that can be used from anyway. We really don't want to pass all that stuff as arguments to functions and then add __unused for most of them...
2014-03-23 01:10:05 +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 mbr_scheme = {
.name = "mbr",
Revert r362466 Such change should not have happen without prior discussion and review. With hat: transitioning core
2020-06-22 07:46:24 +00:00
.description = "Master Boot Record",
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
.aliases = mbr_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 = mbr_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 = mbr_write,
Flesh-out MBR support. The CHS fields need more thought/work...
2014-03-22 23:34:35 +00:00
.bootcode = 512,
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
.nparts = NDOSPART,
.maxsecsz = 4096
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(mbr_scheme);
Reference in New Issue Copy Permalink