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