tools/process_dump/dfx_fault_stack.cpp

/*
 * Copyright (c) 2022-2023 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 "dfx_fault_stack.h"

#include <algorithm>
#include <csignal>
#include <sys/ptrace.h>
#include <sys/stat.h>

#include "dfx_config.h"
#include "dfx_elf.h"
#include "dfx_logger.h"
#include "dfx_ring_buffer_wrapper.h"
#if defined(__x86_64__)
#include "dfx_memory_file.h"
#endif

namespace OHOS {
namespace HiviewDFX {
namespace {
#if defined(__arm__)
constexpr uint64_t STEP = 4;
#define PRINT_FORMAT "%08x"
#elif defined(__aarch64__)
constexpr uint64_t STEP = 8;
#define PRINT_FORMAT "%016llx"
#else
constexpr uint64_t STEP = 8;
#define PRINT_FORMAT "%016llx"
#endif
}
bool FaultStack::ReadTargetMemory(uintptr_t addr, uintptr_t &value) const
{
    uintptr_t targetAddr = addr;
    auto retAddr = reinterpret_cast<long*>(&value);
    for (size_t i = 0; i < sizeof(uintptr_t) / sizeof(long); i++) {
        *retAddr = ptrace(PTRACE_PEEKTEXT, tid_, reinterpret_cast<void*>(targetAddr), nullptr);
        if (*retAddr == -1) {
            return false;
        }
        targetAddr += sizeof(long);
        retAddr += 1;
    }

    return true;
}

uintptr_t FaultStack::AdjustAndCreateMemoryBlock(size_t index, uintptr_t prevSp, uintptr_t prevEndAddr, uintptr_t size)
{
    uintptr_t lowAddrLength = DfxConfig::GetConfig().lowAddressStep;
    uintptr_t startAddr = prevSp - lowAddrLength * STEP;
    if (prevEndAddr != 0 && startAddr <= prevEndAddr) {
        startAddr = prevEndAddr;
    } else {
        size += lowAddrLength;
    }

    if (size == 0) {
        return prevEndAddr;
    }

    std::string name = "sp" + std::to_string(index - 1);
    auto block = CreateMemoryBlock(startAddr, prevSp, size, name);
    blocks_.push_back(block);
    return startAddr + size * STEP;
}

bool FaultStack::CollectStackInfo(const std::vector<DfxFrame>& frames, bool needParseStack)
{
    if (frames.empty()) {
        DFXLOG_WARN("null frames.");
        return false;
    }

    size_t index = 1;
    uintptr_t minAddr = 4096;
    uintptr_t size = 0;
    uintptr_t prevSp = 0;
    uintptr_t prevEndAddr = 0;
    uintptr_t highAddrLength = DfxConfig::GetConfig().highAddressStep;
    if (needParseStack) {
        highAddrLength = 8192; // 8192 : 32k / STEP
    }

    auto firstFrame = frames.at(0);
    prevSp = static_cast<uintptr_t>(firstFrame.sp);
    constexpr size_t MAX_FAULT_STACK_SZ = 4;
    for (index = 1; index < frames.size(); index++) {
        if (index > MAX_FAULT_STACK_SZ) {
            break;
        }

        auto frame = frames.at(index);
        uintptr_t curSp = static_cast<uintptr_t>(frame.sp);

        size = 0;
        if (curSp > prevSp) {
            size = std::min(highAddrLength, static_cast<uintptr_t>(((curSp - prevSp) / STEP) - 1));
        } else {
            break;
        }

        prevEndAddr = AdjustAndCreateMemoryBlock(index, prevSp, prevEndAddr, size);
        prevSp = curSp;
    }

    if ((blocks_.size() < MAX_FAULT_STACK_SZ) && (prevSp > minAddr)) {
        size = highAddrLength;
        prevEndAddr = AdjustAndCreateMemoryBlock(index, prevSp, prevEndAddr, size);
    }

    const uintptr_t minCorruptedStackSz = 1024;
    CreateBlockForCorruptedStack(frames, prevEndAddr, minCorruptedStackSz);
    return true;
}

bool FaultStack::CreateBlockForCorruptedStack(const std::vector<DfxFrame>& frames, uintptr_t prevEndAddr,
                                              uintptr_t size)
{
    const auto& frame = frames.back();
    // stack trace should end with libc or ffrt or */bin/*
    if (frame.mapName.find("ld-musl") != std::string::npos ||
        frame.mapName.find("ffrt") != std::string::npos ||
        frame.mapName.find("bin") != std::string::npos) {
        return false;
    }

    AdjustAndCreateMemoryBlock(frame.index, frame.sp, prevEndAddr, size);
    return true;
}

uintptr_t FaultStack::PrintMemoryBlock(const MemoryBlockInfo& info, uintptr_t stackStartAddr) const
{
    uintptr_t targetAddr = info.startAddr;
    for (uint64_t i = 0; i < static_cast<uint64_t>(info.content.size()); i++) {
        if (targetAddr == info.nameAddr) {
            DfxRingBufferWrapper::GetInstance().AppendBuf("%s:" PRINT_FORMAT " " PRINT_FORMAT "\n",
                info.name.c_str(),
                targetAddr,
                info.content.at(i));
        } else {
            DfxRingBufferWrapper::GetInstance().AppendBuf("    " PRINT_FORMAT " " PRINT_FORMAT "\n",
                targetAddr,
                info.content.at(i));
        }
        if (targetAddr - stackStartAddr > STEP * DfxConfig::GetConfig().highAddressStep) {
            break;
        }
        targetAddr += STEP;
    }
    return targetAddr;
}

void FaultStack::Print() const
{
    PrintRegisterMemory();

    if (blocks_.empty()) {
        return;
    }

    DfxRingBufferWrapper::GetInstance().AppendMsg("FaultStack:\n");
    uintptr_t end = 0;
    uintptr_t stackStartAddr = blocks_.at(0).startAddr;
    for (const auto& block : blocks_) {
        if (end != 0 && end < block.startAddr) {
            DfxRingBufferWrapper::GetInstance().AppendMsg("    ...\n");
        }
        end = PrintMemoryBlock(block, stackStartAddr);
    }
}

MemoryBlockInfo FaultStack::CreateMemoryBlock(
    uintptr_t addr,
    uintptr_t offset,
    uintptr_t size,
    const std::string& name) const
{
    MemoryBlockInfo info;
    info.startAddr = addr;
    info.nameAddr = offset;
    info.size = size;
    info.name = name;
    uintptr_t targetAddr = addr;
    for (uint64_t i = 0; i < static_cast<uint64_t>(size); i++) {
        uintptr_t value = 0;
        if (ReadTargetMemory(targetAddr, value)) {
            info.content.push_back(value);
        } else {
            info.content.push_back(-1);
        }
        targetAddr += STEP;
    }
    return info;
}

#if defined(__x86_64__)
void FaultStack::CollectRegistersBlock(std::shared_ptr<DfxRegs> regs, std::shared_ptr<DfxElfMaps> maps)
#else
void FaultStack::CollectRegistersBlock(std::shared_ptr<DfxRegs> regs, std::shared_ptr<DfxMaps> maps)
#endif
{
    if (regs == nullptr || maps == nullptr) {
        return;
    }

    auto regData = regs->GetRegsData();
    int index = 0;
    for (auto data : regData) {
        index++;
#if defined(__x86_64__)
        std::shared_ptr<DfxElfMap> map;
#else
        std::shared_ptr<DfxMap> map;
#endif
        if (!maps->FindMapByAddr(data, map)) {
            continue;
        }

        if (map->perms.find("r") == std::string::npos) {
            continue;
        }

#if defined(__x86_64__)
        std::string name = regs->GetSpecialRegisterName(data);
#else
        std::string name = regs->GetSpecialRegsName(data);
#endif
        if (name.empty()) {
#if defined(__arm__)
#define NAME_PREFIX "r"
#elif defined(__aarch64__)
#define NAME_PREFIX "x"
#else
#define NAME_PREFIX "x"
#endif
            name = NAME_PREFIX + std::to_string(index - 1);
        }

        constexpr size_t SIZE = sizeof(uintptr_t);
        constexpr int COUNT = 32;
        constexpr int FORWARD_SZ = 2;
#if defined(__x86_64__)
        auto mapName = map->path;
#else
        auto mapName = map->name;
#endif
        if (!mapName.empty()) {
            name.append("(" + mapName + ")");
        }

        data = data & ~(SIZE - 1);
        data -= (FORWARD_SZ * SIZE);
        auto block = CreateMemoryBlock(data, 0, COUNT, name);
        registerBlocks_.push_back(block);
    }
}

void FaultStack::PrintRegisterMemory() const
{
    if (registerBlocks_.empty()) {
        return;
    }

    DfxRingBufferWrapper::GetInstance().AppendMsg("Memory near registers:\n");
    for (const auto& block : registerBlocks_) {
        uintptr_t targetAddr = block.startAddr;
        DfxRingBufferWrapper::GetInstance().AppendMsg(block.name + ":\n");
        for (size_t i = 0; i < block.content.size(); i++) {
            DfxRingBufferWrapper::GetInstance().AppendBuf("    " PRINT_FORMAT " " PRINT_FORMAT "\n",
                targetAddr,
                block.content.at(i));
            targetAddr += STEP;
        }
    }
}

#if defined(__x86_64__)
bool FaultStack::ParseUnwindStack(std::shared_ptr<DfxElfMaps> maps, std::vector<DfxFrame>& frames)
{
    if (maps == nullptr) {
        DFXLOG_ERROR("%s : maps is null.", __func__);
        return false;
    }
    size_t index = frames.size();
    for (const auto& block : blocks_) {
        std::shared_ptr<DfxElfMap> map;
        for (size_t i = 0; i < block.content.size(); i++) {
            if (!maps->FindMapByAddr(block.content[i], map) ||
                map->perms.find("x") == std::string::npos) {
                continue;
            }
            DfxFrame frame;
            frame.index = index;
            frame.pc = block.content[i];
            frame.mapName = map->path;
            int64_t loadBias = 0;
            struct stat st;
            if (stat(map->path.c_str(), &st) == 0 && (st.st_mode & S_IFREG)) {
                auto memoryFile = DfxMemoryFile::CreateFileMemory(frame.mapName, 0);
                if (memoryFile == nullptr) {
                    DFXLOG_ERROR("%s : Failed to CreateFileMemory, elf path(%s).", __func__, frame.mapName.c_str());
                    return false;
                }
                std::shared_ptr<DfxElf> elf = std::make_shared<DfxElf>(memoryFile);
                if (elf == nullptr || !elf->Init()) {
                    DFXLOG_ERROR("%s : Failed to create DfxElf, elf path(%s).", __func__, frame.mapName.c_str());
                    return false;
                }
                loadBias = elf->GetLoadBias();
                frame.buildId = DfxElf::GetReadableBuildID(elf->GetBuildID());
            } else {
                DFXLOG_WARN("%s : mapName(%s) is not file.", __func__, frame.mapName.c_str());
            }

            frame.relPc = frame.pc - map->begin + map->offset + static_cast<uint64_t>(loadBias);
            frames.emplace_back(frame);
            constexpr int MAX_VALID_ADDRESS_NUM = 32;
            if (++index >= MAX_VALID_ADDRESS_NUM) {
                return true;
            }
        }
    }
    return true;
}
#else
bool FaultStack::ParseUnwindStack(std::shared_ptr<DfxMaps> maps, std::vector<DfxFrame>& frames)
{
    if (maps == nullptr) {
        DFXLOG_ERROR("%s : maps is null.", __func__);
        return false;
    }
    size_t index = frames.size();
    for (const auto& block : blocks_) {
        std::shared_ptr<DfxMap> map;
        for (size_t i = 0; i < block.content.size(); i++) {
            if (!maps->FindMapByAddr(block.content[i], map) ||
                map->perms.find("x") == std::string::npos) {
                continue;
            }
            DfxFrame frame;
            frame.index = index;
            frame.pc = block.content[i];
            frame.map = map;
            frame.mapName = map->name;
            int64_t loadBias = 0;
            struct stat st;
            if (stat(map->name.c_str(), &st) == 0 && (st.st_mode & S_IFREG)) {
                auto elf = DfxElf::Create(frame.mapName);
                if (elf == nullptr || !elf->IsValid()) {
                    DFXLOG_ERROR("%s : Failed to create DfxElf, elf path(%s).", __func__, frame.mapName.c_str());
                    return false;
                }
                loadBias = elf->GetLoadBias();
                frame.buildId = elf->GetBuildId();
            } else {
                DFXLOG_WARN("%s : mapName(%s) is not file.", __func__, frame.mapName.c_str());
            }

            frame.relPc = frame.pc - map->begin + map->offset + static_cast<uint64_t>(loadBias);
            frames.emplace_back(frame);
            constexpr int MAX_VALID_ADDRESS_NUM = 32;
            if (++index >= MAX_VALID_ADDRESS_NUM) {
                return true;
            }
        }
    }
    return true;
}
#endif
} // namespace HiviewDFX
} // namespace OHOS