Idenfity devices by name, not by char [1/3]
[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 = devtab[c->type].dc;
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         if (c->flag & COPEN)
122                 panic("clone of open file type %c\n", devtab[c->type].dc);
123
124         nc = newchan();
125
126         nc->type = c->type;
127         nc->dev = c->dev;
128         nc->mode = c->mode;
129         nc->qid = c->qid;
130         nc->offset = c->offset;
131         nc->umh = NULL;
132         nc->mountid = c->mountid;
133         nc->aux = c->aux;
134         nc->mqid = c->mqid;
135         nc->mcp = c->mcp;
136         return nc;
137 }
138
139 struct walkqid *devwalk(struct chan *c,
140                                                 struct chan *nc, char **name, int nname,
141                                                 struct dirtab *tab, int ntab, Devgen * gen)
142 {
143         ERRSTACK(1);
144         int i, j;
145         volatile int alloc;                     /* to keep waserror from optimizing this out */
146         struct walkqid *wq;
147         char *n;
148         struct dir dir;
149
150         if (nname > 0)
151                 isdir(c);
152
153         alloc = 0;
154         wq = kzmalloc(sizeof(struct walkqid) + nname * sizeof(struct qid),
155                                   KMALLOC_WAIT);
156         if (waserror()) {
157                 if (alloc && wq->clone != NULL)
158                         cclose(wq->clone);
159                 kfree(wq);
160                 poperror();
161                 return NULL;
162         }
163         if (nc == NULL) {
164                 nc = devclone(c);
165                 /* inferno was setting this to 0, assuming it was devroot.  lining up
166                  * with chanrelease and newchan */
167                 nc->type = -1;  /* device doesn't know about this channel yet */
168                 alloc = 1;
169         }
170         wq->clone = nc;
171
172         dir.qid.path = 0;
173         for (j = 0; j < nname; j++) {
174                 if (!(nc->qid.type & QTDIR)) {
175                         if (j == 0)
176                                 error(Enotdir);
177                         goto Done;
178                 }
179                 n = name[j];
180                 if (strcmp(n, ".") == 0) {
181 Accept:
182                         wq->qid[wq->nqid++] = nc->qid;
183                         continue;
184                 }
185                 if (strcmp(n, "..") == 0) {
186                         (*gen) (nc, NULL, tab, ntab, DEVDOTDOT, &dir);
187                         nc->qid = dir.qid;
188                         goto Accept;
189                 }
190                 /*
191                  * Ugly problem: If we're using devgen, make sure we're
192                  * walking the directory itself, represented by the first
193                  * entry in the table, and not trying to step into a sub-
194                  * directory of the table, e.g. /net/net. Devgen itself
195                  * should take care of the problem, but it doesn't have
196                  * the necessary information (that we're doing a walk).
197                  */
198                 if (gen == devgen && nc->qid.path != tab[0].qid.path)
199                         goto Notfound;
200                 dir.qid.path = 0;
201                 for (i = 0;; i++) {
202                         switch ((*gen) (nc, n, tab, ntab, i, &dir)) {
203                                 case -1:
204                                         printd("DEVWALK -1, i was %d, want path %p\n", i,
205                                                    c->qid.path);
206 Notfound:
207                                         set_errno(ENOENT);
208                                         if (j == 0)
209                                                 error(Enonexist);
210                                         set_errstr(Enonexist);
211                                         goto Done;
212                                 case 0:
213                                         printd("DEVWALK continue, i was %d\n", i);
214                                         continue;
215                                 case 1:
216                                         printd
217                                                 ("DEVWALK gen returns path %p name %s, want path %p\n",
218                                                  dir.qid.path, dir.name, c->qid.path);
219                                         if (strcmp(n, dir.name) == 0) {
220                                                 nc->qid = dir.qid;
221                                                 goto Accept;
222                                         }
223                                         continue;
224                         }
225                 }
226         }
227         /*
228          * We processed at least one name, so will return some data.
229          * If we didn't process all nname entries succesfully, we drop
230          * the cloned channel and return just the Qids of the walks.
231          */
232 Done:
233         poperror();
234         if (wq->nqid < nname) {
235                 if (alloc)
236                         cclose(wq->clone);
237                 wq->clone = NULL;
238         } else if (wq->clone) {
239                 /* attach cloned channel to same device */
240                 wq->clone->type = c->type;
241         }
242         return wq;
243 }
244
245 int
246 devstat(struct chan *c, uint8_t * db, int n,
247                 struct dirtab *tab, int ntab, Devgen * gen)
248 {
249         int i;
250         struct dir dir;
251         char *p, *elem;
252
253         dir.qid.path = 0;
254         for (i = 0;; i++)
255                 switch ((*gen) (c, NULL, tab, ntab, i, &dir)) {
256                         case -1:
257                                 if (c->qid.type & QTDIR) {
258                                         printd("DEVSTAT got a dir: %llu\n", c->qid.path);
259                                         if (c->name == NULL)
260                                                 elem = "???";
261                                         else if (strcmp(c->name->s, "/") == 0)
262                                                 elem = "/";
263                                         else
264                                                 for (elem = p = c->name->s; *p; p++)
265                                                         if (*p == '/')
266                                                                 elem = p + 1;
267                                         devdir(c, c->qid, elem, 0, eve, DMDIR | 0555, &dir);
268                                         n = convD2M(&dir, db, n);
269                                         if (n == 0)
270                                                 error(Ebadarg);
271                                         return n;
272                                 }
273                                 printd("DEVSTAT fails:%c %llu\n", devtab[c->type].dc,
274                                            c->qid.path);
275                                 set_errno(ENOENT);
276                                 error(Enonexist);
277                         case 0:
278                                 printd("DEVSTAT got 0\n");
279                                 break;
280                         case 1:
281                                 printd("DEVSTAT gen returns path %p name %s, want path %p\n",
282                                            dir.qid.path, dir.name, c->qid.path);
283                                 if (c->qid.path == dir.qid.path) {
284                                         if (c->flag & CMSG)
285                                                 dir.mode |= DMMOUNT;
286                                         n = convD2M(&dir, db, n);
287                                         if (n == 0)
288                                                 error(Ebadarg);
289                                         return n;
290                                 }
291                                 break;
292                 }
293 }
294
295 long
296 devdirread(struct chan *c, char *d, long n,
297                    struct dirtab *tab, int ntab, Devgen * gen)
298 {
299         long m, dsz;
300         /* this is gross. Make it 2 so we have room at the end for
301          * bad things.
302          */
303         struct dir dir[4];
304
305         dir[0].qid.path = 0;
306         for (m = 0; m < n; c->dri++) {
307                 switch ((*gen) (c, NULL, tab, ntab, c->dri, &dir[0])) {
308                         case -1:
309                                 printd("DEVDIRREAD got -1, asked for s = %d\n", c->dri);
310                                 return m;
311
312                         case 0:
313                                 printd("DEVDIRREAD got 0, asked for s = %d\n", c->dri);
314                                 break;
315
316                         case 1:
317                                 printd("DEVDIRREAD got 1, asked for s = %d\n", c->dri);
318                                 dsz = convD2M(&dir[0], (uint8_t *) d, n - m);
319                                 if (dsz <= BIT16SZ) {   /* <= not < because this isn't stat; read is stuck */
320                                         if (m == 0)
321                                                 error(Eshort);
322                                         return m;
323                                 }
324                                 m += dsz;
325                                 d += dsz;
326                                 break;
327                 }
328         }
329
330         return m;
331 }
332
333 /*
334  * error(Eperm) if open permission not granted for up->env->user.
335  */
336 void devpermcheck(char *fileuid, uint32_t perm, int omode)
337 {
338         int rwx;
339         /* select user, group, or other from the traditional rwxrwxrwx, shifting
340          * into the upper-most position */
341         if (strcmp(current->user, fileuid) == 0)
342                 perm <<= 0;
343         else if (strcmp(current->user, eve) == 0)
344                 perm <<= 3;
345         else
346                 perm <<= 6;
347         /* translate omode into things like S_IRUSR (just one set of rwx------).
348          * Plan 9 originally only returned 0400 0200 0600 and 0100 here; it didn't
349          * seem to handle O_EXEC being mixed readable or writable. */
350         rwx = omode_to_rwx(omode);
351         if ((rwx & perm) != rwx)
352                 error("%s: devpermcheck(%s,0x%x,0x%x) failed", Eperm, fileuid, perm,
353                           omode);
354 }
355
356 struct chan *devopen(struct chan *c, int omode, struct dirtab *tab, int ntab,
357                                          Devgen * gen)
358 {
359         int i;
360         struct dir dir;
361
362         dir.qid.path = 0;
363         for (i = 0;; i++) {
364                 switch ((*gen) (c, NULL, tab, ntab, i, &dir)) {
365                         case -1:
366                                 goto Return;
367                         case 0:
368                                 break;
369                         case 1:
370                                 if (c->qid.path == dir.qid.path) {
371                                         devpermcheck(dir.uid, dir.mode, omode);
372                                         goto Return;
373                                 }
374                                 break;
375                 }
376         }
377 Return:
378         c->offset = 0;
379         if ((c->qid.type & QTDIR) && (omode & O_WRITE))
380                 error("Tried opening dir with non-read-only mode %o", omode);
381         c->mode = openmode(omode);
382         c->flag |= COPEN;
383         return c;
384 }
385
386 void
387 devcreate(struct chan *c, char *unused_char_p_t, int unused_int, uint32_t u)
388 {
389         error(Eperm);
390 }
391
392 struct block *devbread(struct chan *c, long n, uint32_t offset)
393 {
394         ERRSTACK(1);
395         struct block *bp;
396
397         bp = allocb(n);
398         if (bp == 0)
399                 error(Enomem);
400         if (waserror()) {
401                 freeb(bp);
402                 nexterror();
403         }
404         bp->wp += devtab[c->type].read(c, bp->wp, n, offset);
405         poperror();
406         return bp;
407 }
408
409 long devbwrite(struct chan *c, struct block *bp, uint32_t offset)
410 {
411         ERRSTACK(1);
412         long n;
413
414         if (waserror()) {
415                 freeb(bp);
416                 nexterror();
417         }
418         n = devtab[c->type].write(c, bp->rp, BLEN(bp), offset);
419         poperror();
420         freeb(bp);
421
422         return n;
423 }
424
425 void devremove(struct chan *c)
426 {
427         error(Eperm);
428 }
429
430 int devwstat(struct chan *c, uint8_t * unused_uint8_p_t, int i)
431 {
432         error(Eperm);
433         return 0;
434 }
435
436 void devpower(int i)
437 {
438         error(Eperm);
439 }
440
441 #if 0
442 int devconfig(int unused_int, char *c, DevConf *)
443 {
444         error(Eperm);
445         return 0;
446 }
447 #endif
448
449 char *devchaninfo(struct chan *chan, char *ret, size_t ret_l)
450 {
451         snprintf(ret, ret_l, "qid.path: %p, qid.type: %02x", chan->qid.path,
452                          chan->qid.type);
453         return ret;
454 }
455
456 /*
457  * check that the name in a wstat is plausible
458  */
459 void validwstatname(char *name)
460 {
461         validname(name, 0);
462         if (strcmp(name, ".") == 0 || strcmp(name, "..") == 0)
463                 error(Efilename);
464 }
465
466 struct dev *devbyname(char *name)
467 {
468         int i;
469
470         for (i = 0; &devtab[i] < __devtabend; i++)
471                 if (strcmp(devtab[i].name, name) == 0)
472                         return &devtab[i];
473         return NULL;
474 }