hiperf/src/virtual_thread.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.
 */
#define HILOG_TAG "RuntimeThread"

#include "virtual_thread.h"

#include <cinttypes>
#include <iostream>
#include <sstream>
#if !is_mingw
#include <sys/mman.h>
#endif

#include "symbols_file.h"
#include "utilities.h"
#include "virtual_runtime.h"
namespace OHOS {
namespace Developtools {
namespace HiPerf {

static constexpr int MMAP_PROT_CHARS = 4;
static constexpr int MAP_PROT_EXEC_INDEX = 2;

#ifdef DEBUG_TIME

bool VirtualThread::IsSorted() const
{
    if (memMapsIndexs_.empty()) {
        return true;
    }
    for (std::size_t index = 1; index < memMaps_.size(); ++index) {
        if (memMaps_[memMapsIndexs_[index - 1]]->end > memMaps_[memMapsIndexs_[index]]->begin) {
            std::cout << "memMaps_ order error:\n"
                      << "    " << memMaps_[memMapsIndexs_[index - 1]]->begin << "-"
                      << memMaps_[memMapsIndexs_[index - 1]]->end
                      << "    " << memMaps_[memMapsIndexs_[index]]->begin << "-"
                      << memMaps_[memMapsIndexs_[index]]->end;
            return false;
        }
    }
    return true;
}
#endif

int64_t VirtualThread::FindMapIndexByAddr(uint64_t addr) const
{
    HLOGM("try found vaddr 0x%" PRIx64 "in maps %zu", addr, memMaps_.size());
    const int64_t illegal = -1;
    if (memMaps_.size() == 0) {
        return illegal;
    }
    if (memMaps_[memMapsIndexs_[0]]->begin > addr) {
        return illegal;
    }
    if (memMaps_[memMapsIndexs_[memMapsIndexs_.size() >= 1 ? memMapsIndexs_.size() -  1 : 0]]->end <= addr) {
        return illegal;
    }
    constexpr int divisorNum {2};
    std::size_t left {0};
    std::size_t right {memMapsIndexs_.size()};
    std::size_t mid = (right - left) / divisorNum + left;
    while (left < right) {
        if (addr < memMaps_[memMapsIndexs_[mid]]->end) {
            right = mid;
            mid = (right - left) / divisorNum + left;
            continue;
        }
        if (addr >= memMaps_[memMapsIndexs_[mid]]->end) {
            left = mid + 1;
            mid = (right - left) / divisorNum + left;
            continue;
        }
    }
    if (addr >= memMaps_[memMapsIndexs_[left]]->begin && addr < memMaps_[memMapsIndexs_[left]]->end) {
        if (left > 0) {
            memMaps_[memMapsIndexs_[left]]->prevMap = memMaps_[memMapsIndexs_[left - 1]];
        }
        return static_cast<int64_t>(memMapsIndexs_[left]);
    }
    return illegal;
}

std::shared_ptr<DfxMap> VirtualThread::FindMapByAddr(uint64_t addr) const
{
    HLOGM("try found vaddr 0x%" PRIx64 "in maps %zu", addr, memMaps_.size());
    if (memMaps_.size() == 0) {
        return nullptr;
    }
    if (memMaps_[memMapsIndexs_[0]]->begin > addr) {
        return nullptr;
    }
    if (memMaps_[memMapsIndexs_[memMapsIndexs_.size() >= 1 ? memMapsIndexs_.size() - 1 : 0]]->end <= addr) {
        return nullptr;
    }
    constexpr int divisorNum {2};
    std::size_t left {0};
    std::size_t right {memMapsIndexs_.size()};
    std::size_t mid = (right - left) / divisorNum + left;
    while (left < right) {
        if (addr < memMaps_[memMapsIndexs_[mid]]->end) {
            right = mid;
            mid = (right - left) / divisorNum + left;
            continue;
        }
        if (addr >= memMaps_[memMapsIndexs_[mid]]->end) {
            left = mid + 1;
            mid = (right - left) / divisorNum + left;
            continue;
        }
    }
    if (addr >= memMaps_[memMapsIndexs_[left]]->begin && addr < memMaps_[memMapsIndexs_[left]]->end) {
        if (left > 0) {
            memMaps_[memMapsIndexs_[left]]->prevMap = memMaps_[memMapsIndexs_[left - 1]];
        }
        return memMaps_[memMapsIndexs_[left]];
    }
    return nullptr;
}

std::shared_ptr<DfxMap> VirtualThread::FindMapByFileInfo(const std::string name, uint64_t offset) const
{
    for (auto &map : memMaps_) {
        if (name != map->name) {
            continue;
        }
        // check begin and length
        if (offset >= map->offset && (offset - map->offset) < (map->end - map->begin)) {
            HLOGMMM("found fileoffset 0x%" PRIx64 " in map (0x%" PRIx64 " - 0x%" PRIx64
                    " pageoffset 0x%" PRIx64 ")  from %s",
                    offset, map->begin, map->end, map->offset, map->name.c_str());
            return map;
        }
    }
    HLOGM("NOT found offset 0x%" PRIx64 " in maps %zu ", offset, memMaps_.size());
    return nullptr;
}

SymbolsFile *VirtualThread::FindSymbolsFileByMap(std::shared_ptr<DfxMap> map) const
{
    if (map == nullptr) {
        return nullptr;
    }
    if (map->symbolFileIndex != -1) {
        // no need further operation
        if (symbolsFiles_[map->symbolFileIndex]->LoadDebugInfo(map)) {
            return symbolsFiles_[map->symbolFileIndex].get();
        }
    } else {
        // add it to cache
        for (size_t i = 0; i < symbolsFiles_.size(); ++i) {
            if (symbolsFiles_[i]->filePath_ == map->name) {
                HLOGD("found symbol for map '%s'", map->name.c_str());
                map->symbolFileIndex = static_cast<int32_t>(i);
                if (symbolsFiles_[i]->LoadDebugInfo(map)) {
                    return symbolsFiles_[i].get();
                }
            }
        }
    }

#ifdef DEBUG_MISS_SYMBOL
    if (find(missedSymbolFile_.begin(), missedSymbolFile_.end(), inMap.name) ==
        missedSymbolFile_.end()) {
        missedSymbolFile_.emplace_back(inMap.name);
        HLOGW("NOT found symbol for map '%s'", inMap.name.c_str());
        for (const auto &file : symbolsFiles_) {
            HLOGW(" we have '%s'", file->filePath_.c_str());
        }
    }
#endif
    return nullptr;
}
void VirtualThread::ReportVaddrMapMiss(uint64_t vaddr) const
{
#ifdef HIPERF_DEBUG
    if (DebugLogger::logDisabled_) {
        return;
    }
    if (DebugLogger::GetInstance()->GetLogLevel() <= LEVEL_VERBOSE) {
        if (missedRuntimeVaddr_.find(vaddr) == missedRuntimeVaddr_.end()) {
            missedRuntimeVaddr_.insert(vaddr);
            HLOGV("vaddr %" PRIx64 " not found in any map", vaddr);
            for (auto &map : memMaps_) {
                if (map == nullptr) {
                    return;
                }
                HLOGV("map %s ", map->ToString().c_str());
            }
        }
    }
#endif
}

bool VirtualThread::ReadRoMemory(uint64_t vaddr, uint8_t *data, const size_t size) const
{
    uint64_t pageIndex = vaddr >> 12;
    uint64_t memMapIndex = -1;
    const int64_t exceptRet = -1;
    const uint64_t illegal = -1;
    auto pageFile = vaddr4kPageCache_.find(pageIndex);
    if (pageFile != vaddr4kPageCache_.end()) {
        memMapIndex = pageFile->second;
    } else {
        int64_t retIndex = FindMapIndexByAddr(vaddr);
        memMapIndex = static_cast<uint64_t>(retIndex);
        // add to 4k page cache table
        if (retIndex != exceptRet && memMapIndex < memMaps_.size()) {
            const_cast<VirtualThread *>(this)->vaddr4kPageCache_[pageIndex] = memMapIndex;
        }
    }
    if (memMapIndex != illegal) {
        auto map = memMaps_[memMapIndex];
        if (map != nullptr) {
            if (map->elf == nullptr) {
                SymbolsFile* symFile = FindSymbolsFileByMap(map);
                if (symFile == nullptr) {
                    return false;
                }
                map->elf = symFile->GetElfFile();
            }
            if (map->elf != nullptr) {
                // default base offset is zero
                uint64_t foff = vaddr - map->begin + map->offset - map->elf->GetBaseOffset();
                if (map->elf->Read(foff, data, size)) {
                    return true;
                } else {
                    return false;
                }
            } else {
                HLOGW("find addr %" PRIx64 "in map but not loaded symbole %s", vaddr, map->name.c_str());
            }
        }
    } else {
        HLOGV("not found in any map");
    }
    return false;
}

#if defined(is_mingw) && is_mingw
void VirtualThread::ParseMap()
{
    // only linux support read maps in runtime
    return;
}
#else
void VirtualThread::ParseMap()
{
    if (!(OHOS::HiviewDFX::DfxMaps::Create(pid_, memMaps_, memMapsIndexs_))) {
        HLOGE("VirtualThread Failed to Parse Map.");
    }
    SortMemMaps();
}
#endif

void VirtualThread::FixHMBundleMap()
{
    // fix bundle path in map
    for (auto &map : memMaps_) {
        NeedAdaptHMBundlePath(map->name, name_);
    }
}

constexpr const int MMAP_LINE_TOKEN_INDEX_FLAG = 1;
constexpr const int MMAP_LINE_TOKEN_INDEX_OFFSET = 2;
constexpr const int MMAP_LINE_TOKEN_INDEX_NAME = 5;
constexpr const int MMAP_LINE_MAX_TOKEN = 6;
void VirtualThread::ParseServiceMap(const std::string &filename)
{
    std::string mapPath = StringPrintf("/proc/%d/maps", pid_);
    std::string mapContent = ReadFileToString(mapPath);
    uint64_t begin = 0;
    uint64_t end = 0;
    if (mapContent.size() == 0) {
        HLOGW("Parse %s failed, content empty", mapPath.c_str());
        return;
    }
    std::istringstream s(mapContent);
    std::string line;
    while (std::getline(s, line)) {
        std::vector<std::string> mapTokens = StringSplit(line, " ");
        if (mapTokens.size() == MMAP_LINE_MAX_TOKEN &&
            mapTokens[MMAP_LINE_TOKEN_INDEX_NAME] == name_) {
            HLOGM("map line: %s", line.c_str());
            constexpr int mmapAddrRangeToken = 2;
            std::vector<std::string> addrRanges = StringSplit(mapTokens[0], "-");
            if (addrRanges.size() < mmapAddrRangeToken) {
                continue;
            }
            begin = std::stoull(addrRanges[0], nullptr, NUMBER_FORMAT_HEX_BASE);
            end = std::stoull(addrRanges[1], nullptr, NUMBER_FORMAT_HEX_BASE);
            break;
        }
    }
    CreateMapItem(filename, begin, end - begin, 0);
}

void VirtualThread::ParseDevhostMap(const pid_t devhost)
{
    std::string mapPath = StringPrintf("/proc/%d/maps", devhost);
    std::string mapContent = ReadFileToString(mapPath);
    std::string filename;
    if (mapContent.size() > 0) {
        std::istringstream s(mapContent);
        std::string line;
        while (std::getline(s, line)) {
            // 2fe40000-311e1000 r-xp 00000000 00:01 217 /lib/libdh-linux.so.5.10.97-oh
            // 0                 1    2        3     4   5
            std::vector<std::string> mapTokens = StringSplit(line, " ");
            if (mapTokens.size() < MMAP_LINE_MAX_TOKEN) {
                continue;
            }
            HLOGM("map line: %s", line.c_str());

            // 2fe40000-311e1000
            constexpr const int mmapAddrRangeToken = 2;
            std::vector<std::string> addrRanges = StringSplit(mapTokens[0], "-");
            if (addrRanges.size() != mmapAddrRangeToken) {
                continue;
            }
            uint64_t begin = 0;
            uint64_t end = 0;
            uint64_t offset = 0;
            // 2fe40000 / 311e1000
            try {
                begin = std::stoull(addrRanges[0], nullptr, NUMBER_FORMAT_HEX_BASE);
                end = std::stoull(addrRanges[1], nullptr, NUMBER_FORMAT_HEX_BASE);
                offset = std::stoull(mapTokens[MMAP_LINE_TOKEN_INDEX_OFFSET],
                                     nullptr, NUMBER_FORMAT_HEX_BASE);
            } catch (...) {
                continue;
            }

            // --x-
            if (mapTokens[MMAP_LINE_TOKEN_INDEX_FLAG].size() != MMAP_PROT_CHARS ||
                mapTokens[MMAP_LINE_TOKEN_INDEX_FLAG][MAP_PROT_EXEC_INDEX] != 'x') {
                continue;
            }

            const std::string anonPrefix = "[anon:[";
            const std::string anonPostfix = "]]";
            filename = mapTokens[MMAP_LINE_TOKEN_INDEX_NAME];
            if (filename == "[shmm]") {
                continue;
            }
            if (filename.find(anonPrefix) != std::string::npos) {
                // '[anon:[liblinux/devhost.ko]]' to '/liblinux/devhost.ko'
                filename = filename.substr(anonPrefix.size(),
                                           filename.size() - anonPrefix.size() -
                                           anonPostfix.size());
                filename = "/" + filename;
            } else if (filename.find(DEVHOST_LINUX_FILE_NAME) != std::string::npos) {
                // '/lib/libdh-linux.so.5.10.97-oh' to '/lib/libdh-linux.so'
                filename = DEVHOST_LINUX_FILE_NAME;
            }
            CreateMapItem(filename, begin, end - begin, offset);
        }
    }
    SortMemMaps();
}

void VirtualThread::SortMemMaps()
{
    for (int currPos = 1; currPos < static_cast<int>(memMaps_.size()); ++currPos) {
        int targetPos = currPos - 1;
        while (targetPos >= 0 && memMaps_[memMapsIndexs_[currPos]]->end < memMaps_[memMapsIndexs_[targetPos]]->end) {
            --targetPos;
        }
        if (targetPos < currPos - 1) {
            auto target = memMapsIndexs_[currPos];
            for (int k = currPos - 1; k > targetPos; --k) {
                memMapsIndexs_[k + 1] = memMapsIndexs_[k];
            }
            memMapsIndexs_[targetPos + 1] = target;
        }
    }
}

std::shared_ptr<DfxMap> VirtualThread::CreateMapItem(const std::string &filename, uint64_t const begin,
                                                     const uint64_t len, const uint64_t offset,
                                                     const uint32_t prot)
{
    if (!OHOS::HiviewDFX::DfxMaps::IsLegalMapItem(filename)) {
        return nullptr; // skip some memmap
    }
    std::shared_ptr<DfxMap> map = memMaps_.emplace_back(std::make_shared<DfxMap>(begin, begin + len, offset,
        prot, filename));
    memMapsIndexs_.emplace_back(memMaps_.size() >= 1 ? memMaps_.size() - 1 : 0);
    HLOGD(" %u:%u create a new map(total %zu) at '%s' (0x%" PRIx64 "-0x%" PRIx64 ")@0x%" PRIx64 " ",
          pid_, tid_, memMaps_.size(), map->name.c_str(), map->begin, map->end, map->offset);
    SortMemMaps();
    return map;
}
} // namespace HiPerf
} // namespace Developtools
} // namespace OHOS