Use readstr() for #device text buffers
[akaros.git] / kern / drivers / dev / gtfs.c
1 /* Copyright (c) 2018 Google Inc
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * #gtfs, generic tree file system frontend that hooks to a backend 9p device
6  */
7
8 #include <slab.h>
9 #include <kmalloc.h>
10 #include <kref.h>
11 #include <string.h>
12 #include <stdio.h>
13 #include <assert.h>
14 #include <error.h>
15 #include <pmap.h>
16 #include <smp.h>
17 #include <tree_file.h>
18
19 struct dev gtfs_devtab;
20
21 static char *devname(void)
22 {
23         return gtfs_devtab.name;
24 }
25
26 struct gtfs {
27         struct tree_filesystem          tfs;
28         struct kref                                     users;
29 };
30
31 /* Blob hanging off the fs_file->priv.  The backend chans are only accessed,
32  * (changed or used) with the corresponding fs_file qlock held.  That's the
33  * primary use of the qlock - we might be able to avoid qlocking with increfs
34  * and atomics or spinlocks, but be careful of be_length.  Qlocking doesn't
35  * matter much yet since #mnt serializes.
36  *
37  * The walk chan is never opened - it's basically just the walked fid, from
38  * which we can do other walks or get the I/O chans.  The read and write chans
39  * are opened on demand and closed periodically.  We open them initially on
40  * open/create in case we are unable to open them (e.g. unwritable).  Better to
41  * find out early than during a long writeback.
42  *
43  * The mnt server might complain about having too many open fids.  We can run a
44  * ktask that periodically closes the be_chans on any LRU'd files.
45  *
46  * be_{length,mode,mtime} should be what the remote server thinks they are -
47  * especially for length and mode.  The invariant is that e.g. the file's length
48  * == be_length, and the qlock protects that invariant.  We don't care as much
49  * about mtime, since some 9p servers just change that on their own.
50  *
51  * Also note that you can't trust be_length for directories.  You'll often get
52  * 4096 or 0, depending on the 9p server you're talking to. */
53 struct gtfs_priv {
54         struct chan                                     *be_walk;       /* never opened */
55         struct chan                                     *be_read;
56         struct chan                                     *be_write;
57         uint64_t                                        be_length;
58         uint32_t                                        be_mode;
59         struct timespec                         be_mtime;
60         bool                                            was_removed;
61 };
62
63 static inline struct gtfs_priv *fsf_to_gtfs_priv(struct fs_file *f)
64 {
65         return f->priv;
66 }
67
68 static inline struct gtfs_priv *tf_to_gtfs_priv(struct tree_file *tf)
69 {
70         return fsf_to_gtfs_priv(&tf->file);
71 }
72
73 /* Helper.  Clones the chan (walks to itself) and then opens with omode. */
74 static struct chan *cclone_and_open(struct chan *c, int omode)
75 {
76         ERRSTACK(1);
77         struct chan *new;
78
79         new = cclone(c);
80         if (waserror()) {
81                 cclose(new);
82                 nexterror();
83         }
84         new = devtab[new->type].open(new, omode);
85         poperror();
86         return new;
87 }
88
89 /* Send a wstat with the contents of dir for the file. */
90 static void wstat_dir(struct fs_file *f, struct dir *dir)
91 {
92         ERRSTACK(1);
93         struct gtfs_priv *gp = fsf_to_gtfs_priv(f);
94         size_t sz;
95         uint8_t *buf;
96
97         sz = sizeD2M(dir);
98         buf = kzmalloc(sz, MEM_WAIT);
99         convD2M(dir, buf, sz);
100         if (waserror()) {
101                 kfree(buf);
102                 nexterror();
103         }
104         devtab[gp->be_walk->type].wstat(gp->be_walk, buf, sz);
105         kfree(buf);
106         poperror();
107 }
108
109 /* Note we only track and thus change the following:
110  * - length
111  * - mode
112  * - mtime (second granularity)
113  * If we support chown, we'll have to do something else there.  See
114  * fs_file_copy_from_dir(). */
115 static void sync_metadata(struct fs_file *f)
116 {
117         ERRSTACK(1);
118         struct gtfs_priv *gp = fsf_to_gtfs_priv(f);
119         struct dir dir;
120         bool send_it = false;
121
122         qlock(&f->qlock);
123         init_empty_dir(&dir);
124         if (f->dir.length != gp->be_length) {
125                 dir.length = f->dir.length;
126                 send_it = true;
127         }
128         if (f->dir.mode != gp->be_mode) {
129                 dir.mode = f->dir.mode;
130                 send_it = true;
131         }
132         if (f->dir.mtime.tv_sec != gp->be_mtime.tv_sec) {
133                 /* ninep's UFS server assumes you set both atime and mtime */
134                 dir.atime.tv_sec = f->dir.atime.tv_sec;
135                 dir.atime.tv_nsec = f->dir.atime.tv_nsec;
136                 dir.mtime.tv_sec = f->dir.mtime.tv_sec;
137                 dir.mtime.tv_nsec = f->dir.mtime.tv_nsec;
138                 send_it = true;
139         }
140         if (!send_it) {
141                 qunlock(&f->qlock);
142                 return;
143         }
144         if (waserror()) {
145                 qunlock(&f->qlock);
146                 nexterror();
147         }
148         wstat_dir(f, &dir);
149         /* We set these after the wstat succeeds.  If we set them earlier, we'd have
150          * to roll back.  Remember the invariant: the be_values match the backend's
151          * file's values.  We should be able to stat be_walk and check these (though
152          * the 9p server might muck with atime/mtime). */
153         if (f->dir.length != gp->be_length)
154                 gp->be_length = f->dir.length;
155         if (f->dir.mode != gp->be_mode)
156                 gp->be_mode = f->dir.mode;
157         if (f->dir.mtime.tv_sec != gp->be_mtime.tv_sec)
158                 gp->be_mtime = f->dir.mtime;
159         qunlock(&f->qlock);
160         poperror();
161 }
162
163 /* Can throw on error, currently from sync_metadata. */
164 static void writeback_file(struct fs_file *f)
165 {
166         sync_metadata(f);
167         /* This is a lockless peak.  Once a file is dirtied, we never undirty it.
168          * To do so, we need the file qlock (not a big deal, though that may replace
169          * the PM qlock), and we still need to handle/scan mmaps.  Specifically, we
170          * only dirty when an mmap attaches (PROT_WRITE and MAP_SHARED), but we
171          * don't know if an existing mapping has caused more dirtying (an mmap can
172          * re-dirty then detach before our next writeback).  That usually requires a
173          * scan.  This is all an optimization to avoid scanning the entire PM's
174          * pages for whether or not they are dirty.
175          *
176          * Also, our writeback pm op grabs the file's qlock.  So be careful; though
177          * we could use another qlock, since we're mostly protecting backend state.
178          */
179         if (qid_is_file(f->dir.qid) && (f->flags & FSF_DIRTY))
180                 pm_writeback_pages(f->pm);
181 }
182
183 static void purge_cb(struct tree_file *tf)
184 {
185         ERRSTACK(1)
186
187         /* discard error, and keep on going if we can. */
188         if (!waserror())
189                 writeback_file(&tf->file);
190         poperror();
191 }
192
193 static void gtfs_release(struct kref *kref)
194 {
195         struct gtfs *gtfs = container_of(kref, struct gtfs, users);
196
197         tfs_frontend_purge(&gtfs->tfs, purge_cb);
198         /* this is the ref from attach */
199         assert(kref_refcnt(&gtfs->tfs.root->kref) == 1);
200         tf_kref_put(gtfs->tfs.root);
201         /* ensures __tf_free() happens before tfs_destroy */
202         rcu_barrier();
203         tfs_destroy(&gtfs->tfs);
204         kfree(gtfs);
205 }
206
207 static struct gtfs *chan_to_gtfs(struct chan *c)
208 {
209         struct tree_file *tf = chan_to_tree_file(c);
210
211         return (struct gtfs*)(tf->tfs);
212 }
213
214 static void incref_gtfs_chan(struct chan *c)
215 {
216         kref_get(&chan_to_gtfs(c)->users, 1);
217 }
218
219 static void decref_gtfs_chan(struct chan *c)
220 {
221         kref_put(&chan_to_gtfs(c)->users);
222 }
223
224 static struct walkqid *gtfs_walk(struct chan *c, struct chan *nc, char **name,
225                                  unsigned int nname)
226 {
227         struct walkqid *wq;
228
229         wq = tree_chan_walk(c, nc, name, nname);
230         if (wq && wq->clone && (wq->clone != c))
231                 incref_gtfs_chan(wq->clone);
232         return wq;
233 }
234
235 /* Given an omode, make sure the be chans are set up */
236 static void setup_be_chans(struct chan *c, int omode)
237 {
238         ERRSTACK(1);
239         struct tree_file *tf = chan_to_tree_file(c);
240         struct fs_file *f = &tf->file;
241         struct gtfs_priv *gp = fsf_to_gtfs_priv(f);
242
243         qlock(&f->qlock);
244         if (waserror()) {
245                 qunlock(&f->qlock);
246                 nexterror();
247         }
248         /* Readers and writers both need be_read.  With fs files you can't have a
249          * writable-only file, since we need to load the page into the page cache,
250          * which is a readpage. */
251         if (!gp->be_read)
252                 gp->be_read = cclone_and_open(gp->be_walk, O_READ);
253         if (!gp->be_write && (omode & O_WRITE))
254                 gp->be_write = cclone_and_open(gp->be_walk, O_WRITE);
255         qunlock(&f->qlock);
256         poperror();
257 }
258
259 static struct chan *gtfs_open(struct chan *c, int omode)
260 {
261         /* truncate can happen before we setup the be_chans.  if we need those, we
262          * can swap the order */
263         c = tree_chan_open(c, omode);
264         setup_be_chans(c, omode);
265         return c;
266 }
267
268
269 static void gtfs_create(struct chan *c, char *name, int omode, uint32_t perm,
270                         char *ext)
271 {
272         tree_chan_create(c, name, omode, perm, ext);
273         /* We have to setup *after* create, since it moves the chan from the parent
274          * to the new file. */
275         setup_be_chans(c, omode);
276 }
277
278 static void gtfs_close(struct chan *c)
279 {
280         tree_chan_close(c);
281         decref_gtfs_chan(c);
282 }
283
284 static void gtfs_remove(struct chan *c)
285 {
286         ERRSTACK(1);
287         struct gtfs *gtfs = chan_to_gtfs(c);
288
289         if (waserror()) {
290                 /* Same old pain-in-the-ass for remove */
291                 kref_put(&gtfs->users);
292                 nexterror();
293         }
294         tree_chan_remove(c);
295         kref_put(&gtfs->users);
296         poperror();
297 }
298
299 static size_t gtfs_wstat(struct chan *c, uint8_t *m_buf, size_t m_buf_sz)
300 {
301         size_t ret;
302
303         ret = tree_chan_wstat(c, m_buf, m_buf_sz);
304         /* Tell the backend so that any metadata changes take effect immediately.
305          * Consider chmod +w.  We need to tell the 9p server so that it will allow
306          * future accesses. */
307         sync_metadata(&chan_to_tree_file(c)->file);
308         return ret;
309 }
310
311 /* Caller holds the file's qlock. */
312 static size_t __gtfs_fsf_read(struct fs_file *f, void *ubuf, size_t n,
313                               off64_t off)
314 {
315         struct gtfs_priv *gp = fsf_to_gtfs_priv(f);
316
317         if (!gp->be_read)
318                 gp->be_read = cclone_and_open(gp->be_walk, O_READ);
319         return devtab[gp->be_read->type].read(gp->be_read, ubuf, n, off);
320 }
321
322 /* Reads a file from its backend chan */
323 static size_t gtfs_fsf_read(struct fs_file *f, void *ubuf, size_t n,
324                             off64_t off)
325 {
326         ERRSTACK(1);
327         size_t ret;
328
329         qlock(&f->qlock);
330         if (waserror()) {
331                 qunlock(&f->qlock);
332                 nexterror();
333         }
334         ret = __gtfs_fsf_read(f, ubuf, n, off);
335         qunlock(&f->qlock);
336         poperror();
337         return ret;
338 }
339
340 /* Caller holds the file's qlock. */
341 static size_t __gtfs_fsf_write(struct fs_file *f, void *ubuf, size_t n,
342                                off64_t off)
343 {
344         struct gtfs_priv *gp = fsf_to_gtfs_priv(f);
345         size_t ret;
346
347         if (!gp->be_write)
348                 gp->be_write = cclone_and_open(gp->be_walk, O_WRITE);
349         ret = devtab[gp->be_write->type].write(gp->be_write, ubuf, n, off);
350         gp->be_length = MAX(gp->be_length, n + ret);
351         return ret;
352 }
353
354 /* Writes a file to its backend chan */
355 static size_t gtfs_fsf_write(struct fs_file *f, void *ubuf, size_t n,
356                              off64_t off)
357 {
358         ERRSTACK(1);
359         size_t ret;
360
361         qlock(&f->qlock);
362         if (waserror()) {
363                 qunlock(&f->qlock);
364                 nexterror();
365         }
366         ret = __gtfs_fsf_write(f, ubuf, n, off);
367         qunlock(&f->qlock);
368         poperror();
369         return ret;
370 }
371
372 static size_t gtfs_read(struct chan *c, void *ubuf, size_t n, off64_t off)
373 {
374         struct tree_file *tf = chan_to_tree_file(c);
375
376         if (tree_file_is_dir(tf))
377                 return gtfs_fsf_read(&tf->file, ubuf, n, off);
378         return fs_file_read(&tf->file, ubuf, n, off);
379 }
380
381 /* Given a file (with dir->name set), couple it and sync to the backend chan.
382  * This will store/consume the ref for backend, in the TF (freed with
383  * gtfs_tf_free), even on error, unless you zero out the be_walk field. */
384 static void gtfs_tf_couple_backend(struct tree_file *tf, struct chan *backend)
385 {
386         struct dir *dir;
387         struct gtfs_priv *gp = kzmalloc(sizeof(struct gtfs_priv), MEM_WAIT);
388
389         tf->file.priv = gp;
390         tf->file.dir.qid = backend->qid;
391         gp->be_walk = backend;
392         dir = chandirstat(backend);
393         if (!dir)
394                 error(ENOMEM, "chandirstat failed");
395         fs_file_copy_from_dir(&tf->file, dir);
396         kfree(dir);
397         /* For sync_metadata */
398         gp->be_length = tf->file.dir.length;
399         gp->be_mode = tf->file.dir.mode;
400         gp->be_mtime = tf->file.dir.mtime;
401 }
402
403 static void gtfs_tf_free(struct tree_file *tf)
404 {
405         struct gtfs_priv *gp = tf_to_gtfs_priv(tf);
406
407         /* Might have some partially / never constructed tree files */
408         if (!gp)
409                 return;
410         if (gp->was_removed) {
411                 gp->be_walk->type = -1;
412                 /* sanity */
413                 assert(kref_refcnt(&gp->be_walk->ref) == 1);
414         }
415         cclose(gp->be_walk);
416         /* I/O chans can be NULL */
417         cclose(gp->be_read);
418         cclose(gp->be_write);
419         kfree(gp);
420 }
421
422 static void gtfs_tf_unlink(struct tree_file *parent, struct tree_file *child)
423 {
424         struct gtfs_priv *gp = tf_to_gtfs_priv(child);
425         struct chan *be_walk = gp->be_walk;
426
427         /* Remove clunks the be_walk chan/fid.  if it succeeded (and I think even if
428          * it didn't), we shouldn't close that fid again, which is what will happen
429          * soon after this function.  The TF code calls unlink, then when the last
430          * ref closes the TF, it'll get freed and we'll call back to gtfs_tf_free().
431          *
432          * This is the same issue we run into with all of the device remove ops
433          * where we want to refcnt something hanging off e.g. c->aux.  In 9p, you're
434          * not supposed to close a chan/fid that was already removed.
435          *
436          * Now here's the weird thing.  We can close the be_walk chan after remove,
437          * but it's possible that someone has walked and perhaps opened a frontend
438          * chan + TF, but hasn't done a read yet.  So someone might want to set up
439          * be_read, but they can't due to be_walk being closed.  We could give them
440          * a 'phase error' (one of 9p's errors for I/O on a removed file).
441          *
442          * Alternatively, we can mark the gtfs_priv so that when we do free it, we
443          * skip the dev.remove, similar to what sysremove() does.  That's probably
444          * easier.  This is technically racy, but we know that the release/free
445          * method won't be called until we return. */
446         gp->was_removed = true;
447         devtab[be_walk->type].remove(be_walk);
448 }
449
450 /* Caller sets the name, but doesn't know if it exists or not.  It's our job to
451  * find out if it exists and fill in the child structure appropriately.  For
452  * negative entries, just flagging it is fine.  Otherwise, we fill in the dir.
453  * We should throw on error. */
454 static void gtfs_tf_lookup(struct tree_file *parent, struct tree_file *child)
455 {
456         struct walkqid *wq;
457         struct chan *be_walk = tf_to_gtfs_priv(parent)->be_walk;
458         struct chan *child_be_walk;
459
460         wq = devtab[be_walk->type].walk(be_walk, NULL, &child->file.dir.name, 1);
461         if (!wq || !wq->clone) {
462                 kfree(wq);
463                 /* This isn't racy, since the child isn't linked to the tree yet */
464                 child->flags |= TF_F_NEGATIVE | TF_F_HAS_BEEN_USED;
465                 return;
466         }
467         /* walk shouldn't give us the same chan struct since we gave it a name and a
468          * NULL nc. */
469         assert(wq->clone != be_walk);
470         /* only gave it one name, and it didn't fail. */
471         assert(wq->nqid == 1);
472         /* sanity */
473         assert(wq->clone->qid.path == wq->qid[wq->nqid - 1].path);
474         child_be_walk = wq->clone;
475         kfree(wq);
476         gtfs_tf_couple_backend(child, child_be_walk);
477 }
478
479 static void gtfs_tf_create(struct tree_file *parent, struct tree_file *child,
480                            int perm)
481 {
482         ERRSTACK(1);
483         struct chan *c = cclone(tf_to_gtfs_priv(parent)->be_walk);
484
485         if (waserror()) {
486                 cclose(c);
487                 nexterror();
488         }
489         devtab[c->type].create(c, tree_file_to_name(child), 0, perm,
490                                child->file.dir.ext);
491         /* The chan c is opened, which we don't want.  We can't cclone it either
492          * (since it is opened).  All we can do is have the parent walk again so we
493          * can get the child's unopened be_walk chan.  Conveniently, that's
494          * basically a lookup, so create is really two things: make it, then look it
495          * up from the backend. */
496         cclose(c);
497         poperror();
498         if (waserror()) {
499                 warn("File %s was created in the backend, but unable to look it up!",
500                      tree_file_to_name(child));
501                 nexterror();
502         }
503         gtfs_tf_lookup(parent, child);
504         poperror();
505 }
506
507 static void gtfs_wstat_rename(struct fs_file *f, const char *name)
508 {
509         struct dir dir;
510
511         init_empty_dir(&dir);
512         dir.name = (char*)name;
513         wstat_dir(f, &dir);
514 }
515
516 static void gtfs_tf_rename(struct tree_file *tf, struct tree_file *old_parent,
517                            struct tree_file *new_parent, const char *name,
518                            int flags)
519 {
520         struct chan *tf_c = tf_to_gtfs_priv(tf)->be_walk;
521         struct chan *np_c = tf_to_gtfs_priv(new_parent)->be_walk;
522
523         if (!devtab[tf_c->type].rename) {
524                 /* 9p can handle intra-directory renames, though some Akaros #devices
525                  * might throw. */
526                 if (old_parent == new_parent) {
527                         gtfs_wstat_rename(&tf->file, name);
528                         return;
529                 }
530                 error(EXDEV, "%s: %s doesn't support rename", devname(),
531                       devtab[tf_c->type].name);
532         }
533         devtab[tf_c->type].rename(tf_c, np_c, name, flags);
534 }
535
536 static bool gtfs_tf_has_children(struct tree_file *parent)
537 {
538         struct dir dir[1];
539
540         assert(tree_file_is_dir(parent));       /* TF bug */
541         /* Any read should work, but there might be issues asking for something
542          * smaller than a dir.
543          *
544          * Note we use the unlocked read here.  The fs_file's qlock is held by our
545          * caller, and we reuse that qlock for the sync for reading/writing. */
546         return __gtfs_fsf_read(&parent->file, dir, sizeof(struct dir), 0) > 0;
547 }
548
549 struct tree_file_ops gtfs_tf_ops = {
550         .free = gtfs_tf_free,
551         .unlink = gtfs_tf_unlink,
552         .lookup = gtfs_tf_lookup,
553         .create = gtfs_tf_create,
554         .rename = gtfs_tf_rename,
555         .has_children = gtfs_tf_has_children,
556 };
557
558 /* Fills page with its contents from its backing store file.
559  *
560  * Note the page/offset might be beyond the current file length, based on the
561  * current pagemap code. */
562 static int gtfs_pm_readpage(struct page_map *pm, struct page *pg)
563 {
564         ERRSTACK(1);
565         void *kva = page2kva(pg);
566         off64_t offset = pg->pg_index << PGSHIFT;
567         size_t ret;
568
569         if (waserror()) {
570                 poperror();
571                 return -get_errno();
572         }
573         /* If offset is beyond the length of the file, the 9p device/server should
574          * return 0.  We'll just init an empty page.  The length on the frontend (in
575          * the fsf->dir.length) will be adjusted.  The backend will hear about it on
576          * the next sync. */
577         ret = gtfs_fsf_read(pm->pm_file, kva, PGSIZE, offset);
578         poperror();
579         if (ret < PGSIZE)
580                 memset(kva + ret, 0, PGSIZE - ret);
581         atomic_or(&pg->pg_flags, PG_UPTODATE);
582         return 0;
583 }
584
585 /* Meant to take the page from PM and flush to backing store. */
586 static int gtfs_pm_writepage(struct page_map *pm, struct page *pg)
587 {
588         ERRSTACK(1);
589         struct fs_file *f = pm->pm_file;
590         void *kva = page2kva(pg);
591         off64_t offset = pg->pg_index << PGSHIFT;
592         size_t amt;
593
594         qlock(&f->qlock);
595         if (waserror()) {
596                 qunlock(&f->qlock);
597                 poperror();
598                 return -get_errno();
599         }
600         /* Don't writeback beyond the length of the file.  Most of the time this
601          * comes up is when the len is in the middle of the last page. */
602         if (offset >= fs_file_get_length(f)) {
603                 qunlock(&f->qlock);
604                 return 0;
605         }
606         amt = MIN(PGSIZE, fs_file_get_length(f) - offset);
607         __gtfs_fsf_write(f, kva, amt, offset);
608         qunlock(&f->qlock);
609         poperror();
610         return 0;
611 }
612
613 /* Caller holds the file's qlock */
614 static void __trunc_to(struct fs_file *f, off64_t begin)
615 {
616         struct gtfs_priv *gp = fsf_to_gtfs_priv(f);
617         struct dir dir;
618
619         init_empty_dir(&dir);
620         dir.length = begin;
621         wstat_dir(f, &dir);
622         /* recall the invariant: be_length == the backend's length */
623         gp->be_length = begin;
624 }
625
626 /* Caller holds the file's qlock */
627 static void __zero_fill(struct fs_file *f, off64_t begin, off64_t end)
628 {
629         ERRSTACK(1);
630         void *zeros;
631
632         if (PGOFF(begin) || PGOFF(end))
633                 error(EINVAL, "zero_fill had unaligned begin (%p) or end (%p)\n",
634                       begin, end);
635         zeros = kpages_zalloc(PGSIZE, MEM_WAIT);
636         if (waserror()) {
637                 kpages_free(zeros, PGSIZE);
638                 nexterror();
639         }
640         for (off64_t o = begin; o < end; o += PGSIZE)
641                 __gtfs_fsf_write(f, zeros, PGSIZE, o);
642         poperror();
643 }
644
645 /* The intent here is for the backend to drop all data in the range.  Zeros are
646  * OK - any future read should get a zero.
647  *
648  * These offsets are the beginning and end of the hole to punch.  The TF code
649  * already dealt with edge cases, so these happen to be page aligned.  That
650  * shouldn't matter for the backend device.
651  *
652  * Don't worry about a border page for end that is all zeros.
653  * fs_file_truncate() rounded up to the nearest page to avoid issues.  The user
654  * could manually punch a hole, and they could create a page of zeros at end.
655  * We don't care.
656  *
657  * 9p doesn't have a hole-punch, so we'll truncate if we can and o/w fill with
658  * zeros.
659  *
660  * Note that the frontend's file length often differs from the backend.  Under
661  * normal operation, such as writing to a file, the frontend's len will be
662  * greater than the backend's.  When we sync, the backend learns the real
663  * length.  Similarly, when we shrink a gile, the backend's length may be
664  * greater than the frontend.  Consider a truncate from 8192 to 4095: we punch
665  * with begin = 4096, end = 8192.  In either case, the backend learns the real
666  * length on a sync.  In punch_hole, we're just trying to discard old data. */
667 static void gtfs_fs_punch_hole(struct fs_file *f, off64_t begin, off64_t end)
668 {
669         ERRSTACK(1);
670         struct gtfs_priv *gp = fsf_to_gtfs_priv(f);
671
672         qlock(&f->qlock);
673         if (waserror()) {
674                 qunlock(&f->qlock);
675                 nexterror();
676         }
677         if (end >= gp->be_length) {
678                 if (begin < gp->be_length)
679                         __trunc_to(f, begin);
680         } else {
681                 __zero_fill(f, begin, end);
682         }
683         qunlock(&f->qlock);
684         poperror();
685 }
686
687 static bool gtfs_fs_can_grow_to(struct fs_file *f, size_t len)
688 {
689         /* TODO: are there any limits in 9p? */
690         return true;
691 }
692
693 struct fs_file_ops gtfs_fs_ops = {
694         .readpage = gtfs_pm_readpage,
695         .writepage = gtfs_pm_writepage,
696         .punch_hole = gtfs_fs_punch_hole,
697         .can_grow_to = gtfs_fs_can_grow_to,
698 };
699
700 /* We're passed a backend chan, usually of type #mnt, used for an uncached
701  * mount.  We call it 'backend.'  It is the result of an attach, e.g. mntattach.
702  * In the case of #mnt, this chan is different than the one that has the 9p
703  * server on the other side, called 'mchan'.  That chan is at backend->mchan,
704  * and also the struct mnt->c.  The struct mnt is shared by all mounts talking
705  * to the 9p server over the mchan, and is stored at mchan->mux.  Backend chans
706  * have a strong (counted) ref on the mchan.
707  *
708  * We create and return a chan of #gtfs, suitable for attaching to the
709  * namespace.  This chan will have the root TF hanging off aux, just like how
710  * any other attached TFS has a root TF.  #gtfs manages the linkage between a TF
711  * and the backend, which is the purpose of gtfs_priv.
712  *
713  * A note on refcounts: in the normal, uncached operation, the 'backend' chan
714  * has a ref (actually a chan kref, which you cclose) on the comms chan (mchan).
715  * We get one ref at mntattach time, and every distinct mntwalk gets another
716  * ref.  Those actually get closed in chanfree(), since they are stored at
717  * mchan.
718  *
719  * All gtfs *tree_files* have at least one refcounted chan corresponding to the
720  * file/FID on the backend server.  Think of it as a 1:1 connection, even though
721  * there is more than one chan.  The gtfs device can have many chans pointing to
722  * the same TF, which is kreffed.  That TF is 1:1 on a backend object.
723  *
724  * All walks from this attach point will get chans with TFs from this TFS and
725  * will incref the struct gtfs.
726  */
727 static struct chan *gtfs_attach(char *arg)
728 {
729         ERRSTACK(2);
730         struct chan *backend = (struct chan*)arg;
731         struct chan *frontend;
732         struct tree_filesystem *tfs;
733         struct gtfs *gtfs;
734
735         frontend = devattach(devname(), 0);
736         if (waserror()) {
737                 /* same as #mnt - don't cclose, since we don't want to devtab close, and
738                  * we know the ref == 1 here. */
739                 chanfree(frontend);
740                 nexterror();
741         }
742         gtfs = kzmalloc(sizeof(struct gtfs), MEM_WAIT);
743         /* This 'users' kref is the one that every distinct frontend chan has.
744          * These come from attaches and successful, 'moving' walks. */
745         kref_init(&gtfs->users, gtfs_release, 1);
746         tfs = (struct tree_filesystem*)gtfs;
747         /* This gives us one ref on root, released during gtfs_release().  name is
748          * set to ".", though that gets overwritten during coupling. */
749         tfs_init(tfs);
750         if (waserror()) {
751                 /* don't consume the backend ref on error, caller expects to have it */
752                 tf_to_gtfs_priv(tfs->root)->be_walk = NULL;
753                 /* ref from tfs_init.  this should free the TF. */
754                 tf_kref_put(tfs->root);
755                 tfs_destroy(tfs);
756                 kfree(gtfs);
757                 nexterror();
758         }
759         /* stores the ref for 'backend' inside tfs->root */
760         gtfs_tf_couple_backend(tfs->root, backend);
761         poperror();
762         tfs->tf_ops = gtfs_tf_ops;
763         tfs->fs_ops = gtfs_fs_ops;
764         /* need another ref on root for the frontend chan */
765         tf_kref_get(tfs->root);
766         chan_set_tree_file(frontend, tfs->root);
767         poperror();
768         return frontend;
769 }
770
771 static bool lru_prune_cb(struct tree_file *tf)
772 {
773         ERRSTACK(1);
774
775         if (waserror()) {
776                 /* not much to do - ssh the file out? */
777                 printk("Failed to sync file %s: %s\n", tree_file_to_name(tf),
778                        current_errstr());
779                 poperror();
780                 return false;
781         }
782         writeback_file(&tf->file);
783         poperror();
784         return true;
785 }
786
787 static void pressure_dfs_cb(struct tree_file *tf)
788 {
789         if (!tree_file_is_dir(tf))
790                 pm_free_unused_pages(tf->file.pm);
791 }
792
793 /* Under memory pressure, there are a bunch of things we can do. */
794 static void gtfs_free_memory(struct gtfs *gtfs)
795 {
796         /* This attempts to remove every file from the LRU.  It'll write back dirty
797          * files, then if they haven't been used since we started, it'll delete the
798          * frontend TF, which will delete the entire page cache entry.  The heavy
799          * lifting is done by TF code. */
800         tfs_lru_for_each(&gtfs->tfs, lru_prune_cb, -1);
801         /* This drops the negative TFs.  It's not a huge deal, since they are small,
802          * but perhaps it'll help. */
803         tfs_lru_prune_neg(&gtfs->tfs);
804         /* This will attempt to free memory from all files in the frontend,
805          * regardless of whether or not they are in use.  This might help if you
806          * have some large files that happened to be open. */
807         tfs_frontend_for_each(&gtfs->tfs, pressure_dfs_cb);
808 }
809
810 static void gtfs_sync_tf(struct tree_file *tf)
811 {
812         writeback_file(&tf->file);
813 }
814
815 static void gtfs_sync_gtfs(struct gtfs *gtfs)
816 {
817         tfs_frontend_for_each(&gtfs->tfs, gtfs_sync_tf);
818 }
819
820 static void gtfs_sync_chan(struct chan *c)
821 {
822         gtfs_sync_tf(chan_to_tree_file(c));
823 }
824
825 static void gtfs_sync_chans_fs(struct chan *any_c)
826 {
827         gtfs_sync_gtfs(chan_to_gtfs(any_c));
828 }
829
830 static unsigned long gtfs_chan_ctl(struct chan *c, int op, unsigned long a1,
831                                    unsigned long a2, unsigned long a3,
832                                    unsigned long a4)
833 {
834         switch (op) {
835         case CCTL_SYNC:
836                 if (tree_file_is_dir(chan_to_tree_file(c)))
837                         gtfs_sync_chans_fs(c);
838                 else
839                         gtfs_sync_chan(c);
840                 return 0;
841         default:
842                 return tree_chan_ctl(c, op, a1, a2, a3, a4);
843         }
844 }
845
846 struct dev gtfs_devtab __devtab = {
847         .name = "gtfs",
848
849         .reset = devreset,
850         .init = devinit,
851         .shutdown = devshutdown,
852         .attach = gtfs_attach,
853         .walk = gtfs_walk,
854         .stat = tree_chan_stat,
855         .open = gtfs_open,
856         .create = gtfs_create,
857         .close = gtfs_close,
858         .read = gtfs_read,
859         .bread = devbread,
860         .write = tree_chan_write,
861         .bwrite = devbwrite,
862         .remove = gtfs_remove,
863         .rename = tree_chan_rename,
864         .wstat = gtfs_wstat,
865         .power = devpower,
866         .chaninfo = devchaninfo,
867         .mmap = tree_chan_mmap,
868         .chan_ctl = gtfs_chan_ctl,
869 };