[linux-2.6-block.git] / net / batman-adv / log.h

/* SPDX-License-Identifier: GPL-2.0 */
/* Copyright (C) 2007-2017  B.A.T.M.A.N. contributors:
 *
 * Marek Lindner, Simon Wunderlich
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _NET_BATMAN_ADV_LOG_H_
#define _NET_BATMAN_ADV_LOG_H_

#include "main.h"

#include <linux/bitops.h>
#include <linux/compiler.h>
#include <linux/printk.h>

#ifdef CONFIG_BATMAN_ADV_DEBUG

int batadv_debug_log_setup(struct batadv_priv *bat_priv);
void batadv_debug_log_cleanup(struct batadv_priv *bat_priv);

#else

static inline int batadv_debug_log_setup(struct batadv_priv *bat_priv)
{
	return 0;
}

static inline void batadv_debug_log_cleanup(struct batadv_priv *bat_priv)
{
}

#endif

/**
 * enum batadv_dbg_level - available log levels
 */
enum batadv_dbg_level {
	/** @BATADV_DBG_BATMAN: OGM and TQ computations related messages */
	BATADV_DBG_BATMAN	= BIT(0),

	/** @BATADV_DBG_ROUTES: route added / changed / deleted */
	BATADV_DBG_ROUTES	= BIT(1),

	/** @BATADV_DBG_TT: translation table messages */
	BATADV_DBG_TT		= BIT(2),

	/** @BATADV_DBG_BLA: bridge loop avoidance messages */
	BATADV_DBG_BLA		= BIT(3),

	/** @BATADV_DBG_DAT: ARP snooping and DAT related messages */
	BATADV_DBG_DAT		= BIT(4),

	/** @BATADV_DBG_NC: network coding related messages */
	BATADV_DBG_NC		= BIT(5),

	/** @BATADV_DBG_MCAST: multicast related messages */
	BATADV_DBG_MCAST	= BIT(6),

	/** @BATADV_DBG_TP_METER: throughput meter messages */
	BATADV_DBG_TP_METER	= BIT(7),

	/** @BATADV_DBG_ALL: the union of all the above log levels */
	BATADV_DBG_ALL		= 255,
};

#ifdef CONFIG_BATMAN_ADV_DEBUG
int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...)
__printf(2, 3);

/**
 * _batadv_dbg() - Store debug output with(out) ratelimiting
 * @type: type of debug message
 * @bat_priv: the bat priv with all the soft interface information
 * @ratelimited: whether output should be rate limited
 * @fmt: format string
 * @arg...: variable arguments
 */
