inflateCopy
创建可以从源位置继续的解码器。
完整章节与共同规则 ↗int ZEXPORT inflateCopy(z_streamp dest, z_streamp source);
创建可以从源位置继续的解码器。
返回值与后续调用
返回值类型。 int — zlib 状态码
结果说明目的流是否获得一个可独立结束的解码器副本。
inflateCopy()| 返回值 | 含义与出现条件 | 调用者接下来 |
|---|---|---|
Z_OK解码状态已复制 |
有效源被复制到另一个不是存活流的目的流;目的流拥有独立状态和所需窗口,源不变。 | 两个流最终都须 inflateEnd;继续前提供分离的可写目的缓冲区并维持共享指针的生命周期。 |
Z_STREAM_ERROR复制请求被拒绝 |
dest 为 NULL 或源流检查失败;非 NULL dest 的 state 清空,其他字段不变,源不变。 | 修正源和目的流后再复制;本次失败未建立需结束的目的流。 |
Z_MEM_ERROR副本分配失败 |
状态或窗口分配失败;本次已分配存储全部释放,目的流的 state 为 NULL,源不变。 | 资源可用时可重新复制;本次失败的目的流无需 inflateEnd,源仍须正常结束。 |
调用条件与效果
定义域 受限定义域:存活的源流,以及与之不同、可写、不是存活流的目的流。
内存与状态效果 分配独立状态,并在源有窗口时分配窗口。
前置条件 源满足公共条件。目的流不与源或源拥有的存储重叠。共享的输入/输出和头部指针保留各自的调用者生命周期;使用前为各个流提供独立的可写目的缓冲区。
证明目标。
- 目标。
Goal.inflateCopy_safety(Safety/Copy.lean);必需。定理:ZlibF.Spec.Public.InflateCopySafetyProof.inflateCopy_safety(public-inflate-copy-safety.lean)。这个目标有四个子句:对 NULLdest的拒绝;对 NULLsource的拒绝;从可达的源复制(主子句);对属于被拒绝的流的source的拒绝。Goal.inflate_refusal(Safety/Refusals.lean)也是必需目标,它同样陈述对被拒绝的源的拒绝。 - 适用条件。 对 NULL
dest的拒绝没有条件。对 NULLsource的拒绝要求dest指向一个可读的流记录。对被拒绝的source的拒绝要求dest指向一个可读的流记录,并要求source不是 NULL 且是被拒绝的流(RefusedInflate);它不要求dest与source不同。主子句要求:source是可达流(StreamReachable)。命题还把它的不变量和默认分配器作为假设(Good、DefAlloc);每个可达流都满足它们(Goal.inflate_sequence_safety的第一个子句);dest指向一个可读的流记录,且不是source记录(source ≠ dest)。不要求平台大小上界。
- 无条件覆盖。
dest记录的每一种内容;每一种分配结果。拒绝子句中:dest记录的每一种内容,每一个被拒绝的source,以及dest为 NULL 时的每一个source指针。本目标比前置条件宽:dest可以是存活流;这时它的旧状态仍处于已分配状态,而记录不再指向它。 - 保证。
- 返回。
dest为 NULL、source为 NULL 或source被拒绝时,调用返回Z_STREAM_ERROR。从可达的源复制时,调用返回,返回值为Z_OK或Z_MEM_ERROR。只有在某次分配确实失败之后才返回Z_MEM_ERROR(AllocationFailed)。 - 状态。 从可达的源复制时:
source记录及其状态不变。返回Z_OK时,dest是可达流。返回Z_MEM_ERROR时,dest->state为 NULL,dest的其他字段不变。 - 写入。
dest为 NULL 时不写任何内容:堆不变。source为 NULL 或被拒绝时,只写dest->state,把它置为 NULL;dest的其他字段和堆的其余部分不变。从可达的源复制时,只写dest记录和调用自己分配的块。 - 分配。 三种拒绝都不分配也不释放任何块。从可达的源复制时:返回
Z_OK时,新块恰好是新状态记录的那些块:记录本身,以及它的窗口(如果有)。不释放任何块。安全目标没有说dest->state指向这个记录;功能目标Goal.inflateCopy说了这一点。返回Z_MEM_ERROR时,已分配的块与调用前相同。
- 返回。
- 不在本目标内。
zalloc和zfree已设置、而state是垃圾指针、指向已释放的状态或指向 deflate 状态的source记录:没有目标覆盖从这种源的复制(见偏离记录)。source可达而dest == source:没有目标覆盖这个调用(见偏离记录中“复制的目的流”一行)。副本的内容:功能目标Goal.inflateCopy(不在计划内;已有定理证明它)。
完整返回条件与边界
返回与保证 Z_OK 复制解码位置、历史和流字段。两个流独立拥有各自状态/窗口,都必须结束。源不变。调用者缓冲区指针、消息和任何已挂接的头部指针共享,不做深复制。不消费或产生调用者数据。
错误路径 NULL dest 返回 Z_STREAM_ERROR。其他拒绝会清空非 NULL dest 的 state,除此以外不变。分配失败返回 Z_MEM_ERROR,并释放本次尝试的全部分配。源不变。
边界情况 源为存活流而 dest == source 的调用不在本契约范围内。此时 C 先用 zmemcpy(dest, source, sizeof(z_stream)) 把记录复制到它自身,这是未定义行为;随后把 dest->state 设为新状态。此后不再有指针指向原来的状态,这一点尚未由证明确认。源被拒绝时,C 在复制之前就返回 Z_STREAM_ERROR,与其他拒绝相同。未打补丁的 C 在这个函数里比较了互不相关的指针;补丁 0001 替换了这处比较(见补丁说明)。
本组共同前提与范围
使用 inflate 流分批解码输入,同时控制输出空间。初始化时选择 zlib、gzip 或裸 DEFLATE,随后提供更多输入或空间继续,直到完成、请求字典或发生错误。无论出现哪种结果,inflateEnd 都可释放解码器。整块缓冲区的 zlib 解码见 uncompress。
| 任务 | 条目 |
|---|---|
| 开始或复用 | 初始化、配置初始化、重置、新配置、保留历史 |
| 解码或提供元数据 | 解压、设置字典、读取历史、gzip 头 |
| 恢复或检查 | 同步搜索、同步点、位置标记、表使用量 |
| 调整或分支 | 预置位、校验、距离选项、复制 |
| 释放存储 | 结束 |
这些契约遵循打上补丁 0001 之后的固定版本 inflate.c 以及 zlib.h,采用默认 LP64 Linux 构建,启用 gzip,不启用可选的无效距离或严格距离模式。补丁 0001 只改动 inflateCopy(见补丁说明)。这些是聚焦契约:前置条件描述通常的正确用法,有意比函数实际接受的范围窄。前置条件之外、C 仍会处理的情况,写在“错误”或“边界情况”下。超出前置条件的调用并不因此就是未定义行为,也不一定返回错误码。各标签的含义见契约约定。
已证明的内容。 只证明安全性:每次调用都返回,没有未定义行为和内存错误,只写其目标指明的内容,并且不泄漏(见安全性)。各条目在“证明目标”下给出自己的目标,所用的五项和固定用语由阅读证明目标段落定义:目标及其定理;目标适用的条件,按 Lean 命题中的顺序列出;对每一个取值都覆盖的内容;保证的内容(返回、状态、写入、分配);以及留给其他目标的内容。证明所假设的是那里列出的条件,而不是文档中的前置条件。后置条件、返回值表和各项说明描述的是功能行为:它们读自 C 源码,凡是没有定理陈述的,都尚未由证明确认;安全结论不需要它们。哪些目标已完成,见进度。
公共条件
调用者与解码器各自保留不同的内容。调用者提供每次调用的输入和输出缓冲区;解码器保留当前解析阶段、尚未用完的位,以及后续复制可能需要的历史。给它换一个输出数组,并不会开始一个新的解码任务。
next_in 是未读输入的起点,avail_in 是可读字节数;next_out 是下一个输出位置,avail_out 是从这里开始的剩余可写字节数。例如,一个 5 字节的输出数组在返回时还剩 2 字节空间,就说明它已收到 3 字节。先取走这些字节,再把指针和计数设置为下一块可写区域。
下列所有契约都有受限定义域。仅凭 C 指针类型,不能提供这里要求的存储、生命周期或调用历史。
- 存活流已成功初始化或复制,尚未结束,保留库拥有的状态,且不发生并发调用。使用默认分配器和释放函数。初始化调用接收可写的、不是存活流的流对象,分配器字段为 NULL 或默认函数。
- 可读或可写范围在整个调用期间都具有所述容量。调用者范围与流及流拥有的存储分离。输入与输出范围不重叠。字典目的缓冲区、已挂接的头部记录及其目的缓冲区彼此分离,也与流分离。使用已挂接的头部存储的调用还要求它与输入/输出范围分离。这些限制属于前置条件;各条目的“证明目标”说明其目标假设了其中哪些。
- 调用者拥有流对象及缓冲区。库拥有状态和可选窗口。调用只改变自己的流、流拥有的存储、所述输出范围和任何已挂接的头部目的存储。它绝不释放调用者缓冲区。
- 流检查拒绝时返回
Z_STREAM_ERROR,不发生变化,除非查询或复制契约另有说明。这覆盖 NULL 和可安全读取但未通过检查的记录,不覆盖悬空或任意指针。检查要求有分配器、状态、状态的回指指针和有效的模式。 - 计数器使用 C 无符号位宽并回绕。没有契约假设分配成功。解码、字典或分配错误之后,仍可调用
inflateEnd。 - 证明目标里说的是可达流,契约里说的是存活流(见契约约定)。目标所覆盖的调用会延长流的历史:调用返回后,无论返回哪个状态码,流仍然是可达流,下一次调用的目标随之适用。
inflateEnd结束这段历史。 - 结果单元作为值。
inflateGetDictionary通过uInt *dictLength报告长度。翻译没有把这个单元建模为内存:函数接收该单元的旧值(或者指针为 NULL 这一事实),并返回新值。因此目标不涉及这个单元的地址,也无法表达它与其他对象重叠的情况。
flowchart LR
I["初始化"] --> F["inflate"]
F -->|"Z_NEED_DICT"| D["设置字典"] --> F
F -->|"更多空间或输入"| F
F -->|"结束或放弃"| E["结束"]
F -->|"数据错误"| R["重置或同步搜索"] --> F
安全目标
ZlibF.Spec.Public.Goal.inflateCopy_safety
状态:完成 · 结论的状态
/-- `int inflateCopy(z_streamp dest, z_streamp source)`.
**Safety of `inflateCopy`** (the safety content of `Goal.inflateCopy`). Null arguments are
refused. From every reachable source into a distinct, readable destination record, the call
returns without a fault, with `Z_OK` or `Z_MEM_ERROR`. It leaves the source record and its state
unchanged and writes only the destination record and new blocks. On `Z_MEM_ERROR` an allocation
really failed, the destination state is cleared and the live blocks are unchanged (no leak). On
`Z_OK` the destination is a reachable stream (`StreamReachable.inflateCopy`) and the live blocks
grow by exactly the fresh blocks its new state owns. The copied contents are left to
`Goal.inflateCopy`. The last clause is zlib.h's refusal of an inconsistent source: a source the state
check refuses (`RefusedInflate`) is refused with `Z_STREAM_ERROR`, and the destination state is
cleared (as in `Goal.inflate_refusal`). -/
def Goal.inflateCopy_safety : Prop :=
(∀ h source, C.run (Zlib.Inflate.inflateCopy none source) h = .ok (Z_STREAM_ERROR, h)) ∧
(∀ h dest z, dest.get h = some z →
C.run (Zlib.Inflate.inflateCopy (some dest) none) h =
.ok (Z_STREAM_ERROR, dest.put h { z with state := none })) ∧
(∀ h source i z s dest oldDest,
StreamReachable .inflate h source → Zlib.Inflate.Spec.Good h source i z s →
Zlib.Inflate.Spec.DefAlloc z → source ≠ dest → dest.get h = some oldDest →
∃ rc after,
C.run (Zlib.Inflate.inflateCopy (some dest) (some source)) h = .ok (rc, after) ∧
source.get after = some z ∧ after.istates i = some s ∧ Frame h after (StreamRoot dest) ∧
((rc = Z_MEM_ERROR ∧ AllocationFailed h after ∧
dest.get after = some { oldDest with state := none } ∧
LiveChange h after (fun _ => False) (fun _ => False)) ∨
(rc = Z_OK ∧ StreamReachable .inflate after dest ∧
∃ copied, after.istates h.nextBlk = some copied ∧
(∀ b, InflateOwned h.nextBlk copied b → h.nextBlk ≤ b) ∧
LiveChange h after (InflateOwned h.nextBlk copied) (fun _ => False)))) ∧
(∀ h source dest oldDest, dest.get h = some oldDest → RefusedInflate h (some source) →
C.run (Zlib.Inflate.inflateCopy (some dest) (some source)) h =
.ok (Z_STREAM_ERROR, dest.put h { oldDest with state := none }))相关定义与源码 ↗功能契约(安全之外)
ZlibF.Spec.Public.Goal.inflateCopy
状态:完成 · 结论的状态
/-- `int inflateCopy(z_streamp dest, z_streamp source)`.
Copy every decoder field, relocate internal table pointers, share application header pointers,
and copy the initialized window bytes. All new storage is independent; failure releases it. -/
def Goal.inflateCopy : Prop :=
(∀ h source, C.run (Zlib.Inflate.inflateCopy none source) h = .ok (Z_STREAM_ERROR, h)) ∧
(∀ h dest z, dest.get h = some z →
C.run (Zlib.Inflate.inflateCopy (some dest) none) h =
.ok (Z_STREAM_ERROR, dest.put h { z with state := none })) ∧
(∀ h source i z s dest oldDest,
StreamReachable .inflate h source → Zlib.Inflate.Spec.Good h source i z s →
Zlib.Inflate.Spec.DefAlloc z → source ≠ dest → dest.get h = some oldDest →
∃ rc after,
C.run (Zlib.Inflate.inflateCopy (some dest) (some source)) h = .ok (rc, after) ∧
source.get after = some z ∧ after.istates i = some s ∧ Frame h after (StreamRoot dest) ∧
((rc = Z_MEM_ERROR ∧ AllocationFailed h after ∧
dest.get after = some { oldDest with state := none } ∧
LiveChange h after (fun _ => False) (fun _ => False)) ∨
(rc = Z_OK ∧ ∃ copied,
Zlib.Inflate.Spec.Good after dest h.nextBlk
{ z with state := some (.inflate h.nextBlk) } copied ∧
copied = { s with
strm := some dest, window := copied.window
lencode := relocateCode i h.nextBlk s.lencode
distcode := relocateCode i h.nextBlk s.distcode
next := relocateCode i h.nextBlk s.next } ∧
(s.window = .null ↔ copied.window = .null) ∧
(s.window ≠ .null → SameBytePrefix h after s.window copied.window s.whave.toNat) ∧
(∀ b, InflateOwned h.nextBlk copied b → h.nextBlk ≤ b) ∧
LiveChange h after (InflateOwned h.nextBlk copied) (fun _ => False))))相关定义与源码 ↗