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