sys/geom/part/g_part.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2006-2008 Marcel Moolenaar
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  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 AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _GEOM_PART_H_
  32 #define _GEOM_PART_H_
  33
  34 #define G_PART_TRACE(args)      g_trace args
  35
  36 #define G_PART_PROBE_PRI_LOW    -10
  37 #define G_PART_PROBE_PRI_NORM   -5
  38 #define G_PART_PROBE_PRI_HIGH   0
  39
  40 enum g_part_alias {
  41         G_PART_ALIAS_APPLE_APFS,        /* An Apple APFS partition. */
  42         G_PART_ALIAS_APPLE_BOOT,        /* An Apple boot partition entry. */
  43         G_PART_ALIAS_APPLE_CORE_STORAGE,/* An Apple Core Storage partition. */
  44         G_PART_ALIAS_APPLE_HFS,         /* An HFS+ file system entry. */
  45         G_PART_ALIAS_APPLE_LABEL,       /* An Apple label partition entry. */
  46         G_PART_ALIAS_APPLE_RAID,        /* An Apple RAID partition entry. */
  47         G_PART_ALIAS_APPLE_RAID_OFFLINE,/* An Apple RAID (offline) part entry.*/
  48         G_PART_ALIAS_APPLE_TV_RECOVERY, /* An Apple TV recovery part entry. */
  49         G_PART_ALIAS_APPLE_UFS,         /* An Apple UFS partition entry. */
  50         G_PART_ALIAS_BIOS_BOOT,         /* A GRUB 2 boot partition entry. */
  51         G_PART_ALIAS_CHROMEOS_FIRMWARE, /* A ChromeOS firmware part. entry. */
  52         G_PART_ALIAS_CHROMEOS_KERNEL,   /* A ChromeOS Kernel part. entry. */
  53         G_PART_ALIAS_CHROMEOS_RESERVED, /* ChromeOS. Reserved for future use. */
  54         G_PART_ALIAS_CHROMEOS_ROOT,     /* A ChromeOS root part. entry. */
  55         G_PART_ALIAS_DFBSD,             /* A DfBSD label32 partition entry */
  56         G_PART_ALIAS_DFBSD64,           /* A DfBSD label64 partition entry */
  57         G_PART_ALIAS_DFBSD_CCD,         /* A DfBSD CCD partition entry */
  58         G_PART_ALIAS_DFBSD_HAMMER,      /* A DfBSD HAMMER FS partition entry */
  59         G_PART_ALIAS_DFBSD_HAMMER2,     /* A DfBSD HAMMER2 FS partition entry */
  60         G_PART_ALIAS_DFBSD_LEGACY,      /* A DfBSD legacy partition entry */
  61         G_PART_ALIAS_DFBSD_SWAP,        /* A DfBSD swap partition entry */
  62         G_PART_ALIAS_DFBSD_UFS,         /* A DfBSD UFS partition entry */
  63         G_PART_ALIAS_DFBSD_VINUM,       /* A DfBSD Vinum partition entry */
  64         G_PART_ALIAS_EBR,               /* A EBR partition entry. */
  65         G_PART_ALIAS_EFI,               /* A EFI system partition entry. */
  66         G_PART_ALIAS_FREEBSD,           /* A BSD labeled partition entry. */
  67         G_PART_ALIAS_FREEBSD_BOOT,      /* A FreeBSD boot partition entry. */
  68         G_PART_ALIAS_FREEBSD_NANDFS,    /* A FreeBSD nandfs partition entry. */
  69         G_PART_ALIAS_FREEBSD_SWAP,      /* A swap partition entry. */
  70         G_PART_ALIAS_FREEBSD_UFS,       /* A UFS/UFS2 file system entry. */
  71         G_PART_ALIAS_FREEBSD_VINUM,     /* A Vinum partition entry. */
  72         G_PART_ALIAS_FREEBSD_ZFS,       /* A ZFS file system entry. */
  73         G_PART_ALIAS_LINUX_DATA,        /* A Linux data partition entry. */
  74         G_PART_ALIAS_LINUX_LVM,         /* A Linux LVM partition entry. */
  75         G_PART_ALIAS_LINUX_RAID,        /* A Linux RAID partition entry. */
  76         G_PART_ALIAS_LINUX_SWAP,        /* A Linux swap partition entry. */
  77         G_PART_ALIAS_MBR,               /* A MBR (extended) partition entry. */
  78         G_PART_ALIAS_MS_BASIC_DATA,     /* A Microsoft Data part. entry. */
  79         G_PART_ALIAS_MS_FAT16,          /* A Microsoft FAT16 partition entry. */
  80         G_PART_ALIAS_MS_FAT32,          /* A Microsoft FAT32 partition entry. */
  81         G_PART_ALIAS_MS_FAT32LBA,       /* A Microsoft FAT32 LBA partition entry */
  82         G_PART_ALIAS_MS_LDM_DATA,       /* A Microsoft LDM Data part. entry. */
  83         G_PART_ALIAS_MS_LDM_METADATA,   /* A Microsoft LDM Metadata entry. */
  84         G_PART_ALIAS_MS_NTFS,           /* A Microsoft NTFS partition entry */
  85         G_PART_ALIAS_MS_RECOVERY,       /* A Microsoft recovery part. entry. */
  86         G_PART_ALIAS_MS_RESERVED,       /* A Microsoft Reserved part. entry. */
  87         G_PART_ALIAS_MS_SPACES,         /* A Microsoft Spaces part. entry. */
  88         G_PART_ALIAS_NETBSD_CCD,        /* A NetBSD CCD partition entry. */
  89         G_PART_ALIAS_NETBSD_CGD,        /* A NetBSD CGD partition entry. */
  90         G_PART_ALIAS_NETBSD_FFS,        /* A NetBSD FFS partition entry. */
  91         G_PART_ALIAS_NETBSD_LFS,        /* A NetBSD LFS partition entry. */
  92         G_PART_ALIAS_NETBSD_RAID,       /* A NetBSD RAID partition entry. */
  93         G_PART_ALIAS_NETBSD_SWAP,       /* A NetBSD swap partition entry. */
  94         G_PART_ALIAS_OPENBSD_DATA,      /* An OpenBSD data partition entry. */
  95         G_PART_ALIAS_PREP_BOOT,         /* A PREP/CHRP boot partition entry. */
  96         G_PART_ALIAS_VMFS,              /* A VMware VMFS partition entry */
  97         G_PART_ALIAS_VMKDIAG,           /* A VMware vmkDiagnostic partition entry */
  98         G_PART_ALIAS_VMRESERVED,        /* A VMware reserved partition entry */
  99         G_PART_ALIAS_VMVSANHDR,         /* A VMware vSAN header partition entry */
 100         /* Keep the following last */
 101         G_PART_ALIAS_COUNT
 102 };
 103
 104 const char *g_part_alias_name(enum g_part_alias);
 105
 106 /* G_PART scheme (KOBJ class). */
 107 struct g_part_scheme {
 108         KOBJ_CLASS_FIELDS;
 109         size_t          gps_entrysz;
 110         int             gps_minent;
 111         int             gps_maxent;
 112         int             gps_bootcodesz;
 113         TAILQ_ENTRY(g_part_scheme) scheme_list;
 114 };
 115
 116 struct g_part_entry {
 117         LIST_ENTRY(g_part_entry) gpe_entry;
 118         struct g_provider *gpe_pp;      /* Corresponding provider. */
 119         off_t           gpe_offset;     /* Byte offset. */
 120         quad_t          gpe_start;      /* First LBA of partition. */
 121         quad_t          gpe_end;        /* Last LBA of partition. */
 122         int             gpe_index;
 123         int             gpe_created:1;  /* Entry is newly created. */
 124         int             gpe_deleted:1;  /* Entry has been deleted. */
 125         int             gpe_modified:1; /* Entry has been modified. */
 126         int             gpe_internal:1; /* Entry is not a used entry. */
 127 };
 128
 129 /* G_PART table (KOBJ instance). */
 130 struct g_part_table {
 131         KOBJ_FIELDS;
 132         struct g_part_scheme *gpt_scheme;
 133         struct g_geom   *gpt_gp;
 134         LIST_HEAD(, g_part_entry) gpt_entry;
 135         quad_t          gpt_first;      /* First allocatable LBA */
 136         quad_t          gpt_last;       /* Last allocatable LBA */
 137         int             gpt_entries;
 138         /*
 139          * gpt_smhead and gpt_smtail are bitmaps representing the first
 140          * 32 sectors on the disk (gpt_smhead) and the last 32 sectors
 141          * on the disk (gpt_smtail). These maps are used by the commit
 142          * verb to clear sectors previously used by a scheme after the
 143          * partitioning scheme has been destroyed.
 144          */
 145         uint32_t        gpt_smhead;
 146         uint32_t        gpt_smtail;
 147         /*
 148          * gpt_sectors and gpt_heads are the fixed or synchesized number
 149          * of sectors per track and heads (resp) that make up a disks
 150          * geometry. This is to support partitioning schemes as well as
 151          * file systems that work on a geometry. The MBR scheme and the
 152          * MS-DOS (FAT) file system come to mind.
 153          * We keep track of whether the geometry is fixed or synchesized
 154          * so that a partitioning scheme can correct the synthesized
 155          * geometry, based on the on-disk metadata.
 156          */
 157         uint32_t        gpt_sectors;
 158         uint32_t        gpt_heads;
 159
 160         int             gpt_depth;      /* Sub-partitioning level. */
 161         int             gpt_isleaf:1;   /* Cannot be sub-partitioned. */
 162         int             gpt_created:1;  /* Newly created. */
 163         int             gpt_modified:1; /* Table changes have been made. */
 164         int             gpt_opened:1;   /* Permissions obtained. */
 165         int             gpt_fixgeom:1;  /* Geometry is fixed. */
 166         int             gpt_corrupt:1;  /* Table is corrupt. */
 167 };
 168
 169 struct g_part_entry *g_part_new_entry(struct g_part_table *, int, quad_t,
 170     quad_t);
 171
 172 enum g_part_ctl {
 173         G_PART_CTL_NONE,
 174         G_PART_CTL_ADD,
 175         G_PART_CTL_BOOTCODE,
 176         G_PART_CTL_COMMIT,
 177         G_PART_CTL_CREATE,
 178         G_PART_CTL_DELETE,
 179         G_PART_CTL_DESTROY,
 180         G_PART_CTL_MODIFY,
 181         G_PART_CTL_MOVE,
 182         G_PART_CTL_RECOVER,
 183         G_PART_CTL_RESIZE,
 184         G_PART_CTL_SET,
 185         G_PART_CTL_UNDO,
 186         G_PART_CTL_UNSET
 187 };
 188
 189 /* G_PART ctlreq parameters. */
 190 #define G_PART_PARM_ENTRIES     0x0001
 191 #define G_PART_PARM_FLAGS       0x0002
 192 #define G_PART_PARM_GEOM        0x0004
 193 #define G_PART_PARM_INDEX       0x0008
 194 #define G_PART_PARM_LABEL       0x0010
 195 #define G_PART_PARM_OUTPUT      0x0020
 196 #define G_PART_PARM_PROVIDER    0x0040
 197 #define G_PART_PARM_SCHEME      0x0080
 198 #define G_PART_PARM_SIZE        0x0100
 199 #define G_PART_PARM_START       0x0200
 200 #define G_PART_PARM_TYPE        0x0400
 201 #define G_PART_PARM_VERSION     0x0800
 202 #define G_PART_PARM_BOOTCODE    0x1000
 203 #define G_PART_PARM_ATTRIB      0x2000
 204 #define G_PART_PARM_FORCE       0x4000
 205 #define G_PART_PARM_SKIP_DSN    0x8000
 206
 207 struct g_part_parms {
 208         unsigned int    gpp_parms;
 209         unsigned int    gpp_entries;
 210         const char      *gpp_flags;
 211         struct g_geom   *gpp_geom;
 212         unsigned int    gpp_index;
 213         const char      *gpp_label;
 214         struct g_provider *gpp_provider;
 215         struct g_part_scheme *gpp_scheme;
 216         quad_t          gpp_size;
 217         quad_t          gpp_start;
 218         const char      *gpp_type;
 219         unsigned int    gpp_version;
 220         const void      *gpp_codeptr;
 221         unsigned int    gpp_codesize;
 222         const char      *gpp_attrib;
 223         unsigned int    gpp_force;
 224         unsigned int    gpp_skip_dsn;
 225 };
 226
 227 void g_part_geometry_heads(off_t, u_int, off_t *, u_int *);
 228
 229 int g_part_modevent(module_t, int, struct g_part_scheme *);
 230
 231 #define G_PART_SCHEME_DECLARE(name)                             \
 232     static int name##_modevent(module_t mod, int tp, void *d)   \
 233     {                                                           \
 234         return (g_part_modevent(mod, tp, d));                   \
 235     }                                                           \
 236     static moduledata_t name##_mod = {                          \
 237         #name,                                                  \
 238         name##_modevent,                                        \
 239         &name##_scheme                                          \
 240     };                                                          \
 241     DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_ANY); \
 242     MODULE_DEPEND(name, g_part, 0, 0, 0)
 243
 244 #endif /* !_GEOM_PART_H_ */