9ns: Fix issues with can_have_children
[akaros.git] / kern / src / ns / dev.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 <slab.h>
30 #include <kmalloc.h>
31 #include <kref.h>
32 #include <string.h>
33 #include <stdio.h>
34 #include <assert.h>
35 #include <error.h>
36 #include <cpio.h>
37 #include <pmap.h>
38 #include <smp.h>
39 #include <net/ip.h>
40
41 extern uint32_t kerndate;
42 extern struct username eve;
43
44 void mkqid(struct qid *q, int64_t path, uint32_t vers, int type)
45 {
46         q->type = type;
47         q->vers = vers;
48         q->path = path;
49 }
50
51 int devno(const char *name, int user)
52 {
53         int i;
54
55         for (i = 0; &devtab[i] < __devtabend; i++) {
56                 if (!strcmp(devtab[i].name, name))
57                         return i;
58         }
59         if (user == 0)
60                 panic("Lookup of dev :%s: failed", name);
61
62         return -1;
63 }
64
65 void
66 devdir(struct chan *c, struct qid qid, char *n,
67            int64_t length, char *user, long perm, struct dir *db)
68 {
69         struct timespec now = nsec2timespec(epoch_nsec());
70
71         db->name = n;
72         if (c->flag & CMSG)
73                 qid.type |= QTMOUNT;
74         db->qid = qid;
75         db->type = c->type;     /* used to use the dev's dc here */
76         db->dev = c->dev;
77         db->mode = perm;
78         db->mode |= qid.type << 24;
79         db->length = length;
80         db->uid = user;
81         db->gid = eve.name;
82         db->muid = user;
83         db->ext = NULL;
84         /* TODO: once we figure out what to do for uid/gid, then we can try to tie
85          * that to the n_uid.  Or just ignore it, and only use that as a
86          * pass-through for 9p2000.u. */
87         db->n_uid = 0;
88         db->n_gid = 0;
89         db->n_muid = 0;
90         /* TODO: what does devdir really want? */
91         db->atime = now;
92         db->btime = now;
93         db->ctime = now;
94         db->mtime = now;
95 }
96
97 /*
98  * The zeroth element of the table MUST be the directory itself, or '.' (dot),
99  * for processing '..' (dot-dot). Specifically, if i==DEVDOTDOT, we call devdir
100  * on the *directory* (that is, dot), as opposed to children of the directory.
101  * The rest of the system assumes that the first entry in the table refers to
102  * the directory, and by convention this is named '.' (dot). This is confusing.
103  *
104  * Any entry with qid verion of -1 will return 0, indicating that the value is
105  * valid but there is nothing there, so continue walking.
106  *
107  * TODO(cross): Document devgen and clean this mess up. Devgen should probably
108  * be removed and replaced with a smarter data structure.
109  *
110  * Keep in mind that the expected behavior of gen functions that interoperate
111  * with dev functions (e.g. devdirread()) is that files are directly genned, but
112  * not directories.  Directories will fail to gen, and devstat() just makes
113  * something up.  See also:
114  * https://github.com/brho/plan9/blob/89d43d2262ad43eb4b26c2a8d6a27cfeddb33828/nix/sys/src/nix/port/dev.c#L74
115  *
116  * The comment about genning a file's siblings needs a grain of salt too.  Look
117  * through ipgen().  I think it's what I call "direct genning." */
118 int
119 devgen(struct chan *c, char *unused_name, struct dirtab *tab, int ntab,
120        int i, struct dir *dp)
121 {
122         if (tab == NULL)
123                 return -1;
124         if (i != DEVDOTDOT) {
125                 /* Skip over the first element, that for the directory itself. */
126                 i++;
127                 if (i < 0 || ntab <= i)
128                         return -1;
129                 tab += i;
130         }
131         if (tab->qid.vers == -1)
132                 return 0;
133         devdir(c, tab->qid, tab->name, tab->length, eve.name, tab->perm, dp);
134         return 1;
135 }
136
137 void devreset(void)
138 {
139 }
140
141 void devinit(void)
142 {
143 }
144
145 void devshutdown(void)
146 {
147 }
148
149 struct chan *devattach(const char *name, char *spec)
150 {
151         struct chan *c;
152         char *buf;
153         size_t buflen;
154
155         c = newchan();
156         mkqid(&c->qid, 0, 0, QTDIR);
157         c->type = devno(name, 0);
158         if (spec == NULL)
159                 spec = "";
160         /* 1 for #, 1 for ., 1 for \0 */
161         buflen = strlen(name) + strlen(spec) + 3;
162         buf = kzmalloc(buflen, MEM_WAIT);
163         snprintf(buf, sizeof(buf), "#%s.%s", name, spec);
164         c->name = newcname(buf);
165         kfree(buf);
166         return c;
167 }
168
169 struct chan *devclone(struct chan *c)
170 {
171         struct chan *nc;
172
173         /* In plan 9, you couldn't clone an open chan.  We're allowing it, possibly
174          * foolishly.  The new chan is a non-open, "kernel internal" chan.  Note
175          * that c->flag isn't set, for instance.  c->mode is, which might be a
176          * problem.  The newchan should eventually have a device's open called on
177          * it, at which point it upgrades from a kernel internal chan to one that
178          * can refer to an object in the device (e.g. grab a refcnt on a
179          * conversation in #ip).
180          *
181          * Either we allow devclones of open chans, or O_PATH walks do not open a
182          * file.  It's nice to allow the device to do something for O_PATH, but
183          * perhaps that is not critical.  However, if we can't clone an opened chan,
184          * then we can *only* openat from an FD that is O_PATH, which is not the
185          * spec (and not as useful). */
186         if ((c->flag & COPEN) && !(c->flag & O_PATH))
187                 panic("clone of non-O_PATH open file type %s\n", devtab[c->type].name);
188
189         nc = newchan();
190         nc->type = c->type;
191         nc->dev = c->dev;
192         nc->mode = c->mode;
193         nc->qid = c->qid;
194         nc->offset = c->offset;
195         nc->umh = NULL;
196         nc->mountid = c->mountid;
197         nc->aux = c->aux;
198         nc->mqid = c->mqid;
199         nc->mcp = c->mcp;
200         return nc;
201 }
202
203 struct walkqid *devwalk(struct chan *c,
204                                                 struct chan *nc, char **name, int nname,
205                                                 struct dirtab *tab, int ntab, Devgen * gen)
206 {
207         ERRSTACK(1);
208         int i, j;
209         volatile int alloc;                     /* to keep waserror from optimizing this out */
210         struct walkqid *wq;
211         char *n;
212         struct dir dir;
213
214         if (nname > 0)
215                 isdir(c);
216
217         alloc = 0;
218         wq = kzmalloc(sizeof(struct walkqid) + nname * sizeof(struct qid),
219                                   MEM_WAIT);
220         if (waserror()) {
221                 if (alloc && wq->clone != NULL)
222                         cclose(wq->clone);
223                 kfree(wq);
224                 poperror();
225                 return NULL;
226         }
227         if (nc == NULL) {
228                 nc = devclone(c);
229                 /* inferno was setting this to 0, assuming it was devroot.  lining up
230                  * with chanrelease and newchan */
231                 nc->type = -1;  /* device doesn't know about this channel yet */
232                 alloc = 1;
233         }
234         wq->clone = nc;
235
236         dir.qid.path = 0;
237         for (j = 0; j < nname; j++) {
238                 if (!(nc->qid.type & QTDIR)) {
239                         if (j == 0)
240                                 error(ENOTDIR, ERROR_FIXME);
241                         goto Done;
242                 }
243                 n = name[j];
244                 if (strcmp(n, ".") == 0) {
245 Accept:
246                         wq->qid[wq->nqid++] = nc->qid;
247                         continue;
248                 }
249                 if (strcmp(n, "..") == 0) {
250                         (*gen) (nc, NULL, tab, ntab, DEVDOTDOT, &dir);
251                         nc->qid = dir.qid;
252                         goto Accept;
253                 }
254                 /*
255                  * Ugly problem: If we're using devgen, make sure we're
256                  * walking the directory itself, represented by the first
257                  * entry in the table, and not trying to step into a sub-
258                  * directory of the table, e.g. /net/net. Devgen itself
259                  * should take care of the problem, but it doesn't have
260                  * the necessary information (that we're doing a walk).
261                  */
262                 if (gen == devgen && nc->qid.path != tab[0].qid.path)
263                         goto Notfound;
264                 dir.qid.path = 0;
265                 for (i = 0;; i++) {
266                         switch ((*gen) (nc, n, tab, ntab, i, &dir)) {
267                                 case -1:
268                                         printd("DEVWALK -1, i was %d, want path %p\n", i,
269                                                    c->qid.path);
270 Notfound:
271                                         set_error(ENOENT, "could not find name %s, dev %s", n,
272                                                       c->type == -1 ? "no dev" : devtab[c->type].name);
273                                         if (j == 0)
274                                                 error_jmp();
275                                         goto Done;
276                                 case 0:
277                                         printd("DEVWALK continue, i was %d\n", i);
278                                         continue;
279                                 case 1:
280                                         printd
281                                                 ("DEVWALK gen returns path %p name %s, want path %p\n",
282                                                  dir.qid.path, dir.name, c->qid.path);
283                                         if (strcmp(n, dir.name) == 0) {
284                                                 nc->qid = dir.qid;
285                                                 goto Accept;
286                                         }
287                                         continue;
288                         }
289                 }
290         }
291         /*
292          * We processed at least one name, so will return some data.
293          * If we didn't process all nname entries succesfully, we drop
294          * the cloned channel and return just the Qids of the walks.
295          */
296 Done:
297         poperror();
298         if (wq->nqid < nname) {
299                 if (alloc)
300                         cclose(wq->clone);
301                 wq->clone = NULL;
302         } else if (wq->clone) {
303                 /* attach cloned channel to same device */
304                 wq->clone->type = c->type;
305         } else {
306                 /* Not sure this is possible, would like to know. */
307                 warn_once("had enough names, but still no wq->clone");
308         }
309         return wq;
310 }
311
312 /* Helper, makes a stat in @dp, given @n bytes, from chan @c's contents in @dir.
313  * Throws on error, returns the size used on success. */
314 size_t dev_make_stat(struct chan *c, struct dir *dir, uint8_t *dp, size_t n)
315 {
316         if (c->flag & CMSG)
317                 dir->mode |= DMMOUNT;
318         n = convD2M(dir, dp, n);
319         if (n == 0)
320                 error(EINVAL, ERROR_FIXME);
321         return n;
322 }
323
324 size_t devstat(struct chan *c, uint8_t *db, size_t n, struct dirtab *tab,
325                int ntab, Devgen *gen)
326 {
327         int i;
328         struct dir dir;
329         char *p, *elem;
330
331         dir.qid.path = 0;
332         for (i = 0;; i++)
333                 switch ((*gen) (c, NULL, tab, ntab, i, &dir)) {
334                         case -1:
335                                 if (c->qid.type & QTDIR) {
336                                         printd("DEVSTAT got a dir: %llu\n", c->qid.path);
337                                         if (c->name == NULL)
338                                                 elem = "???";
339                                         else if (strcmp(c->name->s, "/") == 0)
340                                                 elem = "/";
341                                         else
342                                                 for (elem = p = c->name->s; *p; p++)
343                                                         if (*p == '/')
344                                                                 elem = p + 1;
345                                         devdir(c, c->qid, elem, 0, eve.name, DMDIR | 0555, &dir);
346                                         n = convD2M(&dir, db, n);
347                                         if (n == 0)
348                                                 error(EINVAL, ERROR_FIXME);
349                                         return n;
350                                 }
351                                 printd("DEVSTAT fails:%s %llu\n", devtab[c->type].name,
352                                            c->qid.path);
353                                 error(ENOENT, ERROR_FIXME);
354                         case 0:
355                                 printd("DEVSTAT got 0\n");
356                                 break;
357                         case 1:
358                                 printd("DEVSTAT gen returns path %p name %s, want path %p\n",
359                                            dir.qid.path, dir.name, c->qid.path);
360                                 if (c->qid.path == dir.qid.path)
361                                         return dev_make_stat(c, &dir, db, n);
362                                 break;
363                 }
364 }
365
366 long
367 devdirread(struct chan *c, char *d, long n,
368                    struct dirtab *tab, int ntab, Devgen * gen)
369 {
370         long m, dsz;
371         /* this is gross. Make it 2 so we have room at the end for
372          * bad things.
373          */
374         struct dir dir[4];
375
376         dir[0].qid.path = 0;
377         for (m = 0; m < n; c->dri++) {
378                 switch ((*gen) (c, NULL, tab, ntab, c->dri, &dir[0])) {
379                         case -1:
380                                 printd("DEVDIRREAD got -1, asked for s = %d\n", c->dri);
381                                 return m;
382
383                         case 0:
384                                 printd("DEVDIRREAD got 0, asked for s = %d\n", c->dri);
385                                 break;
386
387                         case 1:
388                                 printd("DEVDIRREAD got 1, asked for s = %d\n", c->dri);
389                                 dsz = convD2M(&dir[0], (uint8_t *) d, n - m);
390                                 if (dsz <= BIT16SZ) {   /* <= not < because this isn't stat; read is stuck */
391                                         if (m == 0)
392                                                 error(ENODATA, ERROR_FIXME);
393                                         return m;
394                                 }
395                                 m += dsz;
396                                 d += dsz;
397                                 break;
398                 }
399         }
400
401         return m;
402 }
403
404 /*
405  * Throws an error if open permission not granted for current->user.name
406  */
407 void devpermcheck(char *fileuid, uint32_t perm, int omode)
408 {
409         if (!caller_has_perms(fileuid, perm, omode))
410                 error(EPERM, "permcheck(user: %s, rwx: 0%o, omode 0%o) failed",
411                       fileuid, perm, omode);
412 }
413
414 struct chan *devopen(struct chan *c, int omode, struct dirtab *tab, int ntab,
415                                          Devgen * gen)
416 {
417         int i;
418         struct dir dir;
419
420         dir.qid.path = 0;
421         for (i = 0;; i++) {
422                 switch ((*gen) (c, NULL, tab, ntab, i, &dir)) {
423                         case -1:
424                                 goto Return;
425                         case 0:
426                                 break;
427                         case 1:
428                                 if (c->qid.path == dir.qid.path) {
429                                         devpermcheck(dir.uid, dir.mode, omode);
430                                         goto Return;
431                                 }
432                                 break;
433                 }
434         }
435 Return:
436         c->offset = 0;
437         if ((c->qid.type & QTDIR) && (omode & O_WRITE))
438                 error(EACCES, "Tried opening dir with non-read-only mode %o", omode);
439         c->mode = openmode(omode);
440         c->flag |= COPEN;
441         return c;
442 }
443
444 void devcreate(struct chan *c, char *unused_char_p_t, int unused_int,
445                uint32_t u, char *ext)
446 {
447         error(EPERM, ERROR_FIXME);
448 }
449
450 struct block *devbread(struct chan *c, size_t n, off64_t offset)
451 {
452         ERRSTACK(1);
453         struct block *bp;
454
455         bp = block_alloc(n, MEM_WAIT);
456         if (bp == 0)
457                 error(ENOMEM, ERROR_FIXME);
458         if (waserror()) {
459                 freeb(bp);
460                 nexterror();
461         }
462         bp->wp += devtab[c->type].read(c, bp->wp, n, offset);
463         poperror();
464         return bp;
465 }
466
467 size_t devbwrite(struct chan *c, struct block *bp, off64_t offset)
468 {
469         ERRSTACK(1);
470         long n;
471
472         if (waserror()) {
473                 freeb(bp);
474                 nexterror();
475         }
476         n = devtab[c->type].write(c, bp->rp, BLEN(bp), offset);
477         poperror();
478         freeb(bp);
479
480         return n;
481 }
482
483 void devremove(struct chan *c)
484 {
485         error(EPERM, ERROR_FIXME);
486 }
487
488 size_t devwstat(struct chan *c, uint8_t *unused_uint8_p_t, size_t i)
489 {
490         error(EPERM, ERROR_FIXME);
491         return 0;
492 }
493
494 void devpower(int i)
495 {
496         error(EPERM, ERROR_FIXME);
497 }
498
499 #if 0
500 int devconfig(int unused_int, char *c, DevConf *)
501 {
502         error(EPERM, ERROR_FIXME);
503         return 0;
504 }
505 #endif
506
507 char *devchaninfo(struct chan *chan, char *ret, size_t ret_l)
508 {
509         snprintf(ret, ret_l, "qid.path: %p, qid.type: %02x", chan->qid.path,
510                          chan->qid.type);
511         return ret;
512 }
513
514 /*
515  * check that the name in a wstat is plausible
516  */
517 void validwstatname(char *name)
518 {
519         validname(name, 0);
520         if (strcmp(name, ".") == 0 || strcmp(name, "..") == 0)
521                 error(EINVAL, ERROR_FIXME);
522 }
523
524 struct dev *devbyname(char *name)
525 {
526         int i;
527
528         for (i = 0; &devtab[i] < __devtabend; i++)
529                 if (strcmp(devtab[i].name, name) == 0)
530                         return &devtab[i];
531         return NULL;
532 }