Have #ip protocol's announce()s throw errors
[akaros.git] / kern / src / net / icmp.c
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 #include <vfs.h>
30 #include <kfs.h>
31 #include <slab.h>
32 #include <kmalloc.h>
33 #include <kref.h>
34 #include <string.h>
35 #include <stdio.h>
36 #include <assert.h>
37 #include <error.h>
38 #include <cpio.h>
39 #include <pmap.h>
40 #include <smp.h>
41 #include <ip.h>
42
43 #include <vfs.h>
44 #include <kfs.h>
45 #include <slab.h>
46 #include <kmalloc.h>
47 #include <kref.h>
48 #include <string.h>
49 #include <stdio.h>
50 #include <assert.h>
51 #include <error.h>
52 #include <cpio.h>
53 #include <pmap.h>
54 #include <smp.h>
55 #include <ip.h>
56
57 typedef struct Icmp {
58         uint8_t vihl;                           /* Version and header length */
59         uint8_t tos;                            /* Type of service */
60         uint8_t length[2];                      /* packet length */
61         uint8_t id[2];                          /* Identification */
62         uint8_t frag[2];                        /* Fragment information */
63         uint8_t ttl;                            /* Time to live */
64         uint8_t proto;                          /* Protocol */
65         uint8_t ipcksum[2];                     /* Header checksum */
66         uint8_t src[4];                         /* Ip source */
67         uint8_t dst[4];                         /* Ip destination */
68         uint8_t type;
69         uint8_t code;
70         uint8_t cksum[2];
71         uint8_t icmpid[2];
72         uint8_t seq[2];
73         uint8_t data[1];
74 } Icmp;
75
76 enum {                                                  /* Packet Types */
77         EchoReply = 0,
78         Unreachable = 3,
79         SrcQuench = 4,
80         Redirect = 5,
81         EchoRequest = 8,
82         TimeExceed = 11,
83         InParmProblem = 12,
84         Timestamp = 13,
85         TimestampReply = 14,
86         InfoRequest = 15,
87         InfoReply = 16,
88         AddrMaskRequest = 17,
89         AddrMaskReply = 18,
90
91         Maxtype = 18,
92 };
93
94 enum {
95         MinAdvise = 24,                         /* minimum needed for us to advise another protocol */
96 };
97
98 char *icmpnames[Maxtype + 1] = {
99         [EchoReply] "EchoReply",
100         [Unreachable] "Unreachable",
101         [SrcQuench] "SrcQuench",
102         [Redirect] "Redirect",
103         [EchoRequest] "EchoRequest",
104         [TimeExceed] "TimeExceed",
105         [InParmProblem] "InParmProblem",
106         [Timestamp] "Timestamp",
107         [TimestampReply] "TimestampReply",
108         [InfoRequest] "InfoRequest",
109         [InfoReply] "InfoReply",
110         [AddrMaskRequest] "AddrMaskRequest",
111         [AddrMaskReply] "AddrMaskReply  ",
112 };
113
114 enum {
115         IP_ICMPPROTO = 1,
116         ICMP_IPSIZE = 20,
117         ICMP_HDRSIZE = 8,
118 };
119
120 enum {
121         InMsgs,
122         InErrors,
123         OutMsgs,
124         CsumErrs,
125         LenErrs,
126         HlenErrs,
127
128         Nstats,
129 };
130
131 static char *statnames[Nstats] = {
132         [InMsgs] "InMsgs",
133         [InErrors] "InErrors",
134         [OutMsgs] "OutMsgs",
135         [CsumErrs] "CsumErrs",
136         [LenErrs] "LenErrs",
137         [HlenErrs] "HlenErrs",
138 };
139
140 typedef struct Icmppriv Icmppriv;
141 struct Icmppriv {
142         uint32_t stats[Nstats];
143
144         /* message counts */
145         uint32_t in[Maxtype + 1];
146         uint32_t out[Maxtype + 1];
147 };
148
149 static void icmpkick(void *x, struct block *);
150
151 static void icmpcreate(struct conv *c)
152 {
153         c->rq = qopen(64 * 1024, Qmsg, 0, c);
154         c->wq = qbypass(icmpkick, c);
155 }
156
157 void icmpconnect(struct conv *c, char **argv, int argc)
158 {
159         Fsstdconnect(c, argv, argc);
160         Fsconnected(c, 0);
161 }
162
163 extern int icmpstate(struct conv *c, char *state, int n)
164 {
165         return snprintf(state, n, "%s qin %d qout %d\n",
166                                         "Datagram",
167                                         c->rq ? qlen(c->rq) : 0, c->wq ? qlen(c->wq) : 0);
168 }
169
170 void icmpannounce(struct conv *c, char **argv, int argc)
171 {
172         Fsstdannounce(c, argv, argc);
173         Fsconnected(c, NULL);
174 }
175
176 extern void icmpclose(struct conv *c)
177 {
178         qclose(c->rq);
179         qclose(c->wq);
180         ipmove(c->laddr, IPnoaddr);
181         ipmove(c->raddr, IPnoaddr);
182         c->lport = 0;
183 }
184
185 static void icmpkick(void *x, struct block *bp)
186 {
187         struct conv *c = x;
188         Icmp *p;
189         Icmppriv *ipriv;
190
191         if (bp == NULL)
192                 return;
193
194         bp = pullupblock(bp, ICMP_IPSIZE + ICMP_HDRSIZE);
195         if (bp == 0)
196                 return;
197         p = (Icmp *) (bp->rp);
198         p->vihl = IP_VER4;
199         ipriv = c->p->priv;
200         if (p->type <= Maxtype)
201                 ipriv->out[p->type]++;
202
203         v6tov4(p->dst, c->raddr);
204         v6tov4(p->src, c->laddr);
205         p->proto = IP_ICMPPROTO;
206         hnputs(p->icmpid, c->lport);
207         memset(p->cksum, 0, sizeof(p->cksum));
208         hnputs(p->cksum, ptclcsum(bp, ICMP_IPSIZE, blocklen(bp) - ICMP_IPSIZE));
209         ipriv->stats[OutMsgs]++;
210         ipoput4(c->p->f, bp, 0, c->ttl, c->tos, NULL);
211 }
212
213 extern void icmpttlexceeded(struct Fs *f, uint8_t * ia, struct block *bp)
214 {
215         struct block *nbp;
216         Icmp *p, *np;
217
218         p = (Icmp *) bp->rp;
219
220         netlog(f, Logicmp, "sending icmpttlexceeded -> %V\n", p->src);
221         nbp = allocb(ICMP_IPSIZE + ICMP_HDRSIZE + ICMP_IPSIZE + 8);
222         nbp->wp += ICMP_IPSIZE + ICMP_HDRSIZE + ICMP_IPSIZE + 8;
223         np = (Icmp *) nbp->rp;
224         np->vihl = IP_VER4;
225         memmove(np->dst, p->src, sizeof(np->dst));
226         v6tov4(np->src, ia);
227         memmove(np->data, bp->rp, ICMP_IPSIZE + 8);
228         np->type = TimeExceed;
229         np->code = 0;
230         np->proto = IP_ICMPPROTO;
231         hnputs(np->icmpid, 0);
232         hnputs(np->seq, 0);
233         memset(np->cksum, 0, sizeof(np->cksum));
234         hnputs(np->cksum, ptclcsum(nbp, ICMP_IPSIZE, blocklen(nbp) - ICMP_IPSIZE));
235         ipoput4(f, nbp, 0, MAXTTL, DFLTTOS, NULL);
236
237 }
238
239 static void icmpunreachable(struct Fs *f, struct block *bp, int code, int seq)
240 {
241         struct block *nbp;
242         Icmp *p, *np;
243         int i;
244         uint8_t addr[IPaddrlen];
245
246         p = (Icmp *) bp->rp;
247
248         /* only do this for unicast sources and destinations */
249         v4tov6(addr, p->dst);
250         i = ipforme(f, addr);
251         if ((i & Runi) == 0)
252                 return;
253         v4tov6(addr, p->src);
254         i = ipforme(f, addr);
255         if (i != 0 && (i & Runi) == 0)
256                 return;
257
258         netlog(f, Logicmp, "sending icmpnoconv -> %V\n", p->src);
259         nbp = allocb(ICMP_IPSIZE + ICMP_HDRSIZE + ICMP_IPSIZE + 8);
260         nbp->wp += ICMP_IPSIZE + ICMP_HDRSIZE + ICMP_IPSIZE + 8;
261         np = (Icmp *) nbp->rp;
262         np->vihl = IP_VER4;
263         memmove(np->dst, p->src, sizeof(np->dst));
264         memmove(np->src, p->dst, sizeof(np->src));
265         memmove(np->data, bp->rp, ICMP_IPSIZE + 8);
266         np->type = Unreachable;
267         np->code = code;
268         np->proto = IP_ICMPPROTO;
269         hnputs(np->icmpid, 0);
270         hnputs(np->seq, seq);
271         memset(np->cksum, 0, sizeof(np->cksum));
272         hnputs(np->cksum, ptclcsum(nbp, ICMP_IPSIZE, blocklen(nbp) - ICMP_IPSIZE));
273         ipoput4(f, nbp, 0, MAXTTL, DFLTTOS, NULL);
274 }
275
276 extern void icmpnoconv(struct Fs *f, struct block *bp)
277 {
278         icmpunreachable(f, bp, 3, 0);
279 }
280
281 extern void icmpcantfrag(struct Fs *f, struct block *bp, int mtu)
282 {
283         icmpunreachable(f, bp, 4, mtu);
284 }
285
286 static void goticmpkt(struct Proto *icmp, struct block *bp)
287 {
288         struct conv **c, *s;
289         Icmp *p;
290         uint8_t dst[IPaddrlen];
291         uint16_t recid;
292
293         p = (Icmp *) bp->rp;
294         v4tov6(dst, p->src);
295         recid = nhgets(p->icmpid);
296
297         for (c = icmp->conv; *c; c++) {
298                 s = *c;
299                 if (s->lport == recid)
300                         if (ipcmp(s->raddr, dst) == 0) {
301                                 bp = concatblock(bp);
302                                 if (bp != NULL)
303                                         qpass(s->rq, bp);
304                                 return;
305                         }
306         }
307         freeblist(bp);
308 }
309
310 static struct block *mkechoreply(struct block *bp)
311 {
312         Icmp *q;
313         uint8_t ip[4];
314
315         /* we're repurposing bp to send it back out.  we need to remove any inbound
316          * checksum flags (which were saying the HW did the checksum) */
317         bp->flag &= ~BCKSUM_FLAGS;
318         q = (Icmp *) bp->rp;
319         q->vihl = IP_VER4;
320         memmove(ip, q->src, sizeof(q->dst));
321         memmove(q->src, q->dst, sizeof(q->src));
322         memmove(q->dst, ip, sizeof(q->dst));
323         q->type = EchoReply;
324         memset(q->cksum, 0, sizeof(q->cksum));
325         hnputs(q->cksum, ptclcsum(bp, ICMP_IPSIZE, blocklen(bp) - ICMP_IPSIZE));
326
327         return bp;
328 }
329
330 static char *unreachcode[] = {
331         [0] "net unreachable",
332         [1] "host unreachable",
333         [2] "protocol unreachable",
334         [3] "port unreachable",
335         [4] "fragmentation needed and DF set",
336         [5] "source route failed",
337 };
338
339 static void icmpiput(struct Proto *icmp, struct Ipifc *unused, struct block *bp)
340 {
341         int n, iplen;
342         Icmp *p;
343         struct block *r;
344         struct Proto *pr;
345         char *msg;
346         char m2[128];
347         Icmppriv *ipriv;
348
349         bp = pullupblock(bp, ICMP_IPSIZE + ICMP_HDRSIZE);
350         if (bp == NULL)
351                 return;
352
353         ipriv = icmp->priv;
354
355         ipriv->stats[InMsgs]++;
356
357         p = (Icmp *) bp->rp;
358         netlog(icmp->f, Logicmp, "icmpiput %d %d\n", p->type, p->code);
359         n = blocklen(bp);
360         if (n < ICMP_IPSIZE + ICMP_HDRSIZE) {
361                 ipriv->stats[InErrors]++;
362                 ipriv->stats[HlenErrs]++;
363                 netlog(icmp->f, Logicmp, "icmp hlen %d\n", n);
364                 goto raise;
365         }
366         iplen = nhgets(p->length);
367         if (iplen > n || (iplen % 1)) {
368                 ipriv->stats[LenErrs]++;
369                 ipriv->stats[InErrors]++;
370                 netlog(icmp->f, Logicmp, "icmp length %d\n", iplen);
371                 goto raise;
372         }
373         if (ptclcsum(bp, ICMP_IPSIZE, iplen - ICMP_IPSIZE)) {
374                 ipriv->stats[InErrors]++;
375                 ipriv->stats[CsumErrs]++;
376                 netlog(icmp->f, Logicmp, "icmp checksum error\n");
377                 goto raise;
378         }
379         if (p->type <= Maxtype)
380                 ipriv->in[p->type]++;
381
382         switch (p->type) {
383                 case EchoRequest:
384                         if (iplen < n)
385                                 bp = trimblock(bp, 0, iplen);
386                         r = mkechoreply(bp);
387                         ipriv->out[EchoReply]++;
388                         ipoput4(icmp->f, r, 0, MAXTTL, DFLTTOS, NULL);
389                         break;
390                 case Unreachable:
391                         if (p->code > 5)
392                                 msg = unreachcode[1];
393                         else
394                                 msg = unreachcode[p->code];
395
396                         bp->rp += ICMP_IPSIZE + ICMP_HDRSIZE;
397                         if (blocklen(bp) < MinAdvise) {
398                                 ipriv->stats[LenErrs]++;
399                                 goto raise;
400                         }
401                         p = (Icmp *) bp->rp;
402                         pr = Fsrcvpcolx(icmp->f, p->proto);
403                         if (pr != NULL && pr->advise != NULL) {
404                                 (*pr->advise) (pr, bp, msg);
405                                 return;
406                         }
407
408                         bp->rp -= ICMP_IPSIZE + ICMP_HDRSIZE;
409                         goticmpkt(icmp, bp);
410                         break;
411                 case TimeExceed:
412                         if (p->code == 0) {
413                                 snprintf(m2, sizeof(m2), "ttl exceeded at %V", p->src);
414
415                                 bp->rp += ICMP_IPSIZE + ICMP_HDRSIZE;
416                                 if (blocklen(bp) < MinAdvise) {
417                                         ipriv->stats[LenErrs]++;
418                                         goto raise;
419                                 }
420                                 p = (Icmp *) bp->rp;
421                                 pr = Fsrcvpcolx(icmp->f, p->proto);
422                                 if (pr != NULL && pr->advise != NULL) {
423                                         (*pr->advise) (pr, bp, m2);
424                                         return;
425                                 }
426                                 bp->rp -= ICMP_IPSIZE + ICMP_HDRSIZE;
427                         }
428
429                         goticmpkt(icmp, bp);
430                         break;
431                 default:
432                         goticmpkt(icmp, bp);
433                         break;
434         }
435         return;
436
437 raise:
438         freeblist(bp);
439 }
440
441 void icmpadvise(struct Proto *icmp, struct block *bp, char *msg)
442 {
443         struct conv **c, *s;
444         Icmp *p;
445         uint8_t dst[IPaddrlen];
446         uint16_t recid;
447
448         p = (Icmp *) bp->rp;
449         v4tov6(dst, p->dst);
450         recid = nhgets(p->icmpid);
451
452         for (c = icmp->conv; *c; c++) {
453                 s = *c;
454                 if (s->lport == recid)
455                         if (ipcmp(s->raddr, dst) == 0) {
456                                 qhangup(s->rq, msg);
457                                 qhangup(s->wq, msg);
458                                 break;
459                         }
460         }
461         freeblist(bp);
462 }
463
464 int icmpstats(struct Proto *icmp, char *buf, int len)
465 {
466         Icmppriv *priv;
467         char *p, *e;
468         int i;
469
470         priv = icmp->priv;
471         p = buf;
472         e = p + len;
473         for (i = 0; i < Nstats; i++)
474                 p = seprintf(p, e, "%s: %u\n", statnames[i], priv->stats[i]);
475         for (i = 0; i <= Maxtype; i++) {
476                 if (icmpnames[i])
477                         p = seprintf(p, e, "%s: %u %u\n", icmpnames[i], priv->in[i],
478                                                  priv->out[i]);
479                 else
480                         p = seprintf(p, e, "%d: %u %u\n", i, priv->in[i], priv->out[i]);
481         }
482         return p - buf;
483 }
484
485 void icmpinit(struct Fs *fs)
486 {
487         struct Proto *icmp;
488
489         icmp = kzmalloc(sizeof(struct Proto), 0);
490         icmp->priv = kzmalloc(sizeof(Icmppriv), 0);
491         icmp->name = "icmp";
492         icmp->connect = icmpconnect;
493         icmp->announce = icmpannounce;
494         icmp->state = icmpstate;
495         icmp->create = icmpcreate;
496         icmp->close = icmpclose;
497         icmp->rcv = icmpiput;
498         icmp->stats = icmpstats;
499         icmp->ctl = NULL;
500         icmp->advise = icmpadvise;
501         icmp->gc = NULL;
502         icmp->ipproto = IP_ICMPPROTO;
503         icmp->nc = 128;
504         icmp->ptclsize = 0;
505
506         Fsproto(fs, icmp);
507 }