1 /* 2 * Copyright (c) 2014-2019 The Linux Foundation. All rights reserved. 3 * 4 * Permission to use, copy, modify, and/or distribute this software for 5 * any purpose with or without fee is hereby granted, provided that the 6 * above copyright notice and this permission notice appear in all 7 * copies. 8 * 9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 10 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 11 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 12 * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 13 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 14 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 15 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 16 * PERFORMANCE OF THIS SOFTWARE. 17 */ 18 19 /** 20 * DOC: i_qdf_trace.h 21 * 22 * Linux-specific definitions for QDF trace 23 * 24 */ 25 26 #if !defined(__I_QDF_TRACE_H) 27 #define __I_QDF_TRACE_H 28 29 /* older kernels have a bug in kallsyms, so ensure module.h is included */ 30 #include <linux/module.h> 31 #include <linux/kallsyms.h> 32 #ifdef CONFIG_QCA_MINIDUMP 33 #include <linux/minidump_tlv.h> 34 #endif 35 36 #if !defined(__printf) 37 #define __printf(a, b) 38 #endif 39 40 /* QDF_TRACE is the macro invoked to add trace messages to code. See the 41 * documenation for qdf_trace_msg() for the parameters etc. for this function. 42 * 43 * NOTE: Code QDF_TRACE() macros into the source code. Do not code directly 44 * to the qdf_trace_msg() function. 45 * 46 * NOTE 2: qdf tracing is totally turned off if WLAN_DEBUG is *not* defined. 47 * This allows us to build 'performance' builds where we can measure performance 48 * without being bogged down by all the tracing in the code 49 */ 50 #if defined(QDF_TRACE_PRINT_ENABLE) 51 #define qdf_trace(log_level, args...) \ 52 do { \ 53 extern int qdf_dbg_mask; \ 54 if (qdf_dbg_mask >= log_level) { \ 55 printk(args); \ 56 printk("\n"); \ 57 } \ 58 } while (0) 59 #endif 60 61 #if defined(WLAN_DEBUG) || defined(DEBUG) || defined(QDF_TRACE_PRINT_ENABLE) 62 #define QDF_TRACE qdf_trace_msg 63 #define QDF_VTRACE qdf_vtrace_msg 64 #define QDF_TRACE_HEX_DUMP qdf_trace_hex_dump 65 #else 66 #define QDF_TRACE(arg ...) __qdf_trace_dummy(arg) 67 #define QDF_VTRACE(arg ...) __qdf_vtrace_dummy(arg) 68 #define QDF_TRACE_HEX_DUMP(arg ...) __qdf_trace_hexdump_dummy(arg) 69 #endif 70 71 #if defined(WLAN_DEBUG) || defined(DEBUG) || defined(QDF_TRACE_PRINT_ENABLE) 72 #define QDF_MAX_LOGS_PER_SEC 2 73 /** 74 * __QDF_TRACE_RATE_LIMITED() - rate limited version of QDF_TRACE 75 * @params: parameters to pass through to QDF_TRACE 76 * 77 * This API prevents logging a message more than QDF_MAX_LOGS_PER_SEC times per 78 * second. This means any subsequent calls to this API from the same location 79 * within 1/QDF_MAX_LOGS_PER_SEC seconds will be dropped. 80 * 81 * Return: None 82 */ 83 #define __QDF_TRACE_RATE_LIMITED(params...)\ 84 do {\ 85 static ulong __last_ticks;\ 86 ulong __ticks = jiffies;\ 87 if (time_after(__ticks,\ 88 __last_ticks + HZ / QDF_MAX_LOGS_PER_SEC)) {\ 89 QDF_TRACE(params);\ 90 __last_ticks = __ticks;\ 91 } \ 92 } while (0) 93 #else 94 #define __QDF_TRACE_RATE_LIMITED(arg ...) 95 #endif 96 97 #define __QDF_TRACE_NO_FL(log_level, module_id, format, args...) \ 98 QDF_TRACE(module_id, log_level, format, ## args) 99 100 #define __QDF_TRACE_FL(log_level, module_id, format, args...) \ 101 QDF_TRACE(module_id, log_level, FL(format), ## args) 102 103 #define __QDF_TRACE_RL(log_level, module_id, format, args...) \ 104 __QDF_TRACE_RATE_LIMITED(module_id, log_level, FL(format), ## args) 105 106 #define __QDF_TRACE_RL_NO_FL(log_level, module_id, format, args...) \ 107 __QDF_TRACE_RATE_LIMITED(module_id, log_level, format, ## args) 108 109 static inline void __qdf_trace_noop(QDF_MODULE_ID module, 110 const char *format, ...) { } 111 static inline void __qdf_trace_dummy(QDF_MODULE_ID module, 112 QDF_TRACE_LEVEL level, 113 const char *format, ...) { } 114 static inline void __qdf_vtrace_dummy(QDF_MODULE_ID module, 115 QDF_TRACE_LEVEL level, 116 const char *str_format, va_list val) { } 117 static inline void __qdf_trace_hexdump_dummy(QDF_MODULE_ID module, 118 QDF_TRACE_LEVEL level, 119 void *data, int buf_len) { } 120 121 122 #ifdef WLAN_LOG_FATAL 123 #define QDF_TRACE_FATAL(params...) \ 124 __QDF_TRACE_FL(QDF_TRACE_LEVEL_FATAL, ## params) 125 #define QDF_TRACE_FATAL_NO_FL(params...) \ 126 __QDF_TRACE_NO_FL(QDF_TRACE_LEVEL_FATAL, ## params) 127 #define QDF_TRACE_FATAL_RL(params...) \ 128 __QDF_TRACE_RL(QDF_TRACE_LEVEL_FATAL, ## params) 129 #define QDF_TRACE_FATAL_RL_NO_FL(params...) \ 130 __QDF_TRACE_RL_NO_FL(QDF_TRACE_LEVEL_FATAL, ## params) 131 #define QDF_VTRACE_FATAL(module_id, fmt, args) \ 132 QDF_VTRACE(module_id, QDF_TRACE_LEVEL_FATAL, fmt, args) 133 #else 134 #define QDF_TRACE_FATAL(params...) __qdf_trace_noop(params) 135 #define QDF_TRACE_FATAL_NO_FL(params...) __qdf_trace_noop(params) 136 #define QDF_TRACE_FATAL_RL(params...) __qdf_trace_noop(params) 137 #define QDF_TRACE_FATAL_RL_NO_FL(params...) __qdf_trace_noop(params) 138 #define QDF_VTRACE_FATAL(params...) __qdf_trace_noop(params) 139 #endif 140 141 #ifdef WLAN_LOG_ERROR 142 #define QDF_TRACE_ERROR(params...) \ 143 __QDF_TRACE_FL(QDF_TRACE_LEVEL_ERROR, ## params) 144 #define QDF_TRACE_ERROR_NO_FL(params...) \ 145 __QDF_TRACE_NO_FL(QDF_TRACE_LEVEL_ERROR, ## params) 146 #define QDF_TRACE_ERROR_RL(params...) \ 147 __QDF_TRACE_RL(QDF_TRACE_LEVEL_ERROR, ## params) 148 #define QDF_TRACE_ERROR_RL_NO_FL(params...) \ 149 __QDF_TRACE_RL_NO_FL(QDF_TRACE_LEVEL_ERROR, ## params) 150 #define QDF_VTRACE_ERROR(module_id, fmt, args) \ 151 QDF_VTRACE(module_id, QDF_TRACE_LEVEL_ERROR, fmt, args) 152 #else 153 #define QDF_TRACE_ERROR(params...) __qdf_trace_noop(params) 154 #define QDF_TRACE_ERROR_NO_FL(params...) __qdf_trace_noop(params) 155 #define QDF_TRACE_ERROR_RL(params...) __qdf_trace_noop(params) 156 #define QDF_TRACE_ERROR_RL_NO_FL(params...) __qdf_trace_noop(params) 157 #define QDF_VTRACE_ERROR(params...) __qdf_trace_noop(params) 158 #endif 159 160 #ifdef WLAN_LOG_WARN 161 #define QDF_TRACE_WARN(params...) \ 162 __QDF_TRACE_FL(QDF_TRACE_LEVEL_WARN, ## params) 163 #define QDF_TRACE_WARN_NO_FL(params...) \ 164 __QDF_TRACE_NO_FL(QDF_TRACE_LEVEL_WARN, ## params) 165 #define QDF_TRACE_WARN_RL(params...) \ 166 __QDF_TRACE_RL(QDF_TRACE_LEVEL_WARN, ## params) 167 #define QDF_TRACE_WARN_RL_NO_FL(params...) \ 168 __QDF_TRACE_RL_NO_FL(QDF_TRACE_LEVEL_WARN, ## params) 169 #define QDF_VTRACE_WARN(module_id, fmt, args) \ 170 QDF_VTRACE(module_id, QDF_TRACE_LEVEL_WARN, fmt, args) 171 #else 172 #define QDF_TRACE_WARN(params...) __qdf_trace_noop(params) 173 #define QDF_TRACE_WARN_NO_FL(params...) __qdf_trace_noop(params) 174 #define QDF_TRACE_WARN_RL(params...) __qdf_trace_noop(params) 175 #define QDF_TRACE_WARN_RL_NO_FL(params...) __qdf_trace_noop(params) 176 #define QDF_VTRACE_WARN(params...) __qdf_trace_noop(params) 177 #endif 178 179 #ifdef WLAN_LOG_INFO 180 #define QDF_TRACE_INFO(params...) \ 181 __QDF_TRACE_FL(QDF_TRACE_LEVEL_INFO, ## params) 182 #define QDF_TRACE_INFO_NO_FL(params...) \ 183 __QDF_TRACE_NO_FL(QDF_TRACE_LEVEL_INFO, ## params) 184 #define QDF_TRACE_INFO_RL(params...) \ 185 __QDF_TRACE_RL(QDF_TRACE_LEVEL_INFO, ## params) 186 #define QDF_TRACE_INFO_RL_NO_FL(params...) \ 187 __QDF_TRACE_RL_NO_FL(QDF_TRACE_LEVEL_INFO, ## params) 188 #define QDF_VTRACE_INFO(module_id, fmt, args) \ 189 QDF_VTRACE(module_id, QDF_TRACE_LEVEL_INFO, fmt, args) 190 #else 191 #define QDF_TRACE_INFO(params...) __qdf_trace_noop(params) 192 #define QDF_TRACE_INFO_NO_FL(params...) __qdf_trace_noop(params) 193 #define QDF_TRACE_INFO_RL(params...) __qdf_trace_noop(params) 194 #define QDF_TRACE_INFO_RL_NO_FL(params...) __qdf_trace_noop(params) 195 #define QDF_VTRACE_INFO(params...) __qdf_trace_noop(params) 196 #endif 197 198 #ifdef WLAN_LOG_DEBUG 199 #define QDF_TRACE_DEBUG(params...) \ 200 __QDF_TRACE_FL(QDF_TRACE_LEVEL_DEBUG, ## params) 201 #define QDF_TRACE_DEBUG_NO_FL(params...) \ 202 __QDF_TRACE_NO_FL(QDF_TRACE_LEVEL_DEBUG, ## params) 203 #define QDF_TRACE_DEBUG_RL(params...) \ 204 __QDF_TRACE_RL(QDF_TRACE_LEVEL_DEBUG, ## params) 205 #define QDF_TRACE_DEBUG_RL_NO_FL(params...) \ 206 __QDF_TRACE_RL_NO_FL(QDF_TRACE_LEVEL_DEBUG, ## params) 207 #define QDF_VTRACE_DEBUG(module_id, fmt, args) \ 208 QDF_VTRACE(module_id, QDF_TRACE_LEVEL_DEBUG, fmt, args) 209 #else 210 #define QDF_TRACE_DEBUG(params...) __qdf_trace_noop(params) 211 #define QDF_TRACE_DEBUG_NO_FL(params...) __qdf_trace_noop(params) 212 #define QDF_TRACE_DEBUG_RL(params...) __qdf_trace_noop(params) 213 #define QDF_TRACE_DEBUG_RL_NO_FL(params...) __qdf_trace_noop(params) 214 #define QDF_VTRACE_DEBUG(params...) __qdf_trace_noop(params) 215 #endif 216 217 #ifdef WLAN_LOG_ENTER 218 #define QDF_TRACE_ENTER(params...) \ 219 __QDF_TRACE_FL(QDF_TRACE_LEVEL_DEBUG, ## params) 220 #else 221 #define QDF_TRACE_ENTER(params...) __qdf_trace_noop(params) 222 #endif 223 224 #ifdef WLAN_LOG_EXIT 225 #define QDF_TRACE_EXIT(params...) \ 226 __QDF_TRACE_FL(QDF_TRACE_LEVEL_DEBUG, ## params) 227 #else 228 #define QDF_TRACE_EXIT(params...) __qdf_trace_noop(params) 229 #endif 230 231 #define QDF_ENABLE_TRACING 232 #define qdf_scnprintf scnprintf 233 234 #ifdef QDF_ENABLE_TRACING 235 236 #ifdef WLAN_WARN_ON_ASSERT 237 #define QDF_ASSERT(_condition) \ 238 do { \ 239 if (!(_condition)) { \ 240 pr_err("QDF ASSERT in %s Line %d\n", \ 241 __func__, __LINE__); \ 242 WARN_ON(1); \ 243 } \ 244 } while (0) 245 #else 246 #define QDF_ASSERT(_condition) \ 247 do { \ 248 if (!(_condition)) { \ 249 /* no-op */ \ 250 } \ 251 } while (0) 252 #endif /* WLAN_WARN_ON_ASSERT */ 253 /** 254 * qdf_trace_msg()- logging API 255 * @module: Module identifier. A member of the QDF_MODULE_ID enumeration that 256 * identifies the module issuing the trace message. 257 * @level: Trace level. A member of the QDF_TRACE_LEVEL enumeration indicating 258 * the severity of the condition causing the trace message to be issued. 259 * More severe conditions are more likely to be logged. 260 * @str_format: Format string. The message to be logged. This format string 261 * contains printf-like replacement parameters, which follow this 262 * parameter in the variable argument list. 263 * 264 * Users wishing to add tracing information to their code should use 265 * QDF_TRACE. QDF_TRACE() will compile into a call to qdf_trace_msg() when 266 * tracing is enabled. 267 * 268 * Return: nothing 269 * 270 * implemented in qdf_trace.c 271 */ 272 void __printf(3, 4) qdf_trace_msg(QDF_MODULE_ID module, QDF_TRACE_LEVEL level, 273 const char *str_format, ...); 274 275 /** 276 * qdf_vtrace_msg() - the va_list version of qdf_trace_msg 277 * @module: the calling module's Id 278 * @level: the logging level to log using 279 * @str_format: the log format string 280 * @val: the va_list containing the values to format according to str_format 281 * 282 * Return: None 283 */ 284 void qdf_vtrace_msg(QDF_MODULE_ID module, QDF_TRACE_LEVEL level, 285 const char *str_format, va_list val); 286 287 #else 288 289 /* This code will be used for compilation if tracing is to be compiled out */ 290 /* of the code so these functions/macros are 'do nothing' */ 291 static inline void qdf_trace_msg(QDF_MODULE_ID module, QDF_TRACE_LEVEL level, 292 const char *str_format, ...) 293 { 294 } 295 296 #define QDF_ASSERT(_condition) 297 298 #endif 299 300 #ifdef QDF_TRACE_PRINT_ENABLE 301 static inline void qdf_vprint(const char *fmt, va_list args) 302 { 303 QDF_VTRACE_INFO(QDF_MODULE_ID_ANY, fmt, args); 304 } 305 #else /* QDF_TRACE_PRINT_ENABLE */ 306 static inline void qdf_vprint(const char *fmt, va_list args) 307 { 308 QDF_VTRACE_ERROR(QDF_MODULE_ID_QDF, fmt, args); 309 } 310 #endif 311 312 #ifdef PANIC_ON_BUG 313 #ifdef CONFIG_SLUB_DEBUG 314 /** 315 * __qdf_bug() - Calls BUG() when the PANIC_ON_BUG compilation option is enabled 316 * 317 * Note: Calling BUG() can cause a compiler to assume any following code is 318 * unreachable. Because these BUG's may or may not be enabled by the build 319 * configuration, this can cause developers some pain. Consider: 320 * 321 * bool bit; 322 * 323 * if (ptr) 324 * bit = ptr->returns_bool(); 325 * else 326 * __qdf_bug(); 327 * 328 * // do stuff with @bit 329 * 330 * return bit; 331 * 332 * In this case, @bit is potentially uninitialized when we return! However, the 333 * compiler can correctly assume this case is impossible when PANIC_ON_BUG is 334 * enabled. Because developers typically enable this feature, the "maybe 335 * uninitialized" warning will not be emitted, and the bug remains uncaught 336 * until someone tries to make a build without PANIC_ON_BUG. 337 * 338 * A simple workaround for this, is to put the definition of __qdf_bug in 339 * another compilation unit, which prevents the compiler from assuming 340 * subsequent code is unreachable. For CONFIG_SLUB_DEBUG, do this to catch more 341 * bugs. Otherwise, use the typical inlined approach. 342 * 343 * Return: None 344 */ 345 void __qdf_bug(void); 346 #else /* CONFIG_SLUB_DEBUG */ 347 static inline void __qdf_bug(void) 348 { 349 BUG(); 350 } 351 #endif /* CONFIG_SLUB_DEBUG */ 352 353 /** 354 * QDF_DEBUG_PANIC() - In debug builds, panic, otherwise do nothing 355 * @reason_fmt: a format string containing the reason for the panic 356 * @args: zero or more printf compatible logging arguments 357 * 358 * Return: None 359 */ 360 #define QDF_DEBUG_PANIC(reason_fmt, args...) \ 361 QDF_DEBUG_PANIC_FL(__func__, __LINE__, reason_fmt, ## args) 362 363 /** 364 * QDF_DEBUG_PANIC_FL() - In debug builds, panic, otherwise do nothing 365 * @func: origin function name to be logged 366 * @line: origin line number to be logged 367 * @fmt: printf compatible format string to be logged 368 * @args: zero or more printf compatible logging arguments 369 * 370 * Return: None 371 */ 372 #define QDF_DEBUG_PANIC_FL(func, line, fmt, args...) \ 373 do { \ 374 pr_err("WLAN Panic @ %s:%d: " fmt "\n", func, line, ##args); \ 375 __qdf_bug(); \ 376 } while (false) 377 378 #define QDF_BUG(_condition) \ 379 do { \ 380 if (!(_condition)) { \ 381 pr_err("QDF BUG in %s Line %d: Failed assertion '" \ 382 #_condition "'\n", __func__, __LINE__); \ 383 __qdf_bug(); \ 384 } \ 385 } while (0) 386 387 #else /* PANIC_ON_BUG */ 388 389 #define QDF_DEBUG_PANIC(reason...) \ 390 do { \ 391 /* no-op */ \ 392 } while (false) 393 394 #define QDF_DEBUG_PANIC_FL(func, line, fmt, args...) \ 395 do { \ 396 /* no-op */ \ 397 } while (false) 398 399 #define QDF_BUG(_condition) \ 400 do { \ 401 if (!(_condition)) { \ 402 /* no-op */ \ 403 } \ 404 } while (0) 405 406 #endif /* PANIC_ON_BUG */ 407 408 #ifdef KSYM_SYMBOL_LEN 409 #define __QDF_SYMBOL_LEN KSYM_SYMBOL_LEN 410 #else 411 #define __QDF_SYMBOL_LEN 1 412 #endif 413 414 #ifdef CONFIG_QCA_MINIDUMP 415 static inline void 416 __qdf_minidump_log(void *start_addr, size_t size, const char *name) 417 { 418 if (fill_minidump_segments((uintptr_t)start_addr, size, 419 QCA_WDT_LOG_DUMP_TYPE_WLAN_MOD, (char *)name) < 0) 420 QDF_TRACE(QDF_MODULE_ID_QDF, QDF_TRACE_LEVEL_INFO, 421 "%s: failed to log %pK (%s)\n", 422 __func__, start_addr, name); 423 } 424 425 static inline void 426 __qdf_minidump_remove(void *addr) 427 { 428 remove_minidump_segments((uintptr_t)addr); 429 } 430 #else 431 static inline void 432 __qdf_minidump_log(void *start_addr, size_t size, const char *name) {} 433 static inline void 434 __qdf_minidump_remove(void *addr) {} 435 #endif 436 #endif /* __I_QDF_TRACE_H */ 437