platform/unix/file.cpp

/*
 * Copyright (c) 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/platform/file.h"

#include <dirent.h>
#include "common_components/log/log.h"
#include "ecmascript/module/js_module_source_text.h"

namespace panda::ecmascript {
std::string GetFileDelimiter()
{
    return ":";
}

std::string GetPathSeparator()
{
    return "/";
}

bool RealPath(const std::string &path, std::string &realPath, bool readOnly)
{
    if (path.empty() || path.size() > PATH_MAX) {
        LOG_ECMA(WARN) << "File path is illegal";
        return false;
    }
    char buffer[PATH_MAX] = { '\0' };
    if (!realpath(path.c_str(), buffer)) {
        // Maybe file does not exist.
        if (!readOnly && errno == ENOENT) {
            realPath = path;
            return true;
        }
        LOG_ECMA(ERROR) << "File path: " << path << " realpath failure. errno: " << errno;
        return false;
    }
    realPath = std::string(buffer);
    return true;
}

bool RealPathByChar(const char *path, char *realPath, int rowLength, bool readOnly)
{
    if (strlen(path) == 0 || strlen(path) > PATH_MAX) {
        return false;
    }
    char buffer[PATH_MAX] = { '\0' };
    if (!realpath(path, buffer)) {
        // Maybe file does not exist.
        if (!readOnly && errno == ENOENT) {
            if (strcpy_s(realPath, rowLength, path) != 0) {
                return false;
            }
            return true;
        }
        return false;
    }
    if (strcpy_s(realPath, rowLength, buffer) != 0) {
        return false;
    }
    return true;
}

void DPrintf(fd_t fd, const std::string &buffer)
{
    int ret = dprintf(fd, "%s", buffer.c_str());
    if (ret < 0) {
        LOG_ECMA(DEBUG) << "dprintf fd(" << fd << ") failed";
    }
}

void FSync(fd_t fd)
{
    int ret = fsync(fd);
    if (ret < 0) {
        LOG_ECMA(DEBUG) << "fsync fd(" << fd << ") failed";
    }
}

void FdsanExchangeOwnerTag(fd_t fd)
{
#if defined(PANDA_TARGET_OHOS)
    fdsan_exchange_owner_tag(fd, 0, LOG_DOMAIN);
#else
    LOG_ECMA(DEBUG) << "Unsupport FdsanExchangeOwnerTag fd(" << fd << ")";
#endif
}

void Close(fd_t fd)
{
#if defined(PANDA_TARGET_OHOS)
    fdsan_close_with_tag(fd, LOG_DOMAIN);
#else
    close(fd);
#endif
}

MemMap FileMap(const char *fileName, int flag, int prot, int64_t offset)
{
    fd_t fd = open(fileName, flag);
    if (fd == INVALID_FD) {
        LOG_ECMA(ERROR) << fileName << " file open failed";
        return MemMap();
    }
    FdsanExchangeOwnerTag(fd);

    off_t size = lseek(fd, 0, SEEK_END);
    if (size <= 0) {
        Close(fd);
        LOG_ECMA(ERROR) << fileName << " file is empty";
        return MemMap();
    }

    void *addr = mmap(nullptr, size, prot, MAP_PRIVATE, fd, offset);
    Close(fd);
    return MemMap(addr, size);
}

MemMap CreateFileMap([[maybe_unused]] const char *fileName, [[maybe_unused]] int fileSize,
                     [[maybe_unused]] int flag, [[maybe_unused]] int prot)
{
    fd_t fd = open(fileName, flag, S_IRWXU | S_IRGRP | S_IROTH); // rw-r-r-
    if (fd == INVALID_FD) {
        LOG_ECMA(ERROR) << fileName << " file open failed";
        return MemMap();
    }
    FdsanExchangeOwnerTag(fd);

    if (ftruncate(fd, fileSize) == -1) {
        LOG_ECMA(ERROR) << fileName << " file ftruncate failed";
        close(fd);
        return MemMap();
    }
    struct stat st;
    if (fstat(fd, &st) == -1 || st.st_size == 0) {
        LOG_ECMA(ERROR) << fileName << " file fstat failed";
        close(fd);
        return MemMap();
    }

    void *addr = mmap(nullptr, fileSize, prot, MAP_SHARED, fd, 0);
    Close(fd);
    return MemMap(addr, fileSize);
}

MemMap FileMapForAlignAddressByFd(const fd_t fd, int prot, int64_t offset, uint32_t offStart)
{
    if (fd == INVALID_FD) {
        LOG_ECMA(ERROR) << fd << " fd open failed";
        return MemMap();
    }

    off_t size = lseek(fd, 0, SEEK_END);
    if (size <= 0) {
        LOG_ECMA(ERROR) << fd << " fd is empty";
        return MemMap();
    }
    void *addr = mmap(nullptr, size + offset - offStart, prot, MAP_PRIVATE, fd, offStart);
    return MemMap(addr, size);
}

int FileUnMap(MemMap addr)
{
    return munmap(addr.GetOriginAddr(), addr.GetSize());
}

int FileSync(MemMap addr, int flag)
{
    return msync(addr.GetOriginAddr(), addr.GetSize(), flag);
}

CString ResolveFilenameFromNative(JSThread *thread, const CString &dirname,
                                  CString request)
{
    std::string relativePath;
    if (request.find("./") == 0) {
        request = request.substr(2); // 2 : delete './'
    }
    int suffixEnd = static_cast<int>(request.find_last_of('.'));
    if (request[0] == '/') { // absolute FilePath
        relativePath = request.substr(0, suffixEnd) + ".abc";
    } else {
        int pos = static_cast<int>(dirname.find_last_of('/'));
        relativePath = dirname.substr(0, pos + 1) + request.substr(0, suffixEnd) + ".abc";
    }

    std::string absPath = "";
    if (RealPath(relativePath.c_str(), absPath)) {
        return absPath.c_str();
    }
    THROW_REFERENCE_ERROR_AND_RETURN(thread, "resolve absolute path fail", CString());
}

bool FileExist(const char *filename)
{
    return (access(filename, F_OK) != -1);
}

int Unlink(const char *filename)
{
    return unlink(filename);
}

void *LoadLib(const std::string &libname)
{
    return dlopen(libname.c_str(), RTLD_NOW);
}

void *FindSymbol(void *handle, const char *symbol)
{
    return dlsym(handle, symbol);
}

int CloseLib(void *handle)
{
    return dlclose(handle);
}

char *LoadLibError()
{
    return dlerror();
}

void DeleteFilesWithSuffix(const std::string &dirPath, const std::string &suffix)
{
    DIR* dir = opendir(dirPath.data());
    if (!dir) {
        LOG_FULL(ERROR) << "DeleteFilesWithSuffix open dir Failed";
        return;
    }
    struct dirent* entry;
    while ((entry = readdir(dir)) != nullptr) {
        if (entry->d_type == DT_REG) {
            const std::string &fileName = entry->d_name;
            if (fileName.find(suffix) == std::string::npos) {
                continue;
            }
            std::string fullPath = std::string(dirPath) + fileName;
            if (remove(fullPath.c_str()) == 0) {
                LOG_ECMA(INFO) << "DeleteFilesWithSuffix remove path success: " << fullPath;
            } else {
                LOG_ECMA(ERROR) << "DeleteFilesWithSuffix remove path failed: " << fullPath;
            }
        }
    }
    closedir(dir);
}
}  // namespace panda::ecmascript