9ns: Extend struct dir and the stat M bufs
[akaros.git] / kern / include / ns.h
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
30 #pragma once
31
32 #include <env.h>
33 #include <err.h>
34 #include <rendez.h>
35 #include <rwlock.h>
36 #include <linker_func.h>
37 #include <fdtap.h>
38 #include <ros/fs.h>
39 #include <vfs.h>
40
41 /*
42  * functions (possibly) linked in, complete, from libc.
43  */
44 enum {
45         UTFmax = 4,                                     /* maximum bytes per rune */
46         Runesync = 0x80,        /* cannot represent part of a UTF sequence (<) */
47         Runeself = 0x80,        /* rune and UTF sequences are the same (<) */
48         Runeerror = 0xFFFD,     /* decoding error in UTF */
49         Runemax = 0x10FFFF,     /* 21-bit rune */
50         Runemask = 0x1FFFFF,    /* bits used by runes (see grep) */
51         NUMSIZE32 = 10, /* max size of formatted 32 bit number (hex or decimal) */
52         NUMSIZE64 = 20, /* max size of formatted 64 bit number (hex or decimal) */
53 };
54
55 /*
56  * math
57  */
58 extern int isNaN(double);
59 extern int isInf(double, int);
60 extern double floor(double);
61 extern double frexp(double, int *);
62 extern double pow10(int);
63
64 /*
65  * one-of-a-kind
66  */
67 extern char *cleanname(char *unused_char_p_t);
68 //extern    uint32_t    getcallerpc(void*);
69 static inline uint32_t getcallerpc(void *v)
70 {
71         return 0;
72 }
73
74 extern int getfields(char *unused_char_p_t, char **unused_char_pp_t,
75                                          int unused_int, int, char *);
76 extern int tokenize(char *unused_char_p_t, char **unused_char_pp_t, int);
77 extern int dec64(uint8_t * unused_uint8_p_t, int unused_int,
78                                  char *unused_char_p_t, int);
79 extern void qsort(void *, long, long, int (*)(void *, void *));
80
81 extern int toupper(int);
82 extern int myetheraddr(uint8_t * unused_uint8_p_t, char *unused_char_p_t);
83 extern int parseether(uint8_t * unused_uint8_p_t, char *unused_char_p_t);
84
85 /*
86  * network dialling
87  */
88 #define NETPATHLEN      40
89
90 /*
91  * Syscall data structures
92  */
93 #define MORDER  0x0003  /* mask for bits defining order of mounting */
94 #define MREPL   0x0000  /* mount replaces object */
95 #define MBEFORE 0x0001  /* mount goes before others in union directory */
96 #define MAFTER  0x0002  /* mount goes after others in union directory */
97 #define MCREATE 0x0004  /* permit creation in mounted directory */
98 #define MCACHE  0x0010  /* cache some data */
99 #define MMASK   0x0017  /* all bits on */
100
101 #define NCONT   0       /* continue after note */
102 #define NDFLT   1       /* terminate after note */
103 #define NSAVE   2       /* clear note but hold state */
104 #define NRSTR   3       /* restore saved state */
105
106 #define STATMAX 65535U  /* max length of machine-independent stat structure */
107 #define ERRMAX                  128     /* max length of error string */
108 #define KNAMELEN                28      /* max length of name held in kernel */
109
110 /* bits in Qid.type */
111 #define QTDIR           0x80    /* type bit for directories */
112 #define QTAPPEND        0x40    /* type bit for append only files */
113 #define QTEXCL          0x20    /* type bit for exclusive use files */
114 #define QTMOUNT         0x10    /* type bit for mounted channel */
115 #define QTAUTH          0x08    /* type bit for authentication file */
116 #define QTFILE          0x01    /* plain file */
117
118 /* bits in Dir.mode */
119 #define DMDIR           0x80000000      /* mode bit for directories */
120 #define DMAPPEND        0x40000000      /* mode bit for append only files */
121 #define DMEXCL          0x20000000      /* mode bit for exclusive use files */
122 #define DMMOUNT         0x10000000      /* mode bit for mounted channel */
123 #define DMWRITABLE      0x08000000      /* non-standard, for select() */
124 #define DMREADABLE      0x04000000      /* non-standard, for select() */
125 #define DMSYMLINK       0x02000000      /* symlink -- from 9p2000.u */
126 #define DMREAD          0x4     /* mode bit for read permission */
127 #define DMWRITE         0x2     /* mode bit for write permission */
128 #define DMEXEC          0x1     /* mode bit for execute permission */
129
130 struct qid {
131         uint64_t path;
132         uint32_t vers;
133         uint8_t type;
134 };
135
136 struct dir {
137         /* system-modified data */
138         uint16_t type;                          /* server type */
139         uint32_t dev;                   /* server subtype */
140         /* file data */
141         struct qid qid;                         /* unique id from server */
142         uint32_t mode;                          /* permissions */
143         /* 9p stat has u32 atime (seconds) here */
144         /* 9p stat has u32 mtime (seconds) here */
145         uint64_t length;                        /* file length: see <u.h> */
146         char *name;                                     /* last element of path */
147         char *uid;                                      /* owner name */
148         char *gid;                                      /* group name */
149         char *muid;                                     /* last modifier name */
150         char *ext;                                      /* extensions for special files (symlinks) */
151         uint32_t n_uid;                         /* numeric owner uid */
152         uint32_t n_gid;                         /* numeric group id */
153         uint32_t n_muid;                        /* numeric last modifier id */
154         struct timespec atime;          /* last access time */
155         struct timespec btime;          /* file creation time */
156         struct timespec ctime;          /* last attribute change time */
157         struct timespec mtime;          /* last data modification time */
158 };
159
160 struct waitmsg {
161         int pid;                                        /* of loved one */
162         uint32_t time[3];                       /* of loved one and descendants */
163         char msg[ERRMAX];                       /* actually variable-size in user mode */
164 };
165
166 #define VERSION9P       "9P2000"
167
168 #define MAXWELEM        16
169
170 typedef
171         struct fcall {
172         uint8_t type;
173         uint32_t fid;
174         uint16_t tag;
175         /* union { */
176         /* struct { */
177         uint32_t msize;                         /* Tversion, Rversion */
178         char *version;                          /* Tversion, Rversion */
179         /* }; */
180         /* struct { */
181         uint16_t oldtag;                        /* Tflush */
182         /* }; */
183         /* struct { */
184         char *ename;                            /* Rerror */
185         /* }; */
186         /* struct { */
187         struct qid qid;                         /* Rattach, Ropen, Rcreate */
188         uint32_t iounit;                        /* Ropen, Rcreate */
189         /* }; */
190         /* struct { */
191         struct qid aqid;                        /* Rauth */
192         /* }; */
193         /* struct { */
194         uint32_t afid;                          /* Tauth, Tattach */
195         char *uname;                            /* Tauth, Tattach */
196         char *aname;                            /* Tauth, Tattach */
197         /* }; */
198         /* struct { */
199         uint32_t perm;                          /* Tcreate */
200         char *name;                                     /* Tcreate */
201         uint8_t mode;                           /* Tcreate, Topen */
202         /* }; */
203         /* struct { */
204         uint32_t newfid;                        /* Twalk */
205         uint16_t nwname;                        /* Twalk */
206         char *wname[MAXWELEM];          /* Twalk */
207         /* }; */
208         /* struct { */
209         uint16_t nwqid;                         /* Rwalk */
210         struct qid wqid[MAXWELEM];      /* Rwalk */
211         /* }; */
212         /* struct { */
213         int64_t offset;                         /* Tread, Twrite */
214         uint32_t count;                         /* Tread, Twrite, Rread */
215         char *data;                                     /* Twrite, Rread */
216         /* }; */
217         /* struct { */
218         uint16_t nstat;                         /* Twstat, Rstat */
219         uint8_t *stat;                          /* Twstat, Rstat */
220         /* }; */
221         /* }; */
222 } fcall;
223
224 #define GBIT8(p)        ((p)[0])
225 #define GBIT16(p)       ((p)[0]|((p)[1]<<8))
226 #define GBIT32(p)       ((uint32_t)((p)[0]|((p)[1]<<8)|((p)[2]<<16)|((p)[3]<<24)))
227 #define GBIT64(p)       ((uint32_t)((p)[0]|((p)[1]<<8)|((p)[2]<<16)|((p)[3]<<24)) |\
228                                 ((int64_t)((p)[4]|((p)[5]<<8)|((p)[6]<<16)|((p)[7]<<24)) << 32))
229
230 #define PBIT8(p,v)      (p)[0]=(v)
231 #define PBIT16(p,v)     (p)[0]=(v);(p)[1]=(v)>>8
232 #define PBIT32(p,v)     (p)[0]=(v);(p)[1]=(v)>>8;(p)[2]=(v)>>16;(p)[3]=(v)>>24
233 #define PBIT64(p,v)     (p)[0]=(v);(p)[1]=(v)>>8;(p)[2]=(v)>>16;(p)[3]=(v)>>24;\
234                         (p)[4]=(v)>>32;(p)[5]=(v)>>40;(p)[6]=(v)>>48;(p)[7]=(v)>>56
235
236 #define BIT8SZ          1
237 #define BIT16SZ         2
238 #define BIT32SZ         4
239 #define BIT64SZ         8
240 #define QIDSZ   (BIT8SZ+BIT32SZ+BIT64SZ)
241
242 /* The 9p STATFIXLENs include the leading 16-bit count.  The count, however,
243  * excludes itself; total size is BIT16SZ + count.  This is the amount of fixed
244  * length data in a stat buffer.  This does not include the strings, but it
245  * includes the string counts (u16s)
246  *
247  * STAT_FIX_LEN_9P is the original 9p stat message: type to length, including
248  * u32 atime and u32 mtime.  This is the bare minimum for a stat that we
249  * receive.  We check in e.g. convM2D for any extra fields.
250  *
251  * STAT_FIX_LEN_AK is the stat message used by Akaros, which includes Eric VH's
252  * extensions and full timespecs.  It is analogous to struct dir, including the
253  * u32s for the legacy atime/mtime.  We always send stats of this size, e.g. in
254  * convD2M.
255  *
256  * Note that the extended stat message has fixed data after the strings, but to
257  * get to this data, you have to jump through the string and their counts
258  * (u16s).  The counts are part of the fixed length, but not the strings.  Also
259  * note that the _AK version has an extra string. */
260 #define STAT_NR_STRINGS_9P 4
261 #define STAT_NR_STRINGS_AK 5
262 #define STAT_FIX_LEN_9P (BIT16SZ +                      /* size */             \
263                          BIT16SZ +                      /* type */             \
264                          BIT32SZ +                      /* dev */              \
265                          QIDSZ +                        /* qid */              \
266                          BIT32SZ +                      /* mode */             \
267                          BIT32SZ +                      /* atime u32 */        \
268                          BIT32SZ +                      /* mtime u32 */        \
269                          BIT64SZ +                      /* length */           \
270                          STAT_NR_STRINGS_9P * BIT16SZ + /* string counts */    \
271                                                  0)
272 #define __STAT_FIX_LEN_AK_NONSTRING (                                          \
273                          BIT32SZ +                      /* n_uid */            \
274                          BIT32SZ +                      /* n_gid */            \
275                          BIT32SZ +                      /* n_muid */           \
276                          2 * BIT64SZ +                  /* atime */            \
277                          2 * BIT64SZ +                  /* btime */            \
278                          2 * BIT64SZ +                  /* ctime */            \
279                          2 * BIT64SZ +                  /* mtime */            \
280                                                  0)
281 #define STAT_FIX_LEN_AK (STAT_FIX_LEN_9P +                                     \
282                          (STAT_NR_STRINGS_AK - STAT_NR_STRINGS_9P) * BIT16SZ + \
283                          __STAT_FIX_LEN_AK_NONSTRING +                         \
284                                                  0)
285
286 #define NOTAG           (uint16_t)~0U   /* Dummy tag */
287 #define NOFID           (uint32_t)~0U   /* Dummy fid */
288 #define IOHDRSZ         24      /* ample room for Twrite/Rread header (iounit) */
289
290 enum {
291         Tversion = 100,
292         Rversion,
293         Tauth = 102,
294         Rauth,
295         Tattach = 104,
296         Rattach,
297         Terror = 106,   /* illegal */
298         Rerror,
299         Tflush = 108,
300         Rflush,
301         Twalk = 110,
302         Rwalk,
303         Topen = 112,
304         Ropen,
305         Tcreate = 114,
306         Rcreate,
307         Tread = 116,
308         Rread,
309         Twrite = 118,
310         Rwrite,
311         Tclunk = 120,
312         Rclunk,
313         Tremove = 122,
314         Rremove,
315         Tstat = 124,
316         Rstat,
317         Twstat = 126,
318         Rwstat,
319         Tmax,
320 };
321
322 void init_empty_dir(struct dir *d);
323 unsigned int convM2S(uint8_t * unused_uint8_p_t, unsigned int unused_int,
324                                          struct fcall *);
325 unsigned int convS2M(struct fcall *, uint8_t * unused_uint8_p_t, unsigned int);
326 unsigned int sizeS2M(struct fcall *);
327
328 unsigned int convM2kdirent(uint8_t * buf, unsigned int nbuf, struct kdirent *kd,
329                                                    char *strs);
330 unsigned int convM2kstat(uint8_t * buf, unsigned int nbuf, struct kstat *ks);
331
332 int statcheck(uint8_t * abuf, unsigned int nbuf);
333 unsigned int convM2D(uint8_t * unused_uint8_p_t, unsigned int unused_int,
334                                          struct dir *, char *unused_char_p_t);
335 unsigned int convD2M(struct dir *, uint8_t * unused_uint8_p_t, unsigned int);
336 unsigned int sizeD2M(struct dir *);
337
338 int read9pmsg(int unused_int, void *, unsigned int);
339
340 struct ref {
341         spinlock_t l;
342         long ref;
343 };
344
345 struct rept {
346         spinlock_t l;
347         struct rendez r;
348         void *o;
349         int t;
350         int (*active) (void *);
351         int (*ck) (void *, int);
352         void (*f) (void *);                     /* called with VM acquire()'d */
353 };
354
355 enum {
356         Nopin = -1
357 };
358
359 struct talarm {
360         spinlock_t lock;
361         struct proc *list;
362 };
363
364 struct alarms {
365         qlock_t qlock;
366         struct proc *head;
367 };
368
369 /*
370  * Access types in namec & channel flags
371  */
372 enum {
373         Aaccess,                                        /* as in stat, wstat */
374         Abind,                                          /* for left-hand-side of bind */
375         Atodir,                                         /* as in chdir */
376         Aopen,                                          /* for i/o */
377         Amount,                                         /* to be mounted or mounted upon */
378         Acreate,                                        /* is to be created */
379         Aremove,                                        /* will be removed by caller */
380         Acreatechan,                                    /* return a chan for a create request. for sysrename. */
381
382         /* internal chan flags, used by the kernel only */
383         COPEN =                 0x0001, /* for i/o */
384         CMSG =                  0x0002, /* the message channel for a mount */
385         CFREE =                 0x0004, /* not in use */
386         CCACHE =                0x0008, /* client cache */
387         CINTERNAL_FLAGS = (COPEN | CMSG | CFREE | CCACHE),
388
389         /* chan/file flags, getable via fcntl/getfl and setably via open and
390          * sometimes fcntl/setfl.  those that can't be set cause an error() in
391          * fd_setfl. */
392         CEXTERNAL_FLAGS = (
393             O_CLOEXEC      | /* (prob should be on the FD, 9ns has it here) */
394             O_REMCLO       | /* remove on close (also, maybe should be on FD) */
395             O_APPEND       | /* append on write */
396             O_NONBLOCK     | /* don't block, can't be set via setfl */
397             O_PATH         | /* path open, just the name, no I/O */
398             0),
399 };
400
401 #define NS_IPCK_SHIFT  2
402 #define NS_UDPCK_SHIFT 3
403 #define NS_TCPCK_SHIFT 4
404 #define NS_PKTCK_SHIFT 5
405 #define NS_TSO_SHIFT 6
406 #define NS_SHIFT_MAX 6
407
408 enum {
409         BFREE = (1 << 1),
410         Bipck = (1 << NS_IPCK_SHIFT),   /* ip checksum (rx) */
411         Budpck = (1 << NS_UDPCK_SHIFT), /* udp checksum (rx), needed (tx) */
412         Btcpck = (1 << NS_TCPCK_SHIFT), /* tcp checksum (rx), needed (tx) */
413         Bpktck = (1 << NS_PKTCK_SHIFT), /* packet checksum (rx, maybe) */
414         Btso = (1 << NS_TSO_SHIFT),             /* TSO desired (tx) */
415 };
416 #define BLOCK_META_FLAGS (Bipck | Budpck | Btcpck | Bpktck | Btso)
417 #define BLOCK_TRANS_TX_CSUM (Budpck | Btcpck)
418 #define BLOCK_RX_CSUM (Bipck | Budpck | Btcpck)
419
420 struct extra_bdata {
421         uintptr_t base;
422         /* using u32s for packing reasons.  this means no extras > 4GB */
423         uint32_t off;
424         uint32_t len;
425 };
426
427 struct block {
428         struct block *next;
429         struct block *list;
430         uint8_t *rp;                            /* first unconsumed byte */
431         uint8_t *wp;                            /* first empty byte */
432         uint8_t *lim;                           /* 1 past the end of the buffer */
433         uint8_t *base;                          /* start of the buffer */
434         void (*free) (struct block *);
435         uint16_t flag;
436         uint16_t mss;               /* TCP MSS for TSO */
437         uint16_t network_offset;        /* offset from start */
438         uint16_t transport_offset;      /* offset from start */
439         uint16_t tx_csum_offset;        /* offset from tx_offset to store csum */
440         /* might want something to track the next free extra_data slot */
441         size_t extra_len;
442         unsigned int nr_extra_bufs;
443         struct extra_bdata *extra_data;
444 };
445 #define BLEN(s) ((s)->wp - (s)->rp + (s)->extra_len)
446 #define BHLEN(s) ((s)->wp - (s)->rp)
447 #define BALLOC(s) ((s)->lim - (s)->base + (s)->extra_len)
448
449 struct chan {
450         spinlock_t lock;
451         struct kref ref;
452         struct chan *next;                      /* allocation */
453         struct chan *link;
454         int64_t offset;                         /* in file */
455         int type;
456         uint32_t dev;
457         uint16_t mode;                          /* read/write */
458         int flag;
459         struct qid qid;
460         int fid;                                        /* for devmnt */
461         uint32_t iounit;                        /* chunk size for i/o; 0==default */
462         struct mhead *umh;                      /* mount point that derived Chan; used in unionread */
463         struct chan *umc;                       /* channel in union; held for union read */
464         qlock_t umqlock;                        /* serialize unionreads */
465         int uri;                                        /* union read index */
466         int dri;                                        /* devdirread index */
467         uint32_t mountid;
468         struct mntcache *mcp;           /* Mount cache pointer */
469         struct mnt *mux;                        /* Mnt for clients using me for messages */
470         union {
471                 void *aux;
472                 char tag[4];                    /* for iproute */
473         };
474         /* mountpoint, as discovered during walk.
475          * Used for rename at present.
476          */
477         struct chan *mountpoint;
478         struct chan *mchan;                     /* channel to mounted server */
479         struct qid mqid;                        /* qid of root of mount point */
480         struct cname *name;
481         /* hack for dir reads to try to get them right. */
482         int ateof;
483         void *buf;
484         int bufused;
485         /* A lot of synthetic files need something generated at open time, which the
486          * user can read from (including offsets) while the underlying file changes.
487          * Hang that buffer here. */
488         void *synth_buf;
489 };
490
491 struct cname {
492         struct kref ref;
493         int alen;                                       /* allocated length */
494         int len;                                        /* strlen(s) */
495         char *s;
496 };
497
498 struct dev {
499         char *name;
500
501         void (*reset) (void);
502         void (*init) (void);
503         void (*shutdown) (void);
504         struct chan *(*attach) (char *muxattach);
505         struct walkqid *(*walk) (struct chan *, struct chan *, char **name, int);
506         int (*stat) (struct chan *, uint8_t *, int);
507         struct chan *(*open) (struct chan *, int);
508         void (*create)(struct chan *, char *, int, uint32_t, char *);
509         void (*close) (struct chan *);
510         long (*read) (struct chan *, void *, long, int64_t);
511         struct block *(*bread) (struct chan *, long, uint32_t);
512         long (*write) (struct chan *, void *, long, int64_t);
513         long (*bwrite) (struct chan *, struct block *, uint32_t);
514         void (*remove) (struct chan *);
515         int (*wstat) (struct chan *, uint8_t * unused_uint8_p_t, int);
516         void (*power) (int);            /* power mgt: power(1) → on, power (0) → off */
517 //  int (*config)( int unused_int, char *unused_char_p_t, DevConf*);
518         char *(*chaninfo) (struct chan *, char *, size_t);
519         int (*tapfd) (struct chan *, struct fd_tap *, int);
520         int (*chan_ctl)(struct chan *, int);
521         /* we need to be aligned to 64 bytes for the linker tables. */
522 } __attribute__ ((aligned(64)));
523
524 struct dirtab {
525         char name[KNAMELEN];
526         struct qid qid;
527         int64_t length;
528         int perm;
529         /* we need to be aligned to 64 bytes for the linker tables. */
530 } __attribute__ ((aligned(64)));
531
532 struct walkqid {
533         struct chan *clone;
534         int nqid;
535         struct qid qid[1];
536 };
537
538 enum {
539         NSMAX = 1000,
540         NSLOG = 7,
541         NSCACHE = (1 << NSLOG),
542 };
543
544 struct mntwalk {                                /* state for /proc/#/ns */
545         int cddone;
546         uint32_t id;
547         struct mhead *mh;
548         struct mount *cm;
549 };
550
551 struct mount {
552         uint32_t mountid;
553         struct mount *next;
554         struct mhead *head;
555         struct mount *copy;
556         struct mount *order;
557         struct chan *to;                        /* channel replacing channel */
558         int mflag;
559         char *spec;
560 };
561
562 struct mhead {
563         struct kref ref;
564         struct rwlock lock;
565         struct chan *from;                      /* channel mounted upon */
566         struct mount *mount;            /* what's mounted upon it */
567         struct mhead *hash;                     /* Hash chain */
568 };
569
570 struct mnt {
571         spinlock_t lock;
572         /* references are counted using c->ref; channels on this mount point incref(c->mchan) == Mnt.c */
573         struct chan *c;                         /* Channel to file service */
574         struct proc *rip;                       /* Reader in progress */
575         struct mntrpc *queue;           /* Queue of pending requests on this channel */
576         uint32_t id;                            /* Multiplexer id for channel check */
577         struct mnt *list;                       /* Free list */
578         int flags;                                      /* cache */
579         int msize;                                      /* data + IOHDRSZ */
580         char *version;                          /* 9P version */
581         struct queue *q;                        /* input queue */
582 };
583
584 enum {
585         RENDLOG = 5,
586         RENDHASH = 1 << RENDLOG,        /* Hash to lookup rendezvous tags */
587         MNTLOG = 5,
588         MNTHASH = 1 << MNTLOG,  /* Hash to walk mount table */
589         DELTAFD = 20,   /* allocation quantum for process file descriptors */
590         MAXNFD = 4000,  /* max per process file descriptors */
591         MAXKEY = 8,     /* keys for signed modules */
592 };
593 #define MOUNTH(p,qid)   ((p)->mnthash[(qid).path&((1<<MNTLOG)-1)])
594
595 struct mntparam {
596         struct chan *chan;
597         struct chan *authchan;
598         char *spec;
599         int flags;
600 };
601
602 struct pgrp {
603         struct kref ref;                        /* also used as a lock when mounting */
604         uint32_t pgrpid;
605         qlock_t debug;                          /* single access via devproc.c */
606         struct rwlock ns;                       /* Namespace n read/one write lock */
607         qlock_t nsh;
608         struct mhead *mnthash[MNTHASH];
609         int progmode;
610         struct chan *dot;
611         struct chan *slash;
612         int nodevs;
613         int pin;
614 };
615
616 struct evalue {
617         char *var;
618         char *val;
619         int len;
620         struct qid qid;
621         struct evalue *next;
622 };
623
624 struct egrp {
625         struct kref ref;
626         qlock_t qlock;
627         struct evalue *entries;
628         uint32_t path;                          /* qid.path of next Evalue to be allocated */
629         uint32_t vers;                          /* of Egrp */
630 };
631
632 struct signerkey {
633         struct kref ref;
634         char *owner;
635         uint16_t footprint;
636         uint32_t expires;
637         void *alg;
638         void *pk;
639         void (*pkfree) (void *);
640 };
641
642 struct skeyset {
643         struct kref ref;
644         qlock_t qlock;
645         uint32_t flags;
646         char *devs;
647         int nkey;
648         struct signerkey *keys[MAXKEY];
649 };
650
651 /*
652  * fasttick timer interrupts
653  */
654 enum {
655         /* Mode */
656         Trelative,                                      /* timer programmed in ns from now */
657         Tabsolute,                                      /* timer programmed in ns since epoch */
658         Tperiodic,                                      /* periodic timer, period in ns */
659 };
660
661 enum {
662         PRINTSIZE = 256,
663         NUMSIZE = 12,   /* size of formatted number */
664         MB = (1024 * 1024),
665         READSTR = 2000, /* temporary buffer size for device reads */
666 };
667
668 extern struct dev devtab[];
669 extern struct dev __devtabend[];
670
671 struct cmdbuf {
672         char *buf;
673         char **f;
674         int nf;
675 };
676
677 struct cmdtab {
678         int index;                                      /* used by client to switch on result */
679         char *cmd;                                      /* command name */
680         int narg;                                       /* expected #args; 0 ==> variadic */
681 };
682
683 /* queue state bits, all can be set in qopen (Qstarve is always set) */
684 enum {
685         Qmsg                    = (1 << 1),     /* message stream */
686         Qclosed                 = (1 << 2),     /* queue has been closed/hungup */
687         Qcoalesce               = (1 << 3),     /* coalesce empty packets on read */
688         Qkick                   = (1 << 4),     /* always call the kick routine after qwrite */
689         Qdropoverflow   = (1 << 5),     /* writes that would block will be dropped */
690 };
691
692 #define DEVDOTDOT -1
693
694 typedef int Devgen(struct chan *, char *unused_char_p_t, struct dirtab *,
695                                    int unused_int, int, struct dir *);
696
697 /* inferno portfns.h. Not all these are needed. */
698 #define         FPinit() fpinit()       /* remove this if math lib is linked */
699 void FPrestore(void *);
700 void FPsave(void *);
701 struct cname *addelem(struct cname *, char *unused_char_p_t);
702 void addprog(struct proc *);
703 void addrootfile(char *unused_char_p_t, uint8_t * unused_uint8_p_t, uint32_t);
704 struct block *adjustblock(struct block *, int);
705 struct block *block_alloc(size_t, int);
706 int block_add_extd(struct block *b, unsigned int nr_bufs, int mem_flags);
707 int block_append_extra(struct block *b, uintptr_t base, uint32_t off,
708                        uint32_t len, int mem_flags);
709 void block_copy_metadata(struct block *new_b, struct block *old_b);
710 void block_reset_metadata(struct block *b);
711 int anyhigher(void);
712 int anyready(void);
713 void _assert(char *unused_char_p_t);
714 struct block *bl2mem(uint8_t * unused_uint8_p_t, struct block *, int);
715 int blocklen(struct block *);
716 char *channame(struct chan *);
717 void cclose(struct chan *);
718 void chan_incref(struct chan *);
719 void chandevinit(void);
720 void chandevreset(void);
721 void chandevshutdown(void);
722 void chanfree(struct chan *);
723 void chanrec(struct mnt *);
724 void checkalarms(void);
725 void checkb(struct block *, char *unused_char_p_t);
726 void cinit(void);
727 struct chan *cclone(struct chan *);
728 void cclose(struct chan *);
729 void closeegrp(struct egrp *);
730 void closemount(struct mount *);
731 void closepgrp(struct pgrp *);
732 void closesigs(struct skeyset *);
733 void debugcmd(struct cmdbuf *cb);
734 struct mhead *newmhead(struct chan *from);
735 int cmount(struct chan *, struct chan *, int unused_int, char *unused_char_p_t);
736 void cnameclose(struct cname *);
737 struct block *concatblock(struct block *);
738 struct block *linearizeblock(struct block *b);
739 void confinit(void);
740 void cons_add_char(char c);
741 void copen(struct chan *);
742 struct block *copyblock(struct block *b, int mem_flags);
743 int cread(struct chan *, uint8_t * unused_uint8_p_t, int unused_int, int64_t);
744 struct chan *cunique(struct chan *);
745 struct chan *createdir(struct chan *, struct mhead *);
746 void cunmount(struct chan *, struct chan *);
747 void cupdate(struct chan *, uint8_t * unused_uint8_p_t, int unused_int,
748                          int64_t);
749 void cursorenable(void);
750 void cursordisable(void);
751 int cursoron(int);
752 void cursoroff(int);
753 void cwrite(struct chan *, uint8_t * unused_uint8_p_t, int unused_int, int64_t);
754 struct chan *devattach(const char *name, char *spec);
755 struct block *devbread(struct chan *, long, uint32_t);
756 long devbwrite(struct chan *, struct block *, uint32_t);
757 struct chan *devclone(struct chan *);
758 void devcreate(struct chan *, char *name, int mode, uint32_t perm, char *ext);
759 void devdir(struct chan *, struct qid, char *, int64_t, char *, long,
760                         struct dir *);
761 long devdirread(struct chan *, char *, long, struct dirtab *, int, Devgen *);
762 Devgen devgen;
763 void devinit(void);
764 int devno(const char *name, int user);
765 void devpower(int);
766 struct dev *devbyname(char *unused_char_p_t);
767 struct chan *devopen(struct chan *, int unused_int,
768                                          struct dirtab *, int unused_int2, Devgen *);
769 void devpermcheck(char *unused_char_p_t, uint32_t, int);
770 void devremove(struct chan *);
771 void devreset(void);
772 void devshutdown(void);
773 size_t dev_make_stat(struct chan *c, struct dir *dir, uint8_t *dp, size_t n);
774 int devstat(struct chan *, uint8_t * unused_uint8_p_t, int unused_int,
775                         struct dirtab *, int unused_int2, Devgen *);
776 struct walkqid *devwalk(struct chan *,
777                                                 struct chan *, char **unused_char_pp_t, int unused_int,
778                                                 struct dirtab *, int unused_intw, Devgen *);
779 int devwstat(struct chan *, uint8_t * unused_uint8_p_t, int);
780 char *devchaninfo(struct chan *chan, char *ret, size_t ret_l);
781 void disinit(void *);
782 void disfault(void *, char *unused_char_p_t);
783 int domount(struct chan **, struct mhead **);
784 void drawactive(int);
785 void drawcmap(void);
786 void dumpstack(void);
787 void egrpcpy(struct egrp *, struct egrp *);
788 int emptystr(char *unused_char_p_t);
789 int eqchan(struct chan *, struct chan *, int);
790 int eqqid(struct qid, struct qid);
791
792 void errstr(char *unused_char_p_t, int);
793 void excinit(void);
794 void exit(int);
795 void reboot(void);
796 void halt(void);
797 int export(int unused_int, char *unused_char_p_t, int);
798 uint64_t fastticks(uint64_t *);
799 uint64_t fastticks2ns(uint64_t);
800 int findmount(struct chan **, struct mhead **, int unused_int, int, struct qid);
801 void free_block_extra(struct block *);
802 size_t freeb(struct block *b);
803 size_t freeblist(struct block *b);
804 void freeskey(struct signerkey *);
805 void getcolor(uint32_t, uint32_t *, uint32_t *, uint32_t *);
806 uint32_t getmalloctag(void *);
807 uint32_t getrealloctag(void *);
808 void printblock(struct block *b);
809 void ilock(spinlock_t *);
810 int iprint(char *unused_char_p_t, ...);
811 void isdir(struct chan *);
812 int islo(void);
813 void iunlock(spinlock_t *);
814 void ixsummary(void);
815 void kbdclock(void);
816 int kbdcr2nl(struct queue *, int);
817 int kbdputc(struct queue *, int);
818 void kbdrepeat(int);
819 void kproc(char *unused_char_p_t, void (*)(void *), void *, int);
820 void kprocchild(struct proc *, void (*)(void *), void *);
821 void (*kproftick) (uint32_t);
822 void ksetenv(char *unused_char_p_t, char *, int);
823 void kstrdup(char **cp, char *name);
824
825 struct block *mem2bl(uint8_t * unused_uint8_p_t, int);
826 int memusehigh(void);
827 void microdelay(int);
828 uint64_t mk64fract(uint64_t, uint64_t);
829 void mkqid(struct qid *, int64_t, uint32_t, int);
830 void modinit(void);
831 struct chan *mntauth(struct chan *, char *unused_char_p_t);
832 long mntversion(struct chan *, char *unused_char_p_t, int unused_int, int);
833 void mountfree(struct mount *);
834 void mousetrack(int unused_int, int, int, int);
835 uint64_t ms2fastticks(uint32_t);
836 void mul64fract(uint64_t *, uint64_t, uint64_t);
837 void muxclose(struct mnt *);
838 struct chan *namec(char *unused_char_p_t, int unused_int, int, uint32_t,
839                    void *ext);
840 struct chan *namec_from(struct chan *c, char *name, int amode, int omode,
841                         uint32_t perm, void *ext);
842 struct chan *newchan(void);
843 struct egrp *newegrp(void);
844 struct mount *newmount(struct mhead *, struct chan *, int unused_int,
845                                            char *unused_char_p_t);
846 struct pgrp *newpgrp(void);
847 struct proc *newproc(void);
848 char *nextelem(char *unused_char_p_t, char *);
849
850 struct cname *newcname(char *unused_char_p_t);
851 void notkilled(void);
852 uint32_t random_read(void *xp, uint32_t n);
853 uint32_t urandom_read(void *xp, uint32_t n);
854 uint64_t ns2fastticks(uint64_t);
855 int okaddr(uint32_t, uint32_t, int);
856 int omode_to_rwx(int);
857 int omode_to_9p_accmode(int open_flags);
858 struct block *packblock(struct block *);
859 struct block *padblock(struct block *, int);
860
861 void pgrpcpy(struct pgrp *, struct pgrp *);
862
863 int progfdprint(struct chan *, int unused_int, int, char *unused_char_p_t,
864                                 int i);
865 int pullblock(struct block **, int);
866 struct block *pullupblock(struct block *, int);
867 struct block *pullupqueue(struct queue *, int);
868 void putmhead(struct mhead *);
869 void putstrn(char *unused_char_p_t, int);
870 void qaddlist(struct queue *, struct block *);
871 struct block *qbread(struct queue *q, size_t len);
872 struct block *qbread_nonblock(struct queue *q, size_t len);
873 ssize_t qbwrite(struct queue *, struct block *);
874 ssize_t qbwrite_nonblock(struct queue *, struct block *);
875 ssize_t qibwrite(struct queue *q, struct block *b);
876 struct queue *qbypass(void (*)(void *, struct block *), void *);
877 int qcanread(struct queue *);
878 void qclose(struct queue *);
879 struct block *qcopy(struct queue *, int unused_int, uint32_t);
880 struct block *qclone(struct queue *q, int header_len, int len,
881                      uint32_t offset);
882 struct block *blist_clone(struct block *blist, int header_len, int len,
883                           uint32_t offset);
884 size_t qdiscard(struct queue *q, size_t len);
885 void qflush(struct queue *);
886 void qfree(struct queue *);
887 int qfull(struct queue *);
888 struct block *qget(struct queue *);
889 void qhangup(struct queue *, char *unused_char_p_t);
890 int qisclosed(struct queue *);
891 ssize_t qiwrite(struct queue *, void *, int);
892 int qlen(struct queue *);
893 size_t q_bytes_read(struct queue *q);
894 void qdropoverflow(struct queue *, bool);
895 void q_toggle_qmsg(struct queue *q, bool onoff);
896 void q_toggle_qcoalesce(struct queue *q, bool onoff);
897 struct queue *qopen(int unused_int, int, void (*)(void *), void *);
898 ssize_t qpass(struct queue *, struct block *);
899 ssize_t qpassnolim(struct queue *, struct block *);
900 void qputback(struct queue *, struct block *);
901 size_t qread(struct queue *q, void *va, size_t len);
902 size_t qread_nonblock(struct queue *q, void *va, size_t len);
903 void qreopen(struct queue *);
904 void qsetlimit(struct queue *, size_t);
905 size_t qgetlimit(struct queue *);
906 int qwindow(struct queue *);
907 ssize_t qwrite(struct queue *, void *, int);
908 ssize_t qwrite_nonblock(struct queue *, void *, int);
909 typedef void (*qio_wake_cb_t)(struct queue *q, void *data, int filter);
910 void qio_set_wake_cb(struct queue *q, qio_wake_cb_t func, void *data);
911 bool qreadable(struct queue *q);
912 bool qwritable(struct queue *q);
913
914 void *realloc(void *, uint32_t);
915 int readmem(unsigned long offset, char *buf, unsigned long n,
916                         const void *mem, size_t mem_len);
917 int readnum(unsigned long off, char *buf, unsigned long n, unsigned long val,
918                         size_t size);
919 int readnum_hex(unsigned long off, char *buf, unsigned long n,
920                 unsigned long val, size_t size);
921 int readstr(unsigned long offset, char *buf, unsigned long n, const char *str);
922 int readnum_int64_t(uint32_t, char *unused_char_p_t, uint32_t, int64_t, int);
923 unsigned long strtoul_from_ubuf(void *ubuf, size_t count, int base);
924 void ready(struct proc *);
925 void renameproguser(char *unused_char_p_t, char *);
926 void renameuser(char *unused_char_p_t, char *);
927 void resrcwait(char *unused_char_p_t);
928 struct proc *runproc(void);
929 void (*serwrite) (char *unused_char_p_t, int);
930 int setcolor(uint32_t, uint32_t, uint32_t, uint32_t);
931
932 void setmalloctag(void *, uint32_t);
933 int setpri(int);
934 void setrealloctag(void *, uint32_t);
935 char *skipslash(char *unused_char_p_t);
936 void *smalloc(uint32_t);
937 int splhi(void);
938 int spllo(void);
939 void splx(int);
940 void splxpc(int);
941 void swiproc(struct proc *, int);
942 uint32_t _tas(uint32_t *);
943 uint32_t tk2ms(uint32_t);
944 #define         TK2MS(x) ((x)*(1000/HZ))
945 uint64_t tod2fastticks(int64_t);
946 int64_t todget(int64_t *);
947 void todfix(void);
948 void todsetfreq(int64_t);
949 void todinit(void);
950 void todset(int64_t, int64_t, int);
951 int tready(void *);
952 struct block *trimblock(struct block *, int unused_int, int);
953 int uartgetc(void);
954 void uartputc(int);
955 void uartputs(char *unused_char_p_t, int);
956 void unlock(spinlock_t *);
957 void userinit(void);
958 uint32_t userpc(void);
959 void validname(char *, int);
960 void validwstatname(char *);
961 int walk(struct chan **, char **unused_char_pp_t, int unused_int, bool, int *);
962 void *xalloc(uint32_t);
963 void *xallocz(uint32_t, int);
964 void xfree(void *);
965 void xhole(uint32_t, uint32_t);
966 void xinit(void);
967 int xmerge(void *, void *);
968 void *xspanalloc(uint32_t, int unused_int, uint32_t);
969 void xsummary(void);
970
971 void validaddr(void *, uint32_t, int);
972 void *vmemchr(void *, int unused_int, int);
973 void hnputv(void *, int64_t);
974 void hnputl(void *, uint32_t);
975 void hnputs(void *, uint16_t);
976 int64_t nhgetv(void *);
977 uint32_t nhgetl(void *);
978 uint16_t nhgets(void *);
979
980 char *get_cur_genbuf(void);
981
982 /* hack for now. */
983 #define NOW     tsc2msec(read_tsc())
984 #define seconds() tsc2sec(read_tsc())
985 #define milliseconds() tsc2msec(read_tsc())
986
987 /* kern/drivers/dev/tab.c */
988 void devtabinit();
989 void devtabreset();
990
991 /* kern/src/ns/parse.c */
992 struct cmdbuf *parsecmd(char *p, int n);
993 void cmderror(struct cmdbuf *cb, char *s);
994 struct cmdtab *lookupcmd(struct cmdbuf *cb, struct cmdtab *ctab, int nctab);
995
996 /* kern/src/ns/sysfile.c */
997 int newfd(struct chan *c, int low_fd, int oflags, bool must_use_low);
998 struct chan *fdtochan(struct fd_table *fdt, int fd, int mode, int chkmnt,
999                       int iref);
1000 long kchanio(void *vc, void *buf, int n, int mode);
1001 int openmode(uint32_t o);
1002 void fdclose(struct fd_table *fdt, int fd);
1003 int syschdir(char *path);
1004 int grpclose(struct fd_table *fdt, int fd);
1005 int sysclose(int fd);
1006 int syscreate(char *path, int mode, uint32_t perm);
1007 int sysdup(int old, int low_fd, bool must_use_low);
1008 int sys_dup_to(struct proc *from_proc, unsigned int from_fd,
1009                struct proc *to_proc, unsigned int to_fd);
1010 int sysfstat(int fd, uint8_t*, int n);
1011 int sysfstatakaros(int fd, struct kstat *);
1012 char *sysfd2path(int fd);
1013 int sysfauth(int fd, char *aname);
1014 int sysfversion(int fd, unsigned int msize, char *vers, unsigned int arglen);
1015 int sysfwstat(int fd, uint8_t * buf, int n);
1016 long bindmount(struct chan *c, char *old, int flag, char *spec);
1017 int sysbind(char *new, char *old, int flags);
1018 int sysmount(int fd, int afd, char *old, int flags, char *spec);
1019 int sysunmount(char *old, char *new);
1020 int sysopenat(int dirfd, char *path, int vfs_flags);
1021 int sysopen(char *path, int vfs_flags);
1022 long unionread(struct chan *c, void *va, long n);
1023 void read_exactly_n(struct chan *c, void *vp, long n);
1024 long sysread(int fd, void *va, long n);
1025 long syspread(int fd, void *va, long n, int64_t off);
1026 int sysremove(char *path);
1027 int64_t sysseek(int fd, int64_t off, int whence);
1028 void validstat(uint8_t * s, int n, int slashok);
1029 int sysstat(char *path, uint8_t*, int n);
1030 int sysstatakaros(char *path, struct kstat *);
1031 long syswrite(int fd, void *va, long n);
1032 long syspwrite(int fd, void *va, long n, int64_t off);
1033 int syswstat(char *path, uint8_t * buf, int n);
1034 struct dir *chandirstat(struct chan *c);
1035 struct dir *sysdirstat(char *name);
1036 struct dir *sysdirfstat(int fd);
1037 int sysdirwstat(char *name, struct dir *dir);
1038 int sysdirfwstat(int fd, struct dir *dir);
1039 long sysdirread(int fd, struct kdirent **d);
1040 int sysiounit(int fd);
1041 void print_chaninfo(struct chan *ch);
1042 int plan9setup(struct proc *new_proc, struct proc *parent, int flags);
1043 int iseve(void);
1044 int fd_getfl(int fd);
1045 int fd_setfl(int fd, int flags);
1046
1047 /* kern/drivers/dev/srv.c */
1048 char *srvname(struct chan *c);
1049
1050 /* kern/src/eipconv.c. Put them here or face real include hell. */
1051 void printqid(void (*putch) (int, void **), void **putdat, struct qid *q);
1052 void printcname(void (*putch) (int, void **), void **putdat, struct cname *c);
1053 void printchan(void (*putch) (int, void **), void **putdat, struct chan *c);
1054
1055 /* kern/src/ns/util.c */
1056 bool caller_is_username(char *uid);
1057 bool caller_has_perms(char *fileuid, uint32_t perm, int omode);
1058 bool caller_has_dir_perms(struct dir *dir, int omode);
1059 void dir_perm_check(struct dir *dir, int omode);
1060
1061 static inline int abs(int a)
1062 {
1063         if (a < 0)
1064                 return -a;
1065         return a;
1066 }
1067
1068 extern struct username eve;
1069 extern unsigned int qiomaxatomic;
1070
1071 /* special sections */
1072 #define __devtab  __attribute__((__section__(".devtab")))
1073
1074 #define DEVVARS_ENTRY(name, fmt)                                               \
1075 struct dirtab __attribute__((__section__("devvars"))) __devvars_##name =       \
1076               {#name "!" fmt,                                                  \
1077                {(uint64_t)&(name), 0, QTFILE},                                 \
1078                sizeof((name)),                                                 \
1079                0444}