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

48 lines
1.9 KiB
C
Raw Normal View History

Add image.c and image.h. These files will contain functions to implement the management of the raw image that's being created. The most notable of the API is that there's no file descriptor argument. This is because the image is managed in memory. Once we have the in-memory (raw) image, we can write it out acording to different formats. This two-pass approach shields schemes from formats and formats from schemes.
2014-05-07 17:12:15 +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_IMAGE_H_
#define _MKIMG_IMAGE_H_
Allow bootstrapping mkimg on macOS/Linux On these systems the (u)int64_t typedefs will not be implicitly defined by the previous includes, so include <stdint.h> in the header that uses uint64_t. Reviewed By: brooks Differential Revision: https://reviews.freebsd.org/D23202
2020-01-16 14:14:55 +00:00
#include <stdint.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
typedef int64_t lba_t;
Add image.c and image.h. These files will contain functions to implement the management of the raw image that's being created. The most notable of the API is that there's no file descriptor argument. This is because the image is managed in memory. Once we have the in-memory (raw) image, we can write it out acording to different formats. This two-pass approach shields schemes from formats and formats from schemes.
2014-05-07 17:12:15 +00:00
int image_copyin(lba_t blk, int fd, uint64_t *sizep);
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
int image_copyout(int fd);
Add image_data() for checking whether a sequence of blocks has data. Use this for VHD and VMDK to avoid allocating space in the image for empty sectors. Note that this negatively affects performance because mkimg uses a temporary file for the intermediate storage. When mkimg has better internal book keeping, performance can be significantly improved.
2014-07-15 04:39:23 +00:00
int image_copyout_done(int fd);
Add image_copyout_region(). It allows a format to write chunks of the image interleaved with metadata.
2014-06-28 04:10:46 +00:00
int image_copyout_region(int fd, lba_t blk, lba_t size);
Make image_copyout_zeroes() an interface function.
2015-08-03 01:24:48 +00:00
int image_copyout_zeroes(int fd, size_t count);
Add image_data() for checking whether a sequence of blocks has data. Use this for VHD and VMDK to avoid allocating space in the image for empty sectors. Note that this negatively affects performance because mkimg uses a temporary file for the intermediate storage. When mkimg has better internal book keeping, performance can be significantly improved.
2014-07-15 04:39:23 +00:00
int image_data(lba_t blk, lba_t size);
Add image_get_size() so formats can query about the image size. Create the VMDK (embedded) descriptor file and round its size to a multiple of 512. TODO: We need the name of the output file -- it's in the extent description. For now, just use "mkimg.vmdk".
2014-05-09 01:13:14 +00:00
lba_t image_get_size(void);
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
int image_init(void);
Add image.c and image.h. These files will contain functions to implement the management of the raw image that's being created. The most notable of the API is that there's no file descriptor argument. This is because the image is managed in memory. Once we have the in-memory (raw) image, we can write it out acording to different formats. This two-pass approach shields schemes from formats and formats from schemes.
2014-05-07 17:12:15 +00:00
int image_set_size(lba_t blk);
int image_write(lba_t blk, void *buf, ssize_t len);
#endif /* _MKIMG_IMAGE_H_ */
Reference in New Issue Copy Permalink