ref: b502a62da2ec6058923db94f87ecc2d29db2fa77
dir: /os/port/portdat.h/
typedef struct Alarms Alarms;
typedef struct Block Block;
typedef struct Bkpt Bkpt;
typedef struct BkptCond BkptCond;
typedef struct Chan Chan;
typedef struct Cmdbuf Cmdbuf;
typedef struct Cmdtab Cmdtab;
typedef struct Cname Cname;
typedef struct Crypt Crypt;
typedef struct Dev Dev;
typedef struct DevConf DevConf;
typedef struct Dirtab Dirtab;
typedef struct Edf Edf;
typedef struct Egrp Egrp;
typedef struct Evalue Evalue;
typedef struct Fgrp Fgrp;
typedef struct List List;
typedef struct Log Log;
typedef struct Logflag Logflag;
typedef struct Mntcache Mntcache;
typedef struct Mntparam Mntparam;
typedef struct Mount Mount;
typedef struct Mntrpc Mntrpc;
typedef struct Mntwalk Mntwalk;
typedef struct Mnt Mnt;
typedef struct Mhead Mhead;
typedef struct Osenv Osenv;
typedef struct Perf Perf;
typedef struct Pgrp Pgrp;
typedef struct Proc Proc;
typedef struct QLock QLock;
typedef struct Queue Queue;
typedef struct Ref Ref;
typedef struct Rendez Rendez;
typedef struct Rept Rept;
typedef struct Rootdata Rootdata;
typedef struct RWlock RWlock;
typedef struct Signerkey Signerkey;
typedef struct Skeyset Skeyset;
typedef struct Talarm Talarm;
typedef struct Timer Timer;
typedef struct Timers Timers;
typedef struct PhysUart PhysUart;
typedef struct Uart Uart;
typedef struct Walkqid Walkqid;
typedef struct Watchpt Watchpt;
typedef struct Watchdog Watchdog;
typedef int Devgen(Chan*, char*, Dirtab*, int, int, Dir*);
#pragma incomplete DevConf
#pragma incomplete Edf
#pragma incomplete Mntcache
#pragma incomplete Mntrpc
#pragma incomplete Queue
#pragma incomplete Timers
#include "fcall.h"
#include <pool.h>
struct Ref
{
Lock l;
s32 ref;
};
struct Rendez
{
Lock;
Proc *p;
};
struct Rept
{
Lock l;
Rendez r;
void *o;
s32 t;
s32 (*active)(void*);
s32 (*ck)(void*, int);
void (*f)(void*); /* called with VM acquire()'d */
};
struct Osenv
{
char *syserrstr; /* last error from a system call, errbuf0 or 1 */
char *errstr; /* reason we're unwinding the error stack, errbuf1 or 0 */
char errbuf0[ERRMAX];
char errbuf1[ERRMAX];
Pgrp* pgrp; /* Ref to namespace, working dir and root */
Fgrp* fgrp; /* Ref to file descriptors */
Egrp* egrp; /* Environment vars */
Skeyset* sigs; /* Signed module keys */
Rendez* rend; /* Synchro point */
Queue* waitq; /* Info about dead children */
Queue* childq; /* Info about children for debuggers */
void* debug; /* Debugging master */
s32 uid; /* Numeric user id for system */
s32 gid; /* Numeric group id for system */
char* user; /* Inferno user name */
int fpuostate;
};
enum
{
Nopin = -1
};
struct QLock
{
Lock use; /* to access Qlock structure */
Proc *head; /* next process waiting for object */
Proc *tail; /* last process waiting for object */
s32 locked; /* flag */
};
struct RWlock
{
Lock; /* Lock modify lock */
QLock x; /* Mutual exclusion lock */
QLock k; /* Lock for waiting writers */
s32 readers; /* Count of readers in lock */
};
struct Talarm
{
Lock;
Proc* list;
};
struct Alarms
{
QLock;
Proc* head;
};
struct Rootdata
{
s32 dotdot;
void *ptr;
s32 size;
s32 *sizep;
};
/*
* Access types in namec & channel flags
*/
enum
{
Aaccess, /* as in stat, wstat */
Abind, /* for left-hand-side of bind */
Atodir, /* as in chdir */
Aopen, /* for i/o */
Amount, /* to be mounted or mounted upon */
Acreate, /* is to be created */
Aremove, /* will be removed by caller */
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 */
};
enum
{
BINTR = (1<<0),
BFREE = (1<<1),
Bipck = (1<<2), /* ip checksum */
Budpck = (1<<3), /* udp checksum */
Btcpck = (1<<4), /* tcp checksum */
Bpktck = (1<<5), /* packet checksum */
};
struct Block
{
Block* next;
Block* list;
uchar* rp; /* first unconsumed byte */
uchar* wp; /* first empty byte */
uchar* lim; /* 1 past the end of the buffer */
uchar* base; /* start of the buffer */
void (*free)(Block*);
u16 flag;
u16 checksum; /* IP checksum of complete packet (minus media header) */
};
#define BLEN(s) ((s)->wp - (s)->rp)
#define BALLOC(s) ((s)->lim - (s)->base)
struct Chan
{
Lock;
Ref;
Chan* next; /* allocation */
Chan* link;
s64 offset; /* in file */
u16 type;
u32 dev;
u16 mode; /* read/write */
u16 flag;
Qid qid;
s32 fid; /* for devmnt */
u32 iounit; /* chunk size for i/o; 0==default */
Mhead* umh; /* mount point that derived Chan; used in unionread */
Chan* umc; /* channel in union; held for union read */
QLock umqlock; /* serialize unionreads */
s32 uri; /* union read index */
s32 dri; /* devdirread index */
u32 mountid;
Mntcache *mcp; /* Mount cache pointer */
Mnt *mux; /* Mnt for clients using me for messages */
union {
void* aux;
char tag[4]; /* for iproute */
};
Chan* mchan; /* channel to mounted server */
Qid mqid; /* qid of root of mount point */
Cname *name;
};
struct Cname
{
Ref;
s32 alen; /* allocated length */
s32 len; /* strlen(s) */
char *s;
};
struct Dev
{
s32 dc;
char* name;
void (*reset)(void);
void (*init)(void);
void (*shutdown)(void);
Chan* (*attach)(char*);
Walkqid* (*walk)(Chan*, Chan*, char**, s32);
s32 (*stat)(Chan*, uchar*, s32);
Chan* (*open)(Chan*, u32);
void (*create)(Chan*, char*, u32, u32);
void (*close)(Chan*);
s32 (*read)(Chan*, void*, s32, s64);
Block* (*bread)(Chan*, s32, u32);
s32 (*write)(Chan*, void*, s32, s64);
s32 (*bwrite)(Chan*, Block*, u32);
void (*remove)(Chan*);
s32 (*wstat)(Chan*, uchar*, s32);
void (*power)(s32); /* power mgt: power(1) → on, power (0) → off */
s32 (*config)(s32, char*, DevConf*);
};
struct Dirtab
{
char name[KNAMELEN];
Qid qid;
s64 length;
s32 perm;
};
struct Walkqid
{
Chan *clone;
s32 nqid;
Qid qid[1];
};
enum
{
NSMAX = 1000,
NSLOG = 7,
NSCACHE = (1<<NSLOG),
};
struct Mntwalk /* state for /proc/#/ns */
{
s32 cddone;
u32 id;
Mhead* mh;
Mount* cm;
};
struct Mount
{
u32 mountid;
Mount* next;
Mhead* head;
Mount* copy;
Mount* order;
Chan* to; /* channel replacing channel */
s32 mflag;
char *spec;
};
struct Mhead
{
Ref;
RWlock lock;
Chan* from; /* channel mounted upon */
Mount* mount; /* what's mounted upon it */
Mhead* hash; /* Hash chain */
};
struct Mnt
{
Lock;
/* references are counted using c->ref; channels on this mount point incref(c->mchan) == Mnt.c */
Chan *c; /* Channel to file service */
Proc *rip; /* Reader in progress */
Mntrpc *queue; /* Queue of pending requests on this channel */
u32 id; /* Multiplexer id for channel check */
Mnt *list; /* Free list */
s32 flags; /* cache */
s32 msize; /* data + IOHDRSZ */
char *version; /* 9P version */
Queue *q; /* input queue */
};
enum
{
RENDLOG = 5,
RENDHASH = 1<<RENDLOG, /* Hash to lookup rendezvous tags */
MNTLOG = 5,
MNTHASH = 1<<MNTLOG, /* Hash to walk mount table */
DELTAFD= 20, /* allocation quantum for process file descriptors */
MAXNFD = 4000, /* max per process file descriptors */
MAXKEY = 8, /* keys for signed modules */
};
#define MOUNTH(p,qid) ((p)->mnthash[(qid).path&((1<<MNTLOG)-1)])
struct Mntparam {
Chan* chan;
Chan* authchan;
char* spec;
s32 flags;
};
struct Pgrp
{
Ref; /* also used as a lock when mounting */
u32 pgrpid;
QLock debug; /* single access via devproc.c */
RWlock ns; /* Namespace n read/one write lock */
QLock nsh;
Mhead* mnthash[MNTHASH];
s32 progmode;
Chan* dot;
Chan* slash;
s32 nodevs;
s32 pin;
};
struct Fgrp
{
Ref;
Lock;
Chan **fd;
uchar *flag; /* per file-descriptor flags (CCEXEC) */
s32 nfd; /* number allocated */
s32 maxfd; /* highest fd in use */
s32 minfd; /* lower bound on free fd */
s32 exceed; /* debugging */
};
struct Evalue
{
union {
char *name;
char *var;
};
union {
char *value;
char *val;
};
s32 len;
Qid qid;
Evalue *next;
};
struct Egrp
{
Ref;
QLock;
union{
Evalue *entries;
Evalue *ent;
};
int nent;
int ment;
ulong path; /* qid.path of next Evalue to be allocated */
ulong vers; /* of Egrp */
};
struct Signerkey
{
Ref;
char* owner;
u16 footprint;
u32 expires;
void* alg;
void* pk;
void (*pkfree)(void*);
};
struct Skeyset
{
Ref;
QLock;
u32 flags;
char* devs;
s32 nkey;
Signerkey *keys[MAXKEY];
};
/*
* fasttick timer interrupts
*/
enum {
/* Mode */
Trelative, /* timer programmed in ns from now */
Tabsolute, /* timer programmed in ns since epoch */
Tperiodic, /* periodic timer, period in ns */
};
struct Timer
{
/* Public interface */
s32 tmode; /* See above */
s64 tns; /* meaning defined by mode */
void (*tf)(Ureg*, Timer*);
void *ta;
/* Internal */
Lock;
Timers *tt; /* Timers queue this timer runs on */
s64 twhen; /* ns represented in fastticks */
Timer *tnext;
};
enum
{
Dead = 0, /* Process states */
Moribund,
Ready,
Scheding,
Running,
Queueing,
Wakeme,
Broken,
Stopped,
Rendezvous,
Waitrelease,
Proc_stopme = 1, /* devproc requests */
Proc_exitme,
Proc_traceme,
Proc_exitbig,
NERR = 30,
Unknown = 0,
IdleGC,
Interp,
BusyGC,
PriLock = 0, /* Holding Spin lock */
PriEdf, /* active edf processes */
PriRelease, /* released edf processes */
PriRealtime, /* Video telephony */
PriHicodec, /* MPEG codec */
PriLocodec, /* Audio codec */
PriHi, /* Important task */
PriNormal,
PriLo,
PriBackground,
PriExtra, /* edf processes we don't care about */
Nrq
};
struct Proc
{
Label sched; /* known to l.s */
char* kstack; /* known to l.s */
Mach* mach; /* machine running this proc */
char text[KNAMELEN];
Proc* rnext; /* next process in run queue */
Proc* qnext; /* next process on queue for a QLock */
QLock* qlock; /* addrof qlock being queued for DEBUG */
s32 state;
s32 type;
void* prog; /* Dummy Prog for interp release */
void* iprog;
Osenv* env;
Osenv defenv;
s32 swipend; /* software interrupt pending for Prog */
Lock sysio; /* note handler lock */
char* psstate; /* What /proc/#/status reports */
u32 pid;
s32 procctl; /* Control for /proc debugging */
uintptr pc; /* DEBUG only */
Lock rlock; /* sync between sleep/swiproc for r */
Rendez* r; /* rendezvous point slept on */
Rendez sleep; /* place for syssleep/debug */
s32 killed; /* by swiproc */
s32 kp; /* true if a kernel process */
u32 alarm; /* Time of call */
s32 pri; /* scheduler priority */
u32 twhen;
Rendez* trend;
Proc* tlink;
s32 (*tfn)(void*);
void (*kpfun)(void*);
void* arg;
PFPU; /* machine specific fpu state */
s32 scallnr;
s32 nerrlab;
Label errlab[NERR];
char genbuf[128]; /* buffer used e.g. for last name element from namec */
Mach* mp; /* machine this process last ran on */
Mach* wired;
u32 movetime; /* next time process should switch processors */
u32 delaysched;
s32 preempted; /* process yielding in interrupt */
uintptr qpc; /* last call that blocked in qlock */
void* dbgreg; /* User registers for devproc */
s32 dbgstop; /* don't run this kproc */
Edf* edf; /* if non-null, real-time proc, edf contains scheduling params */
PMMU; /* TODO obsolete? machine specific mmu state */
};
enum
{
/* kproc flags */
KPDUPPG = (1<<0),
KPDUPFDG = (1<<1),
KPDUPENVG = (1<<2),
KPDUP = KPDUPPG | KPDUPFDG | KPDUPENVG
};
enum {
BrkSched,
BrkNoSched,
};
struct BkptCond
{
uchar op;
u32 val;
BkptCond *next;
};
struct Bkpt
{
s32 id;
u32 addr;
BkptCond *conditions;
Instr instr;
void (*handler)(Bkpt*);
void *aux;
Bkpt *next;
Bkpt *link;
};
enum
{
PRINTSIZE = 1024 /*256*/,
NUMSIZE = 12, /* size of formatted number */
MB = (1024*1024),
READSTR = 1000, /* temporary buffer size for device reads */
};
extern Conf conf;
extern char* conffile;
extern int consoleprint;
extern Dev* devtab[];
extern char* eve;
extern int hwcurs;
extern Queue* kprintoq;
extern Queue *kbdq;
extern Queue *kscanq;
extern Ref noteidalloc;
extern uint qiomaxatomic;
extern Queue* serialoq;
extern char* statename[];
extern char* sysname;
extern Talarm talarm;
/*
* action log
*/
struct Log {
Lock;
s32 opens;
char* buf;
char *end;
char *rptr;
s32 len;
s32 nlog;
s32 minread;
s32 logmask; /* mask of things to debug */
QLock readq;
Rendez readr;
};
struct Logflag {
char* name;
s32 mask;
};
struct Cmdbuf
{
char *buf;
char **f;
s32 nf;
};
struct Cmdtab
{
s32 index; /* used by client to switch on result */
char *cmd; /* command name */
s32 narg; /* expected #args; 0 ==> variadic */
};
/*
* routines to access UART hardware
*/
struct PhysUart
{
char* name;
Uart* (*pnp)(void);
void (*enable)(Uart*, int);
void (*disable)(Uart*);
void (*kick)(Uart*);
void (*dobreak)(Uart*, int);
int (*baud)(Uart*, int);
int (*bits)(Uart*, int);
int (*stop)(Uart*, int);
int (*parity)(Uart*, int);
void (*modemctl)(Uart*, int);
void (*rts)(Uart*, int);
void (*dtr)(Uart*, int);
long (*status)(Uart*, void*, long, long);
void (*fifo)(Uart*, int);
void (*power)(Uart*, int);
int (*getc)(Uart*); /* polling versions, for iprint, rdb */
void (*putc)(Uart*, int);
};
enum {
Stagesize= 2048
};
/*
* software UART
*/
struct Uart
{
void* regs; /* hardware stuff */
void* saveregs; /* place to put registers on power down */
char* name; /* internal name */
ulong freq; /* clock frequency */
int bits; /* bits per character */
int stop; /* stop bits */
int parity; /* even, odd or no parity */
int baud; /* baud rate */
PhysUart*phys;
int console; /* used as a serial console */
int special; /* internal kernel device */
Uart* next; /* list of allocated uarts */
QLock;
int type; /* ?? */
int dev;
int opens;
int enabled;
Uart *elist; /* next enabled interface */
int perr; /* parity errors */
int ferr; /* framing errors */
int oerr; /* rcvr overruns */
int berr; /* no input buffers */
int serr; /* input queue overflow */
/* buffers */
int (*putc)(Queue*, int);
Queue *iq;
Queue *oq;
Lock rlock;
uchar istage[Stagesize];
uchar *iw;
uchar *ir;
uchar *ie;
Lock tlock; /* transmit */
uchar ostage[Stagesize];
uchar *op;
uchar *oe;
int drain;
int modem; /* hardware flow control on */
int xonoff; /* software flow control on */
int blocked;
int cts, dsr, dcd, dcdts; /* keep track of modem status */
int ctsbackoff;
int hup_dsr, hup_dcd; /* send hangup upstream? */
int dohup;
Rendez r;
};
extern Uart* consuart;
enum
{
MAXPOOL = 8,
};
extern Pool* mainmem;
extern Pool* heapmem;
extern Pool* imagmem;
/*
* performance timers, all units in perfticks
*/
struct Perf
{
u32 intrts; /* time of last interrupt */
u32 inintr; /* time since last clock tick in interrupt handlers */
u32 avg_inintr; /* avg time per clock tick in interrupt handlers */
u32 inidle; /* time since last clock tick in idle loop */
u32 avg_inidle; /* avg time per clock tick in idle loop */
u32 last; /* value of perfticks() at last clock tick */
u32 period; /* perfticks() per clock tick */
};
struct Watchdog
{
void (*enable)(void); /* watchdog enable */
void (*disable)(void); /* watchdog disable */
void (*restart)(void); /* watchdog restart */
void (*stat)(char*, char*); /* watchdog statistics */
};
struct Watchpt
{
enum {
WATCHRD = 1,
WATCHWR = 2,
WATCHEX = 4,
} type;
uintptr addr, len;
};
/* queue state bits, Qmsg, Qcoalesce, and Qkick can be set in qopen */
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 */
};
#define DEVDOTDOT -1
#pragma varargck argpos print 1
#pragma varargck argpos snprint 3
#pragma varargck argpos seprint 3
#pragma varargck argpos sprint 2
#pragma varargck argpos fprint 2
#pragma varargck argpos iprint 1
#pragma varargck argpos panic 1
#pragma varargck argpos kwerrstr 1
#pragma varargck argpos kprint 1
#pragma varargck type "lld" vlong
#pragma varargck type "llx" vlong
#pragma varargck type "lld" uvlong
#pragma varargck type "llx" uvlong
#pragma varargck type "lx" void*
#pragma varargck type "ld" long
#pragma varargck type "lx" long
#pragma varargck type "ld" ulong
#pragma varargck type "lx" ulong
#pragma varargck type "zd" intptr
#pragma varargck type "zo" intptr
#pragma varargck type "zx" intptr
#pragma varargck type "zd" uintptr
#pragma varargck type "zo" uintptr
#pragma varargck type "zx" uintptr
#pragma varargck type "d" int
#pragma varargck type "x" int
#pragma varargck type "c" int
#pragma varargck type "C" int
#pragma varargck type "d" uint
#pragma varargck type "x" uint
#pragma varargck type "c" uint
#pragma varargck type "C" uint
#pragma varargck type "f" double
#pragma varargck type "e" double
#pragma varargck type "g" double
#pragma varargck type "s" char*
#pragma varargck type "S" Rune*
#pragma varargck type "r" void
#pragma varargck type "%" void
#pragma varargck type "I" uchar*
#pragma varargck type "V" uchar*
#pragma varargck type "E" uchar*
#pragma varargck type "M" uchar*
#pragma varargck type "p" uintptr
#pragma varargck type "p" void*
#pragma varargck type "q" char*
/*
* Log console output so it can be retrieved via /dev/kmesg.
* This is good for catching boot-time messages after the fact.
*/
struct {
Lock lk;
uint n;
char buf[16384];
} kmesg;