Watch
1
0
Fork
You've already forked kernel_a52xq
0
mirror of https://github.com/a52xq-dev/kernel.git synced 2026-11-21 00:46:59 +07:00
Commit graph kernel_a52xq/Documentation/filesystems/overlayfs.txt
Message SHA1
ovl: update documentation for unionmount-testsuite
David's tree is no longer maintained, so point to my maintained fork.

Add --verify flag to the run example, which enables all latest features
and provides test coverage for constant st_ino/st_dev.

Signed-off-by: Amir Goldstein <amir73il@gmail.com>
Acked-by: David Howells <dhowells@redhat.com>
Signed-off-by: Miklos Szeredi <mszeredi@redhat.com>

Amir Goldstein   authored and   Miklos Szeredi   commited 2018-05-31 11:06:10 +02:00
05af4fe79b
ovl: update documentation w.r.t "xino" feature
Signed-off-by: Amir Goldstein <amir73il@gmail.com>
Signed-off-by: Miklos Szeredi <mszeredi@redhat.com>

Amir Goldstein   authored and   Miklos Szeredi   commited 2018-04-12 12:04:51 +02:00
16149013f8
ovl: document NFS export
Document NFS export design.
Followup patches will implement this design.

Signed-off-by: Amir Goldstein <amir73il@gmail.com>
Signed-off-by: Miklos Szeredi <mszeredi@redhat.com>

Amir Goldstein   authored and   Miklos Szeredi   commited 2018-01-24 11:25:59 +01:00
a01f64b5c0
ovl: add support for "nfs_export" configuration
Introduce the "nfs_export" config, module and mount options.

The NFS export feature depends on the "index" feature and enables two
implicit overlayfs features: "index_all" and "verify_lower".
The "index_all" feature creates an index on copy up of every file and
directory. The "verify_lower" feature uses the full index to detect
overlay filesystems inconsistencies on lookup, like redirect from
multiple upper dirs to the same lower dir.

NFS export can be enabled for non-upper mount with no index. However,
because lower layer redirects cannot be verified with the index, enabling
NFS export support on an overlay with no upper layer requires turning off
redirect follow (e.g. "redirect_dir=nofollow").

The full index may incur some overhead on mount time, especially when
verifying that lower directory file handles are not stale.

NFS export support, full index and consistency verification will be
implemented by following patches.

Signed-off-by: Amir Goldstein <amir73il@gmail.com>
Signed-off-by: Miklos Szeredi <mszeredi@redhat.com>

Amir Goldstein   authored and   Miklos Szeredi   commited 2018-01-24 11:25:37 +01:00
f168f1098d
ovl: update documentation of inodes index feature
Document that inode index feature solves breaking hard links on
copy up.

Simplify Kconfig backward compatibility disclaimer.

Signed-off-by: Amir Goldstein <amir73il@gmail.com>
Signed-off-by: Miklos Szeredi <mszeredi@redhat.com>

Amir Goldstein   authored and   Miklos Szeredi   commited 2018-01-24 10:20:02 +01:00
60b866420b
ovl: don't follow redirects if redirect_dir=off
Overlayfs is following redirects even when redirects are disabled. If this
is unintentional (probably the majority of cases) then this can be a
problem.  E.g. upper layer comes from untrusted USB drive, and attacker
crafts a redirect to enable read access to otherwise unreadable
directories.

If "redirect_dir=off", then turn off following as well as creation of
redirects.  If "redirect_dir=follow", then turn on following, but turn off
creation of redirects (which is what "redirect_dir=off" does now).

This is a backward incompatible change, so make it dependent on a config
option.

Reported-by: David Howells <dhowells@redhat.com>
Signed-off-by: Miklos Szeredi <mszeredi@redhat.com>

Miklos Szeredi   commited 2017-12-11 11:28:10 +01:00
438c84c2f0
ovl: fix regression caused by exclusive upper/work dir protection
Enforcing exclusive ownership on upper/work dirs caused a docker
regression: https://github.com/moby/moby/issues/34672.

Euan spotted the regression and pointed to the offending commit.
Vivek has brought the regression to my attention and provided this
reproducer:

Terminal 1:

  mount -t overlay -o workdir=work,lowerdir=lower,upperdir=upper none
        merged/

Terminal 2:

  unshare -m

Terminal 1:

  umount merged
  mount -t overlay -o workdir=work,lowerdir=lower,upperdir=upper none
        merged/
  mount: /root/overlay-testing/merged: none already mounted or mount point
         busy

To fix the regression, I replaced the error with an alarming warning.
With index feature enabled, mount does fail, but logs a suggestion to
override exclusive dir protection by disabling index.
Note that index=off mount does take the inuse locks, so a concurrent
index=off will issue the warning and a concurrent index=on mount will fail.

Documentation was updated to reflect this change.

Fixes: 2cac0c00a6 ("ovl: get exclusive ownership on upper/work dirs")
Cc: <stable@vger.kernel.org> # v4.13
Reported-by: Euan Kemp <euank@euank.com>
Reported-by: Vivek Goyal <vgoyal@redhat.com>
Signed-off-by: Amir Goldstein <amir73il@gmail.com>
Signed-off-by: Miklos Szeredi <mszeredi@redhat.com>

