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

114 lines
3.2 KiB
C
Raw Permalink Normal View History

Add mkimg.h. It contains the 'part' structure definition and the linked list (STAILQ) so that it can be shared and re-used in all source files. Replace the now unneeded scheme_add_part() with scheme_check_part() for posterity. Also (should have been a separate commit), remove the enforcement of creating a GPT table with at least 128 entries. While this is generally advised as the default or minimum, it's not actually a hard requirement. We now recreate a table that's precisely enough (rounded of course). WHile
2014-03-19 21:44:51 +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.
*
* $FreeBSD$
*/
#ifndef _MKIMG_MKIMG_H_
#define _MKIMG_MKIMG_H_
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/queue.h>
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 <sys/types.h>
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
Add mkimg.h. It contains the 'part' structure definition and the linked list (STAILQ) so that it can be shared and re-used in all source files. Replace the now unneeded scheme_add_part() with scheme_check_part() for posterity. Also (should have been a separate commit), remove the enforcement of creating a GPT table with at least 128 entries. While this is generally advised as the default or minimum, it's not actually a hard requirement. We now recreate a table that's precisely enough (rounded of course). WHile
2014-03-19 21:44:51 +00:00
struct part {
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_ENTRY(part) link;
Check the partition type alias as defined by the scheme.
2014-03-20 02:27:25 +00:00
char *alias; /* Partition type alias. */
Add mkimg.h. It contains the 'part' structure definition and the linked list (STAILQ) so that it can be shared and re-used in all source files. Replace the now unneeded scheme_add_part() with scheme_check_part() for posterity. Also (should have been a separate commit), remove the enforcement of creating a GPT table with at least 128 entries. While this is generally advised as the default or minimum, it's not actually a hard requirement. We now recreate a table that's precisely enough (rounded of course). WHile
2014-03-19 21:44:51 +00:00
char *contents; /* Contents/size specification. */
u_int kind; /* Content kind. */
#define PART_UNDEF 0
#define PART_KIND_FILE 1
#define PART_KIND_PIPE 2
#define PART_KIND_SIZE 3
u_int index; /* Partition index (0-based). */
Dump my WIP of write support for GPT. This compiles, appears to be complete, but isn't accepted by g_part_gpt. Time to debug and fix.
2014-03-21 03:27:42 +00:00
uintptr_t type; /* Scheme-specific partition type. */
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
lba_t block; /* Block-offset of partition in image. */
lba_t size; /* Size in blocks of partition. */
Add support for partition labels and write them for GPT.
2014-03-21 05:30:27 +00:00
char *label; /* Partition label. */
Add mkimg.h. It contains the 'part' structure definition and the linked list (STAILQ) so that it can be shared and re-used in all source files. Replace the now unneeded scheme_add_part() with scheme_check_part() for posterity. Also (should have been a separate commit), remove the enforcement of creating a GPT table with at least 128 entries. While this is generally advised as the default or minimum, it's not actually a hard requirement. We now recreate a table that's precisely enough (rounded of course). WHile
2014-03-19 21:44:51 +00:00
};
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
extern TAILQ_HEAD(partlisthead, part) partlist;
Add mkimg.h. It contains the 'part' structure definition and the linked list (STAILQ) so that it can be shared and re-used in all source files. Replace the now unneeded scheme_add_part() with scheme_check_part() for posterity. Also (should have been a separate commit), remove the enforcement of creating a GPT table with at least 128 entries. While this is generally advised as the default or minimum, it's not actually a hard requirement. We now recreate a table that's precisely enough (rounded of course). WHile
2014-03-19 21:44:51 +00:00
extern u_int nparts;
Add option -y for unit testing. When unit_testing is in effect, fields that have different values for each run, such as UUIDs and timestamps, will have a synthesized value. This allows us to compare images against a known baseline without fails negatives. Add mkimg_uuid() that wraps uuidgen() and provides synthesized values for unit testing.
2014-06-28 04:18:55 +00:00
extern u_int unit_testing;
1. Add -v option to increase vebosity levels 2. Fix copy-paste bug -- acrually check secsz for being a power of 2 3. Check secsz and blksz parameters 4. Print the sector and block size when -v is given
2014-03-27 20:14:40 +00:00
extern u_int verbose;
First batch of media control: 1. Change -h to -H and change -t to -T. Use -H to specify the number of heads and -T to specify the track size (number of sectors per track). 2. Add -S and -P. Use -S to specify the logical sector size and -P to specify the physical sector size. Default to 512 for both the logical and physical sector size. Set nheads and nsecs to 1 by default.
2014-03-25 04:45:55 +00:00
extern u_int ncyls;
extern u_int nheads;
extern u_int nsecs;
extern u_int secsz; /* Logical block size. */
extern u_int blksz; /* Physical block size. */
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
extern uint32_t active_partition;
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
1. When calculating block addresses, round to the physical block size. 2. Replace scheme_first_block() & scheme_next_block() with scheme_metadata(). When we round to block sizes, we can't reliably fixup any miscalculations. 3. In scheme_write, calculate ncyls (number of cyclinders), based on the total size, sectors/track and number of heads. 4. Add verbosity when constructing the partitions. This includes the starting block address and size in bytes and blocks. 5. Add verbosity about the sectors/track and number of heads.
2014-03-27 22:45:05 +00:00
static inline lba_t
round_block(lba_t n)
{
lba_t b = blksz / secsz;
return ((n + b - 1) & ~(b - 1));
}
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 inline lba_t
round_cylinder(lba_t n)
{
u_int cyl = nsecs * nheads;
u_int r = n % cyl;
return ((r == 0) ? n : n + cyl - r);
}
static inline lba_t
round_track(lba_t n)
{
u_int r = n % nsecs;
return ((r == 0) ? n : n + nsecs - r);
}
Provide a file-based implementation for the image API. This almost copies the logic verbatim from mkimg.c to image.c. The difference is that in image.c the temporary file is always created, whereas before we only created a temporary file when writing to stdout. Cleanup mkimg.c now that the song and dance of using a temporary file is gone.
2014-05-07 22:06:54 +00:00
#if !defined(SPARSE_WRITE)
#define sparse_write write
#else
Give sparse_write() the same prototype as write(2) as it's supposed to be a drop-in replacement.
2014-05-15 14:37:35 +00:00
ssize_t sparse_write(int, const void *, size_t);
Provide a file-based implementation for the image API. This almost copies the logic verbatim from mkimg.c to image.c. The difference is that in image.c the temporary file is always created, whereas before we only created a temporary file when writing to stdout. Cleanup mkimg.c now that the song and dance of using a temporary file is gone.
2014-05-07 22:06:54 +00:00
#endif
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
void mkimg_chs(lba_t, u_int, u_int *, u_int *, u_int *);
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
struct mkimg_uuid {
uint32_t time_low;
uint16_t time_mid;
uint16_t time_hi_and_version;
uint8_t clock_seq_hi_and_reserved;
uint8_t clock_seq_low;
uint8_t node[6];
};
typedef struct mkimg_uuid mkimg_uuid_t;
void mkimg_uuid(mkimg_uuid_t *);
void mkimg_uuid_enc(void *, const mkimg_uuid_t *);
Add option -y for unit testing. When unit_testing is in effect, fields that have different values for each run, such as UUIDs and timestamps, will have a synthesized value. This allows us to compare images against a known baseline without fails negatives. Add mkimg_uuid() that wraps uuidgen() and provides synthesized values for unit testing.
2014-06-28 04:18:55 +00:00
Allow building mkimg as cross-tool For linux the mmap offset must also be page aligned, and we need to disable macros like __FBSDID() Change the linux osdep_uuidgen() to use more portable gettimeofday(). Reviewed by: marcel
2017-03-03 01:56:55 +00:00
#ifdef __linux__
# if !defined(__unused)
# define __unused __attribute__ ((__unused__))
# endif
#endif
Add mkimg.h. It contains the 'part' structure definition and the linked list (STAILQ) so that it can be shared and re-used in all source files. Replace the now unneeded scheme_add_part() with scheme_check_part() for posterity. Also (should have been a separate commit), remove the enforcement of creating a GPT table with at least 128 entries. While this is generally advised as the default or minimum, it's not actually a hard requirement. We now recreate a table that's precisely enough (rounded of course). WHile
2014-03-19 21:44:51 +00:00
#endif /* _MKIMG_MKIMG_H_ */
Reference in New Issue Copy Permalink