src/executor/sa_dumper.cpp

/*
 * Copyright (C) 2021 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 "executor/sa_dumper.h"
#include <cstdio>
#include <thread>
#include <unistd.h>
#include "dump_utils.h"
#include "securec.h"

namespace OHOS {
namespace HiviewDFX {
namespace {
const int PIPE_LENGTH = 2;
const int PIPE_INIT = 0;
const int PIPE_READ = 0;
const int PIPE_WRITE = 1;
const int LINE_LENGTH = 256;
const int BUF_LENGTH = 1024;
const char *SEPARATOR_TEMPLATE = "\n----------------------------------%s---------------------------------\n";

using StringMatrix = std::shared_ptr<std::vector<std::vector<std::string>>>;

// UString class
class UString {
public:
    explicit UString(const std::u16string &String)
    {
        string_ = std::wstring_convert<std::codecvt_utf8<char16_t>, char16_t> {}.to_bytes(String);
    }

public:
    const char *GetString() const
    {
        return string_.c_str();
    }
    int GetInteger() const
    {
        return stoi(string_);
    }

private:
    std::string string_;
};

// MatrixWriter
class MatrixWriter {
public:
    explicit MatrixWriter(StringMatrix Data) : spData_(Data)
    {
    }

public:
    void WriteLine(const char *Line)
    {
        if (spData_) {
            std::vector<std::string> lines;
            lines.push_back(Line);
            spData_->push_back(lines);
        } else {
            printf("%s\n", Line);
        }
    }

private:
    StringMatrix spData_;
};

// PipeReader
class PipeReader {
public:
    PipeReader(int Id, StringMatrix Data) : id_(Id), spData_(Data)
    {
        fds_[PIPE_READ] = PIPE_INIT;
        fds_[PIPE_WRITE] = PIPE_INIT;
        pipe(fds_);
    }
    ~PipeReader()
    {
        if (wt_.joinable()) {
            wt_.join();
        }
    }

public:
    int GetWritePipe()
    {
        return fds_[PIPE_WRITE];
    }
    void Run()
    {
        wt_ = std::thread(Execute, id_, fds_[PIPE_READ], spData_);
    }
    void Stop()
    {
        close(fds_[PIPE_WRITE]);
    }
    static void Execute(int id, int fd, StringMatrix Data)
    {
        FILE *fp = fdopen(fd, "r");
        if (fp == nullptr) {
            return;
        }
        char buffer[BUF_LENGTH];
        while (!feof(fp)) {
            if (fgets(buffer, BUF_LENGTH - 1, fp) != nullptr) {
                MatrixWriter(Data).WriteLine(buffer);
            }
        }
        fclose(fp);
    }

private:
    int id_;
    StringMatrix spData_;
    int fds_[PIPE_LENGTH];
    std::thread wt_;
};
} // namespace

SADumper::SADumper(void)
{
}

SADumper::~SADumper(void)
{
}

DumpStatus SADumper::PreExecute(const std::shared_ptr<DumperParameter> &parameter, StringMatrix dump_datas)
{
    result_ = dump_datas;
    names_ = ptrDumpCfg_->args_->GetNameList();
    StringVector args = ptrDumpCfg_->args_->GetArgList();
    if (!args.empty() && names_.size() == 1) {
        std::transform(args.begin(), args.end(), std::back_inserter(args_), Str8ToStr16);
    }
    return DumpStatus::DUMP_OK;
}

DumpStatus SADumper::GetData(const std::string &name, const sptr<ISystemAbilityManager> &sam)
{
    int id = DumpUtils::StrToId(name);
    if (id == 0) {
        DUMPER_HILOGD(MODULE_SERVICE, "no such ability id '%{public}s'\n", name.c_str());
        return DumpStatus::DUMP_FAIL;
    }
    sptr<IRemoteObject> sa = sam->CheckSystemAbility(id);
    if (sa == nullptr) {
        DUMPER_HILOGD(MODULE_SERVICE, "no such system ability %{public}s\n", name.c_str());
        return DumpStatus::DUMP_FAIL;
    }
    char line[LINE_LENGTH] = {};
    int ret = sprintf_s(line, sizeof(line), SEPARATOR_TEMPLATE,
                    DumpUtils::ConvertSaIdToSaName(name).c_str());
    if (ret < 0) {
        DUMPER_HILOGD(MODULE_SERVICE, "print separator line fail!");
        return DumpStatus::DUMP_FAIL;
    }
    MatrixWriter(result_).WriteLine(line);
    PipeReader reader(id, result_);
    reader.Run();
    if (sa->Dump(reader.GetWritePipe(), args_) != ERR_OK) {
        DUMPER_HILOGD(MODULE_SERVICE, "system ability:%{public}s dump fail!\n", name.c_str());
    }
    reader.Stop();
    return DumpStatus::DUMP_OK;
}

DumpStatus SADumper::Execute()
{
    sptr<ISystemAbilityManager> sam = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager();
    if (sam == nullptr) {
        DUMPER_HILOGD(MODULE_SERVICE, "get samgr fail!");
        return DumpStatus::DUMP_FAIL;
    }
    if (names_.empty()) {
        U16StringVector vct = sam->ListSystemAbilities();
        std::transform(vct.begin(), vct.end(), std::back_inserter(names_), Str16ToStr8);
    }
    for (size_t i = 0; i < names_.size(); ++i) {
        if (GetData(names_[i], sam) != DumpStatus::DUMP_OK) {
            DUMPER_HILOGD(MODULE_SERVICE, "system ability:%{public}s execute fail!\n", names_[i].c_str());
        }
    }
    return DumpStatus::DUMP_OK;
}

DumpStatus SADumper::AfterExecute()
{
    return DumpStatus::DUMP_OK;
}
} // namespace HiviewDFX
} // namespace OHOS