#define _batadv_dbg(type, bat_priv, ratelimited, fmt, arg...)		\
	do {								\
		struct batadv_priv *__batpriv = (bat_priv);		\
		if (atomic_read(&__batpriv->log_level) & (type) &&	\
		    (!(ratelimited) || net_ratelimit()))		\
			batadv_debug_log(__batpriv, fmt, ## arg);	\
	}								\
	while (0)
#else /* !CONFIG_BATMAN_ADV_DEBUG */
__printf(4, 5)
static inline void _batadv_dbg(int type __always_unused,
			       struct batadv_priv *bat_priv __always_unused,
			       int ratelimited __always_unused,
			       const char *fmt __always_unused, ...)
{
}
#endif

/**
 * batadv_dbg() - Store debug output without ratelimiting
 * @type: type of debug message
 * @bat_priv: the bat priv with all the soft interface information
 * @arg...: format string and variable arguments
 */
#define batadv_dbg(type, bat_priv, arg...) \
	_batadv_dbg(type, bat_priv, 0, ## arg)

/**
 * batadv_dbg_ratelimited() - Store debug output with ratelimiting
 * @type: type of debug message
 * @bat_priv: the bat priv with all the soft interface information
 * @arg...: format string and variable arguments
 */
#define batadv_dbg_ratelimited(type, bat_priv, arg...) \
	_batadv_dbg(type, bat_priv, 1, ## arg)

/**
 * batadv_info() - Store message in debug buffer and print it to kmsg buffer
 * @net_dev: the soft interface net device
 * @fmt: format string
 * @arg...: variable arguments
 */
#define batadv_info(net_dev, fmt, arg...)				\
	do {								\
		struct net_device *_netdev = (net_dev);                 \
		struct batadv_priv *_batpriv = netdev_priv(_netdev);    \
		batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg);	\
		pr_info("%s: " fmt, _netdev->name, ## arg);		\
	} while (0)

/**
 * batadv_err() - Store error in debug buffer and print it to kmsg buffer
 * @net_dev: the soft interface net device
 * @fmt: format string
 * @arg...: variable arguments
 */
#define batadv_err(net_dev, fmt, arg...)				\
	do {								\
		struct net_device *_netdev = (net_dev);                 \
		struct batadv_priv *_batpriv = netdev_priv(_netdev);    \
		batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg);	\
		pr_err("%s: " fmt, _netdev->name, ## arg);		\
	} while (0)

#endif /* _NET_BATMAN_ADV_LOG_H_ */
Commit	Line	Data
7db7d9f3	1	/* SPDX-License-Identifier: GPL-2.0 */
ac79cbb9	2	/* Copyright (C) 2007-2017 B.A.T.M.A.N. contributors:
ba412080 SE	3	*
	4	* Marek Lindner, Simon Wunderlich
	5	*
	6	* This program is free software; you can redistribute it and/or
	7	* modify it under the terms of version 2 of the GNU General Public
	8	* License as published by the Free Software Foundation.
	9	*
	10	* This program is distributed in the hope that it will be useful, but
	11	* WITHOUT ANY WARRANTY; without even the implied warranty of
	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	13	* General Public License for more details.
	14	*
	15	* You should have received a copy of the GNU General Public License
	16	* along with this program; if not, see <http://www.gnu.org/licenses/>.
	17	*/
	18
	19	#ifndef _NET_BATMAN_ADV_LOG_H_
	20	#define _NET_BATMAN_ADV_LOG_H_
	21
	22	#include "main.h"
	23
	24	#include <linux/bitops.h>
	25	#include <linux/compiler.h>
	26	#include <linux/printk.h>
	27
	28	#ifdef CONFIG_BATMAN_ADV_DEBUG
	29
	30	int batadv_debug_log_setup(struct batadv_priv *bat_priv);
	31	void batadv_debug_log_cleanup(struct batadv_priv *bat_priv);
	32
	33	#else
	34
	35	static inline int batadv_debug_log_setup(struct batadv_priv *bat_priv)
	36	{
	37	return 0;
	38	}
	39
	40	static inline void batadv_debug_log_cleanup(struct batadv_priv *bat_priv)
	41	{
	42	}
	43
	44	#endif
	45
	46	/**
	47	* enum batadv_dbg_level - available log levels
ba412080 SE	48	*/
ba412080 SE	49	enum batadv_dbg_level {
8b84cc4f	50	/** @BATADV_DBG_BATMAN: OGM and TQ computations related messages */
33a3bb4a	51	BATADV_DBG_BATMAN = BIT(0),
8b84cc4f SE	52
8b84cc4f SE	53	/** @BATADV_DBG_ROUTES: route added / changed / deleted */
33a3bb4a	54	BATADV_DBG_ROUTES = BIT(1),
8b84cc4f SE	55
8b84cc4f SE	56	/** @BATADV_DBG_TT: translation table messages */
33a3bb4a	57	BATADV_DBG_TT = BIT(2),
8b84cc4f SE	58
8b84cc4f SE	59	/** @BATADV_DBG_BLA: bridge loop avoidance messages */
33a3bb4a	60	BATADV_DBG_BLA = BIT(3),
8b84cc4f SE	61
8b84cc4f SE	62	/** @BATADV_DBG_DAT: ARP snooping and DAT related messages */
33a3bb4a	63	BATADV_DBG_DAT = BIT(4),
8b84cc4f SE	64
8b84cc4f SE	65	/** @BATADV_DBG_NC: network coding related messages */
33a3bb4a	66	BATADV_DBG_NC = BIT(5),
8b84cc4f SE	67
8b84cc4f SE	68	/** @BATADV_DBG_MCAST: multicast related messages */
33a3bb4a	69	BATADV_DBG_MCAST = BIT(6),
8b84cc4f SE	70
8b84cc4f SE	71	/** @BATADV_DBG_TP_METER: throughput meter messages */
33a3bb4a	72	BATADV_DBG_TP_METER = BIT(7),
8b84cc4f SE	73
8b84cc4f SE	74	/** @BATADV_DBG_ALL: the union of all the above log levels */
611b975b	75	BATADV_DBG_ALL = 255,
ba412080 SE	76	};
	77
	78	#ifdef CONFIG_BATMAN_ADV_DEBUG
	79	int batadv_debug_log(struct batadv_priv bat_priv, const char fmt, ...)
	80	__printf(2, 3);
	81
e57acf8e SE	82	/**
	83	* _batadv_dbg() - Store debug output with(out) ratelimiting
	84	* @type: type of debug message
	85	* @bat_priv: the bat priv with all the soft interface information
	86	* @ratelimited: whether output should be rate limited
	87	* @fmt: format string
	88	* @arg...: variable arguments
	89	*/
4c7da0f6 SE	90	#define _batadv_dbg(type, bat_priv, ratelimited, fmt, arg...) \
4c7da0f6 SE	91	do { \
a09c94d0 SE	92	struct batadv_priv *__batpriv = (bat_priv); \
a09c94d0 SE	93	if (atomic_read(&__batpriv->log_level) & (type) && \
4c7da0f6	94	(!(ratelimited) \|\| net_ratelimit())) \
a09c94d0	95	batadv_debug_log(__batpriv, fmt, ## arg); \
4c7da0f6	96	} \
ba412080 SE	97	while (0)
	98	#else /* !CONFIG_BATMAN_ADV_DEBUG */
	99	__printf(4, 5)
	100	static inline void _batadv_dbg(int type __always_unused,
	101	struct batadv_priv *bat_priv __always_unused,
	102	int ratelimited __always_unused,
	103	const char *fmt __always_unused, ...)
	104	{
	105	}
	106	#endif
	107
e57acf8e SE	108	/**
	109	* batadv_dbg() - Store debug output without ratelimiting
	110	* @type: type of debug message
	111	* @bat_priv: the bat priv with all the soft interface information
	112	* @arg...: format string and variable arguments
	113	*/
ba412080 SE	114	#define batadv_dbg(type, bat_priv, arg...) \
ba412080 SE	115	_batadv_dbg(type, bat_priv, 0, ## arg)
e57acf8e SE	116
	117	/**
	118	* batadv_dbg_ratelimited() - Store debug output with ratelimiting
	119	* @type: type of debug message
	120	* @bat_priv: the bat priv with all the soft interface information
	121	* @arg...: format string and variable arguments
	122	*/
ba412080 SE	123	#define batadv_dbg_ratelimited(type, bat_priv, arg...) \
	124	_batadv_dbg(type, bat_priv, 1, ## arg)
	125
e57acf8e SE	126	/**
	127	* batadv_info() - Store message in debug buffer and print it to kmsg buffer
	128	* @net_dev: the soft interface net device
	129	* @fmt: format string
	130	* @arg...: variable arguments
	131	*/
ba412080 SE	132	#define batadv_info(net_dev, fmt, arg...) \
	133	do { \
	134	struct net_device *_netdev = (net_dev); \
	135	struct batadv_priv *_batpriv = netdev_priv(_netdev); \
	136	batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \
	137	pr_info("%s: " fmt, _netdev->name, ## arg); \
	138	} while (0)
e57acf8e SE	139
	140	/**
	141	* batadv_err() - Store error in debug buffer and print it to kmsg buffer
	142	* @net_dev: the soft interface net device
	143	* @fmt: format string
	144	* @arg...: variable arguments
	145	*/
ba412080 SE	146	#define batadv_err(net_dev, fmt, arg...) \
	147	do { \
	148	struct net_device *_netdev = (net_dev); \
	149	struct batadv_priv *_batpriv = netdev_priv(_netdev); \
	150	batadv_dbg(BATADV_DBG_ALL, _batpriv, fmt, ## arg); \
	151	pr_err("%s: " fmt, _netdev->name, ## arg); \
	152	} while (0)
	153
	154	#endif /* _NET_BATMAN_ADV_LOG_H_ */