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