Skip to content

Commit

Permalink
added Jones crc64
Browse files Browse the repository at this point in the history
  • Loading branch information
nerg4l committed May 9, 2024
1 parent f65fe74 commit 385993a
Show file tree
Hide file tree
Showing 3 changed files with 157 additions and 5 deletions.
7 changes: 2 additions & 5 deletions core/encoder.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ package core
import (
"encoding/binary"
"fmt"
"github.com/hdt3213/rdb/crc64jones"
"hash"
"hash/crc64"
"io"
)

Expand Down Expand Up @@ -89,14 +89,11 @@ var stateChanges = map[string]map[string]struct{}{ // state -> allow next states
writtenEndState: {},
}

const Crc64Jones = 0xad93d23594c935a9

// NewEncoder creates an encoder instance
func NewEncoder(writer io.Writer) *Encoder {
crcTab := crc64.MakeTable(Crc64Jones)
return &Encoder{
writer: writer,
crc: crc64.New(crcTab),
crc: crc64jones.New(),
buffer: make([]byte, 8),
state: startState,
existDB: make(map[uint]struct{}),
Expand Down
139 changes: 139 additions & 0 deletions crc64jones/crc64.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
// Package crc64jones implements a 64-bit cyclic redundancy check, or CRC-64,
// checksum. Specifically the Jones flavour of it which is used by Redis.
//
// Specification of this CRC64 variant follows:
// - Name: crc-64-jones
// - Width: 64 bites
// - Poly: 0xad93d23594c935a9
// - Reflected In: True
// - Xor_In: 0xffffffffffffffff
// - Reflected_Out: True
// - Xor_Out: 0x0
// - Check("123456789"): 0xe9c6d914c4b8d9ca
package crc64jones

import (
"hash"
"hash/crc64"
"sync"
)

// Predefined polynomials.
const (
// The Jones polynomial.
Jones = 0xad93d23594c935a9
)

var table = crc64.MakeTable(reflect(Jones))

// reflect reverses the bit order of the given polynomial.
func reflect(poly uint64) uint64 {
x := poly & 1
for i := 1; i < 64; i++ {
poly >>= 1
x <<= 1
x |= poly & 1
}
return x
}

var (
slicing8TablesBuildOnce sync.Once
slicing8TableJones *[8]crc64.Table
)

func buildSlicing8TablesOnce() {
slicing8TablesBuildOnce.Do(buildSlicing8Tables)
}

func buildSlicing8Tables() {
slicing8TableJones = makeSlicingBy8Table(table)
}

func makeSlicingBy8Table(t *crc64.Table) *[8]crc64.Table {
var helperTable [8]crc64.Table
helperTable[0] = *t
for i := 0; i < 256; i++ {
crc := t[i]
for j := 1; j < 8; j++ {
crc = t[crc&0xff] ^ (crc >> 8)
helperTable[j][i] = crc
}
}
return &helperTable
}

// digest represents the partial evaluation of a checksum.
type digest struct {
crc uint64
tab *crc64.Table
}

// New creates a new hash.Hash64 computing the CRC-64 checksum using the
// Jones polynomial. Its Sum method will lay the value out in little-endian
// byte order.
func New() hash.Hash64 { return &digest{0, table} }

func (d *digest) Size() int { return crc64.Size }

func (d *digest) BlockSize() int { return 1 }

func (d *digest) Reset() { d.crc = 0 }

func update(crc uint64, tab *crc64.Table, p []byte) uint64 {
buildSlicing8TablesOnce()
// Table comparison is somewhat expensive, so avoid it for small sizes
for len(p) >= 64 {
var helperTable *[8]crc64.Table
if *tab == slicing8TableJones[0] {
helperTable = slicing8TableJones
} else if len(p) >= 2048 {
// According to the tests between various x86 and arm CPUs, 2k is a reasonable
// threshold for now. This may change in the future.
helperTable = makeSlicingBy8Table(tab)
} else {
break
}
// Update using slicing-by-8
for len(p) > 8 {
crc ^= uint64(p[0]) | uint64(p[1])<<8 | uint64(p[2])<<16 | uint64(p[3])<<24 |
uint64(p[4])<<32 | uint64(p[5])<<40 | uint64(p[6])<<48 | uint64(p[7])<<56
crc = helperTable[7][crc&0xff] ^
helperTable[6][(crc>>8)&0xff] ^
helperTable[5][(crc>>16)&0xff] ^
helperTable[4][(crc>>24)&0xff] ^
helperTable[3][(crc>>32)&0xff] ^
helperTable[2][(crc>>40)&0xff] ^
helperTable[1][(crc>>48)&0xff] ^
helperTable[0][crc>>56]
p = p[8:]
}
}
// For reminders or small sizes
for _, v := range p {
crc = tab[byte(crc)^v] ^ (crc >> 8)
}
return crc
}

// Update returns the result of adding the bytes in p to the crc.
func Update(crc uint64, tab *crc64.Table, p []byte) uint64 {
return update(crc, tab, p)
}

func (d *digest) Write(p []byte) (n int, err error) {
d.crc = update(d.crc, d.tab, p)
return len(p), nil
}

func (d *digest) Sum64() uint64 { return d.crc }

func (d *digest) Sum(in []byte) []byte {
s := d.Sum64()
// Compared to the core hash functions we return in little endian byte order.
return append(in, byte(s), byte(s>>8), byte(s>>16), byte(s>>24), byte(s>>32), byte(s>>40), byte(s>>48), byte(s>>56))
}

// Checksum returns the CRC-64 checksum of data
// using the polynomial represented by the [Table].
func Checksum(data []byte, tab *crc64.Table) uint64 { return update(0, tab, data) }
16 changes: 16 additions & 0 deletions crc64jones/crc64_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
package crc64jones

import (
"io"
"testing"
)

func TestGolden(t *testing.T) {
c := New()
in := "123456789"
io.WriteString(c, in)
s := c.Sum64()
if out := uint64(0xe9c6d914c4b8d9ca); s != out {
t.Fatalf("jones crc64(%s) = 0x%x want 0x%x", in, s, out)
}
}

0 comments on commit 385993a

Please sign in to comment.