OpenHarmony 源碼解析之DFX子系統-Hiview（上）

作者：吳文璐 2022-01-10 15:30:11

開發開發工具

DFX(Design for X)子系統是為了提升軟件質量設計的工具集，目前包含的內容主要有：DFR(Design for Reliability，可靠性)和DFT(Design for Testability，可測試性)特性。

想了解更多內容，請訪問：

51CTO和華為官方合作共建的鴻蒙技術社區

https://harmonyos.51cto.com

1 簡介

已實現以下功能：

HiLog：流水日志。
HiSysEvent：系統事件記錄接口。
HiView：插件平臺。
FaultLoggerd：應用故障訂閱和收集。
HiAppEvent: js應用事件記錄接口。

1.1 OpenHarmony架構圖

OpenHarmony 源碼解析之DFX子系統-Hiview（上）-鴻蒙HarmonyOS技術社區

1.2 Hiview簡介

Hiview是一個跨平臺的終端設備維測服務集。目前開源部分僅包含插件管理平臺和系統事件源。

Hiview架構圖如下：

Hiview由框架和插件組成，分別為：

操作系統適配層(adapter)，對使用的系統服務的接口進行適配。
Hiview基礎定義(hiview base)，包括插件基類、管道的定義，事件、事件隊列定義以及一些工具類。
Hiview的核心模塊(hiview core)，包括插件配置，插件管理以及事件源。
Hiview服務(hiview services)，目前僅包括hiview運行信息dump功能。
Hiview插件(plugins)，為獨立功能的業務模塊。
Hiview維測服務是由事件驅動的，其核心為分布在系統各處的HiSysEvent樁點。

格式化的事件通過HiSysEvent API上報至hiview進行處理，如下圖：

應用框架、系統服務使用HiSysEvent組件上報系統事件。
Hiview中SysEventSource獲取消息，解析并組裝成管道事件分發給插件處理。

1.3 Hiview代碼目錄

/base/hiviewdfx/hiview. 
├── adapter             #平臺適配 
│   ├── service        #服務適配 
│   └── system_service #系統接口適配 
├── base                #模塊定義，工具類 
│   └── utility 
├── build               #編譯腳本 
├── core                #插件管理核心代碼 
├── include             #公共定義 
├── plugins             #插件 
├── service             #HiviewService服務 
└── utility             #工具類

2 源碼分析

本文主要分析hiview插件管理平臺的初始化，和事件處理流程。

hiview是個常駐服務，在開機階段啟動。

base/hiviewdfx/hiview/service/config/hiview.cfg定義如下

{ 
    "jobs" : [{ 
            "name" : "post-fs-data", 
            "cmds" : [ 
                "mkdir /data/log/ 0770 system log", 
                "mkdir /data/log/faultlog/ 0770 system system", 
                "mkdir /data/log/faultlog/temp/ 0770 system system", 
                "mkdir /data/log/faultlog/faultlogger/ 0770 system system", 
                "start hiview" 
            ] 
        } 
    ], 
    "services" : [{ 
            "name" : "hiview", 
            "path" : ["/system/bin/hiview"], 
            "uid" : "system", 
            "gid" : ["system", "log"], 
            "writepid" : [ 
                "/dev/cpuset/system-background/tasks" 
            ], 
            "socket" : [ 
                "hisysevent dgram 0666 root system passcred" 
            ] 
        } 
    ] 
}

2.1 初始化

hiview的入口函數定義在base/hiviewdfx/hiview/main.cpp中

int main(int argc __UNUSED, char* argv[] __UNUSED) 
{ 
    auto& hiview = OHOS::HiviewDFX::HiviewPlatform::GetInstance(); 
    // process cmdline 
    hiview.ProcessArgsRequest(argc, argv); 
 
    // 初始化環境，主要解析配置文件，加載插件 
    if (!hiview.InitEnvironment()) { 
        HIVIEW_LOGW("Fail to init plugin environment. exit"); 
        return -1; 
    } 
 
    // 啟動HiviewService服務，該服務提供了hiview運行信息dump功能 
    auto hiviewService = std::make_unique<OHOS::HiviewDFX::HiviewService>(); 
    hiviewService->StartService(); 
    return 0; 
}

