qio: Remove qconsume()
[akaros.git] / kern / include / ns.h
index 17b7a49..3973cb7 100644 (file)
@@ -1,12 +1,41 @@
-// INFERNO
-
-#ifndef ROS_KERN_NS_H
-#define ROS_KERN_NS_H
+/* Copyright © 1994-1999 Lucent Technologies Inc.  All rights reserved.
+ * Portions Copyright © 1997-1999 Vita Nuova Limited
+ * Portions Copyright © 2000-2007 Vita Nuova Holdings Limited
+ *                                (www.vitanuova.com)
+ * Revisions Copyright © 2000-2007 Lucent Technologies Inc. and others
+ *
+ * Modified for the Akaros operating system:
+ * Copyright (c) 2013-2014 The Regents of the University of California
+ * Copyright (c) 2013-2015 Google Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE. */
+
+
+#pragma once
 
 #include <err.h>
 #include <rendez.h>
 #include <rwlock.h>
 #include <linker_func.h>
+#include <fdtap.h>
+#include <ros/fs.h>
+#include <vfs.h>
 
 /*
  * functions (possibly) linked in, complete, from libc.
@@ -18,8 +47,8 @@ enum {
        Runeerror = 0xFFFD,     /* decoding error in UTF */
        Runemax = 0x10FFFF,     /* 21-bit rune */
        Runemask = 0x1FFFFF,    /* bits used by runes (see grep) */
-       NUMSIZE32 = 9,  /* max size of formatted 32 bit number */
-       NUMSIZE64 = 20, /* max size of formatted 64 bit number */
+       NUMSIZE32 = 10, /* max size of formatted 32 bit number (hex or decimal) */
+       NUMSIZE64 = 20, /* max size of formatted 64 bit number (hex or decimal) */
 };
 
 /*
@@ -41,9 +70,6 @@ static inline uint32_t getcallerpc(void *v)
        return 0;
 }
 
-extern char etext[];
-extern char edata[];
-extern char end[];
 extern int getfields(char *unused_char_p_t, char **unused_char_pp_t,
                                         int unused_int, int, char *);
 extern int tokenize(char *unused_char_p_t, char **unused_char_pp_t, int);
@@ -303,14 +329,23 @@ enum {
        Aremove,                                        /* will be removed by caller */
        Acreatechan,                                    /* return a chan for a create request. for sysrename. */
 
-       COPEN = 0x0001,                         /* for i/o */
-       CMSG = 0x0002,  /* the message channel for a mount */
-       CCEXEC = 0x0008,        /* close on exec */
-       CFREE = 0x0010, /* not in use */
-       CRCLOSE = 0x0020,       /* remove on close */
-       CCACHE = 0x0080,        /* client cache */
-       /* file/chan status flags, affected by setfl and reported in getfl */
-       CAPPEND = 0x0100,       /* append on write */
+       /* internal chan flags, used by the kernel only */
+       COPEN =                 0x0001, /* for i/o */
+       CMSG =                  0x0002, /* the message channel for a mount */
+       CFREE =                 0x0004, /* not in use */
+       CCACHE =                0x0008, /* client cache */
+       CINTERNAL_FLAGS = (COPEN | CMSG | CFREE | CCACHE),
+
+       /* chan/file flags, getable via fcntl/getfl and setably via open and
+        * sometimes fcntl/setfl.  those that can't be set cause an error() in
+        * fd_setfl. */
+       CEXTERNAL_FLAGS = (
+           O_CLOEXEC      | /* (prob should be on the FD, 9ns has it here) */
+           O_REMCLO       | /* remove on close (also, maybe should be on FD) */
+           O_APPEND       | /* append on write */
+           O_NONBLOCK     | /* don't block, can't be set via setfl */
+           O_PATH         | /* path open, just the name, no I/O */
+           0),
 };
 
 #define NS_IPCK_SHIFT  2
