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

inflateMark

查询当前码位置,用于索引。

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

查询当前码位置,用于索引。

返回的一个整数打包了两种进度。back 按比特计,描述从当前位位置回到正在解码的码的起点的距离;progress 按字节计,描述存储块尚未复制的量或当前匹配已经输出的量。乘数 65536 即 2^16,只用于把两部分放进同一个结果,不是窗口大小。

返回值与后续调用

返回值类型。 long — 打包的位置和进度,或重合的错误哨兵

返回一个打包的位置值,而非 zlib 状态码。错误哨兵与有效位置值重合。

inflateMark()
返回值 含义与出现条件 调用者接下来
back * 65536 + progress
打包的码位置
有效流:back 是回到当前码起点的位数;码之间、头部或存储块中为 -1。progress 是剩余存储块字节数、已输出匹配字节数,其他情况为零。 按位数和字节数分别解释两部分;查询不改变流。
-65536
流检查失败的哨兵
流检查失败时返回 -65536;有效流在 back 为 -1 且 progress 为零时也返回同一值。 仅凭此值无法区分错误;须根据流的有效性解释。

调用条件与效果

定义域 受限定义域:任意模式的存活流。

内存与状态效果 只读查询。

前置条件 满足公共存活流条件。

证明目标。

  • 目标。 Goal.inflateMark_safety(Safety/Streams.lean);必需。定理:ZlibF.Spec.Public.StreamCallSafetyProof.inflateMark_safety(public-stream-call-safety.lean)。这个目标有两个子句:对被拒绝的流的拒绝;对可达流的一次调用。
  • 适用条件。 拒绝子句要求 strm 是被拒绝的流(RefusedInflate)。对可达流的调用要求(StreamCallDomain;这个调用没有参数条件):
    1. strm 是可达流(StreamReachable);
    2. 平台大小上界成立(ByteObjectsFit)。
  • 无条件覆盖。 每一个可达流,无论处于哪种模式:解码之前、块的中途、流结束处,以及数据错误或内存错误之后。拒绝子句中:每一个被拒绝的流。
  • 保证(对可达流的调用是 StreamCallSafe)。
    • 返回。 对被拒绝的流,调用返回 -65536。对可达流调用时,调用返回。
    • 状态。 对可达流调用时,流保持其不变量(StreamInvariant)。
    • 写入。 对被拒绝的流不写任何内容:堆不变。对可达流调用时,只写流记录和流自己的块。
    • 分配。 对可达流调用时,精确的分配账本(LiveChange)。
  • 不在本目标内。 zalloc 和 zfree 已设置、而 state 是垃圾指针、指向已释放的状态或指向 deflate 状态的流记录:没有目标覆盖对这种记录的这个调用(见偏离记录)。返回的值:功能目标 Goal.inflateMark(不在计划内;已有定理证明它)。
完整返回条件与边界

返回与保证 返回 back * 65536 + progress:back 是向后回到当前码所需的位数;在码之间/头部内/存储块内为 -1。progress 为剩余存储块字节数、已输出匹配字节数,其他情况为零。不改变任何内容,不分配/释放。

边界情况 流检查失败返回 -65536。该值也会出现在有效流上,因此不能单凭它识别错误。

本组共同前提与范围

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

状态:完成 · 结论的状态

/-- `long inflateMark(z_streamp strm)`.
**Safety of `inflateMark`**: a `NULL` or inconsistent stream (`RefusedInflate`) is refused with
-65536 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.inflateMark_safety : Prop :=
  (∀ h p, RefusedInflate h p → C.run (Zlib.Inflate.inflateMark p) h = .ok ((-65536), h)) ∧
  (∀ h r,
     StreamCallDomain .inflate h r (.inflateMark (some r)) →
     StreamCallSafe .inflate h r (.inflateMark (some r)))
相关定义与源码 ↗

功能契约(安全之外)

ZlibF.Spec.Public.Goal.inflateMark

状态:完成 · 结论的状态

/-- `long inflateMark(z_streamp strm)`.
The high half counts code bits; the low half counts remaining stored bytes or match bytes
already copied. The internal ranges are obligations of the stream invariant. -/
def Goal.inflateMark : Prop :=
  CheckedInflate Zlib.Inflate.inflateMark (-65536) <|
  ∀ h r i z s, InflateView h r i z s →
    C.run (Zlib.Inflate.inflateMark (some r)) h = .ok
      (Int64.ofInt (s.back.toInt * 65536 +
        (if s.mode = COPY then s.length.toNat else
         if s.mode = MATCH then (s.was - s.length).toNat else 0)), h)
相关定义与源码 ↗
ZLIB × LEAN

目录

正在阅读inflateMark