copy.h

Go to the documentation of this file.

#ifndef IOUTILITIES_COPY_H
#define IOUTILITIES_COPY_H
 
#include "./nativefilestream.h"
#if defined(CPP_UTILITIES_USE_PLATFORM_SPECIFIC_API_FOR_OPTIMIZING_COPY_HELPER) && defined(CPP_UTILITIES_USE_NATIVE_FILE_BUFFER)                     \
    && defined(PLATFORM_LINUX)
#define CPP_UTILITIES_USE_SEND_FILE
#include "../conversion/stringbuilder.h"
#endif
 
#ifdef CPP_UTILITIES_USE_SEND_FILE
#include <errno.h>
#include <sys/sendfile.h>
#endif
 
#include <cstdint>
#include <functional>
#include <iostream>
#ifdef CPP_UTILITIES_USE_SEND_FILE
#include <algorithm>
#include <cstring>
#endif
 
namespace CppUtilities {

template <std::size_t bufferSize> class CPP_UTILITIES_EXPORT CopyHelper {
public:
    CopyHelper();
    void copy(std::istream &input, std::ostream &output, std::uint64_t count);
    void callbackCopy(std::istream &input, std::ostream &output, std::uint64_t count, const std::function<bool(void)> &isAborted,
        const std::function<void(double)> &callback);
    void copy(NativeFileStream &input, NativeFileStream &output, std::uint64_t count);
    void callbackCopy(NativeFileStream &input, NativeFileStream &output, std::uint64_t count, const std::function<bool(void)> &isAborted,
        const std::function<void(double)> &callback);
    char *buffer();
 
private:
    char m_buffer[bufferSize];
};

template <std::size_t bufferSize> CopyHelper<bufferSize>::CopyHelper()
{
}

template <std::size_t bufferSize> void CopyHelper<bufferSize>::copy(std::istream &input, std::ostream &output, std::uint64_t count)
{
    while (count > bufferSize) {
        input.read(m_buffer, bufferSize);
        output.write(m_buffer, bufferSize);
        count -= bufferSize;
    }
    input.read(m_buffer, static_cast<std::streamsize>(count));
    output.write(m_buffer, static_cast<std::streamsize>(count));
}

template <std::size_t bufferSize>
void CopyHelper<bufferSize>::callbackCopy(std::istream &input, std::ostream &output, std::uint64_t count, const std::function<bool(void)> &isAborted,
    const std::function<void(double)> &callback)
{
    const auto totalBytes = count;
    while (count > bufferSize) {
        input.read(m_buffer, bufferSize);
        output.write(m_buffer, bufferSize);
        count -= bufferSize;
        if (isAborted()) {
            return;
        }
        callback(static_cast<double>(totalBytes - count) / static_cast<double>(totalBytes));
    }
    input.read(m_buffer, static_cast<std::streamsize>(count));
    output.write(m_buffer, static_cast<std::streamsize>(count));
    callback(1.0);
}

template <std::size_t bufferSize> void CopyHelper<bufferSize>::copy(NativeFileStream &input, NativeFileStream &output, std::uint64_t count)
{
#ifdef CPP_UTILITIES_USE_SEND_FILE
    if (output.fileDescriptor() != -1 && input.fileDescriptor() != -1 && output.fileDescriptor() != input.fileDescriptor()) {
        const auto inputTellg = output.tellg();
        const auto inputTellp = output.tellp();
        const auto outputTellg = output.tellg();
        const auto outputTellp = output.tellp();
        input.flush();
        output.flush();
        const auto totalBytes = static_cast<std::streamoff>(count);
        while (count) {
            const auto bytesCopied = ::sendfile64(output.fileDescriptor(), input.fileDescriptor(), nullptr, count);
            if (bytesCopied < 0) {
                if ((errno == EINVAL || errno == ENOSYS) && static_cast<std::uint64_t>(totalBytes) == count) {
                    // try again the unoptimized version, maybe the filesystem doesn't support sendfile
                    goto unoptimized_version;
                }
                throw std::ios_base::failure(argsToString("sendfile64() failed: ", std::strerror(errno)));
            }
            count -= static_cast<std::uint64_t>(bytesCopied);
        }
        input.sync();
        output.sync();
        output.seekg(outputTellg + totalBytes);
        output.seekp(outputTellp + totalBytes);
        input.seekg(inputTellg + totalBytes);
        input.seekp(inputTellp + totalBytes);
        return;
    }
unoptimized_version:
#endif
    copy(static_cast<std::istream &>(input), static_cast<std::ostream &>(output), count);
}

template <std::size_t bufferSize>
void CopyHelper<bufferSize>::callbackCopy(NativeFileStream &input, NativeFileStream &output, std::uint64_t count,
    const std::function<bool(void)> &isAborted, const std::function<void(double)> &callback)
{
#ifdef CPP_UTILITIES_USE_SEND_FILE
    if (output.fileDescriptor() != -1 && input.fileDescriptor() != -1 && output.fileDescriptor() != input.fileDescriptor()) {
        const auto inputTellg = output.tellg();
        const auto inputTellp = output.tellp();
        const auto outputTellg = output.tellg();
        const auto outputTellp = output.tellp();
        input.flush();
        output.flush();
        const auto totalBytes = static_cast<std::streamoff>(count);
        while (count) {
            const auto bytesToCopy = static_cast<std::size_t>(std::min(count, static_cast<std::uint64_t>(bufferSize)));
            const auto bytesCopied = ::sendfile64(output.fileDescriptor(), input.fileDescriptor(), nullptr, bytesToCopy);
            if (bytesCopied < 0) {
                if ((errno == EINVAL || errno == ENOSYS) && static_cast<std::uint64_t>(totalBytes) == count) {
                    // try again the unoptimized version, maybe the filesystem doesn't support sendfile
                    goto unoptimized_version;
                }
                throw std::ios_base::failure(argsToString("sendfile64() failed: ", std::strerror(errno)));
            }
            count -= static_cast<std::uint64_t>(bytesCopied);
            if (isAborted()) {
                return;
            }
            callback(static_cast<double>(totalBytes - static_cast<std::streamoff>(count)) / static_cast<double>(totalBytes));
        }
        input.sync();
        output.sync();
        output.seekg(outputTellg + totalBytes);
        output.seekp(outputTellp + totalBytes);
        input.seekg(inputTellg + totalBytes);
        input.seekp(inputTellp + totalBytes);
        callback(1.0);
        return;
    }
unoptimized_version:
#endif
    callbackCopy(static_cast<std::istream &>(input), static_cast<std::ostream &>(output), count, isAborted, callback);
}

template <std::size_t bufferSize> char *CopyHelper<bufferSize>::buffer()
{
    return m_buffer;
}
} // namespace CppUtilities
 
#endif // IOUTILITIES_COPY_H