super.c 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. *
  4. * Copyright (C) 2011 Novell Inc.
  5. */
  6. #include <uapi/linux/magic.h>
  7. #include <linux/fs.h>
  8. #include <linux/namei.h>
  9. #include <linux/xattr.h>
  10. #include <linux/mount.h>
  11. #include <linux/parser.h>
  12. #include <linux/module.h>
  13. #include <linux/statfs.h>
  14. #include <linux/seq_file.h>
  15. #include <linux/posix_acl_xattr.h>
  16. #include <linux/exportfs.h>
  17. #include <linux/file.h>
  18. #include <linux/fs_context.h>
  19. #include <linux/fs_parser.h>
  20. #include "overlayfs.h"
  21. #include "params.h"
  22. MODULE_AUTHOR("Miklos Szeredi <miklos@szeredi.hu>");
  23. MODULE_DESCRIPTION("Overlay filesystem");
  24. MODULE_LICENSE("GPL");
  25. struct ovl_dir_cache;
  26. static struct dentry *ovl_d_real(struct dentry *dentry, enum d_real_type type)
  27. {
  28. struct dentry *upper, *lower;
  29. int err;
  30. switch (type) {
  31. case D_REAL_DATA:
  32. case D_REAL_METADATA:
  33. break;
  34. default:
  35. goto bug;
  36. }
  37. if (!d_is_reg(dentry)) {
  38. /* d_real_inode() is only relevant for regular files */
  39. return dentry;
  40. }
  41. upper = ovl_dentry_upper(dentry);
  42. if (upper && (type == D_REAL_METADATA ||
  43. ovl_has_upperdata(d_inode(dentry))))
  44. return upper;
  45. if (type == D_REAL_METADATA) {
  46. lower = ovl_dentry_lower(dentry);
  47. goto real_lower;
  48. }
  49. /*
  50. * Best effort lazy lookup of lowerdata for D_REAL_DATA case to return
  51. * the real lowerdata dentry. The only current caller of d_real() with
  52. * D_REAL_DATA is d_real_inode() from trace_uprobe and this caller is
  53. * likely going to be followed reading from the file, before placing
  54. * uprobes on offset within the file, so lowerdata should be available
  55. * when setting the uprobe.
  56. */
  57. err = ovl_verify_lowerdata(dentry);
  58. if (err)
  59. goto bug;
  60. lower = ovl_dentry_lowerdata(dentry);
  61. if (!lower)
  62. goto bug;
  63. real_lower:
  64. /* Handle recursion into stacked lower fs */
  65. return d_real(lower, type);
  66. bug:
  67. WARN(1, "%s(%pd4, %d): real dentry not found\n", __func__, dentry, type);
  68. return dentry;
  69. }
  70. static int ovl_revalidate_real(struct dentry *d, unsigned int flags, bool weak)
  71. {
  72. int ret = 1;
  73. if (!d)
  74. return 1;
  75. if (weak) {
  76. if (d->d_flags & DCACHE_OP_WEAK_REVALIDATE)
  77. ret = d->d_op->d_weak_revalidate(d, flags);
  78. } else if (d->d_flags & DCACHE_OP_REVALIDATE) {
  79. struct dentry *parent;
  80. struct inode *dir;
  81. struct name_snapshot n;
  82. if (flags & LOOKUP_RCU) {
  83. parent = READ_ONCE(d->d_parent);
  84. dir = d_inode_rcu(parent);
  85. if (!dir)
  86. return -ECHILD;
  87. } else {
  88. parent = dget_parent(d);
  89. dir = d_inode(parent);
  90. }
  91. take_dentry_name_snapshot(&n, d);
  92. ret = d->d_op->d_revalidate(dir, &n.name, d, flags);
  93. release_dentry_name_snapshot(&n);
  94. if (!(flags & LOOKUP_RCU))
  95. dput(parent);
  96. if (!ret) {
  97. if (!(flags & LOOKUP_RCU))
  98. d_invalidate(d);
  99. ret = -ESTALE;
  100. }
  101. }
  102. return ret;
  103. }
  104. static int ovl_dentry_revalidate_common(struct dentry *dentry,
  105. unsigned int flags, bool weak)
  106. {
  107. struct ovl_entry *oe;
  108. struct ovl_path *lowerstack;
  109. struct inode *inode = d_inode_rcu(dentry);
  110. struct dentry *upper;
  111. unsigned int i;
  112. int ret = 1;
  113. if (!inode) {
  114. /*
  115. * Lookup of negative dentries will call ovl_dentry_init_flags()
  116. * with NULL upperdentry and NULL oe, resulting in the
  117. * DCACHE_OP*_REVALIDATE flags being cleared. Hence the only
  118. * way to get a negative inode is due to a race with dentry
  119. * destruction.
  120. */
  121. WARN_ON(!(flags & LOOKUP_RCU));
  122. return -ECHILD;
  123. }
  124. oe = OVL_I_E(inode);
  125. lowerstack = ovl_lowerstack(oe);
  126. upper = ovl_i_dentry_upper(inode);
  127. if (upper)
  128. ret = ovl_revalidate_real(upper, flags, weak);
  129. for (i = 0; ret > 0 && i < ovl_numlower(oe); i++)
  130. ret = ovl_revalidate_real(lowerstack[i].dentry, flags, weak);
  131. return ret;
  132. }
  133. static int ovl_dentry_revalidate(struct inode *dir, const struct qstr *name,
  134. struct dentry *dentry, unsigned int flags)
  135. {
  136. return ovl_dentry_revalidate_common(dentry, flags, false);
  137. }
  138. static int ovl_dentry_weak_revalidate(struct dentry *dentry, unsigned int flags)
  139. {
  140. return ovl_dentry_revalidate_common(dentry, flags, true);
  141. }
  142. static const struct dentry_operations ovl_dentry_operations = {
  143. .d_real = ovl_d_real,
  144. .d_revalidate = ovl_dentry_revalidate,
  145. .d_weak_revalidate = ovl_dentry_weak_revalidate,
  146. };
  147. #if IS_ENABLED(CONFIG_UNICODE)
  148. static const struct dentry_operations ovl_dentry_ci_operations = {
  149. .d_real = ovl_d_real,
  150. .d_revalidate = ovl_dentry_revalidate,
  151. .d_weak_revalidate = ovl_dentry_weak_revalidate,
  152. .d_hash = generic_ci_d_hash,
  153. .d_compare = generic_ci_d_compare,
  154. };
  155. #endif
  156. static struct kmem_cache *ovl_inode_cachep;
  157. static struct inode *ovl_alloc_inode(struct super_block *sb)
  158. {
  159. struct ovl_inode *oi = alloc_inode_sb(sb, ovl_inode_cachep, GFP_KERNEL);
  160. if (!oi)
  161. return NULL;
  162. oi->cache = NULL;
  163. oi->redirect = NULL;
  164. oi->version = 0;
  165. oi->flags = 0;
  166. oi->__upperdentry = NULL;
  167. oi->lowerdata_redirect = NULL;
  168. oi->oe = NULL;
  169. mutex_init(&oi->lock);
  170. return &oi->vfs_inode;
  171. }
  172. static void ovl_free_inode(struct inode *inode)
  173. {
  174. struct ovl_inode *oi = OVL_I(inode);
  175. kfree(oi->redirect);
  176. kfree(oi->oe);
  177. mutex_destroy(&oi->lock);
  178. kmem_cache_free(ovl_inode_cachep, oi);
  179. }
  180. static void ovl_destroy_inode(struct inode *inode)
  181. {
  182. struct ovl_inode *oi = OVL_I(inode);
  183. dput(oi->__upperdentry);
  184. ovl_stack_put(ovl_lowerstack(oi->oe), ovl_numlower(oi->oe));
  185. if (S_ISDIR(inode->i_mode))
  186. ovl_dir_cache_free(inode);
  187. else
  188. kfree(oi->lowerdata_redirect);
  189. }
  190. static void ovl_put_super(struct super_block *sb)
  191. {
  192. struct ovl_fs *ofs = OVL_FS(sb);
  193. if (ofs)
  194. ovl_free_fs(ofs);
  195. }
  196. /* Sync real dirty inodes in upper filesystem (if it exists) */
  197. static int ovl_sync_fs(struct super_block *sb, int wait)
  198. {
  199. struct ovl_fs *ofs = OVL_FS(sb);
  200. struct super_block *upper_sb;
  201. int ret;
  202. ret = ovl_sync_status(ofs);
  203. if (ret < 0)
  204. return -EIO;
  205. if (!ret)
  206. return ret;
  207. /*
  208. * Not called for sync(2) call or an emergency sync (SB_I_SKIP_SYNC).
  209. * All the super blocks will be iterated, including upper_sb.
  210. *
  211. * If this is a syncfs(2) call, then we do need to call
  212. * sync_filesystem() on upper_sb, but enough if we do it when being
  213. * called with wait == 1.
  214. */
  215. if (!wait)
  216. return 0;
  217. upper_sb = ovl_upper_mnt(ofs)->mnt_sb;
  218. down_read(&upper_sb->s_umount);
  219. ret = sync_filesystem(upper_sb);
  220. up_read(&upper_sb->s_umount);
  221. return ret;
  222. }
  223. /**
  224. * ovl_statfs
  225. * @dentry: The dentry to query
  226. * @buf: The struct kstatfs to fill in with stats
  227. *
  228. * Get the filesystem statistics. As writes always target the upper layer
  229. * filesystem pass the statfs to the upper filesystem (if it exists)
  230. */
  231. static int ovl_statfs(struct dentry *dentry, struct kstatfs *buf)
  232. {
  233. struct super_block *sb = dentry->d_sb;
  234. struct ovl_fs *ofs = OVL_FS(sb);
  235. struct dentry *root_dentry = sb->s_root;
  236. struct path path;
  237. int err;
  238. ovl_path_real(root_dentry, &path);
  239. err = vfs_statfs(&path, buf);
  240. if (!err) {
  241. buf->f_namelen = ofs->namelen;
  242. buf->f_type = OVERLAYFS_SUPER_MAGIC;
  243. if (ovl_has_fsid(ofs))
  244. buf->f_fsid = uuid_to_fsid(sb->s_uuid.b);
  245. }
  246. return err;
  247. }
  248. static const struct super_operations ovl_super_operations = {
  249. .alloc_inode = ovl_alloc_inode,
  250. .free_inode = ovl_free_inode,
  251. .destroy_inode = ovl_destroy_inode,
  252. .drop_inode = inode_just_drop,
  253. .put_super = ovl_put_super,
  254. .sync_fs = ovl_sync_fs,
  255. .statfs = ovl_statfs,
  256. .show_options = ovl_show_options,
  257. };
  258. #define OVL_WORKDIR_NAME "work"
  259. #define OVL_INDEXDIR_NAME "index"
  260. static struct dentry *ovl_workdir_create(struct ovl_fs *ofs,
  261. const char *name, bool persist)
  262. {
  263. struct inode *dir = ofs->workbasedir->d_inode;
  264. struct vfsmount *mnt = ovl_upper_mnt(ofs);
  265. struct dentry *work;
  266. int err;
  267. bool retried = false;
  268. retry:
  269. work = ovl_start_creating_upper(ofs, ofs->workbasedir, &QSTR(name));
  270. if (!IS_ERR(work)) {
  271. struct iattr attr = {
  272. .ia_valid = ATTR_MODE,
  273. .ia_mode = S_IFDIR | 0,
  274. };
  275. if (work->d_inode) {
  276. end_creating_keep(work);
  277. if (persist)
  278. return work;
  279. err = -EEXIST;
  280. if (retried)
  281. goto out_dput;
  282. retried = true;
  283. err = ovl_workdir_cleanup(ofs, ofs->workbasedir, mnt, work, 0);
  284. dput(work);
  285. if (err == -EINVAL)
  286. return ERR_PTR(err);
  287. goto retry;
  288. }
  289. work = ovl_do_mkdir(ofs, dir, work, attr.ia_mode);
  290. end_creating_keep(work);
  291. err = PTR_ERR(work);
  292. if (IS_ERR(work))
  293. goto out_err;
  294. /* Weird filesystem returning with hashed negative (kernfs)? */
  295. err = -EINVAL;
  296. if (d_really_is_negative(work))
  297. goto out_dput;
  298. /*
  299. * Try to remove POSIX ACL xattrs from workdir. We are good if:
  300. *
  301. * a) success (there was a POSIX ACL xattr and was removed)
  302. * b) -ENODATA (there was no POSIX ACL xattr)
  303. * c) -EOPNOTSUPP (POSIX ACL xattrs are not supported)
  304. *
  305. * There are various other error values that could effectively
  306. * mean that the xattr doesn't exist (e.g. -ERANGE is returned
  307. * if the xattr name is too long), but the set of filesystems
  308. * allowed as upper are limited to "normal" ones, where checking
  309. * for the above two errors is sufficient.
  310. */
  311. err = ovl_do_remove_acl(ofs, work, XATTR_NAME_POSIX_ACL_DEFAULT);
  312. if (err && err != -ENODATA && err != -EOPNOTSUPP)
  313. goto out_dput;
  314. err = ovl_do_remove_acl(ofs, work, XATTR_NAME_POSIX_ACL_ACCESS);
  315. if (err && err != -ENODATA && err != -EOPNOTSUPP)
  316. goto out_dput;
  317. /* Clear any inherited mode bits */
  318. inode_lock(work->d_inode);
  319. err = ovl_do_notify_change(ofs, work, &attr);
  320. inode_unlock(work->d_inode);
  321. if (err)
  322. goto out_dput;
  323. } else {
  324. err = PTR_ERR(work);
  325. goto out_err;
  326. }
  327. return work;
  328. out_dput:
  329. dput(work);
  330. out_err:
  331. pr_warn("failed to create directory %s/%s (errno: %i); mounting read-only\n",
  332. ofs->config.workdir, name, -err);
  333. return NULL;
  334. }
  335. static int ovl_check_namelen(const struct path *path, struct ovl_fs *ofs,
  336. const char *name)
  337. {
  338. struct kstatfs statfs;
  339. int err = vfs_statfs(path, &statfs);
  340. if (err)
  341. pr_err("statfs failed on '%s'\n", name);
  342. else
  343. ofs->namelen = max(ofs->namelen, statfs.f_namelen);
  344. return err;
  345. }
  346. static int ovl_lower_dir(const char *name, const struct path *path,
  347. struct ovl_fs *ofs, int *stack_depth)
  348. {
  349. int fh_type;
  350. int err;
  351. err = ovl_check_namelen(path, ofs, name);
  352. if (err)
  353. return err;
  354. *stack_depth = max(*stack_depth, path->mnt->mnt_sb->s_stack_depth);
  355. /*
  356. * The inodes index feature and NFS export need to encode and decode
  357. * file handles, so they require that all layers support them.
  358. */
  359. fh_type = ovl_can_decode_fh(path->dentry->d_sb);
  360. if ((ofs->config.nfs_export ||
  361. (ofs->config.index && ofs->config.upperdir)) && !fh_type) {
  362. ofs->config.index = false;
  363. ofs->config.nfs_export = false;
  364. pr_warn("fs on '%s' does not support file handles, falling back to index=off,nfs_export=off.\n",
  365. name);
  366. }
  367. ofs->nofh |= !fh_type;
  368. /*
  369. * Decoding origin file handle is required for persistent st_ino.
  370. * Without persistent st_ino, xino=auto falls back to xino=off.
  371. */
  372. if (ofs->config.xino == OVL_XINO_AUTO &&
  373. ofs->config.upperdir && !fh_type) {
  374. ofs->config.xino = OVL_XINO_OFF;
  375. pr_warn("fs on '%s' does not support file handles, falling back to xino=off.\n",
  376. name);
  377. }
  378. /* Check if lower fs has 32bit inode numbers */
  379. if (fh_type != FILEID_INO32_GEN)
  380. ofs->xino_mode = -1;
  381. return 0;
  382. }
  383. /* Workdir should not be subdir of upperdir and vice versa */
  384. static bool ovl_workdir_ok(struct dentry *workdir, struct dentry *upperdir)
  385. {
  386. bool ok = false;
  387. if (workdir != upperdir) {
  388. struct dentry *trap = lock_rename(workdir, upperdir);
  389. if (!IS_ERR(trap))
  390. unlock_rename(workdir, upperdir);
  391. ok = (trap == NULL);
  392. }
  393. return ok;
  394. }
  395. static int ovl_setup_trap(struct super_block *sb, struct dentry *dir,
  396. struct inode **ptrap, const char *name)
  397. {
  398. struct inode *trap;
  399. int err;
  400. trap = ovl_get_trap_inode(sb, dir);
  401. err = PTR_ERR_OR_ZERO(trap);
  402. if (err) {
  403. if (err == -ELOOP)
  404. pr_err("conflicting %s path\n", name);
  405. return err;
  406. }
  407. *ptrap = trap;
  408. return 0;
  409. }
  410. /*
  411. * Determine how we treat concurrent use of upperdir/workdir based on the
  412. * index feature. This is papering over mount leaks of container runtimes,
  413. * for example, an old overlay mount is leaked and now its upperdir is
  414. * attempted to be used as a lower layer in a new overlay mount.
  415. */
  416. static int ovl_report_in_use(struct ovl_fs *ofs, const char *name)
  417. {
  418. if (ofs->config.index) {
  419. pr_err("%s is in-use as upperdir/workdir of another mount, mount with '-o index=off' to override exclusive upperdir protection.\n",
  420. name);
  421. return -EBUSY;
  422. } else {
  423. pr_warn("%s is in-use as upperdir/workdir of another mount, accessing files from both mounts will result in undefined behavior.\n",
  424. name);
  425. return 0;
  426. }
  427. }
  428. static int ovl_get_upper(struct super_block *sb, struct ovl_fs *ofs,
  429. struct ovl_layer *upper_layer,
  430. const struct path *upperpath)
  431. {
  432. struct vfsmount *upper_mnt;
  433. int err;
  434. /* Upperdir path should not be r/o */
  435. if (__mnt_is_readonly(upperpath->mnt)) {
  436. pr_err("upper fs is r/o, try multi-lower layers mount\n");
  437. err = -EINVAL;
  438. goto out;
  439. }
  440. err = ovl_check_namelen(upperpath, ofs, ofs->config.upperdir);
  441. if (err)
  442. goto out;
  443. err = ovl_setup_trap(sb, upperpath->dentry, &upper_layer->trap,
  444. "upperdir");
  445. if (err)
  446. goto out;
  447. upper_mnt = clone_private_mount(upperpath);
  448. err = PTR_ERR(upper_mnt);
  449. if (IS_ERR(upper_mnt)) {
  450. pr_err("failed to clone upperpath\n");
  451. goto out;
  452. }
  453. /* Don't inherit atime flags */
  454. upper_mnt->mnt_flags &= ~(MNT_NOATIME | MNT_NODIRATIME | MNT_RELATIME);
  455. upper_layer->mnt = upper_mnt;
  456. upper_layer->idx = 0;
  457. upper_layer->fsid = 0;
  458. /*
  459. * Inherit SB_NOSEC flag from upperdir.
  460. *
  461. * This optimization changes behavior when a security related attribute
  462. * (suid/sgid/security.*) is changed on an underlying layer. This is
  463. * okay because we don't yet have guarantees in that case, but it will
  464. * need careful treatment once we want to honour changes to underlying
  465. * filesystems.
  466. */
  467. if (upper_mnt->mnt_sb->s_flags & SB_NOSEC)
  468. sb->s_flags |= SB_NOSEC;
  469. if (ovl_inuse_trylock(ovl_upper_mnt(ofs)->mnt_root)) {
  470. ofs->upperdir_locked = true;
  471. } else {
  472. err = ovl_report_in_use(ofs, "upperdir");
  473. if (err)
  474. goto out;
  475. }
  476. err = 0;
  477. out:
  478. return err;
  479. }
  480. /*
  481. * Returns 1 if RENAME_WHITEOUT is supported, 0 if not supported and
  482. * negative values if error is encountered.
  483. */
  484. static int ovl_check_rename_whiteout(struct ovl_fs *ofs)
  485. {
  486. struct dentry *workdir = ofs->workdir;
  487. struct dentry *temp;
  488. struct dentry *whiteout;
  489. struct name_snapshot name;
  490. struct renamedata rd = {};
  491. char name2[OVL_TEMPNAME_SIZE];
  492. int err;
  493. temp = ovl_create_temp(ofs, workdir, OVL_CATTR(S_IFREG | 0));
  494. err = PTR_ERR(temp);
  495. if (IS_ERR(temp))
  496. return err;
  497. rd.mnt_idmap = ovl_upper_mnt_idmap(ofs);
  498. rd.old_parent = workdir;
  499. rd.new_parent = workdir;
  500. rd.flags = RENAME_WHITEOUT;
  501. ovl_tempname(name2);
  502. err = start_renaming_dentry(&rd, 0, temp, &QSTR(name2));
  503. if (err) {
  504. dput(temp);
  505. return err;
  506. }
  507. /* Name is inline and stable - using snapshot as a copy helper */
  508. take_dentry_name_snapshot(&name, temp);
  509. err = ovl_do_rename_rd(&rd);
  510. end_renaming(&rd);
  511. if (err) {
  512. if (err == -EINVAL)
  513. err = 0;
  514. goto cleanup_temp;
  515. }
  516. whiteout = ovl_lookup_upper_unlocked(ofs, name.name.name,
  517. workdir, name.name.len);
  518. err = PTR_ERR(whiteout);
  519. if (IS_ERR(whiteout))
  520. goto cleanup_temp;
  521. err = ovl_upper_is_whiteout(ofs, whiteout);
  522. /* Best effort cleanup of whiteout and temp file */
  523. if (err)
  524. ovl_cleanup(ofs, workdir, whiteout);
  525. dput(whiteout);
  526. cleanup_temp:
  527. ovl_cleanup(ofs, workdir, temp);
  528. release_dentry_name_snapshot(&name);
  529. dput(temp);
  530. return err;
  531. }
  532. static struct dentry *ovl_lookup_or_create(struct ovl_fs *ofs,
  533. struct dentry *parent,
  534. const char *name, umode_t mode)
  535. {
  536. struct dentry *child;
  537. child = ovl_start_creating_upper(ofs, parent, &QSTR(name));
  538. if (!IS_ERR(child)) {
  539. if (!child->d_inode)
  540. child = ovl_create_real(ofs, parent, child,
  541. OVL_CATTR(mode));
  542. end_creating_keep(child);
  543. }
  544. dput(parent);
  545. return child;
  546. }
  547. /*
  548. * Creates $workdir/work/incompat/volatile/dirty file if it is not already
  549. * present.
  550. */
  551. static int ovl_create_volatile_dirty(struct ovl_fs *ofs)
  552. {
  553. unsigned int ctr;
  554. struct dentry *d = dget(ofs->workbasedir);
  555. static const char *const volatile_path[] = {
  556. OVL_WORKDIR_NAME, "incompat", "volatile", "dirty"
  557. };
  558. const char *const *name = volatile_path;
  559. for (ctr = ARRAY_SIZE(volatile_path); ctr; ctr--, name++) {
  560. d = ovl_lookup_or_create(ofs, d, *name, ctr > 1 ? S_IFDIR : S_IFREG);
  561. if (IS_ERR(d))
  562. return PTR_ERR(d);
  563. }
  564. dput(d);
  565. return 0;
  566. }
  567. static int ovl_make_workdir(struct super_block *sb, struct ovl_fs *ofs,
  568. const struct path *workpath)
  569. {
  570. struct vfsmount *mnt = ovl_upper_mnt(ofs);
  571. struct dentry *workdir;
  572. struct file *tmpfile;
  573. bool rename_whiteout;
  574. bool d_type;
  575. int fh_type;
  576. int err;
  577. err = mnt_want_write(mnt);
  578. if (err)
  579. return err;
  580. workdir = ovl_workdir_create(ofs, OVL_WORKDIR_NAME, false);
  581. err = PTR_ERR(workdir);
  582. if (IS_ERR_OR_NULL(workdir))
  583. goto out;
  584. ofs->workdir = workdir;
  585. err = ovl_setup_trap(sb, ofs->workdir, &ofs->workdir_trap, "workdir");
  586. if (err)
  587. goto out;
  588. /*
  589. * Upper should support d_type, else whiteouts are visible. Given
  590. * workdir and upper are on same fs, we can do iterate_dir() on
  591. * workdir. This check requires successful creation of workdir in
  592. * previous step.
  593. */
  594. err = ovl_check_d_type_supported(workpath);
  595. if (err < 0)
  596. goto out;
  597. d_type = err;
  598. if (!d_type)
  599. pr_warn("upper fs needs to support d_type.\n");
  600. /* Check if upper/work fs supports O_TMPFILE */
  601. tmpfile = ovl_do_tmpfile(ofs, ofs->workdir, S_IFREG | 0);
  602. ofs->tmpfile = !IS_ERR(tmpfile);
  603. if (ofs->tmpfile)
  604. fput(tmpfile);
  605. else
  606. pr_warn("upper fs does not support tmpfile.\n");
  607. /* Check if upper/work fs supports RENAME_WHITEOUT */
  608. err = ovl_check_rename_whiteout(ofs);
  609. if (err < 0)
  610. goto out;
  611. rename_whiteout = err;
  612. if (!rename_whiteout)
  613. pr_warn("upper fs does not support RENAME_WHITEOUT.\n");
  614. /*
  615. * Check if upper/work fs supports (trusted|user).overlay.* xattr
  616. */
  617. err = ovl_setxattr(ofs, ofs->workdir, OVL_XATTR_OPAQUE, "0", 1);
  618. if (err) {
  619. pr_warn("failed to set xattr on upper\n");
  620. ofs->noxattr = true;
  621. if (ovl_redirect_follow(ofs)) {
  622. ofs->config.redirect_mode = OVL_REDIRECT_NOFOLLOW;
  623. pr_warn("...falling back to redirect_dir=nofollow.\n");
  624. }
  625. if (ofs->config.metacopy) {
  626. ofs->config.metacopy = false;
  627. pr_warn("...falling back to metacopy=off.\n");
  628. }
  629. if (ofs->config.index) {
  630. ofs->config.index = false;
  631. pr_warn("...falling back to index=off.\n");
  632. }
  633. if (ovl_has_fsid(ofs)) {
  634. ofs->config.uuid = OVL_UUID_NULL;
  635. pr_warn("...falling back to uuid=null.\n");
  636. }
  637. /*
  638. * xattr support is required for persistent st_ino.
  639. * Without persistent st_ino, xino=auto falls back to xino=off.
  640. */
  641. if (ofs->config.xino == OVL_XINO_AUTO) {
  642. ofs->config.xino = OVL_XINO_OFF;
  643. pr_warn("...falling back to xino=off.\n");
  644. }
  645. if (err == -EPERM && !ofs->config.userxattr)
  646. pr_info("try mounting with 'userxattr' option\n");
  647. err = 0;
  648. } else {
  649. ovl_removexattr(ofs, ofs->workdir, OVL_XATTR_OPAQUE);
  650. }
  651. /*
  652. * We allowed sub-optimal upper fs configuration and don't want to break
  653. * users over kernel upgrade, but we never allowed remote upper fs, so
  654. * we can enforce strict requirements for remote upper fs.
  655. */
  656. if (ovl_dentry_remote(ofs->workdir) &&
  657. (!d_type || !rename_whiteout || ofs->noxattr)) {
  658. pr_err("upper fs missing required features.\n");
  659. err = -EINVAL;
  660. goto out;
  661. }
  662. /*
  663. * For volatile mount, create a incompat/volatile/dirty file to keep
  664. * track of it.
  665. */
  666. if (ovl_is_volatile(&ofs->config)) {
  667. err = ovl_create_volatile_dirty(ofs);
  668. if (err < 0) {
  669. pr_err("Failed to create volatile/dirty file.\n");
  670. goto out;
  671. }
  672. }
  673. /* Check if upper/work fs supports file handles */
  674. fh_type = ovl_can_decode_fh(ofs->workdir->d_sb);
  675. if (ofs->config.index && !fh_type) {
  676. ofs->config.index = false;
  677. pr_warn("upper fs does not support file handles, falling back to index=off.\n");
  678. }
  679. ofs->nofh |= !fh_type;
  680. /* Check if upper fs has 32bit inode numbers */
  681. if (fh_type != FILEID_INO32_GEN)
  682. ofs->xino_mode = -1;
  683. /* NFS export of r/w mount depends on index */
  684. if (ofs->config.nfs_export && !ofs->config.index) {
  685. pr_warn("NFS export requires \"index=on\", falling back to nfs_export=off.\n");
  686. ofs->config.nfs_export = false;
  687. }
  688. out:
  689. mnt_drop_write(mnt);
  690. return err;
  691. }
  692. static int ovl_get_workdir(struct super_block *sb, struct ovl_fs *ofs,
  693. const struct path *upperpath,
  694. const struct path *workpath)
  695. {
  696. int err;
  697. err = -EINVAL;
  698. if (upperpath->mnt != workpath->mnt) {
  699. pr_err("workdir and upperdir must reside under the same mount\n");
  700. return err;
  701. }
  702. if (!ovl_workdir_ok(workpath->dentry, upperpath->dentry)) {
  703. pr_err("workdir and upperdir must be separate subtrees\n");
  704. return err;
  705. }
  706. ofs->workbasedir = dget(workpath->dentry);
  707. if (ovl_inuse_trylock(ofs->workbasedir)) {
  708. ofs->workdir_locked = true;
  709. } else {
  710. err = ovl_report_in_use(ofs, "workdir");
  711. if (err)
  712. return err;
  713. }
  714. err = ovl_setup_trap(sb, ofs->workbasedir, &ofs->workbasedir_trap,
  715. "workdir");
  716. if (err)
  717. return err;
  718. return ovl_make_workdir(sb, ofs, workpath);
  719. }
  720. static int ovl_get_indexdir(struct super_block *sb, struct ovl_fs *ofs,
  721. struct ovl_entry *oe, const struct path *upperpath)
  722. {
  723. struct vfsmount *mnt = ovl_upper_mnt(ofs);
  724. struct dentry *indexdir;
  725. struct dentry *origin = ovl_lowerstack(oe)->dentry;
  726. const struct ovl_fh *fh;
  727. int err;
  728. fh = ovl_get_origin_fh(ofs, origin);
  729. if (IS_ERR(fh))
  730. return PTR_ERR(fh);
  731. err = mnt_want_write(mnt);
  732. if (err)
  733. goto out_free_fh;
  734. /* Verify lower root is upper root origin */
  735. err = ovl_verify_origin_fh(ofs, upperpath->dentry, fh, true);
  736. if (err) {
  737. pr_err("failed to verify upper root origin\n");
  738. goto out;
  739. }
  740. /* index dir will act also as workdir */
  741. iput(ofs->workdir_trap);
  742. ofs->workdir_trap = NULL;
  743. dput(ofs->workdir);
  744. ofs->workdir = NULL;
  745. indexdir = ovl_workdir_create(ofs, OVL_INDEXDIR_NAME, true);
  746. if (IS_ERR(indexdir)) {
  747. err = PTR_ERR(indexdir);
  748. } else if (indexdir) {
  749. ofs->workdir = indexdir;
  750. err = ovl_setup_trap(sb, indexdir, &ofs->workdir_trap,
  751. "indexdir");
  752. if (err)
  753. goto out;
  754. /*
  755. * Verify upper root is exclusively associated with index dir.
  756. * Older kernels stored upper fh in ".overlay.origin"
  757. * xattr. If that xattr exists, verify that it is a match to
  758. * upper dir file handle. In any case, verify or set xattr
  759. * ".overlay.upper" to indicate that index may have
  760. * directory entries.
  761. */
  762. if (ovl_check_origin_xattr(ofs, indexdir)) {
  763. err = ovl_verify_origin_xattr(ofs, indexdir,
  764. OVL_XATTR_ORIGIN,
  765. upperpath->dentry, true,
  766. false);
  767. if (err)
  768. pr_err("failed to verify index dir 'origin' xattr\n");
  769. }
  770. err = ovl_verify_upper(ofs, indexdir, upperpath->dentry, true);
  771. if (err)
  772. pr_err("failed to verify index dir 'upper' xattr\n");
  773. /* Cleanup bad/stale/orphan index entries */
  774. if (!err)
  775. err = ovl_indexdir_cleanup(ofs);
  776. }
  777. if (err || !indexdir)
  778. pr_warn("try deleting index dir or mounting with '-o index=off' to disable inodes index.\n");
  779. out:
  780. mnt_drop_write(mnt);
  781. out_free_fh:
  782. kfree(fh);
  783. return err;
  784. }
  785. static bool ovl_lower_uuid_ok(struct ovl_fs *ofs, const uuid_t *uuid)
  786. {
  787. unsigned int i;
  788. if (!ofs->config.nfs_export && !ovl_upper_mnt(ofs))
  789. return true;
  790. /*
  791. * We allow using single lower with null uuid for index and nfs_export
  792. * for example to support those features with single lower squashfs.
  793. * To avoid regressions in setups of overlay with re-formatted lower
  794. * squashfs, do not allow decoding origin with lower null uuid unless
  795. * user opted-in to one of the new features that require following the
  796. * lower inode of non-dir upper.
  797. */
  798. if (ovl_allow_offline_changes(ofs) && uuid_is_null(uuid))
  799. return false;
  800. for (i = 0; i < ofs->numfs; i++) {
  801. /*
  802. * We use uuid to associate an overlay lower file handle with a
  803. * lower layer, so we can accept lower fs with null uuid as long
  804. * as all lower layers with null uuid are on the same fs.
  805. * if we detect multiple lower fs with the same uuid, we
  806. * disable lower file handle decoding on all of them.
  807. */
  808. if (ofs->fs[i].is_lower &&
  809. ovl_uuid_match(ofs, ofs->fs[i].sb, uuid)) {
  810. ofs->fs[i].bad_uuid = true;
  811. return false;
  812. }
  813. }
  814. return true;
  815. }
  816. /* Get a unique fsid for the layer */
  817. static int ovl_get_fsid(struct ovl_fs *ofs, const struct path *path)
  818. {
  819. struct super_block *sb = path->mnt->mnt_sb;
  820. const uuid_t *uuid = ovl_origin_uuid(ofs) ? &sb->s_uuid : &uuid_null;
  821. unsigned int i;
  822. dev_t dev;
  823. int err;
  824. bool bad_uuid = false;
  825. bool warn = false;
  826. for (i = 0; i < ofs->numfs; i++) {
  827. if (ofs->fs[i].sb == sb)
  828. return i;
  829. }
  830. if (!ovl_lower_uuid_ok(ofs, uuid)) {
  831. bad_uuid = true;
  832. if (ofs->config.xino == OVL_XINO_AUTO) {
  833. ofs->config.xino = OVL_XINO_OFF;
  834. warn = true;
  835. }
  836. if (ofs->config.index || ofs->config.nfs_export) {
  837. ofs->config.index = false;
  838. ofs->config.nfs_export = false;
  839. warn = true;
  840. }
  841. if (warn) {
  842. pr_warn("%s uuid in non-single lower fs '%pd2', falling back to xino=%s,index=off,nfs_export=off.\n",
  843. uuid_is_null(uuid) ? "null" : "conflicting",
  844. path->dentry, ovl_xino_mode(&ofs->config));
  845. }
  846. }
  847. err = get_anon_bdev(&dev);
  848. if (err) {
  849. pr_err("failed to get anonymous bdev for lowerpath\n");
  850. return err;
  851. }
  852. ofs->fs[ofs->numfs].sb = sb;
  853. ofs->fs[ofs->numfs].pseudo_dev = dev;
  854. ofs->fs[ofs->numfs].bad_uuid = bad_uuid;
  855. return ofs->numfs++;
  856. }
  857. /*
  858. * The fsid after the last lower fsid is used for the data layers.
  859. * It is a "null fs" with a null sb, null uuid, and no pseudo dev.
  860. */
  861. static int ovl_get_data_fsid(struct ovl_fs *ofs)
  862. {
  863. return ofs->numfs;
  864. }
  865. /*
  866. * Set the ovl sb encoding as the same one used by the first layer
  867. */
  868. static int ovl_set_encoding(struct super_block *sb, struct super_block *fs_sb)
  869. {
  870. if (!sb_has_encoding(fs_sb))
  871. return 0;
  872. #if IS_ENABLED(CONFIG_UNICODE)
  873. if (sb_has_strict_encoding(fs_sb)) {
  874. pr_err("strict encoding not supported\n");
  875. return -EINVAL;
  876. }
  877. sb->s_encoding = fs_sb->s_encoding;
  878. sb->s_encoding_flags = fs_sb->s_encoding_flags;
  879. #endif
  880. return 0;
  881. }
  882. static int ovl_get_layers(struct super_block *sb, struct ovl_fs *ofs,
  883. struct ovl_fs_context *ctx, struct ovl_layer *layers)
  884. {
  885. int err;
  886. unsigned int i;
  887. size_t nr_merged_lower;
  888. ofs->fs = kzalloc_objs(struct ovl_sb, ctx->nr + 2);
  889. if (ofs->fs == NULL)
  890. return -ENOMEM;
  891. /*
  892. * idx/fsid 0 are reserved for upper fs even with lower only overlay
  893. * and the last fsid is reserved for "null fs" of the data layers.
  894. */
  895. ofs->numfs++;
  896. /*
  897. * All lower layers that share the same fs as upper layer, use the same
  898. * pseudo_dev as upper layer. Allocate fs[0].pseudo_dev even for lower
  899. * only overlay to simplify ovl_fs_free().
  900. * is_lower will be set if upper fs is shared with a lower layer.
  901. */
  902. err = get_anon_bdev(&ofs->fs[0].pseudo_dev);
  903. if (err) {
  904. pr_err("failed to get anonymous bdev for upper fs\n");
  905. return err;
  906. }
  907. if (ovl_upper_mnt(ofs)) {
  908. ofs->fs[0].sb = ovl_upper_mnt(ofs)->mnt_sb;
  909. ofs->fs[0].is_lower = false;
  910. if (ofs->casefold) {
  911. err = ovl_set_encoding(sb, ofs->fs[0].sb);
  912. if (err)
  913. return err;
  914. }
  915. }
  916. nr_merged_lower = ctx->nr - ctx->nr_data;
  917. for (i = 0; i < ctx->nr; i++) {
  918. struct ovl_fs_context_layer *l = &ctx->lower[i];
  919. struct vfsmount *mnt;
  920. struct inode *trap;
  921. int fsid;
  922. if (i < nr_merged_lower)
  923. fsid = ovl_get_fsid(ofs, &l->path);
  924. else
  925. fsid = ovl_get_data_fsid(ofs);
  926. if (fsid < 0)
  927. return fsid;
  928. /*
  929. * Check if lower root conflicts with this overlay layers before
  930. * checking if it is in-use as upperdir/workdir of "another"
  931. * mount, because we do not bother to check in ovl_is_inuse() if
  932. * the upperdir/workdir is in fact in-use by our
  933. * upperdir/workdir.
  934. */
  935. err = ovl_setup_trap(sb, l->path.dentry, &trap, "lowerdir");
  936. if (err)
  937. return err;
  938. if (ovl_is_inuse(l->path.dentry)) {
  939. err = ovl_report_in_use(ofs, "lowerdir");
  940. if (err) {
  941. iput(trap);
  942. return err;
  943. }
  944. }
  945. mnt = clone_private_mount(&l->path);
  946. err = PTR_ERR(mnt);
  947. if (IS_ERR(mnt)) {
  948. pr_err("failed to clone lowerpath\n");
  949. iput(trap);
  950. return err;
  951. }
  952. /*
  953. * Make lower layers R/O. That way fchmod/fchown on lower file
  954. * will fail instead of modifying lower fs.
  955. */
  956. mnt->mnt_flags |= MNT_READONLY | MNT_NOATIME;
  957. layers[ofs->numlayer].trap = trap;
  958. layers[ofs->numlayer].mnt = mnt;
  959. layers[ofs->numlayer].idx = ofs->numlayer;
  960. layers[ofs->numlayer].fsid = fsid;
  961. layers[ofs->numlayer].fs = &ofs->fs[fsid];
  962. /* Store for printing lowerdir=... in ovl_show_options() */
  963. ofs->config.lowerdirs[ofs->numlayer] = l->name;
  964. l->name = NULL;
  965. ofs->numlayer++;
  966. ofs->fs[fsid].is_lower = true;
  967. if (ofs->casefold) {
  968. if (!ovl_upper_mnt(ofs) && !sb_has_encoding(sb)) {
  969. err = ovl_set_encoding(sb, ofs->fs[fsid].sb);
  970. if (err)
  971. return err;
  972. }
  973. if (!sb_same_encoding(sb, mnt->mnt_sb)) {
  974. pr_err("all layers must have the same encoding\n");
  975. return -EINVAL;
  976. }
  977. }
  978. }
  979. /*
  980. * When all layers on same fs, overlay can use real inode numbers.
  981. * With mount option "xino=<on|auto>", mounter declares that there are
  982. * enough free high bits in underlying fs to hold the unique fsid.
  983. * If overlayfs does encounter underlying inodes using the high xino
  984. * bits reserved for fsid, it emits a warning and uses the original
  985. * inode number or a non persistent inode number allocated from a
  986. * dedicated range.
  987. */
  988. if (ofs->numfs - !ovl_upper_mnt(ofs) == 1) {
  989. if (ofs->config.xino == OVL_XINO_ON)
  990. pr_info("\"xino=on\" is useless with all layers on same fs, ignore.\n");
  991. ofs->xino_mode = 0;
  992. } else if (ofs->config.xino == OVL_XINO_OFF) {
  993. ofs->xino_mode = -1;
  994. } else if (ofs->xino_mode < 0) {
  995. /*
  996. * This is a roundup of number of bits needed for encoding
  997. * fsid, where fsid 0 is reserved for upper fs (even with
  998. * lower only overlay) +1 extra bit is reserved for the non
  999. * persistent inode number range that is used for resolving
  1000. * xino lower bits overflow.
  1001. */
  1002. BUILD_BUG_ON(ilog2(OVL_MAX_STACK) > 30);
  1003. ofs->xino_mode = ilog2(ofs->numfs - 1) + 2;
  1004. }
  1005. if (ofs->xino_mode > 0) {
  1006. pr_info("\"xino\" feature enabled using %d upper inode bits.\n",
  1007. ofs->xino_mode);
  1008. }
  1009. return 0;
  1010. }
  1011. static struct ovl_entry *ovl_get_lowerstack(struct super_block *sb,
  1012. struct ovl_fs_context *ctx,
  1013. struct ovl_fs *ofs,
  1014. struct ovl_layer *layers)
  1015. {
  1016. int err;
  1017. unsigned int i;
  1018. size_t nr_merged_lower;
  1019. struct ovl_entry *oe;
  1020. struct ovl_path *lowerstack;
  1021. struct ovl_fs_context_layer *l;
  1022. if (!ofs->config.upperdir && ctx->nr == 1) {
  1023. pr_err("at least 2 lowerdir are needed while upperdir nonexistent\n");
  1024. return ERR_PTR(-EINVAL);
  1025. }
  1026. if (ctx->nr == ctx->nr_data) {
  1027. pr_err("at least one non-data lowerdir is required\n");
  1028. return ERR_PTR(-EINVAL);
  1029. }
  1030. err = -EINVAL;
  1031. for (i = 0; i < ctx->nr; i++) {
  1032. l = &ctx->lower[i];
  1033. err = ovl_lower_dir(l->name, &l->path, ofs, &sb->s_stack_depth);
  1034. if (err)
  1035. return ERR_PTR(err);
  1036. }
  1037. err = -EINVAL;
  1038. sb->s_stack_depth++;
  1039. if (sb->s_stack_depth > FILESYSTEM_MAX_STACK_DEPTH) {
  1040. pr_err("maximum fs stacking depth exceeded\n");
  1041. return ERR_PTR(err);
  1042. }
  1043. err = ovl_get_layers(sb, ofs, ctx, layers);
  1044. if (err)
  1045. return ERR_PTR(err);
  1046. err = -ENOMEM;
  1047. /* Data-only layers are not merged in root directory */
  1048. nr_merged_lower = ctx->nr - ctx->nr_data;
  1049. oe = ovl_alloc_entry(nr_merged_lower);
  1050. if (!oe)
  1051. return ERR_PTR(err);
  1052. lowerstack = ovl_lowerstack(oe);
  1053. for (i = 0; i < nr_merged_lower; i++) {
  1054. l = &ctx->lower[i];
  1055. lowerstack[i].dentry = dget(l->path.dentry);
  1056. lowerstack[i].layer = &ofs->layers[i + 1];
  1057. }
  1058. ofs->numdatalayer = ctx->nr_data;
  1059. return oe;
  1060. }
  1061. /*
  1062. * Check if this layer root is a descendant of:
  1063. * - another layer of this overlayfs instance
  1064. * - upper/work dir of any overlayfs instance
  1065. */
  1066. static int ovl_check_layer(struct super_block *sb, struct ovl_fs *ofs,
  1067. struct dentry *dentry, const char *name,
  1068. bool is_lower)
  1069. {
  1070. struct dentry *next = dentry, *parent;
  1071. int err = 0;
  1072. if (!dentry)
  1073. return 0;
  1074. parent = dget_parent(next);
  1075. /* Walk back ancestors to root (inclusive) looking for traps */
  1076. while (!err && parent != next) {
  1077. if (is_lower && ovl_lookup_trap_inode(sb, parent)) {
  1078. err = -ELOOP;
  1079. pr_err("overlapping %s path\n", name);
  1080. } else if (ovl_is_inuse(parent)) {
  1081. err = ovl_report_in_use(ofs, name);
  1082. }
  1083. next = parent;
  1084. parent = dget_parent(next);
  1085. dput(next);
  1086. }
  1087. dput(parent);
  1088. return err;
  1089. }
  1090. /*
  1091. * Check if any of the layers or work dirs overlap.
  1092. */
  1093. static int ovl_check_overlapping_layers(struct super_block *sb,
  1094. struct ovl_fs *ofs)
  1095. {
  1096. int i, err;
  1097. if (ovl_upper_mnt(ofs)) {
  1098. err = ovl_check_layer(sb, ofs, ovl_upper_mnt(ofs)->mnt_root,
  1099. "upperdir", false);
  1100. if (err)
  1101. return err;
  1102. /*
  1103. * Checking workbasedir avoids hitting ovl_is_inuse(parent) of
  1104. * this instance and covers overlapping work and index dirs,
  1105. * unless work or index dir have been moved since created inside
  1106. * workbasedir. In that case, we already have their traps in
  1107. * inode cache and we will catch that case on lookup.
  1108. */
  1109. err = ovl_check_layer(sb, ofs, ofs->workbasedir, "workdir",
  1110. false);
  1111. if (err)
  1112. return err;
  1113. }
  1114. for (i = 1; i < ofs->numlayer; i++) {
  1115. err = ovl_check_layer(sb, ofs,
  1116. ofs->layers[i].mnt->mnt_root,
  1117. "lowerdir", true);
  1118. if (err)
  1119. return err;
  1120. }
  1121. return 0;
  1122. }
  1123. static struct dentry *ovl_get_root(struct super_block *sb,
  1124. struct dentry *upperdentry,
  1125. struct ovl_entry *oe)
  1126. {
  1127. struct dentry *root;
  1128. struct ovl_fs *ofs = OVL_FS(sb);
  1129. struct ovl_path *lowerpath = ovl_lowerstack(oe);
  1130. unsigned long ino = d_inode(lowerpath->dentry)->i_ino;
  1131. int fsid = lowerpath->layer->fsid;
  1132. struct ovl_inode_params oip = {
  1133. .upperdentry = upperdentry,
  1134. .oe = oe,
  1135. };
  1136. root = d_make_root(ovl_new_inode(sb, S_IFDIR, 0));
  1137. if (!root)
  1138. return NULL;
  1139. if (upperdentry) {
  1140. /* Root inode uses upper st_ino/i_ino */
  1141. ino = d_inode(upperdentry)->i_ino;
  1142. fsid = 0;
  1143. ovl_dentry_set_upper_alias(root);
  1144. if (ovl_is_impuredir(sb, upperdentry))
  1145. ovl_set_flag(OVL_IMPURE, d_inode(root));
  1146. }
  1147. /* Look for xwhiteouts marker except in the lowermost layer */
  1148. for (int i = 0; i < ovl_numlower(oe) - 1; i++, lowerpath++) {
  1149. struct path path = {
  1150. .mnt = lowerpath->layer->mnt,
  1151. .dentry = lowerpath->dentry,
  1152. };
  1153. /* overlay.opaque=x means xwhiteouts directory */
  1154. if (ovl_get_opaquedir_val(ofs, &path) == 'x') {
  1155. ovl_layer_set_xwhiteouts(ofs, lowerpath->layer);
  1156. ovl_dentry_set_xwhiteouts(root);
  1157. }
  1158. }
  1159. /* Root is always merge -> can have whiteouts */
  1160. ovl_set_flag(OVL_WHITEOUTS, d_inode(root));
  1161. ovl_dentry_set_flag(OVL_E_CONNECTED, root);
  1162. ovl_set_upperdata(d_inode(root));
  1163. ovl_inode_init(d_inode(root), &oip, ino, fsid);
  1164. WARN_ON(!!IS_CASEFOLDED(d_inode(root)) != ofs->casefold);
  1165. ovl_dentry_init_flags(root, upperdentry, oe, DCACHE_OP_WEAK_REVALIDATE);
  1166. /* root keeps a reference of upperdentry */
  1167. dget(upperdentry);
  1168. return root;
  1169. }
  1170. static void ovl_set_d_op(struct super_block *sb)
  1171. {
  1172. #if IS_ENABLED(CONFIG_UNICODE)
  1173. struct ovl_fs *ofs = sb->s_fs_info;
  1174. if (ofs->casefold) {
  1175. set_default_d_op(sb, &ovl_dentry_ci_operations);
  1176. return;
  1177. }
  1178. #endif
  1179. set_default_d_op(sb, &ovl_dentry_operations);
  1180. }
  1181. static int ovl_fill_super_creds(struct fs_context *fc, struct super_block *sb)
  1182. {
  1183. struct ovl_fs *ofs = sb->s_fs_info;
  1184. struct cred *creator_cred = (struct cred *)ofs->creator_cred;
  1185. struct ovl_fs_context *ctx = fc->fs_private;
  1186. struct ovl_layer *layers;
  1187. struct ovl_entry *oe = NULL;
  1188. int err;
  1189. err = ovl_fs_params_verify(ctx, &ofs->config);
  1190. if (err)
  1191. return err;
  1192. err = -EINVAL;
  1193. if (ctx->nr == 0) {
  1194. if (!(fc->sb_flags & SB_SILENT))
  1195. pr_err("missing 'lowerdir'\n");
  1196. return err;
  1197. }
  1198. err = -ENOMEM;
  1199. layers = kzalloc_objs(struct ovl_layer, ctx->nr + 1);
  1200. if (!layers)
  1201. return err;
  1202. ofs->config.lowerdirs = kcalloc(ctx->nr + 1, sizeof(char *), GFP_KERNEL);
  1203. if (!ofs->config.lowerdirs) {
  1204. kfree(layers);
  1205. return err;
  1206. }
  1207. ofs->layers = layers;
  1208. /*
  1209. * Layer 0 is reserved for upper even if there's no upper.
  1210. * config.lowerdirs[0] is used for storing the user provided colon
  1211. * separated lowerdir string.
  1212. */
  1213. ofs->config.lowerdirs[0] = ctx->lowerdir_all;
  1214. ctx->lowerdir_all = NULL;
  1215. ofs->numlayer = 1;
  1216. sb->s_stack_depth = 0;
  1217. sb->s_maxbytes = MAX_LFS_FILESIZE;
  1218. atomic_long_set(&ofs->last_ino, 1);
  1219. /* Assume underlying fs uses 32bit inodes unless proven otherwise */
  1220. if (ofs->config.xino != OVL_XINO_OFF) {
  1221. ofs->xino_mode = BITS_PER_LONG - 32;
  1222. if (!ofs->xino_mode) {
  1223. pr_warn("xino not supported on 32bit kernel, falling back to xino=off.\n");
  1224. ofs->config.xino = OVL_XINO_OFF;
  1225. }
  1226. }
  1227. /* alloc/destroy_inode needed for setting up traps in inode cache */
  1228. sb->s_op = &ovl_super_operations;
  1229. if (ofs->config.upperdir) {
  1230. struct super_block *upper_sb;
  1231. err = -EINVAL;
  1232. if (!ofs->config.workdir) {
  1233. pr_err("missing 'workdir'\n");
  1234. return err;
  1235. }
  1236. err = ovl_get_upper(sb, ofs, &layers[0], &ctx->upper);
  1237. if (err)
  1238. return err;
  1239. upper_sb = ovl_upper_mnt(ofs)->mnt_sb;
  1240. if (!ovl_should_sync(ofs)) {
  1241. ofs->errseq = errseq_sample(&upper_sb->s_wb_err);
  1242. if (errseq_check(&upper_sb->s_wb_err, ofs->errseq)) {
  1243. err = -EIO;
  1244. pr_err("Cannot mount volatile when upperdir has an unseen error. Sync upperdir fs to clear state.\n");
  1245. return err;
  1246. }
  1247. }
  1248. err = ovl_get_workdir(sb, ofs, &ctx->upper, &ctx->work);
  1249. if (err)
  1250. return err;
  1251. if (!ofs->workdir)
  1252. sb->s_flags |= SB_RDONLY;
  1253. sb->s_stack_depth = upper_sb->s_stack_depth;
  1254. sb->s_time_gran = upper_sb->s_time_gran;
  1255. }
  1256. oe = ovl_get_lowerstack(sb, ctx, ofs, layers);
  1257. err = PTR_ERR(oe);
  1258. if (IS_ERR(oe))
  1259. return err;
  1260. /* If the upper fs is nonexistent, we mark overlayfs r/o too */
  1261. if (!ovl_upper_mnt(ofs))
  1262. sb->s_flags |= SB_RDONLY;
  1263. if (ovl_has_fsid(ofs) && ovl_upper_mnt(ofs)) {
  1264. /* Use per instance persistent uuid/fsid */
  1265. ovl_init_uuid_xattr(sb, ofs, &ctx->upper);
  1266. }
  1267. if (!ovl_force_readonly(ofs) && ofs->config.index) {
  1268. err = ovl_get_indexdir(sb, ofs, oe, &ctx->upper);
  1269. if (err)
  1270. goto out_free_oe;
  1271. /* Force r/o mount with no index dir */
  1272. if (!ofs->workdir)
  1273. sb->s_flags |= SB_RDONLY;
  1274. }
  1275. err = ovl_check_overlapping_layers(sb, ofs);
  1276. if (err)
  1277. goto out_free_oe;
  1278. /* Show index=off in /proc/mounts for forced r/o mount */
  1279. if (!ofs->workdir) {
  1280. ofs->config.index = false;
  1281. if (ovl_upper_mnt(ofs) && ofs->config.nfs_export) {
  1282. pr_warn("NFS export requires an index dir, falling back to nfs_export=off.\n");
  1283. ofs->config.nfs_export = false;
  1284. }
  1285. }
  1286. if (ofs->config.metacopy && ofs->config.nfs_export) {
  1287. pr_warn("NFS export is not supported with metadata only copy up, falling back to nfs_export=off.\n");
  1288. ofs->config.nfs_export = false;
  1289. }
  1290. /*
  1291. * Support encoding decodable file handles with nfs_export=on
  1292. * and encoding non-decodable file handles with nfs_export=off
  1293. * if all layers support file handles.
  1294. */
  1295. if (ofs->config.nfs_export)
  1296. sb->s_export_op = &ovl_export_operations;
  1297. else if (!ofs->nofh)
  1298. sb->s_export_op = &ovl_export_fid_operations;
  1299. /* Never override disk quota limits or use reserved space */
  1300. cap_lower(creator_cred->cap_effective, CAP_SYS_RESOURCE);
  1301. sb->s_magic = OVERLAYFS_SUPER_MAGIC;
  1302. sb->s_xattr = ovl_xattr_handlers(ofs);
  1303. sb->s_fs_info = ofs;
  1304. #ifdef CONFIG_FS_POSIX_ACL
  1305. sb->s_flags |= SB_POSIXACL;
  1306. #endif
  1307. sb->s_iflags |= SB_I_SKIP_SYNC;
  1308. /*
  1309. * Ensure that umask handling is done by the filesystems used
  1310. * for the the upper layer instead of overlayfs as that would
  1311. * lead to unexpected results.
  1312. */
  1313. sb->s_iflags |= SB_I_NOUMASK;
  1314. sb->s_iflags |= SB_I_EVM_HMAC_UNSUPPORTED;
  1315. err = -ENOMEM;
  1316. sb->s_root = ovl_get_root(sb, ctx->upper.dentry, oe);
  1317. if (!sb->s_root)
  1318. goto out_free_oe;
  1319. return 0;
  1320. out_free_oe:
  1321. ovl_free_entry(oe);
  1322. return err;
  1323. }
  1324. int ovl_fill_super(struct super_block *sb, struct fs_context *fc)
  1325. {
  1326. struct ovl_fs *ofs = sb->s_fs_info;
  1327. int err;
  1328. err = -EIO;
  1329. if (WARN_ON(fc->user_ns != current_user_ns()))
  1330. goto out_err;
  1331. ovl_set_d_op(sb);
  1332. if (!ofs->creator_cred) {
  1333. err = -ENOMEM;
  1334. ofs->creator_cred = prepare_creds();
  1335. if (!ofs->creator_cred)
  1336. goto out_err;
  1337. }
  1338. with_ovl_creds(sb)
  1339. err = ovl_fill_super_creds(fc, sb);
  1340. out_err:
  1341. if (err) {
  1342. ovl_free_fs(ofs);
  1343. sb->s_fs_info = NULL;
  1344. }
  1345. return err;
  1346. }
  1347. struct file_system_type ovl_fs_type = {
  1348. .owner = THIS_MODULE,
  1349. .name = "overlay",
  1350. .init_fs_context = ovl_init_fs_context,
  1351. .parameters = ovl_parameter_spec,
  1352. .fs_flags = FS_USERNS_MOUNT,
  1353. .kill_sb = kill_anon_super,
  1354. };
  1355. MODULE_ALIAS_FS("overlay");
  1356. static void ovl_inode_init_once(void *foo)
  1357. {
  1358. struct ovl_inode *oi = foo;
  1359. inode_init_once(&oi->vfs_inode);
  1360. }
  1361. static int __init ovl_init(void)
  1362. {
  1363. int err;
  1364. ovl_inode_cachep = kmem_cache_create("ovl_inode",
  1365. sizeof(struct ovl_inode), 0,
  1366. (SLAB_RECLAIM_ACCOUNT|
  1367. SLAB_ACCOUNT),
  1368. ovl_inode_init_once);
  1369. if (ovl_inode_cachep == NULL)
  1370. return -ENOMEM;
  1371. err = register_filesystem(&ovl_fs_type);
  1372. if (!err)
  1373. return 0;
  1374. kmem_cache_destroy(ovl_inode_cachep);
  1375. return err;
  1376. }
  1377. static void __exit ovl_exit(void)
  1378. {
  1379. unregister_filesystem(&ovl_fs_type);
  1380. /*
  1381. * Make sure all delayed rcu free inodes are flushed before we
  1382. * destroy cache.
  1383. */
  1384. rcu_barrier();
  1385. kmem_cache_destroy(ovl_inode_cachep);
  1386. }
  1387. module_init(ovl_init);
  1388. module_exit(ovl_exit);