ee5e465426f3e0ef138298428081fded361e7b3f
[dragonfly.git] / sbin / mount_null / mount_null.8
1 .\"
2 .\" Copyright (c) 1992, 1993, 1994
3 .\"     The Regents of the University of California.  All rights reserved.
4 .\"
5 .\" This code is derived from software donated to Berkeley by
6 .\" John Heidemann of the UCLA Ficus project.
7 .\"
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\"    notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in the
16 .\"    documentation and/or other materials provided with the distribution.
17 .\" 3. All advertising materials mentioning features or use of this software
18 .\"    must display the following acknowledgement:
19 .\"     This product includes software developed by the University of
20 .\"     California, Berkeley and its contributors.
21 .\" 4. Neither the name of the University nor the names of its contributors
22 .\"    may be used to endorse or promote products derived from this software
23 .\"    without specific prior written permission.
24 .\"
25 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 .\" SUCH DAMAGE.
36 .\"
37 .\"     @(#)mount_null.8        8.6 (Berkeley) 5/1/95
38 .\" $FreeBSD: src/sbin/mount_null/mount_null.8,v 1.11.2.6 2001/12/20 16:40:00 ru Exp $
39 .\" $DragonFly: src/sbin/mount_null/mount_null.8,v 1.3 2006/02/17 19:33:33 swildner Exp $
40 .\"
41 .Dd May 1, 1995
42 .Dt MOUNT_NULL 8
43 .Os
44 .Sh NAME
45 .Nm mount_null
46 .Nd "mount a loopback filesystem sub-tree; demonstrate the use of a null file system layer"
47 .Sh SYNOPSIS
48 .Nm
49 .Op Fl o Ar options
50 .Ar target
51 .Ar mount-point
52 .Sh DESCRIPTION
53 The
54 .Nm
55 command creates a
56 null layer, duplicating a sub-tree of the file system
57 name space under another part of the global file system namespace.
58 This allows existing files and directories to be accessed
59 using a different pathname.
60 .Pp
61 The primary differences between a virtual copy of the filesystem
62 and a symbolic link are that the
63 .Xr getcwd 3
64 functions work correctly in the virtual copy, and that other filesystems
65 may be mounted on the virtual copy without affecting the original.
66 A different device number for the virtual copy is returned by
67 .Xr stat 2 ,
68 but in other respects it is indistinguishable from the original.
69 .Pp
70 The
71 .Nm
72 filesystem differs from a traditional
73 loopback file system in two respects: it is implemented using
74 a stackable layers techniques, and it's
75 .Do null-node Dc Ns s
76 stack above
77 all lower-layer vnodes, not just over directory vnodes.
78 .Pp
79 The options are as follows:
80 .Bl -tag -width indent
81 .It Fl o
82 Options are specified with a
83 .Fl o
84 flag followed by a comma separated string of options.
85 See the
86 .Xr mount 8
87 man page for possible options and their meanings.
88 .El
89 .Pp
90 The null layer has two purposes.
91 First, it serves as a demonstration of layering by providing a layer
92 which does nothing.
93 (It actually does everything the loopback file system does,
94 which is slightly more than nothing.)
95 Second, the null layer can serve as a prototype layer.
96 Since it provides all necessary layer framework,
97 new file system layers can be created very easily by starting
98 with a null layer.
99 .Pp
100 The remainder of this man page examines the null layer as a basis
101 for constructing new layers.
102 .\"
103 .\"
104 .Sh INSTANTIATING NEW NULL LAYERS
105 New null layers are created with
106 .Nm .
107 .Nm Mount_null
108 takes two arguments, the pathname
109 of the lower vfs (target-pn) and the pathname where the null
110 layer will appear in the namespace (mount-point-pn).  After
111 the null layer is put into place, the contents
112 of target-pn subtree will be aliased under mount-point-pn.
113 .\"
114 .\"
115 .Sh OPERATION OF A NULL LAYER
116 The null layer is the minimum file system layer,
117 simply bypassing all possible operations to the lower layer
118 for processing there.  The majority of its activity centers
119 on the bypass routine, through which nearly all vnode operations
120 pass.
121 .Pp
122 The bypass routine accepts arbitrary vnode operations for
123 handling by the lower layer.  It begins by examining vnode
124 operation arguments and replacing any null-nodes by their
125 lower-layer equivalents.  It then invokes the operation
126 on the lower layer.  Finally, it replaces the null-nodes
127 in the arguments and, if a vnode is returned by the operation,
128 stacks a null-node on top of the returned vnode.
129 .Pp
130 Although bypass handles most operations,
131 .Em vop_getattr ,
132 .Em vop_inactive ,
133 .Em vop_reclaim ,
134 and
135 .Em vop_print
136 are not bypassed.
137 .Em Vop_getattr
138 must change the fsid being returned.
139 .Em Vop_inactive
140 and
141 .Em vop_reclaim
142 are not bypassed so that
143 they can handle freeing null-layer specific data.
144 .Em Vop_print
145 is not bypassed to avoid excessive debugging
146 information.
147 .\"
148 .\"
149 .Sh INSTANTIATING VNODE STACKS
150 Mounting associates the null layer with a lower layer,
151 in effect stacking two VFSes.  Vnode stacks are instead
152 created on demand as files are accessed.
153 .Pp
154 The initial mount creates a single vnode stack for the
155 root of the new null layer.  All other vnode stacks
156 are created as a result of vnode operations on
157 this or other null vnode stacks.
158 .Pp
159 New vnode stacks come into existence as a result of
160 an operation which returns a vnode.
161 The bypass routine stacks a null-node above the new
162 vnode before returning it to the caller.
163 .Pp
164 For example, imagine mounting a null layer with
165 .Bd -literal -offset indent
166 mount_null /usr/include /dev/layer/null
167 .Ed
168 Changing directory to
169 .Pa /dev/layer/null
170 will assign
171 the root null-node (which was created when the null layer was mounted).
172 Now consider opening
173 .Pa sys .
174 A vop_lookup would be
175 done on the root null-node.  This operation would bypass through
176 to the lower layer which would return a vnode representing
177 the UFS
178 .Pa sys .
179 Null_bypass then builds a null-node
180 aliasing the UFS
181 .Pa sys
182 and returns this to the caller.
183 Later operations on the null-node
184 .Pa sys
185 will repeat this
186 process when constructing other vnode stacks.
187 .\"
188 .\"
189 .Sh CREATING OTHER FILE SYSTEM LAYERS
190 One of the easiest ways to construct new file system layers is to make
191 a copy of the null layer, rename all files and variables, and
192 then begin modifying the copy.
193 .Xr Sed 1
194 can be used to easily rename
195 all variables.
196 .Pp
197 The umap layer is an example of a layer descended from the
198 null layer.
199 .\"
200 .\"
201 .Sh INVOKING OPERATIONS ON LOWER LAYERS
202 There are two techniques to invoke operations on a lower layer
203 when the operation cannot be completely bypassed.  Each method
204 is appropriate in different situations.  In both cases,
205 it is the responsibility of the aliasing layer to make
206 the operation arguments "correct" for the lower layer
207 by mapping a vnode argument to the lower layer.
208 .Pp
209 The first approach is to call the aliasing layer's bypass routine.
210 This method is most suitable when you wish to invoke the operation
211 currently being handled on the lower layer.
212 It has the advantage that
213 the bypass routine already must do argument mapping.
214 An example of this is
215 .Em null_getattrs
216 in the null layer.
217 .Pp
218 A second approach is to directly invoke vnode operations on
219 the lower layer with the
220 .Em VOP_OPERATIONNAME
221 interface.
222 The advantage of this method is that it is easy to invoke
223 arbitrary operations on the lower layer.  The disadvantage
224 is that vnode arguments must be manually mapped.
225 .\"
226 .\"
227 .Sh SEE ALSO
228 .Xr mount 8
229 .Pp
230 UCLA Technical Report CSD-910056,
231 .Em "Stackable Layers: an Architecture for File System Development" .
232 .Sh HISTORY
233 The
234 .Nm
235 utility first appeared in
236 .Bx 4.4 .
237 .Sh BUGS
238 THIS FILESYSTEM TYPE IS NOT YET FULLY SUPPORTED (READ: IT DOESN'T WORK)
239 AND USING IT MAY, IN FACT, DESTROY DATA ON YOUR SYSTEM.  USE AT YOUR
240 OWN RISK.  BEWARE OF DOG.  SLIPPERY WHEN WET.
241 .Pp
242 This code also needs an owner in order to be less dangerous - serious
243 hackers can apply by sending mail to
244 .Aq hackers@FreeBSD.org
245 and announcing
246 their intent to take it over.