sys/geom/label/g_label_ufs.c

   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         fs = NULL;
  79         if (SBLOCKSIZE % pp->sectorsize != 0 ||
  80             ffs_sbget(cp, &fs, STDSB, M_GEOM, g_use_g_read_data) != 0) {
  81                 KASSERT(fs == NULL,
  82                     ("g_label_ufs_taste_common: non-NULL fs %p\n", fs));
  83                 return;
  84         }
  85
  86         /*
  87          * Check for magic. We also need to check if file system size
  88          * is almost equal to providers size, because sysinstall(8)
  89          * used to bogusly put first partition at offset 0
  90          * instead of 16, and glabel/ufs would find file system on slice
  91          * instead of partition.
  92          *
  93          * In addition, media size can be a bit bigger than file system
  94          * size. For instance, mkuzip can append bytes to align data
  95          * to large sector size (it improves compression rates).
  96          */
  97         if (fs->fs_magic == FS_UFS1_MAGIC && fs->fs_fsize > 0 &&
  98             ( G_LABEL_UFS_CMP(pp, fs, fs_old_size)
  99                 || G_LABEL_UFS_CMP(pp, fs, fs_providersize))) {
 100                 /* Valid UFS1. */
 101         } else if (fs->fs_magic == FS_UFS2_MAGIC && fs->fs_fsize > 0 &&
 102             ( G_LABEL_UFS_CMP(pp, fs, fs_size)
 103                 || G_LABEL_UFS_CMP(pp, fs, fs_providersize))) {
 104                 /* Valid UFS2. */
 105         } else {
 106                 goto out;
 107         }
 108         G_LABEL_DEBUG(1, "%s file system detected on %s.",
 109             fs->fs_magic == FS_UFS1_MAGIC ? "UFS1" : "UFS2", pp->name);
 110         switch (what) {
 111         case G_LABEL_UFS_VOLUME:
 112                 /* Check for volume label */
 113                 if (fs->fs_volname[0] != '\0')
 114                         strlcpy(label, fs->fs_volname, size);
 115                 break;
 116         case G_LABEL_UFS_ID:
 117                 if (fs->fs_id[0] != 0 || fs->fs_id[1] != 0)
 118                         snprintf(label, size, "%08x%08x", fs->fs_id[0],
 119                             fs->fs_id[1]);
 120                 break;
 121         }
 122 out:
 123         g_free(fs->fs_csp);
 124         g_free(fs);
 125 }
 126
 127 static void
 128 g_label_ufs_volume_taste(struct g_consumer *cp, char *label, size_t size)
 129 {
 130
 131         g_label_ufs_taste_common(cp, label, size, G_LABEL_UFS_VOLUME);
 132 }
 133
 134 static void
 135 g_label_ufs_id_taste(struct g_consumer *cp, char *label, size_t size)
 136 {
 137
 138         g_label_ufs_taste_common(cp, label, size, G_LABEL_UFS_ID);
 139 }
 140
 141 struct g_label_desc g_label_ufs_volume = {
 142         .ld_taste = g_label_ufs_volume_taste,
 143         .ld_dir = G_LABEL_UFS_VOLUME_DIR,
 144         .ld_enabled = 1
 145 };
 146
 147 struct g_label_desc g_label_ufs_id = {
 148         .ld_taste = g_label_ufs_id_taste,
 149         .ld_dir = G_LABEL_UFS_ID_DIR,
 150         .ld_enabled = 1
 151 };
 152
 153 G_LABEL_INIT(ufsid, g_label_ufs_id, "Create device nodes for UFS file system IDs");
 154 G_LABEL_INIT(ufs, g_label_ufs_volume, "Create device nodes for UFS volume names");
 155
 156 MODULE_DEPEND(g_label, ufs, 1, 1, 1);