1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * 4 * Copyright (C) 2011 Novell Inc. 5 */ 6 7 #include <linux/kernel.h> 8 #include <linux/uuid.h> 9 #include <linux/fs.h> 10 #include <linux/fsverity.h> 11 #include <linux/namei.h> 12 #include <linux/posix_acl.h> 13 #include <linux/posix_acl_xattr.h> 14 #include "ovl_entry.h" 15 16 #undef pr_fmt 17 #define pr_fmt(fmt) "overlayfs: " fmt 18 19 enum ovl_path_type { 20 __OVL_PATH_UPPER = (1 << 0), 21 __OVL_PATH_MERGE = (1 << 1), 22 __OVL_PATH_ORIGIN = (1 << 2), 23 }; 24 25 #define OVL_TYPE_UPPER(type) ((type) & __OVL_PATH_UPPER) 26 #define OVL_TYPE_MERGE(type) ((type) & __OVL_PATH_MERGE) 27 #define OVL_TYPE_ORIGIN(type) ((type) & __OVL_PATH_ORIGIN) 28 29 #define OVL_XATTR_NAMESPACE "overlay." 30 #define OVL_XATTR_TRUSTED_PREFIX XATTR_TRUSTED_PREFIX OVL_XATTR_NAMESPACE 31 #define OVL_XATTR_USER_PREFIX XATTR_USER_PREFIX OVL_XATTR_NAMESPACE 32 33 enum ovl_xattr { 34 OVL_XATTR_OPAQUE, 35 OVL_XATTR_REDIRECT, 36 OVL_XATTR_ORIGIN, 37 OVL_XATTR_IMPURE, 38 OVL_XATTR_NLINK, 39 OVL_XATTR_UPPER, 40 OVL_XATTR_UUID, 41 OVL_XATTR_METACOPY, 42 OVL_XATTR_PROTATTR, 43 }; 44 45 enum ovl_inode_flag { 46 /* Pure upper dir that may contain non pure upper entries */ 47 OVL_IMPURE, 48 /* Non-merge dir that may contain whiteout entries */ 49 OVL_WHITEOUTS, 50 OVL_INDEX, 51 OVL_UPPERDATA, 52 /* Inode number will remain constant over copy up. */ 53 OVL_CONST_INO, 54 OVL_HAS_DIGEST, 55 OVL_VERIFIED_DIGEST, 56 }; 57 58 enum ovl_entry_flag { 59 OVL_E_UPPER_ALIAS, 60 OVL_E_OPAQUE, 61 OVL_E_CONNECTED, 62 }; 63 64 enum { 65 OVL_REDIRECT_OFF, /* "off" mode is never used. In effect */ 66 OVL_REDIRECT_FOLLOW, /* ...it translates to either "follow" */ 67 OVL_REDIRECT_NOFOLLOW, /* ...or "nofollow". */ 68 OVL_REDIRECT_ON, 69 }; 70 71 enum { 72 OVL_UUID_OFF, 73 OVL_UUID_NULL, 74 OVL_UUID_AUTO, 75 OVL_UUID_ON, 76 }; 77 78 enum { 79 OVL_XINO_OFF, 80 OVL_XINO_AUTO, 81 OVL_XINO_ON, 82 }; 83 84 enum { 85 OVL_VERITY_OFF, 86 OVL_VERITY_ON, 87 OVL_VERITY_REQUIRE, 88 }; 89 90 /* 91 * The tuple (fh,uuid) is a universal unique identifier for a copy up origin, 92 * where: 93 * origin.fh - exported file handle of the lower file 94 * origin.uuid - uuid of the lower filesystem 95 */ 96 #define OVL_FH_VERSION 0 97 #define OVL_FH_MAGIC 0xfb 98 99 /* CPU byte order required for fid decoding: */ 100 #define OVL_FH_FLAG_BIG_ENDIAN (1 << 0) 101 #define OVL_FH_FLAG_ANY_ENDIAN (1 << 1) 102 /* Is the real inode encoded in fid an upper inode? */ 103 #define OVL_FH_FLAG_PATH_UPPER (1 << 2) 104 105 #define OVL_FH_FLAG_ALL (OVL_FH_FLAG_BIG_ENDIAN | OVL_FH_FLAG_ANY_ENDIAN | \ 106 OVL_FH_FLAG_PATH_UPPER) 107 108 #if defined(__LITTLE_ENDIAN) 109 #define OVL_FH_FLAG_CPU_ENDIAN 0 110 #elif defined(__BIG_ENDIAN) 111 #define OVL_FH_FLAG_CPU_ENDIAN OVL_FH_FLAG_BIG_ENDIAN 112 #else 113 #error Endianness not defined 114 #endif 115 116 /* The type used to be returned by overlay exportfs for misaligned fid */ 117 #define OVL_FILEID_V0 0xfb 118 /* The type returned by overlay exportfs for 32bit aligned fid */ 119 #define OVL_FILEID_V1 0xf8 120 121 /* On-disk format for "origin" file handle */ 122 struct ovl_fb { 123 u8 version; /* 0 */ 124 u8 magic; /* 0xfb */ 125 u8 len; /* size of this header + size of fid */ 126 u8 flags; /* OVL_FH_FLAG_* */ 127 u8 type; /* fid_type of fid */ 128 uuid_t uuid; /* uuid of filesystem */ 129 u32 fid[]; /* file identifier should be 32bit aligned in-memory */ 130 } __packed; 131 132 /* In-memory and on-wire format for overlay file handle */ 133 struct ovl_fh { 134 u8 padding[3]; /* make sure fb.fid is 32bit aligned */ 135 union { 136 struct ovl_fb fb; 137 DECLARE_FLEX_ARRAY(u8, buf); 138 }; 139 } __packed; 140 141 #define OVL_FH_WIRE_OFFSET offsetof(struct ovl_fh, fb) 142 #define OVL_FH_LEN(fh) (OVL_FH_WIRE_OFFSET + (fh)->fb.len) 143 #define OVL_FH_FID_OFFSET (OVL_FH_WIRE_OFFSET + \ 144 offsetof(struct ovl_fb, fid)) 145 146 /* On-disk format for "metacopy" xattr (if non-zero size) */ 147 struct ovl_metacopy { 148 u8 version; /* 0 */ 149 u8 len; /* size of this header + used digest bytes */ 150 u8 flags; 151 u8 digest_algo; /* FS_VERITY_HASH_ALG_* constant, 0 for no digest */ 152 u8 digest[FS_VERITY_MAX_DIGEST_SIZE]; /* Only the used part on disk */ 153 } __packed; 154 155 #define OVL_METACOPY_MAX_SIZE (sizeof(struct ovl_metacopy)) 156 #define OVL_METACOPY_MIN_SIZE (OVL_METACOPY_MAX_SIZE - FS_VERITY_MAX_DIGEST_SIZE) 157 #define OVL_METACOPY_INIT { 0, OVL_METACOPY_MIN_SIZE } 158 159 static inline int ovl_metadata_digest_size(const struct ovl_metacopy *metacopy) 160 { 161 if (metacopy->len < OVL_METACOPY_MIN_SIZE) 162 return 0; 163 return (int)metacopy->len - OVL_METACOPY_MIN_SIZE; 164 } 165 166 extern const char *const ovl_xattr_table[][2]; 167 static inline const char *ovl_xattr(struct ovl_fs *ofs, enum ovl_xattr ox) 168 { 169 return ovl_xattr_table[ox][ofs->config.userxattr]; 170 } 171 172 /* 173 * When changing ownership of an upper object map the intended ownership 174 * according to the upper layer's idmapping. When an upper mount idmaps files 175 * that are stored on-disk as owned by id 1001 to id 1000 this means stat on 176 * this object will report it as being owned by id 1000 when calling stat via 177 * the upper mount. 178 * In order to change ownership of an object so stat reports id 1000 when 179 * called on an idmapped upper mount the value written to disk - i.e., the 180 * value stored in ia_*id - must 1001. The mount mapping helper will thus take 181 * care to map 1000 to 1001. 182 * The mnt idmapping helpers are nops if the upper layer isn't idmapped. 183 */ 184 static inline int ovl_do_notify_change(struct ovl_fs *ofs, 185 struct dentry *upperdentry, 186 struct iattr *attr) 187 { 188 return notify_change(ovl_upper_mnt_idmap(ofs), upperdentry, attr, NULL); 189 } 190 191 static inline int ovl_do_rmdir(struct ovl_fs *ofs, 192 struct inode *dir, struct dentry *dentry) 193 { 194 int err = vfs_rmdir(ovl_upper_mnt_idmap(ofs), dir, dentry); 195 196 pr_debug("rmdir(%pd2) = %i\n", dentry, err); 197 return err; 198 } 199 200 static inline int ovl_do_unlink(struct ovl_fs *ofs, struct inode *dir, 201 struct dentry *dentry) 202 { 203 int err = vfs_unlink(ovl_upper_mnt_idmap(ofs), dir, dentry, NULL); 204 205 pr_debug("unlink(%pd2) = %i\n", dentry, err); 206 return err; 207 } 208 209 static inline int ovl_do_link(struct ovl_fs *ofs, struct dentry *old_dentry, 210 struct inode *dir, struct dentry *new_dentry) 211 { 212 int err = vfs_link(old_dentry, ovl_upper_mnt_idmap(ofs), dir, 213 new_dentry, NULL); 214 215 pr_debug("link(%pd2, %pd2) = %i\n", old_dentry, new_dentry, err); 216 return err; 217 } 218 219 static inline int ovl_do_create(struct ovl_fs *ofs, 220 struct inode *dir, struct dentry *dentry, 221 umode_t mode) 222 { 223 int err = vfs_create(ovl_upper_mnt_idmap(ofs), dir, dentry, mode, true); 224 225 pr_debug("create(%pd2, 0%o) = %i\n", dentry, mode, err); 226 return err; 227 } 228 229 static inline int ovl_do_mkdir(struct ovl_fs *ofs, 230 struct inode *dir, struct dentry *dentry, 231 umode_t mode) 232 { 233 int err = vfs_mkdir(ovl_upper_mnt_idmap(ofs), dir, dentry, mode); 234 pr_debug("mkdir(%pd2, 0%o) = %i\n", dentry, mode, err); 235 return err; 236 } 237 238 static inline int ovl_do_mknod(struct ovl_fs *ofs, 239 struct inode *dir, struct dentry *dentry, 240 umode_t mode, dev_t dev) 241 { 242 int err = vfs_mknod(ovl_upper_mnt_idmap(ofs), dir, dentry, mode, dev); 243 244 pr_debug("mknod(%pd2, 0%o, 0%o) = %i\n", dentry, mode, dev, err); 245 return err; 246 } 247 248 static inline int ovl_do_symlink(struct ovl_fs *ofs, 249 struct inode *dir, struct dentry *dentry, 250 const char *oldname) 251 { 252 int err = vfs_symlink(ovl_upper_mnt_idmap(ofs), dir, dentry, oldname); 253 254 pr_debug("symlink(\"%s\", %pd2) = %i\n", oldname, dentry, err); 255 return err; 256 } 257 258 static inline ssize_t ovl_do_getxattr(const struct path *path, const char *name, 259 void *value, size_t size) 260 { 261 int err, len; 262 263 WARN_ON(path->dentry->d_sb != path->mnt->mnt_sb); 264 265 err = vfs_getxattr(mnt_idmap(path->mnt), path->dentry, 266 name, value, size); 267 len = (value && err > 0) ? err : 0; 268 269 pr_debug("getxattr(%pd2, \"%s\", \"%*pE\", %zu, 0) = %i\n", 270 path->dentry, name, min(len, 48), value, size, err); 271 return err; 272 } 273 274 static inline ssize_t ovl_getxattr_upper(struct ovl_fs *ofs, 275 struct dentry *upperdentry, 276 enum ovl_xattr ox, void *value, 277 size_t size) 278 { 279 struct path upperpath = { 280 .dentry = upperdentry, 281 .mnt = ovl_upper_mnt(ofs), 282 }; 283 284 return ovl_do_getxattr(&upperpath, ovl_xattr(ofs, ox), value, size); 285 } 286 287 static inline ssize_t ovl_path_getxattr(struct ovl_fs *ofs, 288 const struct path *path, 289 enum ovl_xattr ox, void *value, 290 size_t size) 291 { 292 return ovl_do_getxattr(path, ovl_xattr(ofs, ox), value, size); 293 } 294 295 static inline int ovl_do_setxattr(struct ovl_fs *ofs, struct dentry *dentry, 296 const char *name, const void *value, 297 size_t size, int flags) 298 { 299 int err = vfs_setxattr(ovl_upper_mnt_idmap(ofs), dentry, name, 300 value, size, flags); 301 302 pr_debug("setxattr(%pd2, \"%s\", \"%*pE\", %zu, %d) = %i\n", 303 dentry, name, min((int)size, 48), value, size, flags, err); 304 return err; 305 } 306 307 static inline int ovl_setxattr(struct ovl_fs *ofs, struct dentry *dentry, 308 enum ovl_xattr ox, const void *value, 309 size_t size) 310 { 311 return ovl_do_setxattr(ofs, dentry, ovl_xattr(ofs, ox), value, size, 0); 312 } 313 314 static inline int ovl_do_removexattr(struct ovl_fs *ofs, struct dentry *dentry, 315 const char *name) 316 { 317 int err = vfs_removexattr(ovl_upper_mnt_idmap(ofs), dentry, name); 318 pr_debug("removexattr(%pd2, \"%s\") = %i\n", dentry, name, err); 319 return err; 320 } 321 322 static inline int ovl_removexattr(struct ovl_fs *ofs, struct dentry *dentry, 323 enum ovl_xattr ox) 324 { 325 return ovl_do_removexattr(ofs, dentry, ovl_xattr(ofs, ox)); 326 } 327 328 static inline int ovl_do_set_acl(struct ovl_fs *ofs, struct dentry *dentry, 329 const char *acl_name, struct posix_acl *acl) 330 { 331 return vfs_set_acl(ovl_upper_mnt_idmap(ofs), dentry, acl_name, acl); 332 } 333 334 static inline int ovl_do_remove_acl(struct ovl_fs *ofs, struct dentry *dentry, 335 const char *acl_name) 336 { 337 return vfs_remove_acl(ovl_upper_mnt_idmap(ofs), dentry, acl_name); 338 } 339 340 static inline int ovl_do_rename(struct ovl_fs *ofs, struct inode *olddir, 341 struct dentry *olddentry, struct inode *newdir, 342 struct dentry *newdentry, unsigned int flags) 343 { 344 int err; 345 struct renamedata rd = { 346 .old_mnt_idmap = ovl_upper_mnt_idmap(ofs), 347 .old_dir = olddir, 348 .old_dentry = olddentry, 349 .new_mnt_idmap = ovl_upper_mnt_idmap(ofs), 350 .new_dir = newdir, 351 .new_dentry = newdentry, 352 .flags = flags, 353 }; 354 355 pr_debug("rename(%pd2, %pd2, 0x%x)\n", olddentry, newdentry, flags); 356 err = vfs_rename(&rd); 357 if (err) { 358 pr_debug("...rename(%pd2, %pd2, ...) = %i\n", 359 olddentry, newdentry, err); 360 } 361 return err; 362 } 363 364 static inline int ovl_do_whiteout(struct ovl_fs *ofs, 365 struct inode *dir, struct dentry *dentry) 366 { 367 int err = vfs_whiteout(ovl_upper_mnt_idmap(ofs), dir, dentry); 368 pr_debug("whiteout(%pd2) = %i\n", dentry, err); 369 return err; 370 } 371 372 static inline struct file *ovl_do_tmpfile(struct ovl_fs *ofs, 373 struct dentry *dentry, umode_t mode) 374 { 375 struct path path = { .mnt = ovl_upper_mnt(ofs), .dentry = dentry }; 376 struct file *file = kernel_tmpfile_open(ovl_upper_mnt_idmap(ofs), &path, 377 mode, O_LARGEFILE | O_WRONLY, 378 current_cred()); 379 int err = PTR_ERR_OR_ZERO(file); 380 381 pr_debug("tmpfile(%pd2, 0%o) = %i\n", dentry, mode, err); 382 return file; 383 } 384 385 static inline struct dentry *ovl_lookup_upper(struct ovl_fs *ofs, 386 const char *name, 387 struct dentry *base, int len) 388 { 389 return lookup_one(ovl_upper_mnt_idmap(ofs), name, base, len); 390 } 391 392 static inline bool ovl_open_flags_need_copy_up(int flags) 393 { 394 if (!flags) 395 return false; 396 397 return ((OPEN_FMODE(flags) & FMODE_WRITE) || (flags & O_TRUNC)); 398 } 399 400 static inline int ovl_do_getattr(const struct path *path, struct kstat *stat, 401 u32 request_mask, unsigned int flags) 402 { 403 if (flags & AT_GETATTR_NOSEC) 404 return vfs_getattr_nosec(path, stat, request_mask, flags); 405 return vfs_getattr(path, stat, request_mask, flags); 406 } 407 408 /* util.c */ 409 int ovl_want_write(struct dentry *dentry); 410 void ovl_drop_write(struct dentry *dentry); 411 struct dentry *ovl_workdir(struct dentry *dentry); 412 const struct cred *ovl_override_creds(struct super_block *sb); 413 int ovl_can_decode_fh(struct super_block *sb); 414 struct dentry *ovl_indexdir(struct super_block *sb); 415 bool ovl_index_all(struct super_block *sb); 416 bool ovl_verify_lower(struct super_block *sb); 417 struct ovl_path *ovl_stack_alloc(unsigned int n); 418 void ovl_stack_cpy(struct ovl_path *dst, struct ovl_path *src, unsigned int n); 419 void ovl_stack_put(struct ovl_path *stack, unsigned int n); 420 void ovl_stack_free(struct ovl_path *stack, unsigned int n); 421 struct ovl_entry *ovl_alloc_entry(unsigned int numlower); 422 void ovl_free_entry(struct ovl_entry *oe); 423 bool ovl_dentry_remote(struct dentry *dentry); 424 void ovl_dentry_update_reval(struct dentry *dentry, struct dentry *realdentry); 425 void ovl_dentry_init_reval(struct dentry *dentry, struct dentry *upperdentry, 426 struct ovl_entry *oe); 427 void ovl_dentry_init_flags(struct dentry *dentry, struct dentry *upperdentry, 428 struct ovl_entry *oe, unsigned int mask); 429 bool ovl_dentry_weird(struct dentry *dentry); 430 enum ovl_path_type ovl_path_type(struct dentry *dentry); 431 void ovl_path_upper(struct dentry *dentry, struct path *path); 432 void ovl_path_lower(struct dentry *dentry, struct path *path); 433 void ovl_path_lowerdata(struct dentry *dentry, struct path *path); 434 struct inode *ovl_i_path_real(struct inode *inode, struct path *path); 435 enum ovl_path_type ovl_path_real(struct dentry *dentry, struct path *path); 436 enum ovl_path_type ovl_path_realdata(struct dentry *dentry, struct path *path); 437 struct dentry *ovl_dentry_upper(struct dentry *dentry); 438 struct dentry *ovl_dentry_lower(struct dentry *dentry); 439 struct dentry *ovl_dentry_lowerdata(struct dentry *dentry); 440 int ovl_dentry_set_lowerdata(struct dentry *dentry, struct ovl_path *datapath); 441 const struct ovl_layer *ovl_i_layer_lower(struct inode *inode); 442 const struct ovl_layer *ovl_layer_lower(struct dentry *dentry); 443 struct dentry *ovl_dentry_real(struct dentry *dentry); 444 struct dentry *ovl_i_dentry_upper(struct inode *inode); 445 struct inode *ovl_inode_upper(struct inode *inode); 446 struct inode *ovl_inode_lower(struct inode *inode); 447 struct inode *ovl_inode_lowerdata(struct inode *inode); 448 struct inode *ovl_inode_real(struct inode *inode); 449 struct inode *ovl_inode_realdata(struct inode *inode); 450 const char *ovl_lowerdata_redirect(struct inode *inode); 451 struct ovl_dir_cache *ovl_dir_cache(struct inode *inode); 452 void ovl_set_dir_cache(struct inode *inode, struct ovl_dir_cache *cache); 453 void ovl_dentry_set_flag(unsigned long flag, struct dentry *dentry); 454 void ovl_dentry_clear_flag(unsigned long flag, struct dentry *dentry); 455 bool ovl_dentry_test_flag(unsigned long flag, struct dentry *dentry); 456 bool ovl_dentry_is_opaque(struct dentry *dentry); 457 bool ovl_dentry_is_whiteout(struct dentry *dentry); 458 void ovl_dentry_set_opaque(struct dentry *dentry); 459 bool ovl_dentry_has_upper_alias(struct dentry *dentry); 460 void ovl_dentry_set_upper_alias(struct dentry *dentry); 461 bool ovl_dentry_needs_data_copy_up(struct dentry *dentry, int flags); 462 bool ovl_dentry_needs_data_copy_up_locked(struct dentry *dentry, int flags); 463 bool ovl_has_upperdata(struct inode *inode); 464 void ovl_set_upperdata(struct inode *inode); 465 const char *ovl_dentry_get_redirect(struct dentry *dentry); 466 void ovl_dentry_set_redirect(struct dentry *dentry, const char *redirect); 467 void ovl_inode_update(struct inode *inode, struct dentry *upperdentry); 468 void ovl_dir_modified(struct dentry *dentry, bool impurity); 469 u64 ovl_inode_version_get(struct inode *inode); 470 bool ovl_is_whiteout(struct dentry *dentry); 471 struct file *ovl_path_open(const struct path *path, int flags); 472 int ovl_copy_up_start(struct dentry *dentry, int flags); 473 void ovl_copy_up_end(struct dentry *dentry); 474 bool ovl_already_copied_up(struct dentry *dentry, int flags); 475 bool ovl_path_check_dir_xattr(struct ovl_fs *ofs, const struct path *path, 476 enum ovl_xattr ox); 477 bool ovl_path_check_origin_xattr(struct ovl_fs *ofs, const struct path *path); 478 bool ovl_init_uuid_xattr(struct super_block *sb, struct ovl_fs *ofs, 479 const struct path *upperpath); 480 481 static inline bool ovl_check_origin_xattr(struct ovl_fs *ofs, 482 struct dentry *upperdentry) 483 { 484 struct path upperpath = { 485 .dentry = upperdentry, 486 .mnt = ovl_upper_mnt(ofs), 487 }; 488 return ovl_path_check_origin_xattr(ofs, &upperpath); 489 } 490 491 int ovl_check_setxattr(struct ovl_fs *ofs, struct dentry *upperdentry, 492 enum ovl_xattr ox, const void *value, size_t size, 493 int xerr); 494 int ovl_set_impure(struct dentry *dentry, struct dentry *upperdentry); 495 bool ovl_inuse_trylock(struct dentry *dentry); 496 void ovl_inuse_unlock(struct dentry *dentry); 497 bool ovl_is_inuse(struct dentry *dentry); 498 bool ovl_need_index(struct dentry *dentry); 499 int ovl_nlink_start(struct dentry *dentry); 500 void ovl_nlink_end(struct dentry *dentry); 501 int ovl_lock_rename_workdir(struct dentry *workdir, struct dentry *upperdir); 502 int ovl_check_metacopy_xattr(struct ovl_fs *ofs, const struct path *path, 503 struct ovl_metacopy *data); 504 int ovl_set_metacopy_xattr(struct ovl_fs *ofs, struct dentry *d, 505 struct ovl_metacopy *metacopy); 506 bool ovl_is_metacopy_dentry(struct dentry *dentry); 507 char *ovl_get_redirect_xattr(struct ovl_fs *ofs, const struct path *path, int padding); 508 int ovl_ensure_verity_loaded(struct path *path); 509 int ovl_get_verity_xattr(struct ovl_fs *ofs, const struct path *path, 510 u8 *digest_buf, int *buf_length); 511 int ovl_validate_verity(struct ovl_fs *ofs, 512 struct path *metapath, 513 struct path *datapath); 514 int ovl_get_verity_digest(struct ovl_fs *ofs, struct path *src, 515 struct ovl_metacopy *metacopy); 516 int ovl_sync_status(struct ovl_fs *ofs); 517 518 static inline void ovl_set_flag(unsigned long flag, struct inode *inode) 519 { 520 set_bit(flag, &OVL_I(inode)->flags); 521 } 522 523 static inline void ovl_clear_flag(unsigned long flag, struct inode *inode) 524 { 525 clear_bit(flag, &OVL_I(inode)->flags); 526 } 527 528 static inline bool ovl_test_flag(unsigned long flag, struct inode *inode) 529 { 530 return test_bit(flag, &OVL_I(inode)->flags); 531 } 532 533 static inline bool ovl_is_impuredir(struct super_block *sb, 534 struct dentry *upperdentry) 535 { 536 struct ovl_fs *ofs = OVL_FS(sb); 537 struct path upperpath = { 538 .dentry = upperdentry, 539 .mnt = ovl_upper_mnt(ofs), 540 }; 541 542 return ovl_path_check_dir_xattr(ofs, &upperpath, OVL_XATTR_IMPURE); 543 } 544 545 static inline bool ovl_redirect_follow(struct ovl_fs *ofs) 546 { 547 return ofs->config.redirect_mode != OVL_REDIRECT_NOFOLLOW; 548 } 549 550 static inline bool ovl_redirect_dir(struct ovl_fs *ofs) 551 { 552 return ofs->config.redirect_mode == OVL_REDIRECT_ON; 553 } 554 555 static inline bool ovl_origin_uuid(struct ovl_fs *ofs) 556 { 557 return ofs->config.uuid != OVL_UUID_OFF; 558 } 559 560 static inline bool ovl_has_fsid(struct ovl_fs *ofs) 561 { 562 return ofs->config.uuid == OVL_UUID_ON || 563 ofs->config.uuid == OVL_UUID_AUTO; 564 } 565 566 /* 567 * With xino=auto, we do best effort to keep all inodes on same st_dev and 568 * d_ino consistent with st_ino. 569 * With xino=on, we do the same effort but we warn if we failed. 570 */ 571 static inline bool ovl_xino_warn(struct ovl_fs *ofs) 572 { 573 return ofs->config.xino == OVL_XINO_ON; 574 } 575 576 /* 577 * To avoid regressions in existing setups with overlay lower offline changes, 578 * we allow lower changes only if none of the new features are used. 579 */ 580 static inline bool ovl_allow_offline_changes(struct ovl_fs *ofs) 581 { 582 return (!ofs->config.index && !ofs->config.metacopy && 583 !ovl_redirect_dir(ofs) && !ovl_xino_warn(ofs)); 584 } 585 586 /* All layers on same fs? */ 587 static inline bool ovl_same_fs(struct ovl_fs *ofs) 588 { 589 return ofs->xino_mode == 0; 590 } 591 592 /* All overlay inodes have same st_dev? */ 593 static inline bool ovl_same_dev(struct ovl_fs *ofs) 594 { 595 return ofs->xino_mode >= 0; 596 } 597 598 static inline unsigned int ovl_xino_bits(struct ovl_fs *ofs) 599 { 600 return ovl_same_dev(ofs) ? ofs->xino_mode : 0; 601 } 602 603 static inline void ovl_inode_lock(struct inode *inode) 604 { 605 mutex_lock(&OVL_I(inode)->lock); 606 } 607 608 static inline int ovl_inode_lock_interruptible(struct inode *inode) 609 { 610 return mutex_lock_interruptible(&OVL_I(inode)->lock); 611 } 612 613 static inline void ovl_inode_unlock(struct inode *inode) 614 { 615 mutex_unlock(&OVL_I(inode)->lock); 616 } 617 618 619 /* namei.c */ 620 int ovl_check_fb_len(struct ovl_fb *fb, int fb_len); 621 622 static inline int ovl_check_fh_len(struct ovl_fh *fh, int fh_len) 623 { 624 if (fh_len < sizeof(struct ovl_fh)) 625 return -EINVAL; 626 627 return ovl_check_fb_len(&fh->fb, fh_len - OVL_FH_WIRE_OFFSET); 628 } 629 630 struct dentry *ovl_decode_real_fh(struct ovl_fs *ofs, struct ovl_fh *fh, 631 struct vfsmount *mnt, bool connected); 632 int ovl_check_origin_fh(struct ovl_fs *ofs, struct ovl_fh *fh, bool connected, 633 struct dentry *upperdentry, struct ovl_path **stackp); 634 int ovl_verify_set_fh(struct ovl_fs *ofs, struct dentry *dentry, 635 enum ovl_xattr ox, struct dentry *real, bool is_upper, 636 bool set); 637 struct dentry *ovl_index_upper(struct ovl_fs *ofs, struct dentry *index, 638 bool connected); 639 int ovl_verify_index(struct ovl_fs *ofs, struct dentry *index); 640 int ovl_get_index_name(struct ovl_fs *ofs, struct dentry *origin, 641 struct qstr *name); 642 struct dentry *ovl_get_index_fh(struct ovl_fs *ofs, struct ovl_fh *fh); 643 struct dentry *ovl_lookup_index(struct ovl_fs *ofs, struct dentry *upper, 644 struct dentry *origin, bool verify); 645 int ovl_path_next(int idx, struct dentry *dentry, struct path *path); 646 int ovl_verify_lowerdata(struct dentry *dentry); 647 struct dentry *ovl_lookup(struct inode *dir, struct dentry *dentry, 648 unsigned int flags); 649 bool ovl_lower_positive(struct dentry *dentry); 650 651 static inline int ovl_verify_origin(struct ovl_fs *ofs, struct dentry *upper, 652 struct dentry *origin, bool set) 653 { 654 return ovl_verify_set_fh(ofs, upper, OVL_XATTR_ORIGIN, origin, 655 false, set); 656 } 657 658 static inline int ovl_verify_upper(struct ovl_fs *ofs, struct dentry *index, 659 struct dentry *upper, bool set) 660 { 661 return ovl_verify_set_fh(ofs, index, OVL_XATTR_UPPER, upper, true, set); 662 } 663 664 /* readdir.c */ 665 extern const struct file_operations ovl_dir_operations; 666 struct file *ovl_dir_real_file(const struct file *file, bool want_upper); 667 int ovl_check_empty_dir(struct dentry *dentry, struct list_head *list); 668 void ovl_cleanup_whiteouts(struct ovl_fs *ofs, struct dentry *upper, 669 struct list_head *list); 670 void ovl_cache_free(struct list_head *list); 671 void ovl_dir_cache_free(struct inode *inode); 672 int ovl_check_d_type_supported(const struct path *realpath); 673 int ovl_workdir_cleanup(struct ovl_fs *ofs, struct inode *dir, 674 struct vfsmount *mnt, struct dentry *dentry, int level); 675 int ovl_indexdir_cleanup(struct ovl_fs *ofs); 676 677 /* 678 * Can we iterate real dir directly? 679 * 680 * Non-merge dir may contain whiteouts from a time it was a merge upper, before 681 * lower dir was removed under it and possibly before it was rotated from upper 682 * to lower layer. 683 */ 684 static inline bool ovl_dir_is_real(struct inode *dir) 685 { 686 return !ovl_test_flag(OVL_WHITEOUTS, dir); 687 } 688 689 /* inode.c */ 690 int ovl_set_nlink_upper(struct dentry *dentry); 691 int ovl_set_nlink_lower(struct dentry *dentry); 692 unsigned int ovl_get_nlink(struct ovl_fs *ofs, struct dentry *lowerdentry, 693 struct dentry *upperdentry, 694 unsigned int fallback); 695 int ovl_setattr(struct mnt_idmap *idmap, struct dentry *dentry, 696 struct iattr *attr); 697 int ovl_getattr(struct mnt_idmap *idmap, const struct path *path, 698 struct kstat *stat, u32 request_mask, unsigned int flags); 699 int ovl_permission(struct mnt_idmap *idmap, struct inode *inode, 700 int mask); 701 int ovl_xattr_set(struct dentry *dentry, struct inode *inode, const char *name, 702 const void *value, size_t size, int flags); 703 int ovl_xattr_get(struct dentry *dentry, struct inode *inode, const char *name, 704 void *value, size_t size); 705 ssize_t ovl_listxattr(struct dentry *dentry, char *list, size_t size); 706 707 #ifdef CONFIG_FS_POSIX_ACL 708 struct posix_acl *do_ovl_get_acl(struct mnt_idmap *idmap, 709 struct inode *inode, int type, 710 bool rcu, bool noperm); 711 static inline struct posix_acl *ovl_get_inode_acl(struct inode *inode, int type, 712 bool rcu) 713 { 714 return do_ovl_get_acl(&nop_mnt_idmap, inode, type, rcu, true); 715 } 716 static inline struct posix_acl *ovl_get_acl(struct mnt_idmap *idmap, 717 struct dentry *dentry, int type) 718 { 719 return do_ovl_get_acl(idmap, d_inode(dentry), type, false, false); 720 } 721 int ovl_set_acl(struct mnt_idmap *idmap, struct dentry *dentry, 722 struct posix_acl *acl, int type); 723 struct posix_acl *ovl_get_acl_path(const struct path *path, 724 const char *acl_name, bool noperm); 725 #else 726 #define ovl_get_inode_acl NULL 727 #define ovl_get_acl NULL 728 #define ovl_set_acl NULL 729 static inline struct posix_acl *ovl_get_acl_path(const struct path *path, 730 const char *acl_name, 731 bool noperm) 732 { 733 return NULL; 734 } 735 #endif 736 737 int ovl_update_time(struct inode *inode, int flags); 738 bool ovl_is_private_xattr(struct super_block *sb, const char *name); 739 740 struct ovl_inode_params { 741 struct inode *newinode; 742 struct dentry *upperdentry; 743 struct ovl_entry *oe; 744 bool index; 745 char *redirect; 746 char *lowerdata_redirect; 747 }; 748 void ovl_inode_init(struct inode *inode, struct ovl_inode_params *oip, 749 unsigned long ino, int fsid); 750 struct inode *ovl_new_inode(struct super_block *sb, umode_t mode, dev_t rdev); 751 struct inode *ovl_lookup_inode(struct super_block *sb, struct dentry *real, 752 bool is_upper); 753 bool ovl_lookup_trap_inode(struct super_block *sb, struct dentry *dir); 754 struct inode *ovl_get_trap_inode(struct super_block *sb, struct dentry *dir); 755 struct inode *ovl_get_inode(struct super_block *sb, 756 struct ovl_inode_params *oip); 757 void ovl_copyattr(struct inode *to); 758 759 /* vfs inode flags copied from real to ovl inode */ 760 #define OVL_COPY_I_FLAGS_MASK (S_SYNC | S_NOATIME | S_APPEND | S_IMMUTABLE) 761 /* vfs inode flags read from overlay.protattr xattr to ovl inode */ 762 #define OVL_PROT_I_FLAGS_MASK (S_APPEND | S_IMMUTABLE) 763 764 /* 765 * fileattr flags copied from lower to upper inode on copy up. 766 * We cannot copy up immutable/append-only flags, because that would prevent 767 * linking temp inode to upper dir, so we store them in xattr instead. 768 */ 769 #define OVL_COPY_FS_FLAGS_MASK (FS_SYNC_FL | FS_NOATIME_FL) 770 #define OVL_COPY_FSX_FLAGS_MASK (FS_XFLAG_SYNC | FS_XFLAG_NOATIME) 771 #define OVL_PROT_FS_FLAGS_MASK (FS_APPEND_FL | FS_IMMUTABLE_FL) 772 #define OVL_PROT_FSX_FLAGS_MASK (FS_XFLAG_APPEND | FS_XFLAG_IMMUTABLE) 773 774 void ovl_check_protattr(struct inode *inode, struct dentry *upper); 775 int ovl_set_protattr(struct inode *inode, struct dentry *upper, 776 struct fileattr *fa); 777 778 static inline void ovl_copyflags(struct inode *from, struct inode *to) 779 { 780 unsigned int mask = OVL_COPY_I_FLAGS_MASK; 781 782 inode_set_flags(to, from->i_flags & mask, mask); 783 } 784 785 /* dir.c */ 786 extern const struct inode_operations ovl_dir_inode_operations; 787 int ovl_cleanup_and_whiteout(struct ovl_fs *ofs, struct inode *dir, 788 struct dentry *dentry); 789 struct ovl_cattr { 790 dev_t rdev; 791 umode_t mode; 792 const char *link; 793 struct dentry *hardlink; 794 }; 795 796 #define OVL_CATTR(m) (&(struct ovl_cattr) { .mode = (m) }) 797 798 int ovl_mkdir_real(struct ovl_fs *ofs, struct inode *dir, 799 struct dentry **newdentry, umode_t mode); 800 struct dentry *ovl_create_real(struct ovl_fs *ofs, 801 struct inode *dir, struct dentry *newdentry, 802 struct ovl_cattr *attr); 803 int ovl_cleanup(struct ovl_fs *ofs, struct inode *dir, struct dentry *dentry); 804 struct dentry *ovl_lookup_temp(struct ovl_fs *ofs, struct dentry *workdir); 805 struct dentry *ovl_create_temp(struct ovl_fs *ofs, struct dentry *workdir, 806 struct ovl_cattr *attr); 807 808 /* file.c */ 809 extern const struct file_operations ovl_file_operations; 810 int __init ovl_aio_request_cache_init(void); 811 void ovl_aio_request_cache_destroy(void); 812 int ovl_real_fileattr_get(const struct path *realpath, struct fileattr *fa); 813 int ovl_real_fileattr_set(const struct path *realpath, struct fileattr *fa); 814 int ovl_fileattr_get(struct dentry *dentry, struct fileattr *fa); 815 int ovl_fileattr_set(struct mnt_idmap *idmap, 816 struct dentry *dentry, struct fileattr *fa); 817 818 /* copy_up.c */ 819 int ovl_copy_up(struct dentry *dentry); 820 int ovl_copy_up_with_data(struct dentry *dentry); 821 int ovl_maybe_copy_up(struct dentry *dentry, int flags); 822 int ovl_copy_xattr(struct super_block *sb, const struct path *path, struct dentry *new); 823 int ovl_set_attr(struct ovl_fs *ofs, struct dentry *upper, struct kstat *stat); 824 struct ovl_fh *ovl_encode_real_fh(struct ovl_fs *ofs, struct dentry *real, 825 bool is_upper); 826 int ovl_set_origin(struct ovl_fs *ofs, struct dentry *lower, 827 struct dentry *upper); 828 829 /* export.c */ 830 extern const struct export_operations ovl_export_operations; 831 extern const struct export_operations ovl_export_fid_operations; 832 833 /* super.c */ 834 int ovl_fill_super(struct super_block *sb, struct fs_context *fc); 835 836 /* Will this overlay be forced to mount/remount ro? */ 837 static inline bool ovl_force_readonly(struct ovl_fs *ofs) 838 { 839 return (!ovl_upper_mnt(ofs) || !ofs->workdir); 840 } 841