跳到正文
参考文档 / ZLIB × LEAN

inflateSync

输入受损后,搜索可能的完全刷新边界。

完整章节与共同规则 ↗
int ZEXPORT inflateSync(z_streamp strm);

输入受损后,搜索可能的完全刷新边界。

返回值与后续调用

返回值类型。 int — zlib 状态码

结果说明恢复搜索是否找到候选边界;找到模式不等于数据已恢复正确。

inflateSync()
返回值 含义与出现条件 调用者接下来
Z_OK
找到候选边界
在缓冲整字节或输入中找到 00 00 ff ff;历史和头部挂接重置,总计数保留。 可从后续块恢复 inflate;不要据此假定后缀有效或校验已恢复。
Z_DATA_ERROR
尚未找到,继续搜索
当前可搜索字节中未找到完整模式;部分匹配会跨调用保留。 提供更多输入并继续 inflateSync;搜索期间普通 inflate 返回 Z_STREAM_ERROR。
Z_BUF_ERROR
没有可搜索的字节
没有输入且缓冲位少于八位;内容不变。 提供更多输入后继续 inflateSync,或调用 inflateEnd 放弃。
Z_STREAM_ERROR
流检查未通过
流未通过公共流检查;内容不变。 先建立有效流并确定其所有权,再进行后续操作。

调用条件与效果

定义域 受限定义域:数据错误后或恢复搜索期间的存活流,输入可读。

内存与状态效果 消费输入、修改状态,可能释放窗口。

前置条件 next_in 和 avail_in 描述可读范围。不使用输出。

证明目标。

  • 目标。 Goal.inflateSync_safety(Safety/Streams.lean);必需。定理:ZlibF.Spec.Public.StreamCallSafetyProof.inflateSync_safety(public-stream-call-safety.lean)。这个目标有两个子句:对被拒绝的流的拒绝;对可达流的一次调用。
  • 适用条件。 拒绝子句要求 strm 是被拒绝的流(RefusedInflate),并要求模型的内存在下一个未用块号及其之后没有已分配的块(Fresh,这是对模型的条件,不是对调用者的要求)。对可达流的调用要求(StreamCallDomain):
    1. strm 是可达流(StreamReachable);
    2. 平台大小上界成立(ByteObjectsFit);
    3. next_in 指向 avail_in 个可读字节,且在流自己的块之外;或者为 NULL 且 avail_in == 0(StreamArguments)。
  • 无条件覆盖。 每一种输入字节序列。每一个可达流,无论处于哪种模式:解码之前、块的中途、流结束处,以及数据错误或内存错误之后。拒绝子句中:每一个被拒绝的流。
  • 保证(对可达流的调用是 StreamCallSafe)。
    • 返回。 对被拒绝的流,调用返回 Z_STREAM_ERROR。对可达流调用时,调用返回。
    • 状态。 对可达流调用时,流保持其不变量(StreamInvariant)。
    • 写入。 对被拒绝的流,不写调用前已分配的任何块(Frame);这个子句没有写成“堆不变”,因为翻译会创建并释放一个四字节的局部数组。对可达流调用时,只写流记录和流自己的块。
    • 分配。 对被拒绝的流,已分配的块与调用前相同(LiveChange)。对可达流调用时,精确的分配账本(LiveChange)。
  • 不在本目标内。 zalloc 和 zfree 已设置、而 state 是垃圾指针、指向已释放的状态或指向 deflate 状态的流记录:没有目标覆盖对这种记录的这个调用(见偏离记录)。返回哪个状态码、消费多少输入:功能目标 Goal.inflateSync(不在计划内;未完成)。
完整返回条件与边界

返回与保证 先在缓冲的整字节、再在输入中搜索 00 00 ff ff,跨调用保留部分匹配。输入指针/计数和 total_in 按已搜索输入量推进。不产生输出,total_out 不变。

返回码 Z_OK 表示找到模式:重置历史和头部挂接,保留总计数,可在后续块恢复解码。如果尚未读取头部,恢复使用裸模式;否则关闭尾部校验。仍未知的窗口大小变为 15。Z_DATA_ERROR 表示继续搜索;该搜索期间,普通 inflate 返回 Z_STREAM_ERROR。

边界情况 无输入且缓冲位少于八位时,返回 Z_BUF_ERROR,不发生变化。流检查失败不改变任何内容。找到的模式不一定是真正的刷新点;即使是同步刷新边界,也可能需要更早的历史。恢复不承诺有效后缀,也不承诺恢复校验和检查。不分配。

本组共同前提与范围

使用 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.inflateSync_safety

状态:完成 · 结论的状态

/-- `int inflateSync(z_streamp strm)`.
**Safety of `inflateSync`**: a `NULL` or inconsistent stream (`RefusedInflate`) is refused with
`Z_STREAM_ERROR`; on a `Fresh` heap it writes no block that was live and leaves the live blocks as
they were (the local array it makes is freed); and on every reachable inflate stream, with the
caller's arguments as `zlib.h` asks, the call is safe (`StreamCallSafe`). -/
def Goal.inflateSync_safety : Prop :=
  (∀ h p, Fresh h → RefusedInflate h p →
    ∃ after, C.run (Zlib.Inflate.inflateSync p) h = .ok (Z_STREAM_ERROR, after) ∧
      Frame h after (fun _ => False) ∧ LiveChange h after (fun _ => False) (fun _ => False)) ∧
  (∀ h r,
     StreamCallDomain .inflate h r (.inflateSync (some r)) →
     StreamCallSafe .inflate h r (.inflateSync (some r)))
相关定义与源码 ↗

功能契约(安全之外)

ZlibF.Spec.Public.Goal.inflateSync

状态:未完成,不在计划内 · 结论的状态

/-- `int inflateSync(z_streamp strm)`.
Search byte-aligned held bits before new input, retaining the partial marker match.
On success retain totals and restart at TYPE with validation disabled. -/
def Goal.inflateSync : Prop :=
  ∀ h r i z s input,
    StreamReachable .inflate h r → Zlib.Inflate.Spec.Good h r i z s →
    Zlib.Inflate.Spec.DefAlloc z → Bytes h z.next_in z.avail_in.toNat input →
    ∃ rc after z' s' used,
      C.run (Zlib.Inflate.inflateSync (some r)) h = .ok (rc, after) ∧
      Zlib.Inflate.Spec.Good after r i z' s' ∧ used ≤ input.length ∧
      z'.next_in = advance z.next_in used ∧ z'.avail_in.toNat + used = z.avail_in.toNat ∧
      z'.total_in = z.total_in + UInt64.ofNat used ∧ z'.total_out = z.total_out ∧
      (if z.avail_in = 0 ∧ s.bits.toNat < 8 then rc = Z_BUF_ERROR ∧ z' = z ∧ s' = s
       else let start := if s.mode = SYNC then s.have.toNat else
              (Api.syncSearch 0 (heldSyncBytes s)).1
            let found := Api.syncSearch start input
            used = found.2 ∧
            if found.1 = 4 then rc = Z_OK ∧ s'.mode = TYPE ∧ (s'.wrap &&& 4) = 0
            else rc = Z_DATA_ERROR ∧ s'.mode = SYNC ∧ s'.have.toNat = found.1) ∧
      Frame h after (fun b => StreamRoot r b ∨ InflateOwned i s b) ∧
      LiveChange h after (fun _ => False)
        (fun b => InflateOwned i s b ∧ ¬ InflateOwned i s' b)
相关定义与源码 ↗
ZLIB × LEAN

目录

正在阅读inflateSync