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