pipe.h

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

/*!
 * \file pipe.h
 * \brief Platform independent pipe, used for IPC.
 */
#ifndef TVM_SUPPORT_PIPE_H_
#define TVM_SUPPORT_PIPE_H_

#include <dmlc/io.h>
#include <tvm/runtime/logging.h>

#ifdef _WIN32
#include <windows.h>
#else
#include <errno.h>
#include <unistd.h>

#include <cstdlib>
#include <cstring>
#endif
#include "errno_handling.h"

namespace tvm {
namespace support {

/*! \brief Platform independent pipe */
class Pipe : public dmlc::Stream {
 public:
#ifdef _WIN32
  using PipeHandle = HANDLE;
  explicit Pipe(int64_t handle) : handle_(reinterpret_cast<PipeHandle>(handle)) {}
#else
  using PipeHandle = int;
  explicit Pipe(int64_t handle) : handle_(static_cast<PipeHandle>(handle)) {}
#endif
  /*! \brief destructor */
  ~Pipe() { Flush(); }

  using Stream::Read;
  using Stream::Write;

  /*!
   * \return last error of pipe operation
   */
  static int GetLastErrorCode() {
#ifdef _WIN32
    return GetLastError();
#else
    return errno;
#endif
  }

  /*!
   * \brief reads data from a file descriptor
   * \param ptr pointer to a memory buffer
   * \param size block size
   * \return the size of data read
   */
  size_t Read(void* ptr, size_t size) final {
    if (size == 0) return 0;
#ifdef _WIN32
    auto fread = [&]() -> ssize_t {
      DWORD nread;
      if (!ReadFile(handle_, static_cast<TCHAR*>(ptr), size, &nread, nullptr))
        return static_cast<ssize_t>(-1);
      return static_cast<ssize_t>(nread);
    };
    DWORD nread = static_cast<DWORD>(RetryCallOnEINTR(fread, GetLastErrorCode));
    ICHECK_EQ(static_cast<size_t>(nread), size) << "Read Error: " << GetLastError();
#else
    size_t nread = 0;
    while (size) {
      ssize_t nread_chunk =
          RetryCallOnEINTR([&]() { return read(handle_, ptr, size); }, GetLastErrorCode);
      ICHECK_NE(nread_chunk, -1) << "Write Error: " << strerror(errno);

      if (nread_chunk == 0) {
        break;
      }

      ICHECK_GE(nread_chunk, 0);
      ICHECK_LE(nread_chunk, size) << "Read " << nread_chunk << " bytes, "
                                   << "but only expected to read " << size << " bytes";
      size -= nread_chunk;
      ptr = static_cast<char*>(ptr) + nread_chunk;
      nread += nread_chunk;
    }
#endif
    return static_cast<size_t>(nread);
  }
  /*!
   * \brief write data to a file descriptor
   * \param ptr pointer to a memory buffer
   * \param size block size
   * \return the size of data read
   */
  size_t Write(const void* ptr, size_t size) final {
    if (size == 0) return 0;
#ifdef _WIN32
    auto fwrite = [&]() -> ssize_t {
      DWORD nwrite;
      if (!WriteFile(handle_, static_cast<const TCHAR*>(ptr), size, &nwrite, nullptr))
        return static_cast<ssize_t>(-1);
      return static_cast<ssize_t>(nwrite);
    };
    DWORD nwrite = static_cast<DWORD>(RetryCallOnEINTR(fwrite, GetLastErrorCode));
    ICHECK_EQ(static_cast<size_t>(nwrite), size) << "Write Error: " << GetLastError();
#else
    ssize_t nwrite =
        RetryCallOnEINTR([&]() { return write(handle_, ptr, size); }, GetLastErrorCode);
    ICHECK_NE(nwrite, -1) << "Write Error: " << strerror(errno);

    ICHECK_LE(nwrite, size) << "Wrote " << nwrite << " bytes, "
                            << "but only expected to write " << size << " bytes";

#endif

    return nwrite;
  }
  /*!
   * \brief Flush the pipe;
   */
  void Flush() {
#ifdef _WIN32
    FlushFileBuffers(handle_);
#endif
  }
  /*! \brief close the pipe */
  void Close() {
#ifdef _WIN32
    CloseHandle(handle_);
#else
    close(handle_);
#endif
  }

 private:
  PipeHandle handle_;
};
}  // namespace support
}  // namespace tvm

#endif  // TVM_SUPPORT_PIPE_H_