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/geom_dbg.h>
46#include <geom/label/g_label.h>
47
48#define	G_LABEL_UFS_VOLUME	0
49#define	G_LABEL_UFS_ID		1
50
51/*
52 * G_LABEL_UFS_CMP returns true if difference between provider mediasize
53 * and filesystem size is less than G_LABEL_UFS_MAXDIFF sectors
54 */
55#define	G_LABEL_UFS_CMP(prov, fsys, size) 				   \
56	( abs( ((fsys)->size) - ( (prov)->mediasize / (fsys)->fs_fsize ))  \
57				< G_LABEL_UFS_MAXDIFF )
58#define	G_LABEL_UFS_MAXDIFF	0x100
59
60/*
61 * Try to find a superblock on the provider. If successful, then
62 * check that the size in the superblock corresponds to the size
63 * of the underlying provider. Finally, look for a volume label
64 * and create an appropriate provider based on that.
65 */
66static void
67g_label_ufs_taste_common(struct g_consumer *cp, char *label, size_t size, int what)
68{
69	struct g_provider *pp;
70	struct fs *fs;
71
72	g_topology_assert_not();
73	pp = cp->provider;
74	label[0] = '\0';
75
76	fs = NULL;
77	if (SBLOCKSIZE % pp->sectorsize != 0 || ffs_sbget(cp, &fs,
78	    STDSB_NOHASHFAIL, M_GEOM, g_use_g_read_data) != 0) {
79		KASSERT(fs == NULL,
80		    ("g_label_ufs_taste_common: non-NULL fs %p\n", fs));
81		return;
82	}
83
84	/*
85	 * Check for magic. We also need to check if file system size
86	 * is almost equal to providers size, because sysinstall(8)
87	 * used to bogusly put first partition at offset 0
88	 * instead of 16, and glabel/ufs would find file system on slice
89	 * instead of partition.
90	 *
91	 * In addition, media size can be a bit bigger than file system
92	 * size. For instance, mkuzip can append bytes to align data
93	 * to large sector size (it improves compression rates).
94	 */
95	if (fs->fs_magic == FS_UFS1_MAGIC && fs->fs_fsize > 0 &&
96	    ( G_LABEL_UFS_CMP(pp, fs, fs_old_size)
97		|| G_LABEL_UFS_CMP(pp, fs, fs_providersize))) {
98		/* Valid UFS1. */
99	} else if (fs->fs_magic == FS_UFS2_MAGIC && fs->fs_fsize > 0 &&
100	    ( G_LABEL_UFS_CMP(pp, fs, fs_size)
101		|| G_LABEL_UFS_CMP(pp, fs, fs_providersize))) {
102		/* Valid UFS2. */
103	} else {
104		goto out;
105	}
106	G_LABEL_DEBUG(1, "%s file system detected on %s.",
107	    fs->fs_magic == FS_UFS1_MAGIC ? "UFS1" : "UFS2", pp->name);
108	switch (what) {
109	case G_LABEL_UFS_VOLUME:
110		/* Check for volume label */
111		if (fs->fs_volname[0] != '\0')
112			strlcpy(label, fs->fs_volname, size);
113		break;
114	case G_LABEL_UFS_ID:
115		if (fs->fs_id[0] != 0 || fs->fs_id[1] != 0)
116			snprintf(label, size, "%08x%08x", fs->fs_id[0],
117			    fs->fs_id[1]);
118		break;
119	}
120out:
121	g_free(fs->fs_csp);
122	g_free(fs->fs_si);
123	g_free(fs);
124}
125
126static void
127g_label_ufs_volume_taste(struct g_consumer *cp, char *label, size_t size)
128{
129
130	g_label_ufs_taste_common(cp, label, size, G_LABEL_UFS_VOLUME);
131}
132
133static void
134g_label_ufs_id_taste(struct g_consumer *cp, char *label, size_t size)
135{
136
137	g_label_ufs_taste_common(cp, label, size, G_LABEL_UFS_ID);
138}
139
140struct g_label_desc g_label_ufs_volume = {
141	.ld_taste = g_label_ufs_volume_taste,
142	.ld_dirprefix = "ufs/",
143	.ld_enabled = 1
144};
145
146struct g_label_desc g_label_ufs_id = {
147	.ld_taste = g_label_ufs_id_taste,
148	.ld_dirprefix = "ufsid/",
149	.ld_enabled = 1
150};
151
152G_LABEL_INIT(ufsid, g_label_ufs_id, "Create device nodes for UFS file system IDs");
153G_LABEL_INIT(ufs, g_label_ufs_volume, "Create device nodes for UFS volume names");
154
155MODULE_DEPEND(g_label, ufs, 1, 1, 1);
156