This adds some documentation on how the current behaviour of overlayfs
works, and adds some non-obvious caveats to the documentation. We may want
to pick those up independently.
The volatile option is great for "ephemeral" containers. Unfortunately,
it doesn't capture all uses. There are two ways to use it safely right now:
1. Throw away the entire upperdir between mounts
2. Manually syncfs between mounts
For certain use-cases like serverless, or short-lived containers, it is
advantageous to be able to stop the container (runtime) and start it up on
demand / invocation of the function. Usually, there is some bootstrap
process which involves downloading some artifacts, or putting secrets on
disk, and then upon invocation of the function, you want to (re)start the
container.
If you have to syncfs every time you do this, it can lead to excess
filesystem overhead for all of the other containers on the machine, and
stall out every container who's upperdir is on the same underlying
filesystem, unless your filesystem offers something like subvolumes,
and if sync can be restricted to a subvolume.
The kernel has information that it can use to determine whether or not this
is safe -- primarily if the underlying FS has had writeback errors or not.
Overlayfs doesn't delay writes, so the consistency of the upperdir is not
contingent on the mount of overlayfs, but rather the mount of the
underlying filesystem. It can also make sure the underlying filesystem
wasn't remounted. Although, it was suggested that we use derive this
information from the upperdir's inode[1], we can checkpoint this data on
disk in an xattr.
Specifically we checkpoint:
* Superblock "id": This is a new concept introduced in one of the patches
which keeps track of (re)mounts of filesystems, by having a per boot
monotonically increasing integer identifying the superblock. This is
safer than trying to obfuscate the pointer and putting it into an
xattr (due to leak risk, and address reuse), and during the course
of a boot, the u64 should not wrap.
* Overlay "boot id": This is a new UUID that is overlayfs specific,
as overlayfs is a module that's independent from the rest of the
system and can be (re)loaded independently -- thus it generates
a UUID at load time which can be used to uniquely identify it.
* upperdir / workdir errseq: A sample of the errseq_t on the workdir /
upperdir's superblock. Since the errseq_t is implemented as a u32
with errno + error counter, we can safely store it in a checkpoint.
This has to be done in kernelspace because userspace does not have access
to information such as superblock (re)mounts, the writeback errseq value,
and whether the module has been (re)loaded. Although this mechanism only
determines a subset of the error scenarios, it lays out the groundwork
for adding more.
In the future, we may want to make it so overlayfs shuts down on errors,
or have some kind of other behaviour when errors are detected. If we want
a per-file (on the upperdir) piece of metadata can be added indicating
errseq_t for just that file, and we can check it on each close / open,
and then allow the user to make an intelligent decision of how they want
overlayfs to handle the error. This would allow for errors to be captured
during normal operation as opposed to just between remounts.
This also allows for:
volatile -> volatile
non-volatile -> volatile
non-volatile -> non-volatile
But, for now, prevents volatile -> non-volatile. Perhaps with the future
patches around selective inode sync, and tracking errors on every
interaction will make this possible.
Changes since:
V1 [2]:
* Add documentation commit about current short-comings of the current volatile
implementation.
* Do not allow volatile mounts to be mounted as non-volatile
RFC [3]:
* Changed datastructure names
* No longer delete the volatile dir / dirty file
* Moved xattr to volatile directory
* Split errseq check
[1]: https://lore.kernel.org/linux-unionfs/CAOQ4uxhadzC3-kh-igfxv3pAmC3ocDtAQTxByu4hrn8KtZuieQ@xxxxxxxxxxxxxx/
[2]: https://lore.kernel.org/linux-unionfs/20201125104621.18838-1-sargun@xxxxxxxxx/T/#t
[3]: https://lore.kernel.org/linux-unionfs/20201116045758.21774-1-sargun@xxxxxxxxx/T/#t
Sargun Dhillon (4):
fs: Add s_instance_id field to superblock for unique identification
overlay: Document current outstanding shortcoming of volatile
overlay: Add the ability to remount volatile directories when safe
overlay: Add rudimentary checking of writeback errseq on volatile
remount
Documentation/filesystems/overlayfs.rst | 24 ++++--
fs/overlayfs/overlayfs.h | 38 ++++++++-
fs/overlayfs/readdir.c | 104 +++++++++++++++++++++---
fs/overlayfs/super.c | 74 +++++++++++++----
fs/overlayfs/util.c | 2 +
fs/super.c | 3 +
include/linux/fs.h | 7 ++
7 files changed, 213 insertions(+), 39 deletions(-)
base-commit: be4df0cea08a8b59eb38d73de988b7ba8022df41
--
2.25.1
