为什么C语言中snprintf与swprintf的行为存在差异?
snprintf与swprintf的行为差异梳理 标准原文规定
snprintf规范
C标准对标准库函数snprintf的规定如下:
“
snprintf函数与fprintf功能等价,区别在于其输出会写入参数指定的数组而非流。若n为0,则不会写入任何内容,s可以是空指针。否则,超出第n-1位的输出字符会被丢弃,不会写入数组,同时会在实际写入数组的字符末尾写入一个空字符。若复制操作发生在重叠的对象之间,行为未定义。”“若n足够大,
snprintf函数返回本该写入的字符数,不计末尾的终止空字符;若发生编码错误则返回负值。因此,当且仅当返回值非负且小于n时,以空字符终止的输出已被完整写入。”
swprintf规范
与之对应的swprintf规范如下:
“
swprintf函数与fwprintf功能等价,区别在于参数s指定了宽字符数组,生成的输出会写入该数组而非流。最多写入n个宽字符,包含始终会被添加的终止空宽字符(n为0时除外)。”“
swprintf函数返回数组中写入的宽字符数,不计末尾的终止空宽字符;若发生编码错误,或需要写入的宽字符数大于等于n,则返回负值。”
公开的行为差异
乍看之下,snprintf和swprintf似乎仅存在窄字符/宽字符的处理差异,实际二者核心逻辑并不等价:
- 缓冲区不足时的返回值逻辑完全不同:
snprintf在缓冲区不足时会返回完整输出所需的字符数(不计末尾空终止符),开发者可以利用这个特性先调用一次snprintf获取所需缓冲区长度,动态分配内存后再做正式写入;但swprintf在缓冲区不足时直接返回负值,开发者无法获知完整输出所需的空间大小,无法实现预计算缓冲区长度的逻辑。 - 不存在历史包袱差异:二者均为C99标准引入的函数,不存在
snprintf是遗留功能、swprintf是新设计优化的情况,这种差异目前没有公开的合理解释。
隐蔽的规范歧义与实现分歧
二者的规范还存在更隐蔽的歧义点,直接导致不同实现的行为不一致:
规范歧义点
snprintf的规范明确要求,即使缓冲区长度n小于待输出内容长度,也必须写入最多n-1个有效字符,且末尾必须添加空终止符,输出始终是合法字符串。swprintf的规范表面上也有类似“最多写入n个宽字符,包含始终会被添加的终止空宽字符”的表述,但返回值部分的说明留下了歧义:返回负值的场景同时包含“编码错误”和“待写入字符数≥n”两种情况,但标准没有明确说明“待写入字符数≥n”是否属于错误场景。如果被认定为错误,实现可以选择不写入任何内容、或者不添加末尾空终止符,因为错误场景下的输出本身被视为无效。
实际实现分歧案例
glibc的swprintf实现就采用了“待写入字符数≥n属于错误”的解读:当缓冲区不足时,不会写入末尾的空终止符,导致输出是非法的不完整字符串。
解读争议
目前对该规范存在两种主流解读:
- glibc代表的解读:缓冲区不足属于错误场景,无需保证输出的合法性
- 另一种解读:缓冲区不足仅属于长度提示,不属于错误,应该按照规范第一段的要求写入n-1个有效字符并添加空终止符,返回负值仅用来标识输出未完整写入
标准本身的模糊表述是导致争议的核心原因。
内容的提问来源于stack exchange,提问作者Warp

