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