Support O_NONBLOCK when opening #I chans
[akaros.git] / kern / include / ip.h
1 // INFERNO
2
3 #ifndef ROS_KERN_IP_H
4 #define ROS_KERN_IP_H
5 #include <ns.h>
6
7 enum {
8         Addrlen = 64,
9         Maxproto = 20,
10         Nhash = 64,
11         Maxincall = 500,
12         Nchans = 256,
13         MAClen = 16,    /* longest mac address */
14
15         MAXTTL = 255,
16         DFLTTOS = 0,
17
18         IPaddrlen = 16,
19         IPv4addrlen = 4,
20         IPv4off = 12,
21         IPllen = 4,
22
23         /* ip versions */
24         V4 = 4,
25         V6 = 6,
26         IP_VER4 = 0x40,
27         IP_VER6 = 0x60,
28
29         /* 2^Lroot trees in the root table */
30         Lroot = 10,
31
32         Maxpath = 64,
33 };
34
35 enum {
36         Idle = 0,
37         Announcing = 1,
38         Announced = 2,
39         Connecting = 3,
40         Connected = 4,
41 };
42
43 /*
44  *  one per conversation directory
45  */
46 struct Proto;
47 struct conv {
48         qlock_t qlock;
49
50         int x;                                          /* conversation index */
51         struct Proto *p;
52
53         int restricted;                         /* remote port is restricted */
54         uint32_t ttl;                           /* max time to live */
55         uint32_t tos;                           /* type of service */
56         int ignoreadvice;                       /* don't terminate connection on icmp errors */
57         bool nonblock;                          /* set to nonblocking, O_NONBLOCK style */
58
59         uint8_t ipversion;
60         uint8_t laddr[IPaddrlen];       /* local IP address */
61         uint8_t raddr[IPaddrlen];       /* remote IP address */
62         uint16_t lport;                         /* local port number */
63         uint16_t rport;                         /* remote port number */
64
65         char *owner;                            /* protections */
66         int perm;
67         int inuse;                                      /* opens of listen/data/ctl */
68         int length;
69         int state;
70
71         /* udp specific */
72         int headers;                            /* data src/dst headers in udp */
73         int reliable;                           /* true if reliable udp */
74
75         struct conv *incall;            /* calls waiting to be listened for */
76         struct conv *next;
77
78         struct queue *rq;                       /* queued data waiting to be read */
79         struct queue *wq;                       /* queued data waiting to be written */
80         struct queue *eq;                       /* returned error packets */
81         struct queue *sq;                       /* snooping queue */
82         atomic_t snoopers;                      /* number of processes with snoop open */
83
84         struct rendez cr;
85         char cerr[ERRMAX];
86
87         qlock_t listenq;
88         struct rendez listenr;
89
90         struct Ipmulti *multi;          /* multicast bindings for this interface */
91
92         void *ptcl;                                     /* Protocol specific stuff */
93
94         struct route *r;                        /* last route used */
95         uint32_t rgen;                          /* routetable generation for *r */
96 };
97
98 struct Ipifc;
99 struct Fs;
100
101 struct medium {
102         char *name;
103         int hsize;                                      /* medium header size */
104         int mintu;                                      /* default min mtu */
105         int maxtu;                                      /* default max mtu */
106         int maclen;                                     /* mac address length  */
107         void (*bind) (struct Ipifc * unused_Ipifc, int unused_int,
108                                   char **unused_char_pp_t);
109         void (*unbind) (struct Ipifc * unused_Ipifc);
110         void (*bwrite) (struct Ipifc * ifc,
111                                         struct block * b, int version, uint8_t * ip);
112
113         /* for arming interfaces to receive multicast */
114         void (*addmulti) (struct Ipifc * ifc, uint8_t * a, uint8_t * ia);
115         void (*remmulti) (struct Ipifc * ifc, uint8_t * a, uint8_t * ia);
116
117         /* process packets written to 'data' */
118         void (*pktin) (struct Fs * f, struct Ipifc * ifc, struct block * bp);
119
120         /* routes for router boards */
121         void (*addroute) (struct Ipifc * ifc, int unused_int, uint8_t * u8p,
122                                           uint8_t *, uint8_t * u8p2, int);
123         void (*remroute) (struct Ipifc * ifc, int i, uint8_t * u8p,
124                                           uint8_t * uu8p2);
125         void (*flushroutes) (struct Ipifc * ifc);
126
127         /* for routing multicast groups */
128         void (*joinmulti) (struct Ipifc * ifc, uint8_t * a, uint8_t * ia);
129         void (*leavemulti) (struct Ipifc * ifc, uint8_t * a, uint8_t * ia);
130
131         /* address resolution */
132         void (*ares) (struct Fs *, int unused_int, uint8_t * unused_uint8_p_t, uint8_t *, int, int);    /* resolve */
133         void (*areg) (struct Ipifc * unused_Ipifc, uint8_t * unused_uint8_p_t); /* register */
134
135         /* v6 address generation */
136         void (*pref2addr) (uint8_t * pref, uint8_t * ea);
137
138         int unbindonclose;                      /* if non-zero, unbind on last close */
139 };
140
141 /* logical interface associated with a physical one */
142 struct Iplifc {
143         uint8_t local[IPaddrlen];
144         uint8_t mask[IPaddrlen];
145         uint8_t remote[IPaddrlen];
146         uint8_t net[IPaddrlen];
147         uint8_t tentative;                      /* =1 => v6 dup disc on, =0 => confirmed unique */
148         uint8_t onlink;                         /* =1 => onlink, =0 offlink. */
149         uint8_t autoflag;                       /* v6 autonomous flag */
150         uint64_t validlt;                               /* v6 valid lifetime */
151         uint64_t preflt;                                /* v6 preferred lifetime */
152         uint64_t origint;                               /* time when addr was added */
153         struct Iplink *link;            /* addresses linked to this lifc */
154         struct Iplifc *next;
155 };
156
157 /* binding twixt Ipself and Iplifc */
158 struct Iplink {
159         struct Ipself *self;
160         struct Iplifc *lifc;
161         struct Iplink *selflink;        /* next link for this local address */
162         struct Iplink *lifclink;        /* next link for this ifc */
163         uint64_t expire;
164         struct Iplink *next;            /* free list */
165         struct kref ref;
166 };
167
168 /* rfc 2461, pp.40--43. */
169
170 /* default values, one per stack */
171 struct routerparams {
172         int mflag;
173         int oflag;
174         int maxraint;
175         int minraint;
176         int linkmtu;
177         int reachtime;
178         int rxmitra;
179         int ttl;
180         int routerlt;
181 };
182
183 struct Ipifc {
184         rwlock_t rwlock;
185
186         struct conv *conv;                      /* link to its conversation structure */
187         char dev[64];                           /* device we're attached to */
188         struct medium *m;                       /* Media pointer */
189         int maxtu;                                      /* Maximum transfer unit */
190         int mintu;                                      /* Minumum tranfer unit */
191         unsigned int feat;                              /* Offload features */
192         int mbps;                                       /* megabits per second */
193         void *arg;                                      /* medium specific */
194         int reassemble;                         /* reassemble IP packets before forwarding */
195
196         /* these are used so that we can unbind on the fly */
197         spinlock_t idlock;
198         uint8_t ifcid;                          /* incremented each 'bind/unbind/add/remove' */
199         int ref;                                        /* number of proc's using this Ipifc */
200         struct rendez wait;                     /* where unbinder waits for ref == 0 */
201         int unbinding;
202
203         uint8_t mac[MAClen];            /* MAC address */
204
205         struct Iplifc *lifc;            /* logical interfaces on this physical one */
206
207         uint32_t in, out;                       /* message statistics */
208         uint32_t inerr, outerr;         /* ... */
209
210         uint8_t sendra6;                        /* == 1 => send router advs on this ifc */
211         uint8_t recvra6;                        /* == 1 => recv router advs on this ifc */
212         struct routerparams rp;         /* router parameters as in RFC 2461, pp.40--43. 
213                                                                    used only if node is router */
214 };
215
216 /*
217  *  one per multicast-lifc pair used by a struct conv
218  */
219 struct Ipmulti {
220         uint8_t ma[IPaddrlen];
221         uint8_t ia[IPaddrlen];
222         struct Ipmulti *next;
223 };
224
225 /*
226  *  hash table for 2 ip addresses + 2 ports
227  */
228 enum {
229         Nipht = 521,                            /* convenient prime */
230
231         IPmatchexact = 0,       /* match on 4 tuple */
232         IPmatchany,     /* *!* */
233         IPmatchport,    /* *!port */
234         IPmatchaddr,    /* addr!* */
235         IPmatchpa,      /* addr!port */
236 };
237 struct Iphash {
238         struct Iphash *next;
239         struct conv *c;
240         int match;
241 };
242
243 struct Iphash;
244 struct Ipht {
245         spinlock_t lock;
246         struct Iphash *tab[Nipht];
247 };
248 void iphtadd(struct Ipht *, struct conv *);
249 void iphtrem(struct Ipht *, struct conv *);
250 struct conv *iphtlook(struct Ipht *ht, uint8_t * sa, uint16_t sp, uint8_t * da,
251                                           uint16_t dp);
252
253 /*
254  *  one per multiplexed Protocol
255  */
256 struct Proto {
257         qlock_t qlock;
258         char *name;                                     /* protocol name */
259         int x;                                          /* protocol index */
260         int ipproto;                            /* ip protocol type */
261
262         char *(*connect) (struct conv *, char **unused_char_pp_t, int);
263         char *(*announce) (struct conv *, char **unused_char_pp_t, int);
264         char *(*bind) (struct conv *, char **unused_char_pp_t, int);
265         int (*state) (struct conv *, char *unused_char_p_t, int);
266         void (*create) (struct conv *);
267         void (*close) (struct conv *);
268         void (*rcv) (struct Proto *, struct Ipifc *, struct block *);
269         char *(*ctl) (struct conv *, char **unused_char_pp_t, int);
270         void (*advise) (struct Proto *, struct block *, char *unused_char_p_t);
271         int (*stats) (struct Proto *, char *unused_char_p_t, int);
272         int (*local) (struct conv *, char *unused_char_p_t, int);
273         int (*remote) (struct conv *, char *unused_char_p_t, int);
274         int (*inuse) (struct conv *);
275         int (*gc) (struct Proto *);     /* returns true if any conversations are freed */
276         void (*newconv) (struct Proto * udp, struct conv * conv);
277
278         struct Fs *f;                           /* file system this proto is part of */
279         struct conv **conv;                     /* array of conversations */
280         int ptclsize;                           /* size of per protocol ctl block */
281         int nc;                                         /* number of conversations */
282         int ac;
283         struct qid qid;                         /* qid for protocol directory */
284         uint16_t nextport;
285         uint16_t nextrport;
286
287         void *priv;
288 };
289
290 /*
291  *  Stream for sending packets to user level
292  */
293 struct IProuter {
294         qlock_t qlock;
295         int opens;
296         struct queue *q;
297 };
298
299 /*
300  *  one per IP protocol stack
301  */
302 struct Fs {
303         rwlock_t rwlock;
304         int dev;
305
306         int np;
307         struct Proto *p[Maxproto + 1];  /* list of supported protocols */
308         struct Proto *t2p[256];         /* vector of all protocols */
309         struct Proto *ipifc;            /* kludge for ipifcremroute & ipifcaddroute */
310         struct Proto *ipmux;            /* kludge for finding an ip multiplexor */
311
312         struct IP *ip;
313         struct Ipselftab *self;
314         struct arp *arp;
315         struct V6params *v6p;
316         struct IProuter iprouter;
317
318         struct route *v4root[1 << Lroot];       /* v4 routing forest */
319         struct route *v6root[1 << Lroot];       /* v6 routing forest */
320         struct route *queue;            /* used as temp when reinjecting routes */
321
322         struct Netlog *alog;
323         struct Ifclog *ilog;
324
325         char ndb[1024];                         /* an ndb entry for this interface */
326         int ndbvers;
327         long ndbmtime;
328 };
329
330 /* one per default router known to host */
331 struct V6router {
332         uint8_t inuse;
333         struct Ipifc *ifc;
334         int ifcid;
335         uint8_t routeraddr[IPaddrlen];
336         long ltorigin;
337         struct routerparams rp;
338 };
339
340 struct hostparams {
341         int rxmithost;
342 };
343
344 struct V6params {
345         struct routerparams rp;         /* v6 params, one copy per node now */
346         struct hostparams hp;
347         struct V6router v6rlist[3];     /* max 3 default routers, currently */
348         int cdrouter;                           /* uses only v6rlist[cdrouter] if   */
349         /* cdrouter >= 0. */
350 };
351
352 int Fsconnected(struct conv *, char *unused_char_p_t);
353 struct conv *Fsnewcall(struct conv *, uint8_t * unused_uint8_p_t, uint16_t,
354                                            uint8_t *, uint16_t, uint8_t unused_uint8_t);
355 int Fspcolstats(char *unused_char_p_t, int);
356 int Fsproto(struct Fs *, struct Proto *);
357 int Fsbuiltinproto(struct Fs *, uint8_t unused_uint8_t);
358 struct conv *Fsprotoclone(struct Proto *, char *unused_char_p_t);
359 struct Proto *Fsrcvpcol(struct Fs *, uint8_t unused_uint8_t);
360 struct Proto *Fsrcvpcolx(struct Fs *, uint8_t unused_uint8_t);
361 char *Fsstdconnect(struct conv *, char **unused_char_pp_t, int);
362 char *Fsstdannounce(struct conv *, char **unused_char_pp_t, int);
363 char *Fsstdbind(struct conv *, char **unused_char_pp_t, int);
364 void Fsconvnonblock(struct conv *, bool);
365 uint32_t scalednconv(void);
366
367 /* 
368  *  logging
369  */
370 enum {
371         Logip = 1 << 1,
372         Logtcp = 1 << 2,
373         Logfs = 1 << 3,
374         Logil = 1 << 4,
375         Logicmp = 1 << 5,
376         Logudp = 1 << 6,
377         Logcompress = 1 << 7,
378         Logilmsg = 1 << 8,
379         Loggre = 1 << 9,
380         Logppp = 1 << 10,
381         Logtcprxmt = 1 << 11,
382         Logigmp = 1 << 12,
383         Logudpmsg = 1 << 13,
384         Logipmsg = 1 << 14,
385         Logrudp = 1 << 15,
386         Logrudpmsg = 1 << 16,
387         Logesp = 1 << 17,
388         Logtcpwin = 1 << 18,
389 };
390
391 void netloginit(struct Fs *);
392 void netlogopen(struct Fs *);
393 void netlogclose(struct Fs *);
394 void netlogctl(struct Fs *, char *unused_char_p_t, int);
395 long netlogread(struct Fs *, void *, uint32_t, long);
396 void netlog(struct Fs *, int unused_int, char *unused_char_p_t, ...);
397 void ifcloginit(struct Fs *);
398 long ifclogread(struct Fs *, struct chan *, void *, uint32_t, long);
399 void ifclog(struct Fs *, uint8_t *, int);
400 void ifclogopen(struct Fs *, struct chan *);
401 void ifclogclose(struct Fs *, struct chan *);
402
403 /*
404  *  iproute.c
405  */
406
407 enum {
408
409         /* type bits */
410         Rv4 = (1 << 0),                         /* this is a version 4 route */
411         Rifc = (1 << 1),        /* this route is a directly connected interface */
412         Rptpt = (1 << 2),       /* this route is a pt to pt interface */
413         Runi = (1 << 3),        /* a unicast self address */
414         Rbcast = (1 << 4),      /* a broadcast self address */
415         Rmulti = (1 << 5),      /* a multicast self address */
416         Rproxy = (1 << 6),      /* this route should be proxied */
417 };
418
419 struct routewalk {
420         int o;
421         int h;
422         char *p;
423         char *e;
424         void *state;
425         void (*walk) (struct route *, struct routewalk *);
426 };
427
428 struct RouteTree {
429         struct route *right;
430         struct route *left;
431         struct route *mid;
432         uint8_t depth;
433         uint8_t type;
434         uint8_t ifcid;                          /* must match ifc->id */
435         struct Ipifc *ifc;
436         char tag[4];
437         struct kref kref;
438 };
439
440 struct V4route {
441         uint32_t address;
442         uint32_t endaddress;
443         uint8_t gate[IPv4addrlen];
444 };
445
446 struct V6route {
447         uint32_t address[IPllen];
448         uint32_t endaddress[IPllen];
449         uint8_t gate[IPaddrlen];
450 };
451
452 struct route {
453         struct RouteTree rt;
454
455         union {
456                 struct V6route v6;
457                 struct V4route v4;
458         };
459 };
460 extern void v4addroute(struct Fs *f, char *tag, uint8_t * a, uint8_t * mask,
461                                            uint8_t * gate, int type);
462 extern void v6addroute(struct Fs *f, char *tag, uint8_t * a, uint8_t * mask,
463                                            uint8_t * gate, int type);
464 extern void v4delroute(struct Fs *f, uint8_t * a, uint8_t * mask, int dolock);
465 extern void v6delroute(struct Fs *f, uint8_t * a, uint8_t * mask, int dolock);
466 extern struct route *v4lookup(struct Fs *f, uint8_t * a, struct conv *c);
467 extern struct route *v6lookup(struct Fs *f, uint8_t * a, struct conv *c);
468 extern long routeread(struct Fs *f, char *unused_char_p_t, uint32_t, int);
469 extern long routewrite(struct Fs *f, struct chan *, char *unused_char_p_t, int);
470 extern void routetype(int unused_int, char *unused_char_p_t);
471 extern void ipwalkroutes(struct Fs *, struct routewalk *);
472 extern void convroute(struct route *r, uint8_t * u8pt, uint8_t * u8pt1,
473                                           uint8_t * u8pt2, char *unused_char_p_t, int *intp);
474
475 /*
476  *  devip.c
477  */
478
479 /*
480  *  Hanging off every ip channel's ->aux is the following structure.
481  *  It maintains the state used by devip and iproute.
482  */
483 struct IPaux {
484         char *owner;                            /* the user that did the attach */
485         char tag[4];
486 };
487
488 extern struct IPaux *newipaux(char *unused_char_p_t, char *);
489
490 /*
491  *  arp.c
492  */
493 struct arpent {
494         uint8_t ip[IPaddrlen];
495         uint8_t mac[MAClen];
496         struct medium *type;            /* media type */
497         struct arpent *hash;
498         struct block *hold;
499         struct block *last;
500         uint64_t ctime;                 /* time entry was created or refreshed */
501         uint64_t utime;                 /* time entry was last used */
502         uint8_t state;
503         struct arpent *nextrxt;         /* re-transmit chain */
504         uint64_t rtime;                 /* time for next retransmission */
505         uint8_t rxtsrem;
506         struct Ipifc *ifc;
507         uint8_t ifcid;                          /* must match ifc->id */
508 };
509
510 extern void arpinit(struct Fs *);
511 extern int arpread(struct arp *, char *unused_char_p_t, uint32_t, int);
512 extern int arpwrite(struct Fs *, char *unused_char_p_t, int);
513 extern struct arpent *arpget(struct arp *, struct block *bp, int version,
514                                                          struct Ipifc *ifc, uint8_t * ip, uint8_t * h);
515 extern void arprelease(struct arp *, struct arpent *a);
516 extern struct block *arpresolve(struct arp *, struct arpent *a,
517                                                                 struct medium *type, uint8_t * mac);
518 extern void arpenter(struct Fs *, int version, uint8_t * ip,
519                                          uint8_t * mac, int len, int norefresh);
520
521 /*
522  * ipaux.c
523  */
524
525 extern int myetheraddr(uint8_t * unused_uint8_p_t, char *unused_char_p_t);
526 extern uint32_t parseip(uint8_t * unused_uint8_p_t, char *unused_char_p_t);
527 extern uint32_t parseipmask(uint8_t * unused_uint8_p_t, char *unused_char_p_t);
528 extern char *v4parseip(uint8_t * unused_uint8_p_t, char *unused_char_p_t);
529 extern void maskip(uint8_t * from, uint8_t * mask, uint8_t * to);
530 extern int parsemac(uint8_t * to, char *from, int len);
531 extern uint8_t *defmask(uint8_t * unused_uint8_p_t);
532 extern int isv4(uint8_t * unused_uint8_p_t);
533 extern void v4tov6(uint8_t * v6, uint8_t * v4);
534 extern int v6tov4(uint8_t * v4, uint8_t * v6);
535 //extern int    eipfmt(Fmt*);
536
537
538 #ifdef CONFIG_RISCV
539 #warning "Potentially unaligned IP addrs!"
540 #endif
541 static inline void ipmove(unsigned char *x, unsigned char *y)
542 {
543         uint32_t *a = (uint32_t *)x;
544         uint32_t *b = (uint32_t *)y;
545
546         a[0] = b[0];
547         a[1] = b[1];
548         a[2] = b[2];
549         a[3] = b[3];
550 }
551
552 static inline long ipcmp(unsigned char *x, unsigned char *y)
553 {
554         uint32_t *a = (uint32_t *)x;
555         uint32_t *b = (uint32_t *)y;
556         return (a[0] ^ b[0]) | (a[1] ^ b[1]) |
557                 (a[2] ^ b[2]) | (a[3] ^ b[3]);
558 }
559
560
561 extern uint8_t IPv4bcast[IPaddrlen];
562 extern uint8_t IPv4bcastobs[IPaddrlen];
563 extern uint8_t IPv4allsys[IPaddrlen];
564 extern uint8_t IPv4allrouter[IPaddrlen];
565 extern uint8_t IPnoaddr[IPaddrlen];
566 extern uint8_t v4prefix[IPaddrlen];
567 extern uint8_t IPallbits[IPaddrlen];
568
569 /*
570  *  media
571  */
572 extern struct medium ethermedium;
573 extern struct medium nullmedium;
574 extern struct medium pktmedium;
575 extern struct medium tripmedium;
576
577 /*
578  *  ipifc.c
579  */
580 extern struct medium *ipfindmedium(char *name);
581 extern void addipmedium(struct medium *med);
582 extern int ipforme(struct Fs *, uint8_t * addr);
583 extern int iptentative(struct Fs *, uint8_t * addr);
584 extern int ipisbm(uint8_t *);
585 extern int ipismulticast(uint8_t *);
586 extern struct Ipifc *findipifc(struct Fs *, uint8_t * remote, int type);
587 extern void findprimaryip(struct Fs *, uint8_t * unused_uint8_p_t);
588 extern void findlocalip(struct Fs *, uint8_t * local, uint8_t * remote);
589 extern int ipv4local(struct Ipifc *ifc, uint8_t * addr);
590 extern int ipv6local(struct Ipifc *ifc, uint8_t * addr);
591 extern int ipv6anylocal(struct Ipifc *ifc, uint8_t * addr);
592 extern struct Iplifc *iplocalonifc(struct Ipifc *ifc, uint8_t * ip);
593 extern int ipproxyifc(struct Fs *f, struct Ipifc *ifc, uint8_t * ip);
594 extern int ipismulticast(uint8_t * ip);
595 extern int ipisbooting(void);
596 extern int ipifccheckin(struct Ipifc *ifc, struct medium *med);
597 extern void ipifccheckout(struct Ipifc *ifc);
598 extern int ipifcgrab(struct Ipifc *ifc);
599 extern void ipifcaddroute(struct Fs *, int unused_int,
600                                                   uint8_t * unused_uint8_p_t, uint8_t *, uint8_t *,
601                                                   int);
602 extern void ipifcremroute(struct Fs *, int unused_int, uint8_t * u8pt,
603                                                   uint8_t * u8pt2);
604 extern void ipifcremmulti(struct conv *c, uint8_t * ma, uint8_t * ia);
605 extern void ipifcaddmulti(struct conv *c, uint8_t * ma, uint8_t * ia);
606 extern char *ipifcrem(struct Ipifc *ifc, char **argv, int argc);
607 extern char *ipifcadd(struct Ipifc *ifc, char **argv, int argc, int tentative,
608                                           struct Iplifc *lifcp);
609 extern long ipselftabread(struct Fs *, char *a, uint32_t offset, int n);
610 extern char *ipifcaddpref6(struct Ipifc *ifc, char **argv, int argc);
611 extern void ipsendra6(struct Fs *f, int on);
612
613 /*
614  *  ip.c
615  */
616 extern void iprouting(struct Fs *, int);
617 extern void icmpnoconv(struct Fs *, struct block *);
618 extern void icmpcantfrag(struct Fs *, struct block *, int);
619 extern void icmpttlexceeded(struct Fs *, uint8_t * unused_uint8_p_t,
620                                         struct block *);
621
622 uint16_t ipchecksum(uint8_t *addr, int len);
623 extern uint16_t ipcsum(uint8_t * unused_uint8_p_t);
624 extern void ipiput4(struct Fs *, struct Ipifc *unused_ipifc, struct block *);
625 extern void ipiput6(struct Fs *, struct Ipifc *unused_ipifc, struct block *);
626 extern int ipoput4(struct Fs *,
627                                    struct block *, int unused_int, int, int, struct conv *);
628 extern int ipoput6(struct Fs *,
629                                    struct block *, int unused_int, int, int, struct conv *);
630 extern int ipstats(struct Fs *, char *unused_char_p_t, int);
631 extern uint16_t ptclbsum(uint8_t * unused_uint8_p_t, int);
632 extern uint16_t ptclcsum(struct block *, int unused_int, int);
633 extern void ip_init(struct Fs *);
634 extern void update_mtucache(uint8_t * unused_uint8_p_t, uint32_t);
635 extern uint32_t restrict_mtu(uint8_t * unused_uint8_p_t, uint32_t);
636
637 static inline void ptclcsum_finalize(struct block *bp, unsigned int feat)
638 {
639         unsigned int flag = bp->flag & BCKSUM_FLAGS;
640         uint8_t *csum_store;
641
642         if (flag && (flag & feat) != flag) {
643                 csum_store = bp->rp + bp->checksum_start + bp->checksum_offset;
644                 hnputs((uint16_t *)csum_store,
645                        ptclcsum(bp, bp->checksum_start,
646                                 BLEN(bp) - bp->checksum_start));
647                 bp->flag &= ~BCKSUM_FLAGS;
648         }
649 }
650
651 /*
652  * bootp.c
653  */
654 char *(*bootp) (struct Ipifc * unused_ipifc);
655 int (*bootpread) (char *unused_char_p_t, uint32_t, int);
656
657 /*
658  *  iprouter.c
659  */
660 void useriprouter(struct Fs *, struct Ipifc *unused_ipifc, struct block *);
661 void iprouteropen(struct Fs *);
662 void iprouterclose(struct Fs *);
663 long iprouterread(struct Fs *, void *, int);
664
665 /*
666  *  resolving inferno/plan9 differences
667  */
668 struct chan *commonfdtochan(int unused_int, int, int, int);
669 char *commonuser(void);
670 char *commonerror(void);
671
672 /*
673  * chandial.c
674  */
675 extern struct chan *chandial(char *u1, char *u2, char *u3, struct chan **c);
676
677 /*
678  *  global to all of the stack
679  */
680 extern void (*igmpreportfn) (struct Ipifc * unused_ipifc,
681                                                          uint8_t * unused_uint8_p_t);
682
683 /* IPV6 */
684 /* rfc 3513 defines the address prefices */
685 #define isv6mcast(addr)   ((addr)[0] == 0xff)
686 #define islinklocal(addr) ((addr)[0] == 0xfe && ((addr)[1] & 0xc0) == 0x80)
687 #define issitelocal(addr) ((addr)[0] == 0xfe && ((addr)[1] & 0xc0) == 0xc0)
688 #define isv6global(addr) (((addr)[0] & 0xe0) == 0x20)
689
690 #define optexsts(np) (nhgets((np)->ploadlen) > 24)
691 #define issmcast(addr) (memcmp((addr), v6solicitednode, 13) == 0)
692
693 /* from RFC 2460 */
694
695 typedef struct Ip6hdr Ip6hdr;
696 typedef struct Opthdr Opthdr;
697 typedef struct Routinghdr Routinghdr;
698 typedef struct Fraghdr6 Fraghdr6;
699
700 struct ip6hdr {
701         uint8_t vcf[4];                         // version:4, traffic class:8, flow label:20
702         uint8_t ploadlen[2];            // payload length: packet length - 40
703         uint8_t proto;                          // next header type
704         uint8_t ttl;                            // hop limit
705         uint8_t src[IPaddrlen];
706         uint8_t dst[IPaddrlen];
707 };
708
709 struct Opthdr {
710         uint8_t nexthdr;
711         uint8_t len;
712 };
713
714 struct Routinghdr {
715         uint8_t nexthdr;
716         uint8_t len;
717         uint8_t rtetype;
718         uint8_t segrem;
719 };
720
721 struct fraghdr6 {
722         uint8_t nexthdr;
723         uint8_t res;
724         uint8_t offsetRM[2];            // Offset, Res, M flag
725         uint8_t id[4];
726 };
727
728 enum {                                                  /* Header Types */
729         HBH = 0,                                        //?
730         ICMP = 1,
731         IGMP = 2,
732         GGP = 3,
733         IPINIP = 4,
734         ST = 5,
735         TCP = 6,
736         UDP = 17,
737         ISO_TP4 = 29,
738         RH = 43,
739         FH = 44,
740         IDRP = 45,
741         RSVP = 46,
742         AH = 51,
743         ESP = 52,
744         ICMPv6 = 58,
745         NNH = 59,
746         DOH = 60,
747         ISO_IP = 80,
748         IGRP = 88,
749         OSPF = 89,
750
751         Maxhdrtype = 256,
752 };
753
754 enum {
755         //  multicast flgs and scop
756
757         well_known_flg = 0,
758         transient_flg = 1,
759
760         node_local_scop = 1,
761         link_local_scop = 2,
762         site_local_scop = 5,
763         org_local_scop = 8,
764         global_scop = 14,
765
766         //  various prefix lengths
767
768         SOLN_PREF_LEN = 13,
769
770         //  icmpv6 unreach codes
771         icmp6_no_route = 0,
772         icmp6_ad_prohib = 1,
773         icmp6_unassigned = 2,
774         icmp6_adr_unreach = 3,
775         icmp6_port_unreach = 4,
776         icmp6_unkn_code = 5,
777
778         //  various flags & constants
779
780         v6MINTU = 1280,
781         HOP_LIMIT = 255,
782         ETHERHDR_LEN = 14,
783         IPV6HDR_LEN = 40,
784         IPV4HDR_LEN = 20,
785
786         //  option types
787
788         SRC_LLADDRESS = 1,
789         TARGET_LLADDRESS = 2,
790         PREFIX_INFO = 3,
791         REDIR_HEADER = 4,
792         MTU_OPTION = 5,
793
794         SRC_UNSPEC = 0,
795         SRC_UNI = 1,
796         TARG_UNI = 2,
797         TARG_MULTI = 3,
798
799         t_unitent = 1,
800         t_uniproxy = 2,
801         t_unirany = 3,
802
803         //  Router constants (all times in milliseconds)
804
805         MAX_INITIAL_RTR_ADVERT_INTERVAL = 16000,
806         MAX_INITIAL_RTR_ADVERTISEMENTS = 3,
807         MAX_FINAL_RTR_ADVERTISEMENTS = 3,
808         MIN_DELAY_BETWEEN_RAS = 3000,
809         MAX_RA_DELAY_TIME = 500,
810
811         //  Host constants
812
813         MAX_RTR_SOLICITATION_DELAY = 1000,
814         RTR_SOLICITATION_INTERVAL = 4000,
815         MAX_RTR_SOLICITATIONS = 3,
816
817         //  Node constants
818
819         MAX_MULTICAST_SOLICIT = 3,
820         MAX_UNICAST_SOLICIT = 3,
821         MAX_ANYCAST_DELAY_TIME = 1000,
822         MAX_NEIGHBOR_ADVERTISEMENT = 3,
823         REACHABLE_TIME = 30000,
824         RETRANS_TIMER = 1000,
825         DELAY_FIRST_PROBE_TIME = 5000,
826
827 };
828
829 extern void ipv62smcast(uint8_t *, uint8_t *);
830 extern void icmpns(struct Fs *f, uint8_t * src, int suni, uint8_t * targ,
831                                    int tuni, uint8_t * mac);
832 extern void icmpna(struct Fs *f, uint8_t * src, uint8_t * dst, uint8_t * targ,
833                                    uint8_t * mac, uint8_t flags);
834 extern void icmpttlexceeded6(struct Fs *f, struct Ipifc *ifc, struct block *bp);
835 extern void icmppkttoobig6(struct Fs *f, struct Ipifc *ifc, struct block *bp);
836 extern void icmphostunr(struct Fs *f,
837                                                 struct Ipifc *ifc,
838                                                 struct block *bp, int code, int free);
839
840 extern uint8_t v6allnodesN[IPaddrlen];
841 extern uint8_t v6allnodesL[IPaddrlen];
842 extern uint8_t v6allroutersN[IPaddrlen];
843 extern uint8_t v6allroutersL[IPaddrlen];
844 extern uint8_t v6allnodesNmask[IPaddrlen];
845 extern uint8_t v6allnodesLmask[IPaddrlen];
846 extern uint8_t v6allroutersS[IPaddrlen];
847 extern uint8_t v6solicitednode[IPaddrlen];
848 extern uint8_t v6solicitednodemask[IPaddrlen];
849 extern uint8_t v6Unspecified[IPaddrlen];
850 extern uint8_t v6loopback[IPaddrlen];
851 extern uint8_t v6loopbackmask[IPaddrlen];
852 extern uint8_t v6linklocal[IPaddrlen];
853 extern uint8_t v6linklocalmask[IPaddrlen];
854 extern uint8_t v6sitelocal[IPaddrlen];
855 extern uint8_t v6sitelocalmask[IPaddrlen];
856 extern uint8_t v6glunicast[IPaddrlen];
857 extern uint8_t v6multicast[IPaddrlen];
858 extern uint8_t v6multicastmask[IPaddrlen];
859
860 extern int v6llpreflen;
861 extern int v6slpreflen;
862 extern int v6lbpreflen;
863 extern int v6mcpreflen;
864 extern int v6snpreflen;
865 extern int v6aNpreflen;
866 extern int v6aLpreflen;
867
868 extern int ReTransTimer;
869
870 int kdial(char *dest, char *local, char *dir, int *cfdp);
871
872 /* network interfaces and ethernet */
873 // INFERNO
874
875 enum {
876         Nmaxaddr = 64,
877         Nmhash = 31,
878
879         Ncloneqid = 1,
880         Naddrqid,
881         N2ndqid,
882         N3rdqid,
883         Ndataqid,
884         Nctlqid,
885         Nstatqid,
886         Ntypeqid,
887         Nifstatqid,
888 };
889
890 /*
891  *  Macros to manage Qid's used for multiplexed devices
892  */
893 #define NETTYPE(x)      (((uint32_t)x)&0x1f)
894 /* The net's ID + 1 is stored starting at 1 << 5.  So ID 0 = 32, ID 1 = 64, and
895  * NETID == -1 means no netid */
896 #define NETID(x)        (((uint32_t)(x) >> 5) - 1)
897 #define NETQID(i,t)     ((((uint32_t)(i) + 1) << 5) | (t))
898
899 /*
900  *  one per multiplexed connection
901  */
902 struct netfile {
903         qlock_t qlock;
904
905         int inuse;
906         uint32_t mode;
907         char owner[KNAMELEN];
908
909         int type;                                       /* multiplexor type */
910         int prom;                                       /* promiscuous mode */
911         int scan;                                       /* base station scanning interval */
912         int bridge;                                     /* bridge mode */
913         int headersonly;                        /* headers only - no data */
914         uint8_t maddr[8];                       /* bitmask of multicast addresses requested */
915         int nmaddr;                                     /* number of multicast addresses */
916
917         struct queue *in;                       /* input buffer */
918 };
919
920 /*
921  *  a network address
922  */
923 struct netaddr {
924         struct netaddr *next;           /* allocation chain */
925         struct netaddr *hnext;
926         uint8_t addr[Nmaxaddr];
927         int ref;                                        /* leaving this as an int, not a kref.  no reaping, yet. */
928 };
929
930 /*
931  * These flags overlap with block flags, to make detecting unsupported
932  * offloads efficient.
933  */
934 #define NETF_BASE_SHIFT         (NS_SHIFT_MAX + 1)
935 #define NETF_PADMIN_SHIFT       (NETF_BASE_SHIFT + 0)
936 #define NETF_SG_SHIFT           (NETF_BASE_SHIFT + 1)
937 #define NETF_LRO_SHIFT          (NETF_BASE_SHIFT + 2)
938 enum {
939         NETF_IPCK = (1 << NS_IPCK_SHIFT),       /* xmit ip checksum */
940         NETF_UDPCK = (1 << NS_UDPCK_SHIFT),     /* xmit udp checksum */
941         NETF_TCPCK = (1 << NS_TCPCK_SHIFT),     /* xmit tcp checksum */
942         NETF_PADMIN = (1 << NETF_PADMIN_SHIFT), /* device pads to mintu */
943         NETF_SG = (1 << NETF_SG_SHIFT),         /* device can do scatter/gather */
944         NETF_TSO = (1 << NS_TSO_SHIFT),         /* device can do TSO */
945         NETF_LRO = (1 << NETF_LRO_SHIFT),       /* device can do LRO */
946 };
947 /*
948  *  a network interface
949  */
950 struct ether;
951 struct netif {
952         qlock_t qlock;
953
954         /* multiplexing */
955         char name[KNAMELEN];            /* for top level directory */
956         int nfile;                                      /* max number of Netfiles */
957         struct netfile **f;
958
959         /* about net */
960         int limit;                                      /* flow control */
961         int alen;                                       /* address length */
962         int mbps;                                       /* megabits per sec */
963         int link;                                       /* link status */
964         unsigned int feat;                              /* dev features */
965         uint8_t addr[Nmaxaddr];
966         uint8_t bcast[Nmaxaddr];
967         struct netaddr *maddr;          /* known multicast addresses */
968         int nmaddr;                                     /* number of known multicast addresses */
969         struct netaddr *mhash[Nmhash];  /* hash table of multicast addresses */
970         int prom;                                       /* number of promiscuous opens */
971         int scan;                                       /* number of base station scanners */
972         int all;                                        /* number of -1 multiplexors */
973
974         /* statistics */
975         int misses;
976         int inpackets;
977         int outpackets;
978         int crcs;                                       /* input crc errors */
979         int oerrs;                                      /* output errors */
980         int frames;                                     /* framing errors */
981         int overflows;                          /* packet overflows */
982         int buffs;                                      /* buffering errors */
983         int soverflows;                         /* software overflow */
984
985         /* routines for touching the hardware */
986         void *arg;
987         void (*promiscuous) (void *, int);
988         void (*multicast) (void *, uint8_t * unused_uint8_p_t, int);
989         void (*scanbs) (void *, unsigned nt);   /* scan for base stations */
990 };
991
992 void netifinit(struct ether *, char *, int, uint32_t);
993 struct walkqid *netifwalk(struct ether *, struct chan *, struct chan *,
994                           char **,
995                                                   int);
996 struct chan *netifopen(struct ether *, struct chan *, int);
997 void netifclose(struct ether *, struct chan *);
998 long netifread(struct ether *, struct chan *, void *, long, uint32_t);
999 struct block *netifbread(struct ether *, struct chan *, long, uint32_t);
1000 long netifwrite(struct ether *, struct chan *, void *, long);
1001 int netifwstat(struct ether *, struct chan *, uint8_t *, int);
1002 int netifstat(struct ether *, struct chan *, uint8_t *, int);
1003 int activemulti(struct ether *, uint8_t *, int);
1004
1005 /*
1006  *  Ethernet specific
1007  */
1008 enum {
1009         Eaddrlen = 6,
1010         ETHERMINTU = 60,        /* minimum transmit size */
1011         ETHERMAXTU = 1500,      /* maximum transmit size */
1012         ETHERHDRSIZE = 14,      /* size of an ethernet header */
1013 };
1014
1015 struct etherpkt {
1016         uint8_t d[Eaddrlen];
1017         uint8_t s[Eaddrlen];
1018         uint8_t type[2];
1019         uint8_t data[1500];
1020 };
1021 // INFERNO
1022 enum {
1023         MaxEther = 32,
1024         MaxFID = 16,
1025         Ntypes = 8,
1026 };
1027
1028 struct ether {
1029         rwlock_t rwlock;
1030         int ctlrno;
1031         char *type;
1032         int irq;
1033         unsigned int tbdf;
1034         int port;
1035         int minmtu;
1036         int maxmtu;
1037         uint8_t ea[Eaddrlen];
1038         int encry;
1039
1040         void (*attach) (struct ether *);        /* filled in by reset routine */
1041         void (*closed) (struct ether *);
1042         void (*detach) (struct ether *);
1043         void (*transmit) (struct ether *);
1044         long (*ifstat) (struct ether *, void *, long, uint32_t);
1045         long (*ctl) (struct ether *, void *, long);     /* custom ctl messages */
1046         void (*power) (struct ether *, int);    /* power on/off */
1047         void (*shutdown) (struct ether *);      /* shutdown hardware before reboot */
1048         void *ctlr;
1049         int pcmslot;                            /* PCMCIA */
1050         int fullduplex;                         /* non-zero if full duplex */
1051         int vlanid;                                     /* non-zero if vlan */
1052
1053         struct queue *oq;
1054
1055         qlock_t vlq;                            /* array change */
1056         int nvlan;
1057         struct ether *vlans[MaxFID];
1058
1059         struct netif;
1060 };
1061
1062 extern struct block *etheriq(struct ether *, struct block *, int);
1063 extern void addethercard(char *unused_char_p_t, int (*)(struct ether *));
1064 extern int archether(int unused_int, struct ether *);
1065
1066 #define NEXT_RING(x, len) (((x) + 1) % (len))
1067 #define PREV_RING(x, len) (((x) == 0) ? (len) - 1: (x) - 1)
1068
1069 #endif /* ROS_KERN_IP_H */