AnyPS5/core/libs/tests/GuestStreamPurge.cpp

#include "prx/libc/include/Api.hpp"
#include "prx/libc/include/FileStream.hpp"
#include "prx/libc/include/general/VabiMacros.hpp"
#include <array>
#include <cerrno>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <stdexcept>
#ifdef _WIN32
#include <io.h>
#include <fcntl.h>
#else
#include <unistd.h>
#endif

namespace {

void Require(bool condition, const char* message) {
    if (!condition) {
        std::fprintf(stderr, "stream purge: %s\n", message);
        std::abort();
    }
}

std::int64_t Position(std::FILE* stream) {
#ifdef _WIN32
    return ::_telli64(::_fileno(stream));
#else
    return ::lseek(::fileno(stream), 0, SEEK_CUR);
#endif
}

struct BufferedStream {
    std::array<char, 4096> buffer{};
    std::FILE* native = std::tmpfile();
    FileStream stream{native};

    BufferedStream() { Require(std::setvbuf(native, buffer.data(), _IOFBF, buffer.size()) == 0, "set full buffering"); }
    ~BufferedStream() { if (stream.IsOpen()) stream.Close(); }
};

void CheckOutput() {
    BufferedStream file;
    Require(fwrite_nid_postfix("discard", 1, 7, &file.stream) == 7, "buffer output");
    Require(Position(file.native) == 0, "output is pending in the stream buffer");
    errno = 123;
    Require(fpurge_nid_postfix(&file.stream) == 0 && errno == 123, "purge preserves errno on success");
    Require(Position(file.native) == 0, "purge does not write or seek");
    Require(fpurge_nid_postfix(&file.stream) == 0, "purge an empty buffer twice");
    Require(fwrite_nid_postfix("kept", 1, 4, &file.stream) == 4, "write after purging");
    Require(std::fflush(file.native) == 0 && Position(file.native) == 4, "flush only subsequent output");
    Require(std::fseek(file.native, 0, SEEK_SET) == 0, "rewind subsequent output");
    char bytes[8]{};
    Require(std::fread(bytes, 1, sizeof(bytes), file.native) == 4 && std::memcmp(bytes, "kept", 4) == 0, "discarded output never reaches the file");
}

void CheckInput() {
    BufferedStream file;
    Require(std::fwrite("abcdef", 1, 6, file.native) == 6 && std::fflush(file.native) == 0, "prepare input");
    Require(std::fseek(file.native, 0, SEEK_SET) == 0, "rewind input");
    Require(fgetc_nid_postfix(&file.stream) == 'a', "read one buffered byte");
    const auto position = Position(file.native);
    Require(position > 1, "input has read-ahead data");
    Require(ungetc_nid_postfix('X', &file.stream) == 'X', "push back a different byte");
    Require(fpurge_nid_postfix(&file.stream) == 0, "purge input and pushback");
    Require(Position(file.native) == position, "purging input does not reposition the descriptor");
    Require(fgetc_nid_postfix(&file.stream) == EOF, "read-ahead and pushback have been discarded");
    Require((file.stream.GuestState().flags & 0x20) != 0, "publish EOF");
    Require(fpurge_nid_postfix(&file.stream) == 0 && (file.stream.GuestState().flags & 0x20) != 0, "purge preserves EOF");
    file.stream.SetError();
    Require(fpurge_nid_postfix(&file.stream) == 0 && (file.stream.GuestState().flags & 0x60) == 0x60, "purge preserves EOF and error");
}

void CheckUnbuffered() {
    BufferedStream file;
    Require(std::setvbuf(file.native, nullptr, _IONBF, 0) == 0, "disable buffering");
    Require(std::fwrite("ab", 1, 2, file.native) == 2, "write unbuffered input");
    Require(std::fseek(file.native, 0, SEEK_SET) == 0, "rewind unbuffered input");
    Require(fgetc_nid_postfix(&file.stream) == 'a', "read unbuffered byte");
    const auto position = Position(file.native);
    Require(position >= 1 && position <= 2, "unbuffered descriptor position");
    Require(ungetc_nid_postfix('X', &file.stream) == 'X', "push back on an unbuffered stream");
    Require(fpurge_nid_postfix(&file.stream) == 0 && Position(file.native) == position, "purge unbuffered pushback without seeking");
    Require(fgetc_nid_postfix(&file.stream) == (position == 1 ? 'b' : EOF), "resume at the actual descriptor position");
}

void CheckPipe() {
    int descriptors[2];
#ifdef _WIN32
    Require(::_pipe(descriptors, 4096, _O_BINARY) == 0, "create pipe");
    auto* native = ::_fdopen(descriptors[0], "rb");
    Require(::_write(descriptors[1], "abcdef", 6) == 6 && ::_close(descriptors[1]) == 0, "fill pipe and close writer");
#else
    Require(::pipe(descriptors) == 0, "create pipe");
    auto* native = ::fdopen(descriptors[0], "rb");
    Require(::write(descriptors[1], "abcdef", 6) == 6 && ::close(descriptors[1]) == 0, "fill pipe and close writer");
#endif
    Require(native != nullptr, "open pipe stream");
    std::array<char, 4096> buffer{};
    Require(std::setvbuf(native, buffer.data(), _IOFBF, buffer.size()) == 0, "buffer pipe input");
    FileStream stream{native};
    Require(fgetc_nid_postfix(&stream) == 'a' && ungetc_nid_postfix('X', &stream) == 'X', "read and push back on a pipe");
    Require(fpurge_nid_postfix(&stream) == 0, "purge does not require a seekable descriptor");
    Require(fgetc_nid_postfix(&stream) == EOF, "discard pipe read-ahead and pushback");
    Require(stream.Close() == 0, "close pipe stream");
}
void CheckInvalid() {
    BufferedStream file;
    Require(file.stream.Close() == 0, "close stream");
    errno = 0;
    Require(fpurge_nid_postfix(&file.stream) == -1 && errno == 9, "closed stream reports EBADF");
    bool rejected = false;
    try { fpurge_nid_postfix(nullptr); }
    catch (const std::runtime_error&) { rejected = true; }
    Require(rejected, "null stream throws as existing stream functions do");
}

}

int main() {
    CheckOutput();
    CheckInput();
    CheckUnbuffered();
    CheckPipe();
    CheckInvalid();
    std::puts("stream purge tests passed");
}