nuclear@26: /* crc32.c -- compute the CRC-32 of a data stream nuclear@26: * Copyright (C) 1995-2005 Mark Adler nuclear@26: * For conditions of distribution and use, see copyright notice in zlib.h nuclear@26: * nuclear@26: * Thanks to Rodney Brown for his contribution of faster nuclear@26: * CRC methods: exclusive-oring 32 bits of data at a time, and pre-computing nuclear@26: * tables for updating the shift register in one step with three exclusive-ors nuclear@26: * instead of four steps with four exclusive-ors. This results in about a nuclear@26: * factor of two increase in speed on a Power PC G4 (PPC7455) using gcc -O3. nuclear@26: */ nuclear@26: nuclear@26: /* @(#) $Id$ */ nuclear@26: nuclear@26: /* nuclear@26: Note on the use of DYNAMIC_CRC_TABLE: there is no mutex or semaphore nuclear@26: protection on the static variables used to control the first-use generation nuclear@26: of the crc tables. Therefore, if you #define DYNAMIC_CRC_TABLE, you should nuclear@26: first call get_crc_table() to initialize the tables before allowing more than nuclear@26: one thread to use crc32(). nuclear@26: */ nuclear@26: nuclear@26: #ifdef MAKECRCH nuclear@26: # include nuclear@26: # ifndef DYNAMIC_CRC_TABLE nuclear@26: # define DYNAMIC_CRC_TABLE nuclear@26: # endif /* !DYNAMIC_CRC_TABLE */ nuclear@26: #endif /* MAKECRCH */ nuclear@26: nuclear@26: #include "zutil.h" /* for STDC and FAR definitions */ nuclear@26: nuclear@26: #define local static nuclear@26: nuclear@26: /* Find a four-byte integer type for crc32_little() and crc32_big(). */ nuclear@26: #ifndef NOBYFOUR nuclear@26: # ifdef STDC /* need ANSI C limits.h to determine sizes */ nuclear@26: # include nuclear@26: # define BYFOUR nuclear@26: # if (UINT_MAX == 0xffffffffUL) nuclear@26: typedef unsigned int u4; nuclear@26: # else nuclear@26: # if (ULONG_MAX == 0xffffffffUL) nuclear@26: typedef unsigned long u4; nuclear@26: # else nuclear@26: # if (USHRT_MAX == 0xffffffffUL) nuclear@26: typedef unsigned short u4; nuclear@26: # else nuclear@26: # undef BYFOUR /* can't find a four-byte integer type! */ nuclear@26: # endif nuclear@26: # endif nuclear@26: # endif nuclear@26: # endif /* STDC */ nuclear@26: #endif /* !NOBYFOUR */ nuclear@26: nuclear@26: /* Definitions for doing the crc four data bytes at a time. */ nuclear@26: #ifdef BYFOUR nuclear@26: # define REV(w) (((w)>>24)+(((w)>>8)&0xff00)+ \ nuclear@26: (((w)&0xff00)<<8)+(((w)&0xff)<<24)) nuclear@26: local unsigned long crc32_little OF((unsigned long, nuclear@26: const unsigned char FAR *, unsigned)); nuclear@26: local unsigned long crc32_big OF((unsigned long, nuclear@26: const unsigned char FAR *, unsigned)); nuclear@26: # define TBLS 8 nuclear@26: #else nuclear@26: # define TBLS 1 nuclear@26: #endif /* BYFOUR */ nuclear@26: nuclear@26: /* Local functions for crc concatenation */ nuclear@26: local unsigned long gf2_matrix_times OF((unsigned long *mat, nuclear@26: unsigned long vec)); nuclear@26: local void gf2_matrix_square OF((unsigned long *square, unsigned long *mat)); nuclear@26: nuclear@26: #ifdef DYNAMIC_CRC_TABLE nuclear@26: nuclear@26: local volatile int crc_table_empty = 1; nuclear@26: local unsigned long FAR crc_table[TBLS][256]; nuclear@26: local void make_crc_table OF((void)); nuclear@26: #ifdef MAKECRCH nuclear@26: local void write_table OF((FILE *, const unsigned long FAR *)); nuclear@26: #endif /* MAKECRCH */ nuclear@26: /* nuclear@26: Generate tables for a byte-wise 32-bit CRC calculation on the polynomial: nuclear@26: x^32+x^26+x^23+x^22+x^16+x^12+x^11+x^10+x^8+x^7+x^5+x^4+x^2+x+1. nuclear@26: nuclear@26: Polynomials over GF(2) are represented in binary, one bit per coefficient, nuclear@26: with the lowest powers in the most significant bit. Then adding polynomials nuclear@26: is just exclusive-or, and multiplying a polynomial by x is a right shift by nuclear@26: one. If we call the above polynomial p, and represent a byte as the nuclear@26: polynomial q, also with the lowest power in the most significant bit (so the nuclear@26: byte 0xb1 is the polynomial x^7+x^3+x+1), then the CRC is (q*x^32) mod p, nuclear@26: where a mod b means the remainder after dividing a by b. nuclear@26: nuclear@26: This calculation is done using the shift-register method of multiplying and nuclear@26: taking the remainder. The register is initialized to zero, and for each nuclear@26: incoming bit, x^32 is added mod p to the register if the bit is a one (where nuclear@26: x^32 mod p is p+x^32 = x^26+...+1), and the register is multiplied mod p by nuclear@26: x (which is shifting right by one and adding x^32 mod p if the bit shifted nuclear@26: out is a one). We start with the highest power (least significant bit) of nuclear@26: q and repeat for all eight bits of q. nuclear@26: nuclear@26: The first table is simply the CRC of all possible eight bit values. This is nuclear@26: all the information needed to generate CRCs on data a byte at a time for all nuclear@26: combinations of CRC register values and incoming bytes. The remaining tables nuclear@26: allow for word-at-a-time CRC calculation for both big-endian and little- nuclear@26: endian machines, where a word is four bytes. nuclear@26: */ nuclear@26: local void make_crc_table() nuclear@26: { nuclear@26: unsigned long c; nuclear@26: int n, k; nuclear@26: unsigned long poly; /* polynomial exclusive-or pattern */ nuclear@26: /* terms of polynomial defining this crc (except x^32): */ nuclear@26: static volatile int first = 1; /* flag to limit concurrent making */ nuclear@26: static const unsigned char p[] = {0,1,2,4,5,7,8,10,11,12,16,22,23,26}; nuclear@26: nuclear@26: /* See if another task is already doing this (not thread-safe, but better nuclear@26: than nothing -- significantly reduces duration of vulnerability in nuclear@26: case the advice about DYNAMIC_CRC_TABLE is ignored) */ nuclear@26: if (first) { nuclear@26: first = 0; nuclear@26: nuclear@26: /* make exclusive-or pattern from polynomial (0xedb88320UL) */ nuclear@26: poly = 0UL; nuclear@26: for (n = 0; n < sizeof(p)/sizeof(unsigned char); n++) nuclear@26: poly |= 1UL << (31 - p[n]); nuclear@26: nuclear@26: /* generate a crc for every 8-bit value */ nuclear@26: for (n = 0; n < 256; n++) { nuclear@26: c = (unsigned long)n; nuclear@26: for (k = 0; k < 8; k++) nuclear@26: c = c & 1 ? poly ^ (c >> 1) : c >> 1; nuclear@26: crc_table[0][n] = c; nuclear@26: } nuclear@26: nuclear@26: #ifdef BYFOUR nuclear@26: /* generate crc for each value followed by one, two, and three zeros, nuclear@26: and then the byte reversal of those as well as the first table */ nuclear@26: for (n = 0; n < 256; n++) { nuclear@26: c = crc_table[0][n]; nuclear@26: crc_table[4][n] = REV(c); nuclear@26: for (k = 1; k < 4; k++) { nuclear@26: c = crc_table[0][c & 0xff] ^ (c >> 8); nuclear@26: crc_table[k][n] = c; nuclear@26: crc_table[k + 4][n] = REV(c); nuclear@26: } nuclear@26: } nuclear@26: #endif /* BYFOUR */ nuclear@26: nuclear@26: crc_table_empty = 0; nuclear@26: } nuclear@26: else { /* not first */ nuclear@26: /* wait for the other guy to finish (not efficient, but rare) */ nuclear@26: while (crc_table_empty) nuclear@26: ; nuclear@26: } nuclear@26: nuclear@26: #ifdef MAKECRCH nuclear@26: /* write out CRC tables to crc32.h */ nuclear@26: { nuclear@26: FILE *out; nuclear@26: nuclear@26: out = fopen("crc32.h", "w"); nuclear@26: if (out == NULL) return; nuclear@26: fprintf(out, "/* crc32.h -- tables for rapid CRC calculation\n"); nuclear@26: fprintf(out, " * Generated automatically by crc32.c\n */\n\n"); nuclear@26: fprintf(out, "local const unsigned long FAR "); nuclear@26: fprintf(out, "crc_table[TBLS][256] =\n{\n {\n"); nuclear@26: write_table(out, crc_table[0]); nuclear@26: # ifdef BYFOUR nuclear@26: fprintf(out, "#ifdef BYFOUR\n"); nuclear@26: for (k = 1; k < 8; k++) { nuclear@26: fprintf(out, " },\n {\n"); nuclear@26: write_table(out, crc_table[k]); nuclear@26: } nuclear@26: fprintf(out, "#endif\n"); nuclear@26: # endif /* BYFOUR */ nuclear@26: fprintf(out, " }\n};\n"); nuclear@26: fclose(out); nuclear@26: } nuclear@26: #endif /* MAKECRCH */ nuclear@26: } nuclear@26: nuclear@26: #ifdef MAKECRCH nuclear@26: local void write_table(out, table) nuclear@26: FILE *out; nuclear@26: const unsigned long FAR *table; nuclear@26: { nuclear@26: int n; nuclear@26: nuclear@26: for (n = 0; n < 256; n++) nuclear@26: fprintf(out, "%s0x%08lxUL%s", n % 5 ? "" : " ", table[n], nuclear@26: n == 255 ? "\n" : (n % 5 == 4 ? ",\n" : ", ")); nuclear@26: } nuclear@26: #endif /* MAKECRCH */ nuclear@26: nuclear@26: #else /* !DYNAMIC_CRC_TABLE */ nuclear@26: /* ======================================================================== nuclear@26: * Tables of CRC-32s of all single-byte values, made by make_crc_table(). nuclear@26: */ nuclear@26: #include "crc32.h" nuclear@26: #endif /* DYNAMIC_CRC_TABLE */ nuclear@26: nuclear@26: /* ========================================================================= nuclear@26: * This function can be used by asm versions of crc32() nuclear@26: */ nuclear@26: const unsigned long FAR * ZEXPORT get_crc_table() nuclear@26: { nuclear@26: #ifdef DYNAMIC_CRC_TABLE nuclear@26: if (crc_table_empty) nuclear@26: make_crc_table(); nuclear@26: #endif /* DYNAMIC_CRC_TABLE */ nuclear@26: return (const unsigned long FAR *)crc_table; nuclear@26: } nuclear@26: nuclear@26: /* ========================================================================= */ nuclear@26: #define DO1 crc = crc_table[0][((int)crc ^ (*buf++)) & 0xff] ^ (crc >> 8) nuclear@26: #define DO8 DO1; DO1; DO1; DO1; DO1; DO1; DO1; DO1 nuclear@26: nuclear@26: /* ========================================================================= */ nuclear@26: unsigned long ZEXPORT crc32(crc, buf, len) nuclear@26: unsigned long crc; nuclear@26: const unsigned char FAR *buf; nuclear@26: unsigned len; nuclear@26: { nuclear@26: if (buf == Z_NULL) return 0UL; nuclear@26: nuclear@26: #ifdef DYNAMIC_CRC_TABLE nuclear@26: if (crc_table_empty) nuclear@26: make_crc_table(); nuclear@26: #endif /* DYNAMIC_CRC_TABLE */ nuclear@26: nuclear@26: #ifdef BYFOUR nuclear@26: if (sizeof(void *) == sizeof(ptrdiff_t)) { nuclear@26: u4 endian; nuclear@26: nuclear@26: endian = 1; nuclear@26: if (*((unsigned char *)(&endian))) nuclear@26: return crc32_little(crc, buf, len); nuclear@26: else nuclear@26: return crc32_big(crc, buf, len); nuclear@26: } nuclear@26: #endif /* BYFOUR */ nuclear@26: crc = crc ^ 0xffffffffUL; nuclear@26: while (len >= 8) { nuclear@26: DO8; nuclear@26: len -= 8; nuclear@26: } nuclear@26: if (len) do { nuclear@26: DO1; nuclear@26: } while (--len); nuclear@26: return crc ^ 0xffffffffUL; nuclear@26: } nuclear@26: nuclear@26: #ifdef BYFOUR nuclear@26: nuclear@26: /* ========================================================================= */ nuclear@26: #define DOLIT4 c ^= *buf4++; \ nuclear@26: c = crc_table[3][c & 0xff] ^ crc_table[2][(c >> 8) & 0xff] ^ \ nuclear@26: crc_table[1][(c >> 16) & 0xff] ^ crc_table[0][c >> 24] nuclear@26: #define DOLIT32 DOLIT4; DOLIT4; DOLIT4; DOLIT4; DOLIT4; DOLIT4; DOLIT4; DOLIT4 nuclear@26: nuclear@26: /* ========================================================================= */ nuclear@26: local unsigned long crc32_little(crc, buf, len) nuclear@26: unsigned long crc; nuclear@26: const unsigned char FAR *buf; nuclear@26: unsigned len; nuclear@26: { nuclear@26: register u4 c; nuclear@26: register const u4 FAR *buf4; nuclear@26: nuclear@26: c = (u4)crc; nuclear@26: c = ~c; nuclear@26: while (len && ((ptrdiff_t)buf & 3)) { nuclear@26: c = crc_table[0][(c ^ *buf++) & 0xff] ^ (c >> 8); nuclear@26: len--; nuclear@26: } nuclear@26: nuclear@26: buf4 = (const u4 FAR *)(const void FAR *)buf; nuclear@26: while (len >= 32) { nuclear@26: DOLIT32; nuclear@26: len -= 32; nuclear@26: } nuclear@26: while (len >= 4) { nuclear@26: DOLIT4; nuclear@26: len -= 4; nuclear@26: } nuclear@26: buf = (const unsigned char FAR *)buf4; nuclear@26: nuclear@26: if (len) do { nuclear@26: c = crc_table[0][(c ^ *buf++) & 0xff] ^ (c >> 8); nuclear@26: } while (--len); nuclear@26: c = ~c; nuclear@26: return (unsigned long)c; nuclear@26: } nuclear@26: nuclear@26: /* ========================================================================= */ nuclear@26: #define DOBIG4 c ^= *++buf4; \ nuclear@26: c = crc_table[4][c & 0xff] ^ crc_table[5][(c >> 8) & 0xff] ^ \ nuclear@26: crc_table[6][(c >> 16) & 0xff] ^ crc_table[7][c >> 24] nuclear@26: #define DOBIG32 DOBIG4; DOBIG4; DOBIG4; DOBIG4; DOBIG4; DOBIG4; DOBIG4; DOBIG4 nuclear@26: nuclear@26: /* ========================================================================= */ nuclear@26: local unsigned long crc32_big(crc, buf, len) nuclear@26: unsigned long crc; nuclear@26: const unsigned char FAR *buf; nuclear@26: unsigned len; nuclear@26: { nuclear@26: register u4 c; nuclear@26: register const u4 FAR *buf4; nuclear@26: nuclear@26: c = REV((u4)crc); nuclear@26: c = ~c; nuclear@26: while (len && ((ptrdiff_t)buf & 3)) { nuclear@26: c = crc_table[4][(c >> 24) ^ *buf++] ^ (c << 8); nuclear@26: len--; nuclear@26: } nuclear@26: nuclear@26: buf4 = (const u4 FAR *)(const void FAR *)buf; nuclear@26: buf4--; nuclear@26: while (len >= 32) { nuclear@26: DOBIG32; nuclear@26: len -= 32; nuclear@26: } nuclear@26: while (len >= 4) { nuclear@26: DOBIG4; nuclear@26: len -= 4; nuclear@26: } nuclear@26: buf4++; nuclear@26: buf = (const unsigned char FAR *)buf4; nuclear@26: nuclear@26: if (len) do { nuclear@26: c = crc_table[4][(c >> 24) ^ *buf++] ^ (c << 8); nuclear@26: } while (--len); nuclear@26: c = ~c; nuclear@26: return (unsigned long)(REV(c)); nuclear@26: } nuclear@26: nuclear@26: #endif /* BYFOUR */ nuclear@26: nuclear@26: #define GF2_DIM 32 /* dimension of GF(2) vectors (length of CRC) */ nuclear@26: nuclear@26: /* ========================================================================= */ nuclear@26: local unsigned long gf2_matrix_times(mat, vec) nuclear@26: unsigned long *mat; nuclear@26: unsigned long vec; nuclear@26: { nuclear@26: unsigned long sum; nuclear@26: nuclear@26: sum = 0; nuclear@26: while (vec) { nuclear@26: if (vec & 1) nuclear@26: sum ^= *mat; nuclear@26: vec >>= 1; nuclear@26: mat++; nuclear@26: } nuclear@26: return sum; nuclear@26: } nuclear@26: nuclear@26: /* ========================================================================= */ nuclear@26: local void gf2_matrix_square(square, mat) nuclear@26: unsigned long *square; nuclear@26: unsigned long *mat; nuclear@26: { nuclear@26: int n; nuclear@26: nuclear@26: for (n = 0; n < GF2_DIM; n++) nuclear@26: square[n] = gf2_matrix_times(mat, mat[n]); nuclear@26: } nuclear@26: nuclear@26: /* ========================================================================= */ nuclear@26: uLong ZEXPORT crc32_combine(crc1, crc2, len2) nuclear@26: uLong crc1; nuclear@26: uLong crc2; nuclear@26: z_off_t len2; nuclear@26: { nuclear@26: int n; nuclear@26: unsigned long row; nuclear@26: unsigned long even[GF2_DIM]; /* even-power-of-two zeros operator */ nuclear@26: unsigned long odd[GF2_DIM]; /* odd-power-of-two zeros operator */ nuclear@26: nuclear@26: /* degenerate case */ nuclear@26: if (len2 == 0) nuclear@26: return crc1; nuclear@26: nuclear@26: /* put operator for one zero bit in odd */ nuclear@26: odd[0] = 0xedb88320L; /* CRC-32 polynomial */ nuclear@26: row = 1; nuclear@26: for (n = 1; n < GF2_DIM; n++) { nuclear@26: odd[n] = row; nuclear@26: row <<= 1; nuclear@26: } nuclear@26: nuclear@26: /* put operator for two zero bits in even */ nuclear@26: gf2_matrix_square(even, odd); nuclear@26: nuclear@26: /* put operator for four zero bits in odd */ nuclear@26: gf2_matrix_square(odd, even); nuclear@26: nuclear@26: /* apply len2 zeros to crc1 (first square will put the operator for one nuclear@26: zero byte, eight zero bits, in even) */ nuclear@26: do { nuclear@26: /* apply zeros operator for this bit of len2 */ nuclear@26: gf2_matrix_square(even, odd); nuclear@26: if (len2 & 1) nuclear@26: crc1 = gf2_matrix_times(even, crc1); nuclear@26: len2 >>= 1; nuclear@26: nuclear@26: /* if no more bits set, then done */ nuclear@26: if (len2 == 0) nuclear@26: break; nuclear@26: nuclear@26: /* another iteration of the loop with odd and even swapped */ nuclear@26: gf2_matrix_square(odd, even); nuclear@26: if (len2 & 1) nuclear@26: crc1 = gf2_matrix_times(odd, crc1); nuclear@26: len2 >>= 1; nuclear@26: nuclear@26: /* if no more bits set, then done */ nuclear@26: } while (len2 != 0); nuclear@26: nuclear@26: /* return combined crc */ nuclear@26: crc1 ^= crc2; nuclear@26: return crc1; nuclear@26: }