Skip to content

out BUGFIX flush the current file before opening the new one in ly_out_filepath() - #2645

Open
GeekQAQ wants to merge 1 commit into
CESNET:develfrom
GeekQAQ:out-filepath-flush-first
Open

GeekQAQ wants to merge 1 commit into
CESNET:develfrom
GeekQAQ:out-filepath-flush-first

Conversation

@GeekQAQ

@GeekQAQ GeekQAQ commented Nov 19, 2026

Copy link
Copy Markdown

ly_out_filepath() opens the new path with fopen(filepath, "wb") and only then closes the current stream. When the new path is the current file (to start writing it again), fopen() truncates the file and the following fclose() writes the data still buffered in the old stream into it, so they end up after the new data. The documentation says "the current file is closed and a new one is created/opened"; it does not say whether the new path may be the current one.

#include <stdio.h>

#include <libyang/libyang.h>

int
main(void)
{
    struct ly_out *out;
    FILE *f;
    char buf[64] = {0};

    ly_out_new_filepath("out.txt", &out);
    ly_write(out, "previous data\n", 14);

    /* start writing the same file again */
    ly_out_filepath(out, "out.txt");
    ly_write(out, "new\n", 4);
    ly_print_flush(out);

    f = fopen("out.txt", "r");
    fread(buf, 1, sizeof buf - 1, f);
    fclose(f);
    printf("file: \"%s\"\n", buf);

    ly_out_free(out, NULL, 1);
    return 0;
}

On devel f45939c the file is "new\nious data\n" instead of "new\n". It happens only with data written by ly_write()/ly_print() and not flushed yet, the printer functions flush at their end.

Fix: flush the current stream before opening the new file. The stream is still kept open until the new file is opened, so a failure to open the new path leaves the handler as it was. The new case in test_output_filepath fails on the current tree and passes with the fix.

Tested on devel f45939c with clang 21, -fsanitize=address,undefined, ENABLE_TESTS=ON: ctest passes (70 tests).

…t_filepath()

The new file was opened (and truncated) before the current stream was
closed. When it was the same file, the data still buffered in the
current stream were written into it on fclose() and remained after the
new data. Flush the current stream first; it is still closed only
after the new file is opened.
Copilot AI balanced review requested due to automatic review settings November 19, 2026 21:51

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants