xref: /freebsd/sbin/newfs/newfs.h (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 2002 Networks Associates Technology, Inc.
5  * All rights reserved.
6  *
7  * This software was developed for the FreeBSD Project by Marshall
8  * Kirk McKusick and Network Associates Laboratories, the Security
9  * Research Division of Network Associates, Inc. under DARPA/SPAWAR
10  * contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
11  * research program.
12  *
13  * Copyright (c) 1980, 1989, 1993
14  *	The Regents of the University of California.  All rights reserved.
15  *
16  * Redistribution and use in source and binary forms, with or without
17  * modification, are permitted provided that the following conditions
18  * are met:
19  * 1. Redistributions of source code must retain the above copyright
20  *    notice, this list of conditions and the following disclaimer.
21  * 2. Redistributions in binary form must reproduce the above copyright
22  *    notice, this list of conditions and the following disclaimer in the
23  *    documentation and/or other materials provided with the distribution.
24  * 3. Neither the name of the University nor the names of its contributors
25  *    may be used to endorse or promote products derived from this software
26  *    without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38  * SUCH DAMAGE.
39  */
40 
41 #include <libufs.h>
42 
43 /*
44  * The following two constants set the default block and fragment sizes.
45  * Both constants must be a power of 2 and meet the following constraints:
46  *	MINBSIZE <= DESBLKSIZE <= MAXBSIZE
47  *	sectorsize <= DESFRAGSIZE <= DESBLKSIZE
48  *	DESBLKSIZE / DESFRAGSIZE <= 8
49  */
50 #define	DFL_FRAGSIZE	4096
51 #define	DFL_BLKSIZE	32768
52 
53 /*
54  * Cylinder groups may have up to MAXBLKSPERCG blocks. The actual
55  * number used depends upon how much information can be stored
56  * in a cylinder group map which must fit in a single file system
57  * block. The default is to use as many as possible blocks per group.
58  */
59 #define	MAXBLKSPERCG	0x7fffffff	/* desired fs_fpg ("infinity") */
60 
61 /*
62  * MAXBLKPG determines the maximum number of data blocks which are
63  * placed in a single cylinder group. The default is one indirect
64  * block worth of data blocks.
65  */
66 #define MAXBLKPG(bsize)	((bsize) / sizeof(ufs2_daddr_t))
67 
68 /*
69  * Each file system has a number of inodes statically allocated.
70  * We allocate one inode slot per NFPI fragments, expecting this
71  * to be far more than we will ever need.
72  */
73 #define	NFPI		2
74 
75 /*
76  * variables set up by front end.
77  */
78 extern int	Eflag;		/* Erase previous disk contents */
79 extern int	Lflag;		/* add a volume label */
80 extern int	Nflag;		/* run mkfs without writing file system */
81 extern int	Oflag;		/* build UFS1 format file system */
82 extern int	Rflag;		/* regression test */
83 extern int	Uflag;		/* enable soft updates for file system */
84 extern int	jflag;		/* enable soft updates journaling for filesys */
85 extern int	Xflag;		/* exit in middle of newfs for testing */
86 extern int	Jflag;		/* enable gjournal for file system */
87 extern int	lflag;		/* enable multilabel MAC for file system */
88 extern int	nflag;		/* do not create .snap directory */
89 extern int	tflag;		/* enable TRIM */
90 extern intmax_t	fssize;		/* file system size */
91 extern off_t	mediasize;	/* device size */
92 extern int	sectorsize;	/* bytes/sector */
93 extern int	realsectorsize;	/* bytes/sector in hardware*/
94 extern int	fsize;		/* fragment size */
95 extern int	bsize;		/* block size */
96 extern int	maxbsize;	/* maximum clustering */
97 extern int	maxblkspercg;	/* maximum blocks per cylinder group */
98 extern int	minfree;	/* free space threshold */
99 extern int	metaspace;	/* space held for metadata blocks */
100 extern int	opt;		/* optimization preference (space or time) */
101 extern int	density;	/* number of bytes per inode */
102 extern int	maxcontig;	/* max contiguous blocks to allocate */
103 extern int	maxbpg;		/* maximum blocks per file in a cyl group */
104 extern int	avgfilesize;	/* expected average file size */
105 extern int	avgfilesperdir;	/* expected number of files per directory */
106 extern u_char	*volumelabel;	/* volume label for filesystem */
107 extern struct uufsd disk;	/* libufs disk structure */
108 
109 /*
110  * To override a limitation in libufs, export the offset (in sectors) of the
111  * partition on the underlying media (file or disk). The value is used as
112  * an offset for all accesses to the media through bread(), which is only
113  * invoked directly in this program.
114  * For bwrite() we need a different approach, namely override the library
115  * version with one defined here. This is because bwrite() is called also
116  * by the library function sbwrite() which we cannot intercept nor want to
117  * rewrite. As a consequence, the internal version of bwrite() adds the
118  * partition offset itself when calling the underlying function, pwrite().
119  *
120  * XXX This info really ought to go into the struct uufsd, at which point
121  * we can remove the above hack.
122  */
123 extern ufs2_daddr_t part_ofs;	/* partition offset in blocks */
124 
125 void mkfs (struct partition *, char *);
126