1 /* SPDX-License-Identifier: GPL-2.0-only */
4 * Copyright (C) 2011 Novell Inc.
7 #include <linux/kernel.h>
8 #include <linux/uuid.h>
10 #include "ovl_entry.h"
13 #define pr_fmt(fmt) "overlayfs: " fmt
16 __OVL_PATH_UPPER = (1 << 0),
17 __OVL_PATH_MERGE = (1 << 1),
18 __OVL_PATH_ORIGIN = (1 << 2),
21 #define OVL_TYPE_UPPER(type) ((type) & __OVL_PATH_UPPER)
22 #define OVL_TYPE_MERGE(type) ((type) & __OVL_PATH_MERGE)
23 #define OVL_TYPE_ORIGIN(type) ((type) & __OVL_PATH_ORIGIN)
25 #define OVL_XATTR_NAMESPACE "overlay."
26 #define OVL_XATTR_TRUSTED_PREFIX XATTR_TRUSTED_PREFIX OVL_XATTR_NAMESPACE
27 #define OVL_XATTR_USER_PREFIX XATTR_USER_PREFIX OVL_XATTR_NAMESPACE
40 /* Pure upper dir that may contain non pure upper entries */
42 /* Non-merge dir that may contain whiteout entries */
46 /* Inode number will remain constant over copy up. */
63 * The tuple (fh,uuid) is a universal unique identifier for a copy up origin,
65 * origin.fh - exported file handle of the lower file
66 * origin.uuid - uuid of the lower filesystem
68 #define OVL_FH_VERSION 0
69 #define OVL_FH_MAGIC 0xfb
71 /* CPU byte order required for fid decoding: */
72 #define OVL_FH_FLAG_BIG_ENDIAN (1 << 0)
73 #define OVL_FH_FLAG_ANY_ENDIAN (1 << 1)
74 /* Is the real inode encoded in fid an upper inode? */
75 #define OVL_FH_FLAG_PATH_UPPER (1 << 2)
77 #define OVL_FH_FLAG_ALL (OVL_FH_FLAG_BIG_ENDIAN | OVL_FH_FLAG_ANY_ENDIAN | \
78 OVL_FH_FLAG_PATH_UPPER)
80 #if defined(__LITTLE_ENDIAN)
81 #define OVL_FH_FLAG_CPU_ENDIAN 0
82 #elif defined(__BIG_ENDIAN)
83 #define OVL_FH_FLAG_CPU_ENDIAN OVL_FH_FLAG_BIG_ENDIAN
85 #error Endianness not defined
88 /* The type used to be returned by overlay exportfs for misaligned fid */
89 #define OVL_FILEID_V0 0xfb
90 /* The type returned by overlay exportfs for 32bit aligned fid */
91 #define OVL_FILEID_V1 0xf8
93 /* On-disk format for "origin" file handle */
97 u8 len; /* size of this header + size of fid */
98 u8 flags; /* OVL_FH_FLAG_* */
99 u8 type; /* fid_type of fid */
100 uuid_t uuid; /* uuid of filesystem */
101 u32 fid[]; /* file identifier should be 32bit aligned in-memory */
104 /* In-memory and on-wire format for overlay file handle */
106 u8 padding[3]; /* make sure fb.fid is 32bit aligned */
113 #define OVL_FH_WIRE_OFFSET offsetof(struct ovl_fh, fb)
114 #define OVL_FH_LEN(fh) (OVL_FH_WIRE_OFFSET + (fh)->fb.len)
115 #define OVL_FH_FID_OFFSET (OVL_FH_WIRE_OFFSET + \
116 offsetof(struct ovl_fb, fid))
118 extern const char *const ovl_xattr_table[][2];
119 static inline const char *ovl_xattr(struct ovl_fs *ofs, enum ovl_xattr ox)
121 return ovl_xattr_table[ox][ofs->config.userxattr];
124 static inline int ovl_do_rmdir(struct inode *dir, struct dentry *dentry)
126 int err = vfs_rmdir(&init_user_ns, dir, dentry);
128 pr_debug("rmdir(%pd2) = %i\n", dentry, err);
132 static inline int ovl_do_unlink(struct inode *dir, struct dentry *dentry)
134 int err = vfs_unlink(&init_user_ns, dir, dentry, NULL);
136 pr_debug("unlink(%pd2) = %i\n", dentry, err);
140 static inline int ovl_do_link(struct dentry *old_dentry, struct inode *dir,
141 struct dentry *new_dentry)
143 int err = vfs_link(old_dentry, &init_user_ns, dir, new_dentry, NULL);
145 pr_debug("link(%pd2, %pd2) = %i\n", old_dentry, new_dentry, err);
149 static inline int ovl_do_create(struct inode *dir, struct dentry *dentry,
152 int err = vfs_create(&init_user_ns, dir, dentry, mode, true);
154 pr_debug("create(%pd2, 0%o) = %i\n", dentry, mode, err);
158 static inline int ovl_do_mkdir(struct inode *dir, struct dentry *dentry,
161 int err = vfs_mkdir(&init_user_ns, dir, dentry, mode);
162 pr_debug("mkdir(%pd2, 0%o) = %i\n", dentry, mode, err);
166 static inline int ovl_do_mknod(struct inode *dir, struct dentry *dentry,
167 umode_t mode, dev_t dev)
169 int err = vfs_mknod(&init_user_ns, dir, dentry, mode, dev);
171 pr_debug("mknod(%pd2, 0%o, 0%o) = %i\n", dentry, mode, dev, err);
175 static inline int ovl_do_symlink(struct inode *dir, struct dentry *dentry,
178 int err = vfs_symlink(&init_user_ns, dir, dentry, oldname);
180 pr_debug("symlink(\"%s\", %pd2) = %i\n", oldname, dentry, err);
184 static inline ssize_t ovl_do_getxattr(struct ovl_fs *ofs, struct dentry *dentry,
185 enum ovl_xattr ox, void *value,
188 const char *name = ovl_xattr(ofs, ox);
189 int err = vfs_getxattr(&init_user_ns, dentry, name, value, size);
190 int len = (value && err > 0) ? err : 0;
192 pr_debug("getxattr(%pd2, \"%s\", \"%*pE\", %zu, 0) = %i\n",
193 dentry, name, min(len, 48), value, size, err);
197 static inline int ovl_do_setxattr(struct ovl_fs *ofs, struct dentry *dentry,
198 enum ovl_xattr ox, const void *value,
201 const char *name = ovl_xattr(ofs, ox);
202 int err = vfs_setxattr(&init_user_ns, dentry, name, value, size, 0);
203 pr_debug("setxattr(%pd2, \"%s\", \"%*pE\", %zu, 0) = %i\n",
204 dentry, name, min((int)size, 48), value, size, err);
208 static inline int ovl_do_removexattr(struct ovl_fs *ofs, struct dentry *dentry,
211 const char *name = ovl_xattr(ofs, ox);
212 int err = vfs_removexattr(&init_user_ns, dentry, name);
213 pr_debug("removexattr(%pd2, \"%s\") = %i\n", dentry, name, err);
217 static inline int ovl_do_rename(struct inode *olddir, struct dentry *olddentry,
218 struct inode *newdir, struct dentry *newdentry,
222 struct renamedata rd = {
223 .old_mnt_userns = &init_user_ns,
225 .old_dentry = olddentry,
226 .new_mnt_userns = &init_user_ns,
228 .new_dentry = newdentry,
232 pr_debug("rename(%pd2, %pd2, 0x%x)\n", olddentry, newdentry, flags);
233 err = vfs_rename(&rd);
235 pr_debug("...rename(%pd2, %pd2, ...) = %i\n",
236 olddentry, newdentry, err);
241 static inline int ovl_do_whiteout(struct inode *dir, struct dentry *dentry)
243 int err = vfs_whiteout(&init_user_ns, dir, dentry);
244 pr_debug("whiteout(%pd2) = %i\n", dentry, err);
248 static inline struct dentry *ovl_do_tmpfile(struct dentry *dentry, umode_t mode)
250 struct dentry *ret = vfs_tmpfile(&init_user_ns, dentry, mode, 0);
251 int err = PTR_ERR_OR_ZERO(ret);
253 pr_debug("tmpfile(%pd2, 0%o) = %i\n", dentry, mode, err);
257 static inline bool ovl_open_flags_need_copy_up(int flags)
262 return ((OPEN_FMODE(flags) & FMODE_WRITE) || (flags & O_TRUNC));
266 int ovl_want_write(struct dentry *dentry);
267 void ovl_drop_write(struct dentry *dentry);
268 struct dentry *ovl_workdir(struct dentry *dentry);
269 const struct cred *ovl_override_creds(struct super_block *sb);
270 int ovl_can_decode_fh(struct super_block *sb);
271 struct dentry *ovl_indexdir(struct super_block *sb);
272 bool ovl_index_all(struct super_block *sb);
273 bool ovl_verify_lower(struct super_block *sb);
274 struct ovl_entry *ovl_alloc_entry(unsigned int numlower);
275 bool ovl_dentry_remote(struct dentry *dentry);
276 void ovl_dentry_update_reval(struct dentry *dentry, struct dentry *upperdentry,
278 bool ovl_dentry_weird(struct dentry *dentry);
279 enum ovl_path_type ovl_path_type(struct dentry *dentry);
280 void ovl_path_upper(struct dentry *dentry, struct path *path);
281 void ovl_path_lower(struct dentry *dentry, struct path *path);
282 void ovl_path_lowerdata(struct dentry *dentry, struct path *path);
283 enum ovl_path_type ovl_path_real(struct dentry *dentry, struct path *path);
284 struct dentry *ovl_dentry_upper(struct dentry *dentry);
285 struct dentry *ovl_dentry_lower(struct dentry *dentry);
286 struct dentry *ovl_dentry_lowerdata(struct dentry *dentry);
287 const struct ovl_layer *ovl_layer_lower(struct dentry *dentry);
288 struct dentry *ovl_dentry_real(struct dentry *dentry);
289 struct dentry *ovl_i_dentry_upper(struct inode *inode);
290 struct inode *ovl_inode_upper(struct inode *inode);
291 struct inode *ovl_inode_lower(struct inode *inode);
292 struct inode *ovl_inode_lowerdata(struct inode *inode);
293 struct inode *ovl_inode_real(struct inode *inode);
294 struct inode *ovl_inode_realdata(struct inode *inode);
295 struct ovl_dir_cache *ovl_dir_cache(struct inode *inode);
296 void ovl_set_dir_cache(struct inode *inode, struct ovl_dir_cache *cache);
297 void ovl_dentry_set_flag(unsigned long flag, struct dentry *dentry);
298 void ovl_dentry_clear_flag(unsigned long flag, struct dentry *dentry);
299 bool ovl_dentry_test_flag(unsigned long flag, struct dentry *dentry);
300 bool ovl_dentry_is_opaque(struct dentry *dentry);
301 bool ovl_dentry_is_whiteout(struct dentry *dentry);
302 void ovl_dentry_set_opaque(struct dentry *dentry);
303 bool ovl_dentry_has_upper_alias(struct dentry *dentry);
304 void ovl_dentry_set_upper_alias(struct dentry *dentry);
305 bool ovl_dentry_needs_data_copy_up(struct dentry *dentry, int flags);
306 bool ovl_dentry_needs_data_copy_up_locked(struct dentry *dentry, int flags);
307 bool ovl_has_upperdata(struct inode *inode);
308 void ovl_set_upperdata(struct inode *inode);
309 bool ovl_redirect_dir(struct super_block *sb);
310 const char *ovl_dentry_get_redirect(struct dentry *dentry);
311 void ovl_dentry_set_redirect(struct dentry *dentry, const char *redirect);
312 void ovl_inode_update(struct inode *inode, struct dentry *upperdentry);
313 void ovl_dir_modified(struct dentry *dentry, bool impurity);
314 u64 ovl_dentry_version_get(struct dentry *dentry);
315 bool ovl_is_whiteout(struct dentry *dentry);
316 struct file *ovl_path_open(struct path *path, int flags);
317 int ovl_copy_up_start(struct dentry *dentry, int flags);
318 void ovl_copy_up_end(struct dentry *dentry);
319 bool ovl_already_copied_up(struct dentry *dentry, int flags);
320 bool ovl_check_origin_xattr(struct ovl_fs *ofs, struct dentry *dentry);
321 bool ovl_check_dir_xattr(struct super_block *sb, struct dentry *dentry,
323 int ovl_check_setxattr(struct dentry *dentry, struct dentry *upperdentry,
324 enum ovl_xattr ox, const void *value, size_t size,
326 int ovl_set_impure(struct dentry *dentry, struct dentry *upperdentry);
327 bool ovl_inuse_trylock(struct dentry *dentry);
328 void ovl_inuse_unlock(struct dentry *dentry);
329 bool ovl_is_inuse(struct dentry *dentry);
330 bool ovl_need_index(struct dentry *dentry);
331 int ovl_nlink_start(struct dentry *dentry);
332 void ovl_nlink_end(struct dentry *dentry);
333 int ovl_lock_rename_workdir(struct dentry *workdir, struct dentry *upperdir);
334 int ovl_check_metacopy_xattr(struct ovl_fs *ofs, struct dentry *dentry);
335 bool ovl_is_metacopy_dentry(struct dentry *dentry);
336 char *ovl_get_redirect_xattr(struct ovl_fs *ofs, struct dentry *dentry,
338 int ovl_sync_status(struct ovl_fs *ofs);
340 static inline void ovl_set_flag(unsigned long flag, struct inode *inode)
342 set_bit(flag, &OVL_I(inode)->flags);
345 static inline void ovl_clear_flag(unsigned long flag, struct inode *inode)
347 clear_bit(flag, &OVL_I(inode)->flags);
350 static inline bool ovl_test_flag(unsigned long flag, struct inode *inode)
352 return test_bit(flag, &OVL_I(inode)->flags);
355 static inline bool ovl_is_impuredir(struct super_block *sb,
356 struct dentry *dentry)
358 return ovl_check_dir_xattr(sb, dentry, OVL_XATTR_IMPURE);
362 * With xino=auto, we do best effort to keep all inodes on same st_dev and
363 * d_ino consistent with st_ino.
364 * With xino=on, we do the same effort but we warn if we failed.
366 static inline bool ovl_xino_warn(struct super_block *sb)
368 return OVL_FS(sb)->config.xino == OVL_XINO_ON;
371 /* All layers on same fs? */
372 static inline bool ovl_same_fs(struct super_block *sb)
374 return OVL_FS(sb)->xino_mode == 0;
377 /* All overlay inodes have same st_dev? */
378 static inline bool ovl_same_dev(struct super_block *sb)
380 return OVL_FS(sb)->xino_mode >= 0;
383 static inline unsigned int ovl_xino_bits(struct super_block *sb)
385 return ovl_same_dev(sb) ? OVL_FS(sb)->xino_mode : 0;
388 static inline void ovl_inode_lock(struct inode *inode)
390 mutex_lock(&OVL_I(inode)->lock);
393 static inline int ovl_inode_lock_interruptible(struct inode *inode)
395 return mutex_lock_interruptible(&OVL_I(inode)->lock);
398 static inline void ovl_inode_unlock(struct inode *inode)
400 mutex_unlock(&OVL_I(inode)->lock);
405 int ovl_check_fb_len(struct ovl_fb *fb, int fb_len);
407 static inline int ovl_check_fh_len(struct ovl_fh *fh, int fh_len)
409 if (fh_len < sizeof(struct ovl_fh))
412 return ovl_check_fb_len(&fh->fb, fh_len - OVL_FH_WIRE_OFFSET);
415 struct dentry *ovl_decode_real_fh(struct ovl_fs *ofs, struct ovl_fh *fh,
416 struct vfsmount *mnt, bool connected);
417 int ovl_check_origin_fh(struct ovl_fs *ofs, struct ovl_fh *fh, bool connected,
418 struct dentry *upperdentry, struct ovl_path **stackp);
419 int ovl_verify_set_fh(struct ovl_fs *ofs, struct dentry *dentry,
420 enum ovl_xattr ox, struct dentry *real, bool is_upper,
422 struct dentry *ovl_index_upper(struct ovl_fs *ofs, struct dentry *index);
423 int ovl_verify_index(struct ovl_fs *ofs, struct dentry *index);
424 int ovl_get_index_name(struct ovl_fs *ofs, struct dentry *origin,
426 struct dentry *ovl_get_index_fh(struct ovl_fs *ofs, struct ovl_fh *fh);
427 struct dentry *ovl_lookup_index(struct ovl_fs *ofs, struct dentry *upper,
428 struct dentry *origin, bool verify);
429 int ovl_path_next(int idx, struct dentry *dentry, struct path *path);
430 struct dentry *ovl_lookup(struct inode *dir, struct dentry *dentry,
432 bool ovl_lower_positive(struct dentry *dentry);
434 static inline int ovl_verify_origin(struct ovl_fs *ofs, struct dentry *upper,
435 struct dentry *origin, bool set)
437 return ovl_verify_set_fh(ofs, upper, OVL_XATTR_ORIGIN, origin,
441 static inline int ovl_verify_upper(struct ovl_fs *ofs, struct dentry *index,
442 struct dentry *upper, bool set)
444 return ovl_verify_set_fh(ofs, index, OVL_XATTR_UPPER, upper, true, set);
448 extern const struct file_operations ovl_dir_operations;
449 struct file *ovl_dir_real_file(const struct file *file, bool want_upper);
450 int ovl_check_empty_dir(struct dentry *dentry, struct list_head *list);
451 void ovl_cleanup_whiteouts(struct dentry *upper, struct list_head *list);
452 void ovl_cache_free(struct list_head *list);
453 void ovl_dir_cache_free(struct inode *inode);
454 int ovl_check_d_type_supported(struct path *realpath);
455 int ovl_workdir_cleanup(struct inode *dir, struct vfsmount *mnt,
456 struct dentry *dentry, int level);
457 int ovl_indexdir_cleanup(struct ovl_fs *ofs);
460 * Can we iterate real dir directly?
462 * Non-merge dir may contain whiteouts from a time it was a merge upper, before
463 * lower dir was removed under it and possibly before it was rotated from upper
466 static inline bool ovl_dir_is_real(struct dentry *dir)
468 return !ovl_test_flag(OVL_WHITEOUTS, d_inode(dir));
472 int ovl_set_nlink_upper(struct dentry *dentry);
473 int ovl_set_nlink_lower(struct dentry *dentry);
474 unsigned int ovl_get_nlink(struct ovl_fs *ofs, struct dentry *lowerdentry,
475 struct dentry *upperdentry,
476 unsigned int fallback);
477 int ovl_setattr(struct user_namespace *mnt_userns, struct dentry *dentry,
479 int ovl_getattr(struct user_namespace *mnt_userns, const struct path *path,
480 struct kstat *stat, u32 request_mask, unsigned int flags);
481 int ovl_permission(struct user_namespace *mnt_userns, struct inode *inode,
483 int ovl_xattr_set(struct dentry *dentry, struct inode *inode, const char *name,
484 const void *value, size_t size, int flags);
485 int ovl_xattr_get(struct dentry *dentry, struct inode *inode, const char *name,
486 void *value, size_t size);
487 ssize_t ovl_listxattr(struct dentry *dentry, char *list, size_t size);
488 struct posix_acl *ovl_get_acl(struct inode *inode, int type);
489 int ovl_update_time(struct inode *inode, struct timespec64 *ts, int flags);
490 bool ovl_is_private_xattr(struct super_block *sb, const char *name);
492 struct ovl_inode_params {
493 struct inode *newinode;
494 struct dentry *upperdentry;
495 struct ovl_path *lowerpath;
497 unsigned int numlower;
499 struct dentry *lowerdata;
501 void ovl_inode_init(struct inode *inode, struct ovl_inode_params *oip,
502 unsigned long ino, int fsid);
503 struct inode *ovl_new_inode(struct super_block *sb, umode_t mode, dev_t rdev);
504 struct inode *ovl_lookup_inode(struct super_block *sb, struct dentry *real,
506 bool ovl_lookup_trap_inode(struct super_block *sb, struct dentry *dir);
507 struct inode *ovl_get_trap_inode(struct super_block *sb, struct dentry *dir);
508 struct inode *ovl_get_inode(struct super_block *sb,
509 struct ovl_inode_params *oip);
510 static inline void ovl_copyattr(struct inode *from, struct inode *to)
512 to->i_uid = from->i_uid;
513 to->i_gid = from->i_gid;
514 to->i_mode = from->i_mode;
515 to->i_atime = from->i_atime;
516 to->i_mtime = from->i_mtime;
517 to->i_ctime = from->i_ctime;
518 i_size_write(to, i_size_read(from));
521 static inline void ovl_copyflags(struct inode *from, struct inode *to)
523 unsigned int mask = S_SYNC | S_IMMUTABLE | S_APPEND | S_NOATIME;
525 inode_set_flags(to, from->i_flags & mask, mask);
529 extern const struct inode_operations ovl_dir_inode_operations;
530 int ovl_cleanup_and_whiteout(struct ovl_fs *ofs, struct inode *dir,
531 struct dentry *dentry);
536 struct dentry *hardlink;
539 #define OVL_CATTR(m) (&(struct ovl_cattr) { .mode = (m) })
541 struct dentry *ovl_create_real(struct inode *dir, struct dentry *newdentry,
542 struct ovl_cattr *attr);
543 int ovl_cleanup(struct inode *dir, struct dentry *dentry);
544 struct dentry *ovl_lookup_temp(struct dentry *workdir);
545 struct dentry *ovl_create_temp(struct dentry *workdir, struct ovl_cattr *attr);
548 extern const struct file_operations ovl_file_operations;
549 int __init ovl_aio_request_cache_init(void);
550 void ovl_aio_request_cache_destroy(void);
551 int ovl_fileattr_get(struct dentry *dentry, struct fileattr *fa);
552 int ovl_fileattr_set(struct user_namespace *mnt_userns,
553 struct dentry *dentry, struct fileattr *fa);
556 int ovl_copy_up(struct dentry *dentry);
557 int ovl_copy_up_with_data(struct dentry *dentry);
558 int ovl_maybe_copy_up(struct dentry *dentry, int flags);
559 int ovl_copy_xattr(struct super_block *sb, struct dentry *old,
561 int ovl_set_attr(struct dentry *upper, struct kstat *stat);
562 struct ovl_fh *ovl_encode_real_fh(struct ovl_fs *ofs, struct dentry *real,
564 int ovl_set_origin(struct ovl_fs *ofs, struct dentry *dentry,
565 struct dentry *lower, struct dentry *upper);
568 extern const struct export_operations ovl_export_operations;