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 #ifdef ACE_DEBUG 43 #define ACE_DEBUG_SCOPED_TRACE(fmt, ...) AceScopedTrace aceScopedTrace(fmt, ##__VA_ARGS__) 44 #else 45 #define ACE_DEBUG_SCOPED_TRACE(fmt, ...) 46 #endif 47 48 #define ACE_LAYOUT_TRACE_BEGIN(fmt, ...) \ 49 if (SystemProperties::GetLayoutTraceEnabled()) { \ 50 AceTraceBeginWithArgs(fmt, ##__VA_ARGS__); \ 51 } 52 #define ACE_LAYOUT_TRACE_END() \ 53 if (SystemProperties::GetLayoutTraceEnabled()) { \ 54 AceTraceEnd(); \ 55 } 56 57 // Enable trace for component creation and attribute settings 58 #define ACE_BUILD_TRACE_BEGIN(fmt, ...) \ 59 if (SystemProperties::GetBuildTraceEnabled()) { \ 60 AceTraceBeginWithArgs(fmt, ##__VA_ARGS__); \ 61 } 62 #define ACE_BUILD_TRACE_END() \ 63 if (SystemProperties::GetBuildTraceEnabled()) { \ 64 AceTraceEnd(); \ 65 } 66 67 #define CHECK_NULL_VOID_LAYOUT_TRACE_END(ptr) \ 68 do { \ 69 if (!(ptr)) { \ 70 if (SystemProperties::GetLayoutTraceEnabled()) { \ 71 AceTraceEnd(); \ 72 } \ 73 return; \ 74 } \ 75 } while (0) \ 76 77 #define ACE_FUNCTION_TRACE() ACE_SCOPED_TRACE(__func__) 78 79 #define ACE_COUNT_TRACE(count, fmt, ...) AceCountTraceWidthArgs(count, fmt, ##__VA_ARGS__) 80 81 namespace OHOS::Ace { 82 bool ACE_EXPORT AceAsyncTraceEnable(); 83 void ACE_EXPORT AceTraceBegin(const char* name); 84 void ACE_EXPORT AceAsyncTraceBegin(int32_t taskId, const char* name, bool isAnimationTrace = false); 85 bool ACE_EXPORT AceTraceBeginWithArgs(const char* format, ...) __attribute__((__format__(printf, 1, 2))); 86 std::string ACE_EXPORT AceAsyncTraceBeginWithArgs(int32_t taskId, char* format, ...); 87 bool ACE_EXPORT AceTraceBeginWithArgv(const char* format, va_list args); 88 std::string ACE_EXPORT AceAsyncTraceBeginWithArgv(int32_t taskId, const char* format, va_list args); 89 void ACE_EXPORT AceTraceEnd(); 90 void ACE_EXPORT AceAsyncTraceEnd(int32_t taskId, const char* name, bool isAnimationTrace = false); 91 void ACE_EXPORT AceCountTrace(const char *key, int32_t count); 92 void ACE_EXPORT AceCountTraceWidthArgs(int32_t count, const char* format, ...); 93 94 // for commercial trace 95 void ACE_EXPORT AceTraceBeginCommercial(const char* name); 96 void ACE_EXPORT AceTraceEndCommercial(); 97 void ACE_EXPORT AceAsyncTraceBeginCommercial(int32_t taskId, const char* name, bool isAnimationTrace = false); 98 void ACE_EXPORT AceAsyncTraceEndCommercial(int32_t taskId, const char* name, bool isAnimationTrace = false); 99 100 class ACE_FORCE_EXPORT AceScopedTrace final { 101 public: 102 explicit AceScopedTrace(const char* format, ...) __attribute__((__format__(printf, 2, 3))); 103 ~AceScopedTrace(); 104 105 ACE_DISALLOW_COPY_AND_MOVE(AceScopedTrace); 106 private: 107 bool strValid_ = false; 108 }; 109 110 class ACE_FORCE_EXPORT AceScopedTraceCommercial final { 111 public: 112 explicit AceScopedTraceCommercial(const char* format, ...) __attribute__((__format__(printf, 2, 3))); 113 ~AceScopedTraceCommercial(); 114 115 ACE_DISALLOW_COPY_AND_MOVE(AceScopedTraceCommercial); 116 private: 117 bool strValid_ = false; 118 }; 119 120 class ACE_FORCE_EXPORT AceScopedTraceFlag final { 121 public: 122 AceScopedTraceFlag(bool flag, const char* format, ...) __attribute__((__format__(printf, 3, 4))); 123 ~AceScopedTraceFlag(); 124 125 ACE_DISALLOW_COPY_AND_MOVE(AceScopedTraceFlag); 126 127 private: 128 bool flagTraceEnabled_ { false }; 129 }; 130 131 class ACE_EXPORT AceAsyncScopedTrace final { 132 public: 133 AceAsyncScopedTrace(const char* format, ...); 134 ~AceAsyncScopedTrace(); 135 136 ACE_DISALLOW_COPY_AND_MOVE(AceAsyncScopedTrace); 137 138 private: 139 std::string name_; 140 int32_t taskId_; 141 static std::atomic<std::int32_t> id_; 142 }; 143 144 } // namespace OHOS::Ace 145 146 #endif // FOUNDATION_ACE_FRAMEWORKS_BASE_LOG_ACE_TRACE_H 147