HiviewPlatform::InitEnvironment()函數實現如下：

bool HiviewPlatform::InitEnvironment(const std::string& defaultDir, const std::string& cloudUpdateDir, 
                                     const std::string& workDir, const std::string& persistDir) 
{ 
    // 創建工作目錄，目前目錄名使用了默認的空字符串，所以并未實際創建工作目錄 
    ValidateAndCreateDirectories(defaultDir, cloudUpdateDir, workDir, persistDir); 
 
    // update beta config 
    UpdateBetaConfigIfNeed(); 
 
    // check whether hiview is already started 
    ExitHiviewIfNeed(); 
 
    // 解析"/system/etc/hiview/plugin_config"插件配置文件 
    std::string cfgPath = GetPluginConfigPath(); 
    PluginConfig config(cfgPath); 
    if (!config.StartParse()) { //...........注[1] 
        HIVIEW_LOGE("Fail to parse plugin config. exit!"); 
        return false; 
    } 
    // 啟動插件管理平臺消息隊列 
    StartPlatformDispatchQueue(); 
 
    // init global context helper, remove in the future 
    HiviewGlobal::CreateInstance(static_cast<HiviewContext&>(*this)); 
    //加載插件 
    LoadBusinessPlugin(config); 
 
    isReady_ = true; 
    NotifyPluginReady(); 
    return true; 
}

注[1]處PluginConfig::StartParse()函數會按照特定規則去解析插件配置文件:

if (field == "plugins") { 
       ParsePlugin(strTmp); 
   } else if (field == "pipelines") { 
       ParsePipeline(strTmp); 
   } else if (field == "pipelinegroups") { 
       ParsePipelineGroup(strTmp); 
   }

目前使用的插件配置文件/system/etc/hiview/plugin_config內容如下：

plugins:3 
SysEventSource[thread:sysevent_source]:0 static 
Faultlogger[]:0 static 
SysEventService[thread:sysevent_service]:0 static 
pipelines:1 
SysEventPipeline:SysEventService Faultlogger 
pipelinegroups:1 
SysEventSource:SysEventPipeline

注：base/hiviewdfx/hiview/plugins 下有eventlogger eventservice faultlogger freeze_detector hicollie_collector五個插件目錄，而目前插件配置文件里實際只用到了Faultlogger和SysEventService。

PluginConfig::StartParse()解析完之后會把相關信息保存到列表中。類圖如下：

PluginConfig::ParsePipelineGroup()代碼如下

void PluginConfig::ParsePipelineGroup(const std::string& pipelineGroup) 
{ 
    std::smatch result; 
    // EventSourceExample:FromTwo2Three FromThree2Two 
    if (!regex_search(pipelineGroup, result, std::regex("(\\S+)\\s*:(.+)"))) { 
        HIVIEW_LOGW("Fail to match pipeline group expression."); 
        return; 
    } 
 
    const int pipelineGroupNameField = 1; 
    const int pipelineNameListField = 2; 
    std::string eventSourceName = StringUtil::TrimStr(result.str(pipelineGroupNameField)); 
    auto ret = std::find_if(pluginInfoList_.begin(), pluginInfoList_.end(), [&](PluginInfo& info) { 
        if (info.name == eventSourceName) { 
            info.isEventSource = true; 
            info.pipelineNameList = StringUtil::SplitStr(result.str(pipelineNameListField)); 
            return true; 
        } 
        return false; 
    }); 
    if (ret != std::end(pluginInfoList_)) { 
        HIVIEW_LOGD("%s is an event source.", eventSourceName.c_str()); 
    } 
}

說明：

