Allow 9ns clones of chans opened with O_PATH
[akaros.git] / kern / src / ns / dev.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 <ip.h>
15
16 extern uint32_t kerndate;
17 extern char *eve;
18
19 void mkqid(struct qid *q, int64_t path, uint32_t vers, int type)
20 {
21         q->type = type;
22         q->vers = vers;
23         q->path = path;
24 }
25
26 int devno(const char *name, int user)
27 {
28         int i;
29
30         for (i = 0; &devtab[i] < __devtabend; i++) {
31                 if (!strcmp(devtab[i].name, name))
32                         return i;
33         }
34         if (user == 0)
35                 panic("Lookup of dev :%s: failed", name);
36
37         return -1;
38 }
39
40 void
41 devdir(struct chan *c, struct qid qid, char *n,
42            int64_t length, char *user, long perm, struct dir *db)
43 {
44         db->name = n;
45         if (c->flag & CMSG)
46                 qid.type |= QTMOUNT;
47         db->qid = qid;
48         db->type = c->type;     /* used to use the dev's dc here */
49         db->dev = c->dev;
50         db->mode = perm;
51         db->mode |= qid.type << 24;
52         db->atime = seconds();
53         db->mtime = kerndate;
54         db->length = length;
55         db->uid = user;
56         db->gid = eve;
57         db->muid = user;
58 }
59
60 /*
61  * the zeroth element of the table MUST be the directory itself for ..
62  * Any entry with qid vers of -1 will return 0, indicating that the value is
63  * valid but there is nothing there continue walk.
64  * TODO(gvdl): Update akaros devgen man page.
65 */
66 int
67 devgen(struct chan *c, char *unused_char_p_t, struct dirtab *tab, int ntab,
68            int i, struct dir *dp)
69 {
70         if (tab == 0)
71                 return -1;
72         if (i != DEVDOTDOT) {
73                 /* skip over the first element, that for . itself */
74                 i++;
75                 if (i >= ntab)
76                         return -1;
77                 tab += i;
78         }
79         int ret = (tab->qid.vers == -1)? 0 : 1;
80         if (ret)
81                 devdir(c, tab->qid, tab->name, tab->length, eve, tab->perm, dp);
82         return ret;
83 }
84
85 void devreset(void)
86 {
87 }
88
89 void devinit(void)
90 {
91 }
92
93 void devshutdown(void)
94 {
95 }
96
97 struct chan *devattach(const char *name, char *spec)
98 {
99         struct chan *c;
100         char *buf;
101         size_t buflen;
102
103         c = newchan();
104         mkqid(&c->qid, 0, 0, QTDIR);
105         c->type = devno(name, 0);
106         if (spec == NULL)
107                 spec = "";
108         /* 1 for #, 1 for ., 1 for \0 */
109         buflen = strlen(name) + strlen(spec) + 3;
110         buf = kzmalloc(buflen, KMALLOC_WAIT);
111         snprintf(buf, sizeof(buf), "#%s.%s", name, spec);
112         c->name = newcname(buf);
113         kfree(buf);
114         return c;
115 }
116
117 struct chan *devclone(struct chan *c)
118 {
119         struct chan *nc;
120
121         /* In plan 9, you couldn't clone an open chan.  We're allowing it, possibly
122          * foolishly.  The new chan is a non-open, "kernel internal" chan.  Note
123          * that c->flag isn't set, for instance.  c->mode is, which might be a
124          * problem.  The newchan should eventually have a device's open called on
125          * it, at which point it upgrades from a kernel internal chan to one that
126          * can refer to an object in the device (e.g. grab a refcnt on a
127          * conversation in #ip).
128          *
129          * Either we allow devclones of open chans, or O_PATH walks do not open a
130          * file.  It's nice to allow the device to do something for O_PATH, but
131          * perhaps that is not critical.  However, if we can't clone an opened chan,
132          * then we can *only* openat from an FD that is O_PATH, which is not the
133          * spec (and not as useful). */
134         if ((c->flag & COPEN) && !(c->flag & O_PATH))
135                 panic("clone of non-O_PATH open file type %s\n", devtab[c->type].name);
136
137         nc = newchan();
138         nc->type = c->type;
139         nc->dev = c->dev;
140         nc->mode = c->mode;
141         nc->qid = c->qid;
142         nc->offset = c->offset;
143         nc->umh = NULL;
144         nc->mountid = c->mountid;
145         nc->aux = c->aux;
146         nc->mqid = c->mqid;
147         nc->mcp = c->mcp;
148         return nc;
149 }
150
151 struct walkqid *devwalk(struct chan *c,
152                                                 struct chan *nc, char **name, int nname,
153                                                 struct dirtab *tab, int ntab, Devgen * gen)
154 {
155         ERRSTACK(1);
156         int i, j;
157         volatile int alloc;                     /* to keep waserror from optimizing this out */
158         struct walkqid *wq;
159         char *n;
160         struct dir dir;
161
162         if (nname > 0)
163                 isdir(c);
164
165         alloc = 0;
166         wq = kzmalloc(sizeof(struct walkqid) + nname * sizeof(struct qid),
167                                   KMALLOC_WAIT);
168         if (waserror()) {
169                 if (alloc && wq->clone != NULL)
170                         cclose(wq->clone);
171                 kfree(wq);
172                 poperror();
173                 return NULL;
174         }
175         if (nc == NULL) {
176                 nc = devclone(c);
177                 /* inferno was setting this to 0, assuming it was devroot.  lining up
178                  * with chanrelease and newchan */
179                 nc->type = -1;  /* device doesn't know about this channel yet */
180                 alloc = 1;
181         }
182         wq->clone = nc;
183
184         dir.qid.path = 0;
185         for (j = 0; j < nname; j++) {
186                 if (!(nc->qid.type & QTDIR)) {
187                         if (j == 0)
188                                 error(Enotdir);
189                         goto Done;
190                 }
191                 n = name[j];
192                 if (strcmp(n, ".") == 0) {
193 Accept:
194                         wq->qid[wq->nqid++] = nc->qid;
195                         continue;
196                 }
197                 if (strcmp(n, "..") == 0) {
198                         (*gen) (nc, NULL, tab, ntab, DEVDOTDOT, &dir);
199                         nc->qid = dir.qid;
200                         goto Accept;
201                 }
202                 /*
203                  * Ugly problem: If we're using devgen, make sure we're
204                  * walking the directory itself, represented by the first
205                  * entry in the table, and not trying to step into a sub-
206                  * directory of the table, e.g. /net/net. Devgen itself
207                  * should take care of the problem, but it doesn't have
208                  * the necessary information (that we're doing a walk).
209                  */
210                 if (gen == devgen && nc->qid.path != tab[0].qid.path)
211                         goto Notfound;
212                 dir.qid.path = 0;
213                 for (i = 0;; i++) {
214                         switch ((*gen) (nc, n, tab, ntab, i, &dir)) {
215                                 case -1:
216                                         printd("DEVWALK -1, i was %d, want path %p\n", i,
217                                                    c->qid.path);
218 Notfound:
219                                         set_errno(ENOENT);
220                                         if (j == 0)
221                                                 error(Enonexist);
222                                         set_errstr(Enonexist);
223                                         goto Done;
224                                 case 0:
225                                         printd("DEVWALK continue, i was %d\n", i);
226                                         continue;
227                                 case 1:
228                                         printd
229                                                 ("DEVWALK gen returns path %p name %s, want path %p\n",
230                                                  dir.qid.path, dir.name, c->qid.path);
231                                         if (strcmp(n, dir.name) == 0) {
232                                                 nc->qid = dir.qid;
233                                                 goto Accept;
234                                         }
235                                         continue;
236                         }
237                 }
238         }
239         /*
240          * We processed at least one name, so will return some data.
241          * If we didn't process all nname entries succesfully, we drop
242          * the cloned channel and return just the Qids of the walks.
243          */
244 Done:
245         poperror();
246         if (wq->nqid < nname) {
247                 if (alloc)
248                         cclose(wq->clone);
249                 wq->clone = NULL;
250         } else if (wq->clone) {
251                 /* attach cloned channel to same device */
252                 wq->clone->type = c->type;
253         }
254         return wq;
255 }
256
257 int
258 devstat(struct chan *c, uint8_t * db, int n,
259                 struct dirtab *tab, int ntab, Devgen * gen)
260 {
261         int i;
262         struct dir dir;
263         char *p, *elem;
264
265         dir.qid.path = 0;
266         for (i = 0;; i++)
267                 switch ((*gen) (c, NULL, tab, ntab, i, &dir)) {
268                         case -1:
269                                 if (c->qid.type & QTDIR) {
270                                         printd("DEVSTAT got a dir: %llu\n", c->qid.path);
271                                         if (c->name == NULL)
272                                                 elem = "???";
273                                         else if (strcmp(c->name->s, "/") == 0)
274                                                 elem = "/";
275                                         else
276                                                 for (elem = p = c->name->s; *p; p++)
277                                                         if (*p == '/')
278                                                                 elem = p + 1;
279                                         devdir(c, c->qid, elem, 0, eve, DMDIR | 0555, &dir);
280                                         n = convD2M(&dir, db, n);
281                                         if (n == 0)
282                                                 error(Ebadarg);
283                                         return n;
284                                 }
285                                 printd("DEVSTAT fails:%s %llu\n", devtab[c->type].name,
286                                            c->qid.path);
287                                 set_errno(ENOENT);
288                                 error(Enonexist);
289                         case 0:
290                                 printd("DEVSTAT got 0\n");
291                                 break;
292                         case 1:
293                                 printd("DEVSTAT gen returns path %p name %s, want path %p\n",
294                                            dir.qid.path, dir.name, c->qid.path);
295                                 if (c->qid.path == dir.qid.path) {
296                                         if (c->flag & CMSG)
297                                                 dir.mode |= DMMOUNT;
298                                         n = convD2M(&dir, db, n);
299                                         if (n == 0)
300                                                 error(Ebadarg);
301                                         return n;
302                                 }
303                                 break;
304                 }
305 }
306
307 long
308 devdirread(struct chan *c, char *d, long n,
309                    struct dirtab *tab, int ntab, Devgen * gen)
310 {
311         long m, dsz;
312         /* this is gross. Make it 2 so we have room at the end for
313          * bad things.
314          */
315         struct dir dir[4];
316
317         dir[0].qid.path = 0;
318         for (m = 0; m < n; c->dri++) {
319                 switch ((*gen) (c, NULL, tab, ntab, c->dri, &dir[0])) {
320                         case -1:
321                                 printd("DEVDIRREAD got -1, asked for s = %d\n", c->dri);
322                                 return m;
323
324                         case 0:
325                                 printd("DEVDIRREAD got 0, asked for s = %d\n", c->dri);
326                                 break;
327
328                         case 1:
329                                 printd("DEVDIRREAD got 1, asked for s = %d\n", c->dri);
330                                 dsz = convD2M(&dir[0], (uint8_t *) d, n - m);
331                                 if (dsz <= BIT16SZ) {   /* <= not < because this isn't stat; read is stuck */
332                                         if (m == 0)
333                                                 error(Eshort);
334                                         return m;
335                                 }
336                                 m += dsz;
337                                 d += dsz;
338                                 break;
339                 }
340         }
341
342         return m;
343 }
344
345 /*
346  * error(Eperm) if open permission not granted for up->env->user.
347  */
348 void devpermcheck(char *fileuid, uint32_t perm, int omode)
349 {
350         int rwx;
351         /* select user, group, or other from the traditional rwxrwxrwx, shifting
352          * into the upper-most position */
353         if (strcmp(current->user, fileuid) == 0)
354                 perm <<= 0;
355         else if (strcmp(current->user, eve) == 0)
356                 perm <<= 3;
357         else
358                 perm <<= 6;
359         /* translate omode into things like S_IRUSR (just one set of rwx------).
360          * Plan 9 originally only returned 0400 0200 0600 and 0100 here; it didn't
361          * seem to handle O_EXEC being mixed readable or writable. */
362         rwx = omode_to_rwx(omode);
363         if ((rwx & perm) != rwx)
364                 error("%s: devpermcheck(%s,0x%x,0x%x) failed", Eperm, fileuid, perm,
365                           omode);
366 }
367
368 struct chan *devopen(struct chan *c, int omode, struct dirtab *tab, int ntab,
369                                          Devgen * gen)
370 {
371         int i;
372         struct dir dir;
373
374         dir.qid.path = 0;
375         for (i = 0;; i++) {
376                 switch ((*gen) (c, NULL, tab, ntab, i, &dir)) {
377                         case -1:
378                                 goto Return;
379                         case 0:
380                                 break;
381                         case 1:
382                                 if (c->qid.path == dir.qid.path) {
383                                         devpermcheck(dir.uid, dir.mode, omode);
384                                         goto Return;
385                                 }
386                                 break;
387                 }
388         }
389 Return:
390         c->offset = 0;
391         if ((c->qid.type & QTDIR) && (omode & O_WRITE))
392                 error("Tried opening dir with non-read-only mode %o", omode);
393         c->mode = openmode(omode);
394         c->flag |= COPEN;
395         return c;
396 }
397
398 void
399 devcreate(struct chan *c, char *unused_char_p_t, int unused_int, uint32_t u)
400 {
401         error(Eperm);
402 }
403
404 struct block *devbread(struct chan *c, long n, uint32_t offset)
405 {
406         ERRSTACK(1);
407         struct block *bp;
408
409         bp = allocb(n);
410         if (bp == 0)
411                 error(Enomem);
412         if (waserror()) {
413                 freeb(bp);
414                 nexterror();
415         }
416         bp->wp += devtab[c->type].read(c, bp->wp, n, offset);
417         poperror();
418         return bp;
419 }
420
421 long devbwrite(struct chan *c, struct block *bp, uint32_t offset)
422 {
423         ERRSTACK(1);
424         long n;
425
426         if (waserror()) {
427                 freeb(bp);
428                 nexterror();
429         }
430         n = devtab[c->type].write(c, bp->rp, BLEN(bp), offset);
431         poperror();
432         freeb(bp);
433
434         return n;
435 }
436
437 void devremove(struct chan *c)
438 {
439         error(Eperm);
440 }
441
442 int devwstat(struct chan *c, uint8_t * unused_uint8_p_t, int i)
443 {
444         error(Eperm);
445         return 0;
446 }
447
448 void devpower(int i)
449 {
450         error(Eperm);
451 }
452
453 #if 0
454 int devconfig(int unused_int, char *c, DevConf *)
455 {
456         error(Eperm);
457         return 0;
458 }
459 #endif
460
461 char *devchaninfo(struct chan *chan, char *ret, size_t ret_l)
462 {
463         snprintf(ret, ret_l, "qid.path: %p, qid.type: %02x", chan->qid.path,
464                          chan->qid.type);
465         return ret;
466 }
467
468 /*
469  * check that the name in a wstat is plausible
470  */
471 void validwstatname(char *name)
472 {
473         validname(name, 0);
474         if (strcmp(name, ".") == 0 || strcmp(name, "..") == 0)
475                 error(Efilename);
476 }
477
478 struct dev *devbyname(char *name)
479 {
480         int i;
481
482         for (i = 0; &devtab[i] < __devtabend; i++)
483                 if (strcmp(devtab[i].name, name) == 0)
484                         return &devtab[i];
485         return NULL;
486 }