1 /* 2 * Copyright (c) 2021 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 FOUNDATION_ACE_FRAMEWORKS_BASE_LOG_ACE_TRACE_H 17 #define FOUNDATION_ACE_FRAMEWORKS_BASE_LOG_ACE_TRACE_H 18 19 #include <atomic> 20 #include <cstdarg> 21 #include <cstdio> 22 #include <memory> 23 #include <string> 24 25 #include "base/utils/macros.h" 26 #include "base/utils/noncopyable.h" 27 #include "base/utils/system_properties.h" 28 29 #define ACE_SCOPED_TRACE(fmt, ...) AceScopedTrace aceScopedTrace(fmt, ##__VA_ARGS__) 30 #define ACE_SCOPED_TRACE_COMMERCIAL(fmt, ...) AceScopedTraceCommercial aceScopedTrace(fmt, ##__VA_ARGS__) 31 #define ACE_SCOPED_TRACE_FLAG(flag, fmt, ...) AceScopedTraceFlag aceScopedTraceFlag(flag, fmt, ##__VA_ARGS__) 32 #define ACE_SVG_SCOPED_TRACE(fmt, ...) \ 33 AceScopedTraceFlag aceScopedTraceFlag(SystemProperties::GetSvgTraceEnabled(), fmt, ##__VA_ARGS__) 34 #define ACE_TEXT_SCOPED_TRACE(fmt, ...) \ 35 AceScopedTraceFlag aceScopedTraceFlag(SystemProperties::GetTextTraceEnabled(), fmt, ##__VA_ARGS__) 36 #define ACE_SYNTAX_SCOPED_TRACE(fmt, ...) \ 37 AceScopedTraceFlag aceScopedTraceFlag(SystemProperties::GetSyntaxTraceEnabled(), fmt, ##__VA_ARGS__) 38 #define ACE_ACCESS_SCOPED_TRACE(fmt, ...) \ 39 AceScopedTraceFlag aceScopedTraceFlag(SystemProperties::GetAccessTraceEnabled(), fmt, ##__VA_ARGS__) 40 #define ACE_LAYOUT_SCOPED_TRACE(fmt, ...) \ 41 AceScopedTraceFlag aceScopedTraceFlag(SystemProperties::GetLayoutTraceEnabled(), fmt, ##__VA_ARGS__) 42 #define ACE_IMAGE_SCOPED_TRACE(fmt, ...) \ 43 AceScopedTraceFlag aceScopedTraceFlag(SystemProperties::GetDebugEnabled(), fmt, ##__VA_ARGS__) 44 #define ACE_MEASURE_SCOPED_TRACE(fmt, ...) \ 45 AceScopedTraceFlag aceScopedTraceFlag(SystemProperties::GetMeasureDebugTraceEnabled(), fmt, ##__VA_ARGS__) 46 #define ACE_SAFE_AREA_SCOPED_TRACE(fmt, ...) \ 47 AceScopedTraceFlag aceScopedTraceFlag(SystemProperties::GetSafeAreaDebugTraceEnabled(), fmt, ##__VA_ARGS__) 48 #define ACE_VSYNC_MODE_SCOPED_TRACE(fmt, ...) \ 49 AceScopedTraceFlag aceScopedTraceFlag(SystemProperties::GetVsyncModeTraceEnabled(), fmt, ##__VA_ARGS__) 50 #ifdef ACE_DEBUG 51 #define ACE_DEBUG_SCOPED_TRACE(fmt, ...) AceScopedTrace aceScopedTrace(fmt, ##__VA_ARGS__) 52 #else 53 #define ACE_DEBUG_SCOPED_TRACE(fmt, ...) 54 #endif 55 56 #define ACE_LAYOUT_TRACE_BEGIN(fmt, ...) \ 57 if (SystemProperties::GetLayoutTraceEnabled()) { \ 58 AceTraceBeginWithArgs(fmt, ##__VA_ARGS__); \ 59 } 60 #define ACE_LAYOUT_TRACE_END() \ 61 if (SystemProperties::GetLayoutTraceEnabled()) { \ 62 AceTraceEnd(); \ 63 } 64 65 // Enable trace for component creation and attribute settings 66 #define ACE_BUILD_TRACE_BEGIN(fmt, ...) \ 67 if (SystemProperties::GetBuildTraceEnabled()) { \ 68 AceTraceBeginWithArgs(fmt, ##__VA_ARGS__); \ 69 } 70 #define ACE_BUILD_TRACE_END() \ 71 if (SystemProperties::GetBuildTraceEnabled()) { \ 72 AceTraceEnd(); \ 73 } 74 75 #define CHECK_NULL_VOID_LAYOUT_TRACE_END(ptr) \ 76 do { \ 77 if (!(ptr)) { \ 78 if (SystemProperties::GetLayoutTraceEnabled()) { \ 79 AceTraceEnd(); \ 80 } \ 81 return; \ 82 } \ 83 } while (0) \ 84 85 #define ACE_FUNCTION_TRACE() ACE_SCOPED_TRACE(__func__) 86 #define ACE_FUNCTION_TRACE_COMMERCIAL() ACE_SCOPED_TRACE_COMMERCIAL(__func__) 87 88 #define ACE_COUNT_TRACE(count, fmt, ...) AceCountTraceWidthArgs(count, fmt, ##__VA_ARGS__) 89 90 namespace OHOS::Ace { 91 bool ACE_EXPORT AceAsyncTraceEnable(); 92 void ACE_EXPORT AceTraceBegin(const char* name); 93 void ACE_EXPORT AceAsyncTraceBegin(int32_t taskId, const char* name, bool isAnimationTrace = false); 94 bool ACE_EXPORT AceTraceBeginWithArgs(const char* format, ...) __attribute__((__format__(printf, 1, 2))); 95 std::string ACE_EXPORT AceAsyncTraceBeginWithArgs(int32_t taskId, char* format, ...); 96 bool ACE_EXPORT AceTraceBeginWithArgv(const char* format, va_list args); 97 std::string ACE_EXPORT AceAsyncTraceBeginWithArgv(int32_t taskId, const char* format, va_list args); 98 void ACE_EXPORT AceTraceEnd(); 99 void ACE_EXPORT AceAsyncTraceEnd(int32_t taskId, const char* name, bool isAnimationTrace = false); 100 void ACE_EXPORT AceCountTrace(const char *key, int32_t count); 101 void ACE_EXPORT AceCountTraceWidthArgs(int32_t count, const char* format, ...); 102 103 // for commercial trace 104 void ACE_EXPORT AceTraceBeginCommercial(const char* name); 105 void ACE_EXPORT AceTraceEndCommercial(); 106 void ACE_EXPORT AceAsyncTraceBeginCommercial(int32_t taskId, const char* name, bool isAnimationTrace = false); 107 void ACE_EXPORT AceAsyncTraceEndCommercial(int32_t taskId, const char* name, bool isAnimationTrace = false); 108 109 class ACE_FORCE_EXPORT AceScopedTrace final { 110 public: 111 explicit AceScopedTrace(const char* format, ...) __attribute__((__format__(printf, 2, 3))); 112 ~AceScopedTrace(); 113 114 ACE_DISALLOW_COPY_AND_MOVE(AceScopedTrace); 115 private: 116 bool strValid_ = false; 117 }; 118 119 class ACE_FORCE_EXPORT AceScopedTraceCommercial final { 120 public: 121 explicit AceScopedTraceCommercial(const char* format, ...) __attribute__((__format__(printf, 2, 3))); 122 ~AceScopedTraceCommercial(); 123 124 ACE_DISALLOW_COPY_AND_MOVE(AceScopedTraceCommercial); 125 private: 126 bool strValid_ = false; 127 }; 128 129 class ACE_FORCE_EXPORT AceScopedTraceFlag final { 130 public: 131 AceScopedTraceFlag(bool flag, const char* format, ...) __attribute__((__format__(printf, 3, 4))); 132 ~AceScopedTraceFlag(); 133 134 ACE_DISALLOW_COPY_AND_MOVE(AceScopedTraceFlag); 135 136 private: 137 bool flagTraceEnabled_ { false }; 138 }; 139 140 class ACE_EXPORT AceAsyncScopedTrace final { 141 public: 142 AceAsyncScopedTrace(const char* format, ...); 143 ~AceAsyncScopedTrace(); 144 145 ACE_DISALLOW_COPY_AND_MOVE(AceAsyncScopedTrace); 146 147 private: 148 std::string name_; 149 int32_t taskId_; 150 static std::atomic<std::int32_t> id_; 151 }; 152 153 } // namespace OHOS::Ace 154 155 #endif // FOUNDATION_ACE_FRAMEWORKS_BASE_LOG_ACE_TRACE_H 156