d7b613c65bfdf42ce5eea7872416538f2792f048
[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.8 2008/10/26 00:05:24 swildner Exp $
40 .\"
41 .Dd September 28, 2008
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 null
72 filesystem differs from a traditional
73 loopback file system in two respects: it is implemented using
74 a stackable layers techniques, and its
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 three 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, it is used for NFS exporting
96 .Nm HAMMER
97 PFSs.
98 Third, the null layer can serve as a prototype layer.
99 Since it provides all necessary layer framework,
100 new file system layers can be created very easily by starting
101 with a null layer.
102 .Pp
103 The remainder of this man page examines the null layer as a basis
104 for constructing new layers.
105 .\"
106 .\"
107 .Sh INSTANTIATING NEW NULL LAYERS
108 New null layers are created with
109 .Nm .
110 .Nm Mount_null
111 takes two arguments, the pathname
112 of the lower vfs (target-pn) and the pathname where the null
113 layer will appear in the namespace (mount-point-pn).  After
114 the null layer is put into place, the contents
115 of target-pn subtree will be aliased under mount-point-pn.
116 .\"
117 .\"
118 .Sh OPERATION OF A NULL LAYER
119 The null layer is the minimum file system layer,
120 simply bypassing all possible operations to the lower layer
121 for processing there.  The majority of its activity centers
122 on the bypass routine, through which nearly all vnode operations
123 pass.
124 .Pp
125 The bypass routine accepts arbitrary vnode operations for
126 handling by the lower layer.  It begins by examining vnode
127 operation arguments and replacing any null-nodes by their
128 lower-layer equivalents.  It then invokes the operation
129 on the lower layer.  Finally, it replaces the null-nodes
130 in the arguments and, if a vnode is returned by the operation,
131 stacks a null-node on top of the returned vnode.
132 .Pp
133 Although bypass handles most operations,
134 .Em vop_getattr ,
135 .Em vop_inactive ,
136 .Em vop_reclaim ,
137 and
138 .Em vop_print
139 are not bypassed.
140 .Em Vop_getattr
141 must change the fsid being returned.
142 .Em Vop_inactive
143 and
144 .Em vop_reclaim
145 are not bypassed so that
146 they can handle freeing null-layer specific data.
147 .Em Vop_print
148 is not bypassed to avoid excessive debugging
149 information.
150 .\"
151 .\"
152 .Sh INSTANTIATING VNODE STACKS
153 Mounting associates the null layer with a lower layer,
154 in effect stacking two VFSes.  Vnode stacks are instead
155 created on demand as files are accessed.
156 .Pp
157 The initial mount creates a single vnode stack for the
158 root of the new null layer.  All other vnode stacks
159 are created as a result of vnode operations on
160 this or other null vnode stacks.
161 .Pp
162 New vnode stacks come into existence as a result of
163 an operation which returns a vnode.
164 The bypass routine stacks a null-node above the new
165 vnode before returning it to the caller.
166 .Pp
167 For example, imagine mounting a null layer with
168 .Bd -literal -offset indent
169 mount_null /usr/include /dev/layer/null
170 .Ed
171 .Pp
172 Changing directory to
173 .Pa /dev/layer/null
174 will assign
175 the root null-node (which was created when the null layer was mounted).
176 Now consider opening
177 .Pa sys .
178 A
179 .Em vop_lookup
180 would be
181 done on the root null-node.  This operation would bypass through
182 to the lower layer which would return a vnode representing
183 the
184 .Xr UFS 5
185 .Pa sys
186 (assuming that the lower layer is an
187 .Xr UFS 5
188 file system).
189 Null_bypass then builds a null-node
190 aliasing the
191 .Xr UFS 5
192 .Pa sys
193 and returns this to the caller.
194 Later operations on the null-node
195 .Pa sys
196 will repeat this
197 process when constructing other vnode stacks.
198 .\"
199 .\"
200 .Sh CREATING OTHER FILE SYSTEM LAYERS
201 One of the easiest ways to construct new file system layers is to make
202 a copy of the null layer, rename all files and variables, and
203 then begin modifying the copy.
204 .Xr Sed 1
205 can be used to easily rename
206 all variables.
207 .\"
208 .\"
209 .Sh INVOKING OPERATIONS ON LOWER LAYERS
210 There are two techniques to invoke operations on a lower layer
211 when the operation cannot be completely bypassed.  Each method
212 is appropriate in different situations.  In both cases,
213 it is the responsibility of the aliasing layer to make
214 the operation arguments "correct" for the lower layer
215 by mapping a vnode argument to the lower layer.
216 .Pp
217 The first approach is to call the aliasing layer's bypass routine.
218 This method is most suitable when you wish to invoke the operation
219 currently being handled on the lower layer.
220 It has the advantage that
221 the bypass routine already must do argument mapping.
222 An example of this is
223 .Em null_getattrs
224 in the null layer.
225 .Pp
226 A second approach is to directly invoke vnode operations on
227 the lower layer with the
228 .Em VOP_OPERATIONNAME
229 interface.
230 The advantage of this method is that it is easy to invoke
231 arbitrary operations on the lower layer.  The disadvantage
232 is that vnode arguments must be manually mapped.
233 .\"
234 .\"
235 .Sh SEE ALSO
236 .Xr HAMMER 5 ,
237 .Xr mount 8
238 .Pp
239 UCLA Technical Report CSD-910056,
240 .Em "Stackable Layers: an Architecture for File System Development" .
241 .Sh HISTORY
242 The
243 .Nm
244 utility first appeared in
245 .Bx 4.4 .
246 .An Matthew Dillon
247 made
248 .Nm
249 work in
250 .Dx 1.7 ,
251 after it had been broken for some time.