Skip to content
REFERENCE / ZLIB × LEAN

zlibVersion

Returns the linked library's release string.

Full chapter and shared rules ↗
const char * ZEXPORT zlibVersion(void);

Returns the linked library's release string.

Return values and next calls

Return type. const char * — Borrowed immutable version-string pointer

Returns the version string of the linked library.

zlibVersion()
Returned value Meaning and conditions Caller’s next step
ZLIB_VERSION
Library version string
No arguments; returns a non-NULL, NUL-terminated string, 1.4 in the pinned source. Read this static string; do not write to or free it.

Calling conditions and effects

Domain Full type domain.

Pre Full type domain; no arguments or caller state are required.

Effects Read-only. The result is borrowed immutable static storage; the caller must neither write it nor free it. No allocation or heap change occurs.

Proof goals.

  • Goal. Goal.zlibVersion_safety (Safety/Queries.lean); required. Theorem: ZlibF.Spec.Public.StatelessSafetyProof.zlibVersion_safety (public-stateless-safety.lean).
  • Applies when. Always: the statement has no premise.
  • Covered without condition. Every heap, also one that is not a library heap.
  • Guarantees.
    • Returns. The call returns.
    • State, writes, allocations. None: the heap after the call is the heap before it.
  • Not in this goal. The string the result points to: functional goal Goal.zlibVersion (not planned; a theorem proves it).
Complete return conditions and boundaries

Post Returns a non-NULL pointer to NUL-terminated ZLIB_VERSION (1.4 in the pinned source).

Shared conditions and scope

Use the buffer utilities when the complete input and output capacity are known at the call. They manage a temporary stream internally. Use the stream pages when you need incremental I/O, a different wrapper, a dictionary or explicit flush boundaries.

Task Entries
Compress a buffer Choose a level, default level, size the destination
Decompress a buffer Report input consumed, output only
Inspect the library Version, compile flags, error text

The contracts follow the pinned compress.c, uncompr.c, zutil.c and zlib.h in the default LP64 Linux build. No patch touches these three C files (patches). _z forms use z_size_t; plain forms use uLong. Both are 64-bit here. See contract conventions for domain/effect labels. These are focused contracts: Pre describes ordinary correct use and is deliberately narrower than what the function accepts. A call outside Pre is not thereby undefined, and it need not return an error code.

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.

The safety goals of the buffer utilities instantiate three statements (Common/Utilities.lean): CompressorSafety for the four compression functions, UncompressCountedSafe for uncompress2 and uncompress2_z, and UncompressSingleSafe for uncompress and uncompress_z.

The buffer utilities create and release a local stream with the zlib wrapper and default settings. The stream record is an automatic variable, not a heap block, so it takes no allocation attempt. The allocation attempts of a call are those of the codec. A compress* call attempts at most five, all in deflateInit: the state, the window, prev, head and the pending buffer; it attempts none when it refuses its arguments or the level. An uncompress* call attempts the decoder state in inflateInit, and the window inside inflate when decoding needs it.

First the convention for the lengths. sourceLen gives the number of readable input bytes. *destLen is the writable capacity of the destination array before the call, and the number of bytes written after it. For example, with a destination of 1000 bytes into which 120 bytes are written, set *destLen = 1000 before the call and read 120 after a successful return. The length cell is itself caller storage that stays live, readable and writable. For uncompress2_z, *sourceLen likewise gives the available input before the call and reports the bytes consumed after it.

The bound functions only compute a number; they do not allocate the destination array.

flowchart LR
    B["compressBound"] --> C["compress / compress2"]
    C --> Z["zlib stream"] --> U["uncompress / uncompress2"]
    U --> D["decoded bytes"]

Common conventions

For buffer calls, the domain is restricted to valid memory: non-NULL sources cover the stated readable input; non-NULL destinations cover the stated writable capacity. Non-NULL length pointers name readable, writable scalar cells. Input, output and length cells are separate, including the two length cells when both occur. The caller keeps those objects live and does not modify them during the call. Each entry states its allowed NULL cases. Other invalid pointers are outside this scope. Decompression error handling needs no valid compressed-data assumption.

Common effects. Every in-scope call terminates without a fault. Buffer calls preserve input and memory outside the output and length cells. They write at most the original capacity. All internal allocations are released before return, including on allocation failure; the call leaves the caller no local stream and no allocation of its own. Pointer-valued queries return borrowed immutable storage. The safety goals named under Proof goals state these effects, without the claim about borrowed storage; the content of the output is functional behaviour.

Length cells in the model. For compress, compress2 and their _z forms, the translation passes *destLen as a value: the function takes the capacity, or the fact that destLen is NULL, and returns the length to store. The cell is not memory in the model, so the safety goals of these four functions cannot speak about a cell that overlaps the source or the destination (deviations, row "Whole-buffer compression"). For the uncompress family the cells are memory, 8 readable and writable bytes each, and their separation from the buffers is a stated condition of the goal.

Safety goal

ZlibF.Spec.Public.Goal.zlibVersion_safety

State: done · Status of the results

/-- `const char *zlibVersion(void)`.
**Safety of `zlibVersion`**: on every heap the call returns and the heap is unchanged. -/
def Goal.zlibVersion_safety : Prop :=
  ∀ h : Heap, ∃ p, C.run Zlib.Zutil.zlibVersion h = .ok (p, h)
Related definitions and source ↗

Functional contract (beyond safety)

ZlibF.Spec.Public.Goal.zlibVersion

State: done · Status of the results

/-- `const char *zlibVersion(void)`.
Every heap returns the pinned header's version string, as static read-only storage.
The call terminates without a fault, allocates nothing and changes no heap observation. -/
def Goal.zlibVersion : Prop :=
  ∀ h : Heap, ∃ p,
    C.run Zlib.Zutil.zlibVersion h = .ok (p, h) ∧ StaticString h p ZLIB_VERSION
Related definitions and source ↗
ZLIB × LEAN

Contents

READING NOWzlibVersion