inflateGetDictionary
Read the retained sliding history, oldest byte first.
Full chapter and shared rules ↗int ZEXPORT inflateGetDictionary(z_streamp strm, Bytef *dictionary, uInt *dictLength);
Read the retained sliding history, oldest byte first.
Return values and next calls
Return type. int — zlib status code
The return value reports query status; the history size is written to dictLength rather than returned.
inflateGetDictionary()| Returned value | Meaning and conditions | Caller’s next step |
|---|---|---|
Z_OKHistory query succeeded |
The stream check passed; non-NULL dictionary receives oldest-to-newest history and non-NULL dictLength receives its byte count. | Use the requested destination results; the stream remains usable, and empty history is valid. |
Z_STREAM_ERRORQuery refused |
The stream check failed; no destination is written. | Do not treat previous destination contents as this call’s result; establish a valid stream first. |
Calling conditions and effects
Domain Restricted domain: live streams with optional writable dictionary and length destinations.
Effects Observes state and writes only those destinations.
Pre A non-NULL dictionary has room for the retained history; 32768 bytes is
always enough. Non-NULL dictLength points to writable uInt storage.
Proof goals.
- Goal.
Goal.inflateGetDictionary_safety(Safety/Streams.lean); required. Theorem:ZlibF.Spec.Public.StreamCallSafetyProof.inflateGetDictionary_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.inflate_refusal(Safety/Refusals.lean), also required, states the same refusal. - Applies when. The refusal asks that
strmis a refused stream (RefusedInflate). The call on a reachable stream asks (StreamCallDomain):strmis a reachable stream (StreamReachable);- the platform size bound holds (
ByteObjectsFit); dictionaryis NULL or points to as many writable bytes as the window holds (state->whave, never more than 32768), outside the stream's own blocks (CallerRange).
- Covered without condition. Every reachable stream, in every mode: before decoding, mid-block, at stream end, and after a data or memory error.
dictLengthis a value in the translation, not memory (common conditions), so the goal asks nothing of that pointer, while Pre asks for a writableuInt. 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_ERRORand leaves the length value as it was passed. 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 bytes within the
state->whavebytes atdictionary, the bytes the call copies; for aNULLdictionary, no caller memory. - Allocations. On a reachable stream, the exact allocation account (
LiveChange).
- 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 a deflate state: no goal covers this call on such a record (deviations). The bytes copied and the length reported: functional goalGoal.inflateGetDictionary(not planned; a theorem proves it).
Complete return conditions and boundaries
Post Returns Z_OK. Copies the history if dictionary is non-NULL and stores
its size if dictLength is non-NULL. Allocates/frees nothing; leaves stream unchanged.
Edges Either destination may be NULL. Fresh history is empty. A stream finished without allocating a window can also have empty history despite having produced output. A failed stream check writes nothing.
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
Safety goal
ZlibF.Spec.Public.Goal.inflateGetDictionary_safety
State: done · Status of the results
/-- `int inflateGetDictionary(z_streamp strm, Bytef *dictionary, uInt *dictLength)`.
**Safety of `inflateGetDictionary`**: a `NULL` or inconsistent stream (`RefusedInflate`) is refused
with `Z_STREAM_ERROR` and nothing changed; and on every reachable inflate stream, with the caller's
arguments as `zlib.h` asks, the call is safe (`StreamCallSafe`). -/
def Goal.inflateGetDictionary_safety : Prop :=
(∀ h p dictionary dictLength, RefusedInflate h p →
C.run (Zlib.Inflate.inflateGetDictionary p dictionary dictLength) h =
.ok ((Z_STREAM_ERROR, dictLength), h)) ∧
(∀ h r dictionary dictLength,
StreamCallDomain .inflate h r (.inflateGetDictionary (some r) dictionary dictLength) →
StreamCallSafe .inflate h r (.inflateGetDictionary (some r) dictionary dictLength))Related definitions and source ↗Functional contract (beyond safety)
ZlibF.Spec.Public.Goal.inflateGetDictionary
State: done · Status of the results
/-- `int inflateGetDictionary(z_streamp strm, Bytef *dictionary, uInt *dictLength)`.
Return the chronological window, optionally copy it, and preserve an omitted length cell. -/
def Goal.inflateGetDictionary : Prop :=
∀ h r i z s dest oldLength xs,
Zlib.Inflate.Spec.Good h r i z s → InflateDictionary h s xs →
(dest ≠ .null → Writable h dest xs.length ∧ Separate dest xs.length s.window s.wsize.toNat) →
∃ after, C.run (Zlib.Inflate.inflateGetDictionary (some r) dest oldLength) h =
.ok ((Z_OK, oldLength.map (fun _ => UInt32.ofNat xs.length)), after) ∧
Store h dest (if dest = .null then [] else xs) afterRelated definitions and source ↗