deflateEnd
Release the compressor, discarding any unfinished work.
Full chapter and shared rules ↗int ZEXPORT deflateEnd(z_streamp strm);
Release the compressor, discarding any unfinished work.
Return values and next calls
Return type. int — zlib status code
The result distinguishes the compression phase before release. Both Z_OK and Z_DATA_ERROR release all five stream allocations and clear state.
deflateEnd()| Returned value | Meaning and conditions | Caller’s next step |
|---|---|---|
Z_OKState released |
The live stream’s saved status is not BUSY_STATE; every stream allocation is freed exactly once and state is NULL. | Retain caller-owned buffers and header; initialize again before compression. The result alone does not confirm delivery of all output. |
Z_DATA_ERRORUnfinished task released |
The live stream’s saved status is BUSY_STATE, reporting unfinished compression; all stream allocations are nevertheless freed and state is NULL. | Do not call deflateEnd again for cleanup; unfinished compression has been abandoned, and further compression requires initialization. |
Z_STREAM_ERROREnd refused |
The stream check fails, including a second End; this call frees nothing. | Do not treat this result as successful release; establish the actual stream lifetime before any compression or attempted cleanup. |
Calling conditions and effects
Domain Restricted domain. Effect: free owned state.
Pre live stream in any phase, with the default free routine intact.
Proof goals.
- Goal.
Goal.deflateEnd_safety(Safety/Streams.lean); required. Theorem:ZlibF.Spec.Public.StreamCallSafetyProof.deflateEnd_safety(public-stream-call-safety.lean). The goal has two clauses: the refusal of a refused stream, and the end of a reachable stream. - Applies when. The refusal asks that
strmis a refused stream (RefusedDeflate). The end of a reachable stream asks thatstrmis a reachable stream (StreamReachable); the platform size bound is not asked. - Covered without condition. Every reachable stream, in every phase: before the first
deflate, mid-stream, while finishing, and afterZ_STREAM_END. In the refusal: every refused stream. - Guarantees.
- Returns. On a refused stream the call returns
Z_STREAM_ERROR. On a reachable stream the call returns, withZ_OKorZ_DATA_ERROR. - State. On a reachable stream,
strm->stateis NULL after the call. - 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): the stream's own blocks are freed; nothing else is freed and nothing is allocated.
- Returns. On a refused stream the call returns
- Not in this goal. A stream record with
zallocandzfreeset whosestateis 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 of the two codes is returned, and the values of the other stream fields: functional goalGoal.deflateEnd(not planned; a theorem proves it).
Complete return conditions and boundaries
Post free all five owned allocations exactly once and set state to NULL.
Caller input/output and header storage are unchanged and remain caller-owned.
Return Z_DATA_ERROR if the saved status is busy, otherwise Z_OK.
Both results release everything: Z_DATA_ERROR reports unfinished compression, not failed cleanup.
No later compression call is valid until reinitialisation.
Outside focused scope: a failed stream check, including a second end, returns
Z_STREAM_ERROR without freeing anything. Return status depends on internal compression
phase, not merely whether every produced byte was delivered.
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_streamwith 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_inreadable bytes; output coversavail_outwritable 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
deflateEndfree 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
nameandcommenthave a terminating zero;extracovers its stated length. The contracts on this page takeextra_len <= 65535. - Checked refusals: except for init and bounds, a failed stream check returns
Z_STREAM_ERRORbefore normal operation, without writes.deflateCopyadditionally 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.
deflateEndends the history. - Result cells as values:
deflateGetDictionary,deflatePendinganddeflateUsedreport 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.deflateEnd_safety
State: done · Status of the results
/-- `int deflateEnd(z_streamp strm)`.
**Safety of `deflateEnd`**: a `NULL` or inconsistent stream (`RefusedDeflate`) is refused with
`Z_STREAM_ERROR` and nothing changed; and, by clause 3 of `StreamSequenceSafety .deflate`: on every
reachable deflate stream the call returns `Z_OK`, or `Z_DATA_ERROR` when the stream was freed
prematurely, without a fault; it clears the state pointer, writes only the stream record and its
blocks, and frees exactly the blocks the stream owns (no leak). -/
def Goal.deflateEnd_safety : Prop :=
(∀ h p, RefusedDeflate h p → C.run (Zlib.Deflate.deflateEnd p) h = .ok (Z_STREAM_ERROR, h)) ∧
(∀ h r, StreamReachable .deflate h r →
∃ rc after z, C.run (Zlib.Deflate.deflateEnd (some r)) h = .ok (rc, after) ∧
(rc = Z_OK ∨ rc = Z_DATA_ERROR) ∧
r.get after = some z ∧ z.state = none ∧
Frame h after (fun b => StreamRoot r b ∨ StreamOwned h r b) ∧
LiveChange h after (fun _ => False) (StreamOwned h r))Related definitions and source ↗Functional contract (beyond safety)
ZlibF.Spec.Public.Goal.deflateEnd
State: done · Status of the results
/-- `int deflateEnd(z_streamp strm)`.
Free all five owned blocks. An unfinished busy stream returns `Z_DATA_ERROR` after freeing. -/
def Goal.deflateEnd : Prop :=
∀ h r i z s, Zlib.Deflate.Spec.DGood h r i z s → z.zfree = .fn "zcfree" →
∃ after, C.run (Zlib.Deflate.deflateEnd (some r)) h =
.ok ((if s.status = BUSY_STATE then Z_DATA_ERROR else Z_OK), after) ∧
r.get after = some { z with state := none } ∧
LiveChange h after (fun _ => False) (DeflateOwned i s) ∧
Frame h after (fun b => StreamRoot r b ∨ DeflateOwned i s b) ∧
after.nalloc = h.nalloc ∧ after.nextBlk = h.nextBlkRelated definitions and source ↗