@@ -321,7 +356,6 @@ enum {
 #define NS_SHIFT_MAX 6
 
 enum {
-       BINTR = (1 << 0),
        BFREE = (1 << 1),
        Bipck = (1 << NS_IPCK_SHIFT),   /* ip checksum */
        Budpck = (1 << NS_UDPCK_SHIFT), /* udp checksum */
@@ -406,7 +440,6 @@ struct cname {
 };
 
 struct dev {
-       int dc;
        char *name;
 
        void (*reset) (void);
@@ -427,6 +460,8 @@ struct dev {
        void (*power) (int);            /* power mgt: power(1) → on, power (0) → off */
 //  int (*config)( int unused_int, char *unused_char_p_t, DevConf*);
        char *(*chaninfo) (struct chan *, char *, size_t);
+       int (*tapfd) (struct chan *, struct fd_tap *, int);
+       int (*chan_ctl)(struct chan *, int);
        /* we need to be aligned, we think to 64 bytes, for the linker tables. */
 } __attribute__ ((aligned(64)));
 
@@ -521,16 +556,6 @@ struct pgrp {
        int pin;
 };
 
-struct fgrp {
-       spinlock_t lock;
-       struct kref ref;
-       struct chan **fd;
-       int nfd;                                        /* number of fd slots */
-       int maxfd;                                      /* highest fd in use */
-       int minfd;                                      /* lower bound on free fd */
-       int closed;
-};
-
 struct evalue {
        char *var;
        char *val;
@@ -598,15 +623,16 @@ struct cmdtab {
        int narg;                                       /* expected #args; 0 ==> variadic */
 };
 
-/* queue state bits,  Qmsg, Qcoalesce, and Qkick can be set in qopen */
+/* queue state bits, all can be set in qopen (Qstarve is always set) */
 enum {
-       /* Queue.state */
        Qstarve = (1 << 0),                     /* consumer starved */
        Qmsg = (1 << 1),        /* message stream */
        Qclosed = (1 << 2),     /* queue has been closed/hungup */
        Qflow = (1 << 3),       /* producer flow controlled */
        Qcoalesce = (1 << 4),   /* coallesce packets on read */
        Qkick = (1 << 5),       /* always call the kick routine after qwrite */
+       Qdropoverflow = (1 << 6),       /* writes that would block will be dropped */
+       Qnonblock = (1 << 7),   /* do not block, throw EAGAIN */
 };
 
 #define DEVDOTDOT -1
@@ -615,7 +641,6 @@ typedef int Devgen(struct chan *, char *unused_char_p_t, struct dirtab *,
                                   int unused_int, int, struct dir *);
 
 /* inferno portfns.h. Not all these are needed. */
-// INFERNO
 #define                FPinit() fpinit()       /* remove this if math lib is linked */
 void FPrestore(void *);
 void FPsave(void *);
@@ -623,8 +648,9 @@ struct cname *addelem(struct cname *, char *unused_char_p_t);
 void addprog(struct proc *);
 void addrootfile(char *unused_char_p_t, uint8_t * unused_uint8_p_t, uint32_t);
 struct block *adjustblock(struct block *, int);
-struct block *allocb(int);
-void block_add_extd(struct block *b, unsigned int nr_bufs, int mem_flags);
+struct block *block_alloc(size_t, int);
+int block_add_extd(struct block *b, unsigned int nr_bufs, int mem_flags);
+int block_append_extra(struct block *b, int len, int mem_flags);
 int anyhigher(void);
 int anyready(void);
 void _assert(char *unused_char_p_t);
@@ -636,7 +662,6 @@ void chan_incref(struct chan *);
 void chandevinit(void);
 void chandevreset(void);
 void chandevshutdown(void);
-struct dir *chandirstat(struct chan *);
 void chanfree(struct chan *);
 void chanrec(struct mnt *);
 void checkalarms(void);
@@ -645,11 +670,10 @@ void cinit(void);
 struct chan *cclone(struct chan *);
 void cclose(struct chan *);
 void closeegrp(struct egrp *);
-void closefgrp(struct fgrp *);
 void closemount(struct mount *);
 void closepgrp(struct pgrp *);
 void closesigs(struct skeyset *);
-void cmderror(struct cmdbuf *, char *unused_char_p_t);
+void debugcmd(struct cmdbuf *cb);
 struct mhead *newmhead(struct chan *from);
 int cmount(struct chan *, struct chan *, int unused_int, char *unused_char_p_t);
 void cnameclose(struct cname *);
@@ -669,7 +693,7 @@ void cursordisable(void);
 int cursoron(int);
 void cursoroff(int);
 void cwrite(struct chan *, uint8_t * unused_uint8_p_t, int unused_int, int64_t);
-struct chan *devattach(int unused_int, char *unused_char_p_t);
+struct chan *devattach(const char *name, char *spec);
 struct block *devbread(struct chan *, long, uint32_t);
 long devbwrite(struct chan *, struct block *, uint32_t);
 struct chan *devclone(struct chan *);
@@ -679,7 +703,7 @@ void devdir(struct chan *, struct qid, char *, int64_t, char *, long,
 long devdirread(struct chan *, char *, long, struct dirtab *, int, Devgen *);
 Devgen devgen;
 void devinit(void);
-int devno(int unused_int, int);
+int devno(const char *name, int user);
 void devpower(int);
 struct dev *devbyname(char *unused_char_p_t);
 struct chan *devopen(struct chan *, int unused_int,
@@ -701,7 +725,6 @@ int domount(struct chan **, struct mhead **);
 void drawactive(int);
 void drawcmap(void);
 void dumpstack(void);
-struct fgrp *dupfgrp(struct proc *, struct fgrp *);
 void egrpcpy(struct egrp *, struct egrp *);
 int emptystr(char *unused_char_p_t);
 int eqchan(struct chan *, struct chan *, int);
@@ -715,20 +738,15 @@ void halt(void);
 int export(int unused_int, char *unused_char_p_t, int);
 uint64_t fastticks(uint64_t *);
 uint64_t fastticks2ns(uint64_t);
-void fdclose(struct fgrp *, int);
-struct chan *fdtochan(struct fgrp *, int unused_int, int, int, int);
 int findmount(struct chan **, struct mhead **, int unused_int, int, struct qid);
 void free(void *);
+void free_block_extra(struct block *);
 void freeb(struct block *);
 void freeblist(struct block *);
 void freeskey(struct signerkey *);
 void getcolor(uint32_t, uint32_t *, uint32_t *, uint32_t *);
 uint32_t getmalloctag(void *);
 uint32_t getrealloctag(void *);
-void hnputl(void *, uint32_t);
-void hnputs(void *, uint16_t);
-struct block *iallocb(int);
-void iallocsummary(void);
 void printblock(struct block *b);
 void ilock(spinlock_t *);
 int iprint(char *unused_char_p_t, ...);
@@ -741,14 +759,11 @@ int kbdcr2nl(struct queue *, int);
 int kbdputc(struct queue *, int);
 void kbdrepeat(int);
 void kproc(char *unused_char_p_t, void (*)(void *), void *, int);
-int fgrpclose(struct fgrp *, int);
 void kprocchild(struct proc *, void (*)(void *), void *);
 void (*kproftick) (uint32_t);
 void ksetenv(char *unused_char_p_t, char *, int);
-//void      kstrncpy( char *unused_char_p_t, char*, int unused_int, sizeof(char*, char*));
 void kstrdup(char **unused_char_pp_t, char *unused_char_p_t);
 
-struct cmdtab *lookupcmd(struct cmdbuf *, struct cmdtab *, int);
 struct block *mem2bl(uint8_t * unused_uint8_p_t, int);
 int memusehigh(void);
 void microdelay(int);
@@ -763,9 +778,10 @@ uint64_t ms2fastticks(uint32_t);
 void mul64fract(uint64_t *, uint64_t, uint64_t);
 void muxclose(struct mnt *);
 struct chan *namec(char *unused_char_p_t, int unused_int, int, uint32_t);
+struct chan *namec_from(struct chan *c, char *name, int amode, int omode,
+                        uint32_t perm);
 struct chan *newchan(void);
 struct egrp *newegrp(void);
-struct fgrp *newfgrp(void);
 struct mount *newmount(struct mhead *, struct chan *, int unused_int,
                                           char *unused_char_p_t);
 struct pgrp *newpgrp(void);
@@ -774,15 +790,15 @@ char *nextelem(char *unused_char_p_t, char *);
 
 struct cname *newcname(char *unused_char_p_t);
 void notkilled(void);
-int nrand(int);
+uint32_t random_read(void *xp, uint32_t n);
+uint32_t urandom_read(void *xp, uint32_t n);
 uint64_t ns2fastticks(uint64_t);
 int okaddr(uint32_t, uint32_t, int);
-int openmode(uint32_t);
+int omode_to_rwx(int);
+int omode_to_9p_accmode(int open_flags);
 struct block *packblock(struct block *);
 struct block *padblock(struct block *, int);
 
-struct cmdbuf *parsecmd(char *unused_char_p_t, int);
-
 void pgrpcpy(struct pgrp *, struct pgrp *);
 
 int progfdprint(struct chan *, int unused_int, int, char *unused_char_p_t,
@@ -794,12 +810,11 @@ void putmhead(struct mhead *);
 void putstrn(char *unused_char_p_t, int);
 void qaddlist(struct queue *, struct block *);
 struct block *qbread(struct queue *, int);
-long qbwrite(struct queue *, struct block *);
-long qibwrite(struct queue *q, struct block *b);
+ssize_t qbwrite(struct queue *, struct block *);
+ssize_t qibwrite(struct queue *q, struct block *b);
 struct queue *qbypass(void (*)(void *, struct block *), void *);
 int qcanread(struct queue *);
 void qclose(struct queue *);
-int qconsume(struct queue *, void *, int);
 struct block *qcopy(struct queue *, int unused_int, uint32_t);
 struct block *qclone(struct queue *q, int header_len, int len,
                      uint32_t offset);
@@ -812,22 +827,22 @@ int qfull(struct queue *);
 struct block *qget(struct queue *);
 void qhangup(struct queue *, char *unused_char_p_t);
 int qisclosed(struct queue *);
-int qiwrite(struct queue *, void *, int);
+ssize_t qiwrite(struct queue *, void *, int);
 int qlen(struct queue *);
-void qnoblock(struct queue *, int);
+void qdropoverflow(struct queue *, bool);
+void qnonblock(struct queue *, bool);
 struct queue *qopen(int unused_int, int, void (*)(void *), void *);
-int qpass(struct queue *, struct block *);
-int qpassnolim(struct queue *, struct block *);
-int qproduce(struct queue *, void *, int);
+ssize_t qpass(struct queue *, struct block *);
+ssize_t qpassnolim(struct queue *, struct block *);
 void qputback(struct queue *, struct block *);
 long qread(struct queue *, void *, int);
-struct block *qremove(struct queue *);
 void qreopen(struct queue *);
 void qsetlimit(struct queue *, int);
 int qwindow(struct queue *);
-int qwrite(struct queue *, void *, int);
-void randominit(void);
-uint32_t randomread(void *, uint32_t);
+ssize_t qwrite(struct queue *, void *, int);
+typedef void (*qio_wake_cb_t)(struct queue *q, void *data, int filter);
+void qio_set_wake_cb(struct queue *q, qio_wake_cb_t func, void *data);
+
 void *realloc(void *, uint32_t);
 int readmem(unsigned long offset, char *buf, unsigned long n,
                        void *mem, size_t mem_len);
@@ -840,7 +855,6 @@ void renameproguser(char *unused_char_p_t, char *);
 void renameuser(char *unused_char_p_t, char *);
 void resrcwait(char *unused_char_p_t);
 struct proc *runproc(void);
-long seconds(void);
 void (*serwrite) (char *unused_char_p_t, int);
 int setcolor(uint32_t, uint32_t, uint32_t, uint32_t);
 
@@ -868,13 +882,12 @@ struct block *trimblock(struct block *, int unused_int, int);
 int uartgetc(void);
 void uartputc(int);
 void uartputs(char *unused_char_p_t, int);
-long unionread(struct chan *, void *, long);
 void unlock(spinlock_t *);
 void userinit(void);
 uint32_t userpc(void);
 void validname(char *, int);
 void validwstatname(char *);
-int walk(struct chan **, char **unused_char_pp_t, int unused_int, int, int *);
+int walk(struct chan **, char **unused_char_pp_t, int unused_int, bool, int *);
 void *xalloc(uint32_t);
 void *xallocz(uint32_t, int);
 void xfree(void *);
@@ -893,72 +906,6 @@ int64_t nhgetv(void *);
 uint32_t nhgetl(void *);
 uint16_t nhgets(void *);
 
-/* error messages, from inferno emu error.h */
-extern char Enoerror[];                        /* no error */
-extern char Emount[];                  /* inconsistent mount */
-extern char Eunmount[];                        /* not mounted */
-extern char Eunion[];                  /* not in union */
-extern char Emountrpc[];               /* mount rpc error */
-extern char Eshutdown[];               /* mounted device shut down */
-extern char Eowner[];                  /* not owner */
-extern char Eunknown[];                        /* unknown user or group id */
-extern char Enocreate[];               /* mounted directory forbids creation */
-extern char Enonexist[];               /* file does not exist */
-extern char Eexist[];                  /* file already exists */
-extern char Ebadsharp[];               /* unknown device in # filename */
-extern char Enotdir[];                 /* not a directory */
-extern char Eisdir[];                  /* file is a directory */
-extern char Ebadchar[];                        /* bad character in file name */
-extern char Efilename[];               /* file name syntax */
-extern char Eperm[];                   /* permission denied */
-extern char Ebadusefd[];               /* inappropriate use of fd */
-extern char Ebadarg[];                 /* bad arg in system call */
-extern char Einuse[];                  /* device or object already in use */
-extern char Eio[];                             /* i/o error */
-extern char Etoobig[];                 /* read or write too large */
-extern char Etoosmall[];               /* read or write too small */
-extern char Enetaddr[];                        /* bad network address */
-extern char Emsgsize[];                        /* message is too big for protocol */
-extern char Enetbusy[];                        /* network device is busy or allocated */
-extern char Enoproto[];                        /* network protocol not supported */
-extern char Enoport[];                 /* network port not available */
-extern char Enoifc[];                  /* bad interface or no free interface slots */
-extern char Enolisten[];               /* not announced */
-extern char Ehungup[];                 /* i/o on hungup channel */
-extern char Ebadctl[];                 /* bad process or channel control request */
-extern char Enodev[];                  /* no free devices */
-extern char Enoenv[];                  /* no free environment resources */
-extern char Ethread[];                 /* thread exited */
-extern char Enochild[];                        /* no living children */
-extern char Eioload[];                 /* i/o error in demand load */
-extern char Enovmem[];                 /* out of memory: virtual memory */
-extern char Ebadld[];                  /* illegal line discipline */
-extern char Ebadfd[];                  /* fd out of range or not open */
-extern char Eisstream[];               /* seek on a stream */
-extern char Ebadexec[];                        /* exec header invalid */
-extern char Etimedout[];               /* connection timed out */
-extern char Econrefused[];             /* connection refused */
-extern char Econinuse[];               /* connection in use */
-extern char Enetunreach[];             /* network unreachable */
-extern char Eintr[];                   /* interrupted */
-extern char Enomem[];                  /* out of memory: kernel */
-extern char Esfnotcached[];            /* subfont not cached */
-extern char Esoverlap[];               /* segments overlap */
-extern char Emouseset[];               /* mouse type already set */
-extern char Eshort[];                  /* i/o count too small */
-extern char Enobitstore[];             /* out of screen memory */
-extern char Egreg[];                   /* jim'll fix it */
-extern char Ebadspec[];                        /* bad attach specifier */
-extern char Estopped[];                        /* thread must be stopped */
-extern char Enoattach[];               /* mount/attach disallowed */
-extern char Eshortstat[];              /* stat buffer too small */
-extern char Enegoff[];                 /* negative i/o offset */
-extern char Ebadstat[];                        /* malformed stat buffer */
-extern char Ecmdargs[];                        /* wrong #args in control message */
-extern char Enofd[];                   /* no free file descriptors */
-extern char Enoctl[];                  /* unknown control request */
-extern char Eprocdied[];               /* process died */
-
 char *get_cur_genbuf(void);
 
 /* hack for now. */
@@ -976,16 +923,17 @@ void cmderror(struct cmdbuf *cb, char *s);
 struct cmdtab *lookupcmd(struct cmdbuf *cb, struct cmdtab *ctab, int nctab);
 
 /* kern/src/ns/sysfile.c */
-int newfd(struct chan *c);
-struct chan *fdtochan(struct fgrp *f, int fd, int mode, int chkmnt, int iref);
+int newfd(struct chan *c, int oflags);
+struct chan *fdtochan(struct fd_table *fdt, int fd, int mode, int chkmnt,
+                      int iref);
 long kchanio(void *vc, void *buf, int n, int mode);
 int openmode(uint32_t o);
-void fdclose(struct fgrp *f, int fd);
+void fdclose(struct fd_table *fdt, int fd);
 int syschdir(char *path);
-int grpclose(struct fgrp *f, int fd);
+int grpclose(struct fd_table *fdt, int fd);
 int sysclose(int fd);
 int syscreate(char *path, int mode, uint32_t perm);
-int sysdup(int old, int new);
+int sysdup(int old);
 int sys_dup_to(struct proc *from_proc, unsigned int from_fd,
                struct proc *to_proc, unsigned int to_fd);
 int sysfstat(int fd, uint8_t*, int n);
@@ -999,7 +947,8 @@ long bindmount(struct chan *c, char *old, int flag, char *spec);
 int sysbind(char *new, char *old, int flags);
 int sysmount(int fd, int afd, char *old, int flags, char *spec);
 int sysunmount(char *old, char *new);
-int sysopen(char *path, int mode);
+int sysopenat(int dirfd, char *path, int vfs_flags);
+int sysopen(char *path, int vfs_flags);
 long unionread(struct chan *c, void *va, long n);
 void read_exactly_n(struct chan *c, void *vp, long n);
 long sysread(int fd, void *va, long n);
@@ -1019,9 +968,7 @@ int sysdirwstat(char *name, struct dir *dir);
 int sysdirfwstat(int fd, struct dir *dir);
 long sysdirread(int fd, struct kdirent **d);
 int sysiounit(int fd);
-void close_9ns_files(struct proc *p, bool only_cloexec);
 void print_chaninfo(struct chan *ch);
-void print_9ns_files(struct proc *p);
 int plan9setup(struct proc *new_proc, struct proc *parent, int flags);
 int iseve(void);
 int fd_getfl(int fd);
@@ -1048,4 +995,9 @@ extern unsigned int qiomaxatomic;
 /* special sections */
 #define __devtab  __attribute__((__section__(".devtab")))
 
-#endif /* ROS_KERN_NS_H */
+#define DEVVARS_ENTRY(name, fmt)                                               \
+struct dirtab __attribute__((__section__("devvars"))) __devvars_##name =       \
+              {#name "!" fmt,                                                  \
+               {(uint64_t)&(name), 0, QTFILE},                                 \
+               sizeof((name)),                                                 \
+               0444}