xref: /linux/fs/cachefiles/namei.c (revision a9fc2304972b1db28b88af8203dffef23e1e92ba)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* CacheFiles path walking and related routines
3  *
4  * Copyright (C) 2021 Red Hat, Inc. All Rights Reserved.
5  * Written by David Howells (dhowells@redhat.com)
6  */
7 
8 #include <linux/fs.h>
9 #include <linux/namei.h>
10 #include "internal.h"
11 
12 /*
13  * Mark the backing file as being a cache file if it's not already in use.  The
14  * mark tells the culling request command that it's not allowed to cull the
15  * file or directory.  The caller must hold the inode lock.
16  */
17 static bool __cachefiles_mark_inode_in_use(struct cachefiles_object *object,
18 					   struct inode *inode)
19 {
20 	bool can_use = false;
21 
22 	if (!(inode->i_flags & S_KERNEL_FILE)) {
23 		inode->i_flags |= S_KERNEL_FILE;
24 		trace_cachefiles_mark_active(object, inode);
25 		can_use = true;
26 	} else {
27 		trace_cachefiles_mark_failed(object, inode);
28 	}
29 
30 	return can_use;
31 }
32 
33 static bool cachefiles_mark_inode_in_use(struct cachefiles_object *object,
34 					 struct inode *inode)
35 {
36 	bool can_use;
37 
38 	inode_lock(inode);
39 	can_use = __cachefiles_mark_inode_in_use(object, inode);
40 	inode_unlock(inode);
41 	return can_use;
42 }
43 
44 /*
45  * Unmark a backing inode.  The caller must hold the inode lock.
46  */
47 static void __cachefiles_unmark_inode_in_use(struct cachefiles_object *object,
48 					     struct inode *inode)
49 {
50 	inode->i_flags &= ~S_KERNEL_FILE;
51 	trace_cachefiles_mark_inactive(object, inode);
52 }
53 
54 static void cachefiles_do_unmark_inode_in_use(struct cachefiles_object *object,
55 					      struct inode *inode)
56 {
57 	inode_lock(inode);
58 	__cachefiles_unmark_inode_in_use(object, inode);
59 	inode_unlock(inode);
60 }
61 
62 /*
63  * Unmark a backing inode and tell cachefilesd that there's something that can
64  * be culled.
65  */
66 void cachefiles_unmark_inode_in_use(struct cachefiles_object *object,
67 				    struct file *file)
68 {
69 	struct cachefiles_cache *cache = object->volume->cache;
70 	struct inode *inode = file_inode(file);
71 
72 	cachefiles_do_unmark_inode_in_use(object, inode);
73 
74 	if (!test_bit(CACHEFILES_OBJECT_USING_TMPFILE, &object->flags)) {
75 		atomic_long_add(inode->i_blocks, &cache->b_released);
76 		if (atomic_inc_return(&cache->f_released))
77 			cachefiles_state_changed(cache);
78 	}
79 }
80 
81 /*
82  * get a subdirectory
83  */
84 struct dentry *cachefiles_get_directory(struct cachefiles_cache *cache,
85 					struct dentry *dir,
86 					const char *dirname,
87 					bool *_is_new)
88 {
89 	struct dentry *subdir;
90 	struct path path;
91 	int ret;
92 
93 	_enter(",,%s", dirname);
94 
95 	/* search the current directory for the element name */
96 	inode_lock_nested(d_inode(dir), I_MUTEX_PARENT);
97 
98 retry:
99 	ret = cachefiles_inject_read_error();
100 	if (ret == 0)
101 		subdir = lookup_one_len(dirname, dir, strlen(dirname));
102 	else
103 		subdir = ERR_PTR(ret);
104 	trace_cachefiles_lookup(NULL, dir, subdir);
105 	if (IS_ERR(subdir)) {
106 		trace_cachefiles_vfs_error(NULL, d_backing_inode(dir),
107 					   PTR_ERR(subdir),
108 					   cachefiles_trace_lookup_error);
109 		if (PTR_ERR(subdir) == -ENOMEM)
110 			goto nomem_d_alloc;
111 		goto lookup_error;
112 	}
113 
114 	_debug("subdir -> %pd %s",
115 	       subdir, d_backing_inode(subdir) ? "positive" : "negative");
116 
117 	/* we need to create the subdir if it doesn't exist yet */
118 	if (d_is_negative(subdir)) {
119 		ret = cachefiles_has_space(cache, 1, 0,
120 					   cachefiles_has_space_for_create);
121 		if (ret < 0)
122 			goto mkdir_error;
123 
124 		_debug("attempt mkdir");
125 
126 		path.mnt = cache->mnt;
127 		path.dentry = dir;
128 		ret = security_path_mkdir(&path, subdir, 0700);
129 		if (ret < 0)
130 			goto mkdir_error;
131 		subdir = ERR_PTR(cachefiles_inject_write_error());
132 		if (!IS_ERR(subdir))
133 			subdir = vfs_mkdir(&nop_mnt_idmap, d_inode(dir), subdir, 0700);
134 		ret = PTR_ERR(subdir);
135 		if (IS_ERR(subdir)) {
136 			trace_cachefiles_vfs_error(NULL, d_inode(dir), ret,
137 						   cachefiles_trace_mkdir_error);
138 			goto mkdir_error;
139 		}
140 		trace_cachefiles_mkdir(dir, subdir);
141 
142 		if (unlikely(d_unhashed(subdir) || d_is_negative(subdir))) {
143 			dput(subdir);
144 			goto retry;
145 		}
146 		ASSERT(d_backing_inode(subdir));
147 
148 		_debug("mkdir -> %pd{ino=%lu}",
149 		       subdir, d_backing_inode(subdir)->i_ino);
150 		if (_is_new)
151 			*_is_new = true;
152 	}
153 
154 	/* Tell rmdir() it's not allowed to delete the subdir */
155 	inode_lock(d_inode(subdir));
156 	inode_unlock(d_inode(dir));
157 
158 	if (!__cachefiles_mark_inode_in_use(NULL, d_inode(subdir))) {
159 		pr_notice("cachefiles: Inode already in use: %pd (B=%lx)\n",
160 			  subdir, d_inode(subdir)->i_ino);
161 		goto mark_error;
162 	}
163 
164 	inode_unlock(d_inode(subdir));
165 
166 	/* we need to make sure the subdir is a directory */
167 	ASSERT(d_backing_inode(subdir));
168 
169 	if (!d_can_lookup(subdir)) {
170 		pr_err("%s is not a directory\n", dirname);
171 		ret = -EIO;
172 		goto check_error;
173 	}
174 
175 	ret = -EPERM;
176 	if (!(d_backing_inode(subdir)->i_opflags & IOP_XATTR) ||
177 	    !d_backing_inode(subdir)->i_op->lookup ||
178 	    !d_backing_inode(subdir)->i_op->mkdir ||
179 	    !d_backing_inode(subdir)->i_op->rename ||
180 	    !d_backing_inode(subdir)->i_op->rmdir ||
181 	    !d_backing_inode(subdir)->i_op->unlink)
182 		goto check_error;
183 
184 	_leave(" = [%lu]", d_backing_inode(subdir)->i_ino);
185 	return subdir;
186 
187 check_error:
188 	cachefiles_put_directory(subdir);
189 	_leave(" = %d [check]", ret);
190 	return ERR_PTR(ret);
191 
192 mark_error:
193 	inode_unlock(d_inode(subdir));
194 	dput(subdir);
195 	return ERR_PTR(-EBUSY);
196 
197 mkdir_error:
198 	inode_unlock(d_inode(dir));
199 	if (!IS_ERR(subdir))
200 		dput(subdir);
201 	pr_err("mkdir %s failed with error %d\n", dirname, ret);
202 	return ERR_PTR(ret);
203 
204 lookup_error:
205 	inode_unlock(d_inode(dir));
206 	ret = PTR_ERR(subdir);
207 	pr_err("Lookup %s failed with error %d\n", dirname, ret);
208 	return ERR_PTR(ret);
209 
210 nomem_d_alloc:
211 	inode_unlock(d_inode(dir));
212 	_leave(" = -ENOMEM");
213 	return ERR_PTR(-ENOMEM);
214 }
215 
216 /*
217  * Put a subdirectory.
218  */
219 void cachefiles_put_directory(struct dentry *dir)
220 {
221 	if (dir) {
222 		cachefiles_do_unmark_inode_in_use(NULL, d_inode(dir));
223 		dput(dir);
224 	}
225 }
226 
227 /*
228  * Remove a regular file from the cache.
229  */
230 static int cachefiles_unlink(struct cachefiles_cache *cache,
231 			     struct cachefiles_object *object,
232 			     struct dentry *dir, struct dentry *dentry,
233 			     enum fscache_why_object_killed why)
234 {
235 	struct path path = {
236 		.mnt	= cache->mnt,
237 		.dentry	= dir,
238 	};
239 	int ret;
240 
241 	trace_cachefiles_unlink(object, d_inode(dentry)->i_ino, why);
242 	ret = security_path_unlink(&path, dentry);
243 	if (ret < 0) {
244 		cachefiles_io_error(cache, "Unlink security error");
245 		return ret;
246 	}
247 
248 	ret = cachefiles_inject_remove_error();
249 	if (ret == 0) {
250 		ret = vfs_unlink(&nop_mnt_idmap, d_backing_inode(dir), dentry, NULL);
251 		if (ret == -EIO)
252 			cachefiles_io_error(cache, "Unlink failed");
253 	}
254 	if (ret != 0)
255 		trace_cachefiles_vfs_error(object, d_backing_inode(dir), ret,
256 					   cachefiles_trace_unlink_error);
257 	return ret;
258 }
259 
260 /*
261  * Delete an object representation from the cache
262  * - File backed objects are unlinked
263  * - Directory backed objects are stuffed into the graveyard for userspace to
264  *   delete
265  */
266 int cachefiles_bury_object(struct cachefiles_cache *cache,
267 			   struct cachefiles_object *object,
268 			   struct dentry *dir,
269 			   struct dentry *rep,
270 			   enum fscache_why_object_killed why)
271 {
272 	struct dentry *grave, *trap;
273 	struct path path, path_to_graveyard;
274 	char nbuffer[8 + 8 + 1];
275 	int ret;
276 
277 	_enter(",'%pd','%pd'", dir, rep);
278 
279 	if (rep->d_parent != dir) {
280 		inode_unlock(d_inode(dir));
281 		_leave(" = -ESTALE");
282 		return -ESTALE;
283 	}
284 
285 	/* non-directories can just be unlinked */
286 	if (!d_is_dir(rep)) {
287 		dget(rep); /* Stop the dentry being negated if it's only pinned
288 			    * by a file struct.
289 			    */
290 		ret = cachefiles_unlink(cache, object, dir, rep, why);
291 		dput(rep);
292 
293 		inode_unlock(d_inode(dir));
294 		_leave(" = %d", ret);
295 		return ret;
296 	}
297 
298 	/* directories have to be moved to the graveyard */
299 	_debug("move stale object to graveyard");
300 	inode_unlock(d_inode(dir));
301 
302 try_again:
303 	/* first step is to make up a grave dentry in the graveyard */
304 	sprintf(nbuffer, "%08x%08x",
305 		(uint32_t) ktime_get_real_seconds(),
306 		(uint32_t) atomic_inc_return(&cache->gravecounter));
307 
308 	/* do the multiway lock magic */
309 	trap = lock_rename(cache->graveyard, dir);
310 	if (IS_ERR(trap))
311 		return PTR_ERR(trap);
312 
313 	/* do some checks before getting the grave dentry */
314 	if (rep->d_parent != dir || IS_DEADDIR(d_inode(rep))) {
315 		/* the entry was probably culled when we dropped the parent dir
316 		 * lock */
317 		unlock_rename(cache->graveyard, dir);
318 		_leave(" = 0 [culled?]");
319 		return 0;
320 	}
321 
322 	if (!d_can_lookup(cache->graveyard)) {
323 		unlock_rename(cache->graveyard, dir);
324 		cachefiles_io_error(cache, "Graveyard no longer a directory");
325 		return -EIO;
326 	}
327 
328 	if (trap == rep) {
329 		unlock_rename(cache->graveyard, dir);
330 		cachefiles_io_error(cache, "May not make directory loop");
331 		return -EIO;
332 	}
333 
334 	if (d_mountpoint(rep)) {
335 		unlock_rename(cache->graveyard, dir);
336 		cachefiles_io_error(cache, "Mountpoint in cache");
337 		return -EIO;
338 	}
339 
340 	grave = lookup_one_len(nbuffer, cache->graveyard, strlen(nbuffer));
341 	if (IS_ERR(grave)) {
342 		unlock_rename(cache->graveyard, dir);
343 		trace_cachefiles_vfs_error(object, d_inode(cache->graveyard),
344 					   PTR_ERR(grave),
345 					   cachefiles_trace_lookup_error);
346 
347 		if (PTR_ERR(grave) == -ENOMEM) {
348 			_leave(" = -ENOMEM");
349 			return -ENOMEM;
350 		}
351 
352 		cachefiles_io_error(cache, "Lookup error %ld", PTR_ERR(grave));
353 		return -EIO;
354 	}
355 
356 	if (d_is_positive(grave)) {
357 		unlock_rename(cache->graveyard, dir);
358 		dput(grave);
359 		grave = NULL;
360 		cond_resched();
361 		goto try_again;
362 	}
363 
364 	if (d_mountpoint(grave)) {
365 		unlock_rename(cache->graveyard, dir);
366 		dput(grave);
367 		cachefiles_io_error(cache, "Mountpoint in graveyard");
368 		return -EIO;
369 	}
370 
371 	/* target should not be an ancestor of source */
372 	if (trap == grave) {
373 		unlock_rename(cache->graveyard, dir);
374 		dput(grave);
375 		cachefiles_io_error(cache, "May not make directory loop");
376 		return -EIO;
377 	}
378 
379 	/* attempt the rename */
380 	path.mnt = cache->mnt;
381 	path.dentry = dir;
382 	path_to_graveyard.mnt = cache->mnt;
383 	path_to_graveyard.dentry = cache->graveyard;
384 	ret = security_path_rename(&path, rep, &path_to_graveyard, grave, 0);
385 	if (ret < 0) {
386 		cachefiles_io_error(cache, "Rename security error %d", ret);
387 	} else {
388 		struct renamedata rd = {
389 			.old_mnt_idmap	= &nop_mnt_idmap,
390 			.old_dir	= d_inode(dir),
391 			.old_dentry	= rep,
392 			.new_mnt_idmap	= &nop_mnt_idmap,
393 			.new_dir	= d_inode(cache->graveyard),
394 			.new_dentry	= grave,
395 		};
396 		trace_cachefiles_rename(object, d_inode(rep)->i_ino, why);
397 		ret = cachefiles_inject_read_error();
398 		if (ret == 0)
399 			ret = vfs_rename(&rd);
400 		if (ret != 0)
401 			trace_cachefiles_vfs_error(object, d_inode(dir), ret,
402 						   cachefiles_trace_rename_error);
403 		if (ret != 0 && ret != -ENOMEM)
404 			cachefiles_io_error(cache,
405 					    "Rename failed with error %d", ret);
406 	}
407 
408 	__cachefiles_unmark_inode_in_use(object, d_inode(rep));
409 	unlock_rename(cache->graveyard, dir);
410 	dput(grave);
411 	_leave(" = 0");
412 	return 0;
413 }
414 
415 /*
416  * Delete a cache file.
417  */
418 int cachefiles_delete_object(struct cachefiles_object *object,
419 			     enum fscache_why_object_killed why)
420 {
421 	struct cachefiles_volume *volume = object->volume;
422 	struct dentry *dentry = object->file->f_path.dentry;
423 	struct dentry *fan = volume->fanout[(u8)object->cookie->key_hash];
424 	int ret;
425 
426 	_enter(",OBJ%x{%pD}", object->debug_id, object->file);
427 
428 	/* Stop the dentry being negated if it's only pinned by a file struct. */
429 	dget(dentry);
430 
431 	inode_lock_nested(d_backing_inode(fan), I_MUTEX_PARENT);
432 	ret = cachefiles_unlink(volume->cache, object, fan, dentry, why);
433 	inode_unlock(d_backing_inode(fan));
434 	dput(dentry);
435 	return ret;
436 }
437 
438 /*
439  * Create a temporary file and leave it unattached and un-xattr'd until the
440  * time comes to discard the object from memory.
441  */
442 struct file *cachefiles_create_tmpfile(struct cachefiles_object *object)
443 {
444 	struct cachefiles_volume *volume = object->volume;
445 	struct cachefiles_cache *cache = volume->cache;
446 	const struct cred *saved_cred;
447 	struct dentry *fan = volume->fanout[(u8)object->cookie->key_hash];
448 	struct file *file;
449 	const struct path parentpath = { .mnt = cache->mnt, .dentry = fan };
450 	uint64_t ni_size;
451 	long ret;
452 
453 
454 	cachefiles_begin_secure(cache, &saved_cred);
455 
456 	ret = cachefiles_inject_write_error();
457 	if (ret == 0) {
458 		file = kernel_tmpfile_open(&nop_mnt_idmap, &parentpath,
459 					   S_IFREG | 0600,
460 					   O_RDWR | O_LARGEFILE | O_DIRECT,
461 					   cache->cache_cred);
462 		ret = PTR_ERR_OR_ZERO(file);
463 	}
464 	if (ret) {
465 		trace_cachefiles_vfs_error(object, d_inode(fan), ret,
466 					   cachefiles_trace_tmpfile_error);
467 		if (ret == -EIO)
468 			cachefiles_io_error_obj(object, "Failed to create tmpfile");
469 		goto err;
470 	}
471 
472 	trace_cachefiles_tmpfile(object, file_inode(file));
473 
474 	/* This is a newly created file with no other possible user */
475 	if (!cachefiles_mark_inode_in_use(object, file_inode(file)))
476 		WARN_ON(1);
477 
478 	ret = cachefiles_ondemand_init_object(object);
479 	if (ret < 0)
480 		goto err_unuse;
481 
482 	ni_size = object->cookie->object_size;
483 	ni_size = round_up(ni_size, CACHEFILES_DIO_BLOCK_SIZE);
484 
485 	if (ni_size > 0) {
486 		trace_cachefiles_trunc(object, file_inode(file), 0, ni_size,
487 				       cachefiles_trunc_expand_tmpfile);
488 		ret = cachefiles_inject_write_error();
489 		if (ret == 0)
490 			ret = vfs_truncate(&file->f_path, ni_size);
491 		if (ret < 0) {
492 			trace_cachefiles_vfs_error(
493 				object, file_inode(file), ret,
494 				cachefiles_trace_trunc_error);
495 			goto err_unuse;
496 		}
497 	}
498 
499 	ret = -EINVAL;
500 	if (unlikely(!file->f_op->read_iter) ||
501 	    unlikely(!file->f_op->write_iter)) {
502 		fput(file);
503 		pr_notice("Cache does not support read_iter and write_iter\n");
504 		goto err_unuse;
505 	}
506 out:
507 	cachefiles_end_secure(cache, saved_cred);
508 	return file;
509 
510 err_unuse:
511 	cachefiles_do_unmark_inode_in_use(object, file_inode(file));
512 	fput(file);
513 err:
514 	file = ERR_PTR(ret);
515 	goto out;
516 }
517 
518 /*
519  * Create a new file.
520  */
521 static bool cachefiles_create_file(struct cachefiles_object *object)
522 {
523 	struct file *file;
524 	int ret;
525 
526 	ret = cachefiles_has_space(object->volume->cache, 1, 0,
527 				   cachefiles_has_space_for_create);
528 	if (ret < 0)
529 		return false;
530 
531 	file = cachefiles_create_tmpfile(object);
532 	if (IS_ERR(file))
533 		return false;
534 
535 	set_bit(FSCACHE_COOKIE_NEEDS_UPDATE, &object->cookie->flags);
536 	set_bit(CACHEFILES_OBJECT_USING_TMPFILE, &object->flags);
537 	_debug("create -> %pD{ino=%lu}", file, file_inode(file)->i_ino);
538 	object->file = file;
539 	return true;
540 }
541 
542 /*
543  * Open an existing file, checking its attributes and replacing it if it is
544  * stale.
545  */
546 static bool cachefiles_open_file(struct cachefiles_object *object,
547 				 struct dentry *dentry)
548 {
549 	struct cachefiles_cache *cache = object->volume->cache;
550 	struct file *file;
551 	struct path path;
552 	int ret;
553 
554 	_enter("%pd", dentry);
555 
556 	if (!cachefiles_mark_inode_in_use(object, d_inode(dentry))) {
557 		pr_notice("cachefiles: Inode already in use: %pd (B=%lx)\n",
558 			  dentry, d_inode(dentry)->i_ino);
559 		return false;
560 	}
561 
562 	/* We need to open a file interface onto a data file now as we can't do
563 	 * it on demand because writeback called from do_exit() sees
564 	 * current->fs == NULL - which breaks d_path() called from ext4 open.
565 	 */
566 	path.mnt = cache->mnt;
567 	path.dentry = dentry;
568 	file = kernel_file_open(&path, O_RDWR | O_LARGEFILE | O_DIRECT, cache->cache_cred);
569 	if (IS_ERR(file)) {
570 		trace_cachefiles_vfs_error(object, d_backing_inode(dentry),
571 					   PTR_ERR(file),
572 					   cachefiles_trace_open_error);
573 		goto error;
574 	}
575 
576 	if (unlikely(!file->f_op->read_iter) ||
577 	    unlikely(!file->f_op->write_iter)) {
578 		pr_notice("Cache does not support read_iter and write_iter\n");
579 		goto error_fput;
580 	}
581 	_debug("file -> %pd positive", dentry);
582 
583 	ret = cachefiles_ondemand_init_object(object);
584 	if (ret < 0)
585 		goto error_fput;
586 
587 	ret = cachefiles_check_auxdata(object, file);
588 	if (ret < 0)
589 		goto check_failed;
590 
591 	clear_bit(FSCACHE_COOKIE_NO_DATA_TO_READ, &object->cookie->flags);
592 
593 	object->file = file;
594 
595 	/* Always update the atime on an object we've just looked up (this is
596 	 * used to keep track of culling, and atimes are only updated by read,
597 	 * write and readdir but not lookup or open).
598 	 */
599 	touch_atime(&file->f_path);
600 	return true;
601 
602 check_failed:
603 	fscache_cookie_lookup_negative(object->cookie);
604 	cachefiles_unmark_inode_in_use(object, file);
605 	fput(file);
606 	if (ret == -ESTALE)
607 		return cachefiles_create_file(object);
608 	return false;
609 
610 error_fput:
611 	fput(file);
612 error:
613 	cachefiles_do_unmark_inode_in_use(object, d_inode(dentry));
614 	return false;
615 }
616 
617 /*
618  * walk from the parent object to the child object through the backing
619  * filesystem, creating directories as we go
620  */
621 bool cachefiles_look_up_object(struct cachefiles_object *object)
622 {
623 	struct cachefiles_volume *volume = object->volume;
624 	struct dentry *dentry, *fan = volume->fanout[(u8)object->cookie->key_hash];
625 	int ret;
626 
627 	_enter("OBJ%x,%s,", object->debug_id, object->d_name);
628 
629 	/* Look up path "cache/vol/fanout/file". */
630 	ret = cachefiles_inject_read_error();
631 	if (ret == 0)
632 		dentry = lookup_positive_unlocked(object->d_name, fan,
633 						  object->d_name_len);
634 	else
635 		dentry = ERR_PTR(ret);
636 	trace_cachefiles_lookup(object, fan, dentry);
637 	if (IS_ERR(dentry)) {
638 		if (dentry == ERR_PTR(-ENOENT))
639 			goto new_file;
640 		if (dentry == ERR_PTR(-EIO))
641 			cachefiles_io_error_obj(object, "Lookup failed");
642 		return false;
643 	}
644 
645 	if (!d_is_reg(dentry)) {
646 		pr_err("%pd is not a file\n", dentry);
647 		inode_lock_nested(d_inode(fan), I_MUTEX_PARENT);
648 		ret = cachefiles_bury_object(volume->cache, object, fan, dentry,
649 					     FSCACHE_OBJECT_IS_WEIRD);
650 		dput(dentry);
651 		if (ret < 0)
652 			return false;
653 		goto new_file;
654 	}
655 
656 	ret = cachefiles_open_file(object, dentry);
657 	dput(dentry);
658 	if (!ret)
659 		return false;
660 
661 	_leave(" = t [%lu]", file_inode(object->file)->i_ino);
662 	return true;
663 
664 new_file:
665 	fscache_cookie_lookup_negative(object->cookie);
666 	return cachefiles_create_file(object);
667 }
668 
669 /*
670  * Attempt to link a temporary file into its rightful place in the cache.
671  */
672 bool cachefiles_commit_tmpfile(struct cachefiles_cache *cache,
673 			       struct cachefiles_object *object)
674 {
675 	struct cachefiles_volume *volume = object->volume;
676 	struct dentry *dentry, *fan = volume->fanout[(u8)object->cookie->key_hash];
677 	bool success = false;
678 	int ret;
679 
680 	_enter(",%pD", object->file);
681 
682 	inode_lock_nested(d_inode(fan), I_MUTEX_PARENT);
683 	ret = cachefiles_inject_read_error();
684 	if (ret == 0)
685 		dentry = lookup_one_len(object->d_name, fan, object->d_name_len);
686 	else
687 		dentry = ERR_PTR(ret);
688 	if (IS_ERR(dentry)) {
689 		trace_cachefiles_vfs_error(object, d_inode(fan), PTR_ERR(dentry),
690 					   cachefiles_trace_lookup_error);
691 		_debug("lookup fail %ld", PTR_ERR(dentry));
692 		goto out_unlock;
693 	}
694 
695 	if (!d_is_negative(dentry)) {
696 		ret = cachefiles_unlink(volume->cache, object, fan, dentry,
697 					FSCACHE_OBJECT_IS_STALE);
698 		if (ret < 0)
699 			goto out_dput;
700 
701 		dput(dentry);
702 		ret = cachefiles_inject_read_error();
703 		if (ret == 0)
704 			dentry = lookup_one_len(object->d_name, fan, object->d_name_len);
705 		else
706 			dentry = ERR_PTR(ret);
707 		if (IS_ERR(dentry)) {
708 			trace_cachefiles_vfs_error(object, d_inode(fan), PTR_ERR(dentry),
709 						   cachefiles_trace_lookup_error);
710 			_debug("lookup fail %ld", PTR_ERR(dentry));
711 			goto out_unlock;
712 		}
713 	}
714 
715 	ret = cachefiles_inject_read_error();
716 	if (ret == 0)
717 		ret = vfs_link(object->file->f_path.dentry, &nop_mnt_idmap,
718 			       d_inode(fan), dentry, NULL);
719 	if (ret < 0) {
720 		trace_cachefiles_vfs_error(object, d_inode(fan), ret,
721 					   cachefiles_trace_link_error);
722 		_debug("link fail %d", ret);
723 	} else {
724 		trace_cachefiles_link(object, file_inode(object->file));
725 		spin_lock(&object->lock);
726 		/* TODO: Do we want to switch the file pointer to the new dentry? */
727 		clear_bit(CACHEFILES_OBJECT_USING_TMPFILE, &object->flags);
728 		spin_unlock(&object->lock);
729 		success = true;
730 	}
731 
732 out_dput:
733 	dput(dentry);
734 out_unlock:
735 	inode_unlock(d_inode(fan));
736 	_leave(" = %u", success);
737 	return success;
738 }
739 
740 /*
741  * Look up an inode to be checked or culled.  Return -EBUSY if the inode is
742  * marked in use.
743  */
744 static struct dentry *cachefiles_lookup_for_cull(struct cachefiles_cache *cache,
745 						 struct dentry *dir,
746 						 char *filename)
747 {
748 	struct dentry *victim;
749 	int ret = -ENOENT;
750 
751 	inode_lock_nested(d_inode(dir), I_MUTEX_PARENT);
752 
753 	victim = lookup_one_len(filename, dir, strlen(filename));
754 	if (IS_ERR(victim))
755 		goto lookup_error;
756 	if (d_is_negative(victim))
757 		goto lookup_put;
758 	if (d_inode(victim)->i_flags & S_KERNEL_FILE)
759 		goto lookup_busy;
760 	return victim;
761 
762 lookup_busy:
763 	ret = -EBUSY;
764 lookup_put:
765 	inode_unlock(d_inode(dir));
766 	dput(victim);
767 	return ERR_PTR(ret);
768 
769 lookup_error:
770 	inode_unlock(d_inode(dir));
771 	ret = PTR_ERR(victim);
772 	if (ret == -ENOENT)
773 		return ERR_PTR(-ESTALE); /* Probably got retired by the netfs */
774 
775 	if (ret == -EIO) {
776 		cachefiles_io_error(cache, "Lookup failed");
777 	} else if (ret != -ENOMEM) {
778 		pr_err("Internal error: %d\n", ret);
779 		ret = -EIO;
780 	}
781 
782 	return ERR_PTR(ret);
783 }
784 
785 /*
786  * Cull an object if it's not in use
787  * - called only by cache manager daemon
788  */
789 int cachefiles_cull(struct cachefiles_cache *cache, struct dentry *dir,
790 		    char *filename)
791 {
792 	struct dentry *victim;
793 	struct inode *inode;
794 	int ret;
795 
796 	_enter(",%pd/,%s", dir, filename);
797 
798 	victim = cachefiles_lookup_for_cull(cache, dir, filename);
799 	if (IS_ERR(victim))
800 		return PTR_ERR(victim);
801 
802 	/* check to see if someone is using this object */
803 	inode = d_inode(victim);
804 	inode_lock(inode);
805 	if (inode->i_flags & S_KERNEL_FILE) {
806 		ret = -EBUSY;
807 	} else {
808 		/* Stop the cache from picking it back up */
809 		inode->i_flags |= S_KERNEL_FILE;
810 		ret = 0;
811 	}
812 	inode_unlock(inode);
813 	if (ret < 0)
814 		goto error_unlock;
815 
816 	ret = cachefiles_bury_object(cache, NULL, dir, victim,
817 				     FSCACHE_OBJECT_WAS_CULLED);
818 	if (ret < 0)
819 		goto error;
820 
821 	fscache_count_culled();
822 	dput(victim);
823 	_leave(" = 0");
824 	return 0;
825 
826 error_unlock:
827 	inode_unlock(d_inode(dir));
828 error:
829 	dput(victim);
830 	if (ret == -ENOENT)
831 		return -ESTALE; /* Probably got retired by the netfs */
832 
833 	if (ret != -ENOMEM) {
834 		pr_err("Internal error: %d\n", ret);
835 		ret = -EIO;
836 	}
837 
838 	_leave(" = %d", ret);
839 	return ret;
840 }
841 
842 /*
843  * Find out if an object is in use or not
844  * - called only by cache manager daemon
845  * - returns -EBUSY or 0 to indicate whether an object is in use or not
846  */
847 int cachefiles_check_in_use(struct cachefiles_cache *cache, struct dentry *dir,
848 			    char *filename)
849 {
850 	struct dentry *victim;
851 	int ret = 0;
852 
853 	victim = cachefiles_lookup_for_cull(cache, dir, filename);
854 	if (IS_ERR(victim))
855 		return PTR_ERR(victim);
856 
857 	inode_unlock(d_inode(dir));
858 	dput(victim);
859 	return ret;
860 }
861