1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /* Copyright (C) 2007-2020 B.A.T.M.A.N. contributors:
3*4882a593Smuzhiyun *
4*4882a593Smuzhiyun * Marek Lindner, Simon Wunderlich
5*4882a593Smuzhiyun */
6*4882a593Smuzhiyun
7*4882a593Smuzhiyun #ifndef _NET_BATMAN_ADV_LOG_H_
8*4882a593Smuzhiyun #define _NET_BATMAN_ADV_LOG_H_
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun #include "main.h"
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun #include <linux/atomic.h>
13*4882a593Smuzhiyun #include <linux/bitops.h>
14*4882a593Smuzhiyun #include <linux/compiler.h>
15*4882a593Smuzhiyun #include <linux/printk.h>
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun #ifdef CONFIG_BATMAN_ADV_DEBUG
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun int batadv_debug_log_setup(struct batadv_priv *bat_priv);
20*4882a593Smuzhiyun void batadv_debug_log_cleanup(struct batadv_priv *bat_priv);
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun #else
23*4882a593Smuzhiyun
batadv_debug_log_setup(struct batadv_priv * bat_priv)24*4882a593Smuzhiyun static inline int batadv_debug_log_setup(struct batadv_priv *bat_priv)
25*4882a593Smuzhiyun {
26*4882a593Smuzhiyun return 0;
27*4882a593Smuzhiyun }
28*4882a593Smuzhiyun
batadv_debug_log_cleanup(struct batadv_priv * bat_priv)29*4882a593Smuzhiyun static inline void batadv_debug_log_cleanup(struct batadv_priv *bat_priv)
30*4882a593Smuzhiyun {
31*4882a593Smuzhiyun }
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun #endif
34*4882a593Smuzhiyun
35*4882a593Smuzhiyun /**
36*4882a593Smuzhiyun * enum batadv_dbg_level - available log levels
37*4882a593Smuzhiyun */
38*4882a593Smuzhiyun enum batadv_dbg_level {
39*4882a593Smuzhiyun /** @BATADV_DBG_BATMAN: OGM and TQ computations related messages */
40*4882a593Smuzhiyun BATADV_DBG_BATMAN = BIT(0),
41*4882a593Smuzhiyun
42*4882a593Smuzhiyun /** @BATADV_DBG_ROUTES: route added / changed / deleted */
43*4882a593Smuzhiyun BATADV_DBG_ROUTES = BIT(1),
44*4882a593Smuzhiyun
45*4882a593Smuzhiyun /** @BATADV_DBG_TT: translation table messages */
46*4882a593Smuzhiyun BATADV_DBG_TT = BIT(2),
47*4882a593Smuzhiyun
48*4882a593Smuzhiyun /** @BATADV_DBG_BLA: bridge loop avoidance messages */
49*4882a593Smuzhiyun BATADV_DBG_BLA = BIT(3),
50*4882a593Smuzhiyun
51*4882a593Smuzhiyun /** @BATADV_DBG_DAT: ARP snooping and DAT related messages */
52*4882a593Smuzhiyun BATADV_DBG_DAT = BIT(4),
53*4882a593Smuzhiyun
54*4882a593Smuzhiyun /** @BATADV_DBG_NC: network coding related messages */
55*4882a593Smuzhiyun BATADV_DBG_NC = BIT(5),
56*4882a593Smuzhiyun
57*4882a593Smuzhiyun /** @BATADV_DBG_MCAST: multicast related messages */
58*4882a593Smuzhiyun BATADV_DBG_MCAST = BIT(6),
59*4882a593Smuzhiyun
60*4882a593Smuzhiyun /** @BATADV_DBG_TP_METER: throughput meter messages */
61*4882a593Smuzhiyun BATADV_DBG_TP_METER = BIT(7),
62*4882a593Smuzhiyun
63*4882a593Smuzhiyun /** @BATADV_DBG_ALL: the union of all the above log levels */
64*4882a593Smuzhiyun BATADV_DBG_ALL = 255,
65*4882a593Smuzhiyun };
66*4882a593Smuzhiyun
67*4882a593Smuzhiyun #ifdef CONFIG_BATMAN_ADV_DEBUG
68*4882a593Smuzhiyun int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...)
69*4882a593Smuzhiyun __printf(2, 3);
70*4882a593Smuzhiyun
71*4882a593Smuzhiyun /**
72*4882a593Smuzhiyun * _batadv_dbg() - Store debug output with(out) rate limiting
73*4882a593Smuzhiyun * @type: type of debug message
74*4882a593Smuzhiyun * @bat_priv: the bat priv with all the soft interface information
75*4882a593Smuzhiyun * @ratelimited: whether output should be rate limited
76*4882a593Smuzhiyun * @fmt: format string
77*4882a593Smuzhiyun * @arg: variable arguments
78*4882a593Smuzhiyun */
79*4882a593Smuzhiyun #define _batadv_dbg(type, bat_priv, ratelimited, fmt, arg...) \
80*4882a593Smuzhiyun do { \
81*4882a593Smuzhiyun struct batadv_priv *__batpriv = (bat_priv); \
82*4882a593Smuzhiyun if (atomic_read(&__batpriv->log_level) & (type) && \
83*4882a593Smuzhiyun (!(ratelimited) || net_ratelimit())) \
84*4882a593Smuzhiyun batadv_debug_log(__batpriv, fmt, ## arg); \
85*4882a593Smuzhiyun } \
86*4882a593Smuzhiyun while (0)
87*4882a593Smuzhiyun #else /* !CONFIG_BATMAN_ADV_DEBUG */
88*4882a593Smuzhiyun __printf(4, 5)
_batadv_dbg(int type __always_unused,struct batadv_priv * bat_priv __always_unused,int ratelimited __always_unused,const char * fmt __always_unused,...)89*4882a593Smuzhiyun static inline void _batadv_dbg(int type __always_unused,
90*4882a593Smuzhiyun struct batadv_priv *bat_priv __always_unused,
91*4882a593Smuzhiyun int ratelimited __always_unused,
92*4882a593Smuzhiyun const char *fmt __always_unused, ...)
93*4882a593Smuzhiyun {
94*4882a593Smuzhiyun }
95*4882a593Smuzhiyun #endif
96*4882a593Smuzhiyun
97*4882a593Smuzhiyun /**
98*4882a593Smuzhiyun * batadv_dbg() - Store debug output without rate limiting
99*4882a593Smuzhiyun * @type: type of debug message
100*4882a593Smuzhiyun * @bat_priv: the bat priv with all the soft interface information
101*4882a593Smuzhiyun * @arg: format string and variable arguments
102*4882a593Smuzhiyun */
103*4882a593Smuzhiyun #define batadv_dbg(type, bat_priv, arg...) \
104*4882a593Smuzhiyun _batadv_dbg(type, bat_priv, 0, ## arg)
105*4882a593Smuzhiyun
106*4882a593Smuzhiyun /**
107*4882a593Smuzhiyun * batadv_dbg_ratelimited() - Store debug output with rate limiting
108*4882a593Smuzhiyun * @type: type of debug message
109*4882a593Smuzhiyun * @bat_priv: the bat priv with all the soft interface information
110*4882a593Smuzhiyun * @arg: format string and variable arguments
111*4882a593Smuzhiyun */
112*4882a593Smuzhiyun #define batadv_dbg_ratelimited(type, bat_priv, arg...) \
113*4882a593Smuzhiyun _batadv_dbg(type, bat_priv, 1, ## arg)
114*4882a593Smuzhiyun
115*4882a593Smuzhiyun /**
116*4882a593Smuzhiyun * batadv_info() - Store message in debug buffer and print it to kmsg buffer
117*4882a593Smuzhiyun * @net_dev: the soft interface net device
118*4882a593Smuzhiyun * @fmt: format string
119*4882a593Smuzhiyun * @arg: variable arguments
120*4882a593Smuzhiyun */
121*4882a593Smuzhiyun #define batadv_info(net_dev, fmt, arg...) \
122*4882a593Smuzhiyun do { \
123*4882a593Smuzhiyun struct net_device *_netdev = (net_dev); \
124*4882a593Smuzhiyun struct batadv_priv *_batpriv = netdev_priv(_netdev); \
125*4882a593Smuzhiyun batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \
126*4882a593Smuzhiyun pr_info("%s: " fmt, _netdev->name, ## arg); \
127*4882a593Smuzhiyun } while (0)
128*4882a593Smuzhiyun
129*4882a593Smuzhiyun /**
130*4882a593Smuzhiyun * batadv_err() - Store error in debug buffer and print it to kmsg buffer
131*4882a593Smuzhiyun * @net_dev: the soft interface net device
132*4882a593Smuzhiyun * @fmt: format string
133*4882a593Smuzhiyun * @arg: variable arguments
134*4882a593Smuzhiyun */
135*4882a593Smuzhiyun #define batadv_err(net_dev, fmt, arg...) \
136*4882a593Smuzhiyun do { \
137*4882a593Smuzhiyun struct net_device *_netdev = (net_dev); \
138*4882a593Smuzhiyun struct batadv_priv *_batpriv = netdev_priv(_netdev); \
139*4882a593Smuzhiyun batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \
140*4882a593Smuzhiyun pr_err("%s: " fmt, _netdev->name, ## arg); \
141*4882a593Smuzhiyun } while (0)
142*4882a593Smuzhiyun
143*4882a593Smuzhiyun #endif /* _NET_BATMAN_ADV_LOG_H_ */
144