Fix a few debugging tools
[akaros.git] / kern / src / ns / sysfile.c
1 /* Copyright © 1994-1999 Lucent Technologies Inc.  All rights reserved.
2  * Portions Copyright © 1997-1999 Vita Nuova Limited
3  * Portions Copyright © 2000-2007 Vita Nuova Holdings Limited
4  *                                (www.vitanuova.com)
5  * Revisions Copyright © 2000-2007 Lucent Technologies Inc. and others
6  *
7  * Modified for the Akaros operating system:
8  * Copyright (c) 2013-2014 The Regents of the University of California
9  * Copyright (c) 2013-2015 Google Inc.
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining a copy
12  * of this software and associated documentation files (the "Software"), to deal
13  * in the Software without restriction, including without limitation the rights
14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15  * copies of the Software, and to permit persons to whom the Software is
16  * furnished to do so, subject to the following conditions:
17  *
18  * The above copyright notice and this permission notice shall be included in
19  * all copies or substantial portions of the Software.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27  * SOFTWARE. */
28
29 #include <vfs.h>
30 #include <kfs.h>
31 #include <slab.h>
32 #include <kmalloc.h>
33 #include <kref.h>
34 #include <string.h>
35 #include <stdio.h>
36 #include <assert.h>
37 #include <error.h>
38 #include <cpio.h>
39 #include <pmap.h>
40 #include <smp.h>
41 #include <ip.h>
42
43 enum {
44         DIRSIZE = STATFIXLEN + 32 * 4,
45         DIRREADLIM = 2048,      /* should handle the largest reasonable directory entry */
46         DIRREADSIZE=8192,       /* Just read a lot. Memory is cheap, lots of bandwidth,
47                                  * and RPCs are very expensive. At the same time,
48                                  * let's not yet exceed a common MSIZE. */
49 };
50
51 int newfd(struct chan *c, int oflags)
52 {
53         int ret = insert_obj_fdt(&current->open_files, c, 0,
54                                  oflags & O_CLOEXEC ? FD_CLOEXEC : 0,
55                                  FALSE, FALSE);
56         if (ret >= 0)
57                 cclose(c);
58         return ret;
59 }
60
61 struct chan *fdtochan(struct fd_table *fdt, int fd, int mode, int chkmnt,
62                       int iref)
63 {
64         struct chan *c;
65
66         c = lookup_fd(fdt, fd, iref, FALSE);
67         if (!c) {
68                 /* We lost the info about why there was a problem (we used to track file
69                  * group closed too, can add that in later). */
70                 error(EBADF, ERROR_FIXME);
71         }
72         if (chkmnt && (c->flag & CMSG)) {
73                 if (iref)
74                         cclose(c);
75                 error(EBADF, ERROR_FIXME);
76         }
77         if (mode < 0)
78                 return c;
79         if ((mode & c->mode) != mode) {
80                 if (iref)
81                         cclose(c);
82                 error(EBADF,
83                       "FD access mode failure: chan mode 0x%x, wanted 0x%x (opened with 0 instead of O_READ?)",
84                       c->mode, mode);
85         }
86         return c;
87 }
88
89 long kchanio(void *vc, void *buf, int n, int mode)
90 {
91         ERRSTACK(1);
92         int r;
93         struct chan *c;
94
95         c = vc;
96         if (waserror()) {
97                 poperror();
98                 return -1;
99         }
100
101         if (mode == O_READ)
102                 r = devtab[c->type].read(c, buf, n, c->offset);
103         else if (mode == O_WRITE)
104                 r = devtab[c->type].write(c, buf, n, c->offset);
105         else
106                 error(ENOSYS, "kchanio: use only O_READ xor O_WRITE");
107
108         spin_lock(&c->lock);
109         c->offset += r;
110         spin_unlock(&c->lock);
111         poperror();
112         return r;
113 }
114
115 int openmode(uint32_t omode)
116 {
117 /* GIANT WARNING: if this ever throws, ipopen (and probably many others) will
118  * screw up refcnts of Qctl, err, data, etc */
119 #if 0
120         /* this is the old plan9 style.  i think they want to turn exec into read,
121          * and strip off anything higher, and just return the RD/WR style bits.  not
122          * stuff like ORCLOSE.  the lack of OEXCL might be a bug on their part (it's
123          * the only one of their non-RW-related flags that isn't masked out).
124          *
125          * Note that we no longer convert OEXEC/O_EXEC to O_READ, and instead return
126          * just the O_ACCMODE bits. */
127         if (o >= (OTRUNC | OCEXEC | ORCLOSE | OEXEC))
128                 error(EINVAL, ERROR_FIXME);
129         o &= ~(OTRUNC | OCEXEC | ORCLOSE);
130         if (o > OEXEC)
131                 error(EINVAL, ERROR_FIXME);
132         if (o == OEXEC)
133                 return OREAD;
134         return o;
135 #endif
136         /* no error checking (we have a shitload of flags anyway), and we return the
137          * basic access modes (RD/WR/ETC) */
138         return omode & O_ACCMODE;
139 }
140
141 void fdclose(struct fd_table *fdt, int fd)
142 {
143         close_fd(fdt, fd);
144 }
145
146 int syschdir(char *path)
147 {
148         ERRSTACK(1);
149         struct chan *c;
150         struct pgrp *pg;
151
152         if (waserror()) {
153                 poperror();
154                 return -1;
155         }
156
157         c = namec(path, Atodir, 0, 0);
158         pg = current->pgrp;
159         cclose(pg->dot);
160         pg->dot = c;
161         poperror();
162         return 0;
163 }
164
165 int sysclose(int fd)
166 {
167         ERRSTACK(1);
168         struct fd_table *fdt = &current->open_files;
169
170         if (waserror()) {
171                 poperror();
172                 return -1;
173         }
174         /*
175          * Take no reference on the chan because we don't really need the
176          * data structure, and are calling fdtochan only for error checks.
177          * fdclose takes care of processes racing through here.
178          */
179         fdtochan(fdt, fd, -1, 0, 0);
180         fdclose(fdt, fd);
181         poperror();
182         return 0;
183 }
184
185 int syscreate(char *path, int mode, uint32_t perm)
186 {
187         ERRSTACK(2);
188         int fd;
189         struct chan *c;
190
191         if (waserror()) {
192                 poperror();
193                 return -1;
194         }
195
196         openmode(mode & ~O_EXCL);       /* error check only; OEXCL okay here */
197         c = namec(path, Acreate, mode, perm);
198         if (waserror()) {
199                 cclose(c);
200                 nexterror();
201         }
202         fd = newfd(c, mode);    /* 9ns mode is the O_FLAGS and perm is glibc mode */
203         if (fd < 0)
204                 error(-fd, ERROR_FIXME);
205         poperror();
206
207         poperror();
208         return fd;
209 }
210
211 int sysdup(int old)
212 {
213         ERRSTACK(1);
214         int fd;
215         struct chan *c;
216
217         if (waserror()) {
218                 poperror();
219                 return -1;
220         }
221         c = fdtochan(&current->open_files, old, -1, 0, 1);
222         if (c->qid.type & QTAUTH) {
223                 cclose(c);
224                 error(EPERM, ERROR_FIXME);
225         }
226         fd = newfd(c, 0);
227         if (fd < 0) {
228                 cclose(c);
229                 error(-fd, ERROR_FIXME);
230         }
231         poperror();
232         return fd;
233 }
234
235 /* Could pass in the fdt instead of the proc, but we used to need the to_proc
236  * for now so we can claim a VFS FD.  Careful, we don't close the old chan. */
237 int sys_dup_to(struct proc *from_proc, unsigned int from_fd,
238                struct proc *to_proc, unsigned int to_fd)
239 {
240         ERRSTACK(1);
241         int ret;
242         struct chan *c;
243
244         if (waserror()) {
245                 poperror();
246                 return -1;
247         }
248         c = fdtochan(&from_proc->open_files, from_fd, -1, 0, 1);
249         if (c->qid.type & QTAUTH) {
250                 cclose(c);
251                 error(EPERM, ERROR_FIXME);
252         }
253         ret = insert_obj_fdt(&to_proc->open_files, c, to_fd, 0, TRUE, FALSE);
254         /* drop the ref from fdtochan.  if insert succeeded, there is one other ref
255          * stored in the FDT */
256         cclose(c);
257         if (ret < 0)
258                 error(EFAIL, "Can't insert FD %d into FDG", to_fd);
259         poperror();
260         return 0;
261 }
262
263 char *sysfd2path(int fd)
264 {
265         ERRSTACK(1);
266         struct chan *c;
267         char *s;
268
269         if (waserror()) {
270                 poperror();
271                 return NULL;
272         }
273         c = fdtochan(&current->open_files, fd, -1, 0, 1);
274         s = NULL;
275         if (c->name != NULL) {
276                 s = kzmalloc(c->name->len + 1, 0);
277                 if (s == NULL) {
278                         cclose(c);
279                         error(ENOMEM, ERROR_FIXME);
280                 }
281                 memmove(s, c->name->s, c->name->len + 1);
282         }
283         cclose(c);
284         poperror();
285         return s;
286 }
287
288 int sysfauth(int fd, char *aname)
289 {
290         ERRSTACK(2);
291         struct chan *c, *ac;
292
293         if (waserror()) {
294                 poperror();
295                 return -1;
296         }
297
298         validname(aname, 0);
299         c = fdtochan(&current->open_files, fd, O_RDWR, 0, 1);
300         if (waserror()) {
301                 cclose(c);
302                 nexterror();
303         }
304
305         ac = mntauth(c, aname);
306
307         /* at this point ac is responsible for keeping c alive */
308         poperror();     /* c */
309         cclose(c);
310
311         if (waserror()) {
312                 cclose(ac);
313                 nexterror();
314         }
315
316         fd = newfd(ac, 0);
317         if (fd < 0)
318                 error(-fd, ERROR_FIXME);
319         poperror();     /* ac */
320
321         poperror();
322
323         return fd;
324 }
325
326 int sysfversion(int fd, unsigned int msize, char *vers, unsigned int arglen)
327 {
328         ERRSTACK(2);
329         int m;
330         struct chan *c;
331
332         if (waserror()) {
333                 poperror();
334                 return -1;
335         }
336
337         /* check there's a NUL in the version string */
338         if (arglen == 0 || memchr(vers, 0, arglen) == 0)
339                 error(EINVAL, ERROR_FIXME);
340
341         c = fdtochan(&current->open_files, fd, O_RDWR, 0, 1);
342         if (waserror()) {
343                 cclose(c);
344                 nexterror();
345         }
346
347         m = mntversion(c, vers, msize, arglen);
348
349         poperror();
350         cclose(c);
351
352         poperror();
353         return m;
354 }
355
356 int sysfwstat(int fd, uint8_t * buf, int n)
357 {
358         ERRSTACK(2);
359         struct chan *c;
360
361         if (waserror()) {
362                 poperror();
363                 return -1;
364         }
365
366         validstat(buf, n, 0);
367         c = fdtochan(&current->open_files, fd, -1, 1, 1);
368         if (waserror()) {
369                 cclose(c);
370                 nexterror();
371         }
372         n = devtab[c->type].wstat(c, buf, n);
373         poperror();
374         cclose(c);
375
376         poperror();
377         return n;
378 }
379
380 long bindmount(struct chan *c, char *old, int flag, char *spec)
381 {
382         ERRSTACK(1);
383         int ret;
384         struct chan *c1;
385
386         if (flag > MMASK || (flag & MORDER) == (MBEFORE | MAFTER))
387                 error(EINVAL, ERROR_FIXME);
388
389         c1 = namec(old, Amount, 0, 0);
390         if (waserror()) {
391                 cclose(c1);
392                 nexterror();
393         }
394         ret = cmount(c, c1, flag, spec);
395
396         poperror();
397         cclose(c1);
398         return ret;
399 }
400
401 int sysbind(char *new, char *old, int flags)
402 {
403         ERRSTACK(2);
404         long r;
405         struct chan *c0;
406
407         if (waserror()) {
408                 poperror();
409                 return -1;
410         }
411
412         c0 = namec(new, Abind, 0, 0);
413         if (waserror()) {
414                 cclose(c0);
415                 nexterror();
416         }
417         r = bindmount(c0, old, flags, "");
418         poperror();
419         cclose(c0);
420
421         poperror();
422         return r;
423 }
424
425 int sysmount(int fd, int afd, char *old, int flags, char *spec)
426 {
427         ERRSTACK(1);
428         long r;
429         volatile struct {
430                 struct chan *c;
431         } c0;
432         volatile struct {
433                 struct chan *c;
434         } bc;
435         volatile struct {
436                 struct chan *c;
437         } ac;
438         struct mntparam mntparam;
439
440         ac.c = NULL;
441         bc.c = NULL;
442         c0.c = NULL;
443         if (waserror()) {
444                 cclose(ac.c);
445                 cclose(bc.c);
446                 cclose(c0.c);
447                 poperror();
448                 return -1;
449         }
450         bc.c = fdtochan(&current->open_files, fd, O_RDWR, 0, 1);
451         if (afd >= 0)
452                 ac.c = fdtochan(&current->open_files, afd, O_RDWR, 0, 1);
453         mntparam.chan = bc.c;
454         mntparam.authchan = ac.c;
455         mntparam.spec = spec;
456         mntparam.flags = flags;
457         c0.c = devtab[devno("mnt", 0)].attach((char *)&mntparam);
458
459         r = bindmount(c0.c, old, flags, spec);
460         poperror();
461         cclose(ac.c);
462         cclose(bc.c);
463         cclose(c0.c);
464
465         return r;
466 }
467
468 int sysunmount(char *src_path, char *onto_path)
469 {
470         ERRSTACK(1);
471         volatile struct {
472                 struct chan *c;
473         } cmount;
474         volatile struct {
475                 struct chan *c;
476         } cmounted;
477
478         cmount.c = NULL;
479         cmounted.c = NULL;
480         if (waserror()) {
481                 cclose(cmount.c);
482                 cclose(cmounted.c);
483                 poperror();
484                 return -1;
485         }
486
487         cmount.c = namec(onto_path, Amount, 0, 0);
488         if (src_path != NULL && src_path[0] != '\0') {
489                 /*
490                  * This has to be namec(..., Aopen, ...) because
491                  * if arg[0] is something like /srv/cs or /fd/0,
492                  * opening it is the only way to get at the real
493                  * Chan underneath.
494                  */
495                 cmounted.c = namec(src_path, Aopen, O_READ, 0);
496         }
497
498         cunmount(cmount.c, cmounted.c);
499         poperror();
500         cclose(cmount.c);
501         cclose(cmounted.c);
502         return 0;
503 }
504
505 int sysopenat(int fromfd, char *path, int vfs_flags)
506 {
507         ERRSTACK(1);
508         int fd;
509         struct chan *c = 0, *from = 0;
510
511         if (waserror()) {
512                 cclose(c);
513                 poperror();
514                 return -1;
515         }
516         openmode(vfs_flags);    /* error check only */
517         if ((path[0] == '/') || (fromfd == AT_FDCWD)) {
518                 c = namec(path, Aopen, vfs_flags, 0);
519         } else {
520                 /* We don't cclose from.  namec_from will convert it to the new chan
521                  * during the walk process (c).  It'll probably close from internally,
522                  * and give us something new for c.  On error, namec_from will cclose
523                  * from. */
524                 from = fdtochan(&current->open_files, fromfd, -1, FALSE, TRUE);
525                 c = namec_from(from, path, Aopen, vfs_flags, 0);
526         }
527         fd = newfd(c, vfs_flags);
528         if (fd < 0)
529                 error(-fd, ERROR_FIXME);
530         poperror();
531         return fd;
532 }
533
534 int sysopen(char *path, int vfs_flags)
535 {
536         return sysopenat(AT_FDCWD, path, vfs_flags);
537 }
538
539 long unionread(struct chan *c, void *va, long n)
540 {
541         ERRSTACK(1);
542         int i;
543         long nr;
544         struct mhead *m;
545         struct mount *mount;
546
547         qlock(&c->umqlock);
548         m = c->umh;
549         rlock(&m->lock);
550         mount = m->mount;
551         /* bring mount in sync with c->uri and c->umc */
552         for (i = 0; mount != NULL && i < c->uri; i++)
553                 mount = mount->next;
554
555         nr = 0;
556         while (mount != NULL) {
557                 /* Error causes component of union to be skipped */
558                 if (mount->to) {
559                         /* normally we want to discard the error, but for our ghetto kdirent
560                          * hack, we need to repeat unionread if we saw a ENODATA */
561                         if (waserror()) {
562                                 if (get_errno() == ENODATA) {
563                                         runlock(&m->lock);
564                                         qunlock(&c->umqlock);
565                                         nexterror();
566                                 }
567                                 /* poperror done below for either branch */
568                         } else {
569                                 if (c->umc == NULL) {
570                                         c->umc = cclone(mount->to);
571                                         c->umc = devtab[c->umc->type].open(c->umc,
572                                                                            O_READ);
573                                 }
574
575                                 nr = devtab[c->umc->type].read(c->umc, va, n, c->umc->offset);
576                                 if (nr < 0)
577                                         nr = 0; /* dev.c can return -1 */
578                                 c->umc->offset += nr;
579                         }
580                         poperror();     /* pop regardless */
581                 }
582                 if (nr > 0)
583                         break;
584
585                 /* Advance to next element */
586                 c->uri++;
587                 if (c->umc) {
588                         cclose(c->umc);
589                         c->umc = NULL;
590                 }
591                 mount = mount->next;
592         }
593         runlock(&m->lock);
594         qunlock(&c->umqlock);
595         return nr;
596 }
597
598 static void unionrewind(struct chan *c)
599 {
600         qlock(&c->umqlock);
601         c->uri = 0;
602         if (c->umc) {
603                 cclose(c->umc);
604                 c->umc = NULL;
605         }
606         qunlock(&c->umqlock);
607 }
608
609 static long rread(int fd, void *va, long n, int64_t * offp)
610 {
611         ERRSTACK(3);
612         int dir;
613         struct chan *c;
614         int64_t off;
615
616         /* dirty dirent hack */
617         void *real_va = va;
618
619         if (waserror()) {
620                 poperror();
621                 return -1;
622         }
623
624         c = fdtochan(&current->open_files, fd, O_READ, 1, 1);
625         if (waserror()) {
626                 cclose(c);
627                 nexterror();
628         }
629
630         if (n < 0)
631                 error(EINVAL, ERROR_FIXME);
632
633         dir = c->qid.type & QTDIR;
634
635         /* kdirent hack: userspace is expecting kdirents, but all of 9ns
636          * produces Ms.  Just save up what we don't use and append the
637          * new stuff later. Allocate DIRREADSIZE bytes for that purpose.
638          */
639         if (dir) {
640                 int amt;
641                 /* expecting only one dirent at a time, o/w we're busted */
642                 assert(n >= sizeof(struct kdirent));
643                 if (!c->buf) {
644                         c->buf = kmalloc(DIRREADSIZE, MEM_WAIT);
645                         c->bufused = 0;
646                 }
647                 /* Attempt to extract an M, in case there was some already */
648                 amt = convM2kdirent(c->buf, c->bufused, real_va, 0);
649                 if (amt) {
650                         c->bufused -= amt;
651                         memmove(c->buf, c->buf + amt, c->bufused);
652                         n = sizeof(struct kdirent);
653                         goto out;
654                 }
655                 /* debugging */
656                 if (waserror()) {
657                         printk("Well, sysread of a dir sucks.%s \n", current_errstr());
658                         nexterror();
659                 }
660                 va = c->buf + c->bufused;
661                 n = DIRREADSIZE - c->bufused;
662         }
663
664         /* this is the normal plan9 read */
665         if (dir && c->umh)
666                 n = unionread(c, va, n);
667         else {
668                 if (offp == NULL) {
669                         spin_lock(&c->lock);    /* lock for int64_t assignment */
670                         off = c->offset;
671                         spin_unlock(&c->lock);
672                 } else
673                         off = *offp;
674                 if (off < 0)
675                         error(EINVAL, ERROR_FIXME);
676                 if (off == 0) {
677                         if (offp == NULL) {
678                                 spin_lock(&c->lock);
679                                 c->offset = 0;
680                                 c->dri = 0;
681                                 spin_unlock(&c->lock);
682                         }
683                         unionrewind(c);
684                 }
685                 if (! c->ateof) {
686                         n = devtab[c->type].read(c, va, n, off);
687                         if (n == 0 && dir)
688                                 c->ateof = 1;
689                 } else {
690                         n = 0;
691                 }
692                 spin_lock(&c->lock);
693                 c->offset += n;
694                 spin_unlock(&c->lock);
695         }
696
697         /* dirty kdirent hack */
698         if (dir) {
699                 int amt;
700                 c->bufused = c->bufused + n;
701                 /* extract an M from the front, then shift the remainder back */
702                 amt = convM2kdirent(c->buf, c->bufused, real_va, 0);
703                 c->bufused -= amt;
704                 memmove(c->buf, c->buf + amt, c->bufused);
705                 n = amt ? sizeof(struct kdirent) : 0;
706                 poperror();     /* matching our debugging waserror */
707         }
708
709 out:
710         poperror();
711         cclose(c);
712
713         poperror();
714         return n;
715 }
716
717 /* Reads exactly n bytes from chan c, starting at its offset.  Can block, but if
718  * we get 0 back too soon (EOF or error), then we'll error out with ENODATA.
719  * That might need a little work - if there was a previous error, then we
720  * clobbered it and only know ENODATA but not why we completed early. */
721 void read_exactly_n(struct chan *c, void *vp, long n)
722 {
723         char *p;
724         long nn;
725         int total = 0, want = n;
726
727         p = vp;
728         while (n > 0) {
729                 nn = devtab[c->type].read(c, p, n, c->offset);
730                 printd("readn: Got %d@%lld\n", nn, c->offset);
731                 if (nn == 0)
732                         error(ENODATA, "wanted %d, got %d", want, total);
733                 spin_lock(&c->lock);
734                 c->offset += nn;
735                 spin_unlock(&c->lock);
736                 p += nn;
737                 n -= nn;
738                 total += nn;
739         }
740 }
741
742 long sysread(int fd, void *va, long n)
743 {
744         return rread(fd, va, n, NULL);
745 }
746
747 long syspread(int fd, void *va, long n, int64_t off)
748 {
749         return rread(fd, va, n, &off);
750 }
751
752 int sysremove(char *path)
753 {
754         ERRSTACK(2);
755         struct chan *c;
756
757         if (waserror()) {
758                 poperror();
759                 return -1;
760         }
761
762         c = namec(path, Aremove, 0, 0);
763         if (waserror()) {
764                 c->type = -1;   /* see below */
765                 cclose(c);
766                 nexterror();
767         }
768         devtab[c->type].remove(c);
769         /*
770          * Remove clunks the fid, but we need to recover the Chan
771          * so fake it up.  -1 aborts the dev's close.
772          */
773         c->type = -1;
774         poperror();
775         cclose(c);
776
777         poperror();
778         return 0;
779 }
780
781 int64_t sysseek(int fd, int64_t off, int whence)
782 {
783         ERRSTACK(2);
784         struct dir *dir;
785         struct chan *c;
786
787         if (waserror()) {
788                 poperror();
789                 return -1;
790         }
791
792         c = fdtochan(&current->open_files, fd, -1, 1, 1);
793         if (waserror()) {
794                 cclose(c);
795                 nexterror();
796         }
797         switch (whence) {
798                 case 0:
799                         if (c->qid.type & QTDIR) {
800                                 if (off != 0)
801                                         error(EISDIR, ERROR_FIXME);
802                                 unionrewind(c);
803                         } else if (off < 0)
804                                 error(EINVAL, ERROR_FIXME);
805                         spin_lock(&c->lock);    /* lock for int64_t assignment */
806                         c->offset = off;
807                         spin_unlock(&c->lock);
808                         break;
809
810                 case 1:
811                         if (c->qid.type & QTDIR)
812                                 error(EISDIR, ERROR_FIXME);
813                         spin_lock(&c->lock);    /* lock for read/write update */
814                         off += c->offset;
815                         if (off < 0) {
816                                 spin_unlock(&c->lock);
817                                 error(EINVAL, ERROR_FIXME);
818                         }
819                         c->offset = off;
820                         spin_unlock(&c->lock);
821                         break;
822
823                 case 2:
824                         if (c->qid.type & QTDIR)
825                                 error(EISDIR, ERROR_FIXME);
826                         dir = chandirstat(c);
827                         if (dir == NULL)
828                                 error(EFAIL, "internal error: stat error in seek");
829                         off += dir->length;
830                         kfree(dir);
831                         if (off < 0)
832                                 error(EINVAL, ERROR_FIXME);
833                         spin_lock(&c->lock);    /* lock for read/write update */
834                         c->offset = off;
835                         spin_unlock(&c->lock);
836                         break;
837
838                 default:
839                         error(EINVAL, ERROR_FIXME);
840                         break;
841         }
842         poperror();
843         c->dri = 0;
844         cclose(c);
845         poperror();
846         return off;
847 }
848
849 void validstat(uint8_t * s, int n, int slashok)
850 {
851
852         int m;
853         char buf[64];
854
855         if (statcheck(s, n) < 0)
856                 error(EINVAL, ERROR_FIXME);
857         /* verify that name entry is acceptable */
858         s += STATFIXLEN - 4 * BIT16SZ;  /* location of first string */
859         /*
860          * s now points at count for first string.
861          * if it's too long, let the server decide; this is
862          * only for his protection anyway. otherwise
863          * we'd have to allocate and waserror.
864          */
865         m = GBIT16(s);
866         s += BIT16SZ;
867         if (m + 1 > sizeof buf) {
868                 return;
869         }
870         memmove(buf, s, m);
871         buf[m] = '\0';
872         /* name could be '/' */
873         if (strcmp(buf, "/") != 0)
874                 validname(buf, slashok);
875 }
876
877 int sysfstat(int fd, uint8_t *buf, int n)
878 {
879         ERRSTACK(2);
880         struct chan *c;
881
882         if (waserror()) {
883                 poperror();
884                 return -1;
885         }
886
887         c = fdtochan(&current->open_files, fd, -1, 0, 1);
888         if (waserror()) {
889                 cclose(c);
890                 nexterror();
891         }
892         devtab[c->type].stat(c, buf, n);
893
894         poperror();
895         cclose(c);
896
897         poperror();
898         return n;
899 }
900
901 int sysfstatakaros(int fd, struct kstat *ks)
902 {
903
904         int n = 4096;
905         uint8_t *buf;
906         buf = kmalloc(n, MEM_WAIT);
907         n = sysfstat(fd, buf, n);
908         if (n > 0) {
909                 convM2kstat(buf, n, ks);
910                 n = 0;
911         }
912         kfree(buf);
913         return n;
914 }
915
916 int sysstat(char *path, uint8_t *buf, int n)
917 {
918         ERRSTACK(2);
919         struct chan *c;
920
921         if (waserror()) {
922                 poperror();
923                 return -1;
924         }
925
926         c = namec(path, Aaccess, 0, 0);
927         if (waserror()) {
928                 cclose(c);
929                 nexterror();
930         }
931         devtab[c->type].stat(c, buf, n);
932         poperror();
933         cclose(c);
934
935         poperror();
936
937         return n;
938 }
939
940 int sysstatakaros(char *path, struct kstat *ks)
941 {
942
943         int n = 4096;
944         uint8_t *buf;
945         buf = kmalloc(n, MEM_WAIT);
946         n = sysstat(path, buf, n);
947         if (n > 0) {
948                 convM2kstat(buf, n, ks);
949                 n = 0;
950         }
951         kfree(buf);
952         return n;
953 }
954
955 static long rwrite(int fd, void *va, long n, int64_t * offp)
956 {
957         ERRSTACK(3);
958         struct chan *c;
959         struct dir *dir;
960         int64_t off;
961         long m;
962
963         if (waserror()) {
964                 poperror();
965                 return -1;
966         }
967         c = fdtochan(&current->open_files, fd, O_WRITE, 1, 1);
968         if (waserror()) {
969                 cclose(c);
970                 nexterror();
971         }
972         if (c->qid.type & QTDIR)
973                 error(EISDIR, ERROR_FIXME);
974
975         if (n < 0)
976                 error(EINVAL, ERROR_FIXME);
977
978         if (offp == NULL) {
979                 /* append changes the offset to the end, and even if we fail later, this
980                  * change will persist */
981                 if (c->flag & O_APPEND) {
982                         dir = chandirstat(c);
983                         if (!dir)
984                                 error(EFAIL, "internal error: stat error in append write");
985                         spin_lock(&c->lock);    /* legacy lock for int64 assignment */
986                         c->offset = dir->length;
987                         spin_unlock(&c->lock);
988                         kfree(dir);
989                 }
990                 spin_lock(&c->lock);
991                 off = c->offset;
992                 c->offset += n;
993                 spin_unlock(&c->lock);
994         } else
995                 off = *offp;
996
997         if (waserror()) {
998                 if (offp == NULL) {
999                         spin_lock(&c->lock);
1000                         c->offset -= n;
1001                         spin_unlock(&c->lock);
1002                 }
1003                 nexterror();
1004         }
1005         if (off < 0)
1006                 error(EINVAL, ERROR_FIXME);
1007         m = devtab[c->type].write(c, va, n, off);
1008         poperror();
1009
1010         if (offp == NULL && m < n) {
1011                 spin_lock(&c->lock);
1012                 c->offset -= n - m;
1013                 spin_unlock(&c->lock);
1014         }
1015
1016         poperror();
1017         cclose(c);
1018
1019         poperror();
1020         return n;
1021 }
1022
1023 long syswrite(int fd, void *va, long n)
1024 {
1025         return rwrite(fd, va, n, NULL);
1026 }
1027
1028 long syspwrite(int fd, void *va, long n, int64_t off)
1029 {
1030         return rwrite(fd, va, n, &off);
1031 }
1032
1033 int syswstat(char *path, uint8_t * buf, int n)
1034 {
1035         ERRSTACK(2);
1036         struct chan *c;
1037
1038         if (waserror()) {
1039                 poperror();
1040                 return -1;
1041         }
1042
1043         validstat(buf, n, 0);
1044         c = namec(path, Aaccess, 0, 0);
1045         if (waserror()) {
1046                 cclose(c);
1047                 nexterror();
1048         }
1049         n = devtab[c->type].wstat(c, buf, n);
1050         poperror();
1051         cclose(c);
1052
1053         poperror();
1054         return n;
1055 }
1056
1057 struct dir *chandirstat(struct chan *c)
1058 {
1059         ERRSTACK(1);
1060         struct dir *d;
1061         uint8_t *buf;
1062         int n, nd, i;
1063
1064         nd = DIRSIZE;
1065         for (i = 0; i < 2; i++) {       /* should work by the second try */
1066                 d = kzmalloc(sizeof(struct dir) + nd, 0);
1067                 buf = (uint8_t *) & d[1];
1068                 if (waserror()) {
1069                         kfree(d);
1070                         poperror();
1071                         return NULL;
1072                 }
1073                 n = devtab[c->type].stat(c, buf, nd);
1074                 poperror();
1075                 if (n < BIT16SZ) {
1076                         kfree(d);
1077                         return NULL;
1078                 }
1079                 nd = GBIT16((uint8_t *) buf) + BIT16SZ; /* size needed to store whole stat buffer including count */
1080                 if (nd <= n) {
1081                         convM2D(buf, n, d, (char *)&d[1]);
1082                         return d;
1083                 }
1084                 /* else sizeof(Dir)+nd is plenty */
1085                 kfree(d);
1086         }
1087         return NULL;
1088
1089 }
1090
1091 struct dir *sysdirstat(char *name)
1092 {
1093         ERRSTACK(2);
1094         struct chan *c;
1095         struct dir *d;
1096
1097         if (waserror()) {
1098                 poperror();
1099                 return NULL;
1100         }
1101
1102         c = namec(name, Aaccess, 0, 0);
1103         if (waserror()) {
1104                 cclose(c);
1105                 nexterror();
1106         }
1107         d = chandirstat(c);
1108         poperror();
1109         cclose(c);
1110
1111         poperror();
1112         return d;
1113 }
1114
1115 struct dir *sysdirfstat(int fd)
1116 {
1117         ERRSTACK(2);
1118         struct chan *c;
1119         struct dir *d;
1120
1121         if (waserror()) {
1122                 poperror();
1123                 return NULL;
1124         }
1125
1126         c = fdtochan(&current->open_files, fd, -1, 0, 1);
1127         if (waserror()) {
1128                 cclose(c);
1129                 nexterror();
1130         }
1131         d = chandirstat(c);
1132         poperror();
1133         cclose(c);
1134
1135         poperror();
1136         return d;
1137 }
1138
1139 int sysdirwstat(char *name, struct dir *dir)
1140 {
1141
1142         uint8_t *buf;
1143         int r;
1144
1145         r = sizeD2M(dir);
1146         buf = kzmalloc(r, 0);
1147         convD2M(dir, buf, r);
1148         r = syswstat(name, buf, r);
1149         kfree(buf);
1150         return r < 0 ? r : 0;
1151 }
1152
1153 int sysdirfwstat(int fd, struct dir *dir)
1154 {
1155
1156         uint8_t *buf;
1157         int r;
1158
1159         r = sizeD2M(dir);
1160         buf = kzmalloc(r, 0);
1161         convD2M(dir, buf, r);
1162         r = sysfwstat(fd, buf, r);
1163         kfree(buf);
1164         return r < 0 ? r : 0;
1165 }
1166
1167 static long dirpackage(uint8_t * buf, long ts, struct kdirent **d)
1168 {
1169
1170         char *s;
1171         long ss, i, n, nn, m = 0;
1172
1173         *d = NULL;
1174         if (ts <= 0) {
1175                 return ts;
1176         }
1177
1178         /*
1179          * first find number of all stats, check they look like stats, & size all associated strings
1180          */
1181         ss = 0;
1182         n = 0;
1183         for (i = 0; i < ts; i += m) {
1184                 m = BIT16SZ + GBIT16(&buf[i]);
1185                 if (statcheck(&buf[i], m) < 0)
1186                         break;
1187                 ss += m;
1188                 n++;
1189         }
1190
1191         if (i != ts)
1192                 error(EFAIL, "bad directory format");
1193
1194         *d = kzmalloc(n * sizeof(**d) + ss, 0);
1195         if (*d == NULL)
1196                 error(ENOMEM, ERROR_FIXME);
1197
1198         /*
1199          * then convert all buffers
1200          */
1201         s = (char *)*d + n * sizeof(**d);
1202         nn = 0;
1203         for (i = 0; i < ts; i += m) {
1204                 m = BIT16SZ + GBIT16((uint8_t *) & buf[i]);
1205                 if (nn >= n || /*convM2D */ convM2kdirent(&buf[i], m, *d + nn, s) != m) {
1206                         kfree(*d);
1207                         *d = NULL;
1208                         error(EFAIL, "bad directory entry");
1209                 }
1210                 nn++;
1211                 s += m;
1212         }
1213
1214         return nn;
1215 }
1216
1217 long sysdirread(int fd, struct kdirent **d)
1218 {
1219         ERRSTACK(2);
1220         uint8_t *buf;
1221         long ts;
1222
1223         *d = NULL;
1224         if (waserror()) {
1225                 poperror();
1226                 return -1;
1227         }
1228         buf = kzmalloc(DIRREADLIM, 0);
1229         if (buf == NULL)
1230                 error(ENOMEM, ERROR_FIXME);
1231         if (waserror()) {
1232                 kfree(buf);
1233                 nexterror();
1234         }
1235         ts = sysread(fd, buf, DIRREADLIM);
1236         if (ts >= 0)
1237                 ts = dirpackage(buf, ts, d);
1238         poperror();
1239         kfree(buf);
1240         poperror();
1241         return ts;
1242 }
1243
1244 int sysiounit(int fd)
1245 {
1246         ERRSTACK(1);
1247         struct chan *c;
1248         int n;
1249
1250         c = fdtochan(&current->open_files, fd, -1, 0, 1);
1251         if (waserror()) {
1252                 cclose(c);
1253                 poperror();
1254                 return 0;       /* n.b. */
1255         }
1256         n = c->iounit;
1257         poperror();
1258         cclose(c);
1259         return n;
1260 }
1261
1262 void print_chaninfo(struct chan *c)
1263 {
1264
1265         char buf[128] = { 0 };
1266         bool has_dev = c->type != -1;
1267         bool has_chaninfo = has_dev && devtab[c->type].chaninfo;
1268
1269         printk("Chan flags: %p, pathname: %s, ref: %d, Dev: %s, Devinfo: %s",
1270                    c->flag,
1271                    c->name ? c->name->s : "no cname",
1272                    kref_refcnt(&c->ref),
1273                    has_dev ? devtab[c->type].name : "no dev",
1274                    has_chaninfo ? devtab[c->type].chaninfo(c, buf, sizeof(buf)) : "");
1275         if (!has_chaninfo)
1276                 printk("qid.path: %p\n", c->qid.path);
1277         printk("\n");
1278 }
1279
1280 /* TODO: 9ns ns inheritance flags: Shared, copied, or empty.  The old fgrp is
1281  * managed by the fd_table, which is handled outside this function.  We share
1282  * the pgrp. */
1283 int plan9setup(struct proc *new_proc, struct proc *parent, int flags)
1284 {
1285
1286         struct kref *new_dot_ref;
1287         ERRSTACK(1);
1288         if (waserror()) {
1289                 printk("plan9setup failed, %s\n", current_errstr());
1290                 poperror();
1291                 return -1;
1292         }
1293         if (!parent) {
1294                 /* We are probably spawned by the kernel directly, and have no parent to
1295                  * inherit from. */
1296                 new_proc->pgrp = newpgrp();
1297                 new_proc->slash = namec("#root", Atodir, 0, 0);
1298                 if (!new_proc->slash)
1299                         panic("no root device");
1300                 /* Want the name to be "/" instead of "#root" */
1301                 cnameclose(new_proc->slash->name);
1302                 new_proc->slash->name = newcname("/");
1303                 new_proc->dot = cclone(new_proc->slash);
1304                 poperror();
1305                 return 0;
1306         }
1307         /* Shared semantics */
1308         kref_get(&parent->pgrp->ref, 1);
1309         new_proc->pgrp = parent->pgrp;
1310         /* copy semantics on / and . (doesn't make a lot of sense in akaros o/w) */
1311         /* / should never disappear while we hold a ref to parent */
1312         chan_incref(parent->slash);
1313         new_proc->slash = parent->slash;
1314         /* dot could change concurrently, and we could fail to gain a ref if whoever
1315          * decref'd dot triggered the release.  if that did happen, new_proc->dot
1316          * should update and we can try again. */
1317         while (!(new_dot_ref = kref_get_not_zero(&parent->dot->ref, 1)))
1318                 cpu_relax();
1319         /* And now, we can't trust parent->dot, and need to determine our dot from
1320          * the ref we obtained. */
1321         new_proc->dot = container_of(new_dot_ref, struct chan, ref);
1322         poperror();
1323         return 0;
1324 }
1325
1326 /* Open flags, create modes, access types, file flags, and all that...
1327  *
1328  * there are a bunch of things here:
1329  *              1) file creation flags (e.g. O_TRUNC)
1330  *              2) file status flags (e.g. O_APPEND)
1331  *              3) file open modes (e.g. O_RDWR)
1332  *              4) file descriptor flags (e.g. CLOEXEC)
1333  *              5) file creation mode (e.g. S_IRWXU)
1334  * the 1-4 are passed in via open's vfs_flags, and the 5 via mode only when
1335  * O_CREATE is set.
1336  *
1337  * file creation flags (1) only matter when creating, but aren't permanent.
1338  * O_EXCL, O_DIRECTORY, O_TRUNC, etc.
1339  *
1340  * file status flags (2) are per struct file/chan.  stuff like O_APPEND,
1341  * O_ASYNC, etc.  we convert those to an internal flag bit and store in c->flags
1342  *
1343  * the open mode (3) matters for a given FD/chan (chan->mode), and should be
1344  * stored in the chan. (c->mode) stuff like O_RDONLY.
1345  *
1346  * the file descriptor flags (4) clearly are in the FD.  note that the same
1347  * file/chan can be opened by two different FDs, with different flags.  the only
1348  * one anyone uses is CLOEXEC.  while exec may not last long in akaros, i can
1349  * imagine similar "never pass to children" flags/meanings.
1350  *
1351  * the file creation mode (5) matters for the device's permissions; given this,
1352  * it should be stored in the device/inode.  ACLs fall under this category.
1353  *
1354  * finally, only certain categories can be edited afterwards: file status flags
1355  * (2), FD flags (4), and file permissions (5). */
1356 int fd_getfl(int fd)
1357 {
1358         ERRSTACK(1);
1359         struct chan *c;
1360         int ret;
1361
1362         if (waserror()) {
1363                 poperror();
1364                 return -1;
1365         }
1366         c = fdtochan(&current->open_files, fd, -1, 0, 1);
1367
1368         ret = c->mode;
1369         ret |= c->flag & CEXTERNAL_FLAGS;
1370
1371         cclose(c);
1372         poperror();
1373         return ret;
1374 }
1375
1376 static bool cexternal_flags_differ(int set1, int set2, int flags)
1377 {
1378         flags &= CEXTERNAL_FLAGS;
1379         return (set1 & flags) ^ (set2 & flags);
1380 }
1381
1382 int fd_setfl(int fd, int flags)
1383 {
1384         ERRSTACK(2);
1385         struct chan *c;
1386         int ret = 0;
1387
1388         if (waserror()) {
1389                 poperror();
1390                 return -1;
1391         }
1392         c = fdtochan(&current->open_files, fd, -1, 0, 1);
1393         if (waserror()) {
1394                 cclose(c);
1395                 nexterror();
1396         }
1397         if (cexternal_flags_differ(flags, c->flag, O_CLOEXEC)) {
1398                 /* TODO: The whole CCEXEC / O_CLOEXEC on 9ns needs work */
1399                 error(EINVAL, "can't toggle O_CLOEXEC with setfl");
1400         }
1401         if (cexternal_flags_differ(flags, c->flag, O_PATH))
1402                 error(EINVAL, "can't toggle O_PATH with setfl");
1403         /* Devices can do various prep work, including RPCs to other servers (#mnt)
1404          * for a chan_ctl operation.  If they want to not support the new flags,
1405          * they can throw an error. */
1406         if (devtab[c->type].chan_ctl)
1407                 ret = devtab[c->type].chan_ctl(c, flags & CEXTERNAL_FLAGS);
1408         c->flag = (c->flag & ~CEXTERNAL_FLAGS) | (flags & CEXTERNAL_FLAGS);
1409         poperror();
1410         cclose(c);
1411         poperror();
1412         return ret;
1413 }