setvbuf

来自cppreference.com
< c‎ | io
定义于头文件 <stdio.h>
int setvbuf( FILE *         stream, char *         buffer,
             int mode, size_t size );
(C99前)
int setvbuf( FILE *restrict stream, char *restrict buffer,
             int mode, size_t size );
(C99起)

更改给定文件流的stream缓冲模式为参数mode所指定者。另外,

  • buffer为空指针,则更改内部缓冲大小到size
  • buffer不是空指针,则命令文件流使用用户提供的大小为size始于buffer的缓冲区。此流必须在buffer所指向的数组的生存期结束前关闭(用fclose)。在成功调用后setvbuf数组的内容是不确定的,且任何使用它的尝试是未定义行为。

目录

[编辑] 参数

stream - 要设置大小的文件流,仅更改大小和模式时为空指针
buffer - 指向文件流所用的缓冲区的指针
mode - 所用的缓冲模式。可以是下列值之一:
_IOFBF 满缓冲 当缓冲区为空时,从流读入数据。或者当缓冲区满时,向流写入数据。
_IOLBF 行缓冲 每次从流中读入一行数据或向流中写入一行数据。
_IONBF 无缓冲 直接从流中读入数据或直接向流中写入数据,缓冲设置无效。
size - 缓冲区大小

[编辑] 返回值

成功时为0,失败时为非零。

[编辑] 注意

此函数仅可在stream关联到打开的文件后,但在任何操作(异于对setbuf/setvbuf的失败调用)前使用。

并非整个size字节都需要被用于缓冲:实际缓冲大小通常被向下取整到2的倍数、页面大小的倍数等。

在多数实现中,行缓冲仅可对终端输入流可用。

一个常见错误是设置stdin或stdout的缓冲区为在程序终止前生存期结束的数组:

int main(void) {
    char buf[BUFSIZ];
    setbuf(stdin, buf);
} // buf的生存期结束,未定义行为

一般期待默认缓冲区大小BUFSIZ为该实现中文件I/O的最高效缓冲大小,但POSIX fstat经常提供一个更好的估计。

[编辑] 示例

在已知更好的大小时更改缓冲区大小的使用样例。

#include <stdio.h>
#include <stdlib.h>
#include <sys/stat.h>
 
int main(void)
{
    FILE* fp = fopen("test.txt", "r");
    if(fp == NULL) {
       perror("fopen"); return 1;
    }
 
    struct stat stats;
    if(fstat(fileno(fp), &stats) == -1) { // 仅限POSIX
        perror("fstat"); return 1;
    }
 
    printf("BUFSIZ is %d, but optimal block size is %ld\n", BUFSIZ, stats.st_blksize);
    if(setvbuf(fp, NULL, _IOFBF, stats.st_blksize) != 0) {
       perror("setvbuf failed"); // POSIX版本设置errno
       return 1;
    }
 
    int ch;
    while((ch=fgetc(fp)) != EOF); // 读整个文件:使用truss/strace以
                                  // 观察到read(2) syscall被使用
 
    fclose(fp);
}

可能的输出:

BUFSIZ is 8192, but optimal block size is 65536

[编辑] 参考

  • C11 standard (ISO/IEC 9899:2011):
  • 7.21.5.6 The setvbuf function (p: 308)
  • C99 standard (ISO/IEC 9899:1999):
  • 7.19.5.6 The setvbuf function (p: 273-274)
  • C89/C90 standard (ISO/IEC 9899:1990):
  • 4.9.5.6 The setvbuf function

[编辑] 参阅

为文件流设置缓冲区
(函数) [edit]
setvbufC++文档