dfx/hprof/file_stream.cpp

/*
 * Copyright (c) 2021-2022 Huawei Device Co., Ltd.
 * Licensed 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.
 */

#include "ecmascript/dfx/hprof/file_stream.h"

#include <climits>
#include <unistd.h>

#include "ecmascript/log_wrapper.h"
#include "ecmascript/platform/file.h"

namespace panda::ecmascript {
FileStream::FileStream(const std::string &fileName)
{
    Initialize(fileName);
}

FileStream::~FileStream()
{
    EndOfStream();
}

void FileStream::EndOfStream()
{
    if (fileStream_.is_open()) {
        fileStream_.close();
    }
}

bool FileStream::Good()
{
    return fileStream_.good();
}

void FileStream::Initialize(const std::string &fileName)
{
    // check file name
    std::pair<bool, std::string> realPath = FilePathValid(fileName);
    if (!realPath.first) {
        LOG_ECMA(ERROR) << "FileStream: check file path failed";
        return;
    }

    fileStream_.open(realPath.second.c_str(), std::ios::out);
    if (fileStream_.fail()) {
        LOG_ECMA(ERROR) << "FileStream: open file failed";
    }
}

std::pair<bool, std::string> FileStream::FilePathValid(const std::string &fileName)
{
    if (fileName.empty() || fileName.size() > PATH_MAX) {
        return std::make_pair(false, "");
    }
    char resolvedPath[PATH_MAX] = {0};
    auto result = realpath(fileName.c_str(), resolvedPath);
    if (result == resolvedPath || errno == ENOENT) {
        return std::make_pair(true, std::string(resolvedPath));
    }
    return std::make_pair(false, "");
}

// Writes the chunk of data into the stream
bool FileStream::WriteChunk(char *data, int32_t size)
{
    if (fileStream_.fail()) {
        return false;
    }

    std::string str(data, size);

    fileStream_ << str;

    return true;
}

FileDescriptorStream::FileDescriptorStream(int32_t fd) : fd_(fd)
{
    FdsanExchangeOwnerTag(reinterpret_cast<fd_t>(fd));
}

FileDescriptorStream::~FileDescriptorStream()
{
    EndOfStream();
}

void FileDescriptorStream::EndOfStream()
{
    if (Good()) {
        Close(reinterpret_cast<fd_t>(fd_));
        fd_ = -1;
    }
}

bool FileDescriptorStream::Good()
{
    return fd_ > 0;
}

// Writes the chunk of data into the stream
bool FileDescriptorStream::WriteChunk(char *data, int32_t size)
{
    if (fd_ < 0) {
        return false;
    }

    std::string str(data, size);
    int ret = dprintf(fd_, "%s", str.c_str());
    if (ret < 0) {
        LOG_ECMA(ERROR) << "Write FD print failed, ret" << ret;
        return false;
    }
    ret = fsync(fd_);
    if (ret < 0) {
        LOG_ECMA(ERROR) << "Write FD file failed, ret" << ret;
        return false;
    }
    return true;
}

bool FileDescriptorStream::WriteBinBlock(char *data, int32_t size)
{
    if (fd_ < 0) {
        return false;
    }
    ssize_t written = write(fd_, data, size);
    if (written == -1) {
        perror("write");
        return false;
    }
    return true;
}

BinaryWriter::BinaryWriter(Stream *stream)
    : stream_(stream), chunkSize_(stream->GetSize()), chunk_(chunkSize_), current_(0)
{
}

BinaryWriter::~BinaryWriter()
{
}

void BinaryWriter::WriteBinBlock(char *block, int size)
{
    char *cur = block;
    while (size > 0) {
        MaybeWriteBinBlock();
        int dstSize = chunkSize_ - current_;
        int writeSize = std::min(dstSize, size);
        if (memcpy_s(chunk_.data() + current_, dstSize, cur, writeSize) != EOK) {
            LOG_FULL(FATAL) << "memcpy_s failed!";
        }
        cur += writeSize;
        size -= writeSize;
        IncreaseFileIndex(writeSize);
    }
}

void BinaryWriter::WriteUInt64(uint64_t num)
{
    if (UNLIKELY(chunkSize_ - current_ < sizeof(uint64_t))) {
        WriteBinBlock();
    }
    *reinterpret_cast<uint64_t *>(chunk_.data() + current_) = num;
    IncreaseFileIndex(sizeof(uint64_t));
}

void BinaryWriter::WriteUInt32(uint32_t num)
{
    if (UNLIKELY(chunkSize_ - current_ < sizeof(uint32_t))) {
        WriteBinBlock();
    }
    *reinterpret_cast<uint32_t *>(chunk_.data() + current_) = num;
    IncreaseFileIndex(sizeof(uint32_t));
}

void BinaryWriter::WriteUInt16(uint16_t num)
{
    if (UNLIKELY(chunkSize_ - current_ < sizeof(uint16_t))) {
        WriteBinBlock();
    }
    *reinterpret_cast<uint16_t *>(chunk_.data() + current_) = num;
    IncreaseFileIndex(sizeof(uint16_t));
}

void BinaryWriter::WriteUInt8(uint8_t num)
{
    if (UNLIKELY(chunkSize_ - current_ < sizeof(uint8_t))) {
        WriteBinBlock();
    }
    *reinterpret_cast<uint8_t *>(chunk_.data() + current_) = num;
    IncreaseFileIndex(sizeof(uint8_t));
}

void BinaryWriter::EndOfWriteBinBlock()
{
    if (current_ > 0) {
        WriteBinBlock();
    }
    stream_->EndOfStream();
}

void BinaryWriter::MaybeWriteBinBlock()
{
    ASSERT(current_ <= chunkSize_);
    if (UNLIKELY(current_ == chunkSize_)) {
        WriteBinBlock();
    }
}

void BinaryWriter::WriteBinBlock()
{
    stream_->WriteBinBlock(chunk_.data(), current_);
    current_ = 0;
}
}