2 .\" Copyright (c) 2004 Pawel Jakub Dawidek <pjd@FreeBSD.org>
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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.
14 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 .Fn g_new_geomf "struct g_class *mp" "const char *fmt" ...
39 .Fn g_destroy_geom "struct g_geom *gp"
41 The geom (do not confuse
45 is an instance of a GEOM class.
46 For example: in a typical i386
48 system, there will be one geom
49 of class MBR for each disk.
50 The geom's name is not really important, it is only used in the XML
51 dump and for debugging purposes.
52 There can be many geoms with the same name.
56 function creates a new geom, which will be an instance of the class
58 The geom's name is created in a
60 -like way from the rest of the arguments.
64 function destroys the given geom immediately and cancels all related pending
70 contains fields that should be set by the caller after geom creation, but before
71 creating any providers or consumers related to this geom (not all are required):
72 .Bl -tag -offset indent -width indent
73 .It Vt "g_start_t *" Va start
74 Pointer to a function used for I/O processing.
75 .It Vt "g_spoiled_t *" Va spoiled
76 Pointer to a function used for consumers spoiling.
77 .It Vt "g_dumpconf_t *" Va dumpconf
78 Pointer to a function used for configuration in XML format dumping.
79 .It Vt "g_access_t *" Va access
80 Pointer to a function used for access control.
81 .It Vt "g_orphan_t *" Va orphan
82 Pointer to a function used to inform about orphaned consumer.
83 .It Vt "g_ioctl_t *" Va ioctl
84 Pointer to a function used for handling ioctl requests.
85 .It Vt "void *" Va softc
86 Field for private use.
88 .Sh RESTRICTIONS/CONDITIONS
89 If you intend to use providers in this geom you must set field
93 If you are planning to use consumers in your geom you must set fields
100 .Bl -item -offset indent
104 must be valid (registered in GEOM).
106 The topology lock has to be held.
110 .Bl -item -offset indent
112 The geom cannot possess any providers.
114 The geom cannot possess any consumers.
116 The topology lock has to be held.
122 returns a pointer to the newly created geom.
124 Create an example geom.
125 .Bd -literal -offset indent
127 g_example_start(struct bio *bp)
134 g_example_orphan(struct g_consumer *cp)
143 g_example_spoiled(struct g_consumer *cp)
152 g_example_access(struct g_provider *pp, int dr, int dw, int de)
158 static struct g_geom *
159 create_example_geom(struct g_class *myclass)
164 gp = g_new_geomf(myclass, "example_geom");
166 gp->start = g_example_start;
167 gp->orphan = g_example_orphan;
168 gp->spoiled = g_example_spoiled;
169 gp->access = g_example_access;
176 destroy_example_geom(struct g_geom *gp)
180 if (!LIST_EMPTY(&gp->provider) ||
181 !LIST_EMPTY(&gp->consumer)) {
193 .Xr DECLARE_GEOM_CLASS 9 ,
201 .Xr g_provider_by_name 9 ,
205 This manual page was written by
206 .An Pawel Jakub Dawidek Aq pjd@FreeBSD.org .