1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1987, 1988, 1993
5 *	The Regents of the University of California.  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 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 *    may be used to endorse or promote products derived from this software
17 *    without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32#ifndef _SYS_DISKLABEL_H_
33#define	_SYS_DISKLABEL_H_
34
35#ifndef _KERNEL
36#include <sys/types.h>
37#endif
38#include <sys/ioccom.h>
39
40#include <sys/disk/bsd.h>
41
42/* Disk description table, see disktab(5) */
43#define	_PATH_DISKTAB	"/etc/disktab"
44
45/*
46 * The label is in block 0 or 1, possibly offset from the beginning
47 * to leave room for a bootstrap, etc.
48 * XXX these should be defined per controller (or drive) elsewhere, not here!
49 * XXX in actuality it can't even be per controller or drive. It should be
50 * constant/fixed across storage hardware and CPU architectures. Disks can
51 * travel from one machine to another and a label created on one machine
52 * should be detectable and understood by the other.
53 */
54#define LABELSECTOR	1			/* sector containing label */
55#define LABELOFFSET	0			/* offset of label in sector */
56
57#define DISKMAGIC	BSD_MAGIC		/* The disk magic number */
58
59#ifndef MAXPARTITIONS
60#define	MAXPARTITIONS	BSD_NPARTS_MIN
61#endif
62
63/* Size of bootblock area in sector-size neutral bytes */
64#define BBSIZE		BSD_BOOTBLOCK_SIZE
65
66#define	LABEL_PART	BSD_PART_RAW
67#define	RAW_PART	BSD_PART_RAW
68#define	SWAP_PART	BSD_PART_SWAP
69
70#define NDDATA		BSD_NDRIVEDATA
71#define NSPARE		BSD_NSPARE
72
73static __inline u_int16_t dkcksum(struct disklabel *lp);
74static __inline u_int16_t
75dkcksum(struct disklabel *lp)
76{
77	u_int16_t *start, *end;
78	u_int16_t sum = 0;
79
80	start = (u_int16_t *)lp;
81	end = (u_int16_t *)&lp->d_partitions[lp->d_npartitions];
82	while (start < end)
83		sum ^= *start++;
84	return (sum);
85}
86
87#ifdef DKTYPENAMES
88static const char *dktypenames[] = {
89	"unknown",
90	"SMD",
91	"MSCP",
92	"old DEC",
93	"SCSI",
94	"ESDI",
95	"ST506",
96	"HP-IB",
97	"HP-FL",
98	"type 9",
99	"floppy",
100	"CCD",
101	"Vinum",
102	"DOC2K",
103	"Raid",
104	"?",
105	"jfs",
106	NULL
107};
108#define DKMAXTYPES	(sizeof(dktypenames) / sizeof(dktypenames[0]) - 1)
109#endif
110
111#ifdef	FSTYPENAMES
112static const char *fstypenames[] = {
113	"unused",
114	"swap",
115	"Version 6",
116	"Version 7",
117	"System V",
118	"4.1BSD",
119	"Eighth Edition",
120	"4.2BSD",
121	"MSDOS",
122	"4.4LFS",
123	"unknown",
124	"HPFS",
125	"ISO9660",
126	"boot",
127	"vinum",
128	"raid",
129	"Filecore",
130	"EXT2FS",
131	"NTFS",
132	"?",
133	"ccd",
134	"jfs",
135	"HAMMER",
136	"HAMMER2",
137	"UDF",
138	"?",
139	"EFS",
140	"ZFS",
141	"?",
142	"?",
143	"nandfs",
144	NULL
145};
146#define FSMAXTYPES	(sizeof(fstypenames) / sizeof(fstypenames[0]) - 1)
147#endif
148
149/*
150 * NB: <sys/disk.h> defines ioctls from 'd'/128 and up.
151 */
152
153/*
154 * Functions for proper encoding/decoding of struct disklabel into/from
155 * bytestring.
156 */
157void bsd_partition_le_dec(u_char *ptr, struct partition *d);
158int bsd_disklabel_le_dec(u_char *ptr, struct disklabel *d, int maxpart);
159void bsd_partition_le_enc(u_char *ptr, struct partition *d);
160void bsd_disklabel_le_enc(u_char *ptr, struct disklabel *d);
161
162#ifndef _KERNEL
163__BEGIN_DECLS
164struct disklabel *getdiskbyname(const char *);
165__END_DECLS
166#endif
167
168#endif /* !_SYS_DISKLABEL_H_ */
169