epan/in_cksum.c

   1 /* in_cksum.c
   2  * 4.4-Lite-2 Internet checksum routine, modified to take a vector of
   3  * pointers/lengths giving the pieces to be checksummed.  Also using
   4  * Tahoe/CGI version of ADDCARRY(x) macro instead of from portable version.
   5  *
   6  * Copyright (c) 1988, 1992, 1993
   7  *      The Regents of the University of California.  All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)in_cksum.c  8.1 (Berkeley) 6/10/93
  34  */
  35
  36 #include "config.h"
  37
  38 #include <glib.h>
  39
  40 #include <epan/in_cksum.h>
  41
  42 /*
  43  * Checksum routine for Internet Protocol family headers (Portable Version).
  44  *
  45  * This routine is very heavily used in the network
  46  * code and should be modified for each CPU to be as fast as possible.
  47  */
  48
  49 #define ADDCARRY(x)  {if ((x) > 65535) (x) -= 65535;}
  50 #define REDUCE {l_util.l = sum; sum = l_util.s[0] + l_util.s[1]; ADDCARRY(sum);}
  51
  52 int
  53 in_cksum(const vec_t *vec, int veclen)
  54 {
  55         register const guint16 *w;
  56         register int sum = 0;
  57         register int mlen = 0;
  58         int byte_swapped = 0;
  59
  60         union {
  61                 guint8  c[2];
  62                 guint16 s;
  63         } s_util;
  64         union {
  65                 guint16 s[2];
  66                 guint32 l;
  67         } l_util;
  68
  69         for (; veclen != 0; vec++, veclen--) {
  70                 if (vec->len == 0)
  71                         continue;
  72                 w = (const guint16 *)(const void *)vec->ptr;
  73                 if (mlen == -1) {
  74                         /*
  75                          * The first byte of this chunk is the continuation
  76                          * of a word spanning between this chunk and the
  77                          * last chunk.
  78                          *
  79                          * s_util.c[0] is already saved when scanning previous
  80                          * chunk.
  81                          */
  82                         s_util.c[1] = *(const guint8 *)w;
  83                         sum += s_util.s;
  84                         w = (const guint16 *)(const void *)((const guint8 *)w + 1);
  85                         mlen = vec->len - 1;
  86                 } else
  87                         mlen = vec->len;
  88                 /*
  89                  * Force to even boundary.
  90                  */
  91                 if ((1 & (unsigned long) w) && (mlen > 0)) {
  92                         REDUCE;
  93                         sum <<= 8;
  94                         s_util.c[0] = *(const guint8 *)w;
  95                         w = (const guint16 *)(const void *)((const guint8 *)w + 1);
  96                         mlen--;
  97                         byte_swapped = 1;
  98                 }
  99                 /*
 100                  * Unroll the loop to make overhead from
 101                  * branches &c small.
 102                  */
 103                 while ((mlen -= 32) >= 0) {
 104                         sum += w[0]; sum += w[1]; sum += w[2]; sum += w[3];
 105                         sum += w[4]; sum += w[5]; sum += w[6]; sum += w[7];
 106                         sum += w[8]; sum += w[9]; sum += w[10]; sum += w[11];
 107                         sum += w[12]; sum += w[13]; sum += w[14]; sum += w[15];
 108                         w += 16;
 109                 }
 110                 mlen += 32;
 111                 while ((mlen -= 8) >= 0) {
 112                         sum += w[0]; sum += w[1]; sum += w[2]; sum += w[3];
 113                         w += 4;
 114                 }
 115                 mlen += 8;
 116                 if (mlen == 0 && byte_swapped == 0)
 117                         continue;
 118                 REDUCE;
 119                 while ((mlen -= 2) >= 0) {
 120                         sum += *w++;
 121                 }
 122                 if (byte_swapped) {
 123                         REDUCE;
 124                         sum <<= 8;
 125                         byte_swapped = 0;
 126                         if (mlen == -1) {
 127                                 s_util.c[1] = *(const guint8 *)w;
 128                                 sum += s_util.s;
 129                                 mlen = 0;
 130                         } else
 131                                 mlen = -1;
 132                 } else if (mlen == -1)
 133                         s_util.c[0] = *(const guint8 *)w;
 134         }
 135         if (mlen == -1) {
 136                 /* The last mbuf has odd # of bytes. Follow the
 137                    standard (the odd byte may be shifted left by 8 bits
 138                    or not as determined by endian-ness of the machine) */
 139                 s_util.c[1] = 0;
 140                 sum += s_util.s;
 141         }
 142         REDUCE;
 143         return (~sum & 0xffff);
 144 }
 145
 146 /*
 147  * Given the host-byte-order value of the checksum field in a packet
 148  * header, and the network-byte-order computed checksum of the data
 149  * that the checksum covers (including the checksum itself), compute
 150  * what the checksum field *should* have been.
 151  */
 152 guint16
 153 in_cksum_shouldbe(guint16 sum, guint16 computed_sum)
 154 {
 155         guint32 shouldbe;
 156
 157         /*
 158          * The value that should have gone into the checksum field
 159          * is the negative of the value gotten by summing up everything
 160          * *but* the checksum field.
 161          *
 162          * We can compute that by subtracting the value of the checksum
 163          * field from the sum of all the data in the packet, and then
 164          * computing the negative of that value.
 165          *
 166          * "sum" is the value of the checksum field, and "computed_sum"
 167          * is the negative of the sum of all the data in the packets,
 168          * so that's -(-computed_sum - sum), or (sum + computed_sum).
 169          *
 170          * All the arithmetic in question is one's complement, so the
 171          * addition must include an end-around carry; we do this by
 172          * doing the arithmetic in 32 bits (with no sign-extension),
 173          * and then adding the upper 16 bits of the sum, which contain
 174          * the carry, to the lower 16 bits of the sum, and then do it
 175          * again in case *that* sum produced a carry.
 176          *
 177          * As RFC 1071 notes, the checksum can be computed without
 178          * byte-swapping the 16-bit words; summing 16-bit words
 179          * on a big-endian machine gives a big-endian checksum, which
 180          * can be directly stuffed into the big-endian checksum fields
 181          * in protocol headers, and summing words on a little-endian
 182          * machine gives a little-endian checksum, which must be
 183          * byte-swapped before being stuffed into a big-endian checksum
 184          * field.
 185          *
 186          * "computed_sum" is a network-byte-order value, so we must put
 187          * it in host byte order before subtracting it from the
 188          * host-byte-order value from the header; the adjusted checksum
 189          * will be in host byte order, which is what we'll return.
 190          */
 191         shouldbe = sum;
 192         shouldbe += g_ntohs(computed_sum);
 193         shouldbe = (shouldbe & 0xFFFF) + (shouldbe >> 16);
 194         shouldbe = (shouldbe & 0xFFFF) + (shouldbe >> 16);
 195         return shouldbe;
 196 }