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

deflateSetDictionary

将预置字节载入压缩历史,不把它们作为输入数据输出。

完整章节与共同规则 ↗
int ZEXPORT deflateSetDictionary(z_streamp strm, const Bytef *dictionary, uInt dictLength);

将预置字节载入压缩历史,不把它们作为输入数据输出。

dictLength 是整个给定字典的字节数,w_size 是配置的历史窗口字节数;过长字典只把可用后缀留作历史,但 zlib 的字典标识仍覆盖整个给定字典。

返回值与后续调用

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

返回值说明预置历史是否被接受;字典不会作为普通的压缩输入输出。

deflateSetDictionary()
返回值 含义与出现条件 调用者接下来
Z_OK
历史已载入
满足字典与流的前置条件;历史保留最多一个窗口的可用后缀,zlib 校验和覆盖完整字典。 随后开始压缩;需要预置历史的解码器须获得相同字典。next_in 和 avail_in 已恢复,不交付输出。
Z_STREAM_ERROR
字典条件不满足
流检查失败,或使用 gzip、NULL 字典、已离开初始状态的 zlib、预读字节数非零,或裸流不在已完成的块边界;均不改变流。 先建立合法的字典调用条件。原有的存活流如果仍在,可改用合法操作或 deflateEnd。

调用条件与效果

定义域 受限定义域。效果: 更新历史和字典校验和。

前置条件 存活的裸流或 zlib 流,紧接初始化或 deflateReset,在第一次 deflate 和第一次字典调用之前。dictionary 非 NULL,覆盖 dictLength 个可读字节,且与窗口分离。

证明目标。

  • 目标。 Goal.deflateSetDictionary_safety(Safety/Streams.lean);必需。定理:ZlibF.Spec.Public.StreamCallSafetyProof.deflateSetDictionary_safety(public-stream-call-safety.lean)。这个目标有两个子句:对被拒绝的流的拒绝;对可达流的一次调用。Goal.deflate_refusal(Safety/Refusals.lean)也是必需目标,它陈述同一个拒绝。
  • 适用条件。 拒绝子句要求 strm 是被拒绝的流(RefusedDeflate)。对可达流的调用要求(StreamCallDomain):
    1. strm 是可达流(StreamReachable);
    2. 平台大小上界成立(ByteObjectsFit);
    3. dictionary 为 NULL,或指向 dictLength 个可读字节,且在流自己的块之外(CallerRange)。
  • 无条件覆盖。 每一个 dictLength 和每一种字典内容。每一个可达流,无论处于哪个阶段:第一次 deflate 之前、流的中途、收尾期间,以及 Z_STREAM_END 之后。本目标比前置条件宽:dictionary 可以为 NULL,封装可以是 gzip,调用可以出现在任何时刻。C 会拒绝返回值表中列出的那些情况。拒绝子句中:每一个被拒绝的流,以及其他参数的每个取值。
  • 保证(对可达流的调用是 StreamCallSafe)。
    • 返回。 对被拒绝的流,调用返回 Z_STREAM_ERROR。对可达流调用时,调用返回。
    • 状态。 对可达流调用时,流保持其不变量(StreamInvariant)。
    • 写入。 对被拒绝的流不写任何内容:堆不变。对可达流调用时,只写流记录和流自己的块。
    • 分配。 对可达流调用时,精确的分配账本(LiveChange)。
  • 不在本目标内。 zalloc 和 zfree 已设置、而 state 是垃圾指针、指向已释放的状态或指向 inflate 状态的流记录:没有目标覆盖对这种记录的这个调用(见偏离记录)。返回哪个状态码,以及调用之后的历史:功能目标 Goal.deflateSetDictionary(不在计划内;未完成)。
完整返回条件与边界

返回与保证 返回 Z_OK。历史保留字典的可用后缀,最多一个窗口。zlib 的字典校验和覆盖整个给定字典。原 next_in 和 avail_in 被恢复;total_in 增加 min(dictLength, w_size)。不交付压缩输出,也不分配。需要字典时,必须向解码器提供相同的预置字典。

聚焦范围之外: gzip、NULL 字典、已离开初始状态的 zlib、非零预读字节数,或不在已完成块边界的裸流输入,均返回 Z_STREAM_ERROR,不发生变化。合法边界处的裸流字典替换,以及第一次 deflate 之前重复的 zlib 调用,安全目标和功能目标都覆盖。重复 zlib 调用会累积 Adler-32,而不是重新开始计算。

本组共同前提与范围

输入分批到达、输出空间有限,或需要选择封装、字典、刷新边界时,使用 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.deflateSetDictionary_safety

状态:完成 · 结论的状态

/-- `int deflateSetDictionary(z_streamp strm, const Bytef *dictionary, uInt dictLength)`.
**Safety of `deflateSetDictionary`**: 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.deflateSetDictionary_safety : Prop :=
  (∀ h p dictionary dictLength, RefusedDeflate h p →
    C.run (Zlib.Deflate.deflateSetDictionary p dictionary dictLength) h = .ok (Z_STREAM_ERROR, h)) ∧
  (∀ h r dictionary dictLength,
     StreamCallDomain .deflate h r (.deflateSetDictionary (some r) dictionary dictLength) →
     StreamCallSafe .deflate h r (.deflateSetDictionary (some r) dictionary dictLength))
相关定义与源码 ↗

功能契约(安全之外)

ZlibF.Spec.Public.Goal.deflateSetDictionary

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

/-- `int deflateSetDictionary(z_streamp strm, const Bytef *dictionary, uInt dictLength)`.
The raw path checks the block boundary. Repeated zlib dictionaries accumulate their checksum.
The temporary input binding is restored, and no allocation is performed. -/
def Goal.deflateSetDictionary : Prop :=
  ∀ h r i z s source n xs old,
    Zlib.Deflate.Spec.DGood h r i z s → LibraryGlobals h →
    DeflateDictionary h s old → (source ≠ .null → Bytes h source n.toNat xs) →
    Separate source n.toNat s.window s.window_size.toNat →
    ∃ rc after, C.run (Zlib.Deflate.deflateSetDictionary (some r) source n) h = .ok (rc, after) ∧
      (if source = .null ∨ s.wrap = 2 ∨ (s.wrap = 1 ∧ s.status ≠ INIT_STATE) ∨
          s.lookahead ≠ 0 ∨ (s.wrap = 0 ∧ s.strstart.toUInt64.toInt64 ≠ s.block_start) then
        rc = Z_STREAM_ERROR ∧ after = h
       else rc = Z_OK ∧ ∃ z' s' dict,
         Zlib.Deflate.Spec.DGood after r i z' s' ∧ DeflateDictionary after s' dict ∧
         z' = { z with
           total_in := z.total_in + UInt64.ofNat (min xs.length s.w_size.toNat)
           adler := if s.wrap = 1 then adlerValue z.adler xs else z.adler } ∧
         s'.wrap = s.wrap ∧ s'.lookahead = 0 ∧ s'.block_start = s'.strstart.toUInt64.toInt64 ∧
         dict <:+ old ++ xs ∧ dict.length ≤ s.w_size.toNat ∧
         min (old.length + xs.length) (s.w_size.toNat - 262) ≤ dict.length) ∧
      Frame h after (fun b => StreamRoot r b ∨ DeflateOwned i s b) ∧
      LiveChange h after (fun _ => False) (fun _ => False) ∧ after.nalloc = h.nalloc
相关定义与源码 ↗
ZLIB × LEAN

目录

正在阅读deflateSetDictionary