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