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