Skip to content
REFERENCE / ZLIB × LEAN

crc32

Update a CRC-32 checksum using a 32-bit byte count.

Full chapter and shared rules ↗
uLong ZEXPORT crc32(uLong crc, const unsigned char FAR *buf, uInt len);

Update a CRC-32 checksum using a 32-bit byte count.

Return values and next calls

Return type. uLong — 32-bit checksum

Returns the updated CRC-32, or the initial value for a new checksum.

crc32()
Returned value Meaning and conditions Caller’s next step
0
Initial value
buf == NULL, with any len and incoming checksum; no buffer is read. Start a new sequence at 0.
low32(crc)
Empty range preserves value
buf is non-NULL and len == 0; a one-past pointer is also allowed for the empty range. Keep this value for the next update.
CRC-32(A || buf)
Checksum after append
buf covers len readable bytes, len > 0, and the low 32 bits of crc are the CRC-32 of A. Use this value in later updates or compare it with the expected checksum.

Reading the result.

  • len is uInt, at most 2^32 - 1 bytes; a larger count converted to uInt loses its high bits before the call. Use the _z form or multiple updates for larger counts.

Calling conditions and effects

Domain Restricted domain. Effects: read-only when buf is non-NULL, and reads fixed library tables.

Pre Either buf is NULL, or it points to len readable bytes, at any alignment. For the checksum postcondition, the low 32 bits of crc are the CRC-32 of A. The fixed CRC tables are present.

Effects Preserve all memory and ownership. Read only the given byte range and fixed library tables.

Proof goals.

  • Goal. Goal.crc32_safety (Safety/Checksums.lean); required. Theorem: ZlibF.Spec.Public.StatelessSafetyProof.crc32_safety (public-stateless-safety.lean).
  • Applies when:
    1. the heap holds the library's two constant CRC tables (CrcGlobals), the condition on the model stated at the top of this page;
    2. buf is NULL, with any len, or buf points to len readable bytes (BufferBytes). For len == 0 a pointer one past the end of an object is allowed.
  • Covered without condition. Every crc, also a value that is not a checksum; every content of the bytes; every alignment of buf.
  • Guarantees.
    • Returns. The call returns.
    • State, writes, allocations. None: the heap after the call is the heap before it.
  • Not in this goal. The value returned: functional goal Goal.crc32 (not planned; a theorem proves it).
Complete return conditions and boundaries

Post Return exactly the result of crc32_z(crc, buf, len). NULL returns 0 even with a nonzero length. A non-NULL empty range preserves the incoming checksum's low 32 bits. Complement handling is internal.

Shared conditions and scope

Compute a checksum a buffer at a time, or combine the checksums of independently processed byte sequences without rereading them. The byte sequences A and B below are ordinary data; the contracts use the Adler-32 or CRC-32 of those sequences. For example, after processing A and then B, the checksum of A can be the starting value of the next update; if A and B were processed independently, the combination functions give the checksum of A followed by B.

In the update functions, buf points to this batch of input, len is its byte count, and the incoming adler or crc is the value to continue from. In the combination functions, len2 is the byte count of the second sequence B only, not the total length of the two.

Task Entries
Update Adler-32 Size-type length, 32-bit length
Combine Adler-32 Ordinary offset, explicit 64-bit offset
Update CRC-32 Size-type length, 32-bit length
Combine CRC-32 Ordinary offset, explicit 64-bit offset
Reuse a CRC combination operator Generate, generate with 64-bit length, apply
Inspect the byte table get_crc_table

The contracts follow the pinned adler32.c, crc32.c and zlib.h in the default LP64 Linux static build. No patch touches these two C files (patches). Dynamic table generation, hardware CRC hooks and generated table executables are not covered (build and platform). No checksum entry writes state, allocates, frees or performs I/O. Exceptional numeric results are ordinary values, rather than error codes. Domain and effects remain independent as explained in contract conventions. These are focused contracts: Pre describes ordinary correct use and is deliberately narrower than what the function accepts. A call outside Pre is not thereby undefined, and it need not return an error code.

What is proved. Safety only (safety): each safety goal (Safety/Checksums.lean) says that the call returns and that the heap after the call is the heap before it. It says nothing about the value. Each entry gives its goal under Proof goals, in the five items and with the fixed phrases that Reading a Proof goals paragraph defines. The proof assumes the conditions listed there, not the documentary Pre. Post, the return tables and the notes describe functional behaviour. They are read from the C, are to confirm where no theorem states them, and are not required for the safety results. Progress says which goals are done.

The CRC goals have a premise on the model's heap: its two constant CRC tables, crc_table and x2n_table, equal the tables of the translated crc32.h (CrcGlobals). The premise is assumed of the heap the call starts on; no theorem derives it for an arbitrary heap. It is a condition on the model, not a duty of the caller (model limits). Two facts are proved about it. A library heap, which is what the stream goals start from, meets it (crc_globals_of_library). Each checksum goal returns the heap unchanged, so the premise still holds after the call.

The practical checksum contracts use actual byte sequences A and B. Each checksum is computed independently, starting at 1 for Adler-32 or 0 for CRC-32. These contracts deliberately omit functional promises for forged checksums. The functional goals in Functional/Checksums.lean also describe arbitrary seeds and exact scalar results. Both the Adler entries and their Lean goals, safety and functional, require zero length for NULL initialization queries (AdlerBufferBytes in Common/Checksums.lean). See deviations.

In this build, uLong and z_size_t are unsigned 64-bit types; uInt is unsigned 32-bit. z_off_t and z_off64_t are signed 64-bit. Input checksum bits above bit 31 are ignored; returned checksums fit in 32 bits. The explicit *64 declarations depend on the header's large-file feature macros.

Safety goal

ZlibF.Spec.Public.Goal.crc32_safety

State: done · Status of the results

/-- `uLong crc32(uLong crc, const Bytef *buf, uInt len)`.
**Safety of `crc32`**: with the library's tables (`CrcGlobals`) and a readable buffer of `len`
bytes or `NULL` (`BufferBytes`), the call returns and the heap is unchanged. -/
def Goal.crc32_safety : Prop :=
  ∀ (h : Heap) (seed : UInt64) (pointer : BPtr) (length : UInt32) (bytes : List UInt8),
    CrcGlobals h → BufferBytes h pointer length.toNat bytes →
    ∃ value, C.run (Zlib.Crc32.crc32 seed pointer length) h = .ok (value, h)
Related definitions and source ↗

Functional contract (beyond safety)

ZlibF.Spec.Public.Goal.crc32

State: done · Status of the results

/-- `uLong crc32(uLong crc, const Bytef *buf, uInt len)`.
The public 32-bit length entry has the same full buffer domain and exact checksum contract. -/
def Goal.crc32 : Prop :=
  ∀ (h : Heap) (seed : UInt64) (pointer : BPtr) (length : UInt32) (bytes : List UInt8),
    CrcGlobals h → BufferBytes h pointer length.toNat bytes →
    C.run (Zlib.Crc32.crc32 seed pointer length) h =
      .ok ((if pointer = .null then 0 else (ZlibF.Spec.crc32Update seed.toUInt32 bytes).toUInt64), h)
Related definitions and source ↗
ZLIB × LEAN

Contents

READING NOWcrc32