1 /* Copyright (c) 2011-2014 The Linux Foundation. All rights reserved.
2 *
3 * Redistribution and use in source and binary forms, with or without
4 * modification, are permitted provided that the following conditions are
5 * met:
6 * * Redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer.
8 * * Redistributions in binary form must reproduce the above
9 * copyright notice, this list of conditions and the following
10 * disclaimer in the documentation and/or other materials provided
11 * with the distribution.
12 * * Neither the name of The Linux Foundation nor the names of its
13 * contributors may be used to endorse or promote products derived
14 * from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
20 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
23 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
25 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
26 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 */
29
30 #ifndef __LOG_UTIL_H__
31 #define __LOG_UTIL_H__
32
33 #include <stdbool.h>
34
35 #if defined (USE_ANDROID_LOGGING) || defined (ANDROID)
36 // Android and LE targets with logcat support
37 #include <utils/Log.h>
38 #include <unistd.h>
39 #include <sys/syscall.h>
40
41 #elif defined (USE_GLIB)
42 // LE targets with no logcat support
43 #include <stdio.h>
44 #include <string.h>
45 #include <sys/types.h>
46 #include <sys/time.h>
47 #include <unistd.h>
48 #include <sys/syscall.h>
49
50 #ifndef LOG_TAG
51 #define LOG_TAG "GPS_UTILS"
52 #endif /* LOG_TAG */
53
54 // LE targets with no logcat support
55 #ifdef FEATURE_EXTERNAL_AP
56 #include <syslog.h>
57 #define ALOGE(...) syslog(LOG_ERR, "LOC_LOGE: " __VA_ARGS__);
58 #define ALOGW(...) syslog(LOG_WARNING, "LOC_LOGW: " __VA_ARGS__);
59 #define ALOGI(...) syslog(LOG_NOTICE, "LOC_LOGI: " __VA_ARGS__);
60 #define ALOGD(...) syslog(LOG_DEBUG, "LOC_LOGD: " __VA_ARGS__);
61 #define ALOGV(...) syslog(LOG_NOTICE, "LOC_LOGV: " __VA_ARGS__);
62 #else /* FEATURE_EXTERNAL_AP */
63 #define TS_PRINTF(format, x...) \
64 { \
65 struct timeval tv; \
66 struct timezone tz; \
67 int hh, mm, ss; \
68 gettimeofday(&tv, &tz); \
69 hh = tv.tv_sec/3600%24; \
70 mm = (tv.tv_sec%3600)/60; \
71 ss = tv.tv_sec%60; \
72 fprintf(stdout,"%02d:%02d:%02d.%06ld]" format "\n", hh, mm, ss, tv.tv_usec, ##x); \
73 }
74
75 #define ALOGE(format, x...) TS_PRINTF("E/%s (%d): " format , LOG_TAG, getpid(), ##x)
76 #define ALOGW(format, x...) TS_PRINTF("W/%s (%d): " format , LOG_TAG, getpid(), ##x)
77 #define ALOGI(format, x...) TS_PRINTF("I/%s (%d): " format , LOG_TAG, getpid(), ##x)
78 #define ALOGD(format, x...) TS_PRINTF("D/%s (%d): " format , LOG_TAG, getpid(), ##x)
79 #define ALOGV(format, x...) TS_PRINTF("V/%s (%d): " format , LOG_TAG, getpid(), ##x)
80 #endif /* FEATURE_EXTERNAL_AP */
81
82 #endif /* #if defined (USE_ANDROID_LOGGING) || defined (ANDROID) */
83
84 #ifdef __cplusplus
85 extern "C"
86 {
87 #endif
88 /*=============================================================================
89 *
90 * LOC LOGGER TYPE DECLARATION
91 *
92 *============================================================================*/
93 /* LOC LOGGER */
94 typedef struct loc_logger_s
95 {
96 unsigned long DEBUG_LEVEL;
97 unsigned long TIMESTAMP;
98 bool LOG_BUFFER_ENABLE;
99 } loc_logger_s_type;
100
101
102 /*=============================================================================
103 *
104 * EXTERNAL DATA
105 *
106 *============================================================================*/
107
108 // Logging Improvements
109 extern const char *loc_logger_boolStr[];
110
111 extern loc_logger_s_type loc_logger;
112 extern const char *boolStr[];
113 extern const char VOID_RET[];
114 extern const char FROM_AFW[];
115 extern const char TO_MODEM[];
116 extern const char FROM_MODEM[];
117 extern const char TO_AFW[];
118 extern const char EXIT_TAG[];
119 extern const char ENTRY_TAG[];
120 extern const char EXIT_ERROR_TAG[];
121
122 /*=============================================================================
123 *
124 * MODULE EXPORTED FUNCTIONS
125 *
126 *============================================================================*/
loc_logger_init(unsigned long debug,unsigned long timestamp)127 inline void loc_logger_init(unsigned long debug, unsigned long timestamp)
128 {
129 loc_logger.DEBUG_LEVEL = debug;
130 #ifdef TARGET_BUILD_VARIANT_USER
131 // force user builds to 2 or less
132 if (loc_logger.DEBUG_LEVEL > 2) {
133 loc_logger.DEBUG_LEVEL = 2;
134 }
135 #endif
136 loc_logger.TIMESTAMP = timestamp;
137 }
138
log_buffer_init(bool enabled)139 inline void log_buffer_init(bool enabled) {
140 loc_logger.LOG_BUFFER_ENABLE = enabled;
141 }
142
143 extern char* get_timestamp(char* str, unsigned long buf_size);
144 extern void log_buffer_insert(char *str, unsigned long buf_size, int level);
145
146 /*=============================================================================
147 *
148 * LOGGING BUFFER MACROS
149 *
150 *============================================================================*/
151 #ifndef LOG_NDEBUG
152 #define LOG_NDEBUG 0
153 #endif
154 #define TOTAL_LOG_LEVELS 5
155 #define LOGGING_BUFFER_MAX_LEN 1024
156 #define IF_LOG_BUFFER_ENABLE if (loc_logger.LOG_BUFFER_ENABLE)
157 #define INSERT_BUFFER(flag, level, format, x...) \
158 { \
159 IF_LOG_BUFFER_ENABLE { \
160 if (flag == 0) { \
161 char timestr[32]; \
162 get_timestamp(timestr, sizeof(timestr)); \
163 char log_str[LOGGING_BUFFER_MAX_LEN]; \
164 snprintf(log_str, LOGGING_BUFFER_MAX_LEN, "%s %d %ld %s :" format "\n", \
165 timestr, getpid(), syscall(SYS_gettid), LOG_TAG==NULL ? "": LOG_TAG, ##x);\
166 log_buffer_insert(log_str, sizeof(log_str), level); \
167 } \
168 } \
169 }
170
171 #ifndef DEBUG_DMN_LOC_API
172
173 /* LOGGING MACROS */
174 /*loc_logger.DEBUG_LEVEL is initialized to 0xff in loc_cfg.cpp
175 if that value remains unchanged, it means gps.conf did not
176 provide a value and we default to the initial value to use
177 Android's logging levels*/
178 #define IF_LOC_LOGE if((loc_logger.DEBUG_LEVEL >= 1) && (loc_logger.DEBUG_LEVEL <= 5))
179 #define IF_LOC_LOGW if((loc_logger.DEBUG_LEVEL >= 2) && (loc_logger.DEBUG_LEVEL <= 5))
180 #define IF_LOC_LOGI if((loc_logger.DEBUG_LEVEL >= 3) && (loc_logger.DEBUG_LEVEL <= 5))
181 #define IF_LOC_LOGD if((loc_logger.DEBUG_LEVEL >= 4) && (loc_logger.DEBUG_LEVEL <= 5))
182 #define IF_LOC_LOGV if((loc_logger.DEBUG_LEVEL >= 5) && (loc_logger.DEBUG_LEVEL <= 5))
183
184 #define LOC_LOGE(...) IF_LOC_LOGE { ALOGE(__VA_ARGS__); INSERT_BUFFER(LOG_NDEBUG, 0, __VA_ARGS__);}
185 #define LOC_LOGW(...) IF_LOC_LOGW { ALOGW(__VA_ARGS__); INSERT_BUFFER(LOG_NDEBUG, 1, __VA_ARGS__);}
186 #define LOC_LOGI(...) IF_LOC_LOGI { ALOGI(__VA_ARGS__); INSERT_BUFFER(LOG_NDEBUG, 2, __VA_ARGS__);}
187 #define LOC_LOGD(...) IF_LOC_LOGD { ALOGD(__VA_ARGS__); INSERT_BUFFER(LOG_NDEBUG, 3, __VA_ARGS__);}
188 #define LOC_LOGV(...) IF_LOC_LOGV { ALOGV(__VA_ARGS__); INSERT_BUFFER(LOG_NDEBUG, 4, __VA_ARGS__);}
189
190 #else /* DEBUG_DMN_LOC_API */
191
192 #define LOC_LOGE(...) ALOGE(__VA_ARGS__)
193 #define LOC_LOGW(...) ALOGW(__VA_ARGS__)
194 #define LOC_LOGI(...) ALOGI(__VA_ARGS__)
195 #define LOC_LOGD(...) ALOGD(__VA_ARGS__)
196 #define LOC_LOGV(...) ALOGV(__VA_ARGS__)
197
198 #endif /* DEBUG_DMN_LOC_API */
199
200 /*=============================================================================
201 *
202 * LOGGING IMPROVEMENT MACROS
203 *
204 *============================================================================*/
205 #define LOG_(LOC_LOG, ID, WHAT, SPEC, VAL) \
206 do { \
207 if (loc_logger.TIMESTAMP) { \
208 char ts[32]; \
209 LOC_LOG("[%s] %s %s line %d " #SPEC, \
210 get_timestamp(ts, sizeof(ts)), ID, WHAT, __LINE__, VAL); \
211 } else { \
212 LOC_LOG("%s %s line %d " #SPEC, \
213 ID, WHAT, __LINE__, VAL); \
214 } \
215 } while(0)
216
217 #define LOC_LOG_HEAD(fmt) "%s:%d] " fmt
218 #define LOC_LOGv(fmt,...) LOC_LOGV(LOC_LOG_HEAD(fmt), __FUNCTION__, __LINE__, ##__VA_ARGS__)
219 #define LOC_LOGw(fmt,...) LOC_LOGW(LOC_LOG_HEAD(fmt), __FUNCTION__, __LINE__, ##__VA_ARGS__)
220 #define LOC_LOGi(fmt,...) LOC_LOGI(LOC_LOG_HEAD(fmt), __FUNCTION__, __LINE__, ##__VA_ARGS__)
221 #define LOC_LOGd(fmt,...) LOC_LOGD(LOC_LOG_HEAD(fmt), __FUNCTION__, __LINE__, ##__VA_ARGS__)
222 #define LOC_LOGe(fmt,...) LOC_LOGE(LOC_LOG_HEAD(fmt), __FUNCTION__, __LINE__, ##__VA_ARGS__)
223
224 #define LOG_I(ID, WHAT, SPEC, VAL) LOG_(LOC_LOGI, ID, WHAT, SPEC, VAL)
225 #define LOG_V(ID, WHAT, SPEC, VAL) LOG_(LOC_LOGV, ID, WHAT, SPEC, VAL)
226 #define LOG_E(ID, WHAT, SPEC, VAL) LOG_(LOC_LOGE, ID, WHAT, SPEC, VAL)
227 #define LOG_D(ID, WHAT, SPEC, VAL) LOG_(LOC_LOGD, ID, WHAT, SPEC, VAL)
228
229 #define ENTRY_LOG() LOG_V(ENTRY_TAG, __FUNCTION__, %s, "")
230 #define EXIT_LOG(SPEC, VAL) LOG_V(EXIT_TAG, __FUNCTION__, SPEC, VAL)
231 #define EXIT_LOG_WITH_ERROR(SPEC, VAL) \
232 if (VAL != 0) { \
233 LOG_E(EXIT_ERROR_TAG, __FUNCTION__, SPEC, VAL); \
234 } else { \
235 LOG_V(EXIT_TAG, __FUNCTION__, SPEC, VAL); \
236 }
237
238
239 // Used for logging callflow from Android Framework
240 #define ENTRY_LOG_CALLFLOW() LOG_I(FROM_AFW, __FUNCTION__, %s, "")
241 // Used for logging callflow to Modem
242 #define EXIT_LOG_CALLFLOW(SPEC, VAL) LOG_I(TO_MODEM, __FUNCTION__, SPEC, VAL)
243 // Used for logging callflow from Modem(TO_MODEM, __FUNCTION__, %s, "")
244 #define MODEM_LOG_CALLFLOW(SPEC, VAL) LOG_I(FROM_MODEM, __FUNCTION__, SPEC, VAL)
245 // Used for logging high frequency callflow from Modem(TO_MODEM, __FUNCTION__, %s, "")
246 #define MODEM_LOG_CALLFLOW_DEBUG(SPEC, VAL) LOG_D(FROM_MODEM, __FUNCTION__, SPEC, VAL)
247 // Used for logging callflow to Android Framework
248 #define CALLBACK_LOG_CALLFLOW(CB, SPEC, VAL) LOG_I(TO_AFW, CB, SPEC, VAL)
249
250 #ifdef __cplusplus
251 }
252 #endif
253
254 #endif // __LOG_UTIL_H__
255