inflateBackInit_
用途。 分配解码器状态并关联调用者的窗口。 inflateBackInit 宏提供 version 和 stream_size。
完整章节与共同规则 ↗int ZEXPORT inflateBackInit_(z_streamp strm, int windowBits, unsigned char FAR *window,
const char *version, int stream_size);
用途。 分配解码器状态并关联调用者的窗口。
inflateBackInit 宏提供 version 和 stream_size。
返回值与后续调用
返回值类型。 int — zlib 状态码
结果说明回调解码状态是否已建立并关联调用者窗口。
inflateBackInit_()| 返回值 | 含义与出现条件 | 调用者接下来 |
|---|---|---|
Z_OK回调解码器已建立 |
版本和流大小匹配,8 <= windowBits <= 15,窗口非 NULL 且状态分配成功。 | 保持窗口存活并用 inflateBack 解码;最终调用 inflateBackEnd。 |
Z_VERSION_ERROR版本或结构大小不匹配 |
version 为 NULL、主版本字节不同或 stream_size 错误;在访问流前返回。 | 修正版本及结构大小后重新初始化;本次失败无需结束。 |
Z_STREAM_ERROR流、窗口或位数被拒绝 |
strm 或 window 为 NULL,或 windowBits 不在 8..15 范围内。 | 提供有效的非活跃流、窗口及位数后重新初始化;本次失败无需结束。 |
Z_MEM_ERROR状态分配失败 |
未能分配状态;msg 和默认分配器字段可能改变,旧 state 字段保留。 | 资源可用时可重新初始化;未保留新分配,本次失败无需 inflateBackEnd。 |
调用条件与效果
定义域 受限定义域:有效调用者内存、未活动的流和默认分配器。
前置条件 非 NULL 的 strm 指向可写 z_stream,其 zalloc、zfree 和
opaque 已初始化。使用 NULL 或默认分配/释放函数对;不得覆盖仍存活的库状态。
非 NULL 的 version 的首字节可读。在初始化路径上,window 提供与流分离的
2^windowBits 个可写字节。该切片须保持存活直到结束操作。
内存与状态效果 可能初始化分配器字段和 opaque,清除 msg,并分配一个状态。
窗口仍由调用者拥有,此处不分配、不清空,也不释放窗口。
证明目标。
- 目标。
Goal.inflateBackInit__safety(Safety/Back.lean);必需。定理:ZlibF.Spec.Public.BackSafetyProof.inflateBackInit__safety(public-back-safety.lean)。 - 适用条件(1 到 3 是
InitArguments,即inflateInit2_的条件):- 堆是库堆(
Fresh、Uniq、LibraryGlobals); version为 NULL,或其首字节可读(VersionValue);strm为 NULL;或者指向一个可读的流记录,其zalloc和zfree各自为 NULL 或默认函数(DefaultOrNull);- 当
window不为 NULL 且windowBits为 8 到 15 时,window覆盖2^windowBits个可写字节(Writable)。
- 堆是库堆(
- 无条件覆盖。 每一个
windowBits,包括 8 到 15 之外的值;window为 NULL;每一个stream_size;version首字节的每一个取值;记录中其他字段的每一个取值,包括state;每一种分配结果。如果记录原本持有一个存活的解码器,而调用返回Z_OK,旧状态仍处于已分配状态,而记录不再指向它:账本如实记下这次泄漏,并不排除它。 - 保证。
- 返回。 调用返回。
strm为 NULL 时,返回值是Z_VERSION_ERROR或Z_STREAM_ERROR。 - 状态。 返回
Z_OK时,流记录指向新块中一个有效的回调解码器状态,这个状态的窗口就是window(BackValid)。 - 写入。
strm为 NULL 时不写任何内容:堆不变。否则只写流记录和调用自己分配的块(Frame)。 - 分配。 返回
Z_OK时,恰好新增一个块,即状态记录,并且不释放任何块(LiveChange)。返回其他值时,已分配的块与调用前相同。
- 返回。 调用返回。
- 不在本目标内。
zalloc或zfree是自定义函数的流:在所有目标之外(见偏离记录)。每种拒绝和分配失败各返回哪个值,以及调用之后各字段的值:功能目标Goal.inflateBackInit_(不在计划内;已有定理证明它)。合法的调用确实返回Z_OK:Goal.inflate_back_initialisation_domain(Safety/Domains.lean),必需。
完整返回条件与边界
返回与保证 Z_OK 关联供 inflateBack 使用的新状态,且 8 <= windowBits <= 15。
输入/输出指针、可用计数、累计计数、adler 和 data_type 不变。
只初始化指定的状态字段;该状态须用于回调 API。
错误路径 NULL 版本、主版本字节不同或流大小错误,会在访问流前返回 Z_VERSION_ERROR。
NULL strm/window,或位数不在 8..15 内,返回 Z_STREAM_ERROR。
分配失败返回 Z_MEM_ERROR:msg 和默认分配器字段可能已改变,但保留原 state 字段。
没有分配状态,因此在此未活动流定义域内,初始化失败后不需要结束调用。
本组共同前提与范围
回调接口允许调用者提供输入片段,并直接从窗口接收解码输出。 先用 inflateBackInit_ 初始化,再用 inflateBack 解码, 最后用 inflateBackEnd 释放状态。窗口始终由调用者拥有。
这些聚焦契约对应固定版本的 infback.c 和 zlib.h,针对默认 LP64 Linux 构建。 定义域和效果标签见契约约定。
已证明的内容。 每个函数的必需目标是它的安全目标:没有未定义行为、没有内存错误、没有泄漏,并且终止(见安全性)。各条目在“证明目标”下写出这个目标及其前提。证明所假设的是这些前提,而不是文档中的前置条件;两者不同时,以 Lean 陈述为准。这里描述的返回值、输出字节和状态变化属于功能行为:它们读自 C 源码,凡是没有定理陈述的,都尚未由证明确认。它们不是安全结论所必需的。哪些目标已完成,见进度。
每个函数都有自己的必需安全目标:Goal.inflateBackInit__safety、Goal.inflateBack_safety 和
Goal.inflateBackEnd_safety(Safety/Back.lean)。
序列目标 Goal.inflate_back_sequence_safety(Safety/Sequences.lean)
同样是必需的。它多说一点:每段历史之后,解码器状态都是有效的;它的调用子句和结束子句,就是 inflateBack 和
inflateBackEnd 的目标所重复的子句。功能目标 Goal.inflateBackInit_、Goal.inflateBack
和 Goal.inflateBackEnd(Functional/Back.lean)不在计划内;
每个条目都说明它的功能目标有没有定理证明。
inflateBack 和 inflateBackEnd 的目标所覆盖的,是回调解码器历史(BackSafeReachable)。
历史从一次返回 Z_OK 的 inflateBackInit_ 调用开始:
- 堆是库堆(
Fresh、Uniq、LibraryGlobals),stream_size为 112,version的首字节是'1'; 大小或版本字节不同的调用不会返回Z_OK; - 流记录可读,其
zalloc和zfree各自为 NULL 或默认函数,其他字段(包括state)取任意值(BackInitArguments); windowBits为 8 到 15,窗口非 NULL,有2^windowBits个可写字节,并且是某个堆字节块的一段。
此后可以接任意多步,每步是下面两种之一。一种是一次 inflateBack 调用,它满足其目标的条件
2、3、5 和 6,并且已经返回。另一种是调用者编辑:只改 next_in、avail_in、next_out、avail_out
以及流不拥有的内存,并且保持窗口这一段的字节不变。编辑还保持每个仍然存活的块的只读标志不变,而 C 代码本来就无法改变这个标志。
比 zlib.h 窄的前提,都是偏离记录中的行。
inflateBack 解码裸 DEFLATE。任何 zlib/gzip 头部、尾部和校验和都由调用者处理。
调用者拥有一个至少 2^windowBits 字节的可写窗口,它同时也是输出缓冲区。
windowBits 是窗口字节数的二进制指数:15 表示 2^15 = 32768 字节。对一般流使用这个配置;更小窗口可能拒绝有效的长距离引用。
flowchart LR
I["inflateBackInit_: 分配状态"] --> B["inflateBack: 解码一个流"]
B -->|另一个流| B
B -->|成功或解码错误| E["inflateBackEnd: 释放状态"]
I -->|无需解码| E
回调让库在需要数据时主动调用应用代码。输入回调的参数 in_desc 是应用自己的上下文;buf 接收下一个输入片段的起始指针,返回值给出这个片段的字节数。输出回调的 out_desc 也是应用上下文;buf 和 len 给出本次可以读取的输出范围,len 以字节计。库把指针和长度交给回调,不转移窗口的所有权。
回调类型如下:
typedef unsigned (*in_func)(void FAR *, z_const unsigned char FAR * FAR *);
typedef int (*out_func)(void FAR *, unsigned char FAR *, unsigned);
in(in_desc, &buf) 返回字节数并设置 buf;零表示没有输入,此时忽略 buf。
out(out_desc, buf, len) 接收至多一个窗口的字节;零表示成功。
若回调支持 NULL,描述参数可以为 NULL。
安全目标
ZlibF.Spec.Public.Goal.inflateBackInit__safety
状态:完成 · 结论的状态
/-- `int inflateBackInit_(z_streamp strm, int windowBits, unsigned char FAR *window, const char *version, int stream_size)`.
**Safety of `inflateBackInit_`** (macro `inflateBackInit`): on `InitArguments`, for every
`windowBits`, every `stream_size` and every allocation outcome, the call returns without a fault.
zlib.h requires a window of `2^windowBits` bytes, so where the bits are in range and the window is
not `NULL` it is writable for that length. A `NULL` stream is refused with `Z_VERSION_ERROR` or
`Z_STREAM_ERROR` and the heap unchanged. Otherwise the call writes only the stream record and fresh
blocks; on `Z_OK` the stream holds a valid callback-decoder state over the caller's window, and only
the new state block is new; on any other code the live blocks are unchanged. -/
def Goal.inflateBackInit__safety : Prop :=
∀ h strm version size wb window, InitArguments h strm version →
(window ≠ .null → 8 ≤ wb.toInt → wb.toInt ≤ 15 → Writable h window (2 ^ wb.toInt.toNat)) →
∃ rc after, C.run (Zlib.Infback.inflateBackInit_ strm wb window version size) h = .ok (rc, after) ∧
match strm with
| none => (rc = Z_VERSION_ERROR ∨ rc = Z_STREAM_ERROR) ∧ after = h
| some r => Frame h after (StreamRoot r) ∧
((rc = Z_OK ∧ (∃ z s, BackValid after r h.nextBlk z s ∧ s.window = window) ∧
LiveChange h after (fun b => b = h.nextBlk) (fun _ => False)) ∨
(rc ≠ Z_OK ∧ LiveChange h after (fun _ => False) (fun _ => False)))相关定义与源码 ↗功能契约(安全之外)
ZlibF.Spec.Public.Goal.inflateBackInit_
状态:完成 · 结论的状态
/-- `int inflateBackInit_(z_streamp strm, int windowBits, unsigned char *window,
const char *version, int stream_size)`.
The caller retains the window. Only the state record is allocated; its other integer fields
remain arbitrary. Refusal precedes allocation, and allocation failure retains the old state field. -/
def Goal.inflateBackInit_ : Prop :=
(∀ h p wb window version head size, VersionValue h version head →
(head ≠ some 49 ∨ size ≠ 112) →
C.run (Zlib.Infback.inflateBackInit_ p wb window version size) h = .ok (Z_VERSION_ERROR, h)) ∧
(∀ h p wb window version, VersionValue h version (some 49) →
(p = none ∨ window = .null ∨ wb.toInt < 8 ∨ 15 < wb.toInt) →
C.run (Zlib.Infback.inflateBackInit_ p wb window version 112) h = .ok (Z_STREAM_ERROR, h)) ∧
(∀ h r z wb window version,
Fresh h → Zlib.Inflate.Spec.Uniq h → LibraryGlobals h → r.get h = some z →
DefaultOrNull z → VersionValue h version (some 49) →
8 ≤ wb.toInt → wb.toInt ≤ 15 → window ≠ .null → Writable h window (2 ^ wb.toInt.toNat) →
∃ rc after,
C.run (Zlib.Infback.inflateBackInit_ (some r) wb window version 112) h = .ok (rc, after) ∧
after.nalloc = h.nalloc + 1 ∧
if h.allocOk h.nalloc = false then
rc = Z_MEM_ERROR ∧ SameObjects (r.put h (preparedStream z)) after
else rc = Z_OK ∧
let z' := { preparedStream z with state := some (.inflate h.nextBlk) }
let s := backInitialState (h.garbage h.nalloc) window wb
BackValid after r h.nextBlk z' s ∧
Frame h after (StreamRoot r) ∧
LiveChange h after (fun b => b = h.nextBlk) (fun _ => False))相关定义与源码 ↗