fs: dcache rationalise dget variants
[linux-2.6.git] / fs / ocfs2 / dcache.c
1 /* -*- mode: c; c-basic-offset: 8; -*-
2  * vim: noexpandtab sw=8 ts=8 sts=0:
3  *
4  * dcache.c
5  *
6  * dentry cache handling code
7  *
8  * Copyright (C) 2002, 2004 Oracle.  All rights reserved.
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public
12  * License as published by the Free Software Foundation; either
13  * version 2 of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public
21  * License along with this program; if not, write to the
22  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23  * Boston, MA 021110-1307, USA.
24  */
25
26 #include <linux/fs.h>
27 #include <linux/types.h>
28 #include <linux/slab.h>
29 #include <linux/namei.h>
30
31 #define MLOG_MASK_PREFIX ML_DCACHE
32 #include <cluster/masklog.h>
33
34 #include "ocfs2.h"
35
36 #include "alloc.h"
37 #include "dcache.h"
38 #include "dlmglue.h"
39 #include "file.h"
40 #include "inode.h"
41 #include "super.h"
42
43 void ocfs2_dentry_attach_gen(struct dentry *dentry)
44 {
45         unsigned long gen =
46                 OCFS2_I(dentry->d_parent->d_inode)->ip_dir_lock_gen;
47         BUG_ON(dentry->d_inode);
48         dentry->d_fsdata = (void *)gen;
49 }
50
51
52 static int ocfs2_dentry_revalidate(struct dentry *dentry,
53                                    struct nameidata *nd)
54 {
55         struct inode *inode = dentry->d_inode;
56         int ret = 0;    /* if all else fails, just return false */
57         struct ocfs2_super *osb = OCFS2_SB(dentry->d_sb);
58
59         mlog_entry("(0x%p, '%.*s')\n", dentry,
60                    dentry->d_name.len, dentry->d_name.name);
61
62         /* For a negative dentry -
63          * check the generation number of the parent and compare with the
64          * one stored in the inode.
65          */
66         if (inode == NULL) {
67                 unsigned long gen = (unsigned long) dentry->d_fsdata;
68                 unsigned long pgen =
69                         OCFS2_I(dentry->d_parent->d_inode)->ip_dir_lock_gen;
70                 mlog(0, "negative dentry: %.*s parent gen: %lu "
71                         "dentry gen: %lu\n",
72                         dentry->d_name.len, dentry->d_name.name, pgen, gen);
73                 if (gen != pgen)
74                         goto bail;
75                 goto valid;
76         }
77
78         BUG_ON(!osb);
79
80         if (inode == osb->root_inode || is_bad_inode(inode))
81                 goto bail;
82
83         spin_lock(&OCFS2_I(inode)->ip_lock);
84         /* did we or someone else delete this inode? */
85         if (OCFS2_I(inode)->ip_flags & OCFS2_INODE_DELETED) {
86                 spin_unlock(&OCFS2_I(inode)->ip_lock);
87                 mlog(0, "inode (%llu) deleted, returning false\n",
88                      (unsigned long long)OCFS2_I(inode)->ip_blkno);
89                 goto bail;
90         }
91         spin_unlock(&OCFS2_I(inode)->ip_lock);
92
93         /*
94          * We don't need a cluster lock to test this because once an
95          * inode nlink hits zero, it never goes back.
96          */
97         if (inode->i_nlink == 0) {
98                 mlog(0, "Inode %llu orphaned, returning false "
99                      "dir = %d\n",
100                      (unsigned long long)OCFS2_I(inode)->ip_blkno,
101                      S_ISDIR(inode->i_mode));
102                 goto bail;
103         }
104
105         /*
106          * If the last lookup failed to create dentry lock, let us
107          * redo it.
108          */
109         if (!dentry->d_fsdata) {
110                 mlog(0, "Inode %llu doesn't have dentry lock, "
111                      "returning false\n",
112                      (unsigned long long)OCFS2_I(inode)->ip_blkno);
113                 goto bail;
114         }
115
116 valid:
117         ret = 1;
118
119 bail:
120         mlog_exit(ret);
121
122         return ret;
123 }
124
125 static int ocfs2_match_dentry(struct dentry *dentry,
126                               u64 parent_blkno,
127                               int skip_unhashed)
128 {
129         struct inode *parent;
130
131         /*
132          * ocfs2_lookup() does a d_splice_alias() _before_ attaching
133          * to the lock data, so we skip those here, otherwise
134          * ocfs2_dentry_attach_lock() will get its original dentry
135          * back.
136          */
137         if (!dentry->d_fsdata)
138                 return 0;
139
140         if (!dentry->d_parent)
141                 return 0;
142
143         if (skip_unhashed && d_unhashed(dentry))
144                 return 0;
145
146         parent = dentry->d_parent->d_inode;
147         /* Negative parent dentry? */
148         if (!parent)
149                 return 0;
150
151         /* Name is in a different directory. */
152         if (OCFS2_I(parent)->ip_blkno != parent_blkno)
153                 return 0;
154
155         return 1;
156 }
157
158 /*
159  * Walk the inode alias list, and find a dentry which has a given
160  * parent. ocfs2_dentry_attach_lock() wants to find _any_ alias as it
161  * is looking for a dentry_lock reference. The downconvert thread is
162  * looking to unhash aliases, so we allow it to skip any that already
163  * have that property.
164  */
165 struct dentry *ocfs2_find_local_alias(struct inode *inode,
166                                       u64 parent_blkno,
167                                       int skip_unhashed)
168 {
169         struct list_head *p;
170         struct dentry *dentry = NULL;
171
172         spin_lock(&dcache_inode_lock);
173         list_for_each(p, &inode->i_dentry) {
174                 dentry = list_entry(p, struct dentry, d_alias);
175
176                 spin_lock(&dentry->d_lock);
177                 if (ocfs2_match_dentry(dentry, parent_blkno, skip_unhashed)) {
178                         mlog(0, "dentry found: %.*s\n",
179                              dentry->d_name.len, dentry->d_name.name);
180
181                         dget_dlock(dentry);
182                         spin_unlock(&dentry->d_lock);
183                         break;
184                 }
185                 spin_unlock(&dentry->d_lock);
186
187                 dentry = NULL;
188         }
189
190         spin_unlock(&dcache_inode_lock);
191
192         return dentry;
193 }
194
195 DEFINE_SPINLOCK(dentry_attach_lock);
196
197 /*
198  * Attach this dentry to a cluster lock.
199  *
200  * Dentry locks cover all links in a given directory to a particular
201  * inode. We do this so that ocfs2 can build a lock name which all
202  * nodes in the cluster can agree on at all times. Shoving full names
203  * in the cluster lock won't work due to size restrictions. Covering
204  * links inside of a directory is a good compromise because it still
205  * allows us to use the parent directory lock to synchronize
206  * operations.
207  *
208  * Call this function with the parent dir semaphore and the parent dir
209  * cluster lock held.
210  *
211  * The dir semaphore will protect us from having to worry about
212  * concurrent processes on our node trying to attach a lock at the
213  * same time.
214  *
215  * The dir cluster lock (held at either PR or EX mode) protects us
216  * from unlink and rename on other nodes.
217  *
218  * A dput() can happen asynchronously due to pruning, so we cover
219  * attaching and detaching the dentry lock with a
220  * dentry_attach_lock.
221  *
222  * A node which has done lookup on a name retains a protected read
223  * lock until final dput. If the user requests and unlink or rename,
224  * the protected read is upgraded to an exclusive lock. Other nodes
225  * who have seen the dentry will then be informed that they need to
226  * downgrade their lock, which will involve d_delete on the
227  * dentry. This happens in ocfs2_dentry_convert_worker().
228  */
229 int ocfs2_dentry_attach_lock(struct dentry *dentry,
230                              struct inode *inode,
231                              u64 parent_blkno)
232 {
233         int ret;
234         struct dentry *alias;
235         struct ocfs2_dentry_lock *dl = dentry->d_fsdata;
236
237         mlog(0, "Attach \"%.*s\", parent %llu, fsdata: %p\n",
238              dentry->d_name.len, dentry->d_name.name,
239              (unsigned long long)parent_blkno, dl);
240
241         /*
242          * Negative dentry. We ignore these for now.
243          *
244          * XXX: Could we can improve ocfs2_dentry_revalidate() by
245          * tracking these?
246          */
247         if (!inode)
248                 return 0;
249
250         if (!dentry->d_inode && dentry->d_fsdata) {
251                 /* Converting a negative dentry to positive
252                    Clear dentry->d_fsdata */
253                 dentry->d_fsdata = dl = NULL;
254         }
255
256         if (dl) {
257                 mlog_bug_on_msg(dl->dl_parent_blkno != parent_blkno,
258                                 " \"%.*s\": old parent: %llu, new: %llu\n",
259                                 dentry->d_name.len, dentry->d_name.name,
260                                 (unsigned long long)parent_blkno,
261                                 (unsigned long long)dl->dl_parent_blkno);
262                 return 0;
263         }
264
265         alias = ocfs2_find_local_alias(inode, parent_blkno, 0);
266         if (alias) {
267                 /*
268                  * Great, an alias exists, which means we must have a
269                  * dentry lock already. We can just grab the lock off
270                  * the alias and add it to the list.
271                  *
272                  * We're depending here on the fact that this dentry
273                  * was found and exists in the dcache and so must have
274                  * a reference to the dentry_lock because we can't
275                  * race creates. Final dput() cannot happen on it
276                  * since we have it pinned, so our reference is safe.
277                  */
278                 dl = alias->d_fsdata;
279                 mlog_bug_on_msg(!dl, "parent %llu, ino %llu\n",
280                                 (unsigned long long)parent_blkno,
281                                 (unsigned long long)OCFS2_I(inode)->ip_blkno);
282
283                 mlog_bug_on_msg(dl->dl_parent_blkno != parent_blkno,
284                                 " \"%.*s\": old parent: %llu, new: %llu\n",
285                                 dentry->d_name.len, dentry->d_name.name,
286                                 (unsigned long long)parent_blkno,
287                                 (unsigned long long)dl->dl_parent_blkno);
288
289                 mlog(0, "Found: %s\n", dl->dl_lockres.l_name);
290
291                 goto out_attach;
292         }
293
294         /*
295          * There are no other aliases
296          */
297         dl = kmalloc(sizeof(*dl), GFP_NOFS);
298         if (!dl) {
299                 ret = -ENOMEM;
300                 mlog_errno(ret);
301                 return ret;
302         }
303
304         dl->dl_count = 0;
305         /*
306          * Does this have to happen below, for all attaches, in case
307          * the struct inode gets blown away by the downconvert thread?
308          */
309         dl->dl_inode = igrab(inode);
310         dl->dl_parent_blkno = parent_blkno;
311         ocfs2_dentry_lock_res_init(dl, parent_blkno, inode);
312
313 out_attach:
314         spin_lock(&dentry_attach_lock);
315         dentry->d_fsdata = dl;
316         dl->dl_count++;
317         spin_unlock(&dentry_attach_lock);
318
319         /*
320          * This actually gets us our PRMODE level lock. From now on,
321          * we'll have a notification if one of these names is
322          * destroyed on another node.
323          */
324         ret = ocfs2_dentry_lock(dentry, 0);
325         if (!ret)
326                 ocfs2_dentry_unlock(dentry, 0);
327         else
328                 mlog_errno(ret);
329
330         /*
331          * In case of error, manually free the allocation and do the iput().
332          * We need to do this because error here means no d_instantiate(),
333          * which means iput() will not be called during dput(dentry).
334          */
335         if (ret < 0 && !alias) {
336                 ocfs2_lock_res_free(&dl->dl_lockres);
337                 BUG_ON(dl->dl_count != 1);
338                 spin_lock(&dentry_attach_lock);
339                 dentry->d_fsdata = NULL;
340                 spin_unlock(&dentry_attach_lock);
341                 kfree(dl);
342                 iput(inode);
343         }
344
345         dput(alias);
346
347         return ret;
348 }
349
350 DEFINE_SPINLOCK(dentry_list_lock);
351
352 /* We limit the number of dentry locks to drop in one go. We have
353  * this limit so that we don't starve other users of ocfs2_wq. */
354 #define DL_INODE_DROP_COUNT 64
355
356 /* Drop inode references from dentry locks */
357 static void __ocfs2_drop_dl_inodes(struct ocfs2_super *osb, int drop_count)
358 {
359         struct ocfs2_dentry_lock *dl;
360
361         spin_lock(&dentry_list_lock);
362         while (osb->dentry_lock_list && (drop_count < 0 || drop_count--)) {
363                 dl = osb->dentry_lock_list;
364                 osb->dentry_lock_list = dl->dl_next;
365                 spin_unlock(&dentry_list_lock);
366                 iput(dl->dl_inode);
367                 kfree(dl);
368                 spin_lock(&dentry_list_lock);
369         }
370         spin_unlock(&dentry_list_lock);
371 }
372
373 void ocfs2_drop_dl_inodes(struct work_struct *work)
374 {
375         struct ocfs2_super *osb = container_of(work, struct ocfs2_super,
376                                                dentry_lock_work);
377
378         __ocfs2_drop_dl_inodes(osb, DL_INODE_DROP_COUNT);
379         /*
380          * Don't queue dropping if umount is in progress. We flush the
381          * list in ocfs2_dismount_volume
382          */
383         spin_lock(&dentry_list_lock);
384         if (osb->dentry_lock_list &&
385             !ocfs2_test_osb_flag(osb, OCFS2_OSB_DROP_DENTRY_LOCK_IMMED))
386                 queue_work(ocfs2_wq, &osb->dentry_lock_work);
387         spin_unlock(&dentry_list_lock);
388 }
389
390 /* Flush the whole work queue */
391 void ocfs2_drop_all_dl_inodes(struct ocfs2_super *osb)
392 {
393         __ocfs2_drop_dl_inodes(osb, -1);
394 }
395
396 /*
397  * ocfs2_dentry_iput() and friends.
398  *
399  * At this point, our particular dentry is detached from the inodes
400  * alias list, so there's no way that the locking code can find it.
401  *
402  * The interesting stuff happens when we determine that our lock needs
403  * to go away because this is the last subdir alias in the
404  * system. This function needs to handle a couple things:
405  *
406  * 1) Synchronizing lock shutdown with the downconvert threads. This
407  *    is already handled for us via the lockres release drop function
408  *    called in ocfs2_release_dentry_lock()
409  *
410  * 2) A race may occur when we're doing our lock shutdown and
411  *    another process wants to create a new dentry lock. Right now we
412  *    let them race, which means that for a very short while, this
413  *    node might have two locks on a lock resource. This should be a
414  *    problem though because one of them is in the process of being
415  *    thrown out.
416  */
417 static void ocfs2_drop_dentry_lock(struct ocfs2_super *osb,
418                                    struct ocfs2_dentry_lock *dl)
419 {
420         ocfs2_simple_drop_lockres(osb, &dl->dl_lockres);
421         ocfs2_lock_res_free(&dl->dl_lockres);
422
423         /* We leave dropping of inode reference to ocfs2_wq as that can
424          * possibly lead to inode deletion which gets tricky */
425         spin_lock(&dentry_list_lock);
426         if (!osb->dentry_lock_list &&
427             !ocfs2_test_osb_flag(osb, OCFS2_OSB_DROP_DENTRY_LOCK_IMMED))
428                 queue_work(ocfs2_wq, &osb->dentry_lock_work);
429         dl->dl_next = osb->dentry_lock_list;
430         osb->dentry_lock_list = dl;
431         spin_unlock(&dentry_list_lock);
432 }
433
434 void ocfs2_dentry_lock_put(struct ocfs2_super *osb,
435                            struct ocfs2_dentry_lock *dl)
436 {
437         int unlock;
438
439         BUG_ON(dl->dl_count == 0);
440
441         spin_lock(&dentry_attach_lock);
442         dl->dl_count--;
443         unlock = !dl->dl_count;
444         spin_unlock(&dentry_attach_lock);
445
446         if (unlock)
447                 ocfs2_drop_dentry_lock(osb, dl);
448 }
449
450 static void ocfs2_dentry_iput(struct dentry *dentry, struct inode *inode)
451 {
452         struct ocfs2_dentry_lock *dl = dentry->d_fsdata;
453
454         if (!dl) {
455                 /*
456                  * No dentry lock is ok if we're disconnected or
457                  * unhashed.
458                  */
459                 if (!(dentry->d_flags & DCACHE_DISCONNECTED) &&
460                     !d_unhashed(dentry)) {
461                         unsigned long long ino = 0ULL;
462                         if (inode)
463                                 ino = (unsigned long long)OCFS2_I(inode)->ip_blkno;
464                         mlog(ML_ERROR, "Dentry is missing cluster lock. "
465                              "inode: %llu, d_flags: 0x%x, d_name: %.*s\n",
466                              ino, dentry->d_flags, dentry->d_name.len,
467                              dentry->d_name.name);
468                 }
469
470                 goto out;
471         }
472
473         mlog_bug_on_msg(dl->dl_count == 0, "dentry: %.*s, count: %u\n",
474                         dentry->d_name.len, dentry->d_name.name,
475                         dl->dl_count);
476
477         ocfs2_dentry_lock_put(OCFS2_SB(dentry->d_sb), dl);
478
479 out:
480         iput(inode);
481 }
482
483 /*
484  * d_move(), but keep the locks in sync.
485  *
486  * When we are done, "dentry" will have the parent dir and name of
487  * "target", which will be thrown away.
488  *
489  * We manually update the lock of "dentry" if need be.
490  *
491  * "target" doesn't have it's dentry lock touched - we allow the later
492  * dput() to handle this for us.
493  *
494  * This is called during ocfs2_rename(), while holding parent
495  * directory locks. The dentries have already been deleted on other
496  * nodes via ocfs2_remote_dentry_delete().
497  *
498  * Normally, the VFS handles the d_move() for the file system, after
499  * the ->rename() callback. OCFS2 wants to handle this internally, so
500  * the new lock can be created atomically with respect to the cluster.
501  */
502 void ocfs2_dentry_move(struct dentry *dentry, struct dentry *target,
503                        struct inode *old_dir, struct inode *new_dir)
504 {
505         int ret;
506         struct ocfs2_super *osb = OCFS2_SB(old_dir->i_sb);
507         struct inode *inode = dentry->d_inode;
508
509         /*
510          * Move within the same directory, so the actual lock info won't
511          * change.
512          *
513          * XXX: Is there any advantage to dropping the lock here?
514          */
515         if (old_dir == new_dir)
516                 goto out_move;
517
518         ocfs2_dentry_lock_put(osb, dentry->d_fsdata);
519
520         dentry->d_fsdata = NULL;
521         ret = ocfs2_dentry_attach_lock(dentry, inode, OCFS2_I(new_dir)->ip_blkno);
522         if (ret)
523                 mlog_errno(ret);
524
525 out_move:
526         d_move(dentry, target);
527 }
528
529 const struct dentry_operations ocfs2_dentry_ops = {
530         .d_revalidate           = ocfs2_dentry_revalidate,
531         .d_iput                 = ocfs2_dentry_iput,
532 };