307 lines
9.9 KiB
C
307 lines
9.9 KiB
C
/* $NetBSD: makefs.h,v 1.20 2008/12/28 21:51:46 christos Exp $ */
|
|
|
|
/*-
|
|
* SPDX-License-Identifier: BSD-4-Clause
|
|
*
|
|
* Copyright (c) 2001 Wasabi Systems, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* Written by Luke Mewburn for Wasabi Systems, Inc.
|
|
*
|
|
* 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.
|
|
* 3. All advertising materials mentioning features or use of this software
|
|
* must display the following acknowledgement:
|
|
* This product includes software developed for the NetBSD Project by
|
|
* Wasabi Systems, Inc.
|
|
* 4. The name of Wasabi Systems, Inc. may not be used to endorse
|
|
* or promote products derived from this software without specific prior
|
|
* written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``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 WASABI SYSTEMS, INC
|
|
* 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 _MAKEFS_H
|
|
#define _MAKEFS_H
|
|
|
|
#include <sys/stat.h>
|
|
#include <err.h>
|
|
|
|
/*
|
|
* fsnode -
|
|
* a component of the tree; contains a filename, a pointer to
|
|
* fsinode, optional symlink name, and tree pointers
|
|
*
|
|
* fsinode -
|
|
* equivalent to an inode, containing target file system inode number,
|
|
* refcount (nlink), and stat buffer
|
|
*
|
|
* A tree of fsnodes looks like this:
|
|
*
|
|
* name "." "bin" "netbsd"
|
|
* type S_IFDIR S_IFDIR S_IFREG
|
|
* next > > NULL
|
|
* parent NULL NULL NULL
|
|
* child NULL v
|
|
*
|
|
* name "." "ls"
|
|
* type S_IFDIR S_IFREG
|
|
* next > NULL
|
|
* parent ^ ^ (to "bin")
|
|
* child NULL NULL
|
|
*
|
|
* Notes:
|
|
* - first always points to first entry, at current level, which
|
|
* must be "." when the tree has been built; during build it may
|
|
* not be if "." hasn't yet been found by readdir(2).
|
|
*/
|
|
|
|
enum fi_flags {
|
|
FI_SIZED = 1<<0, /* inode sized */
|
|
FI_ALLOCATED = 1<<1, /* fsinode->ino allocated */
|
|
FI_WRITTEN = 1<<2, /* inode written */
|
|
};
|
|
|
|
typedef struct {
|
|
uint32_t ino; /* inode number used on target fs */
|
|
uint32_t nlink; /* number of links to this entry */
|
|
enum fi_flags flags; /* flags used by fs specific code */
|
|
struct stat st; /* stat entry */
|
|
} fsinode;
|
|
|
|
typedef struct _fsnode {
|
|
struct _fsnode *parent; /* parent (NULL if root) */
|
|
struct _fsnode *child; /* child (if type == S_IFDIR) */
|
|
struct _fsnode *next; /* next */
|
|
struct _fsnode *first; /* first node of current level (".") */
|
|
uint32_t type; /* type of entry */
|
|
fsinode *inode; /* actual inode data */
|
|
char *symlink; /* symlink target */
|
|
char *contents; /* file to provide contents */
|
|
const char *root; /* root path */
|
|
char *path; /* directory name */
|
|
char *name; /* file name */
|
|
int flags; /* misc flags */
|
|
} fsnode;
|
|
|
|
#define FSNODE_F_HASSPEC 0x01 /* fsnode has a spec entry */
|
|
#define FSNODE_F_OPTIONAL 0x02 /* fsnode is optional */
|
|
|
|
/*
|
|
* option_t - contains option name, description, pointer to location to store
|
|
* result, and range checks for the result. Used to simplify fs specific
|
|
* option setting
|
|
*/
|
|
typedef enum {
|
|
OPT_STRARRAY,
|
|
OPT_STRPTR,
|
|
OPT_STRBUF,
|
|
OPT_BOOL,
|
|
OPT_INT8,
|
|
OPT_INT16,
|
|
OPT_INT32,
|
|
OPT_INT64
|
|
} opttype_t;
|
|
|
|
typedef struct {
|
|
char letter; /* option letter NUL for none */
|
|
const char *name; /* option name */
|
|
void *value; /* where to stuff the value */
|
|
opttype_t type; /* type of entry */
|
|
long long minimum; /* minimum for value */
|
|
long long maximum; /* maximum for value */
|
|
const char *desc; /* option description */
|
|
} option_t;
|
|
|
|
/*
|
|
* fsinfo_t - contains various settings and parameters pertaining to
|
|
* the image, including current settings, global options, and fs
|
|
* specific options
|
|
*/
|
|
typedef struct makefs_fsinfo {
|
|
/* current settings */
|
|
off_t size; /* total size */
|
|
off_t inodes; /* number of inodes */
|
|
uint32_t curinode; /* current inode */
|
|
|
|
/* image settings */
|
|
int fd; /* file descriptor of image */
|
|
void *superblock; /* superblock */
|
|
int onlyspec; /* only add entries in specfile */
|
|
|
|
|
|
/* global options */
|
|
off_t minsize; /* minimum size image should be */
|
|
off_t maxsize; /* maximum size image can be */
|
|
off_t freefiles; /* free file entries to leave */
|
|
off_t freeblocks; /* free blocks to leave */
|
|
off_t offset; /* offset from start of file */
|
|
off_t roundup; /* round image size up to this value */
|
|
int freefilepc; /* free file % */
|
|
int freeblockpc; /* free block % */
|
|
int needswap; /* non-zero if byte swapping needed */
|
|
int sectorsize; /* sector size */
|
|
int sparse; /* sparse image, don't fill it with zeros */
|
|
|
|
void *fs_specific; /* File system specific additions. */
|
|
option_t *fs_options; /* File system specific options */
|
|
} fsinfo_t;
|
|
|
|
|
|
void apply_specfile(const char *, const char *, fsnode *, int);
|
|
void dump_fsnodes(fsnode *);
|
|
const char * inode_type(mode_t);
|
|
fsnode * read_mtree(const char *, fsnode *);
|
|
int set_option(const option_t *, const char *, char *, size_t);
|
|
int set_option_var(const option_t *, const char *, const char *,
|
|
char *, size_t);
|
|
fsnode * walk_dir(const char *, const char *, fsnode *, fsnode *);
|
|
void free_fsnodes(fsnode *);
|
|
option_t * copy_opts(const option_t *);
|
|
|
|
#define DECLARE_FUN(fs) \
|
|
void fs ## _prep_opts(fsinfo_t *); \
|
|
int fs ## _parse_opts(const char *, fsinfo_t *); \
|
|
void fs ## _cleanup_opts(fsinfo_t *); \
|
|
void fs ## _makefs(const char *, const char *, fsnode *, fsinfo_t *)
|
|
|
|
DECLARE_FUN(cd9660);
|
|
DECLARE_FUN(ffs);
|
|
DECLARE_FUN(msdos);
|
|
|
|
extern u_int debug;
|
|
extern int dupsok;
|
|
extern struct timespec start_time;
|
|
extern struct stat stampst;
|
|
|
|
/*
|
|
* If -x is specified, we want to exclude nodes which do not appear
|
|
* in the spec file.
|
|
*/
|
|
#define FSNODE_EXCLUDE_P(opts, fsnode) \
|
|
((opts)->onlyspec != 0 && ((fsnode)->flags & FSNODE_F_HASSPEC) == 0)
|
|
|
|
#define DEBUG_TIME 0x00000001
|
|
/* debug bits 1..3 unused at this time */
|
|
#define DEBUG_WALK_DIR 0x00000010
|
|
#define DEBUG_WALK_DIR_NODE 0x00000020
|
|
#define DEBUG_WALK_DIR_LINKCHECK 0x00000040
|
|
#define DEBUG_DUMP_FSNODES 0x00000080
|
|
#define DEBUG_DUMP_FSNODES_VERBOSE 0x00000100
|
|
#define DEBUG_FS_PARSE_OPTS 0x00000200
|
|
#define DEBUG_FS_MAKEFS 0x00000400
|
|
#define DEBUG_FS_VALIDATE 0x00000800
|
|
#define DEBUG_FS_CREATE_IMAGE 0x00001000
|
|
#define DEBUG_FS_SIZE_DIR 0x00002000
|
|
#define DEBUG_FS_SIZE_DIR_NODE 0x00004000
|
|
#define DEBUG_FS_SIZE_DIR_ADD_DIRENT 0x00008000
|
|
#define DEBUG_FS_POPULATE 0x00010000
|
|
#define DEBUG_FS_POPULATE_DIRBUF 0x00020000
|
|
#define DEBUG_FS_POPULATE_NODE 0x00040000
|
|
#define DEBUG_FS_WRITE_FILE 0x00080000
|
|
#define DEBUG_FS_WRITE_FILE_BLOCK 0x00100000
|
|
#define DEBUG_FS_MAKE_DIRBUF 0x00200000
|
|
#define DEBUG_FS_WRITE_INODE 0x00400000
|
|
#define DEBUG_BUF_BREAD 0x00800000
|
|
#define DEBUG_BUF_BWRITE 0x01000000
|
|
#define DEBUG_BUF_GETBLK 0x02000000
|
|
#define DEBUG_APPLY_SPECFILE 0x04000000
|
|
#define DEBUG_APPLY_SPECENTRY 0x08000000
|
|
#define DEBUG_APPLY_SPECONLY 0x10000000
|
|
#define DEBUG_MSDOSFS 0x20000000
|
|
|
|
|
|
#define TIMER_START(x) \
|
|
if (debug & DEBUG_TIME) \
|
|
gettimeofday(&(x), NULL)
|
|
|
|
#define TIMER_RESULTS(x,d) \
|
|
if (debug & DEBUG_TIME) { \
|
|
struct timeval end, td; \
|
|
gettimeofday(&end, NULL); \
|
|
timersub(&end, &(x), &td); \
|
|
printf("%s took %lld.%06ld seconds\n", \
|
|
(d), (long long)td.tv_sec, \
|
|
(long)td.tv_usec); \
|
|
}
|
|
|
|
|
|
#ifndef DEFAULT_FSTYPE
|
|
#define DEFAULT_FSTYPE "ffs"
|
|
#endif
|
|
|
|
|
|
/*
|
|
* ffs specific settings
|
|
* ---------------------
|
|
*/
|
|
|
|
#define FFS_EI /* for opposite endian support in ffs headers */
|
|
|
|
/*
|
|
* Write-arounds/compat shims for endian-agnostic support.
|
|
* These belong in the kernel if/when it's possible to mount
|
|
* filesystems w/ either byte order.
|
|
*/
|
|
|
|
/*
|
|
* File system internal flags, also in fs_flags.
|
|
* (Pick highest number to avoid conflicts with others)
|
|
*/
|
|
#define FS_SWAPPED 0x80000000 /* file system is endian swapped */
|
|
#define FS_INTERNAL 0x80000000 /* mask for internal flags */
|
|
|
|
#define FS_ISCLEAN 1
|
|
|
|
#define DINODE1_SIZE (sizeof(struct ufs1_dinode))
|
|
#define DINODE2_SIZE (sizeof(struct ufs2_dinode))
|
|
|
|
#define UFS1_MAXSYMLINKLEN ((UFS_NDADDR + UFS_NIADDR) * sizeof(ufs1_daddr_t))
|
|
#define UFS2_MAXSYMLINKLEN ((UFS_NDADDR + UFS_NIADDR) * sizeof(ufs2_daddr_t))
|
|
|
|
#if (BYTE_ORDER == LITTLE_ENDIAN)
|
|
#define DIRSIZ_SWAP(oldfmt, dp, needswap) \
|
|
(((oldfmt) && !(needswap)) ? \
|
|
DIRECTSIZ((dp)->d_type) : DIRECTSIZ((dp)->d_namlen))
|
|
#else
|
|
#define DIRSIZ_SWAP(oldfmt, dp, needswap) \
|
|
(((oldfmt) && (needswap)) ? \
|
|
DIRECTSIZ((dp)->d_type) : DIRECTSIZ((dp)->d_namlen))
|
|
#endif
|
|
|
|
#define cg_chkmagic_swap(cgp, ns) \
|
|
(ufs_rw32((cgp)->cg_magic, (ns)) == CG_MAGIC)
|
|
#define cg_inosused_swap(cgp, ns) \
|
|
((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_iusedoff, (ns))))
|
|
#define cg_blksfree_swap(cgp, ns) \
|
|
((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_freeoff, (ns))))
|
|
#define cg_clustersfree_swap(cgp, ns) \
|
|
((u_int8_t *)((u_int8_t *)(cgp) + ufs_rw32((cgp)->cg_clusteroff, (ns))))
|
|
#define cg_clustersum_swap(cgp, ns) \
|
|
((int32_t *)((uintptr_t)(cgp) + ufs_rw32((cgp)->cg_clustersumoff, ns)))
|
|
|
|
struct fs;
|
|
void ffs_fragacct_swap(struct fs *, int, uint32_t [], int, int);
|
|
|
|
fsinode *link_check(fsinode *);
|
|
|
|
#endif /* _MAKEFS_H */
|