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