1 /* 2 * Copyright (C) 2022-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 16 #ifndef INTERFACES_INNERKITS_NATIVE_HITRACE_METER_H 17 #define INTERFACES_INNERKITS_NATIVE_HITRACE_METER_H 18 19 #include <string> 20 #ifdef HITRACE_UNITTEST 21 #include "param/sys_param.h" 22 #endif 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 constexpr uint64_t HITRACE_TAG_NEVER = 0; // This tag is never enabled. 28 constexpr uint64_t HITRACE_TAG_ALWAYS = (1ULL << 0); // This tag is always enabled. 29 constexpr uint64_t HITRACE_TAG_DRM = (1ULL << 6); // Media subsystem Digital Rights Management tag. 30 constexpr uint64_t HITRACE_TAG_SECURITY = (1ULL << 7); // Security subsystem tag. 31 constexpr uint64_t HITRACE_TAG_ANIMATION = (1ULL << 9); // Animation tag. 32 constexpr uint64_t HITRACE_TAG_PUSH = (1ULL << 10); // Push subsystem tag. 33 constexpr uint64_t HITRACE_TAG_VIRSE = (1ULL << 11); // virtualization service. 34 constexpr uint64_t HITRACE_TAG_MUSL = (1ULL << 12); // musl module. 35 constexpr uint64_t HITRACE_TAG_FFRT = (1ULL << 13); // ffrt tasks. 36 constexpr uint64_t HITRACE_TAG_CLOUD = (1ULL << 14); // Cloud subsystem tag. 37 constexpr uint64_t HITRACE_TAG_DEV_AUTH = (1ULL << 15); // Device auth module tag. 38 constexpr uint64_t HITRACE_TAG_COMMONLIBRARY = (1ULL << 16); // Commonlibrary subsystem tag. 39 constexpr uint64_t HITRACE_TAG_HDCD = (1ULL << 17); // HDCD tag. 40 constexpr uint64_t HITRACE_TAG_HDF = (1ULL << 18); // HDF subsystem tag. 41 constexpr uint64_t HITRACE_TAG_USB = (1ULL << 19); // USB subsystem tag. 42 constexpr uint64_t HITRACE_TAG_INTERCONNECTION = (1ULL << 20); // Interconnection subsystem tag. 43 constexpr uint64_t HITRACE_TAG_DLP_CREDENTIAL = (1ULL << 21); // This tag is dlp credential service. 44 constexpr uint64_t HITRACE_TAG_ACCESS_CONTROL = (1ULL << 22); // This tag is access control tag. 45 constexpr uint64_t HITRACE_TAG_NET = (1ULL << 23); // Net tag. 46 constexpr uint64_t HITRACE_TAG_NWEB = (1ULL << 24); // NWeb tag. 47 constexpr uint64_t HITRACE_TAG_HUKS = (1ULL << 25); // This tag is huks. 48 constexpr uint64_t HITRACE_TAG_USERIAM = (1ULL << 26); // This tag is useriam. 49 constexpr uint64_t HITRACE_TAG_DISTRIBUTED_AUDIO = (1ULL << 27); // Distributed audio tag. 50 constexpr uint64_t HITRACE_TAG_DLSM = (1ULL << 28); // device security level tag. 51 constexpr uint64_t HITRACE_TAG_FILEMANAGEMENT = (1ULL << 29); // filemanagement tag. 52 constexpr uint64_t HITRACE_TAG_OHOS = (1ULL << 30); // OHOS generic tag. 53 constexpr uint64_t HITRACE_TAG_ABILITY_MANAGER = (1ULL << 31); // Ability Manager tag. 54 constexpr uint64_t HITRACE_TAG_ZCAMERA = (1ULL << 32); // Camera module tag. 55 constexpr uint64_t HITRACE_TAG_ZMEDIA = (1ULL << 33); // Media module tag. 56 constexpr uint64_t HITRACE_TAG_ZIMAGE = (1ULL << 34); // Image module tag. 57 constexpr uint64_t HITRACE_TAG_ZAUDIO = (1ULL << 35); // Audio module tag. 58 constexpr uint64_t HITRACE_TAG_DISTRIBUTEDDATA = (1ULL << 36); // Distributeddata manager module tag. 59 constexpr uint64_t HITRACE_TAG_MDFS = (1ULL << 37); // Mobile distributed file system tag. 60 constexpr uint64_t HITRACE_TAG_GRAPHIC_AGP = (1ULL << 38); // Graphic module tag. 61 constexpr uint64_t HITRACE_TAG_ACE = (1ULL << 39); // ACE development framework tag. 62 constexpr uint64_t HITRACE_TAG_NOTIFICATION = (1ULL << 40); // Notification module tag. 63 constexpr uint64_t HITRACE_TAG_MISC = (1ULL << 41); // Notification module tag. 64 constexpr uint64_t HITRACE_TAG_MULTIMODALINPUT = (1ULL << 42); // Multi modal module tag. 65 constexpr uint64_t HITRACE_TAG_SENSORS = (1ULL << 43); // Sensors mudule tag. 66 constexpr uint64_t HITRACE_TAG_MSDP = (1ULL << 44); // Multimodal Sensor Data Platform module tag. 67 constexpr uint64_t HITRACE_TAG_DSOFTBUS = (1ULL << 45); // Distributed Softbus tag. 68 constexpr uint64_t HITRACE_TAG_RPC = (1ULL << 46); // RPC and IPC tag. 69 constexpr uint64_t HITRACE_TAG_ARK = (1ULL << 47); // ARK tag. 70 constexpr uint64_t HITRACE_TAG_WINDOW_MANAGER = (1ULL << 48); // window manager tag. 71 constexpr uint64_t HITRACE_TAG_ACCOUNT_MANAGER = (1ULL << 49); // account manager tag. 72 constexpr uint64_t HITRACE_TAG_DISTRIBUTED_SCREEN = (1ULL << 50); // Distributed screen tag. 73 constexpr uint64_t HITRACE_TAG_DISTRIBUTED_CAMERA = (1ULL << 51); // Distributed camera tag. 74 constexpr uint64_t HITRACE_TAG_DISTRIBUTED_HARDWARE_FWK = (1ULL << 52); // Distributed hardware fwk tag. 75 constexpr uint64_t HITRACE_TAG_GLOBAL_RESMGR = (1ULL << 53); // Global resource manager tag. 76 constexpr uint64_t HITRACE_TAG_DEVICE_MANAGER = (1ULL << 54); // Distributed hardware devicemanager tag. 77 constexpr uint64_t HITRACE_TAG_SAMGR = (1ULL << 55); // SA tag. 78 constexpr uint64_t HITRACE_TAG_POWER = (1ULL << 56); // power manager tag. 79 constexpr uint64_t HITRACE_TAG_DISTRIBUTED_SCHEDULE = (1ULL << 57); // Distributed schedule tag. 80 constexpr uint64_t HITRACE_TAG_DEVICE_PROFILE = (1ULL << 58); // device profile tag. 81 constexpr uint64_t HITRACE_TAG_DISTRIBUTED_INPUT = (1ULL << 59); // Distributed input tag. 82 constexpr uint64_t HITRACE_TAG_BLUETOOTH = (1ULL << 60); // bluetooth tag. 83 constexpr uint64_t HITRACE_TAG_ACCESSIBILITY_MANAGER = (1ULL << 61); // accessibility manager tag. 84 constexpr uint64_t HITRACE_TAG_APP = (1ULL << 62); // App tag. 85 86 constexpr uint64_t HITRACE_TAG_LAST = HITRACE_TAG_APP; 87 constexpr uint64_t HITRACE_TAG_NOT_READY = (1ULL << 63); // Reserved for initialization. 88 constexpr uint64_t HITRACE_TAG_VALID_MASK = ((HITRACE_TAG_LAST - 1) | HITRACE_TAG_LAST); 89 constexpr uint64_t HITRACE_TAG_COMMERCIAL = (1ULL << 5); // Tag for commercial version. 90 91 #ifndef HITRACE_TAG 92 #define HITRACE_TAG HITRACE_TAG_NEVER 93 #elif HITRACE_TAG > HITRACE_TAG_VALID_MASK 94 #error HITRACE_TAG must be defined to be one of the tags defined in hitrace_meter.h 95 #elif HITRACE_TAG < HITRACE_TAG_OHOS 96 #error HITRACE_TAG must be defined to be one of the tags defined in hitrace_meter.h 97 #endif 98 99 #define TOKENPASTE(x, y) x ## y 100 #define TOKENPASTE2(x, y) TOKENPASTE(x, y) 101 #define HITRACE_METER_NAME(TAG, str) HitraceScoped TOKENPASTE2(tracer, __LINE__)(TAG, str) 102 #define HITRACE_METER(TAG) HITRACE_METER_NAME(TAG, __func__) 103 #define HITRACE_METER_FMT(TAG, fmt, ...) HitraceMeterFmtScoped TOKENPASTE2(tracer, __LINE__)(TAG, fmt, ##__VA_ARGS__) 104 105 /** 106 * Update trace label when your process has started. 107 */ 108 void UpdateTraceLabel(void); 109 110 /** 111 * Disable trace outputs. 112 * You should know what you are doing when calling this function. 113 */ 114 void SetTraceDisabled(bool disable); 115 116 /** 117 * Track the beginning of a context. 118 */ 119 void StartTrace(uint64_t label, const std::string& value, float limit = -1); 120 void StartTraceDebug(bool isDebug, uint64_t label, const std::string& value, float limit = -1); 121 void StartTraceArgs(uint64_t label, const char *fmt, ...); 122 void StartTraceArgsDebug(bool isDebug, uint64_t label, const char *fmt, ...); 123 void StartTraceWrapper(uint64_t label, const char *value); 124 125 /** 126 * Track the end of a context. 127 */ 128 void FinishTrace(uint64_t label); 129 void FinishTraceDebug(bool isDebug, uint64_t label); 130 131 /** 132 * Track the beginning of an asynchronous event. 133 */ 134 void StartAsyncTrace(uint64_t label, const std::string& value, int32_t taskId, float limit = -1); 135 void StartAsyncTraceDebug(bool isDebug, uint64_t label, const std::string& value, int32_t taskId, float limit = -1); 136 void StartAsyncTraceArgs(uint64_t label, int32_t taskId, const char *fmt, ...); 137 void StartAsyncTraceArgsDebug(bool isDebug, uint64_t label, int32_t taskId, const char *fmt, ...); 138 void StartAsyncTraceWrapper(uint64_t label, const char *value, int32_t taskId); 139 140 /** 141 * Track the beginning of an hitrace chain event. 142 */ 143 struct HiTraceIdStruct; 144 void StartTraceChain(uint64_t label, const struct HiTraceIdStruct* hiTraceId, const char *value); 145 146 /** 147 * Track the end of an asynchronous event. 148 */ 149 void FinishAsyncTrace(uint64_t label, const std::string& value, int32_t taskId); 150 void FinishAsyncTraceDebug(bool isDebug, uint64_t label, const std::string& value, int32_t taskId); 151 void FinishAsyncTraceArgs(uint64_t label, int32_t taskId, const char *fmt, ...); 152 void FinishAsyncTraceArgsDebug(bool isDebug, uint64_t label, int32_t taskId, const char *fmt, ...); 153 void FinishAsyncTraceWrapper(uint64_t label, const char *value, int32_t taskId); 154 155 /** 156 * Track the middle of a context. Match the previous function of StartTrace before it. 157 */ 158 void MiddleTrace(uint64_t label, const std::string& beforeValue, const std::string& afterValue); 159 void MiddleTraceDebug(bool isDebug, uint64_t label, const std::string& beforeValue, const std::string& afterValue); 160 161 /** 162 * Track the 64-bit integer counter value. 163 */ 164 void CountTrace(uint64_t label, const std::string& name, int64_t count); 165 void CountTraceDebug(bool isDebug, uint64_t label, const std::string& name, int64_t count); 166 void CountTraceWrapper(uint64_t label, const char *name, int64_t count); 167 bool IsTagEnabled(uint64_t tag); 168 169 enum RetType { 170 RET_SUCC = 0, // Successful 171 RET_STARTED = 1, // The capture process has already started 172 RET_STOPPED = 2, // The capture process has stopped 173 RET_FAILD = 1000, // Other failures 174 RET_FAIL_INVALID_ARGS = 1001, // Invalid parameter 175 RET_FAIL_MKDIR = 1002, // Failed to create dir 176 RET_FAIL_SETACL = 1003, // Failed to set the acl permission 177 RET_FAIL_ENOENT = 1004, // The file does not exist 178 RET_FAIL_EACCES = 1005, // No permission to open file 179 }; 180 181 enum TraceFlag { 182 FLAG_MAIN_THREAD = 1, 183 FLAG_ALL_THREAD = 2 184 }; 185 #ifdef HITRACE_UNITTEST 186 void SetReloadPid(bool isReloadPid); 187 void SetpidHasReload(bool ispidHasReload); 188 void SetAppFd(int appFd); 189 void SetMarkerFd(int markerFd); 190 void SetAddHitraceMeterMarker(uint64_t label, const std::string& value); 191 void SetAddTraceMarkerLarge(const std::string& name, const int64_t value); 192 void SetWriteAppTrace(TraceFlag appFlag, const std::string& name, const int64_t value, bool tid); 193 void SetWriteToTraceMarker(const char* buf, const int count); 194 void SetCachedHandleAndAppPidCachedHandle(CachedHandle cachedHandle, CachedHandle appPidCachedHandle); 195 void SetGetProcData(const char* file); 196 void GetSetMainThreadInfo(); 197 void GetSetCommStr(); 198 void SetTraceBuffer(int size); 199 void SetWriteOnceLog(LogLevel loglevel, const std::string& logStr, bool& isWrite); 200 void SetappTracePrefix(const std::string& appTracePrefix); 201 void SetMarkerType(TraceFlag appFlag, const std::string& name, const int64_t value, bool tid); 202 void SetWriteAppTraceLong(const int len, const std::string& name, const int64_t value); 203 #endif 204 205 int StartCaptureAppTrace(TraceFlag flag, uint64_t tags, uint64_t limitSize, std::string& fileName); 206 int StopCaptureAppTrace(void); 207 208 class HitraceScoped { 209 public: HitraceScoped(uint64_t tag,const std::string & value)210 inline HitraceScoped(uint64_t tag, const std::string &value) : mTag(tag) 211 { 212 StartTrace(mTag, value); 213 } 214 ~HitraceScoped()215 inline ~HitraceScoped() 216 { 217 FinishTrace(mTag); 218 } 219 private: 220 uint64_t mTag; 221 }; 222 223 class HitracePerfScoped { 224 public: 225 HitracePerfScoped(bool isDebug, uint64_t tag, const std::string &name); 226 227 ~HitracePerfScoped(); 228 229 inline long long GetInsCount(); 230 231 inline long long GetCycleCount(); 232 #ifdef HITRACE_UNITTEST 233 void SetHitracePerfScoped(int fd1st, int fd2nd); 234 #endif 235 private: 236 uint64_t mTag_; 237 std::string mName_; 238 int fd1st_ = -1; 239 int fd2nd_ = -1; 240 long long countIns_ = 0; 241 long long countCycles_ = 0; 242 int err_ = 0; 243 }; 244 245 class HitraceMeterFmtScoped { 246 public: 247 HitraceMeterFmtScoped(uint64_t tag, const char *fmt, ...); 248 ~HitraceMeterFmtScoped()249 ~HitraceMeterFmtScoped() 250 { 251 FinishTrace(mTag); 252 } 253 private: 254 uint64_t mTag; 255 }; 256 #ifdef __cplusplus 257 } 258 #endif 259 #endif // INTERFACES_INNERKITS_NATIVE_HITRACE_METER_H 260