geom_disk.h revision 219056 
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 219056 2011-02-26 14:58:54Z nwhitehorn $
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
47struct disk;
48
49typedef	int	disk_open_t(struct disk *);
50typedef	int	disk_close_t(struct disk *);
51typedef	void	disk_strategy_t(struct bio *bp);
52typedef	int	disk_ioctl_t(struct disk *, u_long cmd, void *data,
53			int fflag, struct thread *td);
54		/* NB: disk_ioctl_t SHALL be cast'able to d_ioctl_t */
55
56struct g_geom;
57struct devstat;
58
59struct disk {
60	/* Fields which are private to geom_disk */
61	struct g_geom		*d_geom;
62	struct devstat		*d_devstat;
63	int			d_destroyed;
64
65	/* Shared fields */
66	u_int			d_flags;
67	const char		*d_name;
68	u_int			d_unit;
69	struct bio_queue_head	*d_queue;
70	struct mtx		*d_lock;
71
72	/* Disk methods  */
73	disk_open_t		*d_open;
74	disk_close_t		*d_close;
75	disk_strategy_t		*d_strategy;
76	disk_ioctl_t		*d_ioctl;
77	dumper_t		*d_dump;
78
79	/* Info fields from driver to geom_disk.c. Valid when open */
80	u_int			d_sectorsize;
81	off_t			d_mediasize;
82	u_int			d_fwsectors;
83	u_int			d_fwheads;
84	u_int			d_maxsize;
85	u_int			d_stripeoffset;
86	u_int			d_stripesize;
87	char			d_ident[DISK_IDENT_SIZE];
88	char			d_descr[DISK_IDENT_SIZE];
89	uint16_t		d_hba_vendor;
90	uint16_t		d_hba_device;
91	uint16_t		d_hba_subvendor;
92	uint16_t		d_hba_subdevice;
93
94	/* Fields private to the driver */
95	void			*d_drv1;
96};
97
98#define DISKFLAG_NEEDSGIANT	0x1
99#define DISKFLAG_OPEN		0x2
100#define DISKFLAG_CANDELETE	0x4
101#define DISKFLAG_CANFLUSHCACHE	0x8
102
103struct disk *disk_alloc(void);
104void disk_create(struct disk *disk, int version);
105void disk_destroy(struct disk *disk);
106void disk_gone(struct disk *disk);
107
108#define DISK_VERSION_00		0x58561059
109#define DISK_VERSION_01		0x5856105a
110#define DISK_VERSION		DISK_VERSION_01
111
112#endif /* _KERNEL */
113#endif /* _GEOM_GEOM_DISK_H_ */
114