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