d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ace52aef3d
freebsd-skq/scheme.h

87 lines
2.6 KiB
C
Raw Normal View History

Safe WIP: mkimg is a user-space utility for creating disk images. In its current form and shape, it creates images with the correct partition contents and overall image layout. What it doesn't do yet is actually scribble the metadata, such as partition tables and boot code. This is where I'd like to leverage code from other places, such as geom_part, and if possible/feasible. Also, the utility should be a little bit smarter about files and pipes so that we create temporary files only when needed (e.g. when we don't know the size of a partition's contents in advance while wrting the image to stdout).
2013-08-04 02:37:05 +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
* Copyright (c) 2013,2014 Juniper Networks, Inc.
Safe WIP: mkimg is a user-space utility for creating disk images. In its current form and shape, it creates images with the correct partition contents and overall image layout. What it doesn't do yet is actually scribble the metadata, such as partition tables and boot code. This is where I'd like to leverage code from other places, such as geom_part, and if possible/feasible. Also, the utility should be a little bit smarter about files and pipes so that we create temporary files only when needed (e.g. when we don't know the size of a partition's contents in advance while wrting the image to stdout).
2013-08-04 02:37:05 +00:00
* 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_SCHEME_H_
#define _MKIMG_SCHEME_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/linker_set.h>
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
enum alias {
ALIAS_NONE, /* Keep first! */
/* start */
ALIAS_EFI,
ALIAS_FREEBSD,
ALIAS_FREEBSD_BOOT,
ALIAS_FREEBSD_NANDFS,
ALIAS_FREEBSD_SWAP,
ALIAS_FREEBSD_UFS,
ALIAS_FREEBSD_VINUM,
ALIAS_FREEBSD_ZFS,
ALIAS_MBR,
/* end */
ALIAS_COUNT /* 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
struct mkimg_alias {
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
u_int alias;
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;
#define ALIAS_PTR2TYPE(p) (uintptr_t)(p)
#define ALIAS_INT2TYPE(i) (i)
#define ALIAS_TYPE2PTR(p) (void *)(p)
#define ALIAS_TYPE2INT(i) (i)
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
};
struct mkimg_scheme {
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
const char *name;
const char *description;
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
struct mkimg_alias *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
u_int (*metadata)(u_int, u_int, u_int);
#define SCHEME_META_IMG_START 1
#define SCHEME_META_IMG_END 2
#define SCHEME_META_PART_BEFORE 3
#define SCHEME_META_PART_AFTER 4
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
int (*write)(int, off_t, u_int, u_int);
Add support for partition labels and write them for GPT.
2014-03-21 05:30:27 +00:00
u_int nparts;
u_int labellen;
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
};
SET_DECLARE(schemes, struct mkimg_scheme);
#define SCHEME_DEFINE(nm) DATA_SET(schemes, nm)
Safe WIP: mkimg is a user-space utility for creating disk images. In its current form and shape, it creates images with the correct partition contents and overall image layout. What it doesn't do yet is actually scribble the metadata, such as partition tables and boot code. This is where I'd like to leverage code from other places, such as geom_part, and if possible/feasible. Also, the utility should be a little bit smarter about files and pipes so that we create temporary files only when needed (e.g. when we don't know the size of a partition's contents in advance while wrting the image to stdout).
2013-08-04 02:37:05 +00:00
int scheme_select(const char *);
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
struct mkimg_scheme *scheme_selected(void);
Safe WIP: mkimg is a user-space utility for creating disk images. In its current form and shape, it creates images with the correct partition contents and overall image layout. What it doesn't do yet is actually scribble the metadata, such as partition tables and boot code. This is where I'd like to leverage code from other places, such as geom_part, and if possible/feasible. Also, the utility should be a little bit smarter about files and pipes so that we create temporary files only when needed (e.g. when we don't know the size of a partition's contents in advance while wrting the image to stdout).
2013-08-04 02:37:05 +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
int scheme_check_part(struct part *);
Safe WIP: mkimg is a user-space utility for creating disk images. In its current form and shape, it creates images with the correct partition contents and overall image layout. What it doesn't do yet is actually scribble the metadata, such as partition tables and boot code. This is where I'd like to leverage code from other places, such as geom_part, and if possible/feasible. Also, the utility should be a little bit smarter about files and pipes so that we create temporary files only when needed (e.g. when we don't know the size of a partition's contents in advance while wrting the image to stdout).
2013-08-04 02:37:05 +00:00
u_int scheme_max_parts(void);
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
uint64_t scheme_round(uint64_t);
Safe WIP: mkimg is a user-space utility for creating disk images. In its current form and shape, it creates images with the correct partition contents and overall image layout. What it doesn't do yet is actually scribble the metadata, such as partition tables and boot code. This is where I'd like to leverage code from other places, such as geom_part, and if possible/feasible. Also, the utility should be a little bit smarter about files and pipes so that we create temporary files only when needed (e.g. when we don't know the size of a partition's contents in advance while wrting the image to stdout).
2013-08-04 02:37:05 +00:00
off_t scheme_first_offset(u_int);
off_t scheme_next_offset(off_t, uint64_t);
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
int scheme_write(int, off_t);
Safe WIP: mkimg is a user-space utility for creating disk images. In its current form and shape, it creates images with the correct partition contents and overall image layout. What it doesn't do yet is actually scribble the metadata, such as partition tables and boot code. This is where I'd like to leverage code from other places, such as geom_part, and if possible/feasible. Also, the utility should be a little bit smarter about files and pipes so that we create temporary files only when needed (e.g. when we don't know the size of a partition's contents in advance while wrting the image to stdout).
2013-08-04 02:37:05 +00:00
#endif /* _MKIMG_SCHEME_H_ */
Reference in New Issue Copy Permalink