geom_disk.h revision 302150 
1/*-
2 * Copyright (c) 2003 Poul-Henning Kamp
3 * All rights reserved.
4 *
5 * This software was developed for the FreeBSD Project by Poul-Henning Kamp
6 * and NAI Labs, the Security Research Division of Network Associates, Inc.
7 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
8 * DARPA CHATS research program.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. The names of the authors may not be used to endorse or promote
19 *    products derived from this software without specific prior written
20 *    permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 * $FreeBSD: head/sys/geom/geom_disk.h 302150 2016-06-23 20:05:59Z ken $
35 */
36
37#ifndef _GEOM_GEOM_DISK_H_
38#define _GEOM_GEOM_DISK_H_
39
40#ifdef _KERNEL
41
42#include <sys/queue.h>
43#include <sys/_lock.h>
44#include <sys/_mutex.h>
45#include <sys/disk.h>
46
47#define G_DISK_CLASS_NAME	"DISK"
48
49struct disk;
50
51typedef	int	disk_open_t(struct disk *);
52typedef	int	disk_close_t(struct disk *);
53typedef	void	disk_strategy_t(struct bio *bp);
54typedef	int	disk_getattr_t(struct bio *bp);
55typedef	void	disk_gone_t(struct disk *);
56typedef	int	disk_ioctl_t(struct disk *, u_long cmd, void *data,
57			int fflag, struct thread *td);
58		/* NB: disk_ioctl_t SHALL be cast'able to d_ioctl_t */
59
60struct g_geom;
61struct devstat;
62
63typedef enum {
64	DISK_INIT_NONE,
65	DISK_INIT_START,
66	DISK_INIT_DONE
67} disk_init_level;
68
69struct disk {
70	/* Fields which are private to geom_disk */
71	struct g_geom		*d_geom;
72	struct devstat		*d_devstat;
73	int			d_goneflag;
74	int			d_destroyed;
75	disk_init_level		d_init_level;
76
77	/* Shared fields */
78	u_int			d_flags;
79	const char		*d_name;
80	u_int			d_unit;
81	struct bio_queue_head	*d_queue;
82	struct mtx		*d_lock;
83
84	/* Disk methods  */
85	disk_open_t		*d_open;
86	disk_close_t		*d_close;
87	disk_strategy_t		*d_strategy;
88	disk_ioctl_t		*d_ioctl;
89	dumper_t		*d_dump;
90	disk_getattr_t		*d_getattr;
91	disk_gone_t		*d_gone;
92
93	/* Info fields from driver to geom_disk.c. Valid when open */
94	u_int			d_sectorsize;
95	off_t			d_mediasize;
96	u_int			d_fwsectors;
97	u_int			d_fwheads;
98	u_int			d_maxsize;
99	off_t			d_delmaxsize;
100	u_int			d_stripeoffset;
101	u_int			d_stripesize;
102	char			d_ident[DISK_IDENT_SIZE];
103	char			d_descr[DISK_IDENT_SIZE];
104	uint16_t		d_hba_vendor;
105	uint16_t		d_hba_device;
106	uint16_t		d_hba_subvendor;
107	uint16_t		d_hba_subdevice;
108	uint16_t		d_rotation_rate;
109
110	/* Fields private to the driver */
111	void			*d_drv1;
112};
113
114#define DISKFLAG_RESERVED	0x1	/* Was NEEDSGIANT */
115#define DISKFLAG_OPEN		0x2
116#define DISKFLAG_CANDELETE	0x4
117#define DISKFLAG_CANFLUSHCACHE	0x8
118#define	DISKFLAG_UNMAPPED_BIO	0x10
119#define	DISKFLAG_DIRECT_COMPLETION	0x20
120#define	DISKFLAG_CANZONE	0x80
121
122struct disk *disk_alloc(void);
123void disk_create(struct disk *disk, int version);
124void disk_destroy(struct disk *disk);
125void disk_gone(struct disk *disk);
126void disk_attr_changed(struct disk *dp, const char *attr, int flag);
127void disk_media_changed(struct disk *dp, int flag);
128void disk_media_gone(struct disk *dp, int flag);
129int disk_resize(struct disk *dp, int flag);
130
131#define DISK_VERSION_00		0x58561059
132#define DISK_VERSION_01		0x5856105a
133#define DISK_VERSION_02		0x5856105b
134#define DISK_VERSION_03		0x5856105c
135#define DISK_VERSION_04		0x5856105d
136#define DISK_VERSION_05		0x5856105e
137#define DISK_VERSION		DISK_VERSION_05
138
139#endif /* _KERNEL */
140#endif /* _GEOM_GEOM_DISK_H_ */
141