HardenedBSD/stand/common/disk.h
Warner Losh 17276525fa stand: Change disk_parsedev() API
Change the first argument to disk_parsedev() to be a pointer to a struct
devdesc *. This now gets filled in with a malloc'd structure that's
returned to the caller that the caller is repsonsible for freeing. Most
places in the tree passed in a malloc'd pointer anyway, and this moves
knowledge of disk_devdesc more firmly into the disk.[ch] code.

Sponsored by:		Netflix
Differential Revision:	https://reviews.freebsd.org/D37335
2022-11-30 15:30:31 -07:00

119 lines
4.0 KiB
C

/*-
* Copyright (c) 2011 Google, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $FreeBSD$
*/
/*
* Device descriptor for partitioned disks. To use, set the
* d_slice and d_partition variables as follows:
*
* Whole disk access:
*
* d_slice = D_SLICENONE
* d_partition = <doesn't matter>
*
* Whole MBR slice:
*
* d_slice = MBR slice number (typically 1..4)
* d_partition = D_PARTNONE
*
* BSD disklabel partition within an MBR slice:
*
* d_slice = MBR slice number (typically 1..4)
* d_partition = disklabel partition (typically 0..19 or D_PARTWILD)
*
* BSD disklabel partition on the true dedicated disk:
*
* d_slice = D_SLICENONE
* d_partition = disklabel partition (typically 0..19 or D_PARTWILD)
*
* GPT partition:
*
* d_slice = GPT partition number (typically 1..N)
* d_partition = D_PARTISGPT
*
* For MBR, setting d_partition to D_PARTWILD will automatically use the first
* partition within the slice.
*
* For both MBR and GPT, to automatically find the 'best' slice and partition,
* set d_slice to D_SLICEWILD. This uses the partition type to decide which
* partition to use according to the following list of preferences:
*
* FreeBSD (active)
* FreeBSD (inactive)
* Linux (active)
* Linux (inactive)
* DOS/Windows (active)
* DOS/Windows (inactive)
*
* Active MBR slices (marked as bootable) are preferred over inactive. GPT
* doesn't have the concept of active/inactive partitions. In both MBR and GPT,
* if there are multiple slices/partitions of a given type, the first one
* is chosen.
*
* The low-level disk device will typically call disk_open() from its open
* method to interpret the disk partition tables according to the rules above.
* This will initialize d_offset to the block offset of the start of the
* selected partition - this offset should be added to the offset passed to
* the device's strategy method.
*/
#ifndef _DISK_H
#define _DISK_H
#define D_SLICENONE -1
#define D_SLICEWILD 0
#define D_PARTNONE -1
#define D_PARTWILD -2
#define D_PARTISGPT 255
struct disk_devdesc {
struct devdesc dd; /* Must be first. */
int d_slice;
int d_partition;
uint64_t d_offset;
};
/*
* Parse disk metadata and initialise dev->d_offset.
*/
extern int disk_open(struct disk_devdesc *, uint64_t, u_int);
extern int disk_close(struct disk_devdesc *);
extern int disk_ioctl(struct disk_devdesc *, u_long, void *);
extern int disk_read(struct disk_devdesc *, void *, uint64_t, u_int);
extern int disk_write(struct disk_devdesc *, void *, uint64_t, u_int);
extern int ptblread(void *, void *, size_t, uint64_t);
/*
* Print information about slices on a disk.
*/
extern int disk_print(struct disk_devdesc *, char *, int);
extern int disk_parsedev(struct devdesc **, const char *, const char **);
char *disk_fmtdev(struct devdesc *vdev);
#endif /* _DISK_H */