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