xref: /freebsd/sys/geom/geom.h (revision a450ecfdbd954f5b10a3b6eb74b1cd863b2b5c1c)
1dd84a43cSPoul-Henning Kamp /*-
23728855aSPedro F. Giffuni  * SPDX-License-Identifier: BSD-3-Clause
33728855aSPedro F. Giffuni  *
4dd84a43cSPoul-Henning Kamp  * Copyright (c) 2002 Poul-Henning Kamp
5dd84a43cSPoul-Henning Kamp  * Copyright (c) 2002 Networks Associates Technology, Inc.
6dd84a43cSPoul-Henning Kamp  * All rights reserved.
7dd84a43cSPoul-Henning Kamp  *
8dd84a43cSPoul-Henning Kamp  * This software was developed for the FreeBSD Project by Poul-Henning Kamp
9dd84a43cSPoul-Henning Kamp  * and NAI Labs, the Security Research Division of Network Associates, Inc.
10dd84a43cSPoul-Henning Kamp  * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
11dd84a43cSPoul-Henning Kamp  * DARPA CHATS research program.
12dd84a43cSPoul-Henning Kamp  *
13dd84a43cSPoul-Henning Kamp  * Redistribution and use in source and binary forms, with or without
14dd84a43cSPoul-Henning Kamp  * modification, are permitted provided that the following conditions
15dd84a43cSPoul-Henning Kamp  * are met:
16dd84a43cSPoul-Henning Kamp  * 1. Redistributions of source code must retain the above copyright
17dd84a43cSPoul-Henning Kamp  *    notice, this list of conditions and the following disclaimer.
18dd84a43cSPoul-Henning Kamp  * 2. Redistributions in binary form must reproduce the above copyright
19dd84a43cSPoul-Henning Kamp  *    notice, this list of conditions and the following disclaimer in the
20dd84a43cSPoul-Henning Kamp  *    documentation and/or other materials provided with the distribution.
21dd84a43cSPoul-Henning Kamp  * 3. The names of the authors may not be used to endorse or promote
22dd84a43cSPoul-Henning Kamp  *    products derived from this software without specific prior written
23dd84a43cSPoul-Henning Kamp  *    permission.
24dd84a43cSPoul-Henning Kamp  *
25dd84a43cSPoul-Henning Kamp  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
26dd84a43cSPoul-Henning Kamp  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27dd84a43cSPoul-Henning Kamp  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28dd84a43cSPoul-Henning Kamp  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
29dd84a43cSPoul-Henning Kamp  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30dd84a43cSPoul-Henning Kamp  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31dd84a43cSPoul-Henning Kamp  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32dd84a43cSPoul-Henning Kamp  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33dd84a43cSPoul-Henning Kamp  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34dd84a43cSPoul-Henning Kamp  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35dd84a43cSPoul-Henning Kamp  * SUCH DAMAGE.
36dd84a43cSPoul-Henning Kamp  *
37dd84a43cSPoul-Henning Kamp  * $FreeBSD$
38dd84a43cSPoul-Henning Kamp  */
39dd84a43cSPoul-Henning Kamp 
40efb9df5cSPoul-Henning Kamp #ifndef _GEOM_GEOM_H_
41efb9df5cSPoul-Henning Kamp #define _GEOM_GEOM_H_
42efb9df5cSPoul-Henning Kamp 
43dd84a43cSPoul-Henning Kamp #include <sys/lock.h>
44dd84a43cSPoul-Henning Kamp #include <sys/mutex.h>
45dd84a43cSPoul-Henning Kamp #include <sys/sx.h>
46dd84a43cSPoul-Henning Kamp #include <sys/queue.h>
4753705e35SPoul-Henning Kamp #include <sys/ioccom.h>
4806f4c96dSAlexander Motin #include <sys/conf.h>
496c87f8d5SPoul-Henning Kamp #include <sys/module.h>
50dd84a43cSPoul-Henning Kamp 
51e805e8f0SPoul-Henning Kamp struct g_class;
52dd84a43cSPoul-Henning Kamp struct g_geom;
53dd84a43cSPoul-Henning Kamp struct g_consumer;
54dd84a43cSPoul-Henning Kamp struct g_provider;
554ec35300SPoul-Henning Kamp struct g_stat;
56dd84a43cSPoul-Henning Kamp struct thread;
57dd84a43cSPoul-Henning Kamp struct bio;
58dd84a43cSPoul-Henning Kamp struct sbuf;
5963728c47SPoul-Henning Kamp struct gctl_req;
60e6e14239SPoul-Henning Kamp struct g_configargs;
619a6844d5SKenneth D. Merry struct disk_zone_args;
62dd84a43cSPoul-Henning Kamp 
63e6e14239SPoul-Henning Kamp typedef int g_config_t (struct g_configargs *ca);
6483d771deSPoul-Henning Kamp typedef void g_ctl_req_t (struct gctl_req *, struct g_class *cp, char const *verb);
6563728c47SPoul-Henning Kamp typedef int g_ctl_create_geom_t (struct gctl_req *, struct g_class *cp, struct g_provider *pp);
6663728c47SPoul-Henning Kamp typedef int g_ctl_destroy_geom_t (struct gctl_req *, struct g_class *cp, struct g_geom *gp);
67ea9ab6beSPoul-Henning Kamp typedef int g_ctl_config_geom_t (struct gctl_req *, struct g_geom *gp, const char *verb);
686c87f8d5SPoul-Henning Kamp typedef void g_init_t (struct g_class *mp);
696c87f8d5SPoul-Henning Kamp typedef void g_fini_t (struct g_class *mp);
70497c3347SPoul-Henning Kamp typedef struct g_geom * g_taste_t (struct g_class *, struct g_provider *, int flags);
712221dbebSPoul-Henning Kamp typedef int g_ioctl_t(struct g_provider *pp, u_long cmd, void *data, int fflag, struct thread *td);
72dd84a43cSPoul-Henning Kamp #define G_TF_NORMAL		0
73dd84a43cSPoul-Henning Kamp #define G_TF_INSIST		1
74dd84a43cSPoul-Henning Kamp #define G_TF_TRANSPARENT	2
75dd84a43cSPoul-Henning Kamp typedef int g_access_t (struct g_provider *, int, int, int);
76dd84a43cSPoul-Henning Kamp /* XXX: not sure about the thread arg */
77b1876192SPoul-Henning Kamp typedef void g_orphan_t (struct g_consumer *);
78dd84a43cSPoul-Henning Kamp 
79dd84a43cSPoul-Henning Kamp typedef void g_start_t (struct bio *);
80dd84a43cSPoul-Henning Kamp typedef void g_spoiled_t (struct g_consumer *);
81416494d7SJustin T. Gibbs typedef void g_attrchanged_t (struct g_consumer *, const char *attr);
82c3fb2891SKenneth D. Merry typedef void g_provgone_t (struct g_provider *);
830f9d3dbaSPoul-Henning Kamp typedef void g_dumpconf_t (struct sbuf *, const char *indent, struct g_geom *,
84dd84a43cSPoul-Henning Kamp     struct g_consumer *, struct g_provider *);
85245899ccSEdward Tomasz Napierala typedef void g_resize_t(struct g_consumer *cp);
86dd84a43cSPoul-Henning Kamp 
87dd84a43cSPoul-Henning Kamp /*
88e805e8f0SPoul-Henning Kamp  * The g_class structure describes a transformation class.  In other words
89e805e8f0SPoul-Henning Kamp  * all BSD disklabel handlers share one g_class, all MBR handlers share
90e805e8f0SPoul-Henning Kamp  * one common g_class and so on.
91e805e8f0SPoul-Henning Kamp  * Certain operations are instantiated on the class, most notably the
92e6e14239SPoul-Henning Kamp  * taste and config_geom functions.
93dd84a43cSPoul-Henning Kamp  */
94e805e8f0SPoul-Henning Kamp struct g_class {
950f9d3dbaSPoul-Henning Kamp 	const char		*name;
96dd66958eSPoul-Henning Kamp 	u_int			version;
978d680f2cSPawel Jakub Dawidek 	u_int			spare0;
98dd84a43cSPoul-Henning Kamp 	g_taste_t		*taste;
99e6e14239SPoul-Henning Kamp 	g_config_t		*config;
10083d771deSPoul-Henning Kamp 	g_ctl_req_t		*ctlreq;
1016c87f8d5SPoul-Henning Kamp 	g_init_t		*init;
1026c87f8d5SPoul-Henning Kamp 	g_fini_t		*fini;
10363728c47SPoul-Henning Kamp 	g_ctl_destroy_geom_t	*destroy_geom;
10407d77fc6SPoul-Henning Kamp 	/*
105ac4b76b7SPoul-Henning Kamp 	 * Default values for geom methods
106dd66958eSPoul-Henning Kamp 	 */
107dd66958eSPoul-Henning Kamp 	g_start_t		*start;
108dd66958eSPoul-Henning Kamp 	g_spoiled_t		*spoiled;
109416494d7SJustin T. Gibbs 	g_attrchanged_t		*attrchanged;
110dd66958eSPoul-Henning Kamp 	g_dumpconf_t		*dumpconf;
111dd66958eSPoul-Henning Kamp 	g_access_t		*access;
112dd66958eSPoul-Henning Kamp 	g_orphan_t		*orphan;
113dd66958eSPoul-Henning Kamp 	g_ioctl_t		*ioctl;
114365e076eSKenneth D. Merry 	g_provgone_t		*providergone;
115245899ccSEdward Tomasz Napierala 	g_resize_t		*resize;
116edad9799SKenneth D. Merry 	void			*spare1;
1178fe76779SEdward Tomasz Napierala 	void			*spare2;
118dd66958eSPoul-Henning Kamp 	/*
119f075585fSPoul-Henning Kamp 	 * The remaining elements are private
12007d77fc6SPoul-Henning Kamp 	 */
121e805e8f0SPoul-Henning Kamp 	LIST_ENTRY(g_class)	class;
122dd84a43cSPoul-Henning Kamp 	LIST_HEAD(,g_geom)	geom;
123dd84a43cSPoul-Henning Kamp };
124dd84a43cSPoul-Henning Kamp 
125dd66958eSPoul-Henning Kamp #define G_VERSION_00	0x19950323
1262221dbebSPoul-Henning Kamp #define G_VERSION_01	0x20041207	/* add fflag to g_ioctl_t */
1272221dbebSPoul-Henning Kamp #define G_VERSION	G_VERSION_01
128dd66958eSPoul-Henning Kamp 
129dd84a43cSPoul-Henning Kamp /*
130e805e8f0SPoul-Henning Kamp  * The g_geom is an instance of a g_class.
131dd84a43cSPoul-Henning Kamp  */
132dd84a43cSPoul-Henning Kamp struct g_geom {
133dd84a43cSPoul-Henning Kamp 	char			*name;
134e805e8f0SPoul-Henning Kamp 	struct g_class		*class;
135dd84a43cSPoul-Henning Kamp 	LIST_ENTRY(g_geom)	geom;
136dd84a43cSPoul-Henning Kamp 	LIST_HEAD(,g_consumer)	consumer;
137dd84a43cSPoul-Henning Kamp 	LIST_HEAD(,g_provider)	provider;
138dd84a43cSPoul-Henning Kamp 	TAILQ_ENTRY(g_geom)	geoms;	/* XXX: better name */
139dd84a43cSPoul-Henning Kamp 	int			rank;
140dd84a43cSPoul-Henning Kamp 	g_start_t		*start;
141dd84a43cSPoul-Henning Kamp 	g_spoiled_t		*spoiled;
142416494d7SJustin T. Gibbs 	g_attrchanged_t		*attrchanged;
143dd84a43cSPoul-Henning Kamp 	g_dumpconf_t		*dumpconf;
14407d77fc6SPoul-Henning Kamp 	g_access_t		*access;
14507d77fc6SPoul-Henning Kamp 	g_orphan_t		*orphan;
146497c3347SPoul-Henning Kamp 	g_ioctl_t		*ioctl;
147365e076eSKenneth D. Merry 	g_provgone_t		*providergone;
148245899ccSEdward Tomasz Napierala 	g_resize_t		*resize;
149edad9799SKenneth D. Merry 	void			*spare0;
1508fe76779SEdward Tomasz Napierala 	void			*spare1;
151dd84a43cSPoul-Henning Kamp 	void			*softc;
152dd84a43cSPoul-Henning Kamp 	unsigned		flags;
153aca41af2SAndriy Gapon #define	G_GEOM_WITHER		0x01
154aca41af2SAndriy Gapon #define	G_GEOM_VOLATILE_BIO	0x02
155aca41af2SAndriy Gapon #define	G_GEOM_IN_ACCESS	0x04
156aca41af2SAndriy Gapon #define	G_GEOM_ACCESS_WAIT	0x08
157dd84a43cSPoul-Henning Kamp };
158dd84a43cSPoul-Henning Kamp 
159dd84a43cSPoul-Henning Kamp /*
160dd84a43cSPoul-Henning Kamp  * The g_bioq is a queue of struct bio's.
161dd84a43cSPoul-Henning Kamp  * XXX: possibly collection point for statistics.
162dd84a43cSPoul-Henning Kamp  * XXX: should (possibly) be collapsed with sys/bio.h::bio_queue_head.
163dd84a43cSPoul-Henning Kamp  */
164dd84a43cSPoul-Henning Kamp struct g_bioq {
165dd84a43cSPoul-Henning Kamp 	TAILQ_HEAD(, bio)	bio_queue;
166dd84a43cSPoul-Henning Kamp 	struct mtx		bio_queue_lock;
167dd84a43cSPoul-Henning Kamp 	int			bio_queue_length;
168dd84a43cSPoul-Henning Kamp };
169dd84a43cSPoul-Henning Kamp 
170dd84a43cSPoul-Henning Kamp /*
171dd84a43cSPoul-Henning Kamp  * A g_consumer is an attachment point for a g_provider.  One g_consumer
172dd84a43cSPoul-Henning Kamp  * can only be attached to one g_provider, but multiple g_consumers
173dd84a43cSPoul-Henning Kamp  * can be attached to one g_provider.
174dd84a43cSPoul-Henning Kamp  */
175dd84a43cSPoul-Henning Kamp 
176dd84a43cSPoul-Henning Kamp struct g_consumer {
177dd84a43cSPoul-Henning Kamp 	struct g_geom		*geom;
178dd84a43cSPoul-Henning Kamp 	LIST_ENTRY(g_consumer)	consumer;
179dd84a43cSPoul-Henning Kamp 	struct g_provider	*provider;
180dd84a43cSPoul-Henning Kamp 	LIST_ENTRY(g_consumer)	consumers;	/* XXX: better name */
181dd84a43cSPoul-Henning Kamp 	int			acr, acw, ace;
1823631c638SAlexander Motin 	int			flags;
1833631c638SAlexander Motin #define G_CF_SPOILED		0x1
1843631c638SAlexander Motin #define G_CF_ORPHAN		0x4
18540ea77a0SAlexander Motin #define G_CF_DIRECT_SEND	0x10
18640ea77a0SAlexander Motin #define G_CF_DIRECT_RECEIVE	0x20
187e24cbd90SPoul-Henning Kamp 	struct devstat		*stat;
1880e082fccSPoul-Henning Kamp 	u_int			nstart, nend;
189f865123eSPoul-Henning Kamp 
190f865123eSPoul-Henning Kamp 	/* Two fields for the implementing class to use */
191f865123eSPoul-Henning Kamp 	void			*private;
192f865123eSPoul-Henning Kamp 	u_int			index;
193dd84a43cSPoul-Henning Kamp };
194dd84a43cSPoul-Henning Kamp 
195dd84a43cSPoul-Henning Kamp /*
196ae1cce52SWarner Losh  * The g_geom_alias is a list node for aliases for the provider name for device
197ae1cce52SWarner Losh  * node creation.
198ae1cce52SWarner Losh  */
199ae1cce52SWarner Losh struct g_geom_alias {
200ae1cce52SWarner Losh 	LIST_ENTRY(g_geom_alias) ga_next;
201ae1cce52SWarner Losh 	const char		*ga_alias;
202ae1cce52SWarner Losh };
203ae1cce52SWarner Losh 
204ae1cce52SWarner Losh /*
205dd84a43cSPoul-Henning Kamp  * A g_provider is a "logical disk".
206dd84a43cSPoul-Henning Kamp  */
207dd84a43cSPoul-Henning Kamp struct g_provider {
208dd84a43cSPoul-Henning Kamp 	char			*name;
209dd84a43cSPoul-Henning Kamp 	LIST_ENTRY(g_provider)	provider;
210dd84a43cSPoul-Henning Kamp 	struct g_geom		*geom;
211dd84a43cSPoul-Henning Kamp 	LIST_HEAD(,g_consumer)	consumers;
212dd84a43cSPoul-Henning Kamp 	int			acr, acw, ace;
213dd84a43cSPoul-Henning Kamp 	int			error;
214dd84a43cSPoul-Henning Kamp 	TAILQ_ENTRY(g_provider)	orphan;
2152fccec19SPoul-Henning Kamp 	off_t			mediasize;
21648444d62SPoul-Henning Kamp 	u_int			sectorsize;
2176d305ab0SEugene Grosbein 	off_t			stripesize;
2186d305ab0SEugene Grosbein 	off_t			stripeoffset;
219e24cbd90SPoul-Henning Kamp 	struct devstat		*stat;
2209794a803SAlexander Motin 	u_int			spare1;
2219794a803SAlexander Motin 	u_int			spare2;
22283333d45SPoul-Henning Kamp 	u_int			flags;
22390916ef7SPoul-Henning Kamp #define G_PF_WITHER		0x2
224d0265773SPoul-Henning Kamp #define G_PF_ORPHAN		0x4
225ee75e7deSKonstantin Belousov #define	G_PF_ACCEPT_UNMAPPED	0x8
22640ea77a0SAlexander Motin #define G_PF_DIRECT_SEND	0x10
22740ea77a0SAlexander Motin #define G_PF_DIRECT_RECEIVE	0x20
228ae1cce52SWarner Losh 	LIST_HEAD(,g_geom_alias) aliases;
229f865123eSPoul-Henning Kamp 
230f865123eSPoul-Henning Kamp 	/* Two fields for the implementing class to use */
231f865123eSPoul-Henning Kamp 	void			*private;
232f865123eSPoul-Henning Kamp 	u_int			index;
233dd84a43cSPoul-Henning Kamp };
234dd84a43cSPoul-Henning Kamp 
235c6d4ed3aSAlexander Motin /* BIO_GETATTR("GEOM::setstate") argument values. */
236c6d4ed3aSAlexander Motin #define G_STATE_FAILED		0
237c6d4ed3aSAlexander Motin #define G_STATE_REBUILD		1
238c6d4ed3aSAlexander Motin #define G_STATE_RESYNC		2
239c6d4ed3aSAlexander Motin #define G_STATE_ACTIVE		3
240c6d4ed3aSAlexander Motin 
241ce225127SPoul-Henning Kamp /* geom_dev.c */
24289c9c53dSPoul-Henning Kamp struct cdev;
24384c080a8SPoul-Henning Kamp void g_dev_print(void);
244416494d7SJustin T. Gibbs void g_dev_physpath_changed(void);
24589c9c53dSPoul-Henning Kamp struct g_provider *g_dev_getprovider(struct cdev *dev);
246ce225127SPoul-Henning Kamp 
247dd84a43cSPoul-Henning Kamp /* geom_dump.c */
2482efaef42SAlexander Motin void (g_trace)(int level, const char *, ...) __printflike(2, 3);
249c4c88d47SAlexander Motin #define	G_T_TOPOLOGY		0x01
250c4c88d47SAlexander Motin #define	G_T_BIO			0x02
251c4c88d47SAlexander Motin #define	G_T_ACCESS		0x04
2522efaef42SAlexander Motin extern int g_debugflags;
253c4c88d47SAlexander Motin #define	G_F_FOOTSHOOTING	0x10
254c4c88d47SAlexander Motin #define	G_F_DISKIOCTL		0x40
255c4c88d47SAlexander Motin #define	G_F_CTLDUMP		0x80
2562efaef42SAlexander Motin #define	g_trace(level, fmt, ...) do {				\
2572efaef42SAlexander Motin 	if (__predict_false(g_debugflags & (level)))		\
2582efaef42SAlexander Motin 		(g_trace)(level, fmt, ## __VA_ARGS__);		\
2592efaef42SAlexander Motin } while (0)
2603773a65cSPoul-Henning Kamp 
261dd84a43cSPoul-Henning Kamp /* geom_event.c */
2628cd1535aSPoul-Henning Kamp typedef void g_event_t(void *, int flag);
263316aed03SPoul-Henning Kamp #define EV_CANCEL	1
2648cd1535aSPoul-Henning Kamp int g_post_event(g_event_t *func, void *arg, int flag, ...);
2650a9c130cSPoul-Henning Kamp int g_waitfor_event(g_event_t *func, void *arg, int flag, ...);
266316aed03SPoul-Henning Kamp void g_cancel_event(void *ref);
267416494d7SJustin T. Gibbs int g_attr_changed(struct g_provider *pp, const char *attr, int flag);
2683631c638SAlexander Motin int g_media_changed(struct g_provider *pp, int flag);
2693631c638SAlexander Motin int g_media_gone(struct g_provider *pp, int flag);
270dd84a43cSPoul-Henning Kamp void g_orphan_provider(struct g_provider *pp, int error);
271b8005b9bSPawel Jakub Dawidek void g_waitidlelock(void);
272dd84a43cSPoul-Henning Kamp 
273dd84a43cSPoul-Henning Kamp /* geom_subr.c */
274d2bae332SPoul-Henning Kamp int g_access(struct g_consumer *cp, int nread, int nwrite, int nexcl);
275dd84a43cSPoul-Henning Kamp int g_attach(struct g_consumer *cp, struct g_provider *pp);
27690f2be24SAlexander Motin int g_compare_names(const char *namea, const char *nameb);
277dd84a43cSPoul-Henning Kamp void g_destroy_consumer(struct g_consumer *cp);
278dd84a43cSPoul-Henning Kamp void g_destroy_geom(struct g_geom *pp);
279dd84a43cSPoul-Henning Kamp void g_destroy_provider(struct g_provider *pp);
280503abe45SPoul-Henning Kamp void g_detach(struct g_consumer *cp);
281dd84a43cSPoul-Henning Kamp void g_error_provider(struct g_provider *pp, int error);
282d6c5e716SPoul-Henning Kamp struct g_provider *g_provider_by_name(char const *arg);
283a4ef1c5fSPoul-Henning Kamp int g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len);
284a4ef1c5fSPoul-Henning Kamp #define g_getattr(a, c, v) g_getattr__((a), (c), (v), sizeof *(v))
285709a6266SMarcel Moolenaar int g_handleattr(struct bio *bp, const char *attribute, const void *val,
286709a6266SMarcel Moolenaar     int len);
2870f9d3dbaSPoul-Henning Kamp int g_handleattr_int(struct bio *bp, const char *attribute, int val);
2880f9d3dbaSPoul-Henning Kamp int g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val);
289c28078e9SSteven Hartland int g_handleattr_uint16_t(struct bio *bp, const char *attribute, uint16_t val);
290709a6266SMarcel Moolenaar int g_handleattr_str(struct bio *bp, const char *attribute, const char *str);
291dd84a43cSPoul-Henning Kamp struct g_consumer * g_new_consumer(struct g_geom *gp);
29202c62349SJaakko Heinonen struct g_geom * g_new_geomf(struct g_class *mp, const char *fmt, ...)
29302c62349SJaakko Heinonen     __printflike(2, 3);
29402c62349SJaakko Heinonen struct g_provider * g_new_providerf(struct g_geom *gp, const char *fmt, ...)
29502c62349SJaakko Heinonen     __printflike(2, 3);
296ae1cce52SWarner Losh void g_provider_add_alias(struct g_provider *pp, const char *fmt, ...)
297ae1cce52SWarner Losh     __printflike(2, 3);
298245899ccSEdward Tomasz Napierala void g_resize_provider(struct g_provider *pp, off_t size);
2998a8fcb00SMarcel Moolenaar int g_retaste(struct g_class *mp);
300dd84a43cSPoul-Henning Kamp void g_spoil(struct g_provider *pp, struct g_consumer *cp);
301dd84a43cSPoul-Henning Kamp int g_std_access(struct g_provider *pp, int dr, int dw, int de);
302dd84a43cSPoul-Henning Kamp void g_std_done(struct bio *bp);
303dd84a43cSPoul-Henning Kamp void g_std_spoiled(struct g_consumer *cp);
304d6227ae7SPoul-Henning Kamp void g_wither_geom(struct g_geom *gp, int error);
305725419afSPoul-Henning Kamp void g_wither_geom_close(struct g_geom *gp, int error);
306d99c1559SMarcel Moolenaar void g_wither_provider(struct g_provider *pp, int error);
307dd84a43cSPoul-Henning Kamp 
308679f8b7eSPawel Jakub Dawidek #if defined(DIAGNOSTIC) || defined(DDB)
3093d1d5bc3SPoul-Henning Kamp int g_valid_obj(void const *ptr);
310679f8b7eSPawel Jakub Dawidek #endif
311679f8b7eSPawel Jakub Dawidek #ifdef DIAGNOSTIC
3123d1d5bc3SPoul-Henning Kamp #define G_VALID_CLASS(foo) \
3133d1d5bc3SPoul-Henning Kamp     KASSERT(g_valid_obj(foo) == 1, ("%p is not a g_class", foo))
3143d1d5bc3SPoul-Henning Kamp #define G_VALID_GEOM(foo) \
3153d1d5bc3SPoul-Henning Kamp     KASSERT(g_valid_obj(foo) == 2, ("%p is not a g_geom", foo))
3163d1d5bc3SPoul-Henning Kamp #define G_VALID_CONSUMER(foo) \
3173d1d5bc3SPoul-Henning Kamp     KASSERT(g_valid_obj(foo) == 3, ("%p is not a g_consumer", foo))
3183d1d5bc3SPoul-Henning Kamp #define G_VALID_PROVIDER(foo) \
3193d1d5bc3SPoul-Henning Kamp     KASSERT(g_valid_obj(foo) == 4, ("%p is not a g_provider", foo))
3203d1d5bc3SPoul-Henning Kamp #else
3213d1d5bc3SPoul-Henning Kamp #define G_VALID_CLASS(foo) do { } while (0)
3223d1d5bc3SPoul-Henning Kamp #define G_VALID_GEOM(foo) do { } while (0)
3233d1d5bc3SPoul-Henning Kamp #define G_VALID_CONSUMER(foo) do { } while (0)
3243d1d5bc3SPoul-Henning Kamp #define G_VALID_PROVIDER(foo) do { } while (0)
3253d1d5bc3SPoul-Henning Kamp #endif
3263d1d5bc3SPoul-Henning Kamp 
3276c87f8d5SPoul-Henning Kamp int g_modevent(module_t, int, void *);
3286c87f8d5SPoul-Henning Kamp 
329dd84a43cSPoul-Henning Kamp /* geom_io.c */
330dd84a43cSPoul-Henning Kamp struct bio * g_clone_bio(struct bio *);
3314bec0ff1SPawel Jakub Dawidek struct bio * g_duplicate_bio(struct bio *);
332dd84a43cSPoul-Henning Kamp void g_destroy_bio(struct bio *);
33372840432SPoul-Henning Kamp void g_io_deliver(struct bio *bp, int error);
3340d3f37a8SPoul-Henning Kamp int g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr);
3359a6844d5SKenneth D. Merry int g_io_zonecmd(struct disk_zone_args *zone_args, struct g_consumer *cp);
336c3618c65SPawel Jakub Dawidek int g_io_flush(struct g_consumer *cp);
337b182c792SWarner Losh int g_io_speedup(size_t shortage, u_int flags, size_t *resid, struct g_consumer *cp);
338dd84a43cSPoul-Henning Kamp void g_io_request(struct bio *bp, struct g_consumer *cp);
339dd84a43cSPoul-Henning Kamp struct bio *g_new_bio(void);
340a2033c96SPoul-Henning Kamp struct bio *g_alloc_bio(void);
341c55f5707SWarner Losh void g_reset_bio(struct bio *);
342dd84a43cSPoul-Henning Kamp void * g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error);
34390b1cd56SPoul-Henning Kamp int g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length);
3442b17fb95SPawel Jakub Dawidek int g_delete_data(struct g_consumer *cp, off_t offset, off_t length);
345ac03832eSConrad Meyer void g_format_bio(struct sbuf *, const struct bio *bp);
346ac03832eSConrad Meyer void g_print_bio(const char *prefix, const struct bio *bp, const char *fmtsuffix, ...) __printflike(3, 4);
347dffce215SKirk McKusick int g_use_g_read_data(void *, off_t, void **, int);
348dffce215SKirk McKusick int g_use_g_write_data(void *, off_t, void *, int);
349dd84a43cSPoul-Henning Kamp 
350dd84a43cSPoul-Henning Kamp /* geom_kern.c / geom_kernsim.c */
351dd84a43cSPoul-Henning Kamp 
352dd84a43cSPoul-Henning Kamp #ifdef _KERNEL
353dd84a43cSPoul-Henning Kamp 
354e8c85a50SPawel Jakub Dawidek extern struct sx topology_lock;
355e8c85a50SPawel Jakub Dawidek 
35695c24b31SPoul-Henning Kamp struct g_kerneldump {
35795c24b31SPoul-Henning Kamp 	off_t		offset;
35895c24b31SPoul-Henning Kamp 	off_t		length;
35906f4c96dSAlexander Motin 	struct dumperinfo di;
36095c24b31SPoul-Henning Kamp };
36195c24b31SPoul-Henning Kamp 
362dd84a43cSPoul-Henning Kamp MALLOC_DECLARE(M_GEOM);
363dd84a43cSPoul-Henning Kamp 
364dd84a43cSPoul-Henning Kamp static __inline void *
365dd84a43cSPoul-Henning Kamp g_malloc(int size, int flags)
366dd84a43cSPoul-Henning Kamp {
367dd84a43cSPoul-Henning Kamp 	void *p;
368dd84a43cSPoul-Henning Kamp 
369dd84a43cSPoul-Henning Kamp 	p = malloc(size, M_GEOM, flags);
370dd84a43cSPoul-Henning Kamp 	return (p);
371dd84a43cSPoul-Henning Kamp }
372dd84a43cSPoul-Henning Kamp 
373dd84a43cSPoul-Henning Kamp static __inline void
374dd84a43cSPoul-Henning Kamp g_free(void *ptr)
375dd84a43cSPoul-Henning Kamp {
3763d1d5bc3SPoul-Henning Kamp 
3773d1d5bc3SPoul-Henning Kamp #ifdef DIAGNOSTIC
378e8c85a50SPawel Jakub Dawidek 	if (sx_xlocked(&topology_lock)) {
3793d1d5bc3SPoul-Henning Kamp 		KASSERT(g_valid_obj(ptr) == 0,
380e8c85a50SPawel Jakub Dawidek 		    ("g_free(%p) of live object, type %d", ptr,
381e8c85a50SPawel Jakub Dawidek 		    g_valid_obj(ptr)));
382e8c85a50SPawel Jakub Dawidek 	}
3833d1d5bc3SPoul-Henning Kamp #endif
384dd84a43cSPoul-Henning Kamp 	free(ptr, M_GEOM);
385dd84a43cSPoul-Henning Kamp }
386dd84a43cSPoul-Henning Kamp 
3874b8374a7SPoul-Henning Kamp #define g_topology_lock() 					\
3884b8374a7SPoul-Henning Kamp 	do {							\
3894b8374a7SPoul-Henning Kamp 		sx_xlock(&topology_lock);			\
3904b8374a7SPoul-Henning Kamp 	} while (0)
3914b8374a7SPoul-Henning Kamp 
39254bab03fSPawel Jakub Dawidek #define g_topology_try_lock()	sx_try_xlock(&topology_lock)
39354bab03fSPawel Jakub Dawidek 
3944b8374a7SPoul-Henning Kamp #define g_topology_unlock()					\
3954b8374a7SPoul-Henning Kamp 	do {							\
3964b8374a7SPoul-Henning Kamp 		sx_xunlock(&topology_lock);			\
3974b8374a7SPoul-Henning Kamp 	} while (0)
3984b8374a7SPoul-Henning Kamp 
399cefbc0d1SPawel Jakub Dawidek #define g_topology_locked()	sx_xlocked(&topology_lock)
400cefbc0d1SPawel Jakub Dawidek 
4014b8374a7SPoul-Henning Kamp #define g_topology_assert()					\
4024b8374a7SPoul-Henning Kamp 	do {							\
4034b8374a7SPoul-Henning Kamp 		sx_assert(&topology_lock, SX_XLOCKED);		\
4044b8374a7SPoul-Henning Kamp 	} while (0)
405dd84a43cSPoul-Henning Kamp 
406692498b0SPawel Jakub Dawidek #define g_topology_assert_not()					\
407692498b0SPawel Jakub Dawidek 	do {							\
408692498b0SPawel Jakub Dawidek 		sx_assert(&topology_lock, SX_UNLOCKED);		\
409692498b0SPawel Jakub Dawidek 	} while (0)
410692498b0SPawel Jakub Dawidek 
4119061251fSJaakko Heinonen #define g_topology_sleep(chan, timo)				\
4129061251fSJaakko Heinonen 	sx_sleep(chan, &topology_lock, 0, "gtopol", timo)
4139061251fSJaakko Heinonen 
414e805e8f0SPoul-Henning Kamp #define DECLARE_GEOM_CLASS(class, name) 			\
4156c87f8d5SPoul-Henning Kamp 	static moduledata_t name##_mod = {			\
4166c87f8d5SPoul-Henning Kamp 		#name, g_modevent, &class			\
4176c87f8d5SPoul-Henning Kamp 	};							\
418b951b8f7SRoger Pau Monné 	DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_SECOND);
419dd84a43cSPoul-Henning Kamp 
42040ea77a0SAlexander Motin int g_is_geom_thread(struct thread *td);
42140ea77a0SAlexander Motin 
4228510f61aSXin LI #ifndef	_PATH_DEV
4238510f61aSXin LI #define	_PATH_DEV	"/dev/"
4248510f61aSXin LI #endif
4258510f61aSXin LI 
4267d590cc4SPoul-Henning Kamp #endif /* _KERNEL */
427dd84a43cSPoul-Henning Kamp 
42863728c47SPoul-Henning Kamp /* geom_ctl.c */
42941063f93SMarcel Moolenaar int gctl_set_param(struct gctl_req *req, const char *param, void const *ptr, int len);
43041063f93SMarcel Moolenaar void gctl_set_param_err(struct gctl_req *req, const char *param, void const *ptr, int len);
43163728c47SPoul-Henning Kamp void *gctl_get_param(struct gctl_req *req, const char *param, int *len);
43283d771deSPoul-Henning Kamp char const *gctl_get_asciiparam(struct gctl_req *req, const char *param);
433fb9483afSPoul-Henning Kamp void *gctl_get_paraml(struct gctl_req *req, const char *param, int len);
4341e00bb45SChuck Silvers void *gctl_get_paraml_opt(struct gctl_req *req, const char *param, int len);
4355e165262SPawel Jakub Dawidek int gctl_error(struct gctl_req *req, const char *fmt, ...) __printflike(2, 3);
43683d771deSPoul-Henning Kamp struct g_class *gctl_get_class(struct gctl_req *req, char const *arg);
437*a450ecfdSXin LI struct g_geom *gctl_get_geom(struct gctl_req *req, struct g_class *mp, char const *arg);
43883d771deSPoul-Henning Kamp struct g_provider *gctl_get_provider(struct gctl_req *req, char const *arg);
43963728c47SPoul-Henning Kamp 
440efb9df5cSPoul-Henning Kamp #endif /* _GEOM_GEOM_H_ */
441