sbin/mount_unionfs/mount_unionfs.8

   1 .\" Copyright (c) 1994
   2 .\" The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software donated to Berkeley by
   5 .\" Jan-Simon Pendry.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 4. Neither the name of the University nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\"     @(#)mount_union.8       8.6 (Berkeley) 3/27/94
  32 .\" $FreeBSD$
  33 .\"
  34 .Dd November 30, 2006
  35 .Dt MOUNT_UNIONFS 8
  36 .Os
  37 .Sh NAME
  38 .Nm mount_unionfs
  39 .Nd mount union file systems
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl b
  43 .Op Fl o Ar options
  44 .Ar directory
  45 .Ar uniondir
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility attaches
  50 .Ar directory
  51 above
  52 .Ar uniondir
  53 in such a way that the contents of both directory trees remain visible.
  54 By default,
  55 .Ar directory
  56 becomes the
  57 .Em upper
  58 layer and
  59 .Ar uniondir
  60 becomes the
  61 .Em lower
  62 layer.
  63 .Pp
  64 The options are as follows:
  65 .Bl -tag -width indent
  66 .It Fl b
  67 Deprecated.
  68 Use
  69 .Fl o Cm below
  70 instead.
  71 .It Fl o
  72 Options are specified with the
  73 .Fl o
  74 flag followed by an option.
  75 The following options are available:
  76 .Bl -tag -width indent
  77 .It Cm below
  78 Inverts the default position, so that
  79 .Ar directory
  80 becomes the lower layer and
  81 .Ar uniondir
  82 becomes the upper layer.
  83 However,
  84 .Ar uniondir
  85 remains the mount point.
  86 .It Sm Cm copymode No = Cm traditional | transparent | masquerade Sm
  87 Specifies the way to create a file or a directory in the upper layer
  88 automatically when needed.
  89 The
  90 .Cm traditional
  91 mode
  92 uses the same way as the old unionfs for backward compatibility, and
  93 .Cm transparent
  94 duplicates the file and directory mode bits and the ownership in the
  95 lower layer to the created file in the upper layer.
  96 For behavior of the
  97 .Cm masquerade
  98 mode, see
  99 .Sx MASQUERADE MODE
 100 below.
 101 .It Sm Cm whiteout No = Cm always | whenneeded Sm
 102 Specifies whether whiteouts should always be made in the upper layer
 103 when removing a file or directory or only when it already exists in the
 104 lower layer.
 105 .It Cm udir Ns = Ns Ar mode
 106 Specifies directory mode bits in octal for
 107 .Cm masquerade
 108 mode.
 109 .It Cm ufile Ns = Ns Ar mode
 110 Specifies file mode bits in octal for
 111 .Cm masquerade
 112 mode.
 113 .It Cm gid Ns = Ns Ar gid
 114 Specifies group for
 115 .Cm masquerade
 116 mode.
 117 .It Cm uid Ns = Ns Ar uid
 118 Specifies user for
 119 .Cm masquerade
 120 mode.
 121 .El
 122 .El
 123 .Pp
 124 To enforce file system security, the user mounting a file system
 125 must be superuser or else have write permission on the mounted-on
 126 directory.
 127 In addition, the
 128 .Va vfs.usermount
 129 .Xr sysctl 8
 130 variable must be set to 1 to permit file system mounting by ordinary users.
 131 However, note that
 132 .Cm transparent
 133 and
 134 .Cm masquerade
 135 modes require
 136 .Va vfs.usermount
 137 to be set to 0 because this functionality can only be used by superusers.
 138 .Pp
 139 Filenames are looked up in the upper layer and then in the
 140 lower layer.
 141 If a directory is found in the lower layer, and there is no entry
 142 in the upper layer, then a
 143 .Em shadow
 144 directory will be created in the upper layer.
 145 The ownership and the mode bits are set depending on the
 146 .Cm copymode
 147 option.
 148 In
 149 .Cm traditional
 150 mode, it will be owned by the user who originally did the
 151 union mount, with mode 0777
 152 .Pq Dq Li rwxrwxrwx
 153 modified by the umask in effect at that time.
 154 .Pp
 155 If a file exists in the upper layer then there is no way to access
 156 a file with the same name in the lower layer.
 157 If necessary, a combination of loopback and union mounts can be made
 158 which will still allow the lower files to be accessed by a different
 159 pathname.
 160 .Pp
 161 Except in the case of a directory,
 162 access to an object is granted via the normal file system access checks.
 163 For directories, the current user must have access to both the upper
 164 and lower directories (should they both exist).
 165 .Pp
 166 Requests to create or modify objects in
 167 .Ar uniondir
 168 are passed to the upper layer with the exception of a few special cases.
 169 An attempt to open for writing a file which exists in the lower layer
 170 causes a copy of the
 171 .Em entire
 172 file to be made to the upper layer, and then for the upper layer copy
 173 to be opened.
 174 Similarly, an attempt to truncate a lower layer file to zero length
 175 causes an empty file to be created in the upper layer.
 176 Any other operation which would ultimately require modification to
 177 the lower layer fails with
 178 .Er EROFS .
 179 .Pp
 180 The union file system manipulates the namespace, rather than
 181 individual file systems.
 182 The union operation applies recursively down the directory tree
 183 now rooted at
 184 .Ar uniondir .
 185 Thus any file systems which are mounted under
 186 .Ar uniondir
 187 will take part in the union operation.
 188 This differs from the
 189 .Cm union
 190 option to
 191 .Xr mount 8
 192 which only applies the union operation to the mount point itself,
 193 and then only for lookups.
 194 .Sh MASQUERADE MODE
 195 When a file
 196 (or a directory)
 197 is created in the upper layer, the
 198 .Cm masquerade
 199 mode sets it the fixed access mode bits given in
 200 .Cm ufile
 201 (for files)
 202 or
 203 .Cm udir
 204 (for directories)
 205 option and the owner given in
 206 .Cm udir
 207 and
 208 .Cm gid
 209 options, instead of ones in the lower layer.
 210 Note that in the
 211 .Cm masquerade
 212 mode and when owner of the file or directory matches
 213 one specified in
 214 .Cm uid
 215 option, only mode bits for the owner will be modified.
 216 More specifically, the file mode bits in the upper layer will
 217 be
 218 (mode in the lower layer)
 219 OR
 220 (mode given in
 221 .Cm ufile
 222 AND 0700), and the ownership will be the same as one in the lower layer.
 223 .Pp
 224 The default values for
 225 .Cm ufile , udir , uid ,
 226 and
 227 .Cm gid
 228 are as follow:
 229 .Pp
 230 .Bl -bullet -compact
 231 .It
 232 If none of
 233 .Cm ufile
 234 and
 235 .Cm udir
 236 were specified, access mode bits in the mount point will be used.
 237 .It
 238 If none of
 239 .Cm uid
 240 and
 241 .Cm gid
 242 were specified, ownership in the mount point will be used.
 243 .It
 244 If one of
 245 .Cm udir
 246 or
 247 .Cm ufile
 248 is not specified, the value of the other option will be used.
 249 .It
 250 If one of
 251 .Cm uid
 252 or
 253 .Cm gid
 254 is not specified, the value of the other option will be used.
 255 .El
 256 .Sh EXAMPLES
 257 The commands
 258 .Bd -literal -offset indent
 259 mount -t cd9660 -o ro /dev/cd0 /usr/src
 260 mount -t unionfs -o noatime /var/obj /usr/src
 261 .Ed
 262 .Pp
 263 mount the CD-ROM drive
 264 .Pa /dev/cd0
 265 on
 266 .Pa /usr/src
 267 and then attaches
 268 .Pa /var/obj
 269 on top.
 270 For most purposes the effect of this is to make the
 271 source tree appear writable
 272 even though it is stored on a CD-ROM.
 273 The
 274 .Fl o Cm noatime
 275 option is useful to avoid unnecessary copying from the lower to the
 276 upper layer.
 277 .Pp
 278 The commands
 279 .Bd -literal -offset indent
 280 mount -t cd9660 -o ro /dev/cd0 /usr/src
 281 chown 2020 /usr/src
 282 mount -t unionfs -o noatime -o copymode=masquerade -o uid=builder \\
 283     -o udir=755 -o ufile=644 /var/obj /usr/src
 284 .Ed
 285 .Pp
 286 also mount the CD-ROM drive
 287 .Pa /dev/cd0
 288 on
 289 .Pa /usr/src
 290 and then attaches
 291 .Pa /var/obj
 292 on top.
 293 Furthermore, the owner of all files and directories in
 294 .Pa /usr/src
 295 is a regular user with UID 2020
 296 when seen from the upper layer.
 297 Note that for the access mode bits,
 298 ones in the lower layer
 299 (on the CD-ROM, in this example)
 300 are still used without change.
 301 Thus, write privilege to the upper layer can be controlled
 302 independently from access mode bits and ownership in the lower layer.
 303 If a user does not have read privilege from the lower layer,
 304 one cannot still read even when the upper layer is mounted by using
 305 .Cm masquerade
 306 mode.
 307 .Pp
 308 The command
 309 .Bd -literal -offset indent
 310 mount -t unionfs -o noatime -o below /sys $HOME/sys
 311 .Ed
 312 .Pp
 313 attaches the system source tree below the
 314 .Pa sys
 315 directory in the user's home directory.
 316 This allows individual users to make private changes
 317 to the source, and build new kernels, without those
 318 changes becoming visible to other users.
 319 Note that the files in the lower layer remain
 320 accessible via
 321 .Pa /sys .
 322 .Sh SEE ALSO
 323 .Xr intro 2 ,
 324 .Xr mount 2 ,
 325 .Xr unmount 2 ,
 326 .Xr fstab 5 ,
 327 .Xr mount 8 ,
 328 .Xr mount_nullfs 8
 329 .Sh HISTORY
 330 The
 331 .Nm
 332 utility first appeared in
 333 .Bx 4.4 .
 334 .Pp
 335 The
 336 .Fl r
 337 option for hiding the lower layer completely was removed in
 338 .Fx 7.0
 339 because this is identical to using
 340 .Xr mount_nullfs 8 .
 341 .Sh AUTHORS
 342 .An -nosplit
 343 In
 344 .Fx 7.0 ,
 345 .An Masanori OZAWA Aq ozawa@ongs.co.jp
 346 reimplemented handling of locking, whiteout, and file mode bits, and
 347 .An Hiroki Sato Aq hrs@FreeBSD.org
 348 wrote about the changes in this manual page.
 349 .Sh BUGS
 350 THIS FILE SYSTEM TYPE IS NOT YET FULLY SUPPORTED (READ: IT DOESN'T WORK)
 351 AND USING IT MAY, IN FACT, DESTROY DATA ON YOUR SYSTEM.
 352 USE AT YOUR
 353 OWN RISK.
 354 BEWARE OF DOG.
 355 SLIPPERY WHEN WET.
 356 BATTERIES NOT INCLUDED.
 357 .Pp
 358 This code also needs an owner in order to be less dangerous - serious
 359 hackers can apply by sending mail to
 360 .Aq freebsd-fs@FreeBSD.org
 361 and announcing
 362 their intent to take it over.
 363 .Pp
 364 Without whiteout support from the file system backing the upper layer,
 365 there is no way that delete and rename operations on lower layer
 366 objects can be done.
 367 .Er EOPNOTSUPP
 368 is returned for this kind of operations as generated by VOP_WHITEOUT()
 369 along with any others which would make modifications to the lower
 370 layer, such as
 371 .Xr chmod 1 .
 372 .Pp
 373 Running
 374 .Xr find 1
 375 over a union tree has the side-effect of creating
 376 a tree of shadow directories in the upper layer.
 377 .Pp
 378 The current implementation does not support copying extended attributes
 379 for
 380 .Xr acl 9 ,
 381 .Xr mac 9 ,
 382 or so on to the upper layer.
 383 Note that this may be a security issue.
 384 .Pp
 385 A shadow directory, which is one automatically created in the upper
 386 layer when it exists in the lower layer and does not exist in the
 387 upper layer, is always created with the superuser privilege.
 388 However, a file copied from the lower layer in the same way
 389 is created by the user who accessed it.
 390 Because of this,
 391 if the user is not the superuser, even in
 392 .Cm transparent
 393 mode the access mode bits in the copied file in the upper layer
 394 will not always be the same as ones in the lower layer.
 395 This behavior should be fixed.