FreeBSD/Linux Kernel Cross Reference
sys/sys/disklabel.h
1 /*
2 * Copyright (c) 1987, 1988, 1993
3 * The Regents of the University of California. 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 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the University of
16 * California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 * @(#)disklabel.h 8.2 (Berkeley) 7/10/94
34 * $FreeBSD$
35 */
36
37 #ifndef _SYS_DISKLABEL_H_
38 #define _SYS_DISKLABEL_H_
39
40 #ifndef _KERNEL
41 #include <sys/types.h>
42 #endif
43 #include <sys/ioccom.h>
44
45 /*
46 * Disk description table, see disktab(5)
47 */
48 #define _PATH_DISKTAB "/etc/disktab"
49 #define DISKTAB "/etc/disktab" /* deprecated */
50
51 /*
52 * Each disk has a label which includes information about the hardware
53 * disk geometry, filesystem partitions, and drive specific information.
54 * The label is in block 0 or 1, possibly offset from the beginning
55 * to leave room for a bootstrap, etc.
56 */
57
58 /* XXX these should be defined per controller (or drive) elsewhere, not here! */
59 #ifdef __i386__
60 #define LABELSECTOR 1 /* sector containing label */
61 #define LABELOFFSET 0 /* offset of label in sector */
62 #endif
63
64 #ifdef __alpha__
65 #define LABELSECTOR 0
66 #define LABELOFFSET 64
67 #endif
68
69 #ifndef LABELSECTOR
70 #define LABELSECTOR 0 /* sector containing label */
71 #endif
72
73 #ifndef LABELOFFSET
74 #define LABELOFFSET 64 /* offset of label in sector */
75 #endif
76
77 #define DISKMAGIC ((u_int32_t)0x82564557) /* The disk magic number */
78 #ifndef MAXPARTITIONS
79 #define MAXPARTITIONS 8
80 #endif
81
82 #define LABEL_PART 2 /* partition containing label */
83 #define RAW_PART 2 /* partition containing whole disk */
84 #define SWAP_PART 1 /* partition normally containing swap */
85
86 #ifndef LOCORE
87 struct disklabel {
88 u_int32_t d_magic; /* the magic number */
89 u_int16_t d_type; /* drive type */
90 u_int16_t d_subtype; /* controller/d_type specific */
91 char d_typename[16]; /* type name, e.g. "eagle" */
92
93 /*
94 * d_packname contains the pack identifier and is returned when
95 * the disklabel is read off the disk or in-core copy.
96 * d_boot0 and d_boot1 are the (optional) names of the
97 * primary (block 0) and secondary (block 1-15) bootstraps
98 * as found in /boot. These are returned when using
99 * getdiskbyname(3) to retrieve the values from /etc/disktab.
100 */
101 union {
102 char un_d_packname[16]; /* pack identifier */
103 struct {
104 char *un_d_boot0; /* primary bootstrap name */
105 char *un_d_boot1; /* secondary bootstrap name */
106 } un_b;
107 } d_un;
108 #define d_packname d_un.un_d_packname
109 #define d_boot0 d_un.un_b.un_d_boot0
110 #define d_boot1 d_un.un_b.un_d_boot1
111
112 /* disk geometry: */
113 u_int32_t d_secsize; /* # of bytes per sector */
114 u_int32_t d_nsectors; /* # of data sectors per track */
115 u_int32_t d_ntracks; /* # of tracks per cylinder */
116 u_int32_t d_ncylinders; /* # of data cylinders per unit */
117 u_int32_t d_secpercyl; /* # of data sectors per cylinder */
118 u_int32_t d_secperunit; /* # of data sectors per unit */
119
120 /*
121 * Spares (bad sector replacements) below are not counted in
122 * d_nsectors or d_secpercyl. Spare sectors are assumed to
123 * be physical sectors which occupy space at the end of each
124 * track and/or cylinder.
125 */
126 u_int16_t d_sparespertrack; /* # of spare sectors per track */
127 u_int16_t d_sparespercyl; /* # of spare sectors per cylinder */
128 /*
129 * Alternate cylinders include maintenance, replacement, configuration
130 * description areas, etc.
131 */
132 u_int32_t d_acylinders; /* # of alt. cylinders per unit */
133
134 /* hardware characteristics: */
135 /*
136 * d_interleave, d_trackskew and d_cylskew describe perturbations
137 * in the media format used to compensate for a slow controller.
138 * Interleave is physical sector interleave, set up by the
139 * formatter or controller when formatting. When interleaving is
140 * in use, logically adjacent sectors are not physically
141 * contiguous, but instead are separated by some number of
142 * sectors. It is specified as the ratio of physical sectors
143 * traversed per logical sector. Thus an interleave of 1:1
144 * implies contiguous layout, while 2:1 implies that logical
145 * sector 0 is separated by one sector from logical sector 1.
146 * d_trackskew is the offset of sector 0 on track N relative to
147 * sector 0 on track N-1 on the same cylinder. Finally, d_cylskew
148 * is the offset of sector 0 on cylinder N relative to sector 0
149 * on cylinder N-1.
150 */
151 u_int16_t d_rpm; /* rotational speed */
152 u_int16_t d_interleave; /* hardware sector interleave */
153 u_int16_t d_trackskew; /* sector 0 skew, per track */
154 u_int16_t d_cylskew; /* sector 0 skew, per cylinder */
155 u_int32_t d_headswitch; /* head switch time, usec */
156 u_int32_t d_trkseek; /* track-to-track seek, usec */
157 u_int32_t d_flags; /* generic flags */
158 #define NDDATA 5
159 u_int32_t d_drivedata[NDDATA]; /* drive-type specific information */
160 #define NSPARE 5
161 u_int32_t d_spare[NSPARE]; /* reserved for future use */
162 u_int32_t d_magic2; /* the magic number (again) */
163 u_int16_t d_checksum; /* xor of data incl. partitions */
164
165 /* filesystem and partition information: */
166 u_int16_t d_npartitions; /* number of partitions in following */
167 u_int32_t d_bbsize; /* size of boot area at sn0, bytes */
168 u_int32_t d_sbsize; /* max size of fs superblock, bytes */
169 struct partition { /* the partition table */
170 u_int32_t p_size; /* number of sectors in partition */
171 u_int32_t p_offset; /* starting sector */
172 u_int32_t p_fsize; /* filesystem basic fragment size */
173 u_int8_t p_fstype; /* filesystem type, see below */
174 u_int8_t p_frag; /* filesystem fragments per block */
175 union {
176 u_int16_t cpg; /* UFS: FS cylinders per group */
177 u_int16_t sgs; /* LFS: FS segment shift */
178 } __partition_u1;
179 #define p_cpg __partition_u1.cpg
180 #define p_sgs __partition_u1.sgs
181 } d_partitions[MAXPARTITIONS]; /* actually may be more */
182 };
183
184 static u_int16_t dkcksum(struct disklabel *lp);
185
186 static __inline u_int16_t
187 dkcksum(struct disklabel *lp)
188 {
189 u_int16_t *start, *end;
190 u_int16_t sum = 0;
191
192 start = (u_int16_t *)lp;
193 end = (u_int16_t *)&lp->d_partitions[lp->d_npartitions];
194 while (start < end)
195 sum ^= *start++;
196 return (sum);
197 }
198
199 #else /* LOCORE */
200 /*
201 * offsets for asm boot files.
202 */
203 .set d_secsize,40
204 .set d_nsectors,44
205 .set d_ntracks,48
206 .set d_ncylinders,52
207 .set d_secpercyl,56
208 .set d_secperunit,60
209 .set d_end_,276 /* size of disk label */
210 #endif /* LOCORE */
211
212 /* d_type values: */
213 #define DTYPE_SMD 1 /* SMD, XSMD; VAX hp/up */
214 #define DTYPE_MSCP 2 /* MSCP */
215 #define DTYPE_DEC 3 /* other DEC (rk, rl) */
216 #define DTYPE_SCSI 4 /* SCSI */
217 #define DTYPE_ESDI 5 /* ESDI interface */
218 #define DTYPE_ST506 6 /* ST506 etc. */
219 #define DTYPE_HPIB 7 /* CS/80 on HP-IB */
220 #define DTYPE_HPFL 8 /* HP Fiber-link */
221 #define DTYPE_FLOPPY 10 /* floppy */
222 #define DTYPE_CCD 11 /* concatenated disk */
223 #define DTYPE_VINUM 12 /* vinum volume */
224 #define DTYPE_DOC2K 13 /* Msys DiskOnChip */
225
226 #if defined(PC98) && !defined(PC98_ATCOMPAT)
227 #define DSTYPE_SEC256 0x80 /* physical sector size=256 */
228 #endif
229
230 #ifdef DKTYPENAMES
231 static char *dktypenames[] = {
232 "unknown",
233 "SMD",
234 "MSCP",
235 "old DEC",
236 "SCSI",
237 "ESDI",
238 "ST506",
239 "HP-IB",
240 "HP-FL",
241 "type 9",
242 "floppy",
243 "CCD",
244 "Vinum",
245 "DOC2K",
246 NULL
247 };
248 #define DKMAXTYPES (sizeof(dktypenames) / sizeof(dktypenames[0]) - 1)
249 #endif
250
251 /*
252 * Filesystem type and version.
253 * Used to interpret other filesystem-specific
254 * per-partition information.
255 */
256 #define FS_UNUSED 0 /* unused */
257 #define FS_SWAP 1 /* swap */
258 #define FS_V6 2 /* Sixth Edition */
259 #define FS_V7 3 /* Seventh Edition */
260 #define FS_SYSV 4 /* System V */
261 #define FS_V71K 5 /* V7 with 1K blocks (4.1, 2.9) */
262 #define FS_V8 6 /* Eighth Edition, 4K blocks */
263 #define FS_BSDFFS 7 /* 4.2BSD fast file system */
264 #define FS_MSDOS 8 /* MSDOS file system */
265 #define FS_BSDLFS 9 /* 4.4BSD log-structured file system */
266 #define FS_OTHER 10 /* in use, but unknown/unsupported */
267 #define FS_HPFS 11 /* OS/2 high-performance file system */
268 #define FS_ISO9660 12 /* ISO 9660, normally CD-ROM */
269 #define FS_BOOT 13 /* partition contains bootstrap */
270 #define FS_VINUM 14 /* Vinum drive */
271
272 #ifdef DKTYPENAMES
273 static char *fstypenames[] = {
274 "unused",
275 "swap",
276 "Version 6",
277 "Version 7",
278 "System V",
279 "4.1BSD",
280 "Eighth Edition",
281 "4.2BSD",
282 "MSDOS",
283 "4.4LFS",
284 "unknown",
285 "HPFS",
286 "ISO9660",
287 "boot",
288 "vinum",
289 NULL
290 };
291 #define FSMAXTYPES (sizeof(fstypenames) / sizeof(fstypenames[0]) - 1)
292 #endif
293
294 /*
295 * flags shared by various drives:
296 */
297 #define D_REMOVABLE 0x01 /* removable media */
298 #define D_ECC 0x02 /* supports ECC */
299 #define D_BADSECT 0x04 /* supports bad sector forw. */
300 #define D_RAMDISK 0x08 /* disk emulator */
301 #define D_CHAIN 0x10 /* can do back-back transfers */
302
303 /*
304 * Drive data for SMD.
305 */
306 #define d_smdflags d_drivedata[0]
307 #define D_SSE 0x1 /* supports skip sectoring */
308 #define d_mindist d_drivedata[1]
309 #define d_maxdist d_drivedata[2]
310 #define d_sdist d_drivedata[3]
311
312 /*
313 * Drive data for ST506.
314 */
315 #define d_precompcyl d_drivedata[0]
316 #define d_gap3 d_drivedata[1] /* used only when formatting */
317
318 /*
319 * Drive data for SCSI.
320 */
321 #define d_blind d_drivedata[0]
322
323 #ifndef LOCORE
324 /*
325 * Structure used to perform a format or other raw operation, returning
326 * data and/or register values. Register identification and format
327 * are device- and driver-dependent.
328 */
329 struct format_op {
330 char *df_buf;
331 int df_count; /* value-result */
332 daddr_t df_startblk;
333 int df_reg[8]; /* result */
334 };
335
336 /*
337 * Structure used internally to retrieve information about a partition
338 * on a disk.
339 */
340 struct partinfo {
341 struct disklabel *disklab;
342 struct partition *part;
343 };
344
345 /* DOS partition table -- located in boot block */
346
347 #if defined(PC98) && !defined(PC98_ATCOMPAT)
348 #define DOSBBSECTOR 0 /* DOS boot block relative sector number */
349 #define DOSLABELSECTOR 1 /* 0: 256b/s, 1: 512b/s */
350 #define DOSPARTOFF 0
351 #define NDOSPART 16
352 #define DOSPTYP_386BSD 0x94 /* 386BSD partition type */
353 #define MBR_PTYPE_FreeBSD 0x94 /* FreeBSD partition type */
354
355 struct dos_partition {
356 unsigned char dp_mid;
357 #define DOSMID_386BSD (0x14|0x80) /* 386bsd|bootable */
358 unsigned char dp_sid;
359 #define DOSSID_386BSD (0x44|0x80) /* 386bsd|active */
360 unsigned char dp_dum1;
361 unsigned char dp_dum2;
362 unsigned char dp_ipl_sct;
363 unsigned char dp_ipl_head;
364 unsigned short dp_ipl_cyl;
365 unsigned char dp_ssect; /* starting sector */
366 unsigned char dp_shd; /* starting head */
367 unsigned short dp_scyl; /* starting cylinder */
368 unsigned char dp_esect; /* end sector */
369 unsigned char dp_ehd; /* end head */
370 unsigned short dp_ecyl; /* end cylinder */
371 unsigned char dp_name[16];
372 };
373
374 #else /* IBMPC */
375 #define DOSBBSECTOR 0 /* DOS boot block relative sector number */
376 #define DOSPARTOFF 446
377 #define NDOSPART 4
378 #define DOSPTYP_386BSD 0xa5 /* 386BSD partition type */
379 #define DOSPTYP_LINSWP 0x82 /* Linux swap partition */
380 #define DOSPTYP_LINUX 0x83 /* Linux partition */
381 #define DOSPTYP_EXT 5 /* DOS extended partition */
382
383 struct dos_partition {
384 unsigned char dp_flag; /* bootstrap flags */
385 unsigned char dp_shd; /* starting head */
386 unsigned char dp_ssect; /* starting sector */
387 unsigned char dp_scyl; /* starting cylinder */
388 unsigned char dp_typ; /* partition type */
389 unsigned char dp_ehd; /* end head */
390 unsigned char dp_esect; /* end sector */
391 unsigned char dp_ecyl; /* end cylinder */
392 u_int32_t dp_start; /* absolute starting sector number */
393 u_int32_t dp_size; /* partition size in sectors */
394 };
395 #endif
396
397 #define DPSECT(s) ((s) & 0x3f) /* isolate relevant bits of sector */
398 #define DPCYL(c, s) ((c) + (((s) & 0xc0)<<2)) /* and those that are cylinder */
399
400 /*
401 * Disk-specific ioctls.
402 */
403 /* get and set disklabel; DIOCGPART used internally */
404 #define DIOCGDINFO _IOR('d', 101, struct disklabel)/* get */
405 #define DIOCSDINFO _IOW('d', 102, struct disklabel)/* set */
406 #define DIOCWDINFO _IOW('d', 103, struct disklabel)/* set, update disk */
407 #define DIOCGPART _IOW('d', 104, struct partinfo) /* get partition */
408 #define DIOCGDVIRGIN _IOR('d', 105, struct disklabel) /* get virgin label */
409
410 #define DIOCWLABEL _IOW('d', 109, int) /* write en/disable label */
411
412 #ifdef _KERNEL
413
414 /*
415 * XXX encoding of disk minor numbers, should be elsewhere.
416 *
417 * See <sys/reboot.h> for a possibly better encoding.
418 *
419 * "cpio -H newc" can be used to back up device files with large minor
420 * numbers (but not ones >= 2^31). Old cpio formats and all tar formats
421 * don't have enough bits, and cpio and tar don't notice the lossage.
422 * There are also some sign extension bugs.
423 */
424
425 /*
426 3 2 1 0
427 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
428 _________________________________________________________________
429 | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
430 -----------------------------------------------------------------
431 | TYPE |UNIT_2 | SLICE | MAJOR? | UNIT |PART |
432 -----------------------------------------------------------------
433 */
434
435 #define DKMAXUNIT 0x1ff /* Highest disk unit number */
436
437 #define dkmakeminor(unit, slice, part) \
438 (((slice) << 16) | (((unit) & 0x1e0) << 16) | \
439 (((unit) & 0x1f) << 3) | (part))
440 static __inline dev_t
441 dkmodpart(dev_t dev, int part)
442 {
443 return (makedev(major(dev), (minor(dev) & ~7) | part));
444 }
445
446 static __inline dev_t
447 dkmodslice(dev_t dev, int slice)
448 {
449 return (makedev(major(dev), (minor(dev) & ~0x1f0000) | (slice << 16)));
450 }
451
452 #define dkpart(dev) (minor(dev) & 7)
453 #define dkslice(dev) ((minor(dev) >> 16) & 0x1f)
454 #define dktype(dev) ((minor(dev) >> 25) & 0x7f)
455
456 static __inline u_int
457 dkunit(dev_t dev)
458 {
459 return (((minor(dev) >> 16) & 0x1e0) | ((minor(dev) >> 3) & 0x1f));
460 }
461
462 struct buf;
463 struct buf_queue_head;
464
465 int bounds_check_with_label __P((struct buf *bp, struct disklabel *lp,
466 int wlabel));
467 void diskerr __P((struct buf *bp, char *what, int pri, int blkdone,
468 struct disklabel *lp));
469 void disksort __P((struct buf *ap, struct buf *bp));
470 char *readdisklabel __P((dev_t dev, struct disklabel *lp));
471 void bufqdisksort __P((struct buf_queue_head *ap, struct buf *bp));
472 int setdisklabel __P((struct disklabel *olp, struct disklabel *nlp,
473 u_long openmask));
474 int writedisklabel __P((dev_t dev, struct disklabel *lp));
475 #ifdef __alpha__
476 void alpha_fix_srm_checksum __P((struct buf *bp));
477 #endif
478
479 #endif /* _KERNEL */
480
481 #endif /* LOCORE */
482
483 #ifndef _KERNEL
484 __BEGIN_DECLS
485 struct disklabel *getdiskbyname __P((const char *));
486 __END_DECLS
487 #endif
488
489 #endif /* !_SYS_DISKLABEL_H_ */
Cache object: 3b1776be3cd59c4db0a00859bf6ccf31
|