l4/pkg/ankh/lib/lwip/contrib/src/core/ipv4/icmp.c

   1 /**
   2  * @file
   3  * ICMP - Internet Control Message Protocol
   4  *
   5  */
   6
   7 /*
   8  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without modification,
  12  * are permitted provided that the following conditions are met:
  13  *
  14  * 1. Redistributions of source code must retain the above copyright notice,
  15  *    this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright notice,
  17  *    this list of conditions and the following disclaimer in the documentation
  18  *    and/or other materials provided with the distribution.
  19  * 3. The name of the author may not be used to endorse or promote products
  20  *    derived from this software without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  23  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  24  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
  25  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  26  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  27  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  30  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  31  * OF SUCH DAMAGE.
  32  *
  33  * This file is part of the lwIP TCP/IP stack.
  34  *
  35  * Author: Adam Dunkels <adam@sics.se>
  36  *
  37  */
  38
  39 /* Some ICMP messages should be passed to the transport protocols. This
  40    is not implemented. */
  41
  42 #include "lwip/opt.h"
  43
  44 #if LWIP_ICMP /* don't build if not configured for use in lwipopts.h */
  45
  46 #include "lwip/icmp.h"
  47 #include "lwip/inet_chksum.h"
  48 #include "lwip/ip.h"
  49 #include "lwip/def.h"
  50 #include "lwip/stats.h"
  51 #include "lwip/snmp.h"
  52
  53 #include <string.h>
  54
  55 /** Small optimization: set to 0 if incoming PBUF_POOL pbuf always can be
  56  * used to modify and send a response packet (and to 1 if this is not the case,
  57  * e.g. when link header is stripped of when receiving) */
  58 #ifndef LWIP_ICMP_ECHO_CHECK_INPUT_PBUF_LEN
  59 #define LWIP_ICMP_ECHO_CHECK_INPUT_PBUF_LEN 1
  60 #endif /* LWIP_ICMP_ECHO_CHECK_INPUT_PBUF_LEN */
  61
  62 /* The amount of data from the original packet to return in a dest-unreachable */
  63 #define ICMP_DEST_UNREACH_DATASIZE 8
  64
  65 static void icmp_send_response(struct pbuf *p, u8_t type, u8_t code);
  66
  67 /**
  68  * Processes ICMP input packets, called from ip_input().
  69  *
  70  * Currently only processes icmp echo requests and sends
  71  * out the echo response.
  72  *
  73  * @param p the icmp echo request packet, p->payload pointing to the ip header
  74  * @param inp the netif on which this packet was received
  75  */
  76 void
  77 icmp_input(struct pbuf *p, struct netif *inp)
  78 {
  79   u8_t type;
  80 #ifdef LWIP_DEBUG
  81   u8_t code;
  82 #endif /* LWIP_DEBUG */
  83   struct icmp_echo_hdr *iecho;
  84   struct ip_hdr *iphdr;
  85   ip_addr_t tmpaddr;
  86   s16_t hlen;
  87
  88   ICMP_STATS_INC(icmp.recv);
  89   snmp_inc_icmpinmsgs();
  90
  91
  92   iphdr = (struct ip_hdr *)p->payload;
  93   hlen = IPH_HL(iphdr) * 4;
  94   if (pbuf_header(p, -hlen) || (p->tot_len < sizeof(u16_t)*2)) {
  95     LWIP_DEBUGF(ICMP_DEBUG, ("icmp_input: short ICMP (%"U16_F" bytes) received\n", p->tot_len));
  96     goto lenerr;
  97   }
  98
  99   type = *((u8_t *)p->payload);
 100 #ifdef LWIP_DEBUG
 101   code = *(((u8_t *)p->payload)+1);
 102 #endif /* LWIP_DEBUG */
 103   switch (type) {
 104   case ICMP_ER:
 105     /* This is OK, echo reply might have been parsed by a raw PCB
 106        (as obviously, an echo request has been sent, too). */
 107     break;
 108   case ICMP_ECHO:
 109 #if !LWIP_MULTICAST_PING || !LWIP_BROADCAST_PING
 110     {
 111       int accepted = 1;
 112 #if !LWIP_MULTICAST_PING
 113       /* multicast destination address? */
 114       if (ip_addr_ismulticast(&iphdr->dest)) {
 115         accepted = 0;
 116       }
 117 #endif /* LWIP_MULTICAST_PING */
 118 #if !LWIP_BROADCAST_PING
 119       /* broadcast destination address? */
 120       if (ip_addr_isbroadcast(&iphdr->dest, inp)) {
 121         accepted = 0;
 122       }
 123 #endif /* LWIP_BROADCAST_PING */
 124       /* broadcast or multicast destination address not acceptd? */
 125       if (!accepted) {
 126         LWIP_DEBUGF(ICMP_DEBUG, ("icmp_input: Not echoing to multicast or broadcast pings\n"));
 127         ICMP_STATS_INC(icmp.err);
 128         pbuf_free(p);
 129         return;
 130       }
 131     }
 132 #endif /* !LWIP_MULTICAST_PING || !LWIP_BROADCAST_PING */
 133     LWIP_DEBUGF(ICMP_DEBUG, ("icmp_input: ping\n"));
 134     if (p->tot_len < sizeof(struct icmp_echo_hdr)) {
 135       LWIP_DEBUGF(ICMP_DEBUG, ("icmp_input: bad ICMP echo received\n"));
 136       goto lenerr;
 137     }
 138     if (inet_chksum_pbuf(p) != 0) {
 139       LWIP_DEBUGF(ICMP_DEBUG, ("icmp_input: checksum failed for received ICMP echo\n"));
 140       pbuf_free(p);
 141       ICMP_STATS_INC(icmp.chkerr);
 142       snmp_inc_icmpinerrors();
 143       return;
 144     }
 145 #if LWIP_ICMP_ECHO_CHECK_INPUT_PBUF_LEN
 146     if (pbuf_header(p, (PBUF_IP_HLEN + PBUF_LINK_HLEN))) {
 147       /* p is not big enough to contain link headers
 148        * allocate a new one and copy p into it
 149        */
 150       struct pbuf *r;
 151       /* switch p->payload to ip header */
 152       if (pbuf_header(p, hlen)) {
 153         LWIP_ASSERT("icmp_input: moving p->payload to ip header failed\n", 0);
 154         goto memerr;
 155       }
 156       /* allocate new packet buffer with space for link headers */
 157       r = pbuf_alloc(PBUF_LINK, p->tot_len, PBUF_RAM);
 158       if (r == NULL) {
 159         LWIP_DEBUGF(ICMP_DEBUG, ("icmp_input: allocating new pbuf failed\n"));
 160         goto memerr;
 161       }
 162       LWIP_ASSERT("check that first pbuf can hold struct the ICMP header",
 163                   (r->len >= hlen + sizeof(struct icmp_echo_hdr)));
 164       /* copy the whole packet including ip header */
 165       if (pbuf_copy(r, p) != ERR_OK) {
 166         LWIP_ASSERT("icmp_input: copying to new pbuf failed\n", 0);
 167         goto memerr;
 168       }
 169       iphdr = (struct ip_hdr *)r->payload;
 170       /* switch r->payload back to icmp header */
 171       if (pbuf_header(r, -hlen)) {
 172         LWIP_ASSERT("icmp_input: restoring original p->payload failed\n", 0);
 173         goto memerr;
 174       }
 175       /* free the original p */
 176       pbuf_free(p);
 177       /* we now have an identical copy of p that has room for link headers */
 178       p = r;
 179     } else {
 180       /* restore p->payload to point to icmp header */
 181       if (pbuf_header(p, -(s16_t)(PBUF_IP_HLEN + PBUF_LINK_HLEN))) {
 182         LWIP_ASSERT("icmp_input: restoring original p->payload failed\n", 0);
 183         goto memerr;
 184       }
 185     }
 186 #endif /* LWIP_ICMP_ECHO_CHECK_INPUT_PBUF_LEN */
 187     /* At this point, all checks are OK. */
 188     /* We generate an answer by switching the dest and src ip addresses,
 189      * setting the icmp type to ECHO_RESPONSE and updating the checksum. */
 190     iecho = (struct icmp_echo_hdr *)p->payload;
 191     ip_addr_copy(tmpaddr, iphdr->src);
 192     ip_addr_copy(iphdr->src, iphdr->dest);
 193     ip_addr_copy(iphdr->dest, tmpaddr);
 194     ICMPH_TYPE_SET(iecho, ICMP_ER);
 195     /* adjust the checksum */
 196     if (iecho->chksum >= PP_HTONS(0xffff - (ICMP_ECHO << 8))) {
 197       iecho->chksum += PP_HTONS(ICMP_ECHO << 8) + 1;
 198     } else {
 199       iecho->chksum += PP_HTONS(ICMP_ECHO << 8);
 200     }
 201
 202     /* Set the correct TTL and recalculate the header checksum. */
 203     IPH_TTL_SET(iphdr, ICMP_TTL);
 204     IPH_CHKSUM_SET(iphdr, 0);
 205 #if CHECKSUM_GEN_IP
 206     IPH_CHKSUM_SET(iphdr, inet_chksum(iphdr, IP_HLEN));
 207 #endif /* CHECKSUM_GEN_IP */
 208
 209     ICMP_STATS_INC(icmp.xmit);
 210     /* increase number of messages attempted to send */
 211     snmp_inc_icmpoutmsgs();
 212     /* increase number of echo replies attempted to send */
 213     snmp_inc_icmpoutechoreps();
 214
 215     if(pbuf_header(p, hlen)) {
 216       LWIP_ASSERT("Can't move over header in packet", 0);
 217     } else {
 218       err_t ret;
 219       ret = ip_output_if(p, &(iphdr->src), IP_HDRINCL,
 220                    ICMP_TTL, 0, IP_PROTO_ICMP, inp);
 221       if (ret != ERR_OK) {
 222         LWIP_DEBUGF(ICMP_DEBUG, ("icmp_input: ip_output_if returned an error: %c.\n", ret));
 223       }
 224     }
 225     break;
 226   default:
 227     LWIP_DEBUGF(ICMP_DEBUG, ("icmp_input: ICMP type %"S16_F" code %"S16_F" not supported.\n",
 228                 (s16_t)type, (s16_t)code));
 229     ICMP_STATS_INC(icmp.proterr);
 230     ICMP_STATS_INC(icmp.drop);
 231   }
 232   pbuf_free(p);
 233   return;
 234 lenerr:
 235   pbuf_free(p);
 236   ICMP_STATS_INC(icmp.lenerr);
 237   snmp_inc_icmpinerrors();
 238   return;
 239 #if LWIP_ICMP_ECHO_CHECK_INPUT_PBUF_LEN
 240 memerr:
 241   pbuf_free(p);
 242   ICMP_STATS_INC(icmp.err);
 243   snmp_inc_icmpinerrors();
 244   return;
 245 #endif /* LWIP_ICMP_ECHO_CHECK_INPUT_PBUF_LEN */
 246 }
 247
 248 /**
 249  * Send an icmp 'destination unreachable' packet, called from ip_input() if
 250  * the transport layer protocol is unknown and from udp_input() if the local
 251  * port is not bound.
 252  *
 253  * @param p the input packet for which the 'unreachable' should be sent,
 254  *          p->payload pointing to the IP header
 255  * @param t type of the 'unreachable' packet
 256  */
 257 void
 258 icmp_dest_unreach(struct pbuf *p, enum icmp_dur_type t)
 259 {
 260   icmp_send_response(p, ICMP_DUR, t);
 261 }
 262
 263 #if IP_FORWARD || IP_REASSEMBLY
 264 /**
 265  * Send a 'time exceeded' packet, called from ip_forward() if TTL is 0.
 266  *
 267  * @param p the input packet for which the 'time exceeded' should be sent,
 268  *          p->payload pointing to the IP header
 269  * @param t type of the 'time exceeded' packet
 270  */
 271 void
 272 icmp_time_exceeded(struct pbuf *p, enum icmp_te_type t)
 273 {
 274   icmp_send_response(p, ICMP_TE, t);
 275 }
 276
 277 #endif /* IP_FORWARD || IP_REASSEMBLY */
 278
 279 /**
 280  * Send an icmp packet in response to an incoming packet.
 281  *
 282  * @param p the input packet for which the 'unreachable' should be sent,
 283  *          p->payload pointing to the IP header
 284  * @param type Type of the ICMP header
 285  * @param code Code of the ICMP header
 286  */
 287 static void
 288 icmp_send_response(struct pbuf *p, u8_t type, u8_t code)
 289 {
 290   struct pbuf *q;
 291   struct ip_hdr *iphdr;
 292   /* we can use the echo header here */
 293   struct icmp_echo_hdr *icmphdr;
 294
 295   /* ICMP header + IP header + 8 bytes of data */
 296   q = pbuf_alloc(PBUF_IP, sizeof(struct icmp_echo_hdr) + IP_HLEN + ICMP_DEST_UNREACH_DATASIZE,
 297                  PBUF_RAM);
 298   if (q == NULL) {
 299     LWIP_DEBUGF(ICMP_DEBUG, ("icmp_time_exceeded: failed to allocate pbuf for ICMP packet.\n"));
 300     return;
 301   }
 302   LWIP_ASSERT("check that first pbuf can hold icmp message",
 303              (q->len >= (sizeof(struct icmp_echo_hdr) + IP_HLEN + ICMP_DEST_UNREACH_DATASIZE)));
 304
 305   iphdr = (struct ip_hdr *)p->payload;
 306   LWIP_DEBUGF(ICMP_DEBUG, ("icmp_time_exceeded from "));
 307   ip_addr_debug_print(ICMP_DEBUG, &(iphdr->src));
 308   LWIP_DEBUGF(ICMP_DEBUG, (" to "));
 309   ip_addr_debug_print(ICMP_DEBUG, &(iphdr->dest));
 310   LWIP_DEBUGF(ICMP_DEBUG, ("\n"));
 311
 312   icmphdr = (struct icmp_echo_hdr *)q->payload;
 313   icmphdr->type = type;
 314   icmphdr->code = code;
 315   icmphdr->id = 0;
 316   icmphdr->seqno = 0;
 317
 318   /* copy fields from original packet */
 319   SMEMCPY((u8_t *)q->payload + sizeof(struct icmp_echo_hdr), (u8_t *)p->payload,
 320           IP_HLEN + ICMP_DEST_UNREACH_DATASIZE);
 321
 322   /* calculate checksum */
 323   icmphdr->chksum = 0;
 324   icmphdr->chksum = inet_chksum(icmphdr, q->len);
 325   ICMP_STATS_INC(icmp.xmit);
 326   /* increase number of messages attempted to send */
 327   snmp_inc_icmpoutmsgs();
 328   /* increase number of destination unreachable messages attempted to send */
 329   snmp_inc_icmpouttimeexcds();
 330   ip_output(q, NULL, &(iphdr->src), ICMP_TTL, 0, IP_PROTO_ICMP);
 331   pbuf_free(q);
 332 }
 333
 334 #endif /* LWIP_ICMP */