hiviewdfx_hiview/base/plugin_proxy.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 "plugin_proxy.h"

#include "hiview_logger.h"

namespace OHOS {
namespace HiviewDFX {
DEFINE_LOG_TAG("HiView-PluginProxy");
bool PluginProxy::OnEvent(std::shared_ptr<Event>& event)
{
    HIVIEW_LOGD("called!");
    std::lock_guard<std::mutex> lock(lock_);
    if (LoadPluginIfNeed()) {
        HIVIEW_LOGD("Plugin name: %{public}s plugin_->OnEvent", plugin_->GetName().c_str());
        return plugin_->OnEvent(event);
    }
    return false;
}

bool PluginProxy::CanProcessEvent(std::shared_ptr<Event> event)
{
    HIVIEW_LOGD("called!");
    std::lock_guard<std::mutex> lock(lock_);
    if (LoadPluginIfNeed()) {
        HIVIEW_LOGD("Plugin name: %{public}s plugin_->CanProcessEvent", plugin_->GetName().c_str());
        return plugin_->CanProcessEvent(event);
    }
    return false;
}

bool PluginProxy::CanProcessMoreEvents()
{
    HIVIEW_LOGD("called!");
    std::lock_guard<std::mutex> lock(lock_);
    if (LoadPluginIfNeed()) {
        HIVIEW_LOGD("Plugin name: %{public}s plugin_->CanProcessMoreEvents", plugin_->GetName().c_str());
        return plugin_->CanProcessMoreEvents();
    }
    return false;
}

std::string PluginProxy::GetHandlerInfo()
{
    HIVIEW_LOGD("called!");
    std::lock_guard<std::mutex> lock(lock_);
    if (plugin_ != nullptr) {
        HIVIEW_LOGD("Plugin name: %{public}s plugin_->GetHandlerInfo", plugin_->GetName().c_str());
        plugin_->UpdateActiveTime();
        return plugin_->GetHandlerInfo();
    }
    return Plugin::GetHandlerInfo();
}

void PluginProxy::Dump(int fd, const std::vector<std::string>& cmds)
{
    std::lock_guard<std::mutex> lock(lock_);
    if (plugin_ != nullptr) {
        return plugin_->Dump(fd, cmds);
    }
}

void PluginProxy::OnEventListeningCallback(const Event &msg)
{
    HIVIEW_LOGD("called!");
    std::lock_guard<std::mutex> lock(lock_);
    if (LoadPluginIfNeed()) {
        HIVIEW_LOGD("Plugin name: %{public}s plugin_->OnEventListeningCallback", plugin_->GetName().c_str());
        plugin_->OnEventListeningCallback(msg);
    }
}

bool PluginProxy::LoadPluginIfNeed()
{
    if (plugin_ != nullptr) {
        plugin_->UpdateActiveTime();
        return true;
    }

    if (plugin_ == nullptr && GetHiviewContext() != nullptr) {
        plugin_ = GetHiviewContext()->InstancePluginByProxy(shared_from_this());
    }

    if (plugin_ == nullptr) {
        // log failure
        HIVIEW_LOGE("Failed to instaniate plugin with name :%{public}s", name_.c_str());
        return false;
    }

    plugin_->UpdateActiveTime();
    return true;
}

void PluginProxy::DestroyInstanceIfNeed(time_t maxIdleTime)
{
    std::lock_guard<std::mutex> lock(lock_);
    time_t now = time(nullptr);
    if (plugin_ == nullptr) {
        return;
    }

    if (plugin_->GetUseCount() > 0) {
        plugin_->UpdateActiveTime();
        return;
    }

    if (now - plugin_->GetLastActiveTime() >= maxIdleTime) {
        auto count = plugin_.use_count();
        if (count > 1) {
            HIVIEW_LOGW("Plugin %{public}s has more refs(%{public}ld), may caused by unfinished task. unload failed.",
                plugin_->GetName().c_str(), count);
            return;
        }
        HIVIEW_LOGI("plugin(%{public}s) reach max idle time, unload.", name_.c_str());
        plugin_->OnUnload();
        plugin_ = nullptr;
    }
}
} // namespace HiviewDFX
} // namespace OHOS