qio: Remove q->len
[akaros.git] / kern / src / ns / chan.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 <syscall.h>
42
43 char *channame(struct chan *c)
44 {       /* DEBUGGING */
45         if (c == NULL)
46                 return "<NULL chan>";
47         if (c->name == NULL)
48                 return "<NULL name>";
49         if (c->name->s == NULL)
50                 return "<NULL name.s>";
51         return c->name->s;
52 }
53
54 enum {
55         CNAMESLOP = 20
56 };
57
58 struct {
59         spinlock_t lock;
60         int fid;
61         struct chan *free;
62         struct chan *list;
63 } chanalloc;
64
65 typedef struct Elemlist Elemlist;
66
67 struct Elemlist {
68         char *name;                                     /* copy of name, so '/' can be overwritten */
69         int ARRAY_SIZEs;
70         char **elems;
71         int *off;
72         int mustbedir;
73 };
74
75 #define SEP(c) ((c) == 0 || (c) == '/')
76 void cleancname(struct cname *);
77
78 int isdotdot(char *p)
79 {
80         return p[0] == '.' && p[1] == '.' && p[2] == '\0';
81 }
82
83 int emptystr(char *s)
84 {
85         if (s == NULL)
86                 return 1;
87         if (s[0] == '\0')
88                 return 1;
89         return 0;
90 }
91
92 /*
93  * Atomically replace *p with copy of s
94  */
95 void kstrdup(char **p, char *s)
96 {
97         int n;
98         char *t, *prev;
99
100         n = strlen(s) + 1;
101         /* if it's a user, we can wait for memory; if not, something's very wrong */
102         if (current) {
103                 t = kzmalloc(n, 0);
104         } else {
105                 t = kzmalloc(n, 0);
106                 if (t == NULL)
107                         panic("kstrdup: no memory");
108         }
109         memmove(t, s, n);
110         prev = *p;
111         *p = t;
112         kfree(prev);
113 }
114
115 void chandevreset(void)
116 {
117         int i;
118
119         for (i = 0; &devtab[i] < __devtabend; i++) {
120                 if (devtab[i].reset)
121                         devtab[i].reset();
122         }
123 }
124
125 void chandevinit(void)
126 {
127         int i;
128
129         for (i = 0; &devtab[i] < __devtabend; i++) {
130                 if (devtab[i].init)
131                         devtab[i].init();
132         }
133 }
134
135 void chandevshutdown(void)
136 {
137         int i;
138
139         /* shutdown in reverse order */
140         for (i = 0; &devtab[i] < __devtabend; i++) ;
141         for (i--; i >= 0; i--) {
142                 if (devtab[i].shutdown)
143                         devtab[i].shutdown();
144         }
145 }
146
147 static void chan_release(struct kref *kref)
148 {
149         struct chan *c = container_of(kref, struct chan, ref);
150         ERRSTACK(1);
151         /* this style discards the error from close().  picture it as
152          * if (waserror()) { } else { close(); } chanfree_no_matter_what();  */
153         if (!waserror()) {
154                 printd("releasing chan %p, type %d\n", c, c->type);
155                 /* -1 means there is no dev yet.  wants a noop for close() */
156                 if (c->type != -1)
157                         devtab[c->type].close(c);
158         }
159         /* need to poperror regardless of whether we error'd or not */
160         poperror();
161         /* and chan free no matter what */
162         chanfree(c);
163 }
164
165 struct chan *newchan(void)
166 {
167         struct chan *c;
168
169         spin_lock(&(&chanalloc)->lock);
170         c = chanalloc.free;
171         if (c != 0)
172                 chanalloc.free = c->next;
173         spin_unlock(&(&chanalloc)->lock);
174
175         if (c == NULL) {
176                 c = kzmalloc(sizeof(struct chan), 0);
177                 spin_lock(&(&chanalloc)->lock);
178                 c->fid = ++chanalloc.fid;
179                 c->link = chanalloc.list;
180                 chanalloc.list = c;
181                 spin_unlock(&(&chanalloc)->lock);
182                 spinlock_init(&c->lock);
183                 qlock_init(&c->umqlock);
184         }
185
186         /* if you get an error before associating with a dev, cclose skips calling
187          * the dev's close */
188         c->type = -1;
189         c->flag = 0;
190         kref_init(&c->ref, chan_release, 1);
191         c->dev = 0;
192         c->offset = 0;
193         c->iounit = 0;
194         c->umh = 0;
195         c->uri = 0;
196         c->dri = 0;
197         c->aux = 0;
198         c->mchan = 0;
199         c->mcp = 0;
200         c->mux = 0;
201         c->mqid.path = 0;
202         c->mqid.vers = 0;
203         c->mqid.type = 0;
204         c->name = 0;
205         c->buf = NULL;
206         c->mountpoint = NULL;
207         return c;
208 }
209
210 static void __cname_release(struct kref *kref)
211 {
212         struct cname *n = container_of(kref, struct cname, ref);
213         kfree(n->s);
214         kfree(n);
215 }
216
217 struct cname *newcname(char *s)
218 {
219         struct cname *n;
220         int i;
221
222         n = kzmalloc(sizeof(*n), 0);
223         i = strlen(s);
224         n->len = i;
225         n->alen = i + CNAMESLOP;
226         n->s = kzmalloc(n->alen, 0);
227         memmove(n->s, s, i + 1);
228         kref_init(&n->ref, __cname_release, 1);
229         return n;
230 }
231
232 void cnameclose(struct cname *n)
233 {
234         if (n == NULL)
235                 return;
236         kref_put(&n->ref);
237 }
238
239 struct cname *addelem(struct cname *n, char *s)
240 {
241         int i, a;
242         char *t;
243         struct cname *new;
244
245         if (s[0] == '.' && s[1] == '\0')
246                 return n;
247
248         if (kref_refcnt(&n->ref) > 1) {
249                 /* copy on write */
250                 new = newcname(n->s);
251                 cnameclose(n);
252                 n = new;
253         }
254
255         i = strlen(s);
256         if (n->len + 1 + i + 1 > n->alen) {
257                 a = n->len + 1 + i + 1 + CNAMESLOP;
258                 t = kzmalloc(a, 0);
259                 memmove(t, n->s, n->len + 1);
260                 kfree(n->s);
261                 n->s = t;
262                 n->alen = a;
263         }
264         if (n->len > 0 && n->s[n->len - 1] != '/' && s[0] != '/')       /* don't insert extra slash if one is present */
265                 n->s[n->len++] = '/';
266         memmove(n->s + n->len, s, i + 1);
267         n->len += i;
268         if (isdotdot(s))
269                 cleancname(n);
270         return n;
271 }
272
273 void chanfree(struct chan *c)
274 {
275         c->flag = CFREE;
276
277         if (c->umh != NULL) {
278                 putmhead(c->umh);
279                 c->umh = NULL;
280         }
281         if (c->umc != NULL) {
282                 cclose(c->umc);
283                 c->umc = NULL;
284         }
285         if (c->mux != NULL) {
286                 //
287                 muxclose(c->mux);
288                 c->mux = NULL;
289         }
290         if (c->mchan != NULL) {
291                 cclose(c->mchan);
292                 c->mchan = NULL;
293         }
294
295         cnameclose(c->name);
296         if (c->buf)
297                 kfree(c->buf);
298         c->buf = NULL;
299         c->bufused = 0;
300         c->ateof = 0;
301
302         spin_lock(&(&chanalloc)->lock);
303         c->next = chanalloc.free;
304         chanalloc.free = c;
305         spin_unlock(&(&chanalloc)->lock);
306 }
307
308 void cclose(struct chan *c)
309 {
310         if (c == 0)
311                 return;
312
313         if (c->flag & CFREE)
314                 panic("cclose %p", getcallerpc(&c));
315
316         kref_put(&c->ref);
317 }
318
319 /* convenience wrapper for interposition.  if you do use this, don't forget
320  * about the kref_get_not_zero in plan9setup() */
321 void chan_incref(struct chan *c)
322 {
323         kref_get(&c->ref, 1);
324 }
325
326 /*
327  * Make sure we have the only copy of c.  (Copy on write.)
328  */
329 struct chan *cunique(struct chan *c)
330 {
331         struct chan *nc;
332
333         if (kref_refcnt(&c->ref) != 1) {
334                 nc = cclone(c);
335                 cclose(c);
336                 c = nc;
337         }
338
339         return c;
340 }
341
342 int eqqid(struct qid a, struct qid b)
343 {
344         return a.path == b.path && a.vers == b.vers;
345 }
346
347 int eqchan(struct chan *a, struct chan *b, int pathonly)
348 {
349         if (a->qid.path != b->qid.path)
350                 return 0;
351         if (!pathonly && a->qid.vers != b->qid.vers)
352                 return 0;
353         if (a->type != b->type)
354                 return 0;
355         if (a->dev != b->dev)
356                 return 0;
357         return 1;
358 }
359
360 int eqchantdqid(struct chan *a, int type, int dev, struct qid qid, int pathonly)
361 {
362         if (a->qid.path != qid.path)
363                 return 0;
364         if (!pathonly && a->qid.vers != qid.vers)
365                 return 0;
366         if (a->type != type)
367                 return 0;
368         if (a->dev != dev)
369                 return 0;
370         return 1;
371 }
372
373 static void mh_release(struct kref *kref)
374 {
375         struct mhead *mh = container_of(kref, struct mhead, ref);
376         mh->mount = (struct mount *)0xCafeBeef;
377         kfree(mh);
378 }
379
380 struct mhead *newmhead(struct chan *from)
381 {
382         struct mhead *mh;
383
384         mh = kzmalloc(sizeof(struct mhead), 0);
385         kref_init(&mh->ref, mh_release, 1);
386         rwinit(&mh->lock);
387         mh->from = from;
388         chan_incref(from);
389
390 /*
391         n = from->name->len;
392         if(n >= sizeof(mh->fromname))
393                 n = sizeof(mh->fromname)-1;
394         memmove(mh->fromname, from->name->s, n);
395         mh->fromname[n] = 0;
396 */
397         return mh;
398 }
399
400 int cmount(struct chan *new, struct chan *old, int flag, char *spec)
401 {
402         ERRSTACK(1);
403         struct pgrp *pg;
404         int order, flg;
405         struct mhead *m, **l, *mh;
406         struct mount *nm, *f, *um, **h;
407
408         if (QTDIR & (old->qid.type ^ new->qid.type))
409                 error(EINVAL, ERROR_FIXME);
410
411         if (old->umh)
412                 printd("cmount old extra umh\n");
413
414         order = flag & MORDER;
415
416         if ((old->qid.type & QTDIR) == 0 && order != MREPL)
417                 error(EINVAL, ERROR_FIXME);
418
419         mh = new->umh;
420
421         /*
422          * Not allowed to bind when the old directory
423          * is itself a union.  (Maybe it should be allowed, but I don't see
424          * what the semantics would be.)
425          *
426          * We need to check mh->mount->next to tell unions apart from
427          * simple mount points, so that things like
428          *  mount -c fd /root
429          *  bind -c /root /
430          * work.  The check of mount->mflag catches things like
431          *  mount fd /root
432          *  bind -c /root /
433          *
434          * This is far more complicated than it should be, but I don't
435          * see an easier way at the moment.     -rsc
436          */
437         if ((flag & MCREATE) && mh && mh->mount
438                 && (mh->mount->next || !(mh->mount->mflag & MCREATE)))
439                 error(EEXIST, ERROR_FIXME);
440
441         pg = current->pgrp;
442         wlock(&pg->ns);
443
444         l = &MOUNTH(pg, old->qid);
445         for (m = *l; m; m = m->hash) {
446                 if (eqchan(m->from, old, 1))
447                         break;
448                 l = &m->hash;
449         }
450
451         if (m == NULL) {
452                 /*
453                  *  nothing mounted here yet.  create a mount
454                  *  head and add to the hash table.
455                  */
456                 m = newmhead(old);
457                 *l = m;
458
459                 /*
460                  *  if this is a union mount, add the old
461                  *  node to the mount chain.
462                  */
463                 if (order != MREPL)
464                         m->mount = newmount(m, old, 0, 0);
465         }
466         wlock(&m->lock);
467         if (waserror()) {
468                 wunlock(&m->lock);
469                 nexterror();
470         }
471         wunlock(&pg->ns);
472
473         nm = newmount(m, new, flag, spec);
474         if (mh != NULL && mh->mount != NULL) {
475                 /*
476                  *  copy a union when binding it onto a directory
477                  */
478                 flg = order;
479                 if (order == MREPL)
480                         flg = MAFTER;
481                 h = &nm->next;
482                 um = mh->mount;
483                 for (um = um->next; um; um = um->next) {
484                         f = newmount(m, um->to, flg, um->spec);
485                         *h = f;
486                         h = &f->next;
487                 }
488         }
489
490         if (m->mount && order == MREPL) {
491                 mountfree(m->mount);
492                 m->mount = 0;
493         }
494
495         if (flag & MCREATE)
496                 nm->mflag |= MCREATE;
497
498         if (m->mount && order == MAFTER) {
499                 for (f = m->mount; f->next; f = f->next) ;
500                 f->next = nm;
501         } else {
502                 for (f = nm; f->next; f = f->next) ;
503                 f->next = m->mount;
504                 m->mount = nm;
505         }
506
507         wunlock(&m->lock);
508         poperror();
509         return nm->mountid;
510 }
511
512 void cunmount(struct chan *mnt, struct chan *mounted)
513 {
514         struct pgrp *pg;
515         struct mhead *m, **l;
516         struct mount *f, **p;
517
518         if (mnt->umh)   /* should not happen */
519                 printd("cunmount newp extra umh %p has %p\n", mnt, mnt->umh);
520
521         /*
522          * It _can_ happen that mounted->umh is non-NULL,
523          * because mounted is the result of namec(Aopen)
524          * (see sysfile.c:/^sysunmount).
525          * If we open a union directory, it will have a umh.
526          * Although surprising, this is okay, since the
527          * cclose will take care of freeing the umh.
528          */
529
530         pg = current->pgrp;
531         wlock(&pg->ns);
532
533         l = &MOUNTH(pg, mnt->qid);
534         for (m = *l; m; m = m->hash) {
535                 if (eqchan(m->from, mnt, 1))
536                         break;
537                 l = &m->hash;
538         }
539
540         if (m == 0) {
541                 wunlock(&pg->ns);
542                 error(ENOENT, ERROR_FIXME);
543         }
544
545         wlock(&m->lock);
546         if (mounted == 0) {
547                 *l = m->hash;
548                 wunlock(&pg->ns);
549                 mountfree(m->mount);
550                 m->mount = NULL;
551                 cclose(m->from);
552                 wunlock(&m->lock);
553                 putmhead(m);
554                 return;
555         }
556
557         p = &m->mount;
558         for (f = *p; f; f = f->next) {
559                 /* BUG: Needs to be 2 pass */
560                 if (eqchan(f->to, mounted, 1) ||
561                         (f->to->mchan && eqchan(f->to->mchan, mounted, 1))) {
562                         *p = f->next;
563                         f->next = 0;
564                         mountfree(f);
565                         if (m->mount == NULL) {
566                                 *l = m->hash;
567                                 cclose(m->from);
568                                 wunlock(&m->lock);
569                                 wunlock(&pg->ns);
570                                 putmhead(m);
571                                 return;
572                         }
573                         wunlock(&m->lock);
574                         wunlock(&pg->ns);
575                         return;
576                 }
577                 p = &f->next;
578         }
579         wunlock(&m->lock);
580         wunlock(&pg->ns);
581         error(ENOENT, ERROR_FIXME);
582 }
583
584 struct chan *cclone(struct chan *c)
585 {
586         struct chan *nc;
587         struct walkqid *wq;
588
589         wq = devtab[c->type].walk(c, NULL, NULL, 0);
590         if (wq == NULL)
591                 error(EFAIL, "clone failed");
592         nc = wq->clone;
593         kfree(wq);
594         nc->name = c->name;
595         if (c->name)
596                 kref_get(&c->name->ref, 1);
597         return nc;
598 }
599
600 int
601 findmount(struct chan **cp,
602                   struct mhead **mp, int type, int dev, struct qid qid)
603 {
604         struct pgrp *pg;
605         struct mhead *m;
606
607         pg = current->pgrp;
608         rlock(&pg->ns);
609         for (m = MOUNTH(pg, qid); m; m = m->hash) {
610                 rlock(&m->lock);
611                 if (m->from == NULL) {
612                         printd("m %p m->from 0\n", m);
613                         runlock(&m->lock);
614                         continue;
615                 }
616                 if (eqchantdqid(m->from, type, dev, qid, 1)) {
617                         runlock(&pg->ns);
618                         if (mp != NULL) {
619                                 kref_get(&m->ref, 1);
620                                 if (*mp != NULL)
621                                         putmhead(*mp);
622                                 *mp = m;
623                         }
624                         if (*cp != NULL)
625                                 cclose(*cp);
626                         chan_incref(m->mount->to);
627                         *cp = m->mount->to;
628                         runlock(&m->lock);
629                         return 1;
630                 }
631                 runlock(&m->lock);
632         }
633
634         runlock(&pg->ns);
635         return 0;
636 }
637
638 int domount(struct chan **cp, struct mhead **mp)
639 {
640         return findmount(cp, mp, (*cp)->type, (*cp)->dev, (*cp)->qid);
641 }
642
643 struct chan *undomount(struct chan *c, struct cname *name)
644 {
645         ERRSTACK(1);
646         struct chan *nc;
647         struct pgrp *pg;
648         struct mount *t;
649         struct mhead **h, **he, *f;
650
651         pg = current->pgrp;
652         rlock(&pg->ns);
653         if (waserror()) {
654                 runlock(&pg->ns);
655                 nexterror();
656         }
657
658         he = &pg->mnthash[MNTHASH];
659         for (h = pg->mnthash; h < he; h++) {
660                 for (f = *h; f; f = f->hash) {
661                         if (strcmp(f->from->name->s, name->s) != 0)
662                                 continue;
663                         for (t = f->mount; t; t = t->next) {
664                                 if (eqchan(c, t->to, 1)) {
665                                         /*
666                                          * We want to come out on the left hand side of the mount
667                                          * point using the element of the union that we entered on.
668                                          * To do this, find the element that has a from name of
669                                          * c->name->s.
670                                          */
671                                         if (strcmp(t->head->from->name->s, name->s) != 0)
672                                                 continue;
673                                         nc = t->head->from;
674                                         chan_incref(nc);
675                                         cclose(c);
676                                         c = nc;
677                                         break;
678                                 }
679                         }
680                 }
681         }
682         poperror();
683         runlock(&pg->ns);
684         return c;
685 }
686
687 /*
688  * Either walks all the way or not at all.  No partial results in *cp.
689  * *nerror is the number of names to display in an error message.
690  */
691 int walk(struct chan **cp, char **names, int nnames, bool can_mount, int *nerror)
692 {
693         int dev, dotdot, i, n, nhave, ntry, type;
694         struct chan *c, *nc, *lastmountpoint = NULL;
695         struct cname *cname;
696         struct mount *f;
697         struct mhead *mh, *nmh;
698         struct walkqid *wq;
699
700         c = *cp;
701         chan_incref(c);
702         cname = c->name;
703         kref_get(&cname->ref, 1);
704         mh = NULL;
705
706         /*
707          * While we haven't gotten all the way down the path:
708          *    1. step through a mount point, if any
709          *    2. send a walk request for initial dotdot or initial prefix without dotdot
710          *    3. move to the first mountpoint along the way.
711          *    4. repeat.
712          *
713          * An invariant is that each time through the loop, c is on the undomount
714          * side of the mount point, and c's name is cname.
715          */
716         for (nhave = 0; nhave < nnames; nhave += n) {
717                 if ((c->qid.type & QTDIR) == 0) {
718                         if (nerror)
719                                 *nerror = nhave;
720                         cnameclose(cname);
721                         cclose(c);
722                         set_error(ENOTDIR, ERROR_FIXME);
723                         if (mh != NULL)
724                                 putmhead(mh);
725                         return -1;
726                 }
727                 ntry = nnames - nhave;
728                 if (ntry > MAXWELEM)
729                         ntry = MAXWELEM;
730                 dotdot = 0;
731                 for (i = 0; i < ntry; i++) {
732                         if (isdotdot(names[nhave + i])) {
733                                 if (i == 0) {
734                                         dotdot = 1;
735                                         ntry = 1;
736                                 } else
737                                         ntry = i;
738                                 break;
739                         }
740                 }
741
742                 if (!dotdot && can_mount)
743                         domount(&c, &mh);
744
745                 type = c->type;
746                 dev = c->dev;
747
748                 if ((wq = devtab[type].walk(c, NULL, names + nhave, ntry)) == NULL) {
749                         /* try a union mount, if any */
750                         if (mh && can_mount) {
751                                 /*
752                                  * mh->mount == c, so start at mh->mount->next
753                                  */
754                                 rlock(&mh->lock);
755                                 for (f = mh->mount->next; f; f = f->next)
756                                         if ((wq =
757                                                  devtab[f->to->type].walk(f->to, NULL, names + nhave,
758                                                                                                   ntry)) != NULL)
759                                                 break;
760                                 runlock(&mh->lock);
761                                 if (f != NULL) {
762                                         type = f->to->type;
763                                         dev = f->to->dev;
764                                 }
765                         }
766                         if (wq == NULL) {
767                                 cclose(c);
768                                 cnameclose(cname);
769                                 if (nerror)
770                                         *nerror = nhave + 1;
771                                 if (mh != NULL)
772                                         putmhead(mh);
773                                 return -1;
774                         }
775                 }
776
777                 nmh = NULL;
778                 if (dotdot) {
779                         assert(wq->nqid == 1);
780                         assert(wq->clone != NULL);
781
782                         cname = addelem(cname, "..");
783                         nc = undomount(wq->clone, cname);
784                         n = 1;
785                 } else {
786                         nc = NULL;
787                         if (can_mount)
788                                 for (i = 0; i < wq->nqid && i < ntry - 1; i++)
789                                         if (findmount(&nc, &nmh, type, dev, wq->qid[i]))
790                                                 break;
791                         if (nc == NULL) {       /* no mount points along path */
792                                 if (wq->clone == NULL) {
793                                         cclose(c);
794                                         cnameclose(cname);
795                                         if (wq->nqid == 0 || (wq->qid[wq->nqid - 1].type & QTDIR)) {
796                                                 if (nerror)
797                                                         *nerror = nhave + wq->nqid + 1;
798                                                 set_error(ENOENT, "walk failed");
799                                         } else {
800                                                 if (nerror)
801                                                         *nerror = nhave + wq->nqid;
802                                                 set_error(ENOTDIR, "walk failed");
803                                         }
804                                         kfree(wq);
805                                         if (mh != NULL)
806                                                 putmhead(mh);
807                                         return -1;
808                                 }
809                                 n = wq->nqid;
810                                 nc = wq->clone;
811                         } else {        /* stopped early, at a mount point */
812                                 if (wq->clone != NULL) {
813                                         cclose(wq->clone);
814                                         wq->clone = NULL;
815                                 }
816                                 lastmountpoint = nc;
817                                 n = i + 1;
818                         }
819                         for (i = 0; i < n; i++)
820                                 cname = addelem(cname, names[nhave + i]);
821                 }
822                 cclose(c);
823                 c = nc;
824                 putmhead(mh);
825                 mh = nmh;
826                 kfree(wq);
827         }
828
829         putmhead(mh);
830
831         c = cunique(c);
832
833         if (c->umh != NULL) {   //BUG
834                 printd("walk umh\n");
835                 putmhead(c->umh);
836                 c->umh = NULL;
837         }
838
839         cnameclose(c->name);
840         c->name = cname;
841         c->mountpoint = lastmountpoint;
842
843         cclose(*cp);
844         *cp = c;
845         if (nerror)
846                 *nerror = 0;
847         return 0;
848 }
849
850 /*
851  * c is a mounted non-creatable directory.  find a creatable one.
852  */
853 struct chan *createdir(struct chan *c, struct mhead *m)
854 {
855         ERRSTACK(1);
856         struct chan *nc;
857         struct mount *f;
858
859         rlock(&m->lock);
860         if (waserror()) {
861                 runlock(&m->lock);
862                 nexterror();
863         }
864         for (f = m->mount; f; f = f->next) {
865                 if (f->mflag & MCREATE) {
866                         nc = cclone(f->to);
867                         runlock(&m->lock);
868                         poperror();
869                         cclose(c);
870                         return nc;
871                 }
872         }
873         error(EPERM, ERROR_FIXME);
874         poperror();
875         return 0;
876 }
877
878 /*
879  * In place, rewrite name to compress multiple /, eliminate ., and process ..
880  */
881 void cleancname(struct cname *n)
882 {
883         char *p;
884
885         if (n->s[0] == '#') {
886                 p = strchr(n->s, '/');
887                 if (p == NULL)
888                         return;
889                 cleanname(p);
890
891                 /*
892                  * The correct name is #i rather than #i/,
893                  * but the correct name of #/ is #/.
894                  */
895                 if (strcmp(p, "/") == 0 && n->s[1] != '/')
896                         *p = '\0';
897         } else
898                 cleanname(n->s);
899         n->len = strlen(n->s);
900 }
901
902 static void growparse(Elemlist * e)
903 {
904         char **new;
905         int *inew;
906         enum { Delta = 8 };
907
908         if (e->ARRAY_SIZEs % Delta == 0) {
909                 new = kzmalloc((e->ARRAY_SIZEs + Delta) * sizeof(char *), 0);
910                 memmove(new, e->elems, e->ARRAY_SIZEs * sizeof(char *));
911                 kfree(e->elems);
912                 e->elems = new;
913                 inew = kzmalloc((e->ARRAY_SIZEs + Delta + 1) * sizeof(int), 0);
914                 memmove(inew, e->off, e->ARRAY_SIZEs * sizeof(int));
915                 kfree(e->off);
916                 e->off = inew;
917         }
918 }
919
920 /*
921  * The name is known to be valid.
922  * Copy the name so slashes can be overwritten.
923  * An empty string will set ARRAY_SIZE=0.
924  * A path ending in / or /. or /.//./ etc. will have
925  * e.mustbedir = 1, so that we correctly
926  * reject, e.g., "/adm/users/." when /adm/users is a file
927  * rather than a directory.
928  */
929 static void parsename(char *name, Elemlist * e)
930 {
931         char *slash;
932
933         kstrdup(&e->name, name);
934         name = e->name;
935         e->ARRAY_SIZEs = 0;
936         e->elems = NULL;
937         e->off = kzmalloc(sizeof(int), 0);
938         e->off[0] = skipslash(name) - name;
939         for (;;) {
940                 name = skipslash(name);
941                 if (*name == '\0') {
942                         e->mustbedir = 1;
943                         break;
944                 }
945                 growparse(e);
946
947                 e->elems[e->ARRAY_SIZEs++] = name;
948                 /* we may want to do this again some day
949                    slash = utfrune(name, '/');
950                  */
951                 slash = strchr(name, '/');
952                 if (slash == NULL) {
953                         e->off[e->ARRAY_SIZEs] = name + strlen(name) - e->name;
954                         e->mustbedir = 0;
955                         break;
956                 }
957                 e->off[e->ARRAY_SIZEs] = slash - e->name;
958                 *slash++ = '\0';
959                 name = slash;
960         }
961 }
962
963 void *memrchr(void *va, int c, long n)
964 {
965         uint8_t *a, *e;
966
967         a = va;
968         for (e = a + n - 1; e > a; e--)
969                 if (*e == c)
970                         return e;
971         return NULL;
972 }
973
974 /*
975  * Turn a name into a channel.
976  * &name[0] is known to be a valid address.  It may be a kernel address.
977  *
978  * Opening with amode Aopen, Acreate, or Aremove guarantees
979  * that the result will be the only reference to that particular fid.
980  * This is necessary since we might pass the result to
981  * devtab[].remove().
982  *
983  * Opening Atodir, Amount, or Aaccess does not guarantee this.
984  *
985  * Opening Aaccess can, under certain conditions, return a
986  * correct Chan* but with an incorrect struct cname attached.
987  * Since the functions that open Aaccess (sysstat, syswstat, sys_stat)
988  * do not use the struct cname*, this avoids an unnecessary clone.
989  *
990  * Acreatechan will never open. It will do all the tests and return a chan
991  * for the directory where an open will succeed.
992  *
993  * The classic namec() is broken into a front end to get the starting point and
994  * a __namec_from, which does the guts of the lookup.  */
995 static struct chan *__namec_from(struct chan *c, char *aname, int amode,
996                                  int omode, uint32_t perm, bool can_mount)
997 {
998         ERRSTACK(2);
999         int len, npath;
1000         struct chan *cnew;
1001         struct cname *cname;
1002         Elemlist e;
1003         struct mhead *m;
1004         char tmperrbuf[ERRMAX];
1005         int saved_errno;
1006         // Rune r;
1007
1008         static_assert(!(CINTERNAL_FLAGS & CEXTERNAL_FLAGS));
1009
1010         e.name = NULL;
1011         e.elems = NULL;
1012         e.off = NULL;
1013         e.ARRAY_SIZEs = 0;
1014         if (waserror()) {
1015                 cclose(c);
1016                 kfree(e.name);
1017                 kfree(e.elems);
1018                 kfree(e.off);
1019                 //dumpmount();
1020                 nexterror();
1021         }
1022
1023         /*
1024          * Build a list of elements in the path.
1025          */
1026         parsename(aname, &e);
1027
1028         /*
1029          * On create, ....
1030          */
1031         if ((amode == Acreate) || (amode == Acreatechan)) {
1032                 /* perm must have DMDIR if last element is / or /. */
1033                 if (e.mustbedir && !(perm & DMDIR)) {
1034                         npath = e.ARRAY_SIZEs;
1035                         strlcpy(tmperrbuf, "create without DMDIR", sizeof(tmperrbuf));
1036                         goto NameError;
1037                 }
1038
1039                 /* don't try to walk the last path element just yet. */
1040                 if (e.ARRAY_SIZEs == 0)
1041                         error(EEXIST, ERROR_FIXME);
1042                 e.ARRAY_SIZEs--;
1043         }
1044
1045         if (walk(&c, e.elems, e.ARRAY_SIZEs, can_mount, &npath) < 0) {
1046                 if (npath < 0 || npath > e.ARRAY_SIZEs) {
1047                         printd("namec %s walk error npath=%d\n", aname, npath);
1048                         error(EFAIL, "walk failed");
1049                 }
1050 NameError:
1051                 if (current_errstr()[0]) {
1052                         /* errstr is set, we'll just stick with it and error out */
1053                         longjmp(&get_cur_errbuf()->jmpbuf, 1);
1054                 } else {
1055                         error(EFAIL, "Name to chan lookup failed");
1056                 }
1057                 /* brho: skipping the namec custom error string business, since it hides
1058                  * the underlying failure.  implement this if you want the old stuff. */
1059 #if 0
1060                 strlcpy(tmperrbuf, current->errstr, sizeof(tmperrbuf));
1061                 len = prefix + e.off[npath]; // prefix was name - aname, the start pt
1062                 if (len < ERRMAX / 3 || (name = memrchr(aname, '/', len)) == NULL
1063                         || name == aname)
1064                         snprintf(get_cur_genbuf(), sizeof current->genbuf, "%.*s", len,
1065                                          aname);
1066                 else
1067                         snprintf(get_cur_genbuf(), sizeof current->genbuf, "...%.*s",
1068                                          (int)(len - (name - aname)), name);
1069                 snprintf(current->errstr, ERRMAX, "%#q %s", get_cur_genbuf(),
1070                                  tmperrbuf);
1071 #endif
1072         }
1073
1074         if (e.mustbedir && !(c->qid.type & QTDIR)) {
1075                 npath = e.ARRAY_SIZEs;
1076                 strlcpy(tmperrbuf, "not a directory", sizeof(tmperrbuf));
1077                 goto NameError;
1078         }
1079
1080         if ((amode == Aopen) && (omode & O_EXEC) && (c->qid.type & QTDIR)) {
1081                 npath = e.ARRAY_SIZEs;
1082                 error(EFAIL, "cannot exec directory");
1083         }
1084
1085         switch (amode) {
1086                 case Aaccess:
1087                         if (can_mount)
1088                                 domount(&c, NULL);
1089                         break;
1090
1091                 case Abind:
1092                         m = NULL;
1093                         if (can_mount)
1094                                 domount(&c, &m);
1095                         if (c->umh != NULL)
1096                                 putmhead(c->umh);
1097                         c->umh = m;
1098                         break;
1099
1100                 case Aremove:
1101                 case Aopen:
1102 Open:
1103                         /* save the name; domount might change c */
1104                         cname = c->name;
1105                         kref_get(&cname->ref, 1);
1106                         m = NULL;
1107                         if (can_mount)
1108                                 domount(&c, &m);
1109
1110                         /* our own copy to open or remove */
1111                         c = cunique(c);
1112
1113                         /* now it's our copy anyway, we can put the name back */
1114                         cnameclose(c->name);
1115                         c->name = cname;
1116
1117                         switch (amode) {
1118                                 case Aremove:
1119                                         putmhead(m);
1120                                         break;
1121
1122                                 case Aopen:
1123                                 case Acreate:
1124                                         if (c->umh != NULL) {
1125                                                 printd("cunique umh\n");
1126                                                 putmhead(c->umh);
1127                                                 c->umh = NULL;
1128                                         }
1129
1130                                         /* only save the mount head if it's a multiple element union */
1131                                         if (m && m->mount && m->mount->next)
1132                                                 c->umh = m;
1133                                         else
1134                                                 putmhead(m);
1135                                         if (omode == O_EXEC)
1136                                                 c->flag &= ~CCACHE;
1137                                         /* here is where convert omode/vfs flags to c->flags.
1138                                          * careful, O_CLOEXEC and O_REMCLO are in there.  might need
1139                                          * to change that. */
1140                                         c->flag |= omode & CEXTERNAL_FLAGS;
1141                                         c = devtab[c->type].open(c,
1142                                                                  omode & ~O_CLOEXEC);
1143                                         /* if you get this from a dev, in the dev's open, you are
1144                                          * probably saving mode directly, without passing it through
1145                                          * openmode. */
1146                                         if (c->mode & O_TRUNC)
1147                                                 error(EFAIL, "Device %s open failed to clear O_TRUNC",
1148                                                       devtab[c->type].name);
1149                                         break;
1150                         }
1151                         break;
1152
1153                 case Atodir:
1154                         /*
1155                          * Directories (e.g. for cd) are left before the mount point,
1156                          * so one may mount on / or . and see the effect.
1157                          */
1158                         if (!(c->qid.type & QTDIR))
1159                                 error(ENOTDIR, ERROR_FIXME);
1160                         break;
1161
1162                 case Amount:
1163                         /*
1164                          * When mounting on an already mounted upon directory,
1165                          * one wants subsequent mounts to be attached to the
1166                          * original directory, not the replacement.  Don't domount.
1167                          */
1168                         break;
1169
1170                 case Acreatechan:
1171                         /*
1172                          * We've walked to the place where it *could* be created.
1173                          * Return that chan.
1174                          */
1175                         break;
1176
1177                 case Acreate:
1178                         /*
1179                          * We've already walked all but the last element.
1180                          * If the last exists, try to open it OTRUNC.
1181                          * If omode&OEXCL is set, just give up.
1182                          */
1183                         e.ARRAY_SIZEs++;
1184                         if (walk(&c, e.elems + e.ARRAY_SIZEs - 1, 1, can_mount, NULL) == 0) {
1185                                 if (omode & O_EXCL)
1186                                         error(EEXIST, ERROR_FIXME);
1187                                 omode |= O_TRUNC;
1188                                 goto Open;
1189                         }
1190
1191                         /*
1192                          * The semantics of the create(2) system call are that if the
1193                          * file exists and can be written, it is to be opened with truncation.
1194                          * On the other hand, the create(5) message fails if the file exists.
1195                          * If we get two create(2) calls happening simultaneously,
1196                          * they might both get here and send create(5) messages, but only
1197                          * one of the messages will succeed.  To provide the expected create(2)
1198                          * semantics, the call with the failed message needs to try the above
1199                          * walk again, opening for truncation.  This correctly solves the
1200                          * create/create race, in the sense that any observable outcome can
1201                          * be explained as one happening before the other.
1202                          * The create/create race is quite common.  For example, it happens
1203                          * when two rc subshells simultaneously update the same
1204                          * environment variable.
1205                          *
1206                          * The implementation still admits a create/create/remove race:
1207                          * (A) walk to file, fails
1208                          * (B) walk to file, fails
1209                          * (A) create file, succeeds, returns
1210                          * (B) create file, fails
1211                          * (A) remove file, succeeds, returns
1212                          * (B) walk to file, return failure.
1213                          *
1214                          * This is hardly as common as the create/create race, and is really
1215                          * not too much worse than what might happen if (B) got a hold of a
1216                          * file descriptor and then the file was removed -- either way (B) can't do
1217                          * anything with the result of the create call.  So we don't care about this race.
1218                          *
1219                          * Applications that care about more fine-grained decision of the races
1220                          * can use the OEXCL flag to get at the underlying create(5) semantics;
1221                          * by default we provide the common case.
1222                          *
1223                          * We need to stay behind the mount point in case we
1224                          * need to do the first walk again (should the create fail).
1225                          *
1226                          * We also need to cross the mount point and find the directory
1227                          * in the union in which we should be creating.
1228                          *
1229                          * The channel staying behind is c, the one moving forward is cnew.
1230                          */
1231                         m = NULL;
1232                         cnew = NULL;    /* is this assignment necessary? */
1233                         /* discard error */
1234                         if (!waserror()) {      /* try create */
1235                                 if (can_mount && findmount(&cnew, &m, c->type, c->dev, c->qid))
1236                                         cnew = createdir(cnew, m);
1237                                 else {
1238                                         cnew = c;
1239                                         chan_incref(cnew);
1240                                 }
1241
1242                                 /*
1243                                  * We need our own copy of the Chan because we're
1244                                  * about to send a create, which will move it.  Once we have
1245                                  * our own copy, we can fix the name, which might be wrong
1246                                  * if findmount gave us a new Chan.
1247                                  */
1248                                 cnew = cunique(cnew);
1249                                 cnameclose(cnew->name);
1250                                 cnew->name = c->name;
1251                                 kref_get(&cnew->name->ref, 1);
1252
1253                                 cnew->flag |= omode & CEXTERNAL_FLAGS;
1254                                 devtab[cnew->type].create(cnew, e.elems[e.ARRAY_SIZEs - 1],
1255                                                                                   omode & ~(O_EXCL | O_CLOEXEC),
1256                                                                                   perm);
1257                                 poperror();
1258
1259                                 if (m)
1260                                         putmhead(m);
1261                                 cclose(c);
1262                                 c = cnew;
1263                                 c->name = addelem(c->name, e.elems[e.ARRAY_SIZEs - 1]);
1264                                 break;
1265                         }
1266
1267                         /* create failed */
1268                         cclose(cnew);
1269                         if (m)
1270                                 putmhead(m);
1271                         if (omode & O_EXCL)
1272                                 nexterror();    /* safe since we're in a waserror() */
1273                         poperror();     /* matching the if(!waserror) */
1274
1275                         /* save error, so walk doesn't clobber our existing errstr */
1276                         strlcpy(tmperrbuf, current_errstr(), sizeof(tmperrbuf));
1277                         saved_errno = get_errno();
1278                         /* note: we depend that walk does not error */
1279                         if (walk(&c, e.elems + e.ARRAY_SIZEs - 1, 1, can_mount, NULL) < 0) {
1280                                 set_errno(saved_errno);
1281                                 /* Report the error we had originally */
1282                                 error(EFAIL, tmperrbuf);
1283                         }
1284                         strlcpy(current_errstr(), tmperrbuf, MAX_ERRSTR_LEN);
1285                         omode |= O_TRUNC;
1286                         goto Open;
1287
1288                 default:
1289                         panic("unknown namec access %d\n", amode);
1290         }
1291
1292         poperror();
1293
1294         if (e.ARRAY_SIZEs > 0)
1295                 strlcpy(get_cur_genbuf(), e.elems[e.ARRAY_SIZEs - 1], GENBUF_SZ);
1296         else
1297                 strlcpy(get_cur_genbuf(), ".", GENBUF_SZ);
1298
1299         kfree(e.name);
1300         kfree(e.elems);
1301         kfree(e.off);
1302
1303         return c;
1304 }
1305
1306 struct chan *namec(char *name, int amode, int omode, uint32_t perm)
1307 {
1308         bool can_mount = TRUE;
1309         struct chan *c;
1310         char *devname, *devspec;
1311         int n, devtype;
1312
1313         if (name[0] == '\0')
1314                 error(EFAIL, "empty file name");
1315         validname(name, 1);
1316         /*
1317          * Find the starting off point (the current slash, the root of
1318          * a device tree, or the current dot) as well as the name to
1319          * evaluate starting there.
1320          */
1321         switch (name[0]) {
1322                 case '/':
1323                         c = current->slash;
1324                         if (!c)
1325                                 panic("no slash!");
1326                         chan_incref(c);
1327                         break;
1328
1329                 case '#':
1330                         can_mount = FALSE;
1331                         devname = get_cur_genbuf();
1332                         devname[0] = '\0';
1333                         n = 0;
1334                         name++; /* drop the # */
1335                         while ((*name != '\0') && (*name != '/')) {
1336                                 if (n >= GENBUF_SZ - 1)
1337                                         error(ENAMETOOLONG, ERROR_FIXME);
1338                                 devname[n++] = *name++;
1339                         }
1340                         devname[n] = '\0';
1341                         /* for a name #foo.spec, devname = foo\0, devspec = spec\0.
1342                          * genbuf contains foo\0spec\0.  for no spec, devspec = \0 */
1343                         devspec = strchr(devname, '.');
1344                         if (devspec) {
1345                                 *devspec = '\0';
1346                                 devspec++;
1347                         } else {
1348                                 devspec = &devname[n];
1349                         }
1350                         if (!strcmp(devname, "mnt"))
1351                                 error(EINVAL, ERROR_FIXME);
1352                         /* TODO: deal with this "nodevs" business. */
1353                         #if 0
1354                         /*
1355                          *  the nodevs exceptions are
1356                          *  |  it only gives access to pipes you create
1357                          *  e  this process's environment
1358                          *  s  private file2chan creation space
1359                          *  D private secure sockets name space
1360                          *  a private TLS name space
1361                          */
1362                         if (current->pgrp->nodevs &&
1363                                 //          (utfrune("|esDa", r) == NULL
1364                                 ((strchr("|esDa", get_cur_genbuf()[1]) == NULL)
1365                                  || (get_cur_genbuf()[1] == 's' // || r == 's'
1366                                          && get_cur_genbuf()[n] != '\0')))
1367                                 error(EINVAL, ERROR_FIXME);
1368                         #endif
1369                         devtype = devno(devname, 1);
1370                         if (devtype == -1)
1371                                 error(EFAIL, "Unknown #device %s (spec %s)", devname, devspec);
1372                         c = devtab[devtype].attach(devspec);
1373                         break;
1374                 default:
1375                         /* this case also covers \0 */
1376                         c = current->dot;
1377                         if (!c)
1378                                 panic("no dot!");
1379                         chan_incref(c);
1380                         break;
1381         }
1382         return __namec_from(c, name, amode, omode, perm, can_mount);
1383 }
1384
1385 struct chan *namec_from(struct chan *c, char *name, int amode, int omode,
1386                         uint32_t perm)
1387 {
1388         if (name[0] == '\0') {
1389                 /* Our responsibility to cclose 'c' on our error */
1390                 cclose(c);
1391                 error(EFAIL, "empty file name");
1392         }
1393         validname(name, 1);
1394         return __namec_from(c, name, amode, omode, perm, TRUE);
1395 }
1396
1397 /*
1398  * name is valid. skip leading / and ./ as much as possible
1399  */
1400 char *skipslash(char *name)
1401 {
1402         while (name[0] == '/'
1403                    || (name[0] == '.' && (name[1] == 0 || name[1] == '/')))
1404                 name++;
1405         return name;
1406 }
1407
1408 char isfrog[256] = {
1409          /*NUL*/ 1, 1, 1, 1, 1, 1, 1, 1,
1410          /*BKS*/ 1, 1, 1, 1, 1, 1, 1, 1,
1411          /*DLE*/ 1, 1, 1, 1, 1, 1, 1, 1,
1412          /*CAN*/ 1, 1, 1, 1, 1, 1, 1, 1,
1413         ['/'] 1,
1414         [0x7f] 1,
1415 };
1416
1417 /*
1418  * Check that the name
1419  *  a) is in valid memory.
1420  *  b) is shorter than 2^16 bytes, so it can fit in a 9P string field.
1421  *  c) contains no frogs.
1422  * The first byte is known to be addressible by the requester, so the
1423  * routine works for kernel and user memory both.
1424  * The parameter slashok flags whether a slash character is an error
1425  * or a valid character.
1426  */
1427 void validname(char *aname, int slashok)
1428 {
1429         char *ename, *name;
1430         int c;
1431
1432         name = aname;
1433         ename = memchr(name, 0, (1 << 16));
1434
1435         if (ename == NULL || ename - name >= (1 << 16))
1436                 error(EINVAL, "Name too long");
1437
1438         while (*name) {
1439                 /* all characters above '~' are ok */
1440                 c = *(uint8_t *) name;
1441 #if 0
1442                 if (c >= Runeself)
1443                         name += chartorune(&r, name);
1444 #endif
1445                 if (c >= 0x7f) {
1446                         error(EFAIL, "Akaros doesn't do UTF-8");
1447                 } else {
1448                         if (isfrog[c])
1449                                 if (!slashok || c != '/') {
1450                                         error(EINVAL, "%s (%p), at char %c", aname, aname, c);
1451                                 }
1452                         name++;
1453                 }
1454         }
1455 }
1456
1457 void isdir(struct chan *c)
1458 {
1459         if (c->qid.type & QTDIR)
1460                 return;
1461         error(ENOTDIR, ERROR_FIXME);
1462 }
1463
1464 /*
1465  * This is necessary because there are many
1466  * pointers to the top of a given mount list:
1467  *
1468  *      - the mhead in the namespace hash table
1469  *      - the mhead in chans returned from findmount:
1470  *        used in namec and then by unionread.
1471  *      - the mhead in chans returned from createdir:
1472  *        used in the open/create race protect, which is gone.
1473  *
1474  * The RWlock in the Mhead protects the mount list it contains.
1475  * The mount list is deleted when we cunmount.
1476  * The RWlock ensures that nothing is using the mount list at that time.
1477  *
1478  * It is okay to replace c->mh with whatever you want as
1479  * long as you are sure you have a unique reference to it.
1480  *
1481  * This comment might belong somewhere else.
1482  */
1483 void putmhead(struct mhead *m)
1484 {
1485         if (m)
1486                 kref_put(&m->ref);
1487 }