1 /* 2 * Copyright (C) 2022 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 21 #ifdef __cplusplus 22 extern "C" { 23 #endif 24 25 constexpr uint64_t HITRACE_TAG_NEVER = 0; // This tag is never enabled. 26 constexpr uint64_t HITRACE_TAG_ALWAYS = (1ULL << 0); // This tag is always enabled. 27 constexpr uint64_t HITRACE_TAG_SECURITY = (1ULL << 7); // Security subsystem tag. 28 constexpr uint64_t HITRACE_TAG_ANIMATION = (1ULL << 9); // Animation tag. 29 constexpr uint64_t HITRACE_TAG_PUSH = (1ULL << 10); // Push subsystem tag. 30 constexpr uint64_t HITRACE_TAG_VIRSE = (1ULL << 11); // virtualization service. 31 constexpr uint64_t HITRACE_TAG_MUSL = (1ULL << 12); // musl module. 32 constexpr uint64_t HITRACE_TAG_FFRT = (1ULL << 13); // ffrt tasks. 33 constexpr uint64_t HITRACE_TAG_CLOUD = (1ULL << 14); // Cloud subsystem tag. 34 constexpr uint64_t HITRACE_TAG_DEV_AUTH = (1ULL << 15); // Device auth module tag. 35 constexpr uint64_t HITRACE_TAG_COMMONLIBRARY = (1ULL << 16); // Commonlibrary subsystem tag. 36 constexpr uint64_t HITRACE_TAG_HDCD = (1ULL << 17); // HDCD tag. 37 constexpr uint64_t HITRACE_TAG_HDF = (1ULL << 18); // HDF subsystem tag. 38 constexpr uint64_t HITRACE_TAG_USB = (1ULL << 19); // USB subsystem tag. 39 constexpr uint64_t HITRACE_TAG_INTERCONNECTION = (1ULL << 20); // Interconnection subsystem tag. 40 constexpr uint64_t HITRACE_TAG_DLP_CREDENTIAL = (1ULL << 21); // This tag is dlp credential service. 41 constexpr uint64_t HITRACE_TAG_ACCESS_CONTROL = (1ULL << 22); // This tag is access control tag. 42 constexpr uint64_t HITRACE_TAG_NET = (1ULL << 23); // Net tag. 43 constexpr uint64_t HITRACE_TAG_NWEB = (1ULL << 24); // NWeb tag. 44 constexpr uint64_t HITRACE_TAG_HUKS = (1ULL << 25); // This tag is huks. 45 constexpr uint64_t HITRACE_TAG_USERIAM = (1ULL << 26); // This tag is useriam. 46 constexpr uint64_t HITRACE_TAG_DISTRIBUTED_AUDIO = (1ULL << 27); // Distributed audio tag. 47 constexpr uint64_t HITRACE_TAG_DLSM = (1ULL << 28); // device security level tag. 48 constexpr uint64_t HITRACE_TAG_FILEMANAGEMENT = (1ULL << 29); // filemanagement tag. 49 constexpr uint64_t HITRACE_TAG_OHOS = (1ULL << 30); // OHOS generic tag. 50 constexpr uint64_t HITRACE_TAG_ABILITY_MANAGER = (1ULL << 31); // Ability Manager tag. 51 constexpr uint64_t HITRACE_TAG_ZCAMERA = (1ULL << 32); // Camera module tag. 52 constexpr uint64_t HITRACE_TAG_ZMEDIA = (1ULL << 33); // Media module tag. 53 constexpr uint64_t HITRACE_TAG_ZIMAGE = (1ULL << 34); // Image module tag. 54 constexpr uint64_t HITRACE_TAG_ZAUDIO = (1ULL << 35); // Audio module tag. 55 constexpr uint64_t HITRACE_TAG_DISTRIBUTEDDATA = (1ULL << 36); // Distributeddata manager module tag. 56 constexpr uint64_t HITRACE_TAG_MDFS = (1ULL << 37); // Mobile distributed file system tag. 57 constexpr uint64_t HITRACE_TAG_GRAPHIC_AGP = (1ULL << 38); // Graphic module tag. 58 constexpr uint64_t HITRACE_TAG_ACE = (1ULL << 39); // ACE development framework tag. 59 constexpr uint64_t HITRACE_TAG_NOTIFICATION = (1ULL << 40); // Notification module tag. 60 constexpr uint64_t HITRACE_TAG_MISC = (1ULL << 41); // Notification module tag. 61 constexpr uint64_t HITRACE_TAG_MULTIMODALINPUT = (1ULL << 42); // Multi modal module tag. 62 constexpr uint64_t HITRACE_TAG_SENSORS = (1ULL << 43); // Sensors mudule tag. 63 constexpr uint64_t HITRACE_TAG_MSDP = (1ULL << 44); // Multimodal Sensor Data Platform module tag. 64 constexpr uint64_t HITRACE_TAG_DSOFTBUS = (1ULL << 45); // Distributed Softbus tag. 65 constexpr uint64_t HITRACE_TAG_RPC = (1ULL << 46); // RPC and IPC tag. 66 constexpr uint64_t HITRACE_TAG_ARK = (1ULL << 47); // ARK tag. 67 constexpr uint64_t HITRACE_TAG_WINDOW_MANAGER = (1ULL << 48); // window manager tag. 68 constexpr uint64_t HITRACE_TAG_ACCOUNT_MANAGER = (1ULL << 49); // account manager tag. 69 constexpr uint64_t HITRACE_TAG_DISTRIBUTED_SCREEN = (1ULL << 50); // Distributed screen tag. 70 constexpr uint64_t HITRACE_TAG_DISTRIBUTED_CAMERA = (1ULL << 51); // Distributed camera tag. 71 constexpr uint64_t HITRACE_TAG_DISTRIBUTED_HARDWARE_FWK = (1ULL << 52); // Distributed hardware fwk tag. 72 constexpr uint64_t HITRACE_TAG_GLOBAL_RESMGR = (1ULL << 53); // Global resource manager tag. 73 constexpr uint64_t HITRACE_TAG_DEVICE_MANAGER = (1ULL << 54); // Distributed hardware devicemanager tag. 74 constexpr uint64_t HITRACE_TAG_SAMGR = (1ULL << 55); // SA tag. 75 constexpr uint64_t HITRACE_TAG_POWER = (1ULL << 56); // power manager tag. 76 constexpr uint64_t HITRACE_TAG_DISTRIBUTED_SCHEDULE = (1ULL << 57); // Distributed schedule tag. 77 constexpr uint64_t HITRACE_TAG_DEVICE_PROFILE = (1ULL << 58); // device profile tag. 78 constexpr uint64_t HITRACE_TAG_DISTRIBUTED_INPUT = (1ULL << 59); // Distributed input tag. 79 constexpr uint64_t HITRACE_TAG_BLUETOOTH = (1ULL << 60); // bluetooth tag. 80 constexpr uint64_t HITRACE_TAG_ACCESSIBILITY_MANAGER = (1ULL << 61); // accessibility manager tag. 81 constexpr uint64_t HITRACE_TAG_APP = (1ULL << 62); // App tag. 82 83 constexpr uint64_t HITRACE_TAG_LAST = HITRACE_TAG_APP; 84 constexpr uint64_t HITRACE_TAG_NOT_READY = (1ULL << 63); // Reserved for initialization. 85 constexpr uint64_t HITRACE_TAG_VALID_MASK = ((HITRACE_TAG_LAST - 1) | HITRACE_TAG_LAST); 86 87 #ifndef HITRACE_TAG 88 #define HITRACE_TAG HITRACE_TAG_NEVER 89 #elif HITRACE_TAG > HITRACE_TAG_VALID_MASK 90 #error HITRACE_TAG must be defined to be one of the tags defined in hitrace_meter.h 91 #elif HITRACE_TAG < HITRACE_TAG_OHOS 92 #error HITRACE_TAG must be defined to be one of the tags defined in hitrace_meter.h 93 #endif 94 95 #define TOKENPASTE(x, y) x ## y 96 #define TOKENPASTE2(x, y) TOKENPASTE(x, y) 97 #define HITRACE_METER_NAME(TAG, str) HitraceScoped TOKENPASTE2(tracer, __LINE__)(TAG, str) 98 #define HITRACE_METER(TAG) HITRACE_METER_NAME(TAG, __func__) 99 #define HITRACE_METER_FMT(TAG, fmt, ...) HitraceMeterFmtScoped TOKENPASTE2(tracer, __LINE__)(TAG, fmt, ##__VA_ARGS__) 100 101 /** 102 * Update trace label when your process has started. 103 */ 104 void UpdateTraceLabel(); 105 106 /** 107 * Disable trace outputs. 108 * You should know what you are doing when calling this function. 109 */ 110 void SetTraceDisabled(bool disable); 111 112 /** 113 * Track the beginning of a context. 114 */ 115 void StartTrace(uint64_t label, const std::string& value, float limit = -1); 116 void StartTraceDebug(bool isDebug, uint64_t label, const std::string& value, float limit = -1); 117 void StartTraceArgs(uint64_t label, const char *fmt, ...); 118 void StartTraceArgsDebug(bool isDebug, uint64_t label, const char *fmt, ...); 119 void StartTraceWrapper(uint64_t label, const char *value); 120 121 /** 122 * Track the end of a context. 123 */ 124 void FinishTrace(uint64_t label); 125 void FinishTraceDebug(bool isDebug, uint64_t label); 126 127 /** 128 * Track the beginning of an asynchronous event. 129 */ 130 void StartAsyncTrace(uint64_t label, const std::string& value, int32_t taskId, float limit = -1); 131 void StartAsyncTraceDebug(bool isDebug, uint64_t label, const std::string& value, int32_t taskId, float limit = -1); 132 void StartAsyncTraceArgs(uint64_t label, int32_t taskId, const char *fmt, ...); 133 void StartAsyncTraceArgsDebug(bool isDebug, uint64_t label, int32_t taskId, const char *fmt, ...); 134 void StartAsyncTraceWrapper(uint64_t label, const char *value, int32_t taskId); 135 136 /** 137 * Track the end of an asynchronous event. 138 */ 139 void FinishAsyncTrace(uint64_t label, const std::string& value, int32_t taskId); 140 void FinishAsyncTraceDebug(bool isDebug, uint64_t label, const std::string& value, int32_t taskId); 141 void FinishAsyncTraceArgs(uint64_t label, int32_t taskId, const char *fmt, ...); 142 void FinishAsyncTraceArgsDebug(bool isDebug, uint64_t label, int32_t taskId, const char *fmt, ...); 143 void FinishAsyncTraceWrapper(uint64_t label, const char *value, int32_t taskId); 144 145 /** 146 * Track the middle of a context. Match the previous function of StartTrace before it. 147 */ 148 void MiddleTrace(uint64_t label, const std::string& beforeValue, const std::string& afterValue); 149 void MiddleTraceDebug(bool isDebug, uint64_t label, const std::string& beforeValue, const std::string& afterValue); 150 151 /** 152 * Track the 64-bit integer counter value. 153 */ 154 void CountTrace(uint64_t label, const std::string& name, int64_t count); 155 void CountTraceDebug(bool isDebug, uint64_t label, const std::string& name, int64_t count); 156 void CountTraceWrapper(uint64_t label, const char *name, int64_t count); 157 bool IsTagEnabled(uint64_t tag); 158 159 class HitraceScoped { 160 public: HitraceScoped(uint64_t tag,const std::string & value)161 inline HitraceScoped(uint64_t tag, const std::string &value) : mTag(tag) 162 { 163 StartTrace(mTag, value); 164 } 165 ~HitraceScoped()166 inline ~HitraceScoped() 167 { 168 FinishTrace(mTag); 169 } 170 private: 171 uint64_t mTag; 172 }; 173 174 class HitraceMeterFmtScoped { 175 public: 176 HitraceMeterFmtScoped(uint64_t tag, const char *fmt, ...); 177 ~HitraceMeterFmtScoped()178 ~HitraceMeterFmtScoped() 179 { 180 FinishTrace(mTag); 181 } 182 private: 183 uint64_t mTag; 184 }; 185 #ifdef __cplusplus 186 } 187 #endif 188 #endif // INTERFACES_INNERKITS_NATIVE_HITRACE_METER_H 189