在解析pipelinegroups時，如果發現pipelineGroupName和pluginInfoList中某個插件的name一致，則把該插件PluginInfo.isEventSource置為true并且把pipelineNameList賦值給PluginInfo.pipelineNameList。
結合/system/etc/hiview/plugin_config配置文件，可以看到SysEventSource插件是帶管道(SysEventPipeline)的，插件SysEventService和Faultlogger隸屬于管道SysEventPipeline,用于處理SysEventSource扔給管道的事件。

解析完插件配置信息之后會調用HiviewPlatform::LoadBusinessPlugin(const PluginConfig& config)去裝載插件和管道。

代碼如下

void HiviewPlatform::LoadBusinessPlugin(const PluginConfig& config) 
{ 
    // start to load plugin 
    // 1. 遍歷pluginInfoList，根據插件名創建插件。因為目前配置的插件加載延時(loadDelay)為0，所以直接走[2]，調用CreatePlugin()創建插件并添加到pluginMap_中。 
    auto const& pluginInfoList = config.GetPluginInfoList(); 
    for (auto const& pluginInfo : pluginInfoList) { 
        HIVIEW_LOGI("Start to create plugin %{public}s delay:%{public}d", pluginInfo.name.c_str(), 
                    pluginInfo.loadDelay); 
        if (pluginInfo.loadDelay > 0) { //.............[1] 
            auto task = std::bind(&HiviewPlatform::ScheduleCreateAndInitPlugin, this, pluginInfo); 
            sharedWorkLoop_->AddTimerEvent(nullptr, nullptr, task, pluginInfo.loadDelay, false); 
        } else {       //...............[2] 
            CreatePlugin(pluginInfo); 
        } 
    } 
    // 2. 遍歷pipelineInfoList,調用CreatePipeline()創建管道并添加到pipelines_中。 
    auto const& pipelineInfoList = config.GetPipelineInfoList(); 
    for (auto const& pipelineInfo : pipelineInfoList) { 
        HIVIEW_LOGI("Start to create pipeline %{public}s", pipelineInfo.name.c_str()); 
        CreatePipeline(pipelineInfo); 
    } 
 
    // 3. 遍歷pluginInfoList，調用InitPlugin()初始化插件 
    for (auto const& pluginInfo : pluginInfoList) { 
        HIVIEW_LOGI("Start to Load plugin %{public}s", pluginInfo.name.c_str()); 
        InitPlugin(config, pluginInfo); //............注[1] 
    } 
 
    CleanupUnusedResources(); 
}

說明：

注[1]InitPlugin()這一步中，如果插件的workHandlerType為thread，則綁定工作線程EventLoop。如果插件是EventSource類型,則綁定管道Pipeline，并且調用StartEventSource開啟消息監聽。代碼如下：

void HiviewPlatform::InitPlugin(const PluginConfig& config __UNUSED, const PluginConfig::PluginInfo& pluginInfo) 
{ 
    auto& plugin = pluginMap_[pluginInfo.name]; 
    if (plugin == nullptr) { 
        return; 
    } 
    // 如果插件的workHandlerType為thread，則綁定工作線程EventLoop。 
    if (pluginInfo.workHandlerType == "thread") { 
        auto workLoop = GetAvaliableWorkLoop(pluginInfo.workHandlerName); 
        plugin->BindWorkLoop(workLoop); 
    } 
 
    auto begin = TimeUtil::GenerateTimestamp(); 
    plugin->OnLoad(); 
    // 如果插件是EventSource類型,則添加管道Pipeline，并且調用StartEventSource開啟消息監聽 
    if (pluginInfo.isEventSource) { 
        auto sharedSource = std::static_pointer_cast<EventSource>(plugin); 
        if (sharedSource == nullptr) { 
            HIVIEW_LOGE("Fail to cast plugin to event source!"); 
            return; 
        } 
        for (auto& pipelineName : pluginInfo.pipelineNameList) { 
            sharedSource->AddPipeline(pipelines_[pipelineName]); 
        } 
        StartEventSource(sharedSource); 
    } 
    auto end = TimeUtil::GenerateTimestamp(); 
    HIVIEW_LOGI("Plugin %{public}s loadtime:%{public}" PRIu64 ".", pluginInfo.name.c_str(), end - begin); 
}

