...
Run Format

Source file src/hash/crc32/crc32_test.go

Documentation: hash/crc32

     1  // Copyright 2009 The Go Authors. All rights reserved.
     2  // Use of this source code is governed by a BSD-style
     3  // license that can be found in the LICENSE file.
     4  
     5  package crc32
     6  
     7  import (
     8  	"encoding"
     9  	"fmt"
    10  	"hash"
    11  	"io"
    12  	"math/rand"
    13  	"testing"
    14  )
    15  
    16  type test struct {
    17  	ieee, castagnoli    uint32
    18  	in                  string
    19  	halfStateIEEE       string // IEEE marshaled hash state after first half of in written, used by TestGoldenMarshal
    20  	halfStateCastagnoli string // Castagnoli marshaled hash state after first half of in written, used by TestGoldenMarshal
    21  }
    22  
    23  var golden = []test{
    24  	{0x0, 0x0, "", "crc\x01ʇ\x91M\x00\x00\x00\x00", "crc\x01wB\x84\x81\x00\x00\x00\x00"},
    25  	{0xe8b7be43, 0xc1d04330, "a", "crc\x01ʇ\x91M\x00\x00\x00\x00", "crc\x01wB\x84\x81\x00\x00\x00\x00"},
    26  	{0x9e83486d, 0xe2a22936, "ab", "crc\x01ʇ\x91M跾C", "crc\x01wB\x84\x81\xc1\xd0C0"},
    27  	{0x352441c2, 0x364b3fb7, "abc", "crc\x01ʇ\x91M跾C", "crc\x01wB\x84\x81\xc1\xd0C0"},
    28  	{0xed82cd11, 0x92c80a31, "abcd", "crc\x01ʇ\x91M\x9e\x83Hm", "crc\x01wB\x84\x81\xe2\xa2)6"},
    29  	{0x8587d865, 0xc450d697, "abcde", "crc\x01ʇ\x91M\x9e\x83Hm", "crc\x01wB\x84\x81\xe2\xa2)6"},
    30  	{0x4b8e39ef, 0x53bceff1, "abcdef", "crc\x01ʇ\x91M5$A\xc2", "crc\x01wB\x84\x816K?\xb7"},
    31  	{0x312a6aa6, 0xe627f441, "abcdefg", "crc\x01ʇ\x91M5$A\xc2", "crc\x01wB\x84\x816K?\xb7"},
    32  	{0xaeef2a50, 0xa9421b7, "abcdefgh", "crc\x01ʇ\x91M\xed\x82\xcd\x11", "crc\x01wB\x84\x81\x92\xc8\n1"},
    33  	{0x8da988af, 0x2ddc99fc, "abcdefghi", "crc\x01ʇ\x91M\xed\x82\xcd\x11", "crc\x01wB\x84\x81\x92\xc8\n1"},
    34  	{0x3981703a, 0xe6599437, "abcdefghij", "crc\x01ʇ\x91M\x85\x87\xd8e", "crc\x01wB\x84\x81\xc4P֗"},
    35  	{0x6b9cdfe7, 0xb2cc01fe, "Discard medicine more than two years old.", "crc\x01ʇ\x91M\xfd\xe5\xc2J", "crc\x01wB\x84\x81S\"(\xe0"},
    36  	{0xc90ef73f, 0xe28207f, "He who has a shady past knows that nice guys finish last.", "crc\x01ʇ\x91M\x01Nj+", "crc\x01wB\x84\x81'\xdaR\x15"},
    37  	{0xb902341f, 0xbe93f964, "I wouldn't marry him with a ten foot pole.", "crc\x01ʇ\x91M\x9d\x13\xce\x10", "crc\x01wB\x84\x81\xc3\xed\xabG"},
    38  	{0x42080e8, 0x9e3be0c3, "Free! Free!/A trip/to Mars/for 900/empty jars/Burma Shave", "crc\x01ʇ\x91M-\xed\xf7\x94", "crc\x01wB\x84\x81\xce\xceb\x81"},
    39  	{0x154c6d11, 0xf505ef04, "The days of the digital watch are numbered.  -Tom Stoppard", "crc\x01ʇ\x91MOa\xa5\r", "crc\x01wB\x84\x81\xd3s\x9dP"},
    40  	{0x4c418325, 0x85d3dc82, "Nepal premier won't resign.", "crc\x01ʇ\x91M\xa8S9\x85", "crc\x01wB\x84\x81{\x90\x8a\x14"},
    41  	{0x33955150, 0xc5142380, "For every action there is an equal and opposite government program.", "crc\x01ʇ\x91Ma\xe9>\x86", "crc\x01wB\x84\x81\xaa@\xc4\x1c"},
    42  	{0x26216a4b, 0x75eb77dd, "His money is twice tainted: 'taint yours and 'taint mine.", "crc\x01ʇ\x91M\\\x1an\x88", "crc\x01wB\x84\x81W\a8Z"},
    43  	{0x1abbe45e, 0x91ebe9f7, "There is no reason for any individual to have a computer in their home. -Ken Olsen, 1977", "crc\x01ʇ\x91M\xb7\xf5\xf2\xca", "crc\x01wB\x84\x81\xc4o\x9d\x85"},
    44  	{0xc89a94f7, 0xf0b1168e, "It's a tiny change to the code and not completely disgusting. - Bob Manchek", "crc\x01ʇ\x91M\x84g1\xe8", "crc\x01wB\x84\x81#\x98\f\xab"},
    45  	{0xab3abe14, 0x572b74e2, "size:  a.out:  bad magic", "crc\x01ʇ\x91M\x8a\x0f\xad\b", "crc\x01wB\x84\x81\x80\xc9n\xd8"},
    46  	{0xbab102b6, 0x8a58a6d5, "The major problem is with sendmail.  -Mark Horton", "crc\x01ʇ\x91M\a\xf0\xb3\x15", "crc\x01wB\x84\x81liS\xcc"},
    47  	{0x999149d7, 0x9c426c50, "Give me a rock, paper and scissors and I will move the world.  CCFestoon", "crc\x01ʇ\x91M\x0fa\xbc.", "crc\x01wB\x84\x81\xdb͏C"},
    48  	{0x6d52a33c, 0x735400a4, "If the enemy is within range, then so are you.", "crc\x01ʇ\x91My\x1b\x99\xf8", "crc\x01wB\x84\x81\xaaB\x037"},
    49  	{0x90631e8d, 0xbec49c95, "It's well we cannot hear the screams/That we create in others' dreams.", "crc\x01ʇ\x91M\bqfY", "crc\x01wB\x84\x81\x16y\xa1\xd2"},
    50  	{0x78309130, 0xa95a2079, "You remind me of a TV show, but that's all right: I watch it anyway.", "crc\x01ʇ\x91M\xbdO,\xc2", "crc\x01wB\x84\x81f&\xc5\xe4"},
    51  	{0x7d0a377f, 0xde2e65c5, "C is as portable as Stonehedge!!", "crc\x01ʇ\x91M\xf7\xd6\x00\xd5", "crc\x01wB\x84\x81de\\\xf8"},
    52  	{0x8c79fd79, 0x297a88ed, "Even if I could be Shakespeare, I think I should still choose to be Faraday. - A. Huxley", "crc\x01ʇ\x91Ml+\xb8\xa7", "crc\x01wB\x84\x81\xbf\xd6S\xdd"},
    53  	{0xa20b7167, 0x66ed1d8b, "The fugacity of a constituent in a mixture of gases at a given temperature is proportional to its mole fraction.  Lewis-Randall Rule", "crc\x01ʇ\x91M<lR[", "crc\x01wB\x84\x81{\xaco\xb1"},
    54  	{0x8e0bb443, 0xdcded527, "How can you write a big system without C++?  -Paul Glick", "crc\x01ʇ\x91M\x0e\x88\x89\xed", "crc\x01wB\x84\x813\xd7C\u007f"},
    55  }
    56  
    57  // testGoldenIEEE verifies that the given function returns
    58  // correct IEEE checksums.
    59  func testGoldenIEEE(t *testing.T, crcFunc func(b []byte) uint32) {
    60  	for _, g := range golden {
    61  		if crc := crcFunc([]byte(g.in)); crc != g.ieee {
    62  			t.Errorf("IEEE(%s) = 0x%x want 0x%x", g.in, crc, g.ieee)
    63  		}
    64  	}
    65  }
    66  
    67  // testGoldenCastagnoli verifies that the given function returns
    68  // correct IEEE checksums.
    69  func testGoldenCastagnoli(t *testing.T, crcFunc func(b []byte) uint32) {
    70  	for _, g := range golden {
    71  		if crc := crcFunc([]byte(g.in)); crc != g.castagnoli {
    72  			t.Errorf("Castagnoli(%s) = 0x%x want 0x%x", g.in, crc, g.castagnoli)
    73  		}
    74  	}
    75  }
    76  
    77  // testCrossCheck generates random buffers of various lengths and verifies that
    78  // the two "update" functions return the same result.
    79  func testCrossCheck(t *testing.T, crcFunc1, crcFunc2 func(crc uint32, b []byte) uint32) {
    80  	// The AMD64 implementation has some cutoffs at lengths 168*3=504 and
    81  	// 1344*3=4032. We should make sure lengths around these values are in the
    82  	// list.
    83  	lengths := []int{0, 1, 2, 3, 4, 5, 10, 16, 50, 63, 64, 65, 100,
    84  		127, 128, 129, 255, 256, 257, 300, 312, 384, 416, 448, 480,
    85  		500, 501, 502, 503, 504, 505, 512, 513, 1000, 1024, 2000,
    86  		4030, 4031, 4032, 4033, 4036, 4040, 4048, 4096, 5000, 10000}
    87  	for _, length := range lengths {
    88  		p := make([]byte, length)
    89  		_, _ = rand.Read(p)
    90  		crcInit := uint32(rand.Int63())
    91  		crc1 := crcFunc1(crcInit, p)
    92  		crc2 := crcFunc2(crcInit, p)
    93  		if crc1 != crc2 {
    94  			t.Errorf("mismatch: 0x%x vs 0x%x (buffer length %d)", crc1, crc2, length)
    95  		}
    96  	}
    97  }
    98  
    99  // TestSimple tests the simple generic algorithm.
   100  func TestSimple(t *testing.T) {
   101  	tab := simpleMakeTable(IEEE)
   102  	testGoldenIEEE(t, func(b []byte) uint32 {
   103  		return simpleUpdate(0, tab, b)
   104  	})
   105  
   106  	tab = simpleMakeTable(Castagnoli)
   107  	testGoldenCastagnoli(t, func(b []byte) uint32 {
   108  		return simpleUpdate(0, tab, b)
   109  	})
   110  }
   111  
   112  func TestGoldenMarshal(t *testing.T) {
   113  	t.Run("IEEE", func(t *testing.T) {
   114  		for _, g := range golden {
   115  			h := New(IEEETable)
   116  			h2 := New(IEEETable)
   117  
   118  			io.WriteString(h, g.in[:len(g.in)/2])
   119  
   120  			state, err := h.(encoding.BinaryMarshaler).MarshalBinary()
   121  			if err != nil {
   122  				t.Errorf("could not marshal: %v", err)
   123  				continue
   124  			}
   125  
   126  			if string(state) != g.halfStateIEEE {
   127  				t.Errorf("IEEE(%q) state = %q, want %q", g.in, state, g.halfStateIEEE)
   128  				continue
   129  			}
   130  
   131  			if err := h2.(encoding.BinaryUnmarshaler).UnmarshalBinary(state); err != nil {
   132  				t.Errorf("could not unmarshal: %v", err)
   133  				continue
   134  			}
   135  
   136  			io.WriteString(h, g.in[len(g.in)/2:])
   137  			io.WriteString(h2, g.in[len(g.in)/2:])
   138  
   139  			if h.Sum32() != h2.Sum32() {
   140  				t.Errorf("IEEE(%s) = 0x%x != marshaled 0x%x", g.in, h.Sum32(), h2.Sum32())
   141  			}
   142  		}
   143  	})
   144  	t.Run("Castagnoli", func(t *testing.T) {
   145  		table := MakeTable(Castagnoli)
   146  		for _, g := range golden {
   147  			h := New(table)
   148  			h2 := New(table)
   149  
   150  			io.WriteString(h, g.in[:len(g.in)/2])
   151  
   152  			state, err := h.(encoding.BinaryMarshaler).MarshalBinary()
   153  			if err != nil {
   154  				t.Errorf("could not marshal: %v", err)
   155  				continue
   156  			}
   157  
   158  			if string(state) != g.halfStateCastagnoli {
   159  				t.Errorf("Castagnoli(%q) state = %q, want %q", g.in, state, g.halfStateCastagnoli)
   160  				continue
   161  			}
   162  
   163  			if err := h2.(encoding.BinaryUnmarshaler).UnmarshalBinary(state); err != nil {
   164  				t.Errorf("could not unmarshal: %v", err)
   165  				continue
   166  			}
   167  
   168  			io.WriteString(h, g.in[len(g.in)/2:])
   169  			io.WriteString(h2, g.in[len(g.in)/2:])
   170  
   171  			if h.Sum32() != h2.Sum32() {
   172  				t.Errorf("Castagnoli(%s) = 0x%x != marshaled 0x%x", g.in, h.Sum32(), h2.Sum32())
   173  			}
   174  		}
   175  	})
   176  }
   177  
   178  func TestMarshalTableMismatch(t *testing.T) {
   179  	h1 := New(IEEETable)
   180  	h2 := New(MakeTable(Castagnoli))
   181  
   182  	state1, err := h1.(encoding.BinaryMarshaler).MarshalBinary()
   183  	if err != nil {
   184  		t.Errorf("could not marshal: %v", err)
   185  	}
   186  
   187  	if err := h2.(encoding.BinaryUnmarshaler).UnmarshalBinary(state1); err == nil {
   188  		t.Errorf("no error when one was expected")
   189  	}
   190  }
   191  
   192  // TestSimple tests the slicing-by-8 algorithm.
   193  func TestSlicing(t *testing.T) {
   194  	tab := slicingMakeTable(IEEE)
   195  	testGoldenIEEE(t, func(b []byte) uint32 {
   196  		return slicingUpdate(0, tab, b)
   197  	})
   198  
   199  	tab = slicingMakeTable(Castagnoli)
   200  	testGoldenCastagnoli(t, func(b []byte) uint32 {
   201  		return slicingUpdate(0, tab, b)
   202  	})
   203  
   204  	// Cross-check various polys against the simple algorithm.
   205  	for _, poly := range []uint32{IEEE, Castagnoli, Koopman, 0xD5828281} {
   206  		t1 := simpleMakeTable(poly)
   207  		f1 := func(crc uint32, b []byte) uint32 {
   208  			return simpleUpdate(crc, t1, b)
   209  		}
   210  		t2 := slicingMakeTable(poly)
   211  		f2 := func(crc uint32, b []byte) uint32 {
   212  			return slicingUpdate(crc, t2, b)
   213  		}
   214  		testCrossCheck(t, f1, f2)
   215  	}
   216  }
   217  
   218  func TestArchIEEE(t *testing.T) {
   219  	if !archAvailableIEEE() {
   220  		t.Skip("Arch-specific IEEE not available.")
   221  	}
   222  	archInitIEEE()
   223  	slicingTable := slicingMakeTable(IEEE)
   224  	testCrossCheck(t, archUpdateIEEE, func(crc uint32, b []byte) uint32 {
   225  		return slicingUpdate(crc, slicingTable, b)
   226  	})
   227  }
   228  
   229  func TestArchCastagnoli(t *testing.T) {
   230  	if !archAvailableCastagnoli() {
   231  		t.Skip("Arch-specific Castagnoli not available.")
   232  	}
   233  	archInitCastagnoli()
   234  	slicingTable := slicingMakeTable(Castagnoli)
   235  	testCrossCheck(t, archUpdateCastagnoli, func(crc uint32, b []byte) uint32 {
   236  		return slicingUpdate(crc, slicingTable, b)
   237  	})
   238  }
   239  
   240  func TestGolden(t *testing.T) {
   241  	testGoldenIEEE(t, ChecksumIEEE)
   242  
   243  	// Some implementations have special code to deal with misaligned
   244  	// data; test that as well.
   245  	for delta := 1; delta <= 7; delta++ {
   246  		testGoldenIEEE(t, func(b []byte) uint32 {
   247  			ieee := NewIEEE()
   248  			d := delta
   249  			if d >= len(b) {
   250  				d = len(b)
   251  			}
   252  			ieee.Write(b[:d])
   253  			ieee.Write(b[d:])
   254  			return ieee.Sum32()
   255  		})
   256  	}
   257  
   258  	castagnoliTab := MakeTable(Castagnoli)
   259  	if castagnoliTab == nil {
   260  		t.Errorf("nil Castagnoli Table")
   261  	}
   262  
   263  	testGoldenCastagnoli(t, func(b []byte) uint32 {
   264  		castagnoli := New(castagnoliTab)
   265  		castagnoli.Write(b)
   266  		return castagnoli.Sum32()
   267  	})
   268  
   269  	// Some implementations have special code to deal with misaligned
   270  	// data; test that as well.
   271  	for delta := 1; delta <= 7; delta++ {
   272  		testGoldenCastagnoli(t, func(b []byte) uint32 {
   273  			castagnoli := New(castagnoliTab)
   274  			d := delta
   275  			if d >= len(b) {
   276  				d = len(b)
   277  			}
   278  			castagnoli.Write(b[:d])
   279  			castagnoli.Write(b[d:])
   280  			return castagnoli.Sum32()
   281  		})
   282  	}
   283  }
   284  
   285  func BenchmarkCRC32(b *testing.B) {
   286  	b.Run("poly=IEEE", benchmarkAll(NewIEEE()))
   287  	b.Run("poly=Castagnoli", benchmarkAll(New(MakeTable(Castagnoli))))
   288  	b.Run("poly=Koopman", benchmarkAll(New(MakeTable(Koopman))))
   289  }
   290  
   291  func benchmarkAll(h hash.Hash32) func(b *testing.B) {
   292  	return func(b *testing.B) {
   293  		for _, size := range []int{15, 40, 512, 1 << 10, 4 << 10, 32 << 10} {
   294  			name := fmt.Sprint(size)
   295  			if size >= 1024 {
   296  				name = fmt.Sprintf("%dkB", size/1024)
   297  			}
   298  			b.Run("size="+name, func(b *testing.B) {
   299  				for align := 0; align <= 1; align++ {
   300  					b.Run(fmt.Sprintf("align=%d", align), func(b *testing.B) {
   301  						benchmark(b, h, int64(size), int64(align))
   302  					})
   303  				}
   304  			})
   305  		}
   306  	}
   307  }
   308  
   309  func benchmark(b *testing.B, h hash.Hash32, n, alignment int64) {
   310  	b.SetBytes(n)
   311  	data := make([]byte, n+alignment)
   312  	data = data[alignment:]
   313  	for i := range data {
   314  		data[i] = byte(i)
   315  	}
   316  	in := make([]byte, 0, h.Size())
   317  
   318  	// Warm up
   319  	h.Reset()
   320  	h.Write(data)
   321  	h.Sum(in)
   322  
   323  	b.ResetTimer()
   324  	for i := 0; i < b.N; i++ {
   325  		h.Reset()
   326  		h.Write(data)
   327  		h.Sum(in)
   328  	}
   329  }
   330  

View as plain text