git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/lwIP_MCF5235_GCC/lwip/src/core/inet.c

   1 /*\r
   2  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.\r
   3  * All rights reserved.\r
   4  *\r
   5  * Redistribution and use in source and binary forms, with or without modification,\r
   6  * are permitted provided that the following conditions are met:\r
   7  *\r
   8  * 1. Redistributions of source code must retain the above copyright notice,\r
   9  *    this list of conditions and the following disclaimer.\r
  10  * 2. Redistributions in binary form must reproduce the above copyright notice,\r
  11  *    this list of conditions and the following disclaimer in the documentation\r
  12  *    and/or other materials provided with the distribution.\r
  13  * 3. The name of the author may not be used to endorse or promote products\r
  14  *    derived from this software without specific prior written permission.\r
  15  *\r
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED\r
  17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT\r
  19  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\r
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT\r
  21  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
  22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
  23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING\r
  24  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY\r
  25  * OF SUCH DAMAGE.\r
  26  *\r
  27  * This file is part of the lwIP TCP/IP stack.\r
  28  *\r
  29  * Author: Adam Dunkels <adam@sics.se>\r
  30  *\r
  31  */\r
  32 \r
  33 \r
  34 /* inet.c\r
  35  *\r
  36  * Functions common to all TCP/IP modules, such as the Internet checksum and the\r
  37  * byte order functions.\r
  38  *\r
  39  */\r
  40 \r
  41 \r
  42 #include "lwip/opt.h"\r
  43 \r
  44 #include "lwip/arch.h"\r
  45 \r
  46 #include "lwip/def.h"\r
  47 #include "lwip/inet.h"\r
  48 \r
  49 #include "lwip/sys.h"\r
  50 \r
  51 /* This is a reference implementation of the checksum algorithm, with the\r
  52  * aim of being simple, correct and fully portable. Checksumming is the\r
  53  * first thing you would want to optimize for your platform. You will\r
  54  * need to port it to your architecture and in your sys_arch.h:\r
  55  * \r
  56  * #define LWIP_CHKSUM <your_checksum_routine> \r
  57 */\r
  58 #ifndef LWIP_CHKSUM\r
  59 #define LWIP_CHKSUM lwip_standard_chksum\r
  60 \r
  61 /**\r
  62  * lwip checksum\r
  63  *\r
  64  * @param dataptr points to start of data to be summed at any boundary\r
  65  * @param len length of data to be summed\r
  66  * @return host order (!) lwip checksum (non-inverted Internet sum) \r
  67  *\r
  68  * @note accumulator size limits summable lenght to 64k\r
  69  * @note host endianess is irrelevant (p3 RFC1071)\r
  70  */\r
  71 static u16_t\r
  72 lwip_standard_chksum(void *dataptr, u16_t len)\r
  73 {\r
  74   u32_t acc;\r
  75   u16_t src;\r
  76   u8_t *octetptr;\r
  77 \r
  78   acc = 0;\r
  79   /* dataptr may be at odd or even addresses */\r
  80   octetptr = (u8_t*)dataptr;\r
  81   while (len > 1)\r
  82   {\r
  83     /* declare first octet as most significant\r
  84        thus assume network order, ignoring host order */\r
  85     src = (*octetptr) << 8;\r
  86     octetptr++;\r
  87     /* declare second octet as least significant */\r
  88     src |= (*octetptr);\r
  89     octetptr++;\r
  90     acc += src;\r
  91     len -= 2;\r
  92   }\r
  93   if (len > 0)\r
  94   {\r
  95     /* accumulate remaining octet */\r
  96     src = (*octetptr) << 8;\r
  97     acc += src;\r
  98   }\r
  99   /* add deferred carry bits */\r
 100   acc = (acc >> 16) + (acc & 0x0000ffffUL);\r
 101   if ((acc & 0xffff0000) != 0) {\r
 102     acc = (acc >> 16) + (acc & 0x0000ffffUL);\r
 103   }\r
 104   /* This maybe a little confusing: reorder sum using htons()\r
 105      instead of ntohs() since it has a little less call overhead.\r
 106      The caller must invert bits for Internet sum ! */\r
 107   return htons((u16_t)acc);\r
 108 }\r
 109 \r
 110 #endif\r
 111 \r
 112 #if 0\r
 113 /*\r
 114  * Curt McDowell\r
 115  * Broadcom Corp.\r
 116  * csm@broadcom.com\r
 117  *\r
 118  * IP checksum two bytes at a time with support for\r
 119  * unaligned buffer.\r
 120  * Works for len up to and including 0x20000.\r
 121  * by Curt McDowell, Broadcom Corp. 12/08/2005\r
 122  */\r
 123 \r
 124 static u16_t\r
 125 lwip_standard_chksum2(void *dataptr, int len)\r
 126 {\r
 127   u8_t *pb = dataptr;\r
 128   u16_t *ps, t = 0;\r
 129   u32_t sum = 0;\r
 130   int odd = ((u32_t)pb & 1);\r
 131 \r
 132   /* Get aligned to u16_t */\r
 133   if (odd && len > 0) {\r
 134     ((u8_t *)&t)[1] = *pb++;\r
 135     len--;\r
 136   }\r
 137 \r
 138   /* Add the bulk of the data */\r
 139   ps = (u16_t *)pb;\r
 140   while (len > 1) {\r
 141     sum += *ps++;\r
 142     len -= 2;\r
 143   }\r
 144 \r
 145   /* Consume left-over byte, if any */\r
 146   if (len > 0)\r
 147     ((u8_t *)&t)[0] = *(u8_t *)ps;;\r
 148 \r
 149   /* Add end bytes */\r
 150   sum += t;\r
 151 \r
 152   /*  Fold 32-bit sum to 16 bits */\r
 153   while (sum >> 16)\r
 154     sum = (sum & 0xffff) + (sum >> 16);\r
 155 \r
 156   /* Swap if alignment was odd */\r
 157   if (odd)\r
 158     sum = ((sum & 0xff) << 8) | ((sum & 0xff00) >> 8);\r
 159 \r
 160   return sum;\r
 161 }\r
 162 \r
 163 /**\r
 164  * An optimized checksum routine. Basically, it uses loop-unrolling on\r
 165  * the checksum loop, treating the head and tail bytes specially, whereas\r
 166  * the inner loop acts on 8 bytes at a time. \r
 167  *\r
 168  * @arg start of buffer to be checksummed. May be an odd byte address.\r
 169  * @len number of bytes in the buffer to be checksummed.\r
 170  * \r
 171  * @todo First argument type conflicts with generic checksum routine.\r
 172  * \r
 173  * by Curt McDowell, Broadcom Corp. December 8th, 2005\r
 174  */\r
 175 \r
 176 static u16_t\r
 177 lwip_standard_chksum4(u8_t *pb, int len)\r
 178 {\r
 179   u16_t *ps, t = 0;\r
 180   u32_t *pl;\r
 181   u32_t sum = 0, tmp;\r
 182   /* starts at odd byte address? */\r
 183   int odd = ((u32_t)pb & 1);\r
 184 \r
 185   if (odd && len > 0) {\r
 186     ((u8_t *)&t)[1] = *pb++;\r
 187     len--;\r
 188   }\r
 189 \r
 190   ps = (u16_t *)pb;\r
 191 \r
 192   if (((u32_t)ps & 3) && len > 1) {\r
 193     sum += *ps++;\r
 194     len -= 2;\r
 195   }\r
 196 \r
 197   pl = (u32_t *)ps;\r
 198 \r
 199   while (len > 7)  {\r
 200     tmp = sum + *pl++;          /* ping */\r
 201     if (tmp < sum)\r
 202       tmp++;                    /* add back carry */\r
 203 \r
 204     sum = tmp + *pl++;          /* pong */\r
 205     if (sum < tmp)\r
 206       sum++;                    /* add back carry */\r
 207 \r
 208     len -= 8;\r
 209   }\r
 210 \r
 211   /* make room in upper bits */\r
 212   sum = (sum >> 16) + (sum & 0xffff);\r
 213 \r
 214   ps = (u16_t *)pl;\r
 215 \r
 216   /* 16-bit aligned word remaining? */\r
 217   while (len > 1) {\r
 218     sum += *ps++;\r
 219     len -= 2;\r
 220   }\r
 221 \r
 222   /* dangling tail byte remaining? */\r
 223   if (len > 0)                  /* include odd byte */\r
 224     ((u8_t *)&t)[0] = *(u8_t *)ps;\r
 225 \r
 226   sum += t;                     /* add end bytes */\r
 227 \r
 228   while (sum >> 16)             /* combine halves */\r
 229     sum = (sum >> 16) + (sum & 0xffff);\r
 230 \r
 231   if (odd)\r
 232     sum = ((sum & 0xff) << 8) | ((sum & 0xff00) >> 8);\r
 233 \r
 234   return sum;\r
 235 }\r
 236 #endif\r
 237 \r
 238 /* inet_chksum_pseudo:\r
 239  *\r
 240  * Calculates the pseudo Internet checksum used by TCP and UDP for a pbuf chain.\r
 241  */\r
 242 \r
 243 u16_t\r
 244 inet_chksum_pseudo(struct pbuf *p,\r
 245        struct ip_addr *src, struct ip_addr *dest,\r
 246        u8_t proto, u16_t proto_len)\r
 247 {\r
 248   u32_t acc;\r
 249   struct pbuf *q;\r
 250   u8_t swapped;\r
 251 \r
 252   acc = 0;\r
 253   swapped = 0;\r
 254   /* iterate through all pbuf in chain */\r
 255   for(q = p; q != NULL; q = q->next) {\r
 256     LWIP_DEBUGF(INET_DEBUG, ("inet_chksum_pseudo(): checksumming pbuf %p (has next %p) \n",\r
 257       (void *)q, (void *)q->next));\r
 258     acc += LWIP_CHKSUM(q->payload, q->len);\r
 259     /*LWIP_DEBUGF(INET_DEBUG, ("inet_chksum_pseudo(): unwrapped lwip_chksum()=%"X32_F" \n", acc));*/\r
 260     while (acc >> 16) {\r
 261       acc = (acc & 0xffffUL) + (acc >> 16);\r
 262     }\r
 263     if (q->len % 2 != 0) {\r
 264       swapped = 1 - swapped;\r
 265       acc = ((acc & 0xff) << 8) | ((acc & 0xff00UL) >> 8);\r
 266     }\r
 267     /*LWIP_DEBUGF(INET_DEBUG, ("inet_chksum_pseudo(): wrapped lwip_chksum()=%"X32_F" \n", acc));*/\r
 268   }\r
 269 \r
 270   if (swapped) {\r
 271     acc = ((acc & 0xff) << 8) | ((acc & 0xff00UL) >> 8);\r
 272   }\r
 273   acc += (src->addr & 0xffffUL);\r
 274   acc += ((src->addr >> 16) & 0xffffUL);\r
 275   acc += (dest->addr & 0xffffUL);\r
 276   acc += ((dest->addr >> 16) & 0xffffUL);\r
 277   acc += (u32_t)htons((u16_t)proto);\r
 278   acc += (u32_t)htons(proto_len);\r
 279 \r
 280   while (acc >> 16) {\r
 281     acc = (acc & 0xffffUL) + (acc >> 16);\r
 282   }\r
 283   LWIP_DEBUGF(INET_DEBUG, ("inet_chksum_pseudo(): pbuf chain lwip_chksum()=%"X32_F"\n", acc));\r
 284   return (u16_t)~(acc & 0xffffUL);\r
 285 }\r
 286 \r
 287 /* inet_chksum:\r
 288  *\r
 289  * Calculates the Internet checksum over a portion of memory. Used primarely for IP\r
 290  * and ICMP.\r
 291  */\r
 292 \r
 293 u16_t\r
 294 inet_chksum(void *dataptr, u16_t len)\r
 295 {\r
 296   u32_t acc;\r
 297 \r
 298   acc = LWIP_CHKSUM(dataptr, len);\r
 299   while (acc >> 16) {\r
 300     acc = (acc & 0xffff) + (acc >> 16);\r
 301   }\r
 302   return (u16_t)~(acc & 0xffff);\r
 303 }\r
 304 \r
 305 u16_t\r
 306 inet_chksum_pbuf(struct pbuf *p)\r
 307 {\r
 308   u32_t acc;\r
 309   struct pbuf *q;\r
 310   u8_t swapped;\r
 311 \r
 312   acc = 0;\r
 313   swapped = 0;\r
 314   for(q = p; q != NULL; q = q->next) {\r
 315     acc += LWIP_CHKSUM(q->payload, q->len);\r
 316     while (acc >> 16) {\r
 317       acc = (acc & 0xffffUL) + (acc >> 16);\r
 318     }\r
 319     if (q->len % 2 != 0) {\r
 320       swapped = 1 - swapped;\r
 321       acc = (acc & 0x00ffUL << 8) | (acc & 0xff00UL >> 8);\r
 322     }\r
 323   }\r
 324 \r
 325   if (swapped) {\r
 326     acc = ((acc & 0x00ffUL) << 8) | ((acc & 0xff00UL) >> 8);\r
 327   }\r
 328   return (u16_t)~(acc & 0xffffUL);\r
 329 }\r
 330 \r
 331 /* Here for now until needed in other places in lwIP */\r
 332 #ifndef isascii\r
 333 #define in_range(c, lo, up)  ((u8_t)c >= lo && (u8_t)c <= up)\r
 334 #define isascii(c)           in_range(c, 0x20, 0x7f)\r
 335 #define isdigit(c)           in_range(c, '0', '9')\r
 336 #define isxdigit(c)          (isdigit(c) || in_range(c, 'a', 'f') || in_range(c, 'A', 'F'))\r
 337 #define islower(c)           in_range(c, 'a', 'z')\r
 338 #define isspace(c)           (c == ' ' || c == '\f' || c == '\n' || c == '\r' || c == '\t' || c == '\v')\r
 339 #endif          \r
 340                 \r
 341 \r
 342  /*\r
 343   * Ascii internet address interpretation routine.\r
 344   * The value returned is in network order.\r
 345   */\r
 346 \r
 347  /*  */\r
 348  /* inet_addr */\r
 349  u32_t inet_addr(const char *cp)\r
 350  {\r
 351      struct in_addr val;\r
 352 \r
 353      if (inet_aton(cp, &val)) {\r
 354          return (val.s_addr);\r
 355      }\r
 356      return (INADDR_NONE);\r
 357  }\r
 358 \r
 359  /*\r
 360   * Check whether "cp" is a valid ascii representation\r
 361   * of an Internet address and convert to a binary address.\r
 362   * Returns 1 if the address is valid, 0 if not.\r
 363   * This replaces inet_addr, the return value from which\r
 364   * cannot distinguish between failure and a local broadcast address.\r
 365   */\r
 366  /*  */\r
 367  /* inet_aton */\r
 368  s8_t\r
 369  inet_aton(const char *cp, struct in_addr *addr)\r
 370  {\r
 371      u32_t val;\r
 372      s32_t base, n;\r
 373      char c;\r
 374      u32_t parts[4];\r
 375      u32_t* pp = parts;\r
 376 \r
 377      c = *cp;\r
 378      for (;;) {\r
 379          /*\r
 380           * Collect number up to ``.''.\r
 381           * Values are specified as for C:\r
 382           * 0x=hex, 0=octal, isdigit=decimal.\r
 383           */\r
 384          if (!isdigit(c))\r
 385              return (0);\r
 386          val = 0; base = 10;\r
 387          if (c == '0') {\r
 388              c = *++cp;\r
 389              if (c == 'x' || c == 'X')\r
 390                  base = 16, c = *++cp;\r
 391              else\r
 392                  base = 8;\r
 393          }\r
 394          for (;;) {\r
 395              if (isdigit(c)) {\r
 396                  val = (val * base) + (s16_t)(c - '0');\r
 397                  c = *++cp;\r
 398              } else if (base == 16 && isxdigit(c)) {\r
 399                  val = (val << 4) |\r
 400                      (s16_t)(c + 10 - (islower(c) ? 'a' : 'A'));\r
 401                  c = *++cp;\r
 402              } else\r
 403              break;\r
 404          }\r
 405          if (c == '.') {\r
 406              /*\r
 407               * Internet format:\r
 408               *  a.b.c.d\r
 409               *  a.b.c   (with c treated as 16 bits)\r
 410               *  a.b (with b treated as 24 bits)\r
 411               */\r
 412              if (pp >= parts + 3)\r
 413                  return (0);\r
 414              *pp++ = val;\r
 415              c = *++cp;\r
 416          } else\r
 417              break;\r
 418      }\r
 419      /*\r
 420       * Check for trailing characters.\r
 421       */\r
 422      if (c != '\0' && (!isascii(c) || !isspace(c)))\r
 423          return (0);\r
 424      /*\r
 425       * Concoct the address according to\r
 426       * the number of parts specified.\r
 427       */\r
 428      n = pp - parts + 1;\r
 429      switch (n) {\r
 430 \r
 431      case 0:\r
 432          return (0);     /* initial nondigit */\r
 433 \r
 434      case 1:             /* a -- 32 bits */\r
 435          break;\r
 436 \r
 437      case 2:             /* a.b -- 8.24 bits */\r
 438          if (val > 0xffffff)\r
 439              return (0);\r
 440          val |= parts[0] << 24;\r
 441          break;\r
 442 \r
 443      case 3:             /* a.b.c -- 8.8.16 bits */\r
 444          if (val > 0xffff)\r
 445              return (0);\r
 446          val |= (parts[0] << 24) | (parts[1] << 16);\r
 447          break;\r
 448 \r
 449      case 4:             /* a.b.c.d -- 8.8.8.8 bits */\r
 450          if (val > 0xff)\r
 451              return (0);\r
 452          val |= (parts[0] << 24) | (parts[1] << 16) | (parts[2] << 8);\r
 453          break;\r
 454      }\r
 455      if (addr)\r
 456          addr->s_addr = htonl(val);\r
 457      return (1);\r
 458  }\r
 459 \r
 460 /* Convert numeric IP address into decimal dotted ASCII representation.\r
 461  * returns ptr to static buffer; not reentrant!\r
 462  */\r
 463 char *inet_ntoa(struct in_addr addr)\r
 464 {\r
 465   static char str[16];\r
 466   u32_t s_addr = addr.s_addr;\r
 467   char inv[3];\r
 468   char *rp;\r
 469   u8_t *ap;\r
 470   u8_t rem;\r
 471   u8_t n;\r
 472   u8_t i;\r
 473 \r
 474   rp = str;\r
 475   ap = (u8_t *)&s_addr;\r
 476   for(n = 0; n < 4; n++) {\r
 477     i = 0;\r
 478     do {\r
 479       rem = *ap % (u8_t)10;\r
 480       *ap /= (u8_t)10;\r
 481       inv[i++] = '0' + rem;\r
 482     } while(*ap);\r
 483     while(i--)\r
 484       *rp++ = inv[i];\r
 485     *rp++ = '.';\r
 486     ap++;\r
 487   }\r
 488   *--rp = 0;\r
 489   return str;\r
 490 }\r
 491 \r
 492 \r
 493 #ifndef BYTE_ORDER\r
 494 #error BYTE_ORDER is not defined\r
 495 #endif\r
 496 #if BYTE_ORDER == LITTLE_ENDIAN\r
 497 \r
 498 u16_t\r
 499 htons(u16_t n)\r
 500 {\r
 501   return ((n & 0xff) << 8) | ((n & 0xff00) >> 8);\r
 502 }\r
 503 \r
 504 u16_t\r
 505 ntohs(u16_t n)\r
 506 {\r
 507   return htons(n);\r
 508 }\r
 509 \r
 510 u32_t\r
 511 htonl(u32_t n)\r
 512 {\r
 513   return ((n & 0xff) << 24) |\r
 514     ((n & 0xff00) << 8) |\r
 515     ((n & 0xff0000) >> 8) |\r
 516     ((n & 0xff000000) >> 24);\r
 517 }\r
 518 \r
 519 u32_t\r
 520 ntohl(u32_t n)\r
 521 {\r
 522   return htonl(n);\r
 523 }\r
 524 \r
 525 #endif /* BYTE_ORDER == LITTLE_ENDIAN */\r