Amir Goldstein   authored and   Miklos Szeredi   commited 2017-10-05 15:53:18 +02:00
85fdee1eef
ovl: document copying layers restrictions with inodes index
The inodes index feature introduces a behavior change - on mount,
upper root origin file handle is verified to match the lower root dir.
This implies that copied layers cannot be mounted with the inodes index
feature enabled, without explicitly removing the upper dir origin xattr
and the index dir.

The inodes index feature is required to support:
- Prevent breaking hardlinks on copy up
- NFS export support (upcoming)
- Overlayfs snapshots (POC)

Signed-off-by: Amir Goldstein <amir73il@gmail.com>
Signed-off-by: Miklos Szeredi <mszeredi@redhat.com>

Amir Goldstein   authored and   Miklos Szeredi   commited 2017-07-04 22:03:19 +02:00
9412812ef5
ovl: update documentation w.r.t. constant inode numbers
Signed-off-by: Amir Goldstein <amir73il@gmail.com>
Signed-off-by: Miklos Szeredi <mszeredi@redhat.com>

Amir Goldstein   authored and   Miklos Szeredi   commited 2017-05-05 11:38:59 +02:00
65f2673832
ovl: fix reStructuredText syntax errors in documentation
- Fix broken long line block quote
 - Fix missing newline before bullets list
 - Use correct numbered list syntax

Signed-off-by: Amir Goldstein <amir73il@gmail.com>
Signed-off-by: Miklos Szeredi <mszeredi@redhat.com>

Amir Goldstein   authored and   Miklos Szeredi   commited 2016-12-16 11:02:58 +01:00
c3c8699664
ovl: redirect on rename-dir
Current code returns EXDEV when a directory would need to be copied up to
move.  We could copy up the directory tree in this case, but there's
another, simpler solution: point to old lower directory from moved upper
directory.

This is achieved with a "trusted.overlay.redirect" xattr storing the path
relative to the root of the overlay.  After such attribute has been set,
the directory can be moved without further actions required.

This is a backward incompatible feature, old kernels won't be able to
correctly mount an overlay containing redirected directories.

Signed-off-by: Miklos Szeredi <mszeredi@redhat.com>

Miklos Szeredi   commited 2016-12-16 11:02:56 +01:00
a6c6065511
ovl: update doc
The quirk for file locks and leases no longer applies.

Add missing info about renaming directory residing on lower layer.

Signed-off-by: Miklos Szeredi <mszeredi@redhat.com>

Miklos Szeredi   commited 2016-12-16 11:02:54 +01:00
2d8f2908e6
ovl: update doc
Some of the documented quirks no longer apply.

Signed-off-by: Miklos Szeredi <mszeredi@redhat.com>

Miklos Szeredi   commited 2016-09-01 11:12:00 +02:00
026e5e0cc1
ovl: update documentation
Two "fixme" items are actually fixed now.

Signed-off-by: Miklos Szeredi <mszeredi@redhat.com>

Miklos Szeredi   commited 2016-05-27 08:55:26 +02:00
942fd803e6
Remove email address from Documentation/filesystems/overlayfs.txt
I'm getting a surprising large number of questions about overlayfs sent
to me personally, rather than to a relevant mailing list.

So remove my email address from the documentation, and add a note
about looking in the MAINTAINERS file.

Signed-off-by: NeilBrown <neilb@suse.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

NeilBrown   authored and   Jonathan Corbet   commited 2015-11-11 10:04:53 -07:00
a907c90765
ovl: document lower layer ordering
Reported-by: Fabian Sturm <fabian.sturm@aduu.de> 
Signed-off-by: Miklos Szeredi <mszeredi@suse.cz>

Miklos Szeredi   commited 2015-01-08 15:09:15 +01:00
6d900f5a33
ovl: add testsuite to docs
Reported-by: Sedat Dilek <sedat.dilek@gmail.com>
Signed-off-by: Miklos Szeredi <mszeredi@suse.cz>

Miklos Szeredi   commited 2014-12-13 00:59:53 +01:00
2b7a8f36f0
ovl: support multiple lower layers
Allow "lowerdir=" option to contain multiple lower directories separated by
a colon (e.g. "lowerdir=/bin:/usr/bin").  Colon characters in filenames can
be escaped with a backslash.

Signed-off-by: Miklos Szeredi <mszeredi@suse.cz>

Miklos Szeredi   commited 2014-12-13 00:59:52 +01:00
a78d9f0d5d
ovl: rename filesystem type to "overlay"
Some distributions carry an "old" format of overlayfs while mainline has a
"new" format.

The distros will possibly want to keep the old overlayfs alongside the new
for compatibility reasons.

To make it possible to differentiate the two versions change the name of
the new one from "overlayfs" to "overlay".

Signed-off-by: Miklos Szeredi <mszeredi@suse.cz>
Reported-by: Serge Hallyn <serge.hallyn@ubuntu.com>
Cc: Andy Whitcroft <apw@canonical.com>

Miklos Szeredi   commited 2014-11-20 16:39:59 +01:00
ef94b1864d
overlay: overlay filesystem documentation
Document the overlay filesystem.

Signed-off-by: Miklos Szeredi <mszeredi@suse.cz>

Neil Brown   authored and   Miklos Szeredi   commited 2014-10-24 00:14:39 +02:00
7c37fbda85