inflateResetKeep
Restart decoding while retaining history. This is an undocumented entry point.
Full chapter and shared rules ↗int ZEXPORT inflateResetKeep(z_streamp strm);
Restart decoding while retaining history. This is an undocumented entry point.
Return values and next calls
Return type. int — zlib status code
The result says whether decoding restarted while retaining the existing history.
inflateResetKeep()| Returned value | Meaning and conditions | Caller’s next step |
|---|---|---|
Z_OKRestarted with history retained |
The live stream passed the check; counters, buffered bits and header registration are cleared while window history remains. | Continue when retained history is intended; use inflateReset for an independent stream. |
Z_STREAM_ERRORStream check failed |
The common stream check failed; nothing changes. | Establish a valid stream and its ownership before further operations. |
Calling conditions and effects
Domain Restricted domain: live streams in any mode.
Effects Mutates state, no allocation or free.
Pre The common live-stream conditions hold. The caller deliberately wants the old window to remain usable by the next stream.
Proof goals.
- Goal. None of its own is required:
zlib.hdeclares this function under "undocumented functions (not part of the zlib API)". A call on a reachable stream is covered all the same, as one step of the required sequence goalGoal.inflate_sequence_safety(Safety/Sequences.lean; its statement isStreamSequenceSafetyin Common/Sequences.lean), second clause:StreamOperationlists this call. Theorem:Zlib.Inflate.Proofs.inflate_sequence_safety_public(public-inflate-sequence-safety.lean). - Applies when (the premises of that clause; this call has no argument condition):
strmis a reachable stream (StreamReachable);- the platform size bound holds (
ByteObjectsFit).
- Covered without condition. Every reachable stream, in every mode: before decoding, mid-block, at stream end, and after a data or memory error.
- Guarantees (the conclusion of that clause, which
StreamCallSaferestates).- Returns. The call returns.
- State. The stream keeps its invariant (
StreamInvariant). - Writes. Only the stream record and the stream's own blocks.
- Allocations. Exact allocation account (
LiveChange).
- Not in this goal. A NULL or inconsistent stream: no required goal covers it for this function. The field values after the call: functional goal
Goal.inflateResetKeep(not planned; a theorem proves it).
Complete return conditions and boundaries
Post Returns Z_OK. Clears totals, message, data_type, buffered bits,
dictionary-set status and header registration. Restarts header/block decoding with
the current wrapper, retaining the window and its history. For a wrapper, adler
is 1 if zlib is accepted, otherwise 0; raw leaves adler unchanged.
Edges Does not restore wrapper settings changed by recovery. A failed stream
check changes nothing. Use inflateReset to discard history.
Shared conditions and scope
Use an inflate stream to decode input in pieces while controlling output space. Select zlib,
gzip or raw DEFLATE at initialization, then continue with more input or room until completion,
a dictionary request or an error. inflateEnd releases the decoder after any of those outcomes.
For whole-buffer zlib decoding, see uncompress.
| Task | Entries |
|---|---|
| Start or reuse | Init, configured init, reset, new configuration, keep history |
| Decode or provide metadata | Inflate, set dictionary, read history, gzip header |
| Recover or inspect | Sync search, sync point, mark, table use |
| Adjust or branch | Prime bits, validation, distance option, copy |
| Release storage | End |
The contracts follow the pinned inflate.c with patch 0001 applied and zlib.h, in the default
LP64 Linux build, with gzip enabled and without the optional invalid-distance or strict-distance
modes. Patch 0001 changes inflateCopy only (patches).
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 Edges.
A call outside Pre is not thereby undefined, and it need not return an error code.
See how to read a contract for the 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.
Common conditions
The caller and the decoder keep different things. The caller supplies the input and output buffers of each call. The decoder keeps the current parsing stage, the bits not yet used, and the history that later copies may need. Giving it a different output array does not start a new decoding task.
next_in is the start of the unread input and avail_in the number of readable bytes. next_out
is the next output position and avail_out the number of writable bytes that remain from there.
For example, a 5-byte output array that returns with 2 bytes of room has received 3 bytes. Take
those bytes first, then set the pointer and the count to the next writable region.
All contracts below have a Restricted domain. A C pointer type alone does not supply the storage, lifetime or call history required here.
- A live stream was successfully initialised or copied, has not been ended, retains its library-owned state, and is used without concurrent calls. Use the default allocator and free function. Init takes a writable, non-live stream with allocator fields set to NULL or the default functions.
- A readable or writable range has the stated capacity for the whole call. Caller ranges are separate from the stream and its owned storage. Input and output ranges do not overlap. Dictionary destinations, the registered header record and its destination buffers are separate from each other and from the stream. Registered header storage is also separate from input/output ranges on calls using it. These restrictions are part of Pre; each entry's Proof goals says which of them its goal assumes.
- The caller owns its stream object and buffers. The library owns the state and optional window. A call changes only its stream, owned storage, stated output ranges and any registered header destination. It never frees caller buffers.
- A rejected stream check returns
Z_STREAM_ERRORwithout changes, unless a query or copy contract says otherwise. This covers NULL and safely readable records rejected by the check; it does not cover dangling or arbitrary pointers. The check requires allocators, state, the state's back-pointer and a valid mode. - Counters use the C unsigned widths and wrap. No contract assumes allocation succeeds. End remains available after decoding, dictionary or allocation errors.
- 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.
inflateEndends the history. - Result cells as values.
inflateGetDictionaryreports a length throughuInt *dictLength. The translation does not model that cell as memory: the function takes the cell's old value, or the fact that the pointer is NULL, and returns the new value. So the goal says nothing about the address of the cell, and a cell that overlaps another object cannot be expressed.
flowchart LR
I["Init"] --> F["inflate"]
F -->|"Z_NEED_DICT"| D["SetDictionary"] --> F
F -->|"more room or input"| F
F -->|"end or abandon"| E["End"]
F -->|"data error"| R["Reset or Sync"] --> F
Functional contract (beyond safety)
ZlibF.Spec.Public.Goal.inflateResetKeep
State: done · Status of the results
/-- `int inflateResetKeep(z_streamp strm)`.
Clear decode progress and counters; retain the allocated window and its dictionary. -/
def Goal.inflateResetKeep : Prop :=
∀ h r i z s, InflateView h r i z s →
C.run (Zlib.Inflate.inflateResetKeep (some r)) h = .ok (Z_OK,
putInflate (r.put h (inflateResetStream z s)) i (inflateResetState i s))Related definitions and source ↗