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