gpt.h revision 1.37 
1/*-
2 * Copyright (c) 2002 Marcel Moolenaar
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 *
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 *
26 * $FreeBSD: src/sbin/gpt/gpt.h,v 1.11 2006/06/22 22:05:28 marcel Exp $
27 */
28
29#ifndef _GPT_H_
30#define	_GPT_H_
31
32#ifndef HAVE_NBTOOL_CONFIG_H
33#include <util.h>
34#else
35#include "opendisk.h"
36#include "namespace.h"
37#endif
38
39#include "gpt_uuid.h"
40
41struct mbr_part {
42	uint8_t		part_flag;		/* bootstrap flags */
43	uint8_t		part_shd;		/* starting head */
44	uint8_t		part_ssect;		/* starting sector */
45	uint8_t		part_scyl;		/* starting cylinder */
46	uint8_t		part_typ;		/* partition type */
47	uint8_t		part_ehd;		/* end head */
48	uint8_t		part_esect;		/* end sector */
49	uint8_t		part_ecyl;		/* end cylinder */
50	uint16_t	part_start_lo;		/* absolute starting ... */
51	uint16_t	part_start_hi;		/* ... sector number */
52	uint16_t	part_size_lo;		/* partition size ... */
53	uint16_t	part_size_hi;		/* ... in sectors */
54};
55
56struct mbr {
57	uint8_t		mbr_code[446];
58	struct mbr_part	mbr_part[4];
59	uint16_t	mbr_sig;
60#define	MBR_SIG		0xAA55
61};
62
63typedef struct gpt *gpt_t;
64typedef struct map *map_t;
65
66struct gpt_cmd {
67	const char *name;
68	int (*fptr)(gpt_t, int, char *[]);
69	const char **help;
70	size_t hlen;
71	int flags;
72};
73
74uint32_t crc32(const void *, size_t);
75void	gpt_close(gpt_t);
76int	gpt_gpt(gpt_t, off_t, int);
77gpt_t	gpt_open(const char *, int, int, off_t, u_int, time_t);
78#define GPT_READONLY	0x01
79#define GPT_MODIFIED	0x02
80#define GPT_QUIET	0x04
81#define GPT_NOSYNC	0x08
82#define GPT_FILE	0x10
83#define GPT_TIMESTAMP	0x20
84#define GPT_OPTDEV      0x8000
85
86void*	gpt_read(gpt_t, off_t, size_t);
87off_t	gpt_last(gpt_t);
88off_t	gpt_create(gpt_t, off_t, u_int, int);
89int	gpt_write(gpt_t, map_t);
90int	gpt_write_crc(gpt_t, map_t, map_t);
91int	gpt_write_primary(gpt_t);
92int	gpt_write_backup(gpt_t);
93struct gpt_hdr *gpt_hdr(gpt_t);
94void	gpt_msg(gpt_t, const char *, ...) __printflike(2, 3);
95void	gpt_warn(gpt_t, const char *, ...) __printflike(2, 3);
96void	gpt_warnx(gpt_t, const char *, ...) __printflike(2, 3);
97void	gpt_create_pmbr_part(struct mbr_part *, off_t, int);
98struct gpt_ent *gpt_ent(map_t, map_t, unsigned int);
99struct gpt_ent *gpt_ent_primary(gpt_t, unsigned int);
100struct gpt_ent *gpt_ent_backup(gpt_t, unsigned int);
101int	gpt_usage(const char *, const struct gpt_cmd *);
102
103void 	utf16_to_utf8(const uint16_t *, size_t, uint8_t *, size_t);
104void	utf8_to_utf16(const uint8_t *, uint16_t *, size_t);
105
106#define GPT_FIND "ab:i:L:s:t:"
107
108struct gpt_find {
109	int all;
110	gpt_uuid_t type;
111	off_t block, size;
112	unsigned int entry;
113	uint8_t *name, *label;
114	const char *msg;
115};
116int	gpt_change_ent(gpt_t, const struct gpt_find *,
117    void (*)(struct gpt_ent *, void *), void *);
118int	gpt_add_find(gpt_t, struct gpt_find *, int);
119
120#define GPT_AIS "a:i:s:"
121int	gpt_add_ais(gpt_t, off_t *, u_int *, off_t *, int);
122off_t	gpt_check_ais(gpt_t, off_t, u_int, off_t);
123
124int	gpt_attr_get(gpt_t, uint64_t *);
125const char *gpt_attr_list(char *, size_t, uint64_t);
126void	gpt_attr_help(const char *);
127int	gpt_attr_update(gpt_t, u_int, uint64_t, uint64_t);
128int	gpt_uint_get(gpt_t, u_int *);
129int	gpt_human_get(gpt_t, off_t *);
130int	gpt_uuid_get(gpt_t, gpt_uuid_t *);
131int	gpt_name_get(gpt_t, void *);
132int	gpt_add_hdr(gpt_t, int, off_t);
133void	gpt_show_num(const char *, uintmax_t);
134
135#endif /* _GPT_H_ */
136