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