Skip to content
REFERENCE / ZLIB × LEAN

deflateParams

Change level and strategy, finishing the old block when needed.

Full chapter and shared rules ↗
int ZEXPORT deflateParams(z_streamp strm, int level, int strategy);

Change level and strategy, finishing the old block when needed.

Return values and next calls

Return type. int — zlib status code

The result says whether the new level and strategy were installed. Completing the old block may first consume input and deliver output.

deflateParams()
Returned value Meaning and conditions Caller’s next step
Z_OK
New settings installed
Parameters are valid and required old-block work is complete; level -1 selects 6, and a changed level restores its standard tuning. A required flush uses the old settings and may make I/O progress. Account for output and unconsumed input through the updated pointers and counts, then continue with the new settings.
Z_BUF_ERROR
Old block incomplete
Required old-block work is incomplete; level and strategy retain their old values, but compression progress, including input consumed and output delivered, is retained. Provide more output room, preserve the updated stream and remaining input, and retry deflateParams; the live stream and allocations are retained.
Z_STREAM_ERROR
Setting arguments refused
level is neither -1 nor 0..9, or strategy is outside 0..4; refusal changes no stream fields. Correct the arguments and retry in a legal stream phase; the new settings have not taken effect.
Z_STREAM_ERROR
Required flush refused
The arguments are valid, but a required deflate(Z_BLOCK) returns Z_STREAM_ERROR, for example after finishing began or when buffer conditions fail; new settings are not installed. Determine the stream phase and the buffer conditions the call started in. Once finishing began, follow the Z_FINISH protocol, or legally reset/end.
Z_STREAM_ERROR
Stream check failed
The stream check fails before normal operation; neither the stream nor result cells are written. Establish a live stream and the call preconditions; this result does not complete the operation.

Calling conditions and effects

Domain Restricted domain. Effect: update settings; may consume input and emit output.

Pre live stream before finishing, valid stream buffers and any active header; level is -1 or 0..9 and strategy is 0..4. To choose an exact input boundary, complete deflate(Z_BLOCK) until avail_out is nonzero and supply no new input before this call.

Proof goals.

  • Goal. Goal.deflateParams_safety (Safety/Streams.lean); required. Theorem: ZlibF.Spec.Public.StreamCallSafetyProof.deflateParams_safety (public-stream-call-safety.lean). The goal has two clauses: the refusal of a refused stream, and one call on a reachable stream. Goal.deflate_refusal (Safety/Refusals.lean), also required, states the same refusal.
  • 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. conditions 3 to 6 of deflate on the buffers and the gzip header (StreamBuffers, ActiveHeader): the call can run deflate(strm, Z_BLOCK).
  • Covered without condition. Every level and strategy, valid or not. Every reachable stream, in every phase: before the first deflate, mid-stream, while finishing, and after Z_STREAM_END. 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, the stream's own blocks and the avail_out bytes at next_out.
    • Allocations. On a reachable stream, the exact allocation account (LiveChange).
  • Not in this goal. 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). Which code is returned, the settings installed and the bytes written: functional goal Goal.deflateParams (not planned; not done).
Complete return conditions and boundaries

Post Z_OK installs the requested settings (level -1 means 6). Changing level restores that level's standard tuning values. A needed block flush uses the old settings and can consume some input and deliver output. I/O pointers, available counts and totals account for exactly those bytes; unconsumed input remains available.

Z_BUF_ERROR means the old block could not yet be completed; level and strategy remain unchanged, but compression progress and emitted output are retained. Provide more output room and retry. The live stream and its allocation set are preserved on either result.

Outside focused scope: invalid level/strategy gives Z_STREAM_ERROR without changes. A needed block flush can also return Z_STREAM_ERROR, including after finishing has begun.

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.deflateParams_safety

State: done · Status of the results

/-- `int deflateParams(z_streamp strm, int level, int strategy)`.
**Safety of `deflateParams`**: 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.deflateParams_safety : Prop :=
  (∀ h p level strategy, RefusedDeflate h p →
    C.run (Zlib.Deflate.deflateParams p level strategy) h = .ok (Z_STREAM_ERROR, h)) ∧
  (∀ h r level strategy,
     StreamCallDomain .deflate h r (.deflateParams (some r) level strategy) →
     StreamCallSafe .deflate h r (.deflateParams (some r) level strategy))
Related definitions and source ↗

Functional contract (beyond safety)

ZlibF.Spec.Public.Goal.deflateParams

State: not done, not planned · Status of the results

/-- `int deflateParams(z_streamp strm, int level, int strategy)`.
May consume input and write output while finishing the old block. A buffer error retains
the old parameters; successful changes select the canonical tuning row for a changed level. -/
def Goal.deflateParams : Prop :=
  ∀ h r i z s level strategy,
    StreamReachable .deflate h r → Zlib.Deflate.Spec.DGood h r i z s →
    StreamBuffers h r → ActiveHeader h r →
    ∃ rc after z' s' used out,
      C.run (Zlib.Deflate.deflateParams (some r) level strategy) h = .ok (rc, after) ∧
      Zlib.Deflate.Spec.DGood after r i z' s' ∧ StreamAccounting z z' used out.length ∧
      Bytes after z.next_out out.length out ∧
      (rc = Z_OK ∨ rc = Z_BUF_ERROR ∨ rc = Z_STREAM_ERROR) ∧
      (rc = Z_OK → s'.level = (if level = -1 then 6 else level) ∧ s'.strategy = strategy) ∧
      (rc ≠ Z_OK → s'.level = s.level ∧ s'.strategy = s.strategy) ∧
      ((level.toInt < -1 ∨ 9 < level.toInt ∨ strategy.toInt < 0 ∨ 4 < strategy.toInt) →
        rc = Z_STREAM_ERROR ∧ after = h) ∧
      BufferFrame h after (fun b => StreamRoot r b ∨ DeflateOwned i s b) [⟨z.next_out, out.length⟩] ∧
      LiveChange h after (fun _ => False) (fun _ => False) ∧ after.nalloc = h.nalloc
Related definitions and source ↗
ZLIB × LEAN

Contents

READING NOWdeflateParams