filesystem_helper.cpp File Reference

Go to the source code of this file.

Namespaces
	foobar2000_io

Functions
bool	fb2kFileSelfTest (file::ptr f, abort_callback &aborter)
static void	fileSanitySeek (file::ptr f, pfc::array_t< uint8_t > const &content, size_t offset, abort_callback &aborter)
void	foobar2000_io::listDirectory (const char *path, abort_callback &aborter, listDirectoryFunc_t func)

Function Documentation

bool fb2kFileSelfTest	(	file::ptr	f,
		abort_callback &	aborter
	)

Debug self-test function for testing a file object implementation, performs various behavior validity checks, random access etc. Output goes to fb2k console. Returns true on success, false on failure (buggy file object implementation).

Definition at line 139 of file filesystem_helper.cpp.

                                                           {
    try {
        pfc::array_t<uint8_t> fileContent;
        f->reopen(aborter);
        f->read_till_eof(fileContent, aborter);

        {
            t_filesize sizeClaimed = f->get_size(aborter);
            if (sizeClaimed == filesize_invalid) {
                FB2K_console_formatter() << "File sanity: file reports unknown size, actual size read is " << fileContent.get_size();
            }
            else {
                if (sizeClaimed != fileContent.get_size()) {
                    FB2K_console_formatter() << "File sanity: file reports size of " << sizeClaimed << ", actual size read is " << fileContent.get_size();
                    throw std::runtime_error("File size mismatch");
                }
                else {
                    FB2K_console_formatter() << "File sanity: file size check OK: " << sizeClaimed;
                }
            }
        }

        {
            FB2K_console_formatter() << "File sanity: testing N-first-bytes reads...";
            const size_t sizeUpTo = pfc::min_t<size_t>(fileContent.get_size(), 1024 * 1024);
            pfc::array_staticsize_t<uint8_t> buf1;
            buf1.set_size_discard(sizeUpTo);

            for (size_t w = 1; w <= sizeUpTo; w <<= 1) {
                f->reopen(aborter);
                size_t did = f->read(buf1.get_ptr(), w, aborter);
                if (did != w) {
                    FB2K_console_formatter() << "File sanity: premature EOF reading first " << w << " bytes, got " << did;
                    throw std::runtime_error("Premature EOF");
                }
                if (memcmp(fileContent.get_ptr(), buf1.get_ptr(), did) != 0) {
                    FB2K_console_formatter() << "File sanity: file content mismatch reading first " << w << " bytes";
                    throw std::runtime_error("File content mismatch");
                }
            }
        }
        if (f->can_seek()) {
            FB2K_console_formatter() << "File sanity: testing random access...";

            {
                size_t sizeUpTo = pfc::min_t<size_t>(fileContent.get_size(), 1024 * 1024);
                for (size_t w = 1; w < sizeUpTo; w <<= 1) {
                    fileSanitySeek(f, fileContent, w, aborter);
                }
                fileSanitySeek(f, fileContent, fileContent.get_size(), aborter);
                for (size_t w = 1; w < sizeUpTo; w <<= 1) {
                    fileSanitySeek(f, fileContent, fileContent.get_size() - w, aborter);
                }
                fileSanitySeek(f, fileContent, fileContent.get_size() / 2, aborter);
            }
        }
        FB2K_console_formatter() << "File sanity test: all OK";
        return true;
    }
    catch (std::exception const & e) {
        FB2K_console_formatter() << "File sanity test failure: " << e.what();
        return false;
    }
}

static void fileSanitySeek ( file::ptr  f, pfc::array_t< uint8_t > const &  content, size_t  offset, abort_callback &  aborter  )

static

Definition at line 111 of file filesystem_helper.cpp.

                                                                                                                    {
    const size_t readAmount = 64 * 1024;
    pfc::array_staticsize_t<uint8_t> buf; buf.set_size_discard(readAmount);
    f->seek(offset, aborter);
    t_filesize positionGot = f->get_position(aborter);
    if (positionGot != offset) {
        FB2K_console_formatter() << "File sanity: at " << offset << " reported position became " << positionGot;
        throw std::runtime_error("Seek test failure");
    }
    size_t did = f->read(buf.get_ptr(), readAmount, aborter);
    size_t expected = pfc::min_t<size_t>(readAmount, content.get_size() - offset);
    if (expected != did) {
        FB2K_console_formatter() << "File sanity: at " << offset << " bytes, expected read size of " << expected << ", got " << did;
        if (did > expected) FB2K_console_formatter() << "Read past EOF";
        else  FB2K_console_formatter() << "Premature EOF";
        throw std::runtime_error("Seek test failure");
    }
    if (memcmp(buf.get_ptr(), content.get_ptr() + offset, did) != 0) {
        FB2K_console_formatter() << "File sanity: data mismatch at " << offset << " - " << (offset + did) << " bytes";
        throw std::runtime_error("Seek test failure");
    }
    positionGot = f->get_position(aborter);
    if (positionGot != offset + did) {
        FB2K_console_formatter() << "File sanity: at " << offset << "+" << did << "=" << (offset + did) << " reported position became " << positionGot;
        throw std::runtime_error("Seek test failure");
    }
}