1 /* 2 * Copyright (c) 2024 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 #ifndef EVT_PARSER_H 16 #define EVT_PARSER_H 17 18 #include "XperfEvt.h" 19 #include "plugin.h" 20 #include "sys_event.h" 21 22 namespace OHOS { 23 namespace HiviewDFX { 24 const std::string KEY_PNAME = "PROCESS_NAME"; 25 const std::string KEY_MESSAGE = "MSG"; 26 const std::string KEY_PID = "PID"; 27 const std::string KEY_UID = "UID"; 28 const std::string KEY_APP_PID = "APP_PID"; 29 const std::string KEY_APP_VERSION = "VERSION_NAME"; 30 const std::string KEY_ABILITY_NAME = "ABILITY_NAME"; 31 const std::string KEY_BUNDLE_NAME = "BUNDLE_NAME"; 32 const std::string KEY_ABILITY_TYPE = "ABILITY_TYPE"; 33 34 const std::string START_ABILITY = "START_ABILITY"; 35 const std::string APP_ATTACH = "APP_ATTACH"; 36 const std::string ABILITY_ONFOREGROUND = "ABILITY_ONFOREGROUND"; 37 const std::string APP_FOREGROUND = "APP_FOREGROUND"; 38 const std::string APP_BACKGROUND = "APP_BACKGROUND"; 39 const std::string APP_TERMINATE = "APP_TERMINATE"; 40 const std::string JANK_FRAME_SKIP = "JANK_FRAME_SKIP"; 41 const std::string ABILITY_ONBACKGROUND = "ABILITY_ONBACKGROUND"; 42 const std::string RS_COMPOSITION_TIMEOUT = "RS_COMPOSITION_TIMEOUT"; 43 const std::string ABILITY_ONACTIVE = "ABILITY_ONACTIVE"; 44 const std::string KERNEL_AWAKE = "KERNEL_AWAKE"; 45 const std::string SCREENON_EVENT = "SCREENON_EVENT"; 46 const std::string LCD_POWER_ON = "LCD_POWER_ON"; 47 const std::string LCD_BACKLIGHT_ON = "LCD_BACKLIGHT_ON"; 48 const std::string KEY_STARTUP_TIME = "STARTUP_TIME"; 49 50 const std::string KEY_VERSION_CODE = "VERSION_CODE"; 51 const std::string KEY_SOURCE_TYPE = "SOURCE_TYPE"; 52 const std::string PAGE_URL = "PAGE_URL"; 53 const std::string SCENE_ID = "SCENE_ID"; 54 const std::string INPUT_TIME = "INPUT_TIME"; 55 const std::string ANIMATION_START_TIME = "ANIMATION_START_TIME"; 56 const std::string RENDER_TIME = "RENDER_TIME"; 57 const std::string RESPONSE_LATENCY = "RESPONSE_LATENCY"; 58 const std::string TIMER = "time_"; 59 const std::string ANIMATION_END_LATENCY = "ANIMATION_END_LATENCY"; 60 const std::string E2E_LATENCY = "E2E_LATENCY"; 61 62 // for boot 63 const std::string REASON = "REASON"; 64 const std::string ISFIRST = "ISFIRST"; 65 const std::string DETAILED_TIME = "DETAILED_TIME"; 66 const std::string TOTAL_TIME = "TOTAL_TIME"; 67 68 //for app startup 69 const std::string KEY_BUNDLE_TYPE = "BUNDLE_TYPE"; 70 const std::string KEY_MODULE_NAME = "MODULE_NAME"; 71 const std::string KEY_STARTUP_ABILITY_TYPE = "STARTUP_ABILITY_TYPE"; 72 const std::string KEY_STARTUP_EXTENSION_TYPE = "STARTUP_EXTENSION_TYPE"; 73 const std::string KEY_CALLER_BUNDLE_NAME = "CALLER_BUNDLE_NAME"; 74 const std::string KEY_CALLER_UID = "CALLER_UID"; 75 const std::string KEY_CALLER_PROCESS_NAME = "CALLER_PROCESS_NAME"; 76 const std::string KEY_WINDOW_NAME = "WINDOW_NAME"; 77 const std::string KEY_ANIMATION_START_LATENCY = "ANIMATION_START_LATENCY"; 78 const std::string KEY_E2E_LATENCY = "ANIMATION_E2E_LATENCY"; 79 const std::string KEY_START_TYPE = "START_TYPE"; 80 const std::string KEY_APP_UID = "APP_UID"; 81 82 // for app associated start 83 const std::string KEY_CALLEE_PROCESS_NAME = "CALLEE_PROCESS_NAME"; 84 const std::string KEY_CALLEE_BUNDLE_NAME = "CALLEE_BUNDLE_NAME"; 85 86 // animator jank frame 87 const std::string UNIQUE_ID = "UNIQUE_ID"; 88 const std::string STARTTIME = "STARTTIME"; 89 const std::string DURITION = "DURITION"; 90 const std::string TOTAL_FRAMES = "TOTAL_FRAMES"; 91 const std::string TOTAL_MISSED_FRAMES = "TOTAL_MISSED_FRAMES"; 92 const std::string MAX_SEQ_MISSED_FRAMES = "MAX_SEQ_MISSED_FRAMES"; 93 const std::string MAX_FRAMETIME = "MAX_FRAMETIME"; 94 const std::string AVERAGE_FRAMETIME = "AVERAGE_FRAMETIME"; 95 const std::string IS_FOLD_DISP = "IS_FOLD_DISP"; 96 const std::string IS_DISPLAY_ANIMATOR = "DISPLAY_ANIMATOR"; 97 // for screen switch 98 const std::string KEY_SCREEN_ID = "SCREEN_ID"; 99 const std::string KEY_SCENE_PANEL_NAME = "SCENE_PANEL_NAME"; 100 const std::string KEY_ROTATION_START_TIME = "ROTATION_START_TIME"; 101 const std::string KEY_ROTATION_DURATION = "ROTATION_DURATION"; 102 //for app exit 103 const std::string KEY_EXIT_TIME = "EXIT_TIME"; 104 const std::string KEY_EXIT_RESULT = "EXIT_RESULT"; 105 const std::string KEY_EXIT_PID = "EXIT_PID"; 106 const std::string KEY_NOTE = "NOTE"; 107 108 // for power on 109 const std::string POWER_STATE = "STATE"; 110 111 // for screen unlock 112 const std::string KEY_PACKAGE_NAME = "PACKAGE_NAME"; 113 const std::string KEY_VERIFYSUCESS = "VERIFYSUCESS"; 114 const std::string KEY_VERIFY_COSTTIME = "VERIFY_COSTTIME"; 115 116 // for for PC quick wake 117 const std::string KEY_KERNEL_START_TIME = "KERNEL_START_TIME"; 118 const std::string KEY_KERNEL_END_TIME = "KERNEL_END_TIME"; 119 const std::string KEY_ANIM_BEGIN_TIME = "BEGIN_TIME"; 120 const std::string KEY_ANIM_END_TIME = "END_TIME"; 121 122 // for general skip frame 123 const std::string KEY_SKIPPED_FRAME_TIME = "SKIPPED_FRAME_TIME"; 124 125 // for DH jank frame 126 const std::string DH_JANK_FRAME_HAPPEN_TIME = "HAPPEN_TIME"; 127 const std::string DH_JANK_FRAME_TOTAL_TIME_SPENT = "TOTAL_TIME_SPENT"; 128 const std::string DH_JANK_FRAME_PACKAGE_NAME = "PACKAGE_NAME"; 129 const std::string DH_JANK_FRAME_VERSION = "VERSION"; 130 131 // for DH compose jank frame 132 const std::string DH_COMPOSE_JANK_FRAME_START_TIME = "START_TIME"; 133 const std::string DH_COMPOSE_JANK_FRAME_END_TIME = "END_TIME"; 134 const std::string DH_COMPOSE_JANK_FRAME_SKIP_FRAME = "SKIP_FRAME"; 135 const std::string DH_COMPOSE_JANK_FRAME_VSYNC_INTERVAL = "VSYNC_INTERVAL"; 136 137 // for DH app start 138 const std::string DH_APP_START_MISSION_ID = "MISSION_ID"; 139 const std::string DH_APP_START_TASK_ID = "TASK_ID"; 140 const std::string DH_APP_START_TIMESTAMP = "TIMESTAMP"; 141 // for screen Fold open and close 142 const std::string KEY_POWER_OFF_SCREEN = "POWER_OFF_SCREEN"; 143 const std::string KEY_POWER_ON_SCREEN = "POWER_ON_SCREEN"; 144 145 const std::string KEY_HAPPEN_TIME = "HAPPEN_TIME"; 146 147 // for perf factory test mode 148 const std::string PERF_FACTORY_TEST_TITLE = "TEST_TITLE"; 149 150 // for frequency limit 151 const std::string KEY_CLIENT_ID = "CLIENT_ID"; 152 const std::string KEY_RES_ID = "RES_ID"; 153 const std::string KEY_CONFIG = "CONFIG"; 154 // for boost limit 155 const std::string KEY_ON_OFF_TAG = "ON_OFF_TAG"; 156 // for shader malfunction 157 const std::string KEY_SHADER_MALFUNCTION_PID = "PID"; 158 const std::string KEY_SHADER_MALFUNCTION_PROCESS_NAME = "PROCESS_NAME"; 159 const std::string KEY_SHADER_MALFUNCTION_HASH_CODE = "HASH_CODE"; 160 const std::string KEY_SHADER_MALFUNCTION_COMPILE_TIME = "COMPILE_TIME"; 161 const std::string KEY_SHADER_MALFUNCTION_TIME_STAMP = "TIME_STAMP"; 162 const std::string KEY_SHADER_MALFUNCTION_PART_FLAG = "PART_FLAG"; 163 // for shader stats 164 const std::string KEY_SHADER_STATS_PID = "PID"; 165 const std::string KEY_SHADER_STATS_PROCESS_NAME = "PROCESS_NAME"; 166 const std::string KEY_SHADER_STATS_TIME_STAMP = "TIME_STAMP"; 167 const std::string KEY_SHADER_STATS_PART_FLAG = "PART_FLAG"; 168 // for webview page load 169 const std::string NAVIGATION_ID = "NAVIGATION_ID"; 170 const std::string NAVIGATION_START = "NAVIGATION_START"; 171 const std::string REDIRECT_COUNT = "REDIRECT_COUNT"; 172 const std::string REDIRECT_START = "REDIRECT_START"; 173 const std::string REDIRECT_END = "REDIRECT_END"; 174 const std::string FETCH_START = "FETCH_START"; 175 const std::string WORKER_START = "WORKER_START"; 176 const std::string DOMAIN_LOOKUP_START = "DOMAIN_LOOKUP_START"; 177 const std::string DOMAIN_LOOKUP_END = "DOMAIN_LOOKUP_END"; 178 const std::string CONNECT_START = "CONNECT_START"; 179 const std::string SECURE_CONNECT_START = "SECURE_CONNECT_START"; 180 const std::string CONNECT_END = "CONNECT_END"; 181 const std::string REQUEST_START = "REQUEST_START"; 182 const std::string RESPONSE_START = "RESPONSE_START"; 183 const std::string RESPONSE_END = "RESPONSE_END"; 184 const std::string DOM_INTERACTIVE = "DOM_INTERACTIVE"; 185 const std::string DOM_CONTENT_LOADED_EVENT_START = "DOM_CONTENT_LOADED_EVENT_START"; 186 const std::string DOM_CONTENT_LOADED_EVENT_END = "DOM_CONTENT_LOADED_EVENT_END"; 187 const std::string LOAD_EVENT_START = "LOAD_EVENT_START"; 188 const std::string LOAD_EVENT_END = "LOAD_EVENT_END"; 189 const std::string FIRST_PAINT = "FIRST_PAINT"; 190 const std::string FIRST_CONTENTFUL_PAINT = "FIRST_CONTENTFUL_PAINT"; 191 const std::string LARGEST_CONTENTFUL_PAINT = "LARGEST_CONTENTFUL_PAINT"; 192 // for webview dynamic frame drop 193 const std::string DURATION = "DURATION"; 194 const std::string TOTAL_APP_FRAMES = "TOTAL_APP_FRAMES"; 195 const std::string TOTAL_APP_MISSED_FRAMES = "TOTAL_APP_MISSED_FRAMES"; 196 const std::string MAX_APP_FRAMETIME = "MAX_APP_FRAMETIME"; 197 // for webview audio frame drop 198 const std::string AUDIO_BLANK_FRAME_COUNT = "AUDIO_BLANK_FRAME_COUNT"; 199 // for webview video frame drop 200 const std::string VIDEO_FRAME_DROPPED_COUNT = "VIDEO_FRAME_DROPPED_COUNT"; 201 const std::string VIDEO_FRAME_DROPPED_DURATION = "VIDEO_FRAME_DROPPED_DURATION"; 202 // for hitch time ratio 203 const std::string UI_START_TIME = "UI_START_TIME"; 204 const std::string RS_START_TIME = "RS_START_TIME"; 205 const std::string HITCH_TIME = "HITCH_TIME"; 206 const std::string KEY_HITCH_TIME_RATIO = "HITCH_TIME_RATIO"; 207 208 #define US_TO_S 1000000 209 210 class EvtParser { 211 using Event = OHOS::HiviewDFX::Event; 212 using SysEvent = OHOS::HiviewDFX::SysEvent; 213 214 public: 215 static const std::string separator; 216 static const std::map<std::string, unsigned int> logIdMap; 217 ExtractLogIdFromEvt(const SysEvent &sysEvent)218 static unsigned int ExtractLogIdFromEvt(const SysEvent &sysEvent) 219 { 220 std::string logIdStr = std::string(sysEvent.domain_ + separator + sysEvent.eventName_); 221 unsigned int logId = logIdMap.at(logIdStr); // this might throw std::out_of_range 222 return logId; 223 } 224 FromHivewEvt(const SysEvent &e)225 static std::shared_ptr <XperfEvt> FromHivewEvt(const SysEvent &e) 226 { 227 Validate(e); 228 XperfEvt evt = ConvertToXperfEvent(e); 229 std::shared_ptr <XperfEvt> ret = std::make_shared<XperfEvt>(evt); 230 return ret; 231 } 232 233 private: ConvertToXperfEvent(const SysEvent &event)234 static XperfEvt ConvertToXperfEvent(const SysEvent &event) 235 { 236 SysEvent &sysEvent = (SysEvent &) event; 237 XperfEvt evt; 238 evt.logId = ExtractLogIdFromEvt(sysEvent); 239 evt.domain = sysEvent.domain_; 240 evt.eventName = std::string(sysEvent.eventName_); 241 evt.pid = sysEvent.GetPid(); 242 evt.versionCode = static_cast<int32_t>(sysEvent.GetEventIntValue(KEY_VERSION_CODE)); 243 evt.appPid = static_cast<int32_t>(sysEvent.GetEventIntValue(KEY_APP_PID)); 244 evt.sourceType = sysEvent.GetEventValue(KEY_SOURCE_TYPE); 245 evt.pageUrl = sysEvent.GetEventValue(PAGE_URL); 246 evt.sceneId = sysEvent.GetEventValue(SCENE_ID); 247 evt.eventTime = static_cast<uint64_t>(sysEvent.GetEventIntValue(TIMER)); 248 evt.inputTime = static_cast<uint64_t>(sysEvent.GetEventIntValue(INPUT_TIME)); 249 evt.renderTime = static_cast<uint64_t>(sysEvent.GetEventIntValue(RENDER_TIME)); 250 evt.responseLatency = static_cast<uint64_t>(sysEvent.GetEventIntValue(RESPONSE_LATENCY)); 251 evt.e2eLatency = static_cast<uint64_t>(sysEvent.GetEventIntValue(E2E_LATENCY)); 252 evt.bundleName = sysEvent.GetEventValue(KEY_BUNDLE_NAME); 253 evt.bundleType = static_cast<int32_t>(sysEvent.GetEventIntValue(KEY_BUNDLE_TYPE)); 254 evt.abilityName = sysEvent.GetEventValue(KEY_ABILITY_NAME); 255 evt.processName = sysEvent.GetEventValue(KEY_PNAME); 256 evt.moduleName = sysEvent.GetEventValue(KEY_MODULE_NAME); 257 evt.versionName = sysEvent.GetEventValue(KEY_APP_VERSION); 258 evt.startType = static_cast<int32_t>(sysEvent.GetEventIntValue(KEY_START_TYPE)); 259 evt.startupTime = static_cast<uint64_t>(sysEvent.GetEventIntValue(KEY_STARTUP_TIME)); 260 evt.startupAbilityType = static_cast<int32_t>(sysEvent.GetEventIntValue(KEY_STARTUP_ABILITY_TYPE)); 261 evt.startupExtensionType = static_cast<int32_t>(sysEvent.GetEventIntValue(KEY_STARTUP_EXTENSION_TYPE)); 262 evt.callerBundleName = sysEvent.GetEventValue(KEY_CALLER_BUNDLE_NAME); 263 evt.callerUid = static_cast<int32_t>(sysEvent.GetEventIntValue(KEY_CALLER_UID)); 264 evt.callerProcessName = sysEvent.GetEventValue(KEY_CALLER_PROCESS_NAME); 265 evt.windowName = sysEvent.GetEventValue(KEY_WINDOW_NAME); 266 evt.time = evt.eventTime; 267 evt.animationStartTime = evt.animStartTime; 268 evt.animationStartLatency = static_cast<uint64_t>(sysEvent.GetEventIntValue(KEY_ANIMATION_START_LATENCY)); 269 evt.animationEndLatency = evt.animationLatency; 270 evt.appUid = static_cast<int32_t>(sysEvent.GetEventIntValue(KEY_APP_UID)); 271 ConvertToXperfAnimatorEvent(evt, sysEvent); 272 evt.exitTime = static_cast<uint64_t>(sysEvent.GetEventIntValue(KEY_EXIT_TIME)); 273 evt.exitResult = static_cast<int32_t>(sysEvent.GetEventIntValue(KEY_EXIT_RESULT)); 274 evt.exitPid = static_cast<int32_t>(sysEvent.GetEventIntValue(KEY_EXIT_PID)); 275 evt.note = sysEvent.GetEventValue(KEY_NOTE); 276 return evt; 277 } 278 ConvertToXperfAnimatorEvent(XperfEvt &evt, SysEvent &sysEvent)279 static void ConvertToXperfAnimatorEvent(XperfEvt &evt, SysEvent &sysEvent) 280 { 281 evt.animatorInfo.basicInfo.uniqueId = static_cast<int32_t>(sysEvent.GetEventIntValue(UNIQUE_ID)); 282 evt.animatorInfo.basicInfo.sceneId = sysEvent.GetEventValue(SCENE_ID); 283 evt.animatorInfo.basicInfo.moduleName = sysEvent.GetEventValue(KEY_MODULE_NAME); 284 evt.animatorInfo.basicInfo.processName = sysEvent.GetEventValue(KEY_PNAME); 285 evt.animatorInfo.basicInfo.abilityName = sysEvent.GetEventValue(KEY_ABILITY_NAME); 286 evt.animatorInfo.basicInfo.pageUrl = sysEvent.GetEventValue(PAGE_URL); 287 evt.animatorInfo.basicInfo.sourceType = sysEvent.GetEventValue(KEY_SOURCE_TYPE); 288 evt.animatorInfo.basicInfo.versionCode = static_cast<int32_t>(sysEvent.GetEventIntValue(KEY_VERSION_CODE)); 289 evt.animatorInfo.basicInfo.versionName = sysEvent.GetEventValue(KEY_APP_VERSION); 290 evt.animatorInfo.basicInfo.bundleNameEx = sysEvent.GetEventValue(KEY_NOTE); 291 evt.animatorInfo.commonInfo.appPid = sysEvent.GetPid(); 292 evt.animatorInfo.commonInfo.durition = static_cast<uint64_t>(sysEvent.GetEventIntValue(DURITION)); 293 evt.animatorInfo.commonInfo.startTime = static_cast<uint64_t>(sysEvent.GetEventIntValue(STARTTIME)); 294 evt.animatorInfo.commonInfo.totalFrames = static_cast<int32_t>(sysEvent.GetEventIntValue(TOTAL_FRAMES)); 295 evt.animatorInfo.commonInfo.totalMissedFrames 296 = static_cast<int32_t>(sysEvent.GetEventIntValue(TOTAL_MISSED_FRAMES)); 297 evt.animatorInfo.commonInfo.maxSeqMissedFrames 298 = static_cast<int32_t>(sysEvent.GetEventIntValue(MAX_SEQ_MISSED_FRAMES)); 299 evt.animatorInfo.commonInfo.maxFrameTime = static_cast<uint64_t>(sysEvent.GetEventIntValue(MAX_FRAMETIME)); 300 evt.animatorInfo.commonInfo.averageFrameTime 301 = static_cast<int32_t>(sysEvent.GetEventIntValue(AVERAGE_FRAMETIME)); 302 evt.animatorInfo.commonInfo.isFoldDisp = static_cast<bool>(sysEvent.GetEventIntValue(IS_FOLD_DISP)); 303 evt.animatorInfo.commonInfo.isDisplayAnimator 304 = static_cast<bool>(sysEvent.GetEventIntValue(IS_DISPLAY_ANIMATOR)); 305 evt.animatorInfo.commonInfo.happenTime = static_cast<uint64_t>(sysEvent.GetEventIntValue(TIMER)); 306 } 307 Validate(const SysEvent &event)308 static void Validate(const SysEvent &event) 309 { 310 SysEvent &sysEvent = (SysEvent &) event; 311 if (sysEvent.eventName_ == JANK_FRAME_SKIP) { 312 std::string appName = sysEvent.GetEventValue(KEY_ABILITY_NAME); 313 if (appName == "") { 314 throw std::invalid_argument("invalid sysEvent JANK_FRAME_SKIP"); 315 } 316 } 317 if (sysEvent.eventName_ == ABILITY_ONACTIVE) { 318 int32_t type = static_cast<int32_t>(sysEvent.GetEventIntValue(KEY_ABILITY_TYPE)); 319 if (type != 1) { 320 throw std::invalid_argument("invalid sysEvent ABILITY_ONACTIVE"); 321 } 322 } 323 if (sysEvent.eventName_ == KEY_STARTUP_TIME) { 324 std::string detailedTime = sysEvent.GetEventValue(DETAILED_TIME); 325 if (detailedTime == "") { 326 throw std::invalid_argument("invalid sysEvent STARTUP_TIME"); 327 } 328 } 329 // what follows cannot be understood 330 } 331 }; 332 } // HiviewDFX 333 } // OHOS 334 #endif 335