• 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_BUTT,
34 };
35 
36 static constexpr unsigned int BASE_TIME_DOMAIN_ID = 0xD001C40;
37 
38 enum TimeDomainId : int32_t {
39     TIME_INNERKIT_DOMAIN = BASE_TIME_DOMAIN_ID + TIME_MODULE_INNERKIT,
40     TIME_CLIENT_DOMAIN,
41     TIME_SERVICE_DOMAIN,
42     TIME_JAVAKIT_DOMAIN,
43     TIME_JNI_DOMAIN,
44     TIME_COMMON_DOMAIN,
45     TIME_JS_NAPI,
46     TIME_BUTT,
47 };
48 
49 static constexpr OHOS::HiviewDFX::HiLogLabel TIME_MODULE_LABEL[TIME_MODULE_BUTT] = {
50     { LOG_CORE, TIME_INNERKIT_DOMAIN, "TimeInnerKit" },
51     { LOG_CORE, TIME_CLIENT_DOMAIN, "TimeClient" },
52     { LOG_CORE, TIME_SERVICE_DOMAIN, "TimeService" },
53     { LOG_CORE, TIME_JAVAKIT_DOMAIN, "TimeJavaKit" },
54     { LOG_CORE, TIME_JNI_DOMAIN, "TimeJni" },
55     { LOG_CORE, TIME_COMMON_DOMAIN, "TimeCommon" },
56     { LOG_CORE, TIME_JS_NAPI, "TimeJSNAPI" },
57 };
58 
59 #define R_FORMATED(fmt, ...) "%{public}s# " fmt, __FUNCTION__, ##__VA_ARGS__
60 
61 // In order to improve performance, do not check the module range.
62 // Besides, make sure module is less than TIME_MODULE_BUTT.
63 #define TIME_HILOGF(module, fmt, ...) (void)HILOG_IMPL(LOG_CORE, LOG_FATAL, TIME_MODULE_LABEL[module].domain, \
64     TIME_MODULE_LABEL[module].tag, "%{public}s# " fmt, __FUNCTION__, ##__VA_ARGS__)
65 #define TIME_HILOGE(module, fmt, ...) (void)HILOG_IMPL(LOG_CORE, LOG_ERROR, TIME_MODULE_LABEL[module].domain, \
66     TIME_MODULE_LABEL[module].tag, "%{public}s# " fmt, __FUNCTION__, ##__VA_ARGS__)
67 #define TIME_HILOGW(module, fmt, ...) (void)HILOG_IMPL(LOG_CORE, LOG_WARN, TIME_MODULE_LABEL[module].domain, \
68     TIME_MODULE_LABEL[module].tag, "%{public}s# " fmt, __FUNCTION__, ##__VA_ARGS__)
69 #define TIME_HILOGI(module, fmt, ...) (void)HILOG_IMPL(LOG_CORE, LOG_INFO, TIME_MODULE_LABEL[module].domain, \
70     TIME_MODULE_LABEL[module].tag, "%{public}s# " fmt, __FUNCTION__, ##__VA_ARGS__)
71 #ifdef DEBUG_ENABLE
72 #define TIME_HILOGD(module, fmt, ...) (void)HILOG_IMPL(LOG_CORE, LOG_DEBUG, TIME_MODULE_LABEL[module].domain, \
73     TIME_MODULE_LABEL[module].tag, "%{public}s# " fmt, __FUNCTION__, ##__VA_ARGS__)
74 #else
75 #define TIME_HILOGD(module, fmt, ...)
76 #endif
77 
78 #define TIME_SIMPLIFY_HILOGI(module, fmt, ...) (void)HILOG_IMPL(LOG_CORE, LOG_INFO, TIME_MODULE_LABEL[module].domain, \
79     TIME_MODULE_LABEL[module].tag, fmt, ##__VA_ARGS__)
80 #define TIME_SIMPLIFY_HILOGW(module, fmt, ...) (void)HILOG_IMPL(LOG_CORE, LOG_WARN, TIME_MODULE_LABEL[module].domain, \
81     TIME_MODULE_LABEL[module].tag, fmt, ##__VA_ARGS__)
82 
83 #define CHECK_AND_RETURN_RET_LOG(module, cond, ret, ...)  \
84     do {                                                  \
85         if (!(cond)) {                                    \
86             TIME_HILOGE(module, R_FORMATED(__VA_ARGS__)); \
87             return ret;                                   \
88         }                                                 \
89     } while (0)
90 
91 #define CHECK_AND_RETURN_LOG(module, cond, ...)           \
92     do {                                                  \
93         if (!(cond)) {                                    \
94             TIME_HILOGE(module, R_FORMATED(__VA_ARGS__)); \
95             return;                                       \
96         }                                                 \
97     } while (0)
98 
99 } // namespace MiscServices
100 } // namespace OHOS
101 #endif // TIME_HILOG_WRAPPER_H