• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 TIME_HILOG_WRAPPER_H
17 #define TIME_HILOG_WRAPPER_H
18 
19 #include "hilog/log.h"
20 #include <cstdint>
21 
22 namespace OHOS {
23 namespace MiscServices {
24 // param of log interface, such as TIME_HILOGF.
25 enum TimeSubModule : int8_t {
26     TIME_MODULE_INNERKIT = 0,
27     TIME_MODULE_CLIENT,
28     TIME_MODULE_SERVICE,
29     TIME_MODULE_JAVAKIT, // java kit, defined to avoid repeated use of domain.
30     TIME_MODULE_JNI,
31     TIME_MODULE_COMMON,
32     TIME_MODULE_JS_NAPI,
33     TIME_MODULE_JS_ANI,
34     TIME_MODULE_BUTT,
35 };
36 
37 static constexpr unsigned int BASE_TIME_DOMAIN_ID = 0xD001C40;
38 
39 enum TimeDomainId : int32_t {
40     TIME_INNERKIT_DOMAIN = BASE_TIME_DOMAIN_ID + TIME_MODULE_INNERKIT,
41     TIME_CLIENT_DOMAIN,
42     TIME_SERVICE_DOMAIN,
43     TIME_JAVAKIT_DOMAIN,
44     TIME_JNI_DOMAIN,
45     TIME_COMMON_DOMAIN,
46     TIME_JS_NAPI,
47     TIME_JS_ANI,
48     TIME_BUTT,
49 };
50 
51 static constexpr OHOS::HiviewDFX::HiLogLabel TIME_MODULE_LABEL[TIME_MODULE_BUTT] = {
52     { LOG_CORE, TIME_INNERKIT_DOMAIN, "TimeInnerKit" },
53     { LOG_CORE, TIME_CLIENT_DOMAIN, "TimeClient" },
54     { LOG_CORE, TIME_SERVICE_DOMAIN, "TimeService" },
55     { LOG_CORE, TIME_JAVAKIT_DOMAIN, "TimeJavaKit" },
56     { LOG_CORE, TIME_JNI_DOMAIN, "TimeJni" },
57     { LOG_CORE, TIME_COMMON_DOMAIN, "TimeCommon" },
58     { LOG_CORE, TIME_JS_NAPI, "TimeJSNAPI" },
59     { LOG_CORE, TIME_JS_ANI, "TimeJSANI" },
60 };
61 
62 #define R_FORMATED(fmt, ...) "%{public}s# " fmt, __FUNCTION__, ##__VA_ARGS__
63 
64 // In order to improve performance, do not check the module range.
65 // Besides, make sure module is less than TIME_MODULE_BUTT.
66 #define TIME_HILOGF(module, fmt, ...) (void)HILOG_IMPL(LOG_CORE, LOG_FATAL, TIME_MODULE_LABEL[module].domain, \
67     TIME_MODULE_LABEL[module].tag, "%{public}s# " fmt, __FUNCTION__, ##__VA_ARGS__)
68 #define TIME_HILOGE(module, fmt, ...) (void)HILOG_IMPL(LOG_CORE, LOG_ERROR, TIME_MODULE_LABEL[module].domain, \
69     TIME_MODULE_LABEL[module].tag, "%{public}s# " fmt, __FUNCTION__, ##__VA_ARGS__)
70 #define TIME_HILOGW(module, fmt, ...) (void)HILOG_IMPL(LOG_CORE, LOG_WARN, TIME_MODULE_LABEL[module].domain, \
71     TIME_MODULE_LABEL[module].tag, "%{public}s# " fmt, __FUNCTION__, ##__VA_ARGS__)
72 #define TIME_HILOGI(module, fmt, ...) (void)HILOG_IMPL(LOG_CORE, LOG_INFO, TIME_MODULE_LABEL[module].domain, \
73     TIME_MODULE_LABEL[module].tag, "%{public}s# " fmt, __FUNCTION__, ##__VA_ARGS__)
74 #ifdef DEBUG_ENABLE
75 #define TIME_HILOGD(module, fmt, ...) (void)HILOG_IMPL(LOG_CORE, LOG_DEBUG, TIME_MODULE_LABEL[module].domain, \
76     TIME_MODULE_LABEL[module].tag, "%{public}s# " fmt, __FUNCTION__, ##__VA_ARGS__)
77 #else
78 #define TIME_HILOGD(module, fmt, ...)
79 #endif
80 
81 #define TIME_SIMPLIFY_HILOGI(module, fmt, ...) (void)HILOG_IMPL(LOG_CORE, LOG_INFO, TIME_MODULE_LABEL[module].domain, \
82     TIME_MODULE_LABEL[module].tag, fmt, ##__VA_ARGS__)
83 #define TIME_SIMPLIFY_HILOGW(module, fmt, ...) (void)HILOG_IMPL(LOG_CORE, LOG_WARN, TIME_MODULE_LABEL[module].domain, \
84     TIME_MODULE_LABEL[module].tag, fmt, ##__VA_ARGS__)
85 
86 #define CHECK_AND_RETURN_RET_LOG(module, cond, ret, ...)  \
87     do {                                                  \
88         if (!(cond)) {                                    \
89             TIME_HILOGE(module, R_FORMATED(__VA_ARGS__)); \
90             return ret;                                   \
91         }                                                 \
92     } while (0)
93 
94 #define CHECK_AND_RETURN_LOG(module, cond, ...)           \
95     do {                                                  \
96         if (!(cond)) {                                    \
97             TIME_HILOGE(module, R_FORMATED(__VA_ARGS__)); \
98             return;                                       \
99         }                                                 \
100     } while (0)
101 
102 } // namespace MiscServices
103 } // namespace OHOS
104 #endif // TIME_HILOG_WRAPPER_H