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_APPLE_ZFS, /* An Apple ZFS partition entry. 51 Also used for Solaris /usr partition. */ 52 G_PART_ALIAS_BIOS_BOOT, /* A GRUB 2 boot partition entry. */ 53 G_PART_ALIAS_CHROMEOS_FIRMWARE, /* A ChromeOS firmware part. entry. */ 54 G_PART_ALIAS_CHROMEOS_KERNEL, /* A ChromeOS Kernel part. entry. */ 55 G_PART_ALIAS_CHROMEOS_RESERVED, /* ChromeOS. Reserved for future use. */ 56 G_PART_ALIAS_CHROMEOS_ROOT, /* A ChromeOS root part. entry. */ 57 G_PART_ALIAS_DFBSD, /* A DfBSD label32 partition entry */ 58 G_PART_ALIAS_DFBSD64, /* A DfBSD label64 partition entry */ 59 G_PART_ALIAS_DFBSD_CCD, /* A DfBSD CCD partition entry */ 60 G_PART_ALIAS_DFBSD_HAMMER, /* A DfBSD HAMMER FS partition entry */ 61 G_PART_ALIAS_DFBSD_HAMMER2, /* A DfBSD HAMMER2 FS partition entry */ 62 G_PART_ALIAS_DFBSD_LEGACY, /* A DfBSD legacy partition entry */ 63 G_PART_ALIAS_DFBSD_SWAP, /* A DfBSD swap partition entry */ 64 G_PART_ALIAS_DFBSD_UFS, /* A DfBSD UFS partition entry */ 65 G_PART_ALIAS_DFBSD_VINUM, /* A DfBSD Vinum partition entry */ 66 G_PART_ALIAS_EBR, /* A EBR partition entry. */ 67 G_PART_ALIAS_EFI, /* A EFI system partition entry. */ 68 G_PART_ALIAS_FREEBSD, /* A BSD labeled partition entry. */ 69 G_PART_ALIAS_FREEBSD_BOOT, /* A FreeBSD boot partition entry. */ 70 G_PART_ALIAS_FREEBSD_NANDFS, /* A FreeBSD nandfs partition entry. */ 71 G_PART_ALIAS_FREEBSD_SWAP, /* A swap partition entry. */ 72 G_PART_ALIAS_FREEBSD_UFS, /* A UFS/UFS2 file system entry. */ 73 G_PART_ALIAS_FREEBSD_VINUM, /* A Vinum partition entry. */ 74 G_PART_ALIAS_FREEBSD_ZFS, /* A ZFS file system entry. */ 75 G_PART_ALIAS_HIFIVE_FSBL, /* HiFive First Stage Bootloader */ 76 G_PART_ALIAS_HIFIVE_BBL, /* HiFive Second Stage Bootloader */ 77 G_PART_ALIAS_LINUX_DATA, /* A Linux data partition entry. */ 78 G_PART_ALIAS_LINUX_LVM, /* A Linux LVM partition entry. */ 79 G_PART_ALIAS_LINUX_RAID, /* A Linux RAID partition entry. */ 80 G_PART_ALIAS_LINUX_SWAP, /* A Linux swap partition entry. */ 81 G_PART_ALIAS_MBR, /* A MBR (extended) partition entry. */ 82 G_PART_ALIAS_MS_BASIC_DATA, /* A Microsoft Data part. entry. */ 83 G_PART_ALIAS_MS_FAT16, /* A Microsoft FAT16 partition entry. */ 84 G_PART_ALIAS_MS_FAT32, /* A Microsoft FAT32 partition entry. */ 85 G_PART_ALIAS_MS_FAT32LBA, /* A Microsoft FAT32 LBA partition entry */ 86 G_PART_ALIAS_MS_LDM_DATA, /* A Microsoft LDM Data part. entry. */ 87 G_PART_ALIAS_MS_LDM_METADATA, /* A Microsoft LDM Metadata entry. */ 88 G_PART_ALIAS_MS_NTFS, /* A Microsoft NTFS partition entry */ 89 G_PART_ALIAS_MS_RECOVERY, /* A Microsoft recovery part. entry. */ 90 G_PART_ALIAS_MS_RESERVED, /* A Microsoft Reserved part. entry. */ 91 G_PART_ALIAS_MS_SPACES, /* A Microsoft Spaces part. entry. */ 92 G_PART_ALIAS_NETBSD_CCD, /* A NetBSD CCD partition entry. */ 93 G_PART_ALIAS_NETBSD_CGD, /* A NetBSD CGD partition entry. */ 94 G_PART_ALIAS_NETBSD_FFS, /* A NetBSD FFS partition entry. */ 95 G_PART_ALIAS_NETBSD_LFS, /* A NetBSD LFS partition entry. */ 96 G_PART_ALIAS_NETBSD_RAID, /* A NetBSD RAID partition entry. */ 97 G_PART_ALIAS_NETBSD_SWAP, /* A NetBSD swap partition entry. */ 98 G_PART_ALIAS_OPENBSD_DATA, /* An OpenBSD data partition entry. */ 99 G_PART_ALIAS_PREP_BOOT, /* A PREP/CHRP boot partition entry. */ 100 G_PART_ALIAS_SOLARIS_BOOT, /* A Solaris boot partition entry. */ 101 G_PART_ALIAS_SOLARIS_ROOT, /* A Solaris root partition entry. */ 102 G_PART_ALIAS_SOLARIS_SWAP, /* A Solaris swap partition entry. */ 103 G_PART_ALIAS_SOLARIS_BACKUP, /* A Solaris backup partition entry. */ 104 G_PART_ALIAS_SOLARIS_VAR, /* A Solaris /var partition entry. */ 105 G_PART_ALIAS_SOLARIS_HOME, /* A Solaris /home partition entry. */ 106 G_PART_ALIAS_SOLARIS_ALTSEC, /* A Solaris alternate sector partition entry. */ 107 G_PART_ALIAS_SOLARIS_RESERVED, /* A Solaris reserved partition entry. */ 108 G_PART_ALIAS_VMFS, /* A VMware VMFS partition entry */ 109 G_PART_ALIAS_VMKDIAG, /* A VMware vmkDiagnostic partition entry */ 110 G_PART_ALIAS_VMRESERVED, /* A VMware reserved partition entry */ 111 G_PART_ALIAS_VMVSANHDR, /* A VMware vSAN header partition entry */ 112 /* Keep the following last */ 113 G_PART_ALIAS_COUNT 114 }; 115 116 const char *g_part_alias_name(enum g_part_alias); 117 118 /* G_PART scheme (KOBJ class). */ 119 struct g_part_scheme { 120 KOBJ_CLASS_FIELDS; 121 size_t gps_entrysz; 122 int gps_minent; 123 int gps_maxent; 124 int gps_bootcodesz; 125 TAILQ_ENTRY(g_part_scheme) scheme_list; 126 }; 127 128 struct g_part_entry { 129 LIST_ENTRY(g_part_entry) gpe_entry; 130 struct g_provider *gpe_pp; /* Corresponding provider. */ 131 off_t gpe_offset; /* Byte offset. */ 132 quad_t gpe_start; /* First LBA of partition. */ 133 quad_t gpe_end; /* Last LBA of partition. */ 134 int gpe_index; 135 bool gpe_created:1; /* Entry is newly created. */ 136 bool gpe_deleted:1; /* Entry has been deleted. */ 137 bool gpe_modified:1; /* Entry has been modified. */ 138 bool gpe_internal:1; /* Entry is not a used entry. */ 139 }; 140 141 /* G_PART table (KOBJ instance). */ 142 struct g_part_table { 143 KOBJ_FIELDS; 144 struct g_part_scheme *gpt_scheme; 145 struct g_geom *gpt_gp; 146 LIST_HEAD(, g_part_entry) gpt_entry; 147 quad_t gpt_first; /* First allocatable LBA */ 148 quad_t gpt_last; /* Last allocatable LBA */ 149 int gpt_entries; 150 /* 151 * gpt_smhead and gpt_smtail are bitmaps representing the first 152 * 32 sectors on the disk (gpt_smhead) and the last 32 sectors 153 * on the disk (gpt_smtail). These maps are used by the commit 154 * verb to clear sectors previously used by a scheme after the 155 * partitioning scheme has been destroyed. 156 */ 157 uint32_t gpt_smhead; 158 uint32_t gpt_smtail; 159 /* 160 * gpt_sectors and gpt_heads are the fixed or synchesized number 161 * of sectors per track and heads (resp) that make up a disks 162 * geometry. This is to support partitioning schemes as well as 163 * file systems that work on a geometry. The MBR scheme and the 164 * MS-DOS (FAT) file system come to mind. 165 * We keep track of whether the geometry is fixed or synchesized 166 * so that a partitioning scheme can correct the synthesized 167 * geometry, based on the on-disk metadata. 168 */ 169 uint32_t gpt_sectors; 170 uint32_t gpt_heads; 171 172 int gpt_depth; /* Sub-partitioning level. */ 173 bool gpt_isleaf:1; /* Cannot be sub-partitioned. */ 174 bool gpt_created:1; /* Newly created. */ 175 bool gpt_modified:1; /* Table changes have been made. */ 176 bool gpt_opened:1; /* Permissions obtained. */ 177 bool gpt_fixgeom:1; /* Geometry is fixed. */ 178 bool gpt_corrupt:1; /* Table is corrupt. */ 179 }; 180 181 struct g_part_entry *g_part_new_entry(struct g_part_table *, int, quad_t, 182 quad_t); 183 184 enum g_part_ctl { 185 G_PART_CTL_NONE, 186 G_PART_CTL_ADD, 187 G_PART_CTL_BOOTCODE, 188 G_PART_CTL_COMMIT, 189 G_PART_CTL_CREATE, 190 G_PART_CTL_DELETE, 191 G_PART_CTL_DESTROY, 192 G_PART_CTL_MODIFY, 193 G_PART_CTL_MOVE, 194 G_PART_CTL_RECOVER, 195 G_PART_CTL_RESIZE, 196 G_PART_CTL_SET, 197 G_PART_CTL_UNDO, 198 G_PART_CTL_UNSET 199 }; 200 201 /* G_PART ctlreq parameters. */ 202 #define G_PART_PARM_ENTRIES 0x0001 203 #define G_PART_PARM_FLAGS 0x0002 204 #define G_PART_PARM_GEOM 0x0004 205 #define G_PART_PARM_INDEX 0x0008 206 #define G_PART_PARM_LABEL 0x0010 207 #define G_PART_PARM_OUTPUT 0x0020 208 #define G_PART_PARM_PROVIDER 0x0040 209 #define G_PART_PARM_SCHEME 0x0080 210 #define G_PART_PARM_SIZE 0x0100 211 #define G_PART_PARM_START 0x0200 212 #define G_PART_PARM_TYPE 0x0400 213 #define G_PART_PARM_VERSION 0x0800 214 #define G_PART_PARM_BOOTCODE 0x1000 215 #define G_PART_PARM_ATTRIB 0x2000 216 #define G_PART_PARM_FORCE 0x4000 217 #define G_PART_PARM_SKIP_DSN 0x8000 218 219 struct g_part_parms { 220 unsigned int gpp_parms; 221 unsigned int gpp_entries; 222 const char *gpp_flags; 223 struct g_geom *gpp_geom; 224 unsigned int gpp_index; 225 const char *gpp_label; 226 struct g_provider *gpp_provider; 227 struct g_part_scheme *gpp_scheme; 228 quad_t gpp_size; 229 quad_t gpp_start; 230 const char *gpp_type; 231 unsigned int gpp_version; 232 const void *gpp_codeptr; 233 unsigned int gpp_codesize; 234 const char *gpp_attrib; 235 unsigned int gpp_force; 236 unsigned int gpp_skip_dsn; 237 }; 238 239 void g_part_geometry_heads(off_t, u_int, off_t *, u_int *); 240 241 int g_part_modevent(module_t, int, struct g_part_scheme *); 242 243 extern char g_part_separator[]; 244 245 #define G_PART_SCHEME_DECLARE(name) \ 246 static int name##_modevent(module_t mod, int tp, void *d) \ 247 { \ 248 return (g_part_modevent(mod, tp, d)); \ 249 } \ 250 static moduledata_t name##_mod = { \ 251 #name, \ 252 name##_modevent, \ 253 &name##_scheme \ 254 }; \ 255 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_ANY); \ 256 MODULE_DEPEND(name, g_part, 0, 0, 0) 257 258 #endif /* !_GEOM_PART_H_ */ 259