至此，插件管理平臺初始化工作已完成。

2.2 事件處理流程

結合插件配置文件，目前實際使用的插件類圖如下：

說明：

前文最后的代碼段提到，如果插件是EventSource類型,則綁定管道，并且調用StartEventSource開啟消息監聽。結合類圖，只有SysEventSource是EventSource類型的插件,所以只有SysEventSource持有管道。
EventSource類型的插件會監聽HiSysEvent接口發來的消息，解析并組裝成管道事件，分發給管道中的插件處理。

SysEventSource::StartEventSource()函數實現如下。

void SysEventSource::StartEventSource() 
{ 
    HIVIEW_LOGI("SysEventSource start"); 
    std::shared_ptr<EventReceiver> sysEventReceiver = std::make_shared<SysEventReceiver>(*this); 
    eventServer.AddReceiver(sysEventReceiver); 
 
    eventServer.Start(); 
}

SysEventSource有個成員變量eventServer，EventServer會開啟socketserver端用于接收HiSysEvent接口發來的socket消息。

類圖如下:

說明：

1.SysEventSource::StartEventSource()中把SysEventReceiver對象加入到EventServer的receivers_容器中。

2.EventServer收到socket消息之后，調用SysEventReceiver::HandlerEvent(const std::string& rawMsg)方法處理接收到的消息。

3.SysEventReceiver::HandlerEvent()方法中會調用SysEventParser::Parser(const std::string& rawMsg)方法解析消息并組裝成SysEvent對象，然后調用EventSource::PublishPipelineEvent(std::shared_ptr event)方法把管道事件發布出去。

EventSource::PublishPipelineEvent()代碼如下：

bool EventSource::PublishPipelineEvent(std::shared_ptr<PipelineEvent> event) 
{ 
    HIVIEW_LOGD("EventSource PublishPipelineEvent"); 
    if (event == nullptr) { 
        return false; 
    } 
 
    if (Audit::IsEnabled()) { 
        auto digest = GetPluginInfo() + Audit::DOMAIN_DELIMITER + event->GetEventInfo(); 
        Audit::WriteAuditEvent(Audit::StatsEvent::PIPELINE_EVENT_CREATE, event->createTime_, digest); 
    } 
 
    for (auto& pipeline : listeners_) { 
        if ((pipeline != nullptr) && (pipeline->CanProcessEvent(event))) { 
            // one event can only be processed by one pipeline 
            pipeline->ProcessEvent(event); 
            return true; 
        } 
    } 
    return false; 
}

結合上面的類圖，EventSource持有管道列表對象listeners_，EventSource::PublishPipelineEvent()函數中會遍歷該列表，調用Pipeline::ProcessEvent(std::shared_ptr event)函數去處理管道事件。(Pipeline對象是在HiviewPlatform::InitPlugin()函數中被加入到EventSource.listeners_中的。)

Pipeline類型有個成員變量std::list

在插件平臺初始化的時候，HiviewPlatform::CreatePipeline()函數中已經把Plugin插件對象加入到了processors_列表中。

接下來分析Pipeline::ProcessEvent()函數做了什么。

void Pipeline::ProcessEvent(std::shared_ptr<PipelineEvent> event) 
{ 
    event->SetPipelineInfo(name_, processors_); 
    event->OnContinue(); 
}

把Pipeline的processors_對象賦給了PipelineEvent的processors_對象，然后調用

PipelineEvent::OnContinue()函數。

接下來分析PipelineEvent::OnContinue()函數：

bool PipelineEvent::OnContinue() 
{ 
    // 判斷hasFinish_標志位和processors_列表是否已經為空，如已為空，結束本次事件傳遞 
    if ((!hasFinish_) && processors_.empty()) { 
        return OnFinish(); 
    } 
 
    // once the event start delivering 
    // the call OnContinue means one has done the processing of the event 
    // this may be called by upstream event processor or the framework 
    if (Audit::IsEnabled() && startDeliver_) { 
        Audit::WriteAuditEvent(Audit::StatsEvent::PIPELINE_EVENT_HANDLE_OUT, 
            createTime_, std::to_string(Thread::GetTid())); 
    } 
 
    // the framework will call OnContinue when the event is assigned to a pipeline 
    if (!startDeliver_) { 
        startDeliver_ = true; 
    } 
 
    // 取出processors_列表中第一個Plugin元素，并從列表彈出 
    std::weak_ptr<Plugin> plugin = processors_.front(); 
    processors_.pop_front(); 
    if (auto pluginPtr = plugin.lock()) { 
        if (!pluginPtr->CanProcessMoreEvents()) { 
            handler_->PauseDispatch(plugin); 
        } 
 
        if (Audit::IsEnabled()) { 
            Audit::WriteAuditEvent(Audit::StatsEvent::PIPELINE_EVENT_HANDLE_IN, createTime_, 
                                   pluginPtr->GetHandlerInfo()); 
        } 
        // 判斷當前Plugin是否開啟了事件工作隊列，如有則加入事件隊列處理，如沒有直接調用OnEventProxy 
        if (auto workLoop = pluginPtr->GetWorkLoop()) { 
            workLoop->AddEvent(pluginPtr, shared_from_this()); //............[1] 
        } else { 
            pluginPtr->OnEventProxy(shared_from_this()); //..........[2] 
        } 
    } else { 
        return OnContinue(); 
    } 
    return true; 
}

不管插件是否使用了事件隊列，最終都會調用到Plugin::OnEventProxy()函數來處理管道事件。

Plugin::OnEventProxy()函數實現如下：

bool Plugin::OnEventProxy(std::shared_ptr<Event> event) 
{ 
    if (event == nullptr) { 
 
        return false; 
    } 
 
    std::shared_ptr<Event> dupEvent = event; 
    auto processorSize = dupEvent->GetPendingProcessorSize(); 
    dupEvent->ResetPendingStatus(); 
    bool ret = OnEvent(dupEvent); //..............注[1] 
 
    if (!dupEvent->IsPipelineEvent()) { 
        if (Audit::IsEnabled()) { 
            Audit::WriteAuditEvent(Audit::StatsEvent::QUEUE_EVENT_OUT, dupEvent->createTime_, 
                std::to_string(Thread::GetTid())); 
        } 
    } else { 
        if ((!dupEvent->HasFinish() && !dupEvent->HasPending()) && 
            (processorSize == dupEvent->GetPendingProcessorSize())) { 
            dupEvent->OnContinue();//.............注[2] 
        } 
    } 
    return ret; 
}

先調用注[1]OnEvent()函數處理事件，再判斷管道事件傳遞是否已結束，如未結束則調用注[2]PipelineEvent::OnContinue()函數繼續把管道事件傳遞給后面的

插件處理。

結合目前的插件配置文件，整個插件管理平臺的消息處理流程大致如下：

EventServer接收到HiSysEvent組件接口發來的消息 --> SysEventReceiver::HandlerEvent() --> SysEventParser::Parser() --> EventSource::PublishPipelineEvent() --> Pipeline::ProcessEvent() --> PipelineEvent::OnContinue() --> SysEventService::OnEventProxy --> SysEventService::OnEvent --> PipelineEvent::OnContinue() --> Faultlogger::OnEventProxy --> Faultlogger::OnEvent --> 結束

至此，事件處理流程已分析完。

3 總結

以上內容首先分析了hiview插件管理平臺的初始化，然后對事件的處理流程做了分析。后續會詳細講解base/hiviewdfx/hiview/plugins目錄下每個插件的源碼。

想了解更多內容，請訪問：

51CTO和華為官方合作共建的鴻蒙技術社區

https://harmonyos.51cto.com

責任編輯：jianghua 來源：鴻蒙社區

鴻蒙 HarmonyOS 應用