xref: /illumos-gate/usr/src/boot/common/part.h (revision 22028508)
1 /*
2  * Copyright (c) 2012 Andrey V. Elsukov <ae@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #ifndef _PART_H_
28 #define	_PART_H_
29 
30 struct ptable;
31 
32 enum ptable_type {
33 	PTABLE_NONE,
34 	PTABLE_BSD,
35 	PTABLE_MBR,
36 	PTABLE_GPT,
37 	PTABLE_VTOC8,
38 	PTABLE_VTOC,
39 	PTABLE_ISO9660
40 };
41 
42 enum partition_type {
43 	PART_UNKNOWN,
44 	PART_EFI,
45 	PART_FREEBSD,
46 	PART_FREEBSD_BOOT,
47 	PART_FREEBSD_UFS,
48 	PART_FREEBSD_ZFS,
49 	PART_FREEBSD_SWAP,
50 	PART_FREEBSD_VINUM,
51 	PART_LINUX,
52 	PART_LINUX_SWAP,
53 	PART_DOS,
54 	PART_ISO9660,
55 	PART_SOLARIS2,
56 	PART_ILLUMOS_UFS,
57 	PART_ILLUMOS_ZFS,
58 	PART_RESERVED,
59 	PART_VTOC_BOOT,
60 	PART_VTOC_ROOT,
61 	PART_VTOC_SWAP,
62 	PART_VTOC_USR,
63 	PART_VTOC_BACKUP,
64 	PART_VTOC_STAND,
65 	PART_VTOC_VAR,
66 	PART_VTOC_HOME,
67 	PART_APFS
68 };
69 
70 struct ptable_entry {
71 	uint64_t		start;
72 	uint64_t		end;
73 	int			index;
74 	enum partition_type	type;
75 };
76 
77 /* The offset and size are in sectors */
78 typedef int (diskread_t)(void *arg, void *buf, size_t blocks, uint64_t offset);
79 typedef int (ptable_iterate_t)(void *arg, const char *partname,
80     const struct ptable_entry *part);
81 
82 struct ptable *ptable_open(void *dev, uint64_t sectors, uint16_t sectorsize,
83     diskread_t *dread);
84 void ptable_close(struct ptable *table);
85 enum ptable_type ptable_gettype(const struct ptable *table);
86 int ptable_getsize(const struct ptable *table, uint64_t *sizep);
87 
88 int ptable_getpart(const struct ptable *table, struct ptable_entry *part,
89     int index);
90 int ptable_getbestpart(const struct ptable *table, struct ptable_entry *part);
91 
92 int ptable_iterate(const struct ptable *table, void *arg,
93     ptable_iterate_t *iter);
94 const char *parttype2str(enum partition_type type);
95 
96 #endif	/* !_PART_H_ */
97