c - 为什么 printf( ) 在重新打开标准输出流后工作异常

Question

重新打开 STDOUT 流后，如果像这样调用 print()，消息不会显示在我的屏幕上:

printf("The message disappeared\n")

解释问题的代码片段:

#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <unistd.h>
#include <stdarg.h>
#include <unistd.h>
#include <errno.h>

int main(void)
{
    printf("Display a message\n");
    int fd, fd_copy, new_fd;
    FILE *old_stream = stdout;

    fd = STDOUT_FILENO;

    fd_copy = dup(fd);
    fclose(old_stream);
    new_fd = dup2(fd_copy, fd);
    close(fd_copy);
    FILE *new_stream = fdopen(fd, "w");
    stdout = new_stream;

    printf("test %d\n", 1);
    fprintf(stdout, "test 2\n");
    int rc = printf("test 3\n");
    printf("Test 4 Why the message disappeared\n");
    printf("Error message is [%s]\n", strerror(errno));

    return 0;
}

为什么只有test 4不能显示在我的屏幕上。他们不都使用标准输出作为输出吗？

输出:

# gcc main.c; ./a.out
Display a message
test 1
test 2
test 3      
Error message is [Bad file descriptor]

上面的代码片段来自LVM2库函数。

int reopen_standard_stream(FILE **stream, const char *mode)
/* https://github.com/lvmteam/lvm2/blob/master/lib/log/log.c */

我设计的动态库:

我总结了一个动态库，它包括供其他进程使用的 LVM 动态库。其中一个函数是这样的(输出系统中所有的PV):

char global_buffer[0x1000];
void show_pvs_clbk_fn(int level, const char *file, int line,
    int dm_errno, const char *format)
{
    /* Extract and process output here rather than printing it */
    if (level != LVM2_LOG_PRINT)
        return;
    sprintf(global_buffer, "%s%s\n", global_buffer, format)
}

int show_all_PV(char *out_buffer)
{
    void *handle = lvm2_init();
    lvm2_log_fn(show_pvs_clbk_fn);
    int rc = lvm2_run(handle, "pvs");
    lvm2_exit(handle);
    if (rc != LVM2_COMMAND_SUCCEEDED) {
        return -1;
    }

    strcpy(out_buffer, global_buffer)
    return 0;
}

调用者可以像这样调用 show_all_PV() API:

 int main(void)
 {
    char tmp[0x1000];
    if (!show_all_PV(tmp)) {
        printf("====== PVS are ======\n");
        printf("%s\n", tmp);
    }
 }

输出:

====== PVS are ======
 PV             VG   Fmt  Attr PSize  PFree
 /dev/nvme1n1p1 vg1  lvm2 a--  <1.2t   1.1t

一些调用者可能会弄乱标准输出:

我发现一个奇怪的事情是，如果调用者定义了一个包含vfprintf(stdout, ) 系统调用的函数。他们永远不会从普通的 print() API 获得输出。

#inclide <stdlin.h>
#inclide <stdio.h>
#inclide <unistd.h>
#inclide <stdarg.h>

#if 1
int a_function_never_be_called(const char *formatP, ...)
{
    va_list  ap;
    va_start(ap, formatP);
    vfprintf(stdout, formatP, ap);
    va_end(ap);
    return 0;
}
#endif

int main(void)
     {
        char tmp[0x1000];
        if (!show_all_PV(tmp)) {
            printf("====== PVS are ======\n");
            printf("%s\n", tmp);
        }
     }

字符串“====== PVS are ======”消失了，调用者得到一个 IO 错误 Bad file descripto。

输出:

 PV             VG   Fmt  Attr PSize  PFree
 /dev/nvme1n1p1 vg1  lvm2 a--  <1.2t   1.1t

Answer 1

分配给 stdout(或 stdin 或 stderr)是未定义的行为。面对未定义的行为，会发生奇怪的事情。

技术上就不用多说了。但是在我写完这个答案之后，@zwol在评论中指出 glibc documentation claims to allow reassignment of standard IO streams .用这些术语来说，这种行为是一个错误。我接受这个事实，但 OP 并不是以 glibc 的使用为前提的，而且还有许多其他标准库实现不提供此保证。在其中一些中，分配给 stdout 会在编译时引发错误；在其他情况下，它根本不起作用或无法始终如一地起作用。换句话说，不管 glibc，分配给 stdout 是未定义的行为，并且尝试这样做的软件充其量是不可移植的。 (而且，正如我们所见，即使在 glibc 上，它也会导致不可预测的输出。)

但是我的好奇心被勾起了，所以我调查了一下。首先要查看 gcc 生成的实际代码，看看每个输出调用实际调用了哪些库函数:

    printf("test %d\n", 1);         /* Calls printf("test %d\n", 1); */
    fprintf(stdout, "test 2\n");    /* Calls fwrite("test 2\n", 1, 7, stdout); */
    int rc = printf("test 3\n");    /* Calls printf("test 3\n"); */
    printf("Test 4 Why the message disappeared\n");
                                    /* Calls puts("Test 4...disappeared"); */
    printf("Error message is [%s]\n", strerror(errno));
                                    /* Calls printf("..."); */

请注意，GCC 正在努力优化调用。在第 2 行和第 4 行，它能够找到非 printf 库调用，从而避免了格式字符串的运行时解析。

但请注意，第 3 行并没有这样做，它看起来与第 4 行相同。为什么不呢？因为你使用的是 printf 的返回值，也就是发送到 stdout 的字符数。但这与 puts 的返回值不同，它在成功时只返回一个“非负数”。所以替换是不可能的。

假设我们从第 3 行删除 int rc = ，然后重新编译。现在我们得到这个:

    printf("test %d\n", 1);         /* Calls printf("test %d\n", 1); */
    fprintf(stdout, "test 2\n");    /* Calls fwrite("test 2\n", 1, 7, stdout); */
    printf("test 3\n");             /* Calls puts("test 3"); */
    printf("Test 4 Why the message disappeared\n");
                                    /* Calls puts("Test 4...disappeared"); */
    printf("Error message is [%s]\n", strerror(errno));
                                    /* Calls printf("..."); */

因此，在不使用返回值的情况下，GCC 可以用 puts 替换 printf。 (还要注意，当它进行替换时，它还会从字符串文字中删除 \n，因为 puts 会自动在其输出的末尾添加一个换行符。)

当我们运行修改后的程序时，我们会看到:

Display a message
test 1
test 2
Error message is [Bad file descriptor]

现在，两行消失了，正是 GCC 使用puts 的那两行。

在开始的恶作剧之后，puts 不再有效，大概是因为它依赖于 stdout 没有被重新分配。这是允许的，因为重新分配 stdout 是未定义的行为。 (如果你想重新打开 stdout，你可以使用 freopen。)

---

最后的说明:

不出所料，事实证明 glibc 团队确实接受了它作为一个错误；它被报告为 bug 24051和 stdin 的类似问题为 bug 24153 .两者都已在 2019 年 8 月发布的 glibc v2.30 中得到修复。因此，如果您最近安装了升级的 Linux，或者您在我写这篇答案多年后阅读它，您可能看不到这个错误。