Skip to content
REFERENCE / ZLIB × LEAN

inflateGetHeader

Register caller storage for the next gzip header.

Full chapter and shared rules ↗
int ZEXPORT inflateGetHeader(z_streamp strm, gz_headerp head);

Register caller storage for the next gzip header.

A gzip header can carry extra bytes, a file name and a comment. The caller gives a destination and a capacity for each: extra and extra_max, name and name_max, comment and comm_max, all in bytes. Registration only stores these addresses; later inflate calls parse the header and fill them.

Return values and next calls

Return type. int — zlib status code

The return value only says whether header storage was registered; head->done later reports parsing progress.

inflateGetHeader()
Returned value Meaning and conditions Caller’s next step
Z_OK
Header storage registered
The valid stream supports gzip; head is registered and head->done is set to 0, without parsing the header yet. Keep all registered storage valid and call inflate; inspect done for the later outcome.
Z_STREAM_ERROR
Registration refused
The stream check failed or the request lacks gzip support; nothing changes. Establish a valid gzip-capable stream, then register storage before decoding.

Calling conditions and effects

Domain Restricted domain: live gzip-capable streams after init/reset and before decoding.

Effects Registers borrowed storage and writes head->done.

Pre head is non-NULL and writable. Its extra, name, comment pointers are NULL or have writable capacities extra_max, name_max, comm_max. Keep all registered storage valid until header parsing ends or the request is cleared. The header record and its destination buffers stay separate from each other, the stream and its owned storage, and the input/output ranges of calls using them.

Proof goals.

  • Goal. Goal.inflateGetHeader_safety (Safety/Streams.lean); required. Theorem: ZlibF.Spec.Public.StreamCallSafetyProof.inflateGetHeader_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 strm is a refused stream (RefusedInflate). The call on a reachable stream asks (StreamCallDomain):
    1. strm is a reachable stream (StreamReachable);
    2. the platform size bound holds (ByteObjectsFit);
    3. head is not NULL and names a live header record that is not one of the stream's own blocks; each of its extra, name and comment pointers is NULL or points to extra_max, name_max or comm_max writable bytes outside the stream's own blocks (HeaderMemory; StreamArguments adds that head is not NULL).
  • Covered without condition. Every reachable stream, in every mode: before decoding, mid-block, at stream end, and after a data or memory error. The goal is wider than Pre: the stream need not support gzip. 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 header record head.
    • Allocations. On a reachable stream, the exact allocation account (LiveChange).
  • Not in this goal. A NULL head on a reachable stream: outside every safety goal (deviations, row "Header arguments"). On a stream without gzip support the C returns Z_STREAM_ERROR before it uses head; the functional goal Goal.inflateGetHeader states that return. A stream record with zalloc and zfree set whose state is 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 return value and what later inflate calls store in the record: functional goal Goal.inflateGetHeader (not planned; a theorem proves it).
Complete return conditions and boundaries

Post Returns Z_OK, retains the pointer and sets done to 0. Later inflate calls fill scalar fields and available buffer prefixes. With an extra field, extra_len is its actual length; without one, extra becomes NULL and extra_len is unchanged. Names/comments are terminated only if the terminator fits. Absent optional fields set the corresponding pointer to NULL. Completion sets done to 1; automatic detection of zlib sets it to -1.

Edges No allocation or ownership transfer. Reset clears registration. A failed stream check or request without gzip support returns Z_STREAM_ERROR unchanged. NULL head on an accepted request is outside this contract: the C dereferences it.

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_ERROR without 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. inflateEnd ends the history.
  • Result cells as values. inflateGetDictionary reports a length through uInt *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.inflateGetHeader_safety

State: done · Status of the results

/-- `int inflateGetHeader(z_streamp strm, gz_headerp head)`.
**Safety of `inflateGetHeader`**: 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.inflateGetHeader_safety : Prop :=
  (∀ h p head, RefusedInflate h p →
    C.run (Zlib.Inflate.inflateGetHeader p head) h = .ok (Z_STREAM_ERROR, h)) ∧
  (∀ h r head,
     StreamCallDomain .inflate h r (.inflateGetHeader (some r) head) →
     StreamCallSafe .inflate h r (.inflateGetHeader (some r) head))
Related definitions and source ↗

Functional contract (beyond safety)

ZlibF.Spec.Public.Goal.inflateGetHeader

State: done · Status of the results

/-- `int inflateGetHeader(z_streamp strm, gz_headerp head)`.
Only gzip-capable wrappers accept the header. Set `done` to zero and retain all other fields. -/
def Goal.inflateGetHeader : Prop :=
  ∀ h r i z s head, InflateView h r i z s →
    ((s.wrap &&& 2) ≠ 0 → ∃ g gh, head = some (.tab g) ∧ h.gzheaders g = some gh) →
    ∃ rc after, C.run (Zlib.Inflate.inflateGetHeader (some r) head) h = .ok (rc, after) ∧
      (if (s.wrap &&& 2) = 0 then rc = Z_STREAM_ERROR ∧ after = h
       else ∃ g gh, head = some (.tab g) ∧ h.gzheaders g = some gh ∧ rc = Z_OK ∧
         after = { putInflate h i { s with head := head } with
           gzheaders := upd h.gzheaders g (some { gh with done := 0 }) })
Related definitions and source ↗
ZLIB × LEAN

Contents

READING NOWinflateGetHeader