deflateGetDictionary
读取当前压缩历史,包括已接受的预读输入。
完整章节与共同规则 ↗int ZEXPORT deflateGetDictionary(z_streamp strm, Bytef *dictionary, uInt *dictLength);
读取当前压缩历史,包括已接受的预读输入。
这里的“已接受”不等于已经编码。压缩器在决定匹配的同时,会把一些输入提前读入窗口。内部字段 strstart 是下一个待处理字节的数组下标,lookahead 是其后的预读字节数。下式中的 w_size 是配置的历史窗口字节数,不是整个物理数组的容量 window_size。n 表示本次最多复制多少历史字节。
返回值与后续调用
返回值类型。 int — zlib 状态码
状态码说明查询是否成功;实际历史字节和长度由可选输出参数提供。
deflateGetDictionary()| 返回值 | 含义与出现条件 | 调用者接下来 |
|---|---|---|
Z_OK历史查询完成 |
存活流;dictionary 若非 NULL,接收窗口区域最后 n 个字节;dictLength 若非 NULL,接收 n,其中 n = min(strstart + lookahead, window size)。 | 使用所请求的结果;两种输出可独立省略,流不变,可继续合法调用。 |
Z_STREAM_ERROR流检查未通过 |
流检查失败;正常操作尚未开始,流和结果单元均未写入。 | 先建立存活流并满足调用的前置条件;这个结果不表示操作已完成。 |
调用条件与效果
定义域 受限定义域。效果: 可带输出缓冲区的查询。
前置条件 存活流。dictionary 为 NULL,或可写一个窗口且与窗口分离;dictLength 为 NULL,或有效标量输出单元。
证明目标。
- 目标。
Goal.deflateGetDictionary_safety(Safety/Streams.lean);必需。定理:ZlibF.Spec.Public.StreamCallSafetyProof.deflateGetDictionary_safety(public-stream-call-safety.lean)。这个目标有两个子句:对被拒绝的流的拒绝;对可达流的一次调用。Goal.deflate_refusal(Safety/Refusals.lean)也是必需目标,它陈述同一个拒绝。 - 适用条件。 拒绝子句要求
strm是被拒绝的流(RefusedDeflate)。对可达流的调用要求(StreamCallDomain):strm是可达流(StreamReachable);- 平台大小上界成立(
ByteObjectsFit); dictionary为 NULL,或指向min(w_size, strstart + lookahead)个可写字节(即本次调用复制的字节数),且在流自己的块之外(CallerRange)。
- 无条件覆盖。 每一个可达流,无论处于哪个阶段:第一次
deflate之前、流的中途、收尾期间,以及Z_STREAM_END之后。在翻译中dictLength是一个值而不是内存(见共享约定),所以本目标对这个指针没有要求。拒绝子句中:每一个被拒绝的流,以及其他参数的每个取值。 - 保证(对可达流的调用是
StreamCallSafe)。- 返回。 对被拒绝的流,调用返回
Z_STREAM_ERROR,不存入长度。对可达流调用时,调用返回。 - 状态。 对可达流调用时,流保持其不变量(
StreamInvariant)。 - 写入。 对被拒绝的流不写任何内容:堆不变。对可达流调用时,只写流记录、流自己的块,以及
dictionary起min(w_size, strstart + lookahead)个字节范围内的字节,也就是调用复制的那些字节;dictionary为NULL时,不写调用者的内存。 - 分配。 对可达流调用时,精确的分配账本(
LiveChange)。
- 返回。 对被拒绝的流,调用返回
- 不在本目标内。
zalloc和zfree已设置、而state是垃圾指针、指向已释放的状态或指向 inflate 状态的流记录:没有目标覆盖对这种记录的这个调用(见偏离记录)。复制出的字节和报告的长度:功能目标Goal.deflateGetDictionary(不在计划内;已有定理证明它)。
完整返回条件与边界
返回与保证 返回 Z_OK。设存活状态中的 n = min(strstart + lookahead, w_size)。非 NULL 的 dictionary 按顺序接收该窗口区域的最后 n 个字节;非 NULL 的 dictLength 接收 n。两种结果均可独立省略。流不变。历史不一定包含此前所有已提供输入中的完整一个窗口。
本组共同前提与范围
输入分批到达、输出空间有限,或需要选择封装、字典、刷新边界时,使用 z_stream 压缩器。封装是在 DEFLATE 压缩数据之外增加的头部、尾部和完整性信息;裸 DEFLATE 则不带这些封装。初始化一次,使用连续的缓冲区调用 deflate,即使放弃压缩也要结束流。单个缓冲区的操作见 compress 和 compress2。
| 任务 | 条目 |
|---|---|
| 开始或复用 | 初始化、配置初始化、重置、保留历史的重置 |
| 提供元数据或历史 | 字典、读取历史、gzip 头 |
| 压缩与输出大小 | 压缩、上界、待输出数据、最近刷新位数 |
| 调整或分支 | 参数、调优、位预置、复制 |
| 释放存储 | 结束 |
这些契约遵循固定版本的 zlib 在应用各补丁之后的 zlib.h 和 deflate.c,采用默认 LP64 Linux 构建。七个补丁中只有补丁 0006 和 0007 改动 deflate.c。两者都修改 deflateBound_z,deflateBound 调用 deflateBound_z,其结果也随之改变:0006 修改一个条件,0007 修改封装大小中 gzip extra 字段的长度。两处改动见条目 deflateBound_z。这些补丁不改动其他函数。这些是聚焦契约:前置条件描述通常的正确用法,有意比函数实际接受的范围窄。前置条件之外、C 仍会处理的情况,写在“错误”或聚焦范围之外下。超出前置条件的调用并不因此就是未定义行为,也不一定返回错误码。定义域和效果标签的含义见契约约定。
已证明的内容。 只证明安全性:每次调用都返回,没有未定义行为和内存错误,只写其目标指明的内容,并且不泄漏(见安全性)。各条目在“证明目标”下给出自己的目标,所用的五项和固定用语由阅读证明目标段落定义:目标及其定理;目标适用的条件,按 Lean 命题中的顺序列出;对每一个取值都覆盖的内容;保证的内容(返回、状态、写入、分配);以及留给其他目标的内容。证明所假设的是那里列出的条件,而不是文档中的前置条件。后置条件、返回值表和各项说明描述的是功能行为:它们读自 C 源码,凡是没有定理陈述的,都尚未由证明确认;安全结论不需要它们。哪些目标已完成,见进度。
共享约定
在每条所述前置条件下,文档描述的行为是:调用终止且不产生运行时故障,并且后置条件成立。调用之后流仍然存活时,它的表示不变量保持成立。其中已被证明的部分,就是该条目的安全目标。
先看一次调用的数据交接。next_in 指向尚未读取的输入的起点,avail_in 是从这里开始可读的字节数;next_out 指向下一个可写位置,avail_out 是剩余输出容量,也以字节计。一次调用可以只消耗部分输入、只交付部分输出。调用者应读取更新后的指针和计数,接走已交付字节,再为同一个流补充输入或输出空间。
- 存活流: 可写的
z_stream,其压缩器状态由成功初始化或复制建立,经过合法调用保持,且尚未结束。调用者不改变其内部状态或分配器字段。同一个流的调用按顺序执行。 - 缓冲区: 输入覆盖
avail_in个可读字节;输出覆盖avail_out个可写字节。它们彼此不重叠,也不与流或流拥有的状态重叠。非 NULL 标量结果指向可写单元,与其他结果及流内存分离。这些分离条件是契约的假设。安全目标也假设其中某一条时,该条目的“证明目标”会写明,偏离记录中也有对应的一行。 - 分配器: 使用默认分配/释放函数对,或在初始化前将两个字段都置为 NULL。任意一次分配尝试都可能失败。自定义分配器回调不在本页范围内。
- 帧性质与所有权: 调用只改变自己的流、其拥有的状态和所述输出区域。调用者输入只读。调用者缓冲区和头部记录仍归调用者所有。只有初始化和复制会分配;只有它们失败时的清理与
deflateEnd会释放内存。其他调用保持流的分配集合。 - 头部生命周期: 保留的 gzip 头及其可选字段在使用期间保持可读且不变。非 NULL 的
name和comment以零终止;extra覆盖所述长度。本页的契约取extra_len <= 65535。 - 检查后的拒绝: 除初始化和上界查询外,流检查失败会在正常操作之前返回
Z_STREAM_ERROR,不发生写入。deflateCopy还会清空非 NULL 目的流的状态。这种拒绝不修改查询输出单元。 - 受限定义域指这些显式内存、生命周期和调用顺序条件,加上条目自身的前置条件。它不意味着接受每个可表示的指针或整数。错误概述覆盖各项检查读得到的流记录和状态,不覆盖任意无效地址。
- 可达流: 证明目标里说的是可达流,契约里说的是存活流(见契约约定)。目标所覆盖的调用会延长流的历史:调用返回后,无论返回哪个状态码,流仍然是可达流,下一次调用的目标随之适用。
deflateEnd结束这段历史。 - 结果单元作为值:
deflateGetDictionary、deflatePending和deflateUsed通过指针报告结果(uInt *dictLength、unsigned *pending、int *bits)。翻译没有把这些单元建模为内存:各函数只接收“指针是否为 NULL”这一事实,并把结果作为值返回。因此目标不涉及结果单元的地址,也无法表达结果单元与其他对象重叠的情况。
安全目标
ZlibF.Spec.Public.Goal.deflateGetDictionary_safety
状态:完成 · 结论的状态
/-- `int deflateGetDictionary(z_streamp strm, Bytef *dictionary, uInt *dictLength)`.
**Safety of `deflateGetDictionary`**: a `NULL` or inconsistent stream (`RefusedDeflate`) is refused
with `Z_STREAM_ERROR` and nothing changed; and on every reachable deflate stream, with the caller's
arguments as `zlib.h` asks, the call is safe (`StreamCallSafe`). -/
def Goal.deflateGetDictionary_safety : Prop :=
(∀ h p dictionary hasDictLength, RefusedDeflate h p →
C.run (Zlib.Deflate.deflateGetDictionary p dictionary hasDictLength) h =
.ok ((Z_STREAM_ERROR, none), h)) ∧
(∀ h r dictionary hasDictLength,
StreamCallDomain .deflate h r (.deflateGetDictionary (some r) dictionary hasDictLength) →
StreamCallSafe .deflate h r (.deflateGetDictionary (some r) dictionary hasDictLength))相关定义与源码 ↗功能契约(安全之外)
ZlibF.Spec.Public.Goal.deflateGetDictionary
状态:完成 · 结论的状态
/-- `int deflateGetDictionary(z_streamp strm, Bytef *dictionary, uInt *dictLength)`.
Return the last window of accepted input, including pending lookahead. -/
def Goal.deflateGetDictionary : Prop :=
∀ h r i z s dest lengthPresent xs,
Zlib.Deflate.Spec.DGood h r i z s → DeflateDictionary h s xs →
(dest ≠ .null → Writable h dest xs.length ∧ Separate dest xs.length s.window s.window_size.toNat) →
∃ after, C.run (Zlib.Deflate.deflateGetDictionary (some r) dest lengthPresent) h =
.ok ((Z_OK, if lengthPresent then some (UInt32.ofNat xs.length) else none), after) ∧
Store h dest (if dest = .null then [] else xs) after相关定义与源码 ↗