toolchain/inspector/connect_inspector.cpp

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

#include <mutex>

#include "common/log_wrapper.h"
#include "tooling/dynamic/base/pt_json.h"
#include "ws_server.h"

namespace OHOS::ArkCompiler::Toolchain {
using panda::ecmascript::tooling::PtJson;
using panda::ecmascript::tooling::Result;
std::mutex g_connectMutex;
std::unique_ptr<ConnectInspector> g_inspector = nullptr;
static constexpr char CONNECTED_MESSAGE[] = "connected";
static constexpr char REQUEST_MESSAGE[] = "tree";
static constexpr char STOPDEBUGGER_MESSAGE[] = "stopDebugger";
static constexpr char OPEN_ARKUI_STATE_PROFILER[] = "ArkUIStateProfilerOpen";
static constexpr char CLOSE_ARKUI_STATE_PROFILER[] = "ArkUIStateProfilerClose";
static constexpr char START_RECORD_MESSAGE[] = "rsNodeStartRecord";
static constexpr char STOP_RECORD_MESSAGE[] = "rsNodeStopRecord";
std::function<void(bool)> g_setConnectCallBack;

void* HandleDebugManager(void* const server)
{
    if (server == nullptr) {
        LOGE("HandleDebugManager server nullptr");
        return nullptr;
    }
#if defined(IOS_PLATFORM) || defined(MAC_PLATFORM)
    pthread_setname_np("OS_DbgConThread");
#else
    pthread_setname_np(pthread_self(), "OS_DbgConThread");
#endif

    static_cast<ConnectServer*>(server)->RunServer();
    return nullptr;
}

void OnConnectedMessage(const std::string& message)
{
    if (message.find(CONNECTED_MESSAGE, 0) != std::string::npos) {
        g_inspector->waitingForDebugger_ = false;
        if (g_setConnectCallBack != nullptr) {
            g_setConnectCallBack(true);
        }
        for (auto& info : g_inspector->infoBuffer_) {
            g_inspector->connectServer_->SendMessage(info.second);
        }
    }
}

void OnInspectorRecordMessage(const std::string& message)
{
    if (message.find(START_RECORD_MESSAGE, 0) != std::string::npos) {
        if (g_inspector->startRecord_ != nullptr && !g_inspector->isRecording_) {
            LOGI("record start");
            g_inspector->startRecord_();
            g_inspector->isRecording_ = true;
        }
    }

    if (message.find(STOP_RECORD_MESSAGE, 0) != std::string::npos) {
        if (g_inspector->stopRecord_ != nullptr && g_inspector->isRecording_) {
            LOGI("record stop");
            g_inspector->stopRecord_();
            g_inspector->isRecording_ = false;
        }
    }
}

bool OnArkUIInspectorMessage(const std::string &message)
{
    ConnectRequest request(message);
    if (!request.IsValid()) {
        return false;
    }
    std::string domain = request.GetDomain();
    if (domain == "ArkUI") {
        if (g_inspector->arkUICallback_ != nullptr) {
            LOGI("OnArkUIInspectorMessage, arkUICallback_ called");
            g_inspector->arkUICallback_(message.c_str());
        } else {
            LOGE("OnArkUIInspectorMessage, arkUICallback_ is nullptr");
        }
        return true;
    } else if (domain == "WMS") {
        if (g_inspector->wMSCallback_ != nullptr) {
            LOGI("OnArkUIInspectorMessage, wMSCallback_ called");
            g_inspector->wMSCallback_(message.c_str());
        } else {
            LOGE("OnArkUIInspectorMessage, wMSCallback_ is nullptr");
        }
        return true;
    } else {
        LOGW("OnArkUIInspectorMessage, unknown request");
    }
    return false;
}

bool OnCangjieInspectorMessage(const std::string &message)
{
    if (message.find("cangjie profiler") != std::string::npos) {
        if (g_inspector->cangjieCallback_ != nullptr) {
            LOGI("OnCangjieInspectorMessage, cangjieCallback_ called");
            g_inspector->cangjieCallback_(message, SendMessage);
        } else {
            LOGE("OnCangjieInspectorMessage, cangjieCallback_ is nullptr");
        }
        return true;
    } else {
        LOGW("OnCangjieInspectorMessage. unknown request");
    }
    return false;
}

void OnMessage(const std::string &message)
{
    std::lock_guard<std::mutex> lock(g_connectMutex);
    if (message.empty()) {
        LOGE("message is empty");
        return;
    }

    LOGI("ConnectServer OnMessage: %{public}s", message.c_str());
    if (g_inspector != nullptr && g_inspector->connectServer_ != nullptr) {
        OnConnectedMessage(message);
        if (OnArkUIInspectorMessage(message)) {
            return;
        }
        if (OnCangjieInspectorMessage(message)) {
            return;
        }
        if (message.find(OPEN_ARKUI_STATE_PROFILER, 0) != std::string::npos) {
            if (g_inspector->setArkUIStateProfilerStatus_ != nullptr) {
                LOGI("state profiler open");
                g_inspector->setArkUIStateProfilerStatus_(true);
            }
        }
        if (message.find(CLOSE_ARKUI_STATE_PROFILER, 0) != std::string::npos) {
            if (g_inspector->setArkUIStateProfilerStatus_ != nullptr) {
                LOGI("state profiler close");
                g_inspector->setArkUIStateProfilerStatus_(false);
            }
        }
        if (message.find(REQUEST_MESSAGE, 0) != std::string::npos) {
            if (g_inspector->createLayoutInfo_ != nullptr) {
                LOGI("tree start");
                g_inspector->createLayoutInfo_(g_inspector->instanceId_);
            }
        }
        if (message.find(STOPDEBUGGER_MESSAGE, 0) != std::string::npos) {
            g_inspector->waitingForDebugger_ = true;
            if (g_inspector->setDebugMode_ != nullptr) {
                LOGI("stopDebugger start");
                g_inspector->setDebugMode_();
            }
            if (g_setConnectCallBack != nullptr) {
                g_setConnectCallBack(false);
            }
        }
        OnInspectorRecordMessage(message);
    }
}

void SetSwitchCallBack(const std::function<void(int32_t)>& createLayoutInfo, int32_t instanceId)
{
    std::lock_guard<std::mutex> lock(g_connectMutex);
    if (g_inspector == nullptr) {
        g_inspector = std::make_unique<ConnectInspector>();
    }
    g_inspector->createLayoutInfo_ = createLayoutInfo;
    g_inspector->instanceId_ = instanceId;
}

void SetConnectCallback(const std::function<void(bool)>& callback)
{
    g_setConnectCallBack = callback;
}

// stop debugger but the application continues to run
void SetDebugModeCallBack(const std::function<void()>& setDebugMode)
{
    std::lock_guard<std::mutex> lock(g_connectMutex);
    if (g_inspector != nullptr) {
        g_inspector->setDebugMode_ = setDebugMode;
    }
}

void ResetService()
{
    if (g_inspector != nullptr && g_inspector->connectServer_ != nullptr) {
        g_inspector->connectServer_->StopServer();
        g_inspector->connectServer_.reset();
    }
}

bool StartServerForSocketPair(int socketfd)
{
    LOGI("StartServerForSocketPair, socketfd = %{private}d", socketfd);
    if (g_inspector == nullptr) {
        g_inspector = std::make_unique<ConnectInspector>();
    }
    if (g_inspector->connectServer_ != nullptr) {
        LOGW("ConnectServer is not nullptr!");
        return true;
    }
    g_inspector->connectServer_ = std::make_unique<ConnectServer>(socketfd,
        std::bind(&OnMessage, std::placeholders::_1));

    pthread_t tid;
    if (pthread_create(&tid, nullptr, &HandleDebugManager,
        static_cast<void*>(g_inspector->connectServer_.get())) != 0) {
        LOGE("pthread_create fail!");
        ResetService();
        return false;
    }
    return true;
}

void StartServer(const std::string& componentName)
{
    LOGI("StartServer, componentName = %{private}s", componentName.c_str());
    g_inspector = std::make_unique<ConnectInspector>();
#ifdef PANDA_TARGET_ARM32
    g_inspector->connectServer_ = std::make_unique<ConnectServer>(componentName,
        std::bind(&OnMessage, std::placeholders::_1));

    pthread_t tid;
    if (pthread_create(&tid, nullptr, &HandleDebugManager,
        static_cast<void*>(g_inspector->connectServer_.get())) != 0) {
        LOGE("pthread_create fail!");
        ResetService();
        return;
    }
#endif
}

void StopServer([[maybe_unused]] const std::string& componentName)
{
    LOGI("StopServer, componentName = %{private}s", componentName.c_str());
    ResetService();
}

void StoreMessage(int32_t instanceId, const std::string& message)
{
    std::lock_guard<std::mutex> lock(g_connectMutex);
    if (g_inspector == nullptr) {
        g_inspector = std::make_unique<ConnectInspector>();
    }
    if (g_inspector->infoBuffer_.count(instanceId) == 1) {
        LOGE("The message with the current instance id has existed.");
        return;
    }
    g_inspector->infoBuffer_[instanceId] = message;
}

void RemoveMessage(int32_t instanceId)
{
    std::lock_guard<std::mutex> lock(g_connectMutex);
    if (g_inspector == nullptr) {
        return;
    }
    if (g_inspector->infoBuffer_.count(instanceId) != 1) {
        LOGE("The message with the current instance id does not exist.");
        return;
    }
    g_inspector->infoBuffer_.erase(instanceId);
}

void SendMessage(const std::string& message)
{
    if (g_inspector != nullptr && g_inspector->connectServer_ != nullptr && !g_inspector->waitingForDebugger_) {
        g_inspector->connectServer_->SendMessage(message);
    }
}

bool WaitForConnection()
{
    if (g_inspector == nullptr) {
        return true;
    }
    return g_inspector->waitingForDebugger_;
}

void SetProfilerCallback(const std::function<void(bool)> &setArkUIStateProfilerStatus)
{
    std::lock_guard<std::mutex> lock(g_connectMutex);
    if (g_inspector == nullptr) {
        g_inspector = std::make_unique<ConnectInspector>();
    }
    g_inspector->setArkUIStateProfilerStatus_ = setArkUIStateProfilerStatus;
}

void SetRecordCallback(const std::function<void(void)> &startRecordFunc,
    const std::function<void(void)> &stopRecordFunc)
{
    std::lock_guard<std::mutex> lock(g_connectMutex);
    if (g_inspector == nullptr) {
        g_inspector = std::make_unique<ConnectInspector>();
    }
    g_inspector->startRecord_ = startRecordFunc;
    g_inspector->stopRecord_ = stopRecordFunc;
}

void SetArkUICallback(const std::function<void(const char *)> &arkUICallback)
{
    std::lock_guard<std::mutex> lock(g_connectMutex);
    if (g_inspector == nullptr) {
        g_inspector = std::make_unique<ConnectInspector>();
    }
    g_inspector->arkUICallback_ = arkUICallback;
}

void SetWMSCallback(const std::function<void(const char *)> &wMSCallback)
{
    std::lock_guard<std::mutex> lock(g_connectMutex);
    if (g_inspector == nullptr) {
        g_inspector = std::make_unique<ConnectInspector>();
    }
    g_inspector->wMSCallback_ = wMSCallback;
}

void SetCangjieCallback(CJCallback &cangjieCallback)
{
    std::lock_guard<std::mutex> lock(g_connectMutex);
    if (g_inspector == nullptr) {
        g_inspector = std::make_unique<ConnectInspector>();
    }
    g_inspector->cangjieCallback_ = cangjieCallback;
}

ConnectRequest::ConnectRequest(const std::string &message)
{
    std::unique_ptr<PtJson> json = PtJson::Parse(message);
    if (json == nullptr) {
        LOGE("ConnectRequest, json == nullptr");
        return;
    }
    if (!json->IsObject()) {
        LOGE("ConnectRequest, json is not object");
        json->ReleaseRoot();
        return;
    }

    Result ret;
    std::string wholeMethod;
    ret = json->GetString("method", &wholeMethod);
    if (ret != Result::SUCCESS || wholeMethod.empty()) {
        LOGW("ConnectRequest, parse method error");
        json->ReleaseRoot();
        return;
    }
    std::string::size_type length = wholeMethod.length();
    std::string::size_type indexPoint = wholeMethod.find_first_of('.', 0);
    if (indexPoint == std::string::npos || indexPoint == 0 || indexPoint == length - 1) {
        LOGW("ConnectRequest, method format error, msg = %{public}s", wholeMethod.c_str());
        json->ReleaseRoot();
        return;
    }
    domain_ = wholeMethod.substr(0, indexPoint);
    isSuccess_ = true;
    json->ReleaseRoot();
}
} // OHOS::ArkCompiler::Toolchain