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

get_crc_table

返回库逐字节计算 CRC 使用的表。

完整章节与共同规则 ↗
const z_crc_t FAR * ZEXPORT get_crc_table(void);

返回库逐字节计算 CRC 使用的表。

返回值与后续调用

返回值类型。 const z_crc_t FAR * — 借用的只读表指针

返回字节 CRC 更新表的地址。此调用不返回状态码。

get_crc_table()
返回值 含义与出现条件 调用者接下来
table != NULL
256 项 CRC 表
固定 CRC 表存在;每次调用返回同一指针。第 i 项是从寄存器值零出发、处理字节 i 得到的反射更新值,不含公开校验和接口的取反步骤。 可在程序生命周期内读取 256 项;不得写入或释放该表。

判读要点。

  • 此构建的 z_crc_t 为无符号 32 位;指针只公开字节表,不公开相邻表或编织表。

调用条件与效果

定义域 完整类型定义域;没有参数。效果为纯计算,返回指向库内存的指针, 不读取表项。

前置条件 库的固定 CRC 表存在,所选构建中就是如此。 不需要先做任何准备调用。

内存与状态效果 保持全部内存与所有权。表仍由库持有,生存期覆盖整个程序。 调用者可读取这 256 项,但不得通过指针写入,也不得释放它。

证明目标。 没有必需目标:zlib.h 把这个函数声明在“undocumented functions (not part of the zlib API)”(未文档化的函数,不属于 zlib API)之下。为它陈述了一个功能目标:Goal.get_crc_table(Functional/Checksums.lean)(不在计划内;已有定理证明它),定理为 ZlibF.Spec.Public.Proofs.get_crc_table(public-get-crc-table.lean)。在存有库的 CRC 表的堆上(CrcGlobals),它陈述:调用返回,堆不变,表的内容如后置条件所述。

完整返回条件与边界

返回与保证 返回非 NULL 指针,指向由 256 个 z_crc_t 表项组成的只读数组。 表项 i 表示从零寄存器出发处理字节 i 的反射 CRC 寄存器更新, 不包含公开校验和接口的取反步骤。重复调用返回相同指针。

本组共同前提与范围

逐块计算缓冲区的校验和,或组合各自独立处理的字节序列的校验和,而不重新读取数据。 下文的字节序列 A 和 B 是普通数据;契约使用这些序列的 Adler-32 或 CRC-32。例如先处理 A,再处理 B,可以把 A 的校验和作为下一次更新的起始值;若 A、B 是各自独立处理的,组合函数给出 A 后接 B 的校验和。

更新函数里的 buf 指向这一批输入,len 是这一批的字节数,传入的 adler 或 crc 是继续计算的起始值。组合函数里的 len2 则只表示后一段 B 的字节数,不是两段总长度。

任务 条目
更新 Adler-32 长度为大小类型、32 位长度
组合 Adler-32 普通偏移类型、显式 64 位偏移类型
更新 CRC-32 长度为大小类型、32 位长度
组合 CRC-32 普通偏移类型、显式 64 位偏移类型
复用 CRC 组合算子 生成、用 64 位长度生成、应用
查看字节表 get_crc_table

这些契约遵循固定版本的 adler32.c、crc32.c 和 zlib.h,采用默认 LP64 Linux 静态构建。 没有补丁改动这两个 C 文件(见补丁说明)。 动态建表、硬件 CRC 钩子和生成表的可执行程序不在覆盖范围内 (见构建与平台)。 任何校验和条目都不写入状态、不分配或释放内存,也不执行 I/O。 特殊数值结果是普通值,而不是错误码。定义域和效果互相独立,见契约约定。 这些是聚焦契约:前置条件描述通常的正确用法,有意比函数实际接受的范围窄。 超出前置条件的调用并不因此就是未定义行为,也不一定返回错误码。

已证明的内容。 只证明安全性(见安全性):每个安全目标(Safety/Checksums.lean)说的是调用返回,并且调用之后的堆就是调用之前的堆。它对返回的数值什么也没说。各条目在“证明目标”下给出自己的目标,所用的五项和固定用语由阅读证明目标段落定义。证明所假设的是那里列出的条件,而不是文档中的前置条件。后置条件、返回值表和各项说明描述的是功能行为:它们读自 C 源码,凡是没有定理陈述的,都尚未由证明确认;安全结论不需要它们。进度说明哪些目标已完成。

CRC 目标对模型的堆有一条前提:堆中的两张 CRC 常量表 crc_table 和 x2n_table 等于翻译后的 crc32.h 中的表(CrcGlobals)。这条前提是对调用开始时的堆所作的假设; 没有定理对任意的堆推出它。它是对模型的条件,不是调用者的义务 (见模型的限制)。 关于它证明了两件事。库堆(流目标的起点) 满足它(crc_globals_of_library)。每个校验和目标都返回未改变的堆,所以调用之后这条前提仍然成立。

实用校验和契约使用真实字节序列 A 和 B。各校验和独立计算:Adler-32 从 1 开始, CRC-32 从 0 开始。这些契约有意不对伪造校验和值作功能保证。 Functional/Checksums.lean 中的功能目标还描述任意种子及精确标量结果。 Adler 条目及其 Lean 目标(安全目标和功能目标)都要求 NULL 初始化查询的长度为零 (Common/Checksums.lean 中的 AdlerBufferBytes)。 见偏离记录。

此构建中,uLong 和 z_size_t 是无符号 64 位类型;uInt 是无符号 32 位类型。 z_off_t 和 z_off64_t 是有符号 64 位类型。输入校验和值中高于第 31 位的位被忽略; 返回校验和值可用 32 位表示。显式 *64 声明取决于头文件的大文件特性宏。

功能契约(安全之外)

ZlibF.Spec.Public.Goal.get_crc_table

状态:完成 · 结论的状态

/-- `const z_crc_t *get_crc_table(void)`.
The returned table is static and read-only, has 256 entries given by the reflected CRC
recurrence, and leaves every heap observation unchanged. -/
def Goal.get_crc_table : Prop :=
  ∀ h : Heap, CrcGlobals h → ∃ pointer table,
    C.run Zlib.Crc32.get_crc_table h = .ok (pointer, h) ∧
    pointer = .ref .st_crc_table 0 ∧ Space.get h URef.st_crc_table = some table ∧
    Space.ro h URef.st_crc_table = true ∧ table.size = 256 ∧
    ∀ i : Fin 256, table[i.val]? = some (ZlibF.Spec.crcByte 0 (UInt8.ofNat i.val))
相关定义与源码 ↗
ZLIB × LEAN

目录

正在阅读get_crc_table