Encapsulate block metadata better
[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         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->atime = seconds();
80         db->mtime = kerndate;
81         db->length = length;
82         db->uid = user;
83         db->gid = eve.name;
84         db->muid = user;
85 }
86
87 /*
88  * The zeroth element of the table MUST be the directory itself, or '.' (dot),
89  * for processing '..' (dot-dot). Specifically, if i==DEVDOTDOT, we call devdir
90  * on the *directory* (that is, dot), as opposed to children of the directory.
91  * The rest of the system assumes that the first entry in the table refers to
92  * the directory, and by convention this is named '.' (dot). This is confusing.
93  *
94  * Any entry with qid verion of -1 will return 0, indicating that the value is
95  * valid but there is nothing there, so continue walking.
96  *
97  * TODO(cross): Document devgen and clean this mess up. Devgen should probably
98  * be removed and replaced with a smarter data structure.
99  *
100  * Keep in mind that the expected behavior of gen functions that interoperate
101  * with dev functions (e.g. devdirread()) is that files are directly genned, but
102  * not directories.  Directories will fail to gen, and devstat() just makes
103  * something up.  See also:
104  * https://github.com/brho/plan9/blob/89d43d2262ad43eb4b26c2a8d6a27cfeddb33828/nix/sys/src/nix/port/dev.c#L74
105  *
106  * The comment about genning a file's siblings needs a grain of salt too.  Look
107  * through ipgen().  I think it's what I call "direct genning." */
108 int
109 devgen(struct chan *c, char *unused_name, struct dirtab *tab, int ntab,
110        int i, struct dir *dp)
111 {
112         if (tab == NULL)
113                 return -1;
114         if (i != DEVDOTDOT) {
115                 /* Skip over the first element, that for the directory itself. */
116                 i++;
117                 if (i < 0 || ntab <= i)
118                         return -1;
119                 tab += i;
120         }
121         if (tab->qid.vers == -1)
122                 return 0;
123         devdir(c, tab->qid, tab->name, tab->length, eve.name, tab->perm, dp);
124         return 1;
125 }
126
127 void devreset(void)
128 {
129 }
130
131 void devinit(void)
132 {
133 }
134
135 void devshutdown(void)
136 {
137 }
138
139 struct chan *devattach(const char *name, char *spec)
140 {
141         struct chan *c;
142         char *buf;
143         size_t buflen;
144
145         c = newchan();
146         mkqid(&c->qid, 0, 0, QTDIR);
147         c->type = devno(name, 0);
148         if (spec == NULL)
149                 spec = "";
150         /* 1 for #, 1 for ., 1 for \0 */
151         buflen = strlen(name) + strlen(spec) + 3;
152         buf = kzmalloc(buflen, MEM_WAIT);
153         snprintf(buf, sizeof(buf), "#%s.%s", name, spec);
154         c->name = newcname(buf);
155         kfree(buf);
156         return c;
157 }
158
159 struct chan *devclone(struct chan *c)
160 {
161         struct chan *nc;
162
163         /* In plan 9, you couldn't clone an open chan.  We're allowing it, possibly
164          * foolishly.  The new chan is a non-open, "kernel internal" chan.  Note
165          * that c->flag isn't set, for instance.  c->mode is, which might be a
166          * problem.  The newchan should eventually have a device's open called on
167          * it, at which point it upgrades from a kernel internal chan to one that
168          * can refer to an object in the device (e.g. grab a refcnt on a
169          * conversation in #ip).
170          *
171          * Either we allow devclones of open chans, or O_PATH walks do not open a
172          * file.  It's nice to allow the device to do something for O_PATH, but
173          * perhaps that is not critical.  However, if we can't clone an opened chan,
174          * then we can *only* openat from an FD that is O_PATH, which is not the
175          * spec (and not as useful). */
176         if ((c->flag & COPEN) && !(c->flag & O_PATH))
177                 panic("clone of non-O_PATH open file type %s\n", devtab[c->type].name);
178
179         nc = newchan();
180         nc->type = c->type;
181         nc->dev = c->dev;
182         nc->mode = c->mode;
183         nc->qid = c->qid;
184         nc->offset = c->offset;
185         nc->umh = NULL;
186         nc->mountid = c->mountid;
187         nc->aux = c->aux;
188         nc->mqid = c->mqid;
189         nc->mcp = c->mcp;
190         return nc;
191 }
192
193 struct walkqid *devwalk(struct chan *c,
194                                                 struct chan *nc, char **name, int nname,
195                                                 struct dirtab *tab, int ntab, Devgen * gen)
196 {
197         ERRSTACK(1);
198         int i, j;
199         volatile int alloc;                     /* to keep waserror from optimizing this out */
200         struct walkqid *wq;
201         char *n;
202         struct dir dir;
203
204         if (nname > 0)
205                 isdir(c);
206
207         alloc = 0;
208         wq = kzmalloc(sizeof(struct walkqid) + nname * sizeof(struct qid),
209                                   MEM_WAIT);
210         if (waserror()) {
211                 if (alloc && wq->clone != NULL)
212                         cclose(wq->clone);
213                 kfree(wq);
214                 poperror();
215                 return NULL;
216         }
217         if (nc == NULL) {
218                 nc = devclone(c);
219                 /* inferno was setting this to 0, assuming it was devroot.  lining up
220                  * with chanrelease and newchan */
221                 nc->type = -1;  /* device doesn't know about this channel yet */
222                 alloc = 1;
223         }
224         wq->clone = nc;
225
226         dir.qid.path = 0;
227         for (j = 0; j < nname; j++) {
228                 if (!(nc->qid.type & QTDIR)) {
229                         if (j == 0)
230                                 error(ENOTDIR, ERROR_FIXME);
231                         goto Done;
232                 }
233                 n = name[j];
234                 if (strcmp(n, ".") == 0) {
235 Accept:
236                         wq->qid[wq->nqid++] = nc->qid;
237                         continue;
238                 }
239                 if (strcmp(n, "..") == 0) {
240                         (*gen) (nc, NULL, tab, ntab, DEVDOTDOT, &dir);
241                         nc->qid = dir.qid;
242                         goto Accept;
243                 }
244                 /*
245                  * Ugly problem: If we're using devgen, make sure we're
246                  * walking the directory itself, represented by the first
247                  * entry in the table, and not trying to step into a sub-
248                  * directory of the table, e.g. /net/net. Devgen itself
249                  * should take care of the problem, but it doesn't have
250                  * the necessary information (that we're doing a walk).
251                  */
252                 if (gen == devgen && nc->qid.path != tab[0].qid.path)
253                         goto Notfound;
254                 dir.qid.path = 0;
255                 for (i = 0;; i++) {
256                         switch ((*gen) (nc, n, tab, ntab, i, &dir)) {
257                                 case -1:
258                                         printd("DEVWALK -1, i was %d, want path %p\n", i,
259                                                    c->qid.path);
260 Notfound:
261                                         if (j == 0)
262                                                 error(ENOENT, "could not find name %s, dev %s", n,
263                                                       c->type == -1 ? "no dev" : devtab[c->type].name);
264                                         /* TODO: I think we don't need to just set_error here */
265                                         set_error(ENOENT, "tell brho you saw this in an error");
266                                         goto Done;
267                                 case 0:
268                                         printd("DEVWALK continue, i was %d\n", i);
269                                         continue;
270                                 case 1:
271                                         printd
272                                                 ("DEVWALK gen returns path %p name %s, want path %p\n",
273                                                  dir.qid.path, dir.name, c->qid.path);
274                                         if (strcmp(n, dir.name) == 0) {
275                                                 nc->qid = dir.qid;
276                                                 goto Accept;
277                                         }
278                                         continue;
279                         }
280                 }
281         }
282         /*
283          * We processed at least one name, so will return some data.
284          * If we didn't process all nname entries succesfully, we drop
285          * the cloned channel and return just the Qids of the walks.
286          */
287 Done:
288         poperror();
289         if (wq->nqid < nname) {
290                 if (alloc)
291                         cclose(wq->clone);
292                 wq->clone = NULL;
293         } else if (wq->clone) {
294                 /* attach cloned channel to same device */
295                 wq->clone->type = c->type;
296         }
297         return wq;
298 }
299
300 /* Helper, makes a stat in @dp, given @n bytes, from chan @c's contents in @dir.
301  * Throws on error, returns the size used on success. */
302 size_t dev_make_stat(struct chan *c, struct dir *dir, uint8_t *dp, size_t n)
303 {
304         if (c->flag & CMSG)
305                 dir->mode |= DMMOUNT;
306         n = convD2M(dir, dp, n);
307         if (n == 0)
308                 error(EINVAL, ERROR_FIXME);
309         return n;
310 }
311
312 int
313 devstat(struct chan *c, uint8_t * db, int n,
314                 struct dirtab *tab, int ntab, Devgen * gen)
315 {
316         int i;
317         struct dir dir;
318         char *p, *elem;
319
320         dir.qid.path = 0;
321         for (i = 0;; i++)
322                 switch ((*gen) (c, NULL, tab, ntab, i, &dir)) {
323                         case -1:
324                                 if (c->qid.type & QTDIR) {
325                                         printd("DEVSTAT got a dir: %llu\n", c->qid.path);
326                                         if (c->name == NULL)
327                                                 elem = "???";
328                                         else if (strcmp(c->name->s, "/") == 0)
329                                                 elem = "/";
330                                         else
331                                                 for (elem = p = c->name->s; *p; p++)
332                                                         if (*p == '/')
333                                                                 elem = p + 1;
334                                         devdir(c, c->qid, elem, 0, eve.name, DMDIR | 0555, &dir);
335                                         n = convD2M(&dir, db, n);
336                                         if (n == 0)
337                                                 error(EINVAL, ERROR_FIXME);
338                                         return n;
339                                 }
340                                 printd("DEVSTAT fails:%s %llu\n", devtab[c->type].name,
341                                            c->qid.path);
342                                 error(ENOENT, ERROR_FIXME);
343                         case 0:
344                                 printd("DEVSTAT got 0\n");
345                                 break;
346                         case 1:
347                                 printd("DEVSTAT gen returns path %p name %s, want path %p\n",
348                                            dir.qid.path, dir.name, c->qid.path);
349                                 if (c->qid.path == dir.qid.path)
350                                         return dev_make_stat(c, &dir, db, n);
351                                 break;
352                 }
353 }
354
355 long
356 devdirread(struct chan *c, char *d, long n,
357                    struct dirtab *tab, int ntab, Devgen * gen)
358 {
359         long m, dsz;
360         /* this is gross. Make it 2 so we have room at the end for
361          * bad things.
362          */
363         struct dir dir[4];
364
365         dir[0].qid.path = 0;
366         for (m = 0; m < n; c->dri++) {
367                 switch ((*gen) (c, NULL, tab, ntab, c->dri, &dir[0])) {
368                         case -1:
369                                 printd("DEVDIRREAD got -1, asked for s = %d\n", c->dri);
370                                 return m;
371
372                         case 0:
373                                 printd("DEVDIRREAD got 0, asked for s = %d\n", c->dri);
374                                 break;
375
376                         case 1:
377                                 printd("DEVDIRREAD got 1, asked for s = %d\n", c->dri);
378                                 dsz = convD2M(&dir[0], (uint8_t *) d, n - m);
379                                 if (dsz <= BIT16SZ) {   /* <= not < because this isn't stat; read is stuck */
380                                         if (m == 0)
381                                                 error(ENODATA, ERROR_FIXME);
382                                         return m;
383                                 }
384                                 m += dsz;
385                                 d += dsz;
386                                 break;
387                 }
388         }
389
390         return m;
391 }
392
393 /*
394  * error(EPERM, ERROR_FIXME) if open permission not granted for
395  * current->user.name
396  */
397 void devpermcheck(char *fileuid, uint32_t perm, int omode)
398 {
399         int rwx;
400
401         /* select user, group, or other from the traditional rwxrwxrwx, shifting
402          * into the upper-most position */
403         if (strcmp(current->user.name, fileuid) == 0)
404                 perm <<= 0;
405         else if (iseve())
406                 perm <<= 3;
407         else
408                 perm <<= 6;
409         /* translate omode into things like S_IRUSR (just one set of rwx------).
410          * Plan 9 originally only returned 0400 0200 0600 and 0100 here; it didn't
411          * seem to handle O_EXEC being mixed readable or writable. */
412         rwx = omode_to_rwx(omode);
413         if ((rwx & perm) != rwx)
414                 error(EPERM, "devpermcheck(%s, 0%o, 0%o) failed", 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
448 devcreate(struct chan *c, char *unused_char_p_t, int unused_int, uint32_t u)
449 {
450         error(EPERM, ERROR_FIXME);
451 }
452
453 struct block *devbread(struct chan *c, long n, uint32_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 long devbwrite(struct chan *c, struct block *bp, uint32_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 int devwstat(struct chan *c, uint8_t * unused_uint8_p_t, int 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 }