9ns: Fix concurrent TF removal bug
[akaros.git] / kern / src / ns / tree_file.c
1 /* Copyright (c) 2018 Google Inc
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * tree_file: structs and helpers for a tree-based filesystem for 9ns devices.
6  */
7
8 #include <tree_file.h>
9 #include <kmalloc.h>
10 #include <string.h>
11 #include <stdio.h>
12 #include <assert.h>
13 #include <error.h>
14
15 /* Adds to the LRU if it was not on it.
16  *
17  * Caller holds the TF lock or o/w knows it has the only ref to tf. */
18 static void __add_to_lru(struct tree_file *tf)
19 {
20         struct walk_cache *wc = &tf->tfs->wc;
21
22         if (tf->flags & TF_F_ON_LRU)
23                 return;
24         tf->flags |= TF_F_ON_LRU;
25         spin_lock(&wc->lru_lock);
26         list_add_tail(&tf->lru, &wc->lru);
27         spin_unlock(&wc->lru_lock);
28 }
29
30 /* Removes from the LRU if it was on it.
31  *
32  * Caller holds the TF lock or o/w knows it has the only ref to tf. */
33 static void __remove_from_lru(struct tree_file *tf)
34 {
35         struct walk_cache *wc = &tf->tfs->wc;
36
37         if (!(tf->flags & TF_F_ON_LRU))
38                 return;
39         assert(kref_refcnt(&tf->kref) == 0);
40         tf->flags &= ~TF_F_ON_LRU;
41         spin_lock(&wc->lru_lock);
42         list_del(&tf->lru);
43         spin_unlock(&wc->lru_lock);
44 }
45
46 /* Caller holds the parent's qlock.  Separate helpers here in case we track
47  * nr_children. */
48 static void __add_to_parent_list(struct tree_file *parent,
49                                  struct tree_file *child)
50 {
51         list_add(&child->siblings, &parent->children);
52 }
53
54 /* Caller holds the parent's qlock */
55 static void __remove_from_parent_list(struct tree_file *parent,
56                                       struct tree_file *child)
57 {
58         list_del(&child->siblings);
59 }
60
61 /* Safely grabs a kref on TF, possibly resurrecting from 0, at which point the
62  * file would be on an LRU list.  This syncs with tree removers, including
63  * unlinking from the tree on remove and LRU cache pruners.  Returns true if we
64  * got the ref, false if we lost and the file was disconnected. */
65 bool tf_kref_get(struct tree_file *tf)
66 {
67         spin_lock(&tf->lifetime);
68         if (tf->flags & TF_F_DISCONNECTED) {
69                 spin_unlock(&tf->lifetime);
70                 return false;
71         }
72         __remove_from_lru(tf);
73         __kref_get(&tf->kref, 1);
74         tf->flags |= TF_F_HAS_BEEN_USED;
75         spin_unlock(&tf->lifetime);
76         return true;
77 }
78
79 void tf_kref_put(struct tree_file *tf)
80 {
81         kref_put(&tf->kref);
82 }
83
84 static void __tf_free(struct tree_file *tf)
85 {
86         struct tree_file *parent = tf->parent;
87         struct tree_filesystem *tfs = tf->tfs;
88
89         tf->tfs->tf_ops.free(tf);
90         if (tf->flags & TF_F_IS_ROOT) {
91                 assert(tfs->root == tf);
92                 assert(!parent);
93         }
94         cleanup_fs_file((struct fs_file*)tf);
95         kfree(tf);
96         /* the reason for decreffing the parent now is for convenience on releasing.
97          * When we unlink the child from the LRU pruner, we don't want to release
98          * the parent immediately while we hold the parent's qlock (and other
99          * locks). */
100         if (parent)
101                 tf_kref_put(parent);
102 }
103
104 static void __tf_free_rcu(struct rcu_head *head)
105 {
106         struct tree_file *tf = container_of(head, struct tree_file, rcu);
107
108         __tf_free(tf);
109 }
110
111 static void tf_release(struct kref *kref)
112 {
113         struct tree_file *tf = container_of(kref, struct tree_file, kref);
114
115         assert(!(tf->flags & TF_F_NEGATIVE));
116
117         spin_lock(&tf->lifetime);
118         if (kref_refcnt(&tf->kref) > 0) {
119                 /* Someone resurrected after we decreffed to 0. */
120                 assert(!(tf->flags & TF_F_ON_LRU));
121                 spin_unlock(&tf->lifetime);
122                 return;
123         }
124         if (!(tf->flags & (TF_F_DISCONNECTED | TF_F_IS_ROOT))) {
125                 /* It's possible that we paused before locking, then another thread
126                  * upped, downed, and put it on the LRU list already.  The helper deals
127                  * with that. */
128                 __add_to_lru(tf);
129                 spin_unlock(&tf->lifetime);
130                 return;
131         }
132         spin_unlock(&tf->lifetime);
133         /* Need RCU, since we could have had a reader who saw the object and still
134          * needs to try to kref (and fail).  call_rcu, since we can't block. */
135         call_rcu(&tf->rcu, __tf_free_rcu);
136 }
137
138 static unsigned long hash_string(const char *name)
139 {
140         unsigned long hash = 5381;
141
142         for (const char *p = name; *p; p++) {
143                 /* hash * 33 + c, djb2's technique */
144                 hash = ((hash << 5) + hash) + *p;
145         }
146         return hash;
147 }
148
149 static void wc_init(struct walk_cache *wc)
150 {
151         spinlock_init(&wc->lru_lock);
152         INIT_LIST_HEAD(&wc->lru);
153         spinlock_init(&wc->ht_lock);
154         wc->ht = wc->static_ht;
155         hash_init_hh(&wc->hh);
156         for (int i = 0; i < wc->hh.nr_hash_lists; i++)
157                 INIT_HLIST_HEAD(&wc->ht[i]);
158 }
159
160 static void wc_destroy(struct walk_cache *wc)
161 {
162         assert(list_empty(&wc->lru));
163         for (int i = 0; i < wc->hh.nr_hash_lists; i++)
164                 assert(hlist_empty(&wc->ht[i]));
165         if (wc->ht != wc->static_ht)
166                 kfree(wc->ht);
167 }
168
169 /* Looks up the child of parent named 'name' in the walk cache hash table.
170  * Caller needs to hold an rcu read lock. */
171 static struct tree_file *wc_lookup_child(struct tree_file *parent,
172                                          const char *name)
173 {
174         struct walk_cache *wc = &parent->tfs->wc;
175         unsigned long hash_val = hash_string(name);
176         struct hlist_head *bucket;
177         struct tree_file *i;
178
179         bucket = &wc->ht[hash_val % wc->hh.nr_hash_bits];
180         hlist_for_each_entry_rcu(i, bucket, hash) {
181                 /* Note 'i' is an rcu protected pointer.  That deref is safe.  i->parent
182                  * is also a pointer that in general we want to protect.  In this case,
183                  * even though we don't dereference it, we want a pointer that is good
184                  * enough to dereference so we can do the comparison. */
185                 if (rcu_dereference(i->parent) != parent)
186                         continue;
187                 /* The file's name should never change while it is in the table, so no
188                  * need for a seq-reader.  Can't assert though, since there are valid
189                  * reasons for other seq lockers. */
190                 if (!strcmp(tree_file_to_name(i), name))
191                         return i;
192         }
193         return NULL;
194 }
195
196 /* Caller should hold the parent's qlock */
197 static void wc_insert_child(struct tree_file *parent, struct tree_file *child)
198 {
199         struct walk_cache *wc = &parent->tfs->wc;
200         unsigned long hash_val = hash_string(tree_file_to_name(child));
201         struct hlist_head *bucket;
202
203         assert(child->parent == parent);        /* catch bugs from our callers */
204         /* TODO: consider bucket locks and/or growing the HT.  Prob need a seq_ctr
205          * in the WC, used on the read side during resizing.  Removal probably would
206          * need something other than the bucket lock too (confusion about which
207          * bucket during the op). */
208         spin_lock(&wc->ht_lock);
209         bucket = &wc->ht[hash_val % wc->hh.nr_hash_bits];
210         hlist_add_head_rcu(&child->hash, bucket);
211         spin_unlock(&wc->ht_lock);
212 }
213
214 /* Caller should hold the parent's qlock */
215 static void wc_remove_child(struct tree_file *parent, struct tree_file *child)
216 {
217         struct walk_cache *wc = &parent->tfs->wc;
218
219         assert(child->parent == parent);        /* catch bugs from our callers */
220         spin_lock(&wc->ht_lock);
221         hlist_del_rcu(&child->hash);
222         spin_unlock(&wc->ht_lock);
223 }
224
225 /* Helper: returns a refcounted pointer to the potential parent.  May return 0.
226  *
227  * Caller needs to qlock the parent and recheck tf->parent.  Callers always need
228  * to get a kref on the parent.  We can rcu-read the parent and *attempt* to
229  * qlock under rcu, but we might block.  Then, say, the TF and the parent got
230  * removed, and *then* we get the qlock.  We're too late. */
231 static struct tree_file *__tf_get_potential_parent(struct tree_file *tf)
232 {
233         struct tree_file *parent;
234
235         rcu_read_lock();
236         parent = rcu_dereference(tf->parent);
237         if (!parent) {
238                 /* the root of the tree has no parent */
239                 rcu_read_unlock();
240                 return NULL;
241         }
242         if (!tf_kref_get(parent))
243                 parent = NULL;
244         rcu_read_unlock();
245         return parent;
246 }
247
248 /* Returns a refcounted and qlocked parent for child.  NULL on failure. */
249 static struct tree_file *get_locked_and_kreffed_parent(struct tree_file *child)
250 {
251         struct tree_file *parent;
252
253         parent = __tf_get_potential_parent(child);
254         if (!parent)
255                 return NULL;
256         qlock(&parent->file.qlock);
257         /* Checking the parent == child->parent isn't enough here.  That works for
258          * rename, but not removal/unlink.  Older versions of TF code cleared
259          * child->parent, but now that's dealt with in tf_free.
260          *
261          * We're doing a lockless peek at child's flags.  We hold the potential
262          * parent's lock, so if they are ours, no one will be messing with the
263          * disconnected flag.  If they are messing with it, then parent !=
264          * child->parent.  Also, once disconnected is set, it is never clear. */
265         if ((child->flags & TF_F_DISCONNECTED) || (parent != child->parent)) {
266                 qunlock(&parent->file.qlock);
267                 tf_kref_put(parent);
268                 return NULL;
269         }
270         return parent;
271 }
272
273 static bool __mark_disconnected(struct tree_file *tf)
274 {
275         bool need_to_free;
276
277         spin_lock(&tf->lifetime);
278         tf->flags |= TF_F_DISCONNECTED;
279         __remove_from_lru(tf);
280         need_to_free = kref_refcnt(&tf->kref) == 0;
281         spin_unlock(&tf->lifetime);
282         return need_to_free;
283 }
284
285 /* Disconnects child from the in-memory tree structure (i.e. only the front
286  * end).  Caller holds the parent qlock.  Assumes child is a child of parent.
287  * Once you disconnect, you can't touch the child object.
288  *
289  * Racing with concurrent lookups, who might grab a ref if they get in before
290  * DISCONNECTED, and racing with release (after ref = 0), who might free, if it
291  * was already unlinked. */
292 static void __disconnect_child(struct tree_file *parent,
293                                struct tree_file *child)
294 {
295         bool need_to_free;
296
297         need_to_free = __mark_disconnected(child);
298         /* Note child->parent is still set.  We clear that in __tf_free. */
299         __remove_from_parent_list(parent, child);
300         wc_remove_child(parent, child);
301         if (need_to_free)
302                 call_rcu(&child->rcu, __tf_free_rcu);
303 }
304
305 /* Backend will need to fill in dir, except for name.  Note this has a kref ==
306  * 0, but is not on the LRU yet. */
307 struct tree_file *tree_file_alloc(struct tree_filesystem *tfs,
308                                   struct tree_file *parent, const char *name)
309 {
310         struct tree_file *tf;
311
312         tf = kzmalloc(sizeof(struct tree_file), MEM_WAIT);
313         fs_file_init((struct fs_file*)tf, name, &tfs->fs_ops);
314         kref_init(&tf->kref, tf_release, 0);
315         spinlock_init(&tf->lifetime);
316         /* Need to set the parent early on, even if the child isn't linked yet, so
317          * that the TFS ops know who the parent is. */
318         tf->parent = parent;
319         if (parent)
320                 kref_get(&parent->kref, 1);
321         INIT_LIST_HEAD(&tf->children);
322         tf->can_have_children = true;
323         tf->tfs = tfs;
324         return tf;
325 }
326
327 /* Callers must hold the parent's qlock. */
328 static void __link_child(struct tree_file *parent, struct tree_file *child)
329 {
330         /* Devices may have already increffed ("+1 for existing").  Those that don't
331          * need to be on the LRU.  We haven't linked to the parent yet, so we hold
332          * the only ref.  Once we unlock in __add_to_lru, we're discoverable via
333          * that list, even though we're not linked.  The lru pruner is careful to
334          * not muck with the parent's or wc linkage without qlocking the parent,
335          * which we currently hold. */
336         if (kref_refcnt(&child->kref) == 0)
337                 __add_to_lru(child);
338         /* This was set in tree_file_alloc */
339         assert(child->parent == parent);
340         __add_to_parent_list(parent, child);
341         wc_insert_child(parent, child);
342 }
343
344 static void neuter_directory(struct tree_file *dir)
345 {
346         bool throw = false;
347
348         qlock(&dir->file.qlock);
349         if (dir->tfs->tf_ops.has_children(dir))
350                 throw = true;
351         dir->can_have_children = false;
352         qunlock(&dir->file.qlock);
353         if (throw)
354                 error(ENOTEMPTY, "can't remove dir with children");
355 }
356
357 /* Unlink a child from the tree.  Last ref will clean it up, which will not be
358  * us.  Caller should hold krefs on the child and parent.  The child's kref will
359  * actually keep the parent's alive, but all practical callers will have the
360  * parent kreff'ed and qlocked - which is required to ensure the child is still
361  * a child of parent. */
362 static void __unlink_child(struct tree_file *parent, struct tree_file *child)
363 {
364         /* Need to make sure concurrent creates/renames do not add children to
365          * directories that are unlinked.  Note we don't undo the neutering if the
366          * backend fails. */
367         if (tree_file_is_dir(child))
368                 neuter_directory(child);
369         /* The ramfs backend will probably decref the "+1 for existing" ref.
370          * This is OK.  If that was the last ref, the child will briefly be on
371          * the LRU list (which ramfs ignores).  When we disconnect, we'll yank
372          * the child back off the list and then free it (after rcu). */
373         parent->tfs->tf_ops.unlink(parent, child);
374         __disconnect_child(parent, child);
375 }
376
377 /* Talks to the backend and ensures a tree_file for the child exists, either
378  * positive or negative.  Throws an error; doesn't return NULL.
379  *
380  * This returns with an rcu read lock sufficient to protect the returned TF, but
381  * it is *not* kreffed.  It could be a negative entry, which is not kreffed.
382  *
383  * It is possible that at the moment we qunlock, someone comes along and removes
384  * the entry (LRU prune or file removal (for positive entries)).  That's fine -
385  * we have an rcu read lock, just like during a regular walk, when the removal
386  * could happen anyways. */
387 static struct tree_file *lookup_child_entry(struct tree_file *parent,
388                                             const char *name)
389 {
390         ERRSTACK(1);
391         struct tree_file *child;
392
393         qlock(&parent->file.qlock);
394         child = wc_lookup_child(parent, name);
395         if (child) {
396                 /* Since we last looked, but before we qlocked, someone else added our
397                  * entry. */
398                 rcu_read_lock();
399                 qunlock(&parent->file.qlock);
400                 return child;
401         }
402         child = tree_file_alloc(parent->tfs, parent, name);
403         if (waserror()) {
404                 /* child wasn't fully created, so freeing it may be tricky, esp on the
405                  * device ops side (might see something they never created). */
406                 __tf_free(child);
407                 qunlock(&parent->file.qlock);
408                 nexterror();
409         }
410         parent->tfs->tf_ops.lookup(parent, child);
411         poperror();
412         __link_child(parent, child);
413         rcu_read_lock();
414         qunlock(&parent->file.qlock);
415         return child;
416 }
417
418 /* Walks a tree filesystem from 'from' for array of null-terminated names.
419  * Devices will often use tree_chan_walk(), but can use this directly if they
420  * want more control.
421  *
422  * Returns the WQ of qids.  On complete/successful walks, we hang a refcnted TF
423  * on wq->clone.
424  *
425  * Walks can return intermediate results, which is when there is an error but we
426  * have walked at least once.  The partial return is useful for namec(), which
427  * can succeed if something was mounted on an intermediate QID.  Walks that have
428  * no results set error and return NULL, which is what namec() expects. */
429 struct walkqid *tree_file_walk(struct tree_file *from, char **name,
430                                unsigned int nname)
431 {
432         ERRSTACK(2);
433         struct tree_file *at, *next;
434         struct tree_filesystem *tfs = from->tfs;
435         struct walkqid *wq;
436
437         wq = kzmalloc(sizeof(struct walkqid) + nname * sizeof(struct qid),
438                                   MEM_WAIT);
439         /* A walk with zero names means "make me a copy."  If we go through the
440          * regular walker, our usual tf_kref_get will fail - similar to failing if
441          * we got a walk for "foo/../" during a concurrent removal of ourselves.
442          * We'll let a walk of zero names work, but if you provide any names, the
443          * actual walk must happen.
444          *
445          * This is tricky, and confused me a little.  We're returning a *TF* through
446          * wq->clone, not a chan, and that is refcounted.  Normally for chans that
447          * end up with wq->clone == c, we do not incref the object hanging off the
448          * chan (see k/d/d/eventfd.c), since there is just one chan with a kreffed
449          * object hanging off e.g. c->aux.  But here, wq->clone is considered a
450          * distinct refcnt to some TF, and it might be 'from.'  Our *caller* needs
451          * to deal with the "wq->clone == from_chan", since they deal with chans.
452          * We deal with tree files. */
453         if (!nname) {
454                 kref_get(&from->kref, 1);
455                 wq->clone = (struct chan*)from;
456                 return wq;
457         }
458         if (waserror()) {
459                 kfree(wq);
460                 poperror();
461                 return NULL;
462         }
463         rcu_read_lock();
464         at = from;
465         for (int i = 0; i < nname; i++) {
466                 /* Walks end if we reach a regular file, i.e. you can't walk through a
467                  * file, only a dir.  But even if there are more names, the overall walk
468                  * might succeed.  E.g. a directory could be mounted on top of the
469                  * current file we're at.  That's just not our job. */
470                 if (tree_file_is_file(at)) {
471                         if (i == 0)
472                                 error(ENOTDIR, "initial walk from a file");
473                         break;
474                 }
475                 /* Normally, symlinks stop walks, and namec's walk() will deal with it.
476                  * We allow walks 'through' symlinks, but only for .. and only for the
477                  * first name.  This is for relative lookups so we can find the parent
478                  * of a symlink. */
479                 if (tree_file_is_symlink(at)) {
480                         if (i != 0)
481                                 break;
482                         if (strcmp(name[i], ".."))
483                                 error(ELOOP, "walk from a symlink that wasn't ..");
484                 }
485                 if (!caller_has_tf_perms(at, O_READ)) {
486                         if (i == 0)
487                                 error(EACCES, "missing perm for lookup");
488                         break;
489                 }
490                 if (!strcmp(name[i], ".")) {
491                         wq->qid[wq->nqid++] = tree_file_to_qid(at);
492                         continue;
493                 }
494                 if (!strcmp(name[i], "..")) {
495                         next = rcu_dereference(at->parent);
496                         if (!next) {
497                                 if (tree_file_is_root(at)) {
498                                         wq->qid[wq->nqid++] = tree_file_to_qid(at);
499                                         /* I think namec should never give us DOTDOT that isn't at
500                                          * the end of the names array.  Though devwalk() seems to
501                                          * expect it. */
502                                         if (i != nname - 1)
503                                                 warn("Possible namec DOTDOT bug, call for help!");
504                                         continue;
505                                 }
506                                 /* We lost our parent due to a removal/rename.  We might have
507                                  * walked enough for our walk to succeed (e.g.  there's a mount
508                                  * point in the WQ), so we can return what we have.  Though if
509                                  * we've done nothing, it's a failure.
510                                  *
511                                  * Note the removal could have happened a long time ago:
512                                  * consider an O_PATH open, then namec_from().
513                                  *
514                                  * We also could walk up and see the *new* parent during
515                                  * rename().  For instance, /src/x/../y could get the old /src/y
516                                  * or the new /dst/y.  If we want to avoid that, then we'll need
517                                  * some sort of sync with rename to make sure we don't get the
518                                  * new one.  Though this can happen with namec_from(), so I'm
519                                  * not sure I care. */
520                                 if (i == 0)
521                                         error(ENOENT, "file lost its parent during lookup");
522                                 break;
523                         }
524                         at = next;
525                         wq->qid[wq->nqid++] = tree_file_to_qid(at);
526                         continue;
527                 }
528                 next = wc_lookup_child(at, name[i]);
529                 if (!next) {
530                         /* TFSs with no backend have the entire tree in the WC HT. */
531                         if (!tfs->tf_ops.lookup) {
532                                 if (i == 0)
533                                         error(ENOENT, "file does not exist");
534                                 break;
535                         }
536                         /* Need to hold a kref on 'at' before we rcu_read_unlock().  Our
537                          * TFS op might block. */
538                         if (!tf_kref_get(at)) {
539                                 if (i == 0)
540                                         error(ENOENT, "file was removed during lookup");
541                                 /* WQ has a qid for 'at' from a previous loop, but since we
542                                  * can't walk to it, we should unwind it. */
543                                 wq->nqid--;
544                                 break;
545                         }
546                         rcu_read_unlock();
547                         /* propagate the error only on the first name.  Note we run the
548                          * 'else' case, and run the poperror case for non-errors and
549                          * non-name=0-errors. */
550                         if (waserror()) {
551                                 if (i == 0) {
552                                         tf_kref_put(at);
553                                         nexterror();
554                                 }
555                         } else {
556                                 /* This returns with an rcu_read_lock protecting 'next' */
557                                 next = lookup_child_entry(at, name[i]);
558                         }
559                         tf_kref_put(at);
560                         poperror();
561                         assert(next);
562                 }
563                 if (tree_file_is_negative(next)) {
564                         /* lockless peek.  other flag users aren't atomic, etc. */
565                         if (!(next->flags & TF_F_HAS_BEEN_USED)) {
566                                 spin_lock(&next->lifetime);
567                                 next->flags |= TF_F_HAS_BEEN_USED;
568                                 spin_unlock(&next->lifetime);
569                         }
570                         if (i == 0)
571                                 error(ENOENT, "file does not exist");
572                         break;
573                 }
574                 at = next;
575                 wq->qid[wq->nqid++] = tree_file_to_qid(at);
576         }
577         if (wq->nqid == nname || tree_file_is_symlink(at)) {
578                 if (!tf_kref_get(at)) {
579                         /* We need to undo our last result as if we never saw it. */
580                         wq->nqid--;
581                         if (wq->nqid == 0)
582                                 error(ENOENT, "file was removed during lookup");
583                 } else {
584                         /* Hanging the refcounted TF off the wq->clone, which is cheating.
585                          * Our walker shim knows to expect this. */
586                         wq->clone = (struct chan*)at;
587                 }
588         }
589         rcu_read_unlock();
590         poperror();
591         return wq;
592 }
593
594 /* Most tree devices will use this for their walk op, similar to devwalk. */
595 struct walkqid *tree_chan_walk(struct chan *c, struct chan *nc, char **name,
596                                unsigned int nname)
597 {
598         struct tree_file *from, *to;
599         struct walkqid *wq;
600
601         from = chan_to_tree_file(c);
602         wq = tree_file_walk(from, name, nname);
603         if (!wq)
604                 return NULL;
605         if (!wq->clone)
606                 return wq;
607         if (!nc)
608                 nc = devclone(c);
609         /* Not sure if callers that specify nc must have a chan from our device */
610         assert(nc->type == c->type);
611         to = (struct tree_file*)wq->clone;
612         nc->qid = tree_file_to_qid(to);
613         chan_set_tree_file(nc, to);
614         wq->clone = nc;
615         /* We might be returning the same chan, so there's actually just one ref */
616         if (wq->clone == c)
617                 tf_kref_put(chan_to_tree_file(c));
618         return wq;
619 }
620
621 /* Creates a tree file under parent with name, omode, and perm.  Returns a
622  * kreffed tree_file for the new child.  Throws on error. */
623 struct tree_file *tree_file_create(struct tree_file *parent, const char *name,
624                                    uint32_t perm, char *ext)
625 {
626         ERRSTACK(2);
627         struct tree_file *child;
628         bool got_ref;
629         struct timespec now;
630
631         qlock(&parent->file.qlock);
632         if (waserror()) {
633                 qunlock(&parent->file.qlock);
634                 nexterror();
635         }
636         if (!caller_has_tf_perms(parent, O_WRITE))
637                 error(EACCES, "missing create permission on dir");
638         child = wc_lookup_child(parent, name);
639         if (child) {
640                 /* The create(5) message fails if the file exists, which differs from
641                  * the syscall.  namec() handles this. */
642                 if (!tree_file_is_negative(child))
643                         error(EEXIST, "file exists");
644                 /* future lookups that find no entry will qlock.  concurrent ones that
645                  * see the child, even if disconnected, will see it was negative and
646                  * fail. */
647                 __disconnect_child(parent, child);
648         }
649         child = tree_file_alloc(parent->tfs, parent, name);
650         if (waserror()) {
651                 __tf_free(child);
652                 nexterror();
653         }
654         /* Backend will need to know the ext for its create.  This gets cleaned up
655          * on error. */
656         if (perm & DMSYMLINK)
657                 kstrdup(&child->file.dir.ext, ext);
658         /* Backend will need to fill in dir, except for name. */
659         parent->tfs->tf_ops.create(parent, child, perm);
660         now = nsec2timespec(epoch_nsec());
661         __set_acmtime_to(&child->file,
662                          FSF_ATIME | FSF_BTIME | FSF_CTIME | FSF_MTIME, &now);
663         poperror();
664         /* At this point, the child is visible, so it must be ready to go */
665         __link_child(parent, child);
666         got_ref = tf_kref_get(child);
667         assert(got_ref);        /* we hold the qlock, no one should have removed */
668         __set_acmtime_to(&parent->file, FSF_CTIME | FSF_MTIME, &now);
669         qunlock(&parent->file.qlock);
670         poperror();
671         return child;
672 }
673
674 /* Most tree devices will use this for their create op. */
675 void tree_chan_create(struct chan *c, char *name, int omode, uint32_t perm,
676                       char *ext)
677 {
678         struct tree_file *parent, *child;
679
680         parent = chan_to_tree_file(c);
681         child = tree_file_create(parent, name, perm, ext);
682         c->qid = tree_file_to_qid(child);
683         c->mode = openmode(omode);
684         chan_set_tree_file(c, child);
685         tf_kref_put(parent);
686 }
687
688 struct chan *tree_chan_open(struct chan *c, int omode)
689 {
690         struct tree_file *tf = chan_to_tree_file(c);
691
692         if ((c->qid.type & QTDIR) && (omode & O_WRITE))
693                 error(EISDIR, "can't open a dir for writing");
694         if (c->qid.type & QTSYMLINK)
695                 error(ELOOP, "can't open a symlink");
696         tree_file_perm_check(tf, omode);
697         /* TODO: if we want to support DMEXCL on dir.mode, we'll need to lock/sync
698          * on the fs_file (have a flag for FSF_IS_OPEN, handle in close).  We'll
699          * also need a way to pass it in to the dir.mode during create/wstat/etc. */
700         if (omode & O_TRUNC)
701                 fs_file_truncate(&tf->file, 0);
702         c->mode = openmode(omode);
703         c->flag |= COPEN;
704         c->offset = 0;
705         return c;
706 }
707
708 void tree_chan_close(struct chan *c)
709 {
710         struct tree_file *tf = chan_to_tree_file(c);
711
712         tf_kref_put(tf);
713 }
714
715 void tree_file_remove(struct tree_file *child)
716 {
717         ERRSTACK(1);
718         struct tree_file *parent;
719
720         parent = get_locked_and_kreffed_parent(child);
721         if (!parent)
722                 error(ENOENT, "%s had no parent", tree_file_to_name(child));
723         if (waserror()) {
724                 qunlock(&parent->file.qlock);
725                 tf_kref_put(parent);
726                 nexterror();
727         }
728         if (!caller_has_tf_perms(parent, O_WRITE))
729                 error(EACCES, "missing remove perm for dir");
730         __unlink_child(parent, child);
731         __set_acmtime(&parent->file, FSF_CTIME | FSF_MTIME);
732         poperror();
733         qunlock(&parent->file.qlock);
734         tf_kref_put(parent);
735 }
736
737 void tree_chan_remove(struct chan *c)
738 {
739         ERRSTACK(1);
740         struct tree_file *tf = chan_to_tree_file(c);
741
742         /* sysremove expects a chan that is disconnected from the device, regardless
743          * of whether or not we fail.  See sysremove(); it will clear type, ensuring
744          * our close is never called. */
745         if (waserror()) {
746                 chan_set_tree_file(c, NULL);
747                 tf_kref_put(tf);        /* The ref from the original walk */
748                 nexterror();
749         }
750         tree_file_remove(tf);
751         chan_set_tree_file(c, NULL);
752         tf_kref_put(tf);        /* The ref from the original walk */
753         poperror();
754 }
755
756 static bool is_descendant_of(struct tree_file *descendant,
757                              struct tree_file *ancestor)
758 {
759         if (!tree_file_is_dir(ancestor))
760                 return false;
761         rcu_read_lock();
762         for (struct tree_file *i = rcu_dereference(descendant->parent);
763              i;
764              i = rcu_dereference(i->parent)) {
765                 if (i == ancestor) {
766                         rcu_read_unlock();
767                         return true;
768                 }
769         }
770         rcu_read_unlock();
771         return false;
772 }
773
774 /* Caller should hold the rename mutex.  This qlocks a and b, which can be the
775  * same file, and this handles lock ordering.  Recall the rule: parents before
776  * children, and otherwise only the renamer can lock. */
777 static void qlock_tree_files(struct tree_file *a, struct tree_file *b)
778 {
779         if (a == b) {
780                 qlock(&a->file.qlock);
781                 return;
782         }
783         if (is_descendant_of(a, b)) {
784                 qlock(&b->file.qlock);
785                 qlock(&a->file.qlock);
786         } else {
787                 qlock(&a->file.qlock);
788                 qlock(&b->file.qlock);
789         }
790 }
791
792 static void qunlock_tree_files(struct tree_file *a, struct tree_file *b)
793 {
794         if (a != b)
795                 qunlock(&a->file.qlock);
796         qunlock(&b->file.qlock);
797 }
798
799 /* Higher layers (namec) ensure that tf and new_parent are in the same device.
800  * The device (e.g. #mnt) ensures that they are in the same instance.
801  * new_parent could be the parent of tf; everything should still work if the
802  * move is within the same directory. */
803 void tree_file_rename(struct tree_file *tf, struct tree_file *new_parent,
804                       const char *name, int flags)
805 {
806         ERRSTACK(1);
807         struct tree_file *old_parent;
808         struct tree_file *prev_dst;
809         struct timespec now;
810
811         old_parent = __tf_get_potential_parent(tf);
812         if (!old_parent)
813                 error(ENOENT, "renamed file had no parent");
814         /* global mtx helps with a variety of weird races, including the "can't move
815          * to a subdirectory of yourself" case and the lock ordering of parents
816          * (locks flow from parent->child). */
817         qlock(&tf->tfs->rename_mtx);
818         qlock_tree_files(old_parent, new_parent);
819         if (waserror()) {
820                 qunlock_tree_files(old_parent, new_parent);
821                 qunlock(&tf->tfs->rename_mtx);
822                 tf_kref_put(old_parent);
823                 nexterror();
824         };
825         if (old_parent != tf->parent)
826                 error(ENOENT, "renamed file lost its parent");
827         /* Probably a namec bug (that code isn't written yet). */
828         assert(tree_file_is_dir(new_parent));
829         if (!new_parent->can_have_children)
830                 error(ENOENT, "target dir being removed");
831         if (!caller_has_tf_perms(old_parent, O_WRITE))
832                 error(EACCES, "missing remove perm for src dir");
833         if (!caller_has_tf_perms(new_parent, O_WRITE))
834                 error(EACCES, "missing create perm for dst dir");
835         /* can't move tf to one of its subdirs */
836         if (is_descendant_of(new_parent, tf))
837                 error(EINVAL, "can't rename to a child directory");
838         /* We hold new_parent's qlock, so there's no worry about prev_dst
839          * disappearing, so no need for an rcu read lock. */
840         prev_dst = wc_lookup_child(new_parent, name);
841         if (prev_dst) {
842                 if (tree_file_is_dir(prev_dst)) {
843                         if (!tree_file_is_dir(tf))
844                                 error(EISDIR, "can't rename a file onto a dir");
845                         /* We need to ensure prev_dst is childless and remains so.  That
846                          * requires grabbing its qlock, but there's a potential lock
847                          * ordering issue with old_parent.  We could have this:
848                          * new_parent/dst/x/y/z/old_parent/src.  That will fail, but we need
849                          * to check for that case instead of grabbing prev_dst's qlock. */
850                         if (is_descendant_of(prev_dst, old_parent))
851                                 error(ENOTEMPTY, "old_parent descends from dst");
852                         neuter_directory(prev_dst);
853                 } else {
854                         if (tree_file_is_dir(tf))
855                                 error(ENOTDIR, "can't rename a dir onto a file");
856                 }
857         }
858         /* We check with the backend first, so that it has a chance to fail early.
859          * Once we make the changes to the front end, lookups can see the effects of
860          * the change, which we can't roll back.  Since we hold the parents' qlocks,
861          * no one should be able to get the info from the backend either (lookups
862          * that require the backend, readdir, etc). */
863         tf->tfs->tf_ops.rename(tf, old_parent, new_parent, name, flags);
864         /* Similar to __disconnect_child, we don't clear tf->parent.  rcu readers at
865          * TF will be able to walk up (with ..).  Same with namec_from an FD.  If we
866          * atomically replace tf->parent, we should be good.  See tree_file_walk().
867          *
868          * Further, we don't mark the tf disconnected.  Someone might lookup from
869          * the old location, and that's fine.  We just don't want issues with
870          * decrefs. */
871         __remove_from_parent_list(old_parent, tf);
872         wc_remove_child(old_parent, tf);
873         synchronize_rcu();
874         /* Now, no new lookups will find it at the old location.  That change is not
875          * atomic wrt src, but it will be wrt dst.  Importantly, no one will see
876          * /path/to/old_parent/new_basename */
877         fs_file_change_basename((struct fs_file*)tf, name);
878         /* We're clobbering the old_parent ref, which we'll drop later */
879         rcu_assign_pointer(tf->parent, new_parent);
880         kref_get(&new_parent->kref, 1);
881         __add_to_parent_list(new_parent, tf);
882         wc_insert_child(new_parent, tf);
883         /* Now both the prev_dst (if it existed) or the tf file are in the walk
884          * cache / HT and either could have been looked up by a concurrent reader.
885          * Readers will always get one or the other, but never see nothing.  This is
886          * the atomic guarantee of rename. */
887         if (prev_dst) {
888                 __remove_from_parent_list(new_parent, prev_dst);
889                 wc_remove_child(new_parent, prev_dst);
890                 synchronize_rcu();
891                 /* Now no one can find prev_dst.  Someone might still have a ref, or it
892                  * might be on the LRU list (if kref == 0).  Now we can mark
893                  * disconnected.  Had we disconnected earlier, then lookup code would
894                  * see that and treat it as a failure.  Using rcu and putting the
895                  * complexity in rename was easier and simpler than changing lookup.
896                  *
897                  * We still need RCU here for freeing the prev_dst.  We could have had
898                  * an LRU pruner, etc, looking.  The synchronize_rcu above only dealt
899                  * with lookups via parent in this function. */
900                 if (__mark_disconnected(prev_dst))
901                         call_rcu(&prev_dst->rcu, __tf_free_rcu);
902         }
903         now = nsec2timespec(epoch_nsec());
904         __set_acmtime_to(&old_parent->file, FSF_CTIME | FSF_MTIME, &now);
905         __set_acmtime_to(&new_parent->file, FSF_CTIME | FSF_MTIME, &now);
906         /* Can we unlock earlier?  No.  We need to at least hold new_parent's qlock,
907          * which was the parent of old_dst, until old_dst is marked disconnected.
908          * Even though old_dst is removed from new_parent's HT, it is still in the
909          * LRU list. */
910         qunlock_tree_files(old_parent, new_parent);
911         qunlock(&tf->tfs->rename_mtx);
912         poperror();
913         tf_kref_put(old_parent);        /* the original tf->parent ref we clobbered */
914         tf_kref_put(old_parent);        /* the one we grabbed when we started */
915 }
916
917 void tree_chan_rename(struct chan *c, struct chan *new_p_c, const char *name,
918                       int flags)
919 {
920         struct tree_file *tf = chan_to_tree_file(c);
921         struct tree_file *new_parent = chan_to_tree_file(new_p_c);
922
923         tree_file_rename(tf, new_parent, name, flags);
924 }
925
926 /* dri is a pointer to the chan->dri, which is a count of how many directory
927  * entries that have been read from this chan so far.  9ns handles it; we just
928  * need to increment it for every successful entry.  Note we ignore offset. */
929 ssize_t tree_file_readdir(struct tree_file *parent, void *ubuf, size_t n,
930                           off64_t offset, int *dri)
931 {
932         ERRSTACK(1);
933         struct tree_file *i;
934         size_t dir_amt, so_far = 0;
935         uint8_t *write_pos = ubuf;
936         int child_nr = 0;
937
938         qlock(&parent->file.qlock);
939         if (waserror()) {
940                 qunlock(&parent->file.qlock);
941                 nexterror();
942         }
943         list_for_each_entry(i, &parent->children, siblings) {
944                 if (child_nr++ < *dri)
945                         continue;
946                 qlock(&i->file.qlock);
947                 dir_amt = convD2M(&i->file.dir, write_pos, n - so_far);
948                 qunlock(&i->file.qlock);
949                 if (dir_amt <= BIT16SZ) {
950                         if (!so_far)
951                                 error(EINVAL, "buffer to small for readdir");
952                         break;
953                 }
954                 write_pos += dir_amt;
955                 so_far += dir_amt;
956                 assert(n - so_far >= 0);
957                 (*dri)++;
958         }
959         /* If we care about directory atime, we can do that here. (if so_far) */
960         qunlock(&parent->file.qlock);
961         poperror();
962         return so_far;
963 }
964
965 /* Note this only works for backend-less TFSs.  It calls tree_file_readdir,
966  * which only looks at the frontend's tree. */
967 size_t tree_chan_read(struct chan *c, void *ubuf, size_t n, off64_t offset)
968 {
969         struct tree_file *tf = chan_to_tree_file(c);
970
971         if (tree_file_is_dir(tf))
972                 return tree_file_readdir(tf, ubuf, n, offset, &c->dri);
973         return fs_file_read(&tf->file, ubuf, n, offset);
974 }
975
976 size_t tree_chan_write(struct chan *c, void *ubuf, size_t n, off64_t offset)
977 {
978         struct tree_file *tf = chan_to_tree_file(c);
979
980         /* sysfile.c:rwrite checked the chan's type. */
981         assert(!tree_file_is_dir(tf));
982         return fs_file_write(&tf->file, ubuf, n, offset);
983 }
984
985 size_t tree_chan_stat(struct chan *c, uint8_t *m_buf, size_t m_buf_sz)
986 {
987         struct tree_file *tf = chan_to_tree_file(c);
988
989         return fs_file_stat(&tf->file, m_buf, m_buf_sz);
990 }
991
992 size_t tree_chan_wstat(struct chan *c, uint8_t *m_buf, size_t m_buf_sz)
993 {
994         struct tree_file *tf = chan_to_tree_file(c);
995
996         return fs_file_wstat(&tf->file, m_buf, m_buf_sz);
997 }
998
999 struct fs_file *tree_chan_mmap(struct chan *c, struct vm_region *vmr, int prot,
1000                                int flags)
1001 {
1002         struct fs_file *f = &chan_to_tree_file(c)->file;
1003
1004         /* TODO: In the future, we'll check the prot, establish hooks with the VMR,
1005          * and other things, mostly in something like fs_file_mmap, which will be
1006          * able to handle mmaping something that doesn't use the page cache.  For
1007          * now, I'm aggressively qlocking to catch bugs. */
1008         qlock(&f->qlock);
1009         if ((prot & PROT_WRITE) && (flags & MAP_SHARED))
1010                 f->flags |= FSF_DIRTY;
1011         qunlock(&f->qlock);
1012         return f;
1013 }
1014
1015 /* Given a tree file, construct a chan that points to the TF for the given
1016  * device.  Careful with this - it's for bootstrapping. */
1017 struct chan *tree_file_alloc_chan(struct tree_file *tf, struct dev *dev,
1018                                   char *name)
1019 {
1020         struct chan *c;
1021
1022         c = newchan();
1023         c->type = dev - devtab;
1024         c->name = newcname(name);
1025         kref_get(&tf->kref, 1);
1026         chan_set_tree_file(c, tf);
1027         c->qid = tree_file_to_qid(tf);
1028         return c;
1029 }
1030
1031 /* Caller needs to set its customizable fields: tf_ops, pm_ops, etc.  root is
1032  * created with a ref of 1, but needs filled in by the particular TFS. */
1033 void tfs_init(struct tree_filesystem *tfs)
1034 {
1035         wc_init(&tfs->wc);
1036         qlock_init(&tfs->rename_mtx);
1037         tfs->root = tree_file_alloc(tfs, NULL, ".");
1038         tfs->root->flags |= TF_F_IS_ROOT;
1039         assert(!(tfs->root->flags & TF_F_ON_LRU));
1040         __kref_get(&tfs->root->kref, 1);
1041 }
1042
1043 void tfs_destroy(struct tree_filesystem *tfs)
1044 {
1045         tfs->root = NULL;       /* was just freed in __tf_free() */
1046         wc_destroy(&tfs->wc);
1047 }
1048
1049 /* For every file except root, we hold our parent's qlock (root has no parent).
1050  * This prevents TF's removal/rename and any changes to tf->parent. */
1051 static void tf_dfs_cb(struct tree_file *tf, void (*cb)(struct tree_file *tf))
1052 {
1053         struct tree_file *child;
1054
1055         if (tree_file_is_dir(tf)) {
1056                 qlock(&tf->file.qlock);
1057                 /* Note we don't have a kref on our child's TF - we have a weak
1058                  * reference (the list membership).  We hold the parent's qlock, which
1059                  * prevents removal/unlinking/disconnecting/etc.  The child's membership
1060                  * on the LRU list can change repeatedly.
1061                  *
1062                  * If we want to avoid holding the parent's qlock, we could grab a kref
1063                  * on the child.  However, our list walk would be in jeopardy - both
1064                  * child and temp could be removed from the list.  So we'd need to qlock
1065                  * the parent, grab krefs on all children, and put them on a local list.
1066                  * Also, grabbing krefs on our children will muck with the LRU list;
1067                  * when we're done, it would be like we sorted the LRU list in the DFS
1068                  * order. */
1069                 list_for_each_entry(child, &tf->children, siblings)
1070                         tf_dfs_cb(child, cb);
1071                 qunlock(&tf->file.qlock);
1072         }
1073         if (!tree_file_is_negative(tf))
1074                 cb(tf);
1075 }
1076
1077 /* Runs CB on all in-memory, non-negative TFs from the TFS in a depth-first
1078  * search.  Compared to the other CB walkers (purge, LRU, etc), this never
1079  * removes/prunes/disconnects a TF from the tree.  You can use it for syncing FS
1080  * trees or pruning page maps (i.e. discarding non-dirty pages).
1081  *
1082  * One thing to note is that it qlocks the tree as part of its DFS.  We can
1083  * change that, but at a slight cost in complexity and tampering with the LRU
1084  * list.  Translation: we can do it if there's a performance problem.
1085  *
1086  * The tfs->root reference is also weak.  It's up to the user to make sure
1087  * there is no concurrent tfs_destroy.  Typically, if we're called on any
1088  * mounted device, we're fine (e.g. #tmpfs) or a device that is never destroyed
1089  * (e.g. #kfs). */
1090 void tfs_frontend_for_each(struct tree_filesystem *tfs,
1091                            void (*cb)(struct tree_file *tf))
1092 {
1093         tf_dfs_cb(tfs->root, cb);
1094 }
1095
1096 /* We should be single-user, so no need for concurrency protections.  I keep
1097  * them around for paranoia/future use/documentation. */
1098 static void tf_dfs_purge(struct tree_file *tf, void (*cb)(struct tree_file *tf))
1099 {
1100         struct tree_file *child, *temp;
1101
1102         if (tree_file_is_dir(tf)) {
1103                 qlock(&tf->file.qlock);
1104                 /* Note we don't have a kref on TF, and one of our children should
1105                  * decref *us* to 0.  We aren't disconnected yet, and we can't be
1106                  * removed (parent's qlock is held), so we'll just end up on the LRU
1107                  * list, which is OK.
1108                  *
1109                  * Our child should remove itself from our list, so we need the _safe.
1110                  *
1111                  * Also note that the child decrefs us in a call_rcu.  CB can block, and
1112                  * technically so can qlock, so we might run RCU callbacks while
1113                  * qlocked.  We'll need to rcu_barrier so that our children's decrefs
1114                  * occur before we remove ourselves from our parent. */
1115                 list_for_each_entry_safe(child, temp, &tf->children, siblings)
1116                         tf_dfs_purge(child, cb);
1117                 qunlock(&tf->file.qlock);
1118         }
1119         rcu_barrier();
1120         /* ramfs will drop the "+1 for existing" ref here */
1121         if (!tree_file_is_negative(tf))
1122                 cb(tf);
1123         spin_lock(&tf->lifetime);
1124         /* should be unused, with no children.  we have a ref on root, to keep the
1125          * TFS around while we destroy the tree. */
1126         assert(kref_refcnt(&tf->kref) == 0 || tree_file_is_root(tf));
1127         /* This mark prevents new lookups.  We'll disconnect it shortly. */
1128         tf->flags |= TF_F_DISCONNECTED;
1129         spin_unlock(&tf->lifetime);
1130         if (tf->parent)
1131                 __disconnect_child(tf->parent, tf);
1132 }
1133
1134 /* Purges all in-memory TFs from the TFS in a depth-first search, both positive
1135  * and negative.  We run CB on all non-negative TFs.  It's up to the caller to
1136  * ensure there is no concurrency.
1137  *
1138  * The caller must make sure they have an extra ref on tfs->root to keep the
1139  * TFS around while it gets destroyed.  The root TF will get freed when it is
1140  * released, unlike other TFs that are still connected.
1141  *
1142  * This is for devices that want to destroy themselves, such as an unmounted
1143  * #tmpfs or #gtfs/#mnt, that want to do some extra work (e.g. sync).
1144  * Typically, those devices will call this after they have no users (e.g. mounts
1145  * or open chans). */
1146 void tfs_frontend_purge(struct tree_filesystem *tfs,
1147                         void (*cb)(struct tree_file *tf))
1148 {
1149         assert(kref_refcnt(&tfs->root->kref) > 0);
1150         tf_dfs_purge(tfs->root, cb);
1151 }
1152
1153 static void print_tf(struct tree_file *tf)
1154 {
1155         if (tree_file_is_negative(tf)) {
1156                 printk("%-10s: Negative\n", tree_file_to_name(tf));
1157                 return;
1158         }
1159         printk("%-10s: Q: %5d, R: %2d, U %s, %c%o %s\n",
1160                    tree_file_to_name(tf),
1161                    tf->file.dir.qid.path,
1162                    kref_refcnt(&tf->kref),
1163                    tf->file.dir.uid,
1164                    tree_file_is_dir(tf) ? 'd' :
1165                                                                 tf->file.dir.mode & DMSYMLINK ? 'l' : '-',
1166                    tf->file.dir.mode & S_PMASK,
1167                    tf->file.dir.mode & DMSYMLINK ? tf->file.dir.ext : ""
1168                    );
1169 }
1170
1171 static void dump_tf(struct tree_file *tf, int tabs)
1172 {
1173         struct tree_file *child;
1174
1175         if (!!(tf->file.dir.mode & DMSYMLINK) !=
1176             !!(tf->file.dir.qid.type & QTSYMLINK))
1177                 warn("%s has differing symlink bits", tree_file_to_name(tf));
1178
1179         for (int i = 0; i < tabs; i++)
1180                 printk("    ");
1181         print_tf(tf);
1182         if (tree_file_is_dir(tf)) {
1183                 for (int i = 0; i < tabs; i++)
1184                         printk("    ");
1185                 printk("---------------------\n");
1186                 list_for_each_entry(child, &tf->children, siblings)
1187                         dump_tf(child, tabs + 1);
1188         }
1189 }
1190
1191 void __tfs_dump(struct tree_filesystem *tfs)
1192 {
1193         dump_tf(tfs->root, 0);
1194 }
1195
1196 /* Runs a callback on every non-negative TF on the LRU list, for a given
1197  * snapshot of the LRU list.  The CB returns true if it wants us to attempt to
1198  * free the TF.  One invariant is that we can never remove a TF from the tree
1199  * while it is dirty; it is the job of the CB to maintain that.  Note the CB can
1200  * run on a TF as soon as that TF was linked to the parent (see lookup).
1201  *
1202  * The work list is a list of strong refs.  We need to keep one in case the file
1203  * is disconnected while we're running our CBs.  Since we incref, we yank from
1204  * the LRU list.  We could design the rest of the TF code so that we stay on the
1205  * LRU list throughout, but I like the invariant of "kref == 0 IFF on LRU".
1206  *
1207  * Since we're only on one list at a time ('wc->lru' or 'work'), we can use the
1208  * lru list_head in the TF.  We know that so long as we hold our kref on a TF,
1209  * no one will attempt to put it back on the LRU list. */
1210 void tfs_lru_for_each(struct tree_filesystem *tfs, bool cb(struct tree_file *),
1211                       size_t max_tfs)
1212 {
1213         struct list_head work = LIST_HEAD_INIT(work);
1214         struct walk_cache *wc = &tfs->wc;
1215         struct tree_file *tf, *temp, *parent;
1216         size_t nr_tfs = 0;
1217
1218         /* We can have multiple LRU workers in flight, though a given TF will be on
1219          * only one CB list at a time. */
1220         spin_lock(&wc->lru_lock);
1221         list_for_each_entry_safe(tf, temp, &wc->lru, lru) {
1222                 /* lockless peak at the flag.  once it's NEGATIVE, it never goes back */
1223                 if (tree_file_is_negative(tf))
1224                         continue;
1225                 /* Normal lock order is TF -> LRU.  Best effort is fine for LRU. */
1226                 if (!spin_trylock(&tf->lifetime))
1227                         continue;
1228                 /* Can't be disconnected and on LRU */
1229                 assert(!(tf->flags & TF_F_DISCONNECTED));
1230                 assert((tf->flags & TF_F_ON_LRU));
1231                 tf->flags &= ~TF_F_ON_LRU;
1232                 list_del(&tf->lru);
1233                 __kref_get(&tf->kref, 1);
1234                 /* The 'used' bit is the what allows us to detect a user in between our
1235                  * callback and the disconnection/freeing.  It's a moot point if the CB
1236                  * returns false. */
1237                 tf->flags &= ~TF_F_HAS_BEEN_USED;
1238                 spin_unlock(&tf->lifetime);
1239                 list_add_tail(&tf->lru, &work);
1240                 if (++nr_tfs >= max_tfs)
1241                         break;
1242         }
1243         spin_unlock(&wc->lru_lock);
1244
1245         /* We have a snapshot of the LRU list.  As soon as we unlocked a file,
1246          * someone could incref it (e.g. to something > 1), and they'll set the used
1247          * bit.  That won't abort the CB.  New TFs could be added to the LRU list.
1248          * Those are ignored for this pass. */
1249         list_for_each_entry_safe(tf, temp, &work, lru) {
1250                 if (!cb(tf)) {
1251                         list_del(&tf->lru);
1252                         tf_kref_put(tf);
1253                         continue;
1254                 }
1255         }
1256
1257         /* Now we have a list of victims to be removed, so long as they haven't been
1258          * used since. */
1259         list_for_each_entry_safe(tf, temp, &work, lru) {
1260                 parent = get_locked_and_kreffed_parent(tf);
1261                 if (!parent) {
1262                         list_del(&tf->lru);
1263                         tf_kref_put(tf);
1264                         continue;
1265                 }
1266                 spin_lock(&tf->lifetime);
1267                 if (tf->flags & TF_F_HAS_BEEN_USED) {
1268                         spin_unlock(&tf->lifetime);
1269                         qunlock(&parent->file.qlock);
1270                         tf_kref_put(parent);
1271                         list_del(&tf->lru);
1272                         tf_kref_put(tf);
1273                         continue;
1274                 }
1275                 tf->flags |= TF_F_DISCONNECTED;
1276                 /* We hold a ref, so it shouldn't have found its way back on LRU */
1277                 assert(!(tf->flags & TF_F_ON_LRU));
1278                 spin_unlock(&tf->lifetime);
1279                 __remove_from_parent_list(parent, tf);
1280                 wc_remove_child(parent, tf);
1281                 /* If we get tired of unlocking and relocking, we could see if the next
1282                  * parent is the current parent before unlocking. */
1283                 qunlock(&parent->file.qlock);
1284                 tf_kref_put(parent);
1285         }
1286         /* Now we have a list of refs that are all disconnected, kref == 1 (because
1287          * no one used them since we increffed them when they were LRU, which was
1288          * when the refcnt was 0).  Each TF has a ref on its parent btw, so parents
1289          * will never be on the LRU list.  (leaves only).
1290          *
1291          * We need to synchronize_rcu() too, since we could have had lockless
1292          * lookups that have pointers to TF and are waiting to notice that it is
1293          * disconnected. */
1294         synchronize_rcu();
1295         list_for_each_entry_safe(tf, temp, &work, lru) {
1296                 assert(kref_refcnt(&tf->kref) == 1);
1297                 list_del(&tf->lru);
1298                 /* We could decref, but instead we can directly free.  We know the ref
1299                  * == 1 and it is disconnected.  Directly freeing bypasses call_rcu. */
1300                 __tf_free(tf);
1301         }
1302 }
1303
1304 /* Does a one-cycle 'clock' algorithm to detect use.  On a given pass, we either
1305  * clear HAS_BEEN_USED xor we remove it.  For negative entries, that bit is used
1306  * when we look at an entry (use it), compared to positive entries, which is
1307  * used when we get a reference.  (we never get refs on negatives). */
1308 void tfs_lru_prune_neg(struct tree_filesystem *tfs)
1309 {
1310         struct list_head work = LIST_HEAD_INIT(work);
1311         struct walk_cache *wc = &tfs->wc;
1312         struct tree_file *tf, *temp, *parent;
1313
1314         spin_lock(&wc->lru_lock);
1315         list_for_each_entry_safe(tf, temp, &wc->lru, lru) {
1316                 if (!tree_file_is_negative(tf))
1317                         continue;
1318                 if (!spin_trylock(&tf->lifetime))
1319                         continue;
1320                 if (tf->flags & TF_F_HAS_BEEN_USED) {
1321                         tf->flags &= ~TF_F_HAS_BEEN_USED;
1322                         spin_unlock(&tf->lifetime);
1323                         continue;
1324                 }
1325                 rcu_read_lock();        /* holding a spinlock, but just to be clear. */
1326                 parent = rcu_dereference(tf->parent);
1327                 /* Again, inverting the lock order, so best effort trylock */
1328                 if (!canqlock(&parent->file.qlock)) {
1329                         rcu_read_unlock();
1330                         spin_unlock(&tf->lifetime);
1331                         continue;
1332                 }
1333                 __remove_from_parent_list(parent, tf);
1334                 wc_remove_child(parent, tf);
1335                 qunlock(&parent->file.qlock);
1336                 /* We're off the list, but our kref == 0 still.  We can break that
1337                  * invariant since we have the only ref and are about to free the TF. */
1338                 tf->flags &= ~TF_F_ON_LRU;
1339                 list_del(&tf->lru);
1340                 spin_unlock(&tf->lifetime);
1341                 list_add_tail(&tf->lru, &work);
1342         }
1343         spin_unlock(&wc->lru_lock);
1344         /* Now we have a list of refs that are all unlinked (but actually not
1345          * flagged DISCONNECTED; that's only necessary for positives), kref == 0
1346          * (because they are negatives).
1347          *
1348          * We need to synchronize_rcu() too, since we could have had lockless
1349          * lookups that have pointers to TF, and they may even mark HAS_BEEN_USED.
1350          * Too late. */
1351         synchronize_rcu();
1352         list_for_each_entry_safe(tf, temp, &work, lru) {
1353                 assert(kref_refcnt(&tf->kref) == 0);
1354                 list_del(&tf->lru);
1355                 __tf_free(tf);
1356         }
1357 }