-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* move crc32c to stdlib * fix capitalization
- Loading branch information
1 parent
698ef27
commit 8e96fbc
Showing
13 changed files
with
150 additions
and
115 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -978,7 +978,6 @@ export | |
| atexit, | ||
| atreplinit, | ||
| clipboard, | ||
| crc32c, | ||
| exit, | ||
| ntuple, | ||
| quit, | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,3 +3,7 @@ test.md | |
| mmap.md | ||
| sharedarrays.md | ||
| profile.md | ||
| base64.md | ||
| filewatching.md | ||
| crc32c.md | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # CRC32c | ||
|
|
||
| ```@docs | ||
| CRC32c.crc32c | ||
| CRC32c.crc32c(::IO, ::Integer, ::UInt32) | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| """ | ||
| Standard library module for computing the CRC-32c checksum. | ||
| See [`CRC32c.crc32c`](@ref) for more information. | ||
| """ | ||
| module CRC32c | ||
|
|
||
| import Base.FastContiguousSubArray | ||
|
|
||
| export crc32c | ||
|
|
||
| """ | ||
| crc32c(data, crc::UInt32=0x00000000) | ||
| Compute the CRC-32c checksum of the given `data`, which can be | ||
| an `Array{UInt8}`, a contiguous subarray thereof, or a `String`. Optionally, you can pass | ||
| a starting `crc` integer to be mixed in with the checksum. The `crc` parameter | ||
| can be used to compute a checksum on data divided into chunks: performing | ||
| `crc32c(data2, crc32c(data1))` is equivalent to the checksum of `[data1; data2]`. | ||
| (Technically, a little-endian checksum is computed.) | ||
| There is also a method `crc32c(io, nb, crc)` to checksum `nb` bytes from | ||
| a stream `io`, or `crc32c(io, crc)` to checksum all the remaining bytes. | ||
| Hence you can do [`open(crc32c, filename)`](@ref) to checksum an entire file, | ||
| or `crc32c(seekstart(buf))` to checksum an [`IOBuffer`](@ref) without | ||
| calling [`take!`](@ref). | ||
| For a `String`, note that the result is specific to the UTF-8 encoding | ||
| (a different checksum would be obtained from a different Unicode encoding). | ||
| To checksum an `a::Array` of some other bitstype, you can do `crc32c(reinterpret(UInt8,a))`, | ||
| but note that the result may be endian-dependent. | ||
| """ | ||
| function crc32c end | ||
|
|
||
|
|
||
| crc32c(a::Union{Array{UInt8},FastContiguousSubArray{UInt8,N,<:Array{UInt8}} where N}, crc::UInt32=0x00000000) = Base._crc32c(a, crc) | ||
| crc32c(s::String, crc::UInt32=0x00000000) = Base._crc32c(s, crc) | ||
|
|
||
| """ | ||
| crc32c(io::IO, [nb::Integer,] crc::UInt32=0x00000000) | ||
| Read up to `nb` bytes from `io` and return the CRC-32c checksum, optionally | ||
| mixed with a starting `crc` integer. If `nb` is not supplied, then | ||
| `io` will be read until the end of the stream. | ||
| """ | ||
| crc32c(io::IO, nb::Integer, crc::UInt32=0x00000000) = Base._crc32c(io, nb, crc) | ||
| crc32c(io::IO, crc::UInt32=0x00000000) = Base._crc32c(io, crc) | ||
| crc32c(io::IOStream, crc::UInt32=0x00000000) = Base._crc32c(io, crc) | ||
|
|
||
| end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| using Test | ||
| using CRC32c | ||
|
|
||
| function test_crc32c(crc32c) | ||
| # CRC32c checksum (test data generated from @andrewcooke's CRC.jl package) | ||
| for (n,crc) in [(0,0x00000000),(1,0xa016d052),(2,0x03f89f52),(3,0xf130f21e),(4,0x29308cf4),(5,0x53518fab),(6,0x4f4dfbab),(7,0xbd3a64dc),(8,0x46891f81),(9,0x5a14b9f9),(10,0xb219db69),(11,0xd232a91f),(12,0x51a15563),(13,0x9f92de41),(14,0x4d8ae017),(15,0xc8b74611),(16,0xa0de6714),(17,0x672c992a),(18,0xe8206eb6),(19,0xc52fd285),(20,0x327b0397),(21,0x318263dd),(22,0x08485ccd),(23,0xea44d29e),(24,0xf6c0cb13),(25,0x3969bba2),(26,0x6a8810ec),(27,0x75b3d0df),(28,0x82d535b1),(29,0xbdf7fc12),(30,0x1f836b7d),(31,0xd29f33af),(32,0x8e4acb3e),(33,0x1cbee2d1),(34,0xb25f7132),(35,0xb0fa484c),(36,0xb9d262b4),(37,0x3207fe27),(38,0xa024d7ac),(39,0x49a2e7c5),(40,0x0e2c157f),(41,0x25f7427f),(42,0x368c6adc),(43,0x75efd4a5),(44,0xa84c5c31),(45,0x0fc817b2),(46,0x8d99a881),(47,0x5cc3c078),(48,0x9983d5e2),(49,0x9267c2db),(50,0xc96d4745),(51,0x058d8df3),(52,0x453f9cf3),(53,0xb714ade1),(54,0x55d3c2bc),(55,0x495710d0),(56,0x3bddf494),(57,0x4f2577d0),(58,0xdae0f604),(59,0x3c57c632),(60,0xfe39bbb0),(61,0x6f5d1d41),(62,0x7d996665),(63,0x68c738dc),(64,0x8dfea7ae)] | ||
| @test crc32c(UInt8[1:n;]) == crc == crc32c(String(UInt8[1:n;])) | ||
| end | ||
|
|
||
| # test that crc parameter is equivalent to checksum of concatenated data, | ||
| # and test crc of subarrays: | ||
| a = UInt8[1:255;] | ||
| crc_256 = crc32c(a) | ||
| @views for n = 1:255 | ||
| @test crc32c(a[n+1:end], crc32c(a[1:n])) == crc_256 | ||
| end | ||
| @test crc32c(IOBuffer(a)) == crc_256 | ||
| let buf = IOBuffer() | ||
| write(buf, a[1:3]) | ||
| @test crc32c(seekstart(buf)) == crc32c(a[1:3]) | ||
| @test crc32c(buf) == 0x00000000 | ||
| @test crc32c(seek(buf, 1)) == crc32c(a[2:3]) | ||
| @test crc32c(seek(buf, 0), 2) == crc32c(a[1:2]) | ||
| @test crc32c(buf) == crc32c(a[3:3]) | ||
| end | ||
|
|
||
| let f = tempname() | ||
| try | ||
| write(f, a) | ||
| @test open(crc32c, f) == crc_256 | ||
| open(f, "r") do io | ||
| @test crc32c(io, 16) == crc32c(a[1:16]) | ||
| @test crc32c(io, 16) == crc32c(a[17:32]) | ||
| @test crc32c(io) == crc32c(a[33:end]) | ||
| @test crc32c(io, 1000) == 0x00000000 | ||
| end | ||
| a = rand(UInt8, 30000) | ||
| write(f, a) | ||
| @test open(crc32c, f) == crc32c(a) == open(io -> crc32c(io, 10^6), f) | ||
| finally | ||
| rm(f, force=true) | ||
| end | ||
| end | ||
| end | ||
| unsafe_crc32c_sw(a, n, crc) = | ||
| ccall(:jl_crc32c_sw, UInt32, (UInt32, Ptr{UInt8}, Csize_t), crc, a, n) | ||
| crc32c_sw(a::Union{Array{UInt8},Base.FastContiguousSubArray{UInt8,N,<:Array{UInt8}} where N}, | ||
| crc::UInt32=0x00000000) = unsafe_crc32c_sw(a, length(a), crc) | ||
| crc32c_sw(s::String, crc::UInt32=0x00000000) = unsafe_crc32c_sw(s, sizeof(s), crc) | ||
| function crc32c_sw(io::IO, nb::Integer, crc::UInt32=0x00000000) | ||
| nb < 0 && throw(ArgumentError("number of bytes to checksum must be ≥ 0")) | ||
| buf = Array{UInt8}(min(nb, 24576)) | ||
| while !eof(io) && nb > 24576 | ||
| n = readbytes!(io, buf) | ||
| crc = unsafe_crc32c_sw(buf, n, crc) | ||
| nb -= n | ||
| end | ||
| return unsafe_crc32c_sw(buf, readbytes!(io, buf, min(nb, length(buf))), crc) | ||
| end | ||
| crc32c_sw(io::IO, crc::UInt32=0x00000000) = crc32c_sw(io, typemax(Int64), crc) | ||
| test_crc32c(crc32c) | ||
| test_crc32c(crc32c_sw) | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters