Skip to content
REFERENCE / ZLIB × LEAN

deflateSetHeader

Select the header for the next gzip stream.

Full chapter and shared rules ↗
int ZEXPORT deflateSetHeader(z_streamp strm, gz_headerp head);

Select the header for the next gzip stream.

Return values and next calls

Return type. int — zlib status code

The result says whether the gzip header pointer was registered; success does not mean header bytes have been emitted.

deflateSetHeader()
Returned value Meaning and conditions Caller’s next step
Z_OK
Header pointer registered
A live gzip stream accepts head; NULL selects defaults, while a non-NULL header remains caller-owned and no header bytes are copied or emitted yet. Keep the record and optional fields alive and unchanged through header emission; continue with deflate. Either reset clears the pointer.
Z_STREAM_ERROR
Stream refuses gzip header
The stream check fails or the wrapper is not gzip; nothing changes. Register under the header-call preconditions on a live gzip stream; an existing live stream can still continue legally or end.

Calling conditions and effects

Domain Restricted domain. Effect: retain a caller-owned header pointer.

Pre live gzip stream, after init or reset and before its first deflate. head is NULL for defaults, or satisfies the shared header conditions.

Proof goals.

  • Goal. Goal.deflateSetHeader_safety (Safety/Streams.lean); required. Theorem: ZlibF.Spec.Public.StreamCallSafetyProof.deflateSetHeader_safety (public-stream-call-safety.lean). The goal has two clauses: the refusal of a refused stream, and one call on a reachable stream.
  • Applies when. The refusal asks that strm is a refused stream (RefusedDeflate). The call on a reachable stream asks (StreamCallDomain):
    1. strm is a reachable stream (StreamReachable);
    2. the platform size bound holds (ByteObjectsFit);
    3. head is NULL, or names a live header record that is not one of the stream's own blocks, whose extra is NULL or points to extra_len readable bytes outside the stream's own blocks, and whose name and comment are each NULL or a NUL-terminated string (HeaderMemory);
    4. no deflate call has started the stream since init or deflateReset: its status is still INIT_STATE or GZIP_STATE (DeflateNotStarted).
  • Covered without condition. Every wrapper: the stream need not be a gzip stream, which is wider than Pre. The call order is the same as in Pre. In the refusal: every refused stream and every value of the other arguments.
  • Guarantees (StreamCallSafe for the call on a reachable stream).
    • Returns. On a refused stream the call returns Z_STREAM_ERROR. On a reachable stream the call returns.
    • State. On a reachable stream, the stream keeps its invariant (StreamInvariant).
    • Writes. On a refused stream, nothing: the heap is unchanged. On a reachable stream, only the stream record and the stream's own blocks.
    • Allocations. On a reachable stream, the exact allocation account (LiveChange).
  • Not in this goal. A call after deflate has started the stream: outside every safety goal (deviations, row "Header arguments"). A stream record with zalloc and zfree set whose state is a garbage pointer, points to a freed state, or points to an inflate state: no goal covers this call on such a record (deviations). The return value and the header bytes that deflate later writes: functional goal Goal.deflateSetHeader (not planned; a theorem proves it).
Complete return conditions and boundaries

Post return Z_OK and retain head; no header bytes are copied or output yet. Subsequent deflate writes the requested text flag, time, OS, optional extra/name/comment, and optional header CRC. Compression settings determine the extra flags byte. The caller keeps the record and fields alive until header emission completes. Either reset clears the pointer. No allocation or ownership transfer occurs.

Outside focused scope: non-gzip or a failed stream check returns Z_STREAM_ERROR without changes. Late registration is accepted for gzip but does not rewrite header bytes already emitted. The functional goal Goal.deflateSetHeader includes that case; the safety goal does not (Proof goals).

Shared conditions and scope

Use a z_stream compressor when input arrives in pieces, output space is limited, or you need a chosen wrapper, dictionary or flush boundary. A wrapper is the header, trailer and integrity information added around the DEFLATE data; raw DEFLATE has none. Initialize once, call deflate with successive buffers, and end the stream even if compression is abandoned. For a single buffer, see compress and compress2.

Task Entries
Start or reuse Init, configured init, reset, reset retaining history
Supply metadata or history Dictionary, read history, gzip header
Compress and size output Deflate, bound, pending output, last flush bits
Adjust or branch Parameters, tuning, priming, copy
Release storage End

The contracts follow zlib.h and deflate.c of the pinned zlib with the patches applied, in the default LP64 Linux build. Of the seven patches only patches 0006 and 0007 touch deflate.c. Both change deflateBound_z, and with it the result of deflateBound, which calls deflateBound_z: 0006 one condition, 0007 the length of the gzip extra field in the wrapper size. The entry deflateBound_z states both changes. The patches change no other function. These are focused contracts: Pre describes ordinary correct use and is deliberately narrower than what the function accepts. Cases outside Pre that the C still handles appear under Errors or Outside focused scope. A call outside Pre is not thereby undefined, and it need not return an error code. See how to read a contract for the domain and effect labels.

What is proved. Safety only: each call returns without undefined behaviour or a memory error, writes only what its goal names, and leaks nothing (safety). 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 goal and its theorem; the conditions under which it applies, in the order of the Lean statement; what it covers for every value; what it guarantees (returns, state, writes, allocations); and what it leaves to another goal. 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.

Shared conventions

Under each stated Pre, the documented behaviour is that the call terminates without a runtime fault and that Post holds. A call that leaves the stream live preserves its representation invariant. The part of this that is proved is the safety goal of the entry.

First, how data changes hands in one call. next_in points to the start of the input not yet read, and avail_in is the number of bytes readable from there. next_out points to the next writable position, and avail_out is the output room that remains, also in bytes. One call may consume only part of the input and deliver only part of the output. Read the updated pointers and counts, take the bytes delivered, then give the same stream more input or more output room.

  • Live stream: a writable z_stream with a compressor state established by successful init or copy, preserved by legal calls, and not ended. The caller does not alter its internal state or allocator fields. Calls on one stream are sequential.
  • Buffers: input covers avail_in readable bytes; output covers avail_out writable bytes. They do not overlap each other, the stream or its owned state. A non-NULL scalar result points to a writable cell separate from other results and stream memory. These separation conditions are assumptions of the contracts. Where a safety goal assumes one too, its Proof goals says so and deviations has a row.
  • Allocator: the default allocator/free pair is used, or both fields are NULL before init. Allocation may fail on any attempt. Custom allocator callbacks are outside this page's scope.
  • Frame and ownership: calls change only their stream, its owned state and stated output regions. Caller input is read-only. Caller buffers and header records remain caller-owned. Only init and copy allocate; only their failure cleanup and deflateEnd free memory. Other calls preserve the stream's allocation set.
  • Header lifetime: a retained gzip header and its optional fields remain readable and unchanged while used. Non-NULL name and comment have a terminating zero; extra covers its stated length. The contracts on this page take extra_len <= 65535.
  • Checked refusals: except for init and bounds, a failed stream check returns Z_STREAM_ERROR before normal operation, without writes. deflateCopy additionally clears a non-NULL destination state. Query output cells are untouched on this refusal.
  • Restricted domain means these explicit memory, lifetime and call-order conditions, plus the entry's Pre. It does not mean every representable pointer or integer is accepted. Error summaries cover stream records and states that the checks can read, not arbitrary invalid addresses.
  • Reachable stream: the proof goals speak of a reachable stream where the contracts say live stream (how to read a contract). A call that a goal covers extends the stream's history: when it returns, with any code, the stream is reachable again and the goal of the next call applies. deflateEnd ends the history.
  • Result cells as values: deflateGetDictionary, deflatePending and deflateUsed report results through pointers (uInt *dictLength, unsigned *pending, int *bits). The translation does not model these cells as memory: each function takes only the fact that a pointer is NULL or not, and returns the values. So the goals say nothing about the address of a result cell, and a cell that overlaps another object cannot be expressed.

Safety goal

ZlibF.Spec.Public.Goal.deflateSetHeader_safety

State: done · Status of the results

/-- `int deflateSetHeader(z_streamp strm, gz_headerp head)`.
**Safety of `deflateSetHeader`**: a `NULL` or inconsistent stream (`RefusedDeflate`) is refused with
`Z_STREAM_ERROR` and nothing changed; and on every reachable deflate stream, with the caller's
arguments as `zlib.h` asks, the call is safe (`StreamCallSafe`). -/
def Goal.deflateSetHeader_safety : Prop :=
  (∀ h p head, RefusedDeflate h p →
    C.run (Zlib.Deflate.deflateSetHeader p head) h = .ok (Z_STREAM_ERROR, h)) ∧
  (∀ h r head,
     StreamCallDomain .deflate h r (.deflateSetHeader (some r) head) →
     StreamCallSafe .deflate h r (.deflateSetHeader (some r) head))
Related definitions and source ↗

Functional contract (beyond safety)

ZlibF.Spec.Public.Goal.deflateSetHeader

State: done · Status of the results

/-- `int deflateSetHeader(z_streamp strm, gz_headerp head)`.
Only the gzip wrapper accepts the pointer. The record is retained and read by later calls. -/
def Goal.deflateSetHeader : Prop :=
  ∀ head, CheckedDeflate (fun p => Zlib.Deflate.deflateSetHeader p head) Z_STREAM_ERROR <|
  ∀ h r i z s, DeflateView h r i z s →
    C.run (Zlib.Deflate.deflateSetHeader (some r) head) h =
      if s.wrap = 2 then .ok (Z_OK, putDeflate h i { s with gzhead := head })
      else .ok (Z_STREAM_ERROR, h)
Related definitions and source ↗
ZLIB × LEAN

Contents

READING NOWdeflateSetHeader