deflatePrime
Prefix raw compression output with a caller-supplied bit fragment.
Full chapter and shared rules ↗int ZEXPORT deflatePrime(z_streamp strm, int bits, int value);
Prefix raw compression output with a caller-supplied bit fragment.
Return values and next calls
Return type. int — zlib status code
The result says whether a bit fragment joined pending output. A buffer-space refusal inserts none of the fragment.
deflatePrime()| Returned value | Meaning and conditions | Caller’s next step |
|---|---|---|
Z_OKBits appended |
The stream check passes, bits is 0..16 and pending space is sufficient; the low bits bits of value are appended least significant first, with complete bytes entering pending output. | Within Pre, insert only before the first deflate on a raw stream and account for the prefix when interpreting output; no bytes are delivered to next_out. |
Z_BUF_ERRORBit count out of range |
bits is outside 0..16; refusal occurs before pending-byte compaction and inserts no bits. | Correct the count and satisfy the priming preconditions before another call. |
Z_BUF_ERRORInsufficient pending space |
bits is 0..16 but the pending buffer lacks room for the fragment; no bits are inserted, though existing pending bytes may have been compacted. | Repeating the same call does not create space; legally handle pending output within the chosen bit-splicing protocol before deciding whether to retry. |
Z_STREAM_ERRORStream 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. |
Reading the result.
- The implementation does not check wrapper or first-call timing; accepting a fragment alone does not guarantee ordinary stream validity after arbitrary insertion.
Calling conditions and effects
Domain Restricted domain. Effect: append bits to pending output.
Pre live raw stream before its first deflate after init or deflateReset;
bits is 0..16 and value is any int. The caller accounts for these prefix bits
when interpreting the later compressed stream.
Proof goals.
- Goal.
Goal.deflatePrime_safety(Safety/Streams.lean); required. Theorem:ZlibF.Spec.Public.StreamCallSafetyProof.deflatePrime_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
strmis a refused stream (RefusedDeflate). The call on a reachable stream asks (StreamCallDomain):strmis a reachable stream (StreamReachable);- the platform size bound holds (
ByteObjectsFit); - no
deflatecall has started the stream since init ordeflateReset: its status is stillINIT_STATEorGZIP_STATE(DeflateNotStarted).
- Covered without condition. Every
bitsandvalue; every wrapper. The call order is the same as in Pre. In the refusal: every refused stream and every value of the other arguments. - Guarantees (
StreamCallSafefor 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).
- Returns. On a refused stream the call returns
- Not in this goal. A call after
deflatehas started the stream: outside every safety goal (deviations, row "Other stream arguments"). A stream record withzallocandzfreeset 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 code is returned and the pending bits after the call: functional goalGoal.deflatePrime(not planned; not done).
Complete return conditions and boundaries
Post Z_OK appends the low bits bits of value, least significant first,
to the logical pending bit sequence. Complete bytes join pending output and fewer than
8 bits remain buffered. No bytes are delivered to next_out; no allocation occurs.
Z_BUF_ERROR inserts no bits when the pending buffer has insufficient space.
Existing pending bytes may be compacted within their owned buffer before that refusal.
Outside focused scope: counts outside 0..16 give Z_BUF_ERROR before compaction;
a failed stream check gives Z_STREAM_ERROR. The functional goal covers the exact pending-bit
effects for every wrapper and every call order.
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.deflatePrime_safety
State: done · Status of the results
/-- `int deflatePrime(z_streamp strm, int bits, int value)`.
**Safety of `deflatePrime`**: 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.deflatePrime_safety : Prop :=
(∀ h p bits value, RefusedDeflate h p →
C.run (Zlib.Deflate.deflatePrime p bits value) h = .ok (Z_STREAM_ERROR, h)) ∧
(∀ h r bits value,
StreamCallDomain .deflate h r (.deflatePrime (some r) bits value) →
StreamCallSafe .deflate h r (.deflatePrime (some r) bits value))Related definitions and source ↗Functional contract (beyond safety)
ZlibF.Spec.Public.Goal.deflatePrime
State: not done, not planned · Status of the results
/-- `int deflatePrime(z_streamp strm, int bits, int value)`.
Append the requested low bits in transmission order. Compaction can occur before a buffer
error; invalid bit counts are refused before compaction. No allocation occurs. -/
def Goal.deflatePrime : Prop :=
∀ h r i z s count value old,
Zlib.Deflate.Spec.DGood h r i z s → PendingBits h s old →
∃ rc after s', C.run (Zlib.Deflate.deflatePrime (some r) count value) h = .ok (rc, after) ∧
Zlib.Deflate.Spec.DGood after r i z s' ∧
(count.toInt < 0 ∨ 16 < count.toInt → rc = Z_BUF_ERROR ∧ after = h) ∧
(0 ≤ count.toInt → count.toInt ≤ 16 →
s'.pending_out = s'.pending_buf ∧
if s.pending_buf_size.toNat - s.pending.toNat < (s.bi_valid.toInt.toNat + count.toInt.toNat) / 8 then
rc = Z_BUF_ERROR ∧ PendingBits after s' old
else rc = Z_OK ∧ PendingBits after s'
(old ++ (List.range count.toInt.toNat).map (fun j => decide (value.toUInt32.toNat / 2 ^ j % 2 = 1)))) ∧
Frame h after (DeflateOwned i s) ∧ LiveChange h after (fun _ => False) (fun _ => False) ∧
after.nalloc = h.nallocRelated definitions and source ↗