tools/process_dump/dfx_process.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.
 */

/* This files contains process module. */

#include "dfx_process.h"

#include <climits>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <dirent.h>
#include <securec.h>
#include <sys/types.h>
#include <unistd.h>
#include <vector>
#include "dfx_config.h"
#include "dfx_define.h"
#include "dfx_define.h"
#include "dfx_logger.h"
#include "dfx_maps.h"
#include "dfx_ring_buffer_wrapper.h"
#include "dfx_signal.h"
#include "dfx_thread.h"
#include "dfx_util.h"

namespace OHOS {
namespace HiviewDFX {
static const int ARGS_COUNT_TWO = 2;

void DfxProcess::FillProcessName()
{
    char path[NAME_LEN] = "\0";
    if (snprintf_s(path, sizeof(path), sizeof(path) - 1, "/proc/%d/cmdline", pid_) <= 0) {
        return;
    }

    ReadStringFromFile(path, processName_, NAME_LEN);
}

std::shared_ptr<DfxProcess> DfxProcess::CreateProcessWithKeyThread(pid_t pid, std::shared_ptr<DfxThread> keyThread)
{
    auto dfxProcess = std::make_shared<DfxProcess>();
    if (dfxProcess != nullptr) {
        dfxProcess->SetPid(pid);
        dfxProcess->FillProcessName();
    }
    if (!dfxProcess->InitProcessMaps()) {
        DfxLogWarn("Fail to init process maps.");
        return nullptr;
    }
    if (!dfxProcess->InitProcessThreads(keyThread)) {
        DfxLogWarn("Fail to init threads.");
        return nullptr;
    }

    DfxLogDebug("Init process dump with pid:%d.", dfxProcess->GetPid());
    return dfxProcess;
}

bool DfxProcess::InitProcessMaps()
{
    auto maps = DfxElfMaps::Create(pid_);
    if (!maps) {
        return false;
    }

    SetMaps(maps);
    return true;
}

bool DfxProcess::InitProcessThreads(std::shared_ptr<DfxThread> keyThread)
{
    if (!keyThread) {
        keyThread = std::make_shared<DfxThread>(pid_, pid_, pid_);
    }

    if (!keyThread->Attach()) {
        DfxLogWarn("Fail to attach thread.");
        return false;
    }
    threads_.push_back(keyThread);
    return true;
}

void DfxProcess::SetRecycleTid(pid_t nstid)
{
    recycleTid_ = nstid;
}

bool DfxProcess::InitOtherThreads(bool attach)
{
    char path[NAME_LEN] = {0};
    if (snprintf_s(path, sizeof(path), sizeof(path) - 1, "/proc/%d/task", GetPid()) <= 0) {
        return false;
    }

    char realPath[PATH_MAX];
    if (!realpath(path, realPath)) {
        return false;
    }

    DIR *dir = opendir(realPath);
    if (!dir) {
        return false;
    }

    struct dirent *ent;
    while ((ent = readdir(dir))) {
        if ((strcmp(ent->d_name, ".") == 0) || (strcmp(ent->d_name, "..") == 0)) {
            continue;
        }

        pid_t tid = atoi(ent->d_name);
        if (tid == 0) {
            continue;
        }

        pid_t nstid = tid;
        if (GetNs()) {
            TidToNstid(tid, nstid);
        }

        if (isSignalDump_ && (nstid == recycleTid_)) {
            DfxLogDebug("skip recycle tid:%d nstid:%d.", recycleTid_, nstid);
            continue;
        }

        InsertThreadNode(tid, nstid, attach);
    }
    closedir(dir);
    return true;
}

void DfxProcess::InsertThreadNode(pid_t tid, pid_t nsTid, bool attach)
{
    for (auto iter = threads_.begin(); iter != threads_.end(); iter++) {
        if ((*iter)->GetRealTid() == nsTid) {
            (*iter)->SetThreadId(tid);
            (*iter)->ReadThreadName();
            return;
        }
    }

    auto thread = std::make_shared<DfxThread>(pid_, tid, nsTid);
    if (attach) {
        thread->Attach();
    }
    threads_.push_back(thread);
}

int DfxProcess::TidToNstid(const int tid, int& nstid)
{
    char path[NAME_LEN];
    (void)memset_s(path, sizeof(path), '\0', sizeof(path));
    if (snprintf_s(path, sizeof(path), sizeof(path) - 1, "/proc/%d/task/%d/status", pid_, tid) <= 0) {
        DfxLogWarn("snprintf_s error.");
        return -1;
    }

    char buf[STATUS_LINE_SIZE];
    FILE *fp = fopen(path, "r");
    if (fp == nullptr) {
        return -1;
    }

    int p = 0, t = 0;
    while (!feof(fp)) {
        if (fgets(buf, STATUS_LINE_SIZE, fp) == NULL) {
            fclose(fp);
            return -1;
        }

        // NSpid:  1892    1
        if (strncmp(buf, NSPID_STR_NAME, strlen(NSPID_STR_NAME)) == 0) {
            if (sscanf_s(buf, "%*[^0-9]%d%*[^0-9]%d", &p, &t) != ARGS_COUNT_TWO) {
                DfxLogWarn("TidToNstid sscanf_s failed. pid:%d, tid:%d", pid_, tid);
            }
            nstid = t;
            break;
        }
    }
    (void)fclose(fp);
    return 0;
}

void DfxProcess::SetIsSignalDump(bool isSignalDump)
{
    isSignalDump_ = isSignalDump;
}

bool DfxProcess::GetIsSignalDump() const
{
    return isSignalDump_;
}

pid_t DfxProcess::GetPid() const
{
    return pid_;
}

uid_t DfxProcess::GetUid() const
{
    return uid_;
}

bool DfxProcess::GetNs() const
{
    return pid_ != nsPid_;
}

std::string DfxProcess::GetProcessName() const
{
    return processName_;
}

std::shared_ptr<DfxElfMaps> DfxProcess::GetMaps() const
{
    return maps_;
}

std::vector<std::shared_ptr<DfxThread>> DfxProcess::GetThreads() const
{
    return threads_;
}

void DfxProcess::SetPid(pid_t pid)
{
    pid_ = pid;
}

void DfxProcess::SetUid(uid_t uid)
{
    uid_ = uid;
}

void DfxProcess::SetNsPid(pid_t pid)
{
    nsPid_ = pid;
}

pid_t DfxProcess::GetNsPid() const
{
    if (nsPid_ > 0) {
        return nsPid_;
    }
    return pid_;
}

void DfxProcess::SetProcessName(const std::string &processName)
{
    processName_ = processName;
}

void DfxProcess::SetMaps(std::shared_ptr<DfxElfMaps> maps)
{
    maps_ = maps;
}

void DfxProcess::SetThreads(const std::vector<std::shared_ptr<DfxThread>> &threads)
{
    threads_ = threads;
}

void DfxProcess::Detach()
{
    if (threads_.empty()) {
        return;
    }

    for (auto iter = threads_.begin(); iter != threads_.end(); iter++) {
        (*iter)->Detach();
    }
}

void DfxProcess::PrintProcessMapsByConfig()
{
    if (DfxConfig::GetInstance().GetDisplayMaps()) {
        if (GetMaps()) {
            DfxRingBufferWrapper::GetInstance().AppendMsg("\nMaps:\n");
        }
        auto mapsVector = maps_->GetValues();
        for (auto iter = mapsVector.begin(); iter != mapsVector.end(); iter++) {
            DfxRingBufferWrapper::GetInstance().AppendMsg((*iter)->PrintMap());
        }
    } else {
        DfxLogDebug("hidden Maps");
    }
}

void DfxProcess::PrintThreadsHeaderByConfig()
{
    if (DfxConfig::GetInstance().GetDisplayBacktrace()) {
        if (!isSignalDump_) {
            DfxRingBufferWrapper::GetInstance().AppendMsg("Other thread info:\n");
        }
    } else {
        DfxLogDebug("hidden thread info.");
    }
}
} // namespace HiviewDFX
} // namespace OHOS