blob: 339c910da916e03a2ae9b9722159429b4b8ade50 [file] [log] [blame]
David Howells9ae326a2009-04-03 16:42:41 +01001/* CacheFiles path walking and related routines
2 *
3 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public Licence
8 * as published by the Free Software Foundation; either version
9 * 2 of the Licence, or (at your option) any later version.
10 */
11
12#include <linux/module.h>
13#include <linux/sched.h>
14#include <linux/file.h>
15#include <linux/fs.h>
16#include <linux/fsnotify.h>
17#include <linux/quotaops.h>
18#include <linux/xattr.h>
19#include <linux/mount.h>
20#include <linux/namei.h>
21#include <linux/security.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090022#include <linux/slab.h>
Andreas Gruenbacher5d6c3192016-09-29 17:48:42 +020023#include <linux/xattr.h>
David Howells9ae326a2009-04-03 16:42:41 +010024#include "internal.h"
25
David Howellsd0e27b72009-11-19 18:12:02 +000026#define CACHEFILES_KEYBUF_SIZE 512
27
28/*
29 * dump debugging info about an object
30 */
31static noinline
32void __cachefiles_printk_object(struct cachefiles_object *object,
33 const char *prefix,
34 u8 *keybuf)
35{
36 struct fscache_cookie *cookie;
37 unsigned keylen, loop;
38
Fabian Frederick4e1eb882014-06-06 14:37:32 -070039 pr_err("%sobject: OBJ%x\n", prefix, object->fscache.debug_id);
40 pr_err("%sobjstate=%s fl=%lx wbusy=%x ev=%lx[%lx]\n",
David Howellscaaef692013-05-10 19:50:26 +010041 prefix, object->fscache.state->name,
Tejun Heo8b8edef2010-07-20 22:09:01 +020042 object->fscache.flags, work_busy(&object->fscache.work),
David Howellsc2d35bf2012-12-05 13:34:47 +000043 object->fscache.events, object->fscache.event_mask);
Fabian Frederick4e1eb882014-06-06 14:37:32 -070044 pr_err("%sops=%u inp=%u exc=%u\n",
David Howellsd0e27b72009-11-19 18:12:02 +000045 prefix, object->fscache.n_ops, object->fscache.n_in_progress,
46 object->fscache.n_exclusive);
Fabian Frederick4e1eb882014-06-06 14:37:32 -070047 pr_err("%sparent=%p\n",
David Howellsd0e27b72009-11-19 18:12:02 +000048 prefix, object->fscache.parent);
49
50 spin_lock(&object->fscache.lock);
51 cookie = object->fscache.cookie;
52 if (cookie) {
Fabian Frederick4e1eb882014-06-06 14:37:32 -070053 pr_err("%scookie=%p [pr=%p nd=%p fl=%lx]\n",
David Howellsd0e27b72009-11-19 18:12:02 +000054 prefix,
55 object->fscache.cookie,
56 object->fscache.cookie->parent,
57 object->fscache.cookie->netfs_data,
58 object->fscache.cookie->flags);
David Howells509bf242013-09-20 14:18:00 +010059 if (keybuf && cookie->def)
David Howellsd0e27b72009-11-19 18:12:02 +000060 keylen = cookie->def->get_key(cookie->netfs_data, keybuf,
61 CACHEFILES_KEYBUF_SIZE);
62 else
63 keylen = 0;
64 } else {
Fabian Frederick4e1eb882014-06-06 14:37:32 -070065 pr_err("%scookie=NULL\n", prefix);
David Howellsd0e27b72009-11-19 18:12:02 +000066 keylen = 0;
67 }
68 spin_unlock(&object->fscache.lock);
69
70 if (keylen) {
Fabian Frederick4e1eb882014-06-06 14:37:32 -070071 pr_err("%skey=[%u] '", prefix, keylen);
David Howellsd0e27b72009-11-19 18:12:02 +000072 for (loop = 0; loop < keylen; loop++)
Fabian Frederick4e1eb882014-06-06 14:37:32 -070073 pr_cont("%02x", keybuf[loop]);
74 pr_cont("'\n");
David Howellsd0e27b72009-11-19 18:12:02 +000075 }
76}
77
78/*
79 * dump debugging info about a pair of objects
80 */
81static noinline void cachefiles_printk_object(struct cachefiles_object *object,
82 struct cachefiles_object *xobject)
83{
84 u8 *keybuf;
85
86 keybuf = kmalloc(CACHEFILES_KEYBUF_SIZE, GFP_NOIO);
87 if (object)
88 __cachefiles_printk_object(object, "", keybuf);
89 if (xobject)
90 __cachefiles_printk_object(xobject, "x", keybuf);
91 kfree(keybuf);
92}
93
David Howells9ae326a2009-04-03 16:42:41 +010094/*
David Howellsc61ea312010-05-11 16:51:39 +010095 * mark the owner of a dentry, if there is one, to indicate that that dentry
96 * has been preemptively deleted
97 * - the caller must hold the i_mutex on the dentry's parent as required to
98 * call vfs_unlink(), vfs_rmdir() or vfs_rename()
99 */
100static void cachefiles_mark_object_buried(struct cachefiles_cache *cache,
David Howells182d9192015-02-19 23:47:31 +0000101 struct dentry *dentry,
102 enum fscache_why_object_killed why)
David Howellsc61ea312010-05-11 16:51:39 +0100103{
104 struct cachefiles_object *object;
105 struct rb_node *p;
106
Al Viroa4555892014-10-21 20:11:25 -0400107 _enter(",'%pd'", dentry);
David Howellsc61ea312010-05-11 16:51:39 +0100108
109 write_lock(&cache->active_lock);
110
111 p = cache->active_nodes.rb_node;
112 while (p) {
113 object = rb_entry(p, struct cachefiles_object, active_node);
114 if (object->dentry > dentry)
115 p = p->rb_left;
116 else if (object->dentry < dentry)
117 p = p->rb_right;
118 else
119 goto found_dentry;
120 }
121
122 write_unlock(&cache->active_lock);
123 _leave(" [no owner]");
124 return;
125
126 /* found the dentry for */
127found_dentry:
128 kdebug("preemptive burial: OBJ%x [%s] %p",
129 object->fscache.debug_id,
David Howellscaaef692013-05-10 19:50:26 +0100130 object->fscache.state->name,
David Howellsc61ea312010-05-11 16:51:39 +0100131 dentry);
132
David Howells493f7bc2013-05-10 19:50:26 +0100133 if (fscache_object_is_live(&object->fscache)) {
Fabian Frederick4e1eb882014-06-06 14:37:32 -0700134 pr_err("\n");
Fabian Frederick0227d6ab2014-06-06 14:37:33 -0700135 pr_err("Error: Can't preemptively bury live object\n");
David Howellsc61ea312010-05-11 16:51:39 +0100136 cachefiles_printk_object(object, NULL);
David Howells182d9192015-02-19 23:47:31 +0000137 } else {
138 if (why != FSCACHE_OBJECT_IS_STALE)
139 fscache_object_mark_killed(&object->fscache, why);
David Howellsc61ea312010-05-11 16:51:39 +0100140 }
141
142 write_unlock(&cache->active_lock);
143 _leave(" [owner marked]");
144}
145
146/*
David Howells9ae326a2009-04-03 16:42:41 +0100147 * record the fact that an object is now active
148 */
David Howellsfee096d2009-11-19 18:12:05 +0000149static int cachefiles_mark_object_active(struct cachefiles_cache *cache,
150 struct cachefiles_object *object)
David Howells9ae326a2009-04-03 16:42:41 +0100151{
152 struct cachefiles_object *xobject;
153 struct rb_node **_p, *_parent = NULL;
154 struct dentry *dentry;
155
156 _enter(",%p", object);
157
158try_again:
159 write_lock(&cache->active_lock);
160
David Howellsd0e27b72009-11-19 18:12:02 +0000161 if (test_and_set_bit(CACHEFILES_OBJECT_ACTIVE, &object->flags)) {
Fabian Frederick0227d6ab2014-06-06 14:37:33 -0700162 pr_err("Error: Object already active\n");
David Howellsd0e27b72009-11-19 18:12:02 +0000163 cachefiles_printk_object(object, NULL);
David Howells9ae326a2009-04-03 16:42:41 +0100164 BUG();
David Howellsd0e27b72009-11-19 18:12:02 +0000165 }
David Howells9ae326a2009-04-03 16:42:41 +0100166
167 dentry = object->dentry;
168 _p = &cache->active_nodes.rb_node;
169 while (*_p) {
170 _parent = *_p;
171 xobject = rb_entry(_parent,
172 struct cachefiles_object, active_node);
173
174 ASSERT(xobject != object);
175
176 if (xobject->dentry > dentry)
177 _p = &(*_p)->rb_left;
178 else if (xobject->dentry < dentry)
179 _p = &(*_p)->rb_right;
180 else
181 goto wait_for_old_object;
182 }
183
184 rb_link_node(&object->active_node, _parent, _p);
185 rb_insert_color(&object->active_node, &cache->active_nodes);
186
187 write_unlock(&cache->active_lock);
David Howellsfee096d2009-11-19 18:12:05 +0000188 _leave(" = 0");
189 return 0;
David Howells9ae326a2009-04-03 16:42:41 +0100190
191 /* an old object from a previous incarnation is hogging the slot - we
192 * need to wait for it to be destroyed */
193wait_for_old_object:
David Howellsa30efe22014-09-30 14:50:30 +0100194 if (fscache_object_is_live(&xobject->fscache)) {
Fabian Frederick4e1eb882014-06-06 14:37:32 -0700195 pr_err("\n");
Fabian Frederick0227d6ab2014-06-06 14:37:33 -0700196 pr_err("Error: Unexpected object collision\n");
David Howellsd0e27b72009-11-19 18:12:02 +0000197 cachefiles_printk_object(object, xobject);
David Howells9ae326a2009-04-03 16:42:41 +0100198 BUG();
199 }
200 atomic_inc(&xobject->usage);
201 write_unlock(&cache->active_lock);
202
David Howellsfee096d2009-11-19 18:12:05 +0000203 if (test_bit(CACHEFILES_OBJECT_ACTIVE, &xobject->flags)) {
204 wait_queue_head_t *wq;
205
206 signed long timeout = 60 * HZ;
207 wait_queue_t wait;
208 bool requeue;
209
210 /* if the object we're waiting for is queued for processing,
211 * then just put ourselves on the queue behind it */
Tejun Heo8b8edef2010-07-20 22:09:01 +0200212 if (work_pending(&xobject->fscache.work)) {
David Howellsfee096d2009-11-19 18:12:05 +0000213 _debug("queue OBJ%x behind OBJ%x immediately",
214 object->fscache.debug_id,
215 xobject->fscache.debug_id);
216 goto requeue;
217 }
218
219 /* otherwise we sleep until either the object we're waiting for
Tejun Heo8b8edef2010-07-20 22:09:01 +0200220 * is done, or the fscache_object is congested */
David Howellsfee096d2009-11-19 18:12:05 +0000221 wq = bit_waitqueue(&xobject->flags, CACHEFILES_OBJECT_ACTIVE);
222 init_wait(&wait);
223 requeue = false;
224 do {
225 prepare_to_wait(wq, &wait, TASK_UNINTERRUPTIBLE);
226 if (!test_bit(CACHEFILES_OBJECT_ACTIVE, &xobject->flags))
227 break;
Tejun Heo8b8edef2010-07-20 22:09:01 +0200228
229 requeue = fscache_object_sleep_till_congested(&timeout);
David Howellsfee096d2009-11-19 18:12:05 +0000230 } while (timeout > 0 && !requeue);
231 finish_wait(wq, &wait);
232
233 if (requeue &&
234 test_bit(CACHEFILES_OBJECT_ACTIVE, &xobject->flags)) {
235 _debug("queue OBJ%x behind OBJ%x after wait",
236 object->fscache.debug_id,
237 xobject->fscache.debug_id);
238 goto requeue;
239 }
240
241 if (timeout <= 0) {
Fabian Frederick4e1eb882014-06-06 14:37:32 -0700242 pr_err("\n");
Fabian Frederick0227d6ab2014-06-06 14:37:33 -0700243 pr_err("Error: Overlong wait for old active object to go away\n");
David Howellsfee096d2009-11-19 18:12:05 +0000244 cachefiles_printk_object(object, xobject);
245 goto requeue;
246 }
247 }
248
249 ASSERT(!test_bit(CACHEFILES_OBJECT_ACTIVE, &xobject->flags));
David Howells9ae326a2009-04-03 16:42:41 +0100250
251 cache->cache.ops->put_object(&xobject->fscache);
252 goto try_again;
David Howellsfee096d2009-11-19 18:12:05 +0000253
254requeue:
255 clear_bit(CACHEFILES_OBJECT_ACTIVE, &object->flags);
256 cache->cache.ops->put_object(&xobject->fscache);
257 _leave(" = -ETIMEDOUT");
258 return -ETIMEDOUT;
David Howells9ae326a2009-04-03 16:42:41 +0100259}
260
261/*
David Howellsa5b3a802016-02-01 16:43:04 +0000262 * Mark an object as being inactive.
263 */
264void cachefiles_mark_object_inactive(struct cachefiles_cache *cache,
David Howellsa8181012016-08-09 17:41:16 +0100265 struct cachefiles_object *object,
266 blkcnt_t i_blocks)
David Howellsa5b3a802016-02-01 16:43:04 +0000267{
268 write_lock(&cache->active_lock);
269 rb_erase(&object->active_node, &cache->active_nodes);
270 clear_bit(CACHEFILES_OBJECT_ACTIVE, &object->flags);
271 write_unlock(&cache->active_lock);
272
273 wake_up_bit(&object->flags, CACHEFILES_OBJECT_ACTIVE);
274
275 /* This object can now be culled, so we need to let the daemon know
276 * that there is something it can remove if it needs to.
277 */
David Howellsdb20a892016-08-03 17:57:39 +0100278 atomic_long_add(i_blocks, &cache->b_released);
David Howellsa5b3a802016-02-01 16:43:04 +0000279 if (atomic_inc_return(&cache->f_released))
280 cachefiles_state_changed(cache);
281}
282
283/*
David Howells9ae326a2009-04-03 16:42:41 +0100284 * delete an object representation from the cache
285 * - file backed objects are unlinked
286 * - directory backed objects are stuffed into the graveyard for userspace to
287 * delete
288 * - unlocks the directory mutex
289 */
290static int cachefiles_bury_object(struct cachefiles_cache *cache,
291 struct dentry *dir,
David Howellsc61ea312010-05-11 16:51:39 +0100292 struct dentry *rep,
David Howells182d9192015-02-19 23:47:31 +0000293 bool preemptive,
294 enum fscache_why_object_killed why)
David Howells9ae326a2009-04-03 16:42:41 +0100295{
296 struct dentry *grave, *trap;
David Howells82140442010-12-24 14:48:35 +0000297 struct path path, path_to_graveyard;
David Howells9ae326a2009-04-03 16:42:41 +0100298 char nbuffer[8 + 8 + 1];
299 int ret;
300
Al Viroa4555892014-10-21 20:11:25 -0400301 _enter(",'%pd','%pd'", dir, rep);
David Howells9ae326a2009-04-03 16:42:41 +0100302
David Howellsc61ea312010-05-11 16:51:39 +0100303 _debug("remove %p from %p", rep, dir);
304
David Howells9ae326a2009-04-03 16:42:41 +0100305 /* non-directories can just be unlinked */
David Howellse36cb0b2015-01-29 12:02:35 +0000306 if (!d_is_dir(rep)) {
David Howells9ae326a2009-04-03 16:42:41 +0100307 _debug("unlink stale object");
David Howells9ae326a2009-04-03 16:42:41 +0100308
David Howells82140442010-12-24 14:48:35 +0000309 path.mnt = cache->mnt;
310 path.dentry = dir;
311 ret = security_path_unlink(&path, rep);
312 if (ret < 0) {
313 cachefiles_io_error(cache, "Unlink security error");
314 } else {
David Howells5153bc82015-03-06 14:08:58 +0000315 ret = vfs_unlink(d_inode(dir), rep, NULL);
David Howells82140442010-12-24 14:48:35 +0000316
317 if (preemptive)
David Howells182d9192015-02-19 23:47:31 +0000318 cachefiles_mark_object_buried(cache, rep, why);
David Howells82140442010-12-24 14:48:35 +0000319 }
David Howellsc61ea312010-05-11 16:51:39 +0100320
Al Viro59551022016-01-22 15:40:57 -0500321 inode_unlock(d_inode(dir));
David Howells9ae326a2009-04-03 16:42:41 +0100322
323 if (ret == -EIO)
324 cachefiles_io_error(cache, "Unlink failed");
325
326 _leave(" = %d", ret);
327 return ret;
328 }
329
330 /* directories have to be moved to the graveyard */
331 _debug("move stale object to graveyard");
Al Viro59551022016-01-22 15:40:57 -0500332 inode_unlock(d_inode(dir));
David Howells9ae326a2009-04-03 16:42:41 +0100333
334try_again:
335 /* first step is to make up a grave dentry in the graveyard */
336 sprintf(nbuffer, "%08x%08x",
337 (uint32_t) get_seconds(),
338 (uint32_t) atomic_inc_return(&cache->gravecounter));
339
340 /* do the multiway lock magic */
341 trap = lock_rename(cache->graveyard, dir);
342
343 /* do some checks before getting the grave dentry */
344 if (rep->d_parent != dir) {
345 /* the entry was probably culled when we dropped the parent dir
346 * lock */
347 unlock_rename(cache->graveyard, dir);
348 _leave(" = 0 [culled?]");
349 return 0;
350 }
351
David Howellsce40fa72015-01-29 12:02:36 +0000352 if (!d_can_lookup(cache->graveyard)) {
David Howells9ae326a2009-04-03 16:42:41 +0100353 unlock_rename(cache->graveyard, dir);
354 cachefiles_io_error(cache, "Graveyard no longer a directory");
355 return -EIO;
356 }
357
358 if (trap == rep) {
359 unlock_rename(cache->graveyard, dir);
360 cachefiles_io_error(cache, "May not make directory loop");
361 return -EIO;
362 }
363
364 if (d_mountpoint(rep)) {
365 unlock_rename(cache->graveyard, dir);
366 cachefiles_io_error(cache, "Mountpoint in cache");
367 return -EIO;
368 }
369
370 grave = lookup_one_len(nbuffer, cache->graveyard, strlen(nbuffer));
371 if (IS_ERR(grave)) {
372 unlock_rename(cache->graveyard, dir);
373
374 if (PTR_ERR(grave) == -ENOMEM) {
375 _leave(" = -ENOMEM");
376 return -ENOMEM;
377 }
378
379 cachefiles_io_error(cache, "Lookup error %ld",
380 PTR_ERR(grave));
381 return -EIO;
382 }
383
David Howells466b77b2015-03-17 22:26:21 +0000384 if (d_is_positive(grave)) {
David Howells9ae326a2009-04-03 16:42:41 +0100385 unlock_rename(cache->graveyard, dir);
386 dput(grave);
387 grave = NULL;
388 cond_resched();
389 goto try_again;
390 }
391
392 if (d_mountpoint(grave)) {
393 unlock_rename(cache->graveyard, dir);
394 dput(grave);
395 cachefiles_io_error(cache, "Mountpoint in graveyard");
396 return -EIO;
397 }
398
399 /* target should not be an ancestor of source */
400 if (trap == grave) {
401 unlock_rename(cache->graveyard, dir);
402 dput(grave);
403 cachefiles_io_error(cache, "May not make directory loop");
404 return -EIO;
405 }
406
407 /* attempt the rename */
David Howells82140442010-12-24 14:48:35 +0000408 path.mnt = cache->mnt;
409 path.dentry = dir;
410 path_to_graveyard.mnt = cache->mnt;
411 path_to_graveyard.dentry = cache->graveyard;
Miklos Szeredi0b3974e2014-04-01 17:08:43 +0200412 ret = security_path_rename(&path, rep, &path_to_graveyard, grave, 0);
David Howells82140442010-12-24 14:48:35 +0000413 if (ret < 0) {
414 cachefiles_io_error(cache, "Rename security error %d", ret);
415 } else {
David Howells5153bc82015-03-06 14:08:58 +0000416 ret = vfs_rename(d_inode(dir), rep,
417 d_inode(cache->graveyard), grave, NULL, 0);
David Howells82140442010-12-24 14:48:35 +0000418 if (ret != 0 && ret != -ENOMEM)
419 cachefiles_io_error(cache,
420 "Rename failed with error %d", ret);
David Howells9ae326a2009-04-03 16:42:41 +0100421
David Howells82140442010-12-24 14:48:35 +0000422 if (preemptive)
David Howells182d9192015-02-19 23:47:31 +0000423 cachefiles_mark_object_buried(cache, rep, why);
David Howells82140442010-12-24 14:48:35 +0000424 }
David Howellsc61ea312010-05-11 16:51:39 +0100425
David Howells9ae326a2009-04-03 16:42:41 +0100426 unlock_rename(cache->graveyard, dir);
427 dput(grave);
428 _leave(" = 0");
429 return 0;
430}
431
432/*
433 * delete an object representation from the cache
434 */
435int cachefiles_delete_object(struct cachefiles_cache *cache,
436 struct cachefiles_object *object)
437{
438 struct dentry *dir;
439 int ret;
440
David Howellsc61ea312010-05-11 16:51:39 +0100441 _enter(",OBJ%x{%p}", object->fscache.debug_id, object->dentry);
David Howells9ae326a2009-04-03 16:42:41 +0100442
443 ASSERT(object->dentry);
David Howells466b77b2015-03-17 22:26:21 +0000444 ASSERT(d_backing_inode(object->dentry));
David Howells9ae326a2009-04-03 16:42:41 +0100445 ASSERT(object->dentry->d_parent);
446
447 dir = dget_parent(object->dentry);
448
Al Viro59551022016-01-22 15:40:57 -0500449 inode_lock_nested(d_inode(dir), I_MUTEX_PARENT);
David Howells8f9941a2010-02-19 18:14:21 +0000450
David Howells182d9192015-02-19 23:47:31 +0000451 if (test_bit(FSCACHE_OBJECT_KILLED_BY_CACHE, &object->fscache.flags)) {
David Howellsc61ea312010-05-11 16:51:39 +0100452 /* object allocation for the same key preemptively deleted this
453 * object's file so that it could create its own file */
454 _debug("object preemptively buried");
Al Viro59551022016-01-22 15:40:57 -0500455 inode_unlock(d_inode(dir));
David Howells8f9941a2010-02-19 18:14:21 +0000456 ret = 0;
David Howellsc61ea312010-05-11 16:51:39 +0100457 } else {
458 /* we need to check that our parent is _still_ our parent - it
459 * may have been renamed */
460 if (dir == object->dentry->d_parent) {
461 ret = cachefiles_bury_object(cache, dir,
David Howells182d9192015-02-19 23:47:31 +0000462 object->dentry, false,
463 FSCACHE_OBJECT_WAS_RETIRED);
David Howellsc61ea312010-05-11 16:51:39 +0100464 } else {
465 /* it got moved, presumably by cachefilesd culling it,
466 * so it's no longer in the key path and we can ignore
467 * it */
Al Viro59551022016-01-22 15:40:57 -0500468 inode_unlock(d_inode(dir));
David Howellsc61ea312010-05-11 16:51:39 +0100469 ret = 0;
470 }
David Howells8f9941a2010-02-19 18:14:21 +0000471 }
David Howells9ae326a2009-04-03 16:42:41 +0100472
473 dput(dir);
474 _leave(" = %d", ret);
475 return ret;
476}
477
478/*
479 * walk from the parent object to the child object through the backing
480 * filesystem, creating directories as we go
481 */
482int cachefiles_walk_to_object(struct cachefiles_object *parent,
483 struct cachefiles_object *object,
484 const char *key,
485 struct cachefiles_xattr *auxdata)
486{
487 struct cachefiles_cache *cache;
488 struct dentry *dir, *next = NULL;
David Howells82140442010-12-24 14:48:35 +0000489 struct path path;
David Howells9ae326a2009-04-03 16:42:41 +0100490 unsigned long start;
491 const char *name;
492 int ret, nlen;
493
David Howellsc61ea312010-05-11 16:51:39 +0100494 _enter("OBJ%x{%p},OBJ%x,%s,",
495 parent->fscache.debug_id, parent->dentry,
496 object->fscache.debug_id, key);
David Howells9ae326a2009-04-03 16:42:41 +0100497
498 cache = container_of(parent->fscache.cache,
499 struct cachefiles_cache, cache);
David Howells82140442010-12-24 14:48:35 +0000500 path.mnt = cache->mnt;
David Howells9ae326a2009-04-03 16:42:41 +0100501
502 ASSERT(parent->dentry);
David Howells466b77b2015-03-17 22:26:21 +0000503 ASSERT(d_backing_inode(parent->dentry));
David Howells9ae326a2009-04-03 16:42:41 +0100504
David Howellse36cb0b2015-01-29 12:02:35 +0000505 if (!(d_is_dir(parent->dentry))) {
David Howells9ae326a2009-04-03 16:42:41 +0100506 // TODO: convert file to dir
507 _leave("looking up in none directory");
508 return -ENOBUFS;
509 }
510
511 dir = dget(parent->dentry);
512
513advance:
514 /* attempt to transit the first directory component */
515 name = key;
516 nlen = strlen(key);
517
518 /* key ends in a double NUL */
519 key = key + nlen + 1;
520 if (!*key)
521 key = NULL;
522
523lookup_again:
524 /* search the current directory for the element name */
525 _debug("lookup '%s'", name);
526
Al Viro59551022016-01-22 15:40:57 -0500527 inode_lock_nested(d_inode(dir), I_MUTEX_PARENT);
David Howells9ae326a2009-04-03 16:42:41 +0100528
529 start = jiffies;
530 next = lookup_one_len(name, dir, nlen);
531 cachefiles_hist(cachefiles_lookup_histogram, start);
532 if (IS_ERR(next))
533 goto lookup_error;
534
David Howells466b77b2015-03-17 22:26:21 +0000535 _debug("next -> %p %s", next, d_backing_inode(next) ? "positive" : "negative");
David Howells9ae326a2009-04-03 16:42:41 +0100536
537 if (!key)
David Howells466b77b2015-03-17 22:26:21 +0000538 object->new = !d_backing_inode(next);
David Howells9ae326a2009-04-03 16:42:41 +0100539
540 /* if this element of the path doesn't exist, then the lookup phase
541 * failed, and we can release any readers in the certain knowledge that
542 * there's nothing for them to actually read */
David Howells466b77b2015-03-17 22:26:21 +0000543 if (d_is_negative(next))
David Howells9ae326a2009-04-03 16:42:41 +0100544 fscache_object_lookup_negative(&object->fscache);
545
546 /* we need to create the object if it's negative */
547 if (key || object->type == FSCACHE_COOKIE_TYPE_INDEX) {
548 /* index objects and intervening tree levels must be subdirs */
David Howells466b77b2015-03-17 22:26:21 +0000549 if (d_is_negative(next)) {
David Howells9ae326a2009-04-03 16:42:41 +0100550 ret = cachefiles_has_space(cache, 1, 0);
551 if (ret < 0)
David Howells182d9192015-02-19 23:47:31 +0000552 goto no_space_error;
David Howells9ae326a2009-04-03 16:42:41 +0100553
David Howells82140442010-12-24 14:48:35 +0000554 path.dentry = dir;
555 ret = security_path_mkdir(&path, next, 0);
556 if (ret < 0)
557 goto create_error;
David Howells9ae326a2009-04-03 16:42:41 +0100558 start = jiffies;
David Howells5153bc82015-03-06 14:08:58 +0000559 ret = vfs_mkdir(d_inode(dir), next, 0);
David Howells9ae326a2009-04-03 16:42:41 +0100560 cachefiles_hist(cachefiles_mkdir_histogram, start);
561 if (ret < 0)
562 goto create_error;
563
David Howells466b77b2015-03-17 22:26:21 +0000564 ASSERT(d_backing_inode(next));
David Howells9ae326a2009-04-03 16:42:41 +0100565
566 _debug("mkdir -> %p{%p{ino=%lu}}",
David Howells466b77b2015-03-17 22:26:21 +0000567 next, d_backing_inode(next), d_backing_inode(next)->i_ino);
David Howells9ae326a2009-04-03 16:42:41 +0100568
David Howellsce40fa72015-01-29 12:02:36 +0000569 } else if (!d_can_lookup(next)) {
Fabian Frederick6ff66ac2014-09-25 16:05:27 -0700570 pr_err("inode %lu is not a directory\n",
David Howells466b77b2015-03-17 22:26:21 +0000571 d_backing_inode(next)->i_ino);
David Howells9ae326a2009-04-03 16:42:41 +0100572 ret = -ENOBUFS;
573 goto error;
574 }
575
576 } else {
577 /* non-index objects start out life as files */
David Howells466b77b2015-03-17 22:26:21 +0000578 if (d_is_negative(next)) {
David Howells9ae326a2009-04-03 16:42:41 +0100579 ret = cachefiles_has_space(cache, 1, 0);
580 if (ret < 0)
David Howells182d9192015-02-19 23:47:31 +0000581 goto no_space_error;
David Howells9ae326a2009-04-03 16:42:41 +0100582
David Howells82140442010-12-24 14:48:35 +0000583 path.dentry = dir;
584 ret = security_path_mknod(&path, next, S_IFREG, 0);
585 if (ret < 0)
586 goto create_error;
David Howells9ae326a2009-04-03 16:42:41 +0100587 start = jiffies;
David Howells5153bc82015-03-06 14:08:58 +0000588 ret = vfs_create(d_inode(dir), next, S_IFREG, true);
David Howells9ae326a2009-04-03 16:42:41 +0100589 cachefiles_hist(cachefiles_create_histogram, start);
590 if (ret < 0)
591 goto create_error;
592
David Howells466b77b2015-03-17 22:26:21 +0000593 ASSERT(d_backing_inode(next));
David Howells9ae326a2009-04-03 16:42:41 +0100594
595 _debug("create -> %p{%p{ino=%lu}}",
David Howells466b77b2015-03-17 22:26:21 +0000596 next, d_backing_inode(next), d_backing_inode(next)->i_ino);
David Howells9ae326a2009-04-03 16:42:41 +0100597
David Howellsce40fa72015-01-29 12:02:36 +0000598 } else if (!d_can_lookup(next) &&
David Howellse36cb0b2015-01-29 12:02:35 +0000599 !d_is_reg(next)
David Howells9ae326a2009-04-03 16:42:41 +0100600 ) {
Fabian Frederick6ff66ac2014-09-25 16:05:27 -0700601 pr_err("inode %lu is not a file or directory\n",
David Howells466b77b2015-03-17 22:26:21 +0000602 d_backing_inode(next)->i_ino);
David Howells9ae326a2009-04-03 16:42:41 +0100603 ret = -ENOBUFS;
604 goto error;
605 }
606 }
607
608 /* process the next component */
609 if (key) {
610 _debug("advance");
Al Viro59551022016-01-22 15:40:57 -0500611 inode_unlock(d_inode(dir));
David Howells9ae326a2009-04-03 16:42:41 +0100612 dput(dir);
613 dir = next;
614 next = NULL;
615 goto advance;
616 }
617
618 /* we've found the object we were looking for */
619 object->dentry = next;
620
621 /* if we've found that the terminal object exists, then we need to
622 * check its attributes and delete it if it's out of date */
623 if (!object->new) {
Al Viroa4555892014-10-21 20:11:25 -0400624 _debug("validate '%pd'", next);
David Howells9ae326a2009-04-03 16:42:41 +0100625
626 ret = cachefiles_check_object_xattr(object, auxdata);
627 if (ret == -ESTALE) {
628 /* delete the object (the deleter drops the directory
629 * mutex) */
630 object->dentry = NULL;
631
David Howells182d9192015-02-19 23:47:31 +0000632 ret = cachefiles_bury_object(cache, dir, next, true,
633 FSCACHE_OBJECT_IS_STALE);
David Howells9ae326a2009-04-03 16:42:41 +0100634 dput(next);
635 next = NULL;
636
637 if (ret < 0)
638 goto delete_error;
639
640 _debug("redo lookup");
David Howells182d9192015-02-19 23:47:31 +0000641 fscache_object_retrying_stale(&object->fscache);
David Howells9ae326a2009-04-03 16:42:41 +0100642 goto lookup_again;
643 }
644 }
645
646 /* note that we're now using this object */
David Howellsfee096d2009-11-19 18:12:05 +0000647 ret = cachefiles_mark_object_active(cache, object);
David Howells9ae326a2009-04-03 16:42:41 +0100648
Al Viro59551022016-01-22 15:40:57 -0500649 inode_unlock(d_inode(dir));
David Howells9ae326a2009-04-03 16:42:41 +0100650 dput(dir);
651 dir = NULL;
652
David Howellsfee096d2009-11-19 18:12:05 +0000653 if (ret == -ETIMEDOUT)
654 goto mark_active_timed_out;
655
David Howells9ae326a2009-04-03 16:42:41 +0100656 _debug("=== OBTAINED_OBJECT ===");
657
658 if (object->new) {
659 /* attach data to a newly constructed terminal object */
660 ret = cachefiles_set_object_xattr(object, auxdata);
661 if (ret < 0)
662 goto check_error;
663 } else {
664 /* always update the atime on an object we've just looked up
665 * (this is used to keep track of culling, and atimes are only
666 * updated by read, write and readdir but not lookup or
667 * open) */
Al Viro68ac1232012-03-15 08:21:57 -0400668 path.dentry = next;
669 touch_atime(&path);
David Howells9ae326a2009-04-03 16:42:41 +0100670 }
671
672 /* open a file interface onto a data file */
673 if (object->type != FSCACHE_COOKIE_TYPE_INDEX) {
David Howellse36cb0b2015-01-29 12:02:35 +0000674 if (d_is_reg(object->dentry)) {
David Howells9ae326a2009-04-03 16:42:41 +0100675 const struct address_space_operations *aops;
676
677 ret = -EPERM;
David Howells466b77b2015-03-17 22:26:21 +0000678 aops = d_backing_inode(object->dentry)->i_mapping->a_ops;
David Howells9ae326a2009-04-03 16:42:41 +0100679 if (!aops->bmap)
680 goto check_error;
NeilBrown95201a42015-11-04 15:20:34 +0000681 if (object->dentry->d_sb->s_blocksize > PAGE_SIZE)
682 goto check_error;
David Howells9ae326a2009-04-03 16:42:41 +0100683
684 object->backer = object->dentry;
685 } else {
686 BUG(); // TODO: open file in data-class subdir
687 }
688 }
689
690 object->new = 0;
691 fscache_obtained_object(&object->fscache);
692
David Howells466b77b2015-03-17 22:26:21 +0000693 _leave(" = 0 [%lu]", d_backing_inode(object->dentry)->i_ino);
David Howells9ae326a2009-04-03 16:42:41 +0100694 return 0;
695
David Howells182d9192015-02-19 23:47:31 +0000696no_space_error:
697 fscache_object_mark_killed(&object->fscache, FSCACHE_OBJECT_NO_SPACE);
David Howells9ae326a2009-04-03 16:42:41 +0100698create_error:
699 _debug("create error %d", ret);
700 if (ret == -EIO)
701 cachefiles_io_error(cache, "Create/mkdir failed");
702 goto error;
703
David Howellsfee096d2009-11-19 18:12:05 +0000704mark_active_timed_out:
705 _debug("mark active timed out");
706 goto release_dentry;
707
David Howells9ae326a2009-04-03 16:42:41 +0100708check_error:
709 _debug("check error %d", ret);
David Howellsa8181012016-08-09 17:41:16 +0100710 cachefiles_mark_object_inactive(
711 cache, object, d_backing_inode(object->dentry)->i_blocks);
David Howellsfee096d2009-11-19 18:12:05 +0000712release_dentry:
David Howells9ae326a2009-04-03 16:42:41 +0100713 dput(object->dentry);
714 object->dentry = NULL;
715 goto error_out;
716
717delete_error:
718 _debug("delete error %d", ret);
719 goto error_out2;
720
721lookup_error:
722 _debug("lookup error %ld", PTR_ERR(next));
723 ret = PTR_ERR(next);
724 if (ret == -EIO)
725 cachefiles_io_error(cache, "Lookup failed");
726 next = NULL;
727error:
Al Viro59551022016-01-22 15:40:57 -0500728 inode_unlock(d_inode(dir));
David Howells9ae326a2009-04-03 16:42:41 +0100729 dput(next);
730error_out2:
731 dput(dir);
732error_out:
David Howells9ae326a2009-04-03 16:42:41 +0100733 _leave(" = error %d", -ret);
734 return ret;
735}
736
737/*
738 * get a subdirectory
739 */
740struct dentry *cachefiles_get_directory(struct cachefiles_cache *cache,
741 struct dentry *dir,
742 const char *dirname)
743{
744 struct dentry *subdir;
745 unsigned long start;
David Howells82140442010-12-24 14:48:35 +0000746 struct path path;
David Howells9ae326a2009-04-03 16:42:41 +0100747 int ret;
748
749 _enter(",,%s", dirname);
750
751 /* search the current directory for the element name */
Al Viro59551022016-01-22 15:40:57 -0500752 inode_lock(d_inode(dir));
David Howells9ae326a2009-04-03 16:42:41 +0100753
754 start = jiffies;
755 subdir = lookup_one_len(dirname, dir, strlen(dirname));
756 cachefiles_hist(cachefiles_lookup_histogram, start);
757 if (IS_ERR(subdir)) {
758 if (PTR_ERR(subdir) == -ENOMEM)
759 goto nomem_d_alloc;
760 goto lookup_error;
761 }
762
763 _debug("subdir -> %p %s",
David Howells466b77b2015-03-17 22:26:21 +0000764 subdir, d_backing_inode(subdir) ? "positive" : "negative");
David Howells9ae326a2009-04-03 16:42:41 +0100765
766 /* we need to create the subdir if it doesn't exist yet */
David Howells466b77b2015-03-17 22:26:21 +0000767 if (d_is_negative(subdir)) {
David Howells9ae326a2009-04-03 16:42:41 +0100768 ret = cachefiles_has_space(cache, 1, 0);
769 if (ret < 0)
770 goto mkdir_error;
771
772 _debug("attempt mkdir");
773
David Howells82140442010-12-24 14:48:35 +0000774 path.mnt = cache->mnt;
775 path.dentry = dir;
776 ret = security_path_mkdir(&path, subdir, 0700);
777 if (ret < 0)
778 goto mkdir_error;
David Howells5153bc82015-03-06 14:08:58 +0000779 ret = vfs_mkdir(d_inode(dir), subdir, 0700);
David Howells9ae326a2009-04-03 16:42:41 +0100780 if (ret < 0)
781 goto mkdir_error;
782
David Howells466b77b2015-03-17 22:26:21 +0000783 ASSERT(d_backing_inode(subdir));
David Howells9ae326a2009-04-03 16:42:41 +0100784
785 _debug("mkdir -> %p{%p{ino=%lu}}",
786 subdir,
David Howells466b77b2015-03-17 22:26:21 +0000787 d_backing_inode(subdir),
788 d_backing_inode(subdir)->i_ino);
David Howells9ae326a2009-04-03 16:42:41 +0100789 }
790
Al Viro59551022016-01-22 15:40:57 -0500791 inode_unlock(d_inode(dir));
David Howells9ae326a2009-04-03 16:42:41 +0100792
793 /* we need to make sure the subdir is a directory */
David Howells466b77b2015-03-17 22:26:21 +0000794 ASSERT(d_backing_inode(subdir));
David Howells9ae326a2009-04-03 16:42:41 +0100795
David Howellsce40fa72015-01-29 12:02:36 +0000796 if (!d_can_lookup(subdir)) {
Fabian Frederick6ff66ac2014-09-25 16:05:27 -0700797 pr_err("%s is not a directory\n", dirname);
David Howells9ae326a2009-04-03 16:42:41 +0100798 ret = -EIO;
799 goto check_error;
800 }
801
802 ret = -EPERM;
Andreas Gruenbacher5d6c3192016-09-29 17:48:42 +0200803 if (!(d_backing_inode(subdir)->i_opflags & IOP_XATTR) ||
David Howells466b77b2015-03-17 22:26:21 +0000804 !d_backing_inode(subdir)->i_op->lookup ||
805 !d_backing_inode(subdir)->i_op->mkdir ||
806 !d_backing_inode(subdir)->i_op->create ||
807 (!d_backing_inode(subdir)->i_op->rename &&
808 !d_backing_inode(subdir)->i_op->rename2) ||
809 !d_backing_inode(subdir)->i_op->rmdir ||
810 !d_backing_inode(subdir)->i_op->unlink)
David Howells9ae326a2009-04-03 16:42:41 +0100811 goto check_error;
812
David Howells466b77b2015-03-17 22:26:21 +0000813 _leave(" = [%lu]", d_backing_inode(subdir)->i_ino);
David Howells9ae326a2009-04-03 16:42:41 +0100814 return subdir;
815
816check_error:
817 dput(subdir);
818 _leave(" = %d [check]", ret);
819 return ERR_PTR(ret);
820
821mkdir_error:
Al Viro59551022016-01-22 15:40:57 -0500822 inode_unlock(d_inode(dir));
David Howells9ae326a2009-04-03 16:42:41 +0100823 dput(subdir);
Fabian Frederick6ff66ac2014-09-25 16:05:27 -0700824 pr_err("mkdir %s failed with error %d\n", dirname, ret);
David Howells9ae326a2009-04-03 16:42:41 +0100825 return ERR_PTR(ret);
826
827lookup_error:
Al Viro59551022016-01-22 15:40:57 -0500828 inode_unlock(d_inode(dir));
David Howells9ae326a2009-04-03 16:42:41 +0100829 ret = PTR_ERR(subdir);
Fabian Frederick6ff66ac2014-09-25 16:05:27 -0700830 pr_err("Lookup %s failed with error %d\n", dirname, ret);
David Howells9ae326a2009-04-03 16:42:41 +0100831 return ERR_PTR(ret);
832
833nomem_d_alloc:
Al Viro59551022016-01-22 15:40:57 -0500834 inode_unlock(d_inode(dir));
David Howells9ae326a2009-04-03 16:42:41 +0100835 _leave(" = -ENOMEM");
836 return ERR_PTR(-ENOMEM);
837}
838
839/*
840 * find out if an object is in use or not
841 * - if finds object and it's not in use:
842 * - returns a pointer to the object and a reference on it
843 * - returns with the directory locked
844 */
845static struct dentry *cachefiles_check_active(struct cachefiles_cache *cache,
846 struct dentry *dir,
847 char *filename)
848{
849 struct cachefiles_object *object;
850 struct rb_node *_n;
851 struct dentry *victim;
852 unsigned long start;
853 int ret;
854
Al Viroa4555892014-10-21 20:11:25 -0400855 //_enter(",%pd/,%s",
856 // dir, filename);
David Howells9ae326a2009-04-03 16:42:41 +0100857
858 /* look up the victim */
Al Viro59551022016-01-22 15:40:57 -0500859 inode_lock_nested(d_inode(dir), I_MUTEX_PARENT);
David Howells9ae326a2009-04-03 16:42:41 +0100860
861 start = jiffies;
862 victim = lookup_one_len(filename, dir, strlen(filename));
863 cachefiles_hist(cachefiles_lookup_histogram, start);
864 if (IS_ERR(victim))
865 goto lookup_error;
866
867 //_debug("victim -> %p %s",
David Howells466b77b2015-03-17 22:26:21 +0000868 // victim, d_backing_inode(victim) ? "positive" : "negative");
David Howells9ae326a2009-04-03 16:42:41 +0100869
870 /* if the object is no longer there then we probably retired the object
871 * at the netfs's request whilst the cull was in progress
872 */
David Howells466b77b2015-03-17 22:26:21 +0000873 if (d_is_negative(victim)) {
Al Viro59551022016-01-22 15:40:57 -0500874 inode_unlock(d_inode(dir));
David Howells9ae326a2009-04-03 16:42:41 +0100875 dput(victim);
876 _leave(" = -ENOENT [absent]");
877 return ERR_PTR(-ENOENT);
878 }
879
880 /* check to see if we're using this object */
881 read_lock(&cache->active_lock);
882
883 _n = cache->active_nodes.rb_node;
884
885 while (_n) {
886 object = rb_entry(_n, struct cachefiles_object, active_node);
887
888 if (object->dentry > victim)
889 _n = _n->rb_left;
890 else if (object->dentry < victim)
891 _n = _n->rb_right;
892 else
893 goto object_in_use;
894 }
895
896 read_unlock(&cache->active_lock);
897
898 //_leave(" = %p", victim);
899 return victim;
900
901object_in_use:
902 read_unlock(&cache->active_lock);
Al Viro59551022016-01-22 15:40:57 -0500903 inode_unlock(d_inode(dir));
David Howells9ae326a2009-04-03 16:42:41 +0100904 dput(victim);
905 //_leave(" = -EBUSY [in use]");
906 return ERR_PTR(-EBUSY);
907
908lookup_error:
Al Viro59551022016-01-22 15:40:57 -0500909 inode_unlock(d_inode(dir));
David Howells9ae326a2009-04-03 16:42:41 +0100910 ret = PTR_ERR(victim);
911 if (ret == -ENOENT) {
912 /* file or dir now absent - probably retired by netfs */
913 _leave(" = -ESTALE [absent]");
914 return ERR_PTR(-ESTALE);
915 }
916
917 if (ret == -EIO) {
918 cachefiles_io_error(cache, "Lookup failed");
919 } else if (ret != -ENOMEM) {
Fabian Frederick6ff66ac2014-09-25 16:05:27 -0700920 pr_err("Internal error: %d\n", ret);
David Howells9ae326a2009-04-03 16:42:41 +0100921 ret = -EIO;
922 }
923
924 _leave(" = %d", ret);
925 return ERR_PTR(ret);
926}
927
928/*
929 * cull an object if it's not in use
930 * - called only by cache manager daemon
931 */
932int cachefiles_cull(struct cachefiles_cache *cache, struct dentry *dir,
933 char *filename)
934{
935 struct dentry *victim;
936 int ret;
937
Al Viroa4555892014-10-21 20:11:25 -0400938 _enter(",%pd/,%s", dir, filename);
David Howells9ae326a2009-04-03 16:42:41 +0100939
940 victim = cachefiles_check_active(cache, dir, filename);
941 if (IS_ERR(victim))
942 return PTR_ERR(victim);
943
944 _debug("victim -> %p %s",
David Howells466b77b2015-03-17 22:26:21 +0000945 victim, d_backing_inode(victim) ? "positive" : "negative");
David Howells9ae326a2009-04-03 16:42:41 +0100946
947 /* okay... the victim is not being used so we can cull it
948 * - start by marking it as stale
949 */
950 _debug("victim is cullable");
951
952 ret = cachefiles_remove_object_xattr(cache, victim);
953 if (ret < 0)
954 goto error_unlock;
955
956 /* actually remove the victim (drops the dir mutex) */
957 _debug("bury");
958
David Howells182d9192015-02-19 23:47:31 +0000959 ret = cachefiles_bury_object(cache, dir, victim, false,
960 FSCACHE_OBJECT_WAS_CULLED);
David Howells9ae326a2009-04-03 16:42:41 +0100961 if (ret < 0)
962 goto error;
963
964 dput(victim);
965 _leave(" = 0");
966 return 0;
967
968error_unlock:
Al Viro59551022016-01-22 15:40:57 -0500969 inode_unlock(d_inode(dir));
David Howells9ae326a2009-04-03 16:42:41 +0100970error:
971 dput(victim);
972 if (ret == -ENOENT) {
973 /* file or dir now absent - probably retired by netfs */
974 _leave(" = -ESTALE [absent]");
975 return -ESTALE;
976 }
977
978 if (ret != -ENOMEM) {
Fabian Frederick6ff66ac2014-09-25 16:05:27 -0700979 pr_err("Internal error: %d\n", ret);
David Howells9ae326a2009-04-03 16:42:41 +0100980 ret = -EIO;
981 }
982
983 _leave(" = %d", ret);
984 return ret;
985}
986
987/*
988 * find out if an object is in use or not
989 * - called only by cache manager daemon
990 * - returns -EBUSY or 0 to indicate whether an object is in use or not
991 */
992int cachefiles_check_in_use(struct cachefiles_cache *cache, struct dentry *dir,
993 char *filename)
994{
995 struct dentry *victim;
996
Al Viroa4555892014-10-21 20:11:25 -0400997 //_enter(",%pd/,%s",
998 // dir, filename);
David Howells9ae326a2009-04-03 16:42:41 +0100999
1000 victim = cachefiles_check_active(cache, dir, filename);
1001 if (IS_ERR(victim))
1002 return PTR_ERR(victim);
1003
Al Viro59551022016-01-22 15:40:57 -05001004 inode_unlock(d_inode(dir));
David Howells9ae326a2009-04-03 16:42:41 +01001005 dput(victim);
1006 //_leave(" = 0");
1007 return 0;
1008}