xref: /freebsd/sys/geom/label/g_label_ufs.c (revision e0656a491411fe65ed8b9135add026358b24951f)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2002, 2003 Gordon Tetlow
5  * Copyright (c) 2006 Pawel Jakub Dawidek <pjd@FreeBSD.org>
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32 
33 #include <sys/param.h>
34 #include <sys/systm.h>
35 #include <sys/malloc.h>
36 #include <sys/vnode.h>
37 
38 #include <ufs/ufs/dinode.h>
39 #include <ufs/ffs/fs.h>
40 #include <ufs/ufs/quota.h>
41 #include <ufs/ufs/extattr.h>
42 #include <ufs/ffs/ffs_extern.h>
43 
44 #include <geom/geom.h>
45 #include <geom/label/g_label.h>
46 
47 #define G_LABEL_UFS_VOLUME_DIR	"ufs"
48 #define G_LABEL_UFS_ID_DIR	"ufsid"
49 
50 #define	G_LABEL_UFS_VOLUME	0
51 #define	G_LABEL_UFS_ID		1
52 
53 /*
54  * G_LABEL_UFS_CMP returns true if difference between provider mediasize
55  * and filesystem size is less than G_LABEL_UFS_MAXDIFF sectors
56  */
57 #define	G_LABEL_UFS_CMP(prov, fsys, size) 				   \
58 	( abs( ((fsys)->size) - ( (prov)->mediasize / (fsys)->fs_fsize ))  \
59 				< G_LABEL_UFS_MAXDIFF )
60 #define	G_LABEL_UFS_MAXDIFF	0x100
61 
62 /*
63  * Try to find a superblock on the provider. If successful, then
64  * check that the size in the superblock corresponds to the size
65  * of the underlying provider. Finally, look for a volume label
66  * and create an appropriate provider based on that.
67  */
68 static void
69 g_label_ufs_taste_common(struct g_consumer *cp, char *label, size_t size, int what)
70 {
71 	struct g_provider *pp;
72 	struct fs *fs;
73 
74 	g_topology_assert_not();
75 	pp = cp->provider;
76 	label[0] = '\0';
77 
78 	if (SBLOCKSIZE % pp->sectorsize != 0 ||
79 	    ffs_sbget(cp, &fs, -1, NULL, g_use_g_read_data) != 0)
80 		return;
81 	/*
82 	 * Check for magic. We also need to check if file system size
83 	 * is almost equal to providers size, because sysinstall(8)
84 	 * used to bogusly put first partition at offset 0
85 	 * instead of 16, and glabel/ufs would find file system on slice
86 	 * instead of partition.
87 	 *
88 	 * In addition, media size can be a bit bigger than file system
89 	 * size. For instance, mkuzip can append bytes to align data
90 	 * to large sector size (it improves compression rates).
91 	 */
92 	if (fs->fs_magic == FS_UFS1_MAGIC && fs->fs_fsize > 0 &&
93 	    ( G_LABEL_UFS_CMP(pp, fs, fs_old_size)
94 		|| G_LABEL_UFS_CMP(pp, fs, fs_providersize))) {
95 		/* Valid UFS1. */
96 	} else if (fs->fs_magic == FS_UFS2_MAGIC && fs->fs_fsize > 0 &&
97 	    ( G_LABEL_UFS_CMP(pp, fs, fs_size)
98 		|| G_LABEL_UFS_CMP(pp, fs, fs_providersize))) {
99 		/* Valid UFS2. */
100 	} else {
101 		g_free(fs);
102 		return;
103 	}
104 	G_LABEL_DEBUG(1, "%s file system detected on %s.",
105 	    fs->fs_magic == FS_UFS1_MAGIC ? "UFS1" : "UFS2", pp->name);
106 	switch (what) {
107 	case G_LABEL_UFS_VOLUME:
108 		/* Check for volume label */
109 		if (fs->fs_volname[0] != '\0')
110 			strlcpy(label, fs->fs_volname, size);
111 		break;
112 	case G_LABEL_UFS_ID:
113 		if (fs->fs_id[0] != 0 || fs->fs_id[1] != 0)
114 			snprintf(label, size, "%08x%08x", fs->fs_id[0],
115 			    fs->fs_id[1]);
116 		break;
117 	}
118 	g_free(fs);
119 }
120 
121 static void
122 g_label_ufs_volume_taste(struct g_consumer *cp, char *label, size_t size)
123 {
124 
125 	g_label_ufs_taste_common(cp, label, size, G_LABEL_UFS_VOLUME);
126 }
127 
128 static void
129 g_label_ufs_id_taste(struct g_consumer *cp, char *label, size_t size)
130 {
131 
132 	g_label_ufs_taste_common(cp, label, size, G_LABEL_UFS_ID);
133 }
134 
135 struct g_label_desc g_label_ufs_volume = {
136 	.ld_taste = g_label_ufs_volume_taste,
137 	.ld_dir = G_LABEL_UFS_VOLUME_DIR,
138 	.ld_enabled = 1
139 };
140 
141 struct g_label_desc g_label_ufs_id = {
142 	.ld_taste = g_label_ufs_id_taste,
143 	.ld_dir = G_LABEL_UFS_ID_DIR,
144 	.ld_enabled = 1
145 };
146 
147 G_LABEL_INIT(ufsid, g_label_ufs_id, "Create device nodes for UFS file system IDs");
148 G_LABEL_INIT(ufs, g_label_ufs_volume, "Create device nodes for UFS volume names");
149