xref: /freebsd/sys/netlink/netlink_debug.h (revision 96190b4fef3b4a0cc3ca0606b0c4e3e69a5e6717)
1 /*-
2  * Copyright (c) 2022 Alexander V. Chernikov <melifaro@FreeBSD.org>
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  * 3. Neither the name of the University nor the names of its contributors
13  *    may be used to endorse or promote products derived from this software
14  *    without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef _NETLINK_NETLINK_DEBUG_H_
30 #define	_NETLINK_NETLINK_DEBUG_H_
31 
32 #ifdef _KERNEL
33 
34 #define	_DEBUG_SYSCTL_OID	_net_netlink_debug
35 #include <net/route/route_debug.h>
36 
37 SYSCTL_DECL(_net_netlink_debug);
38 
39 /*
40  * Generic debug
41  * [nl_domain] func_name: debug text
42  */
43 #define	NL_LOG	RT_LOG
44 
45 /*
46  * Logging for events specific for particular process
47  * Example: [nl_domain] PID 4834 fdump_sa: unsupported family: 45
48  */
49 #define	NL_RAW_PID_LOG(_l, _pid, _fmt, ...)		\
50 	NL_RAW_PID_LOG_##_l(_l, _pid, _fmt, ## __VA_ARGS__)
51 #define	_NL_RAW_PID_LOG(_l, _pid, _fmt, ...)		\
52 	if (_DEBUG_PASS_MSG(_l)) {			\
53 		_output("[" DEBUG_PREFIX_NAME "] PID %u %s: " _fmt "\n", _pid, \
54 		    __func__, ##__VA_ARGS__);		\
55 	}
56 
57 #define	NLP_LOG(_l, _nlp, _fmt, ...)			\
58 	NL_RAW_PID_LOG_##_l(_l, nlp_get_pid(_nlp), _fmt, ## __VA_ARGS__)
59 
60 #if DEBUG_MAX_LEVEL>=LOG_DEBUG3
61 #define	NL_RAW_PID_LOG_LOG_DEBUG3	_NL_RAW_PID_LOG
62 #else
63 #define	NL_RAW_PID_LOG_LOG_DEBUG3(_l, _pid, _fmt, ...)
64 #endif
65 #if DEBUG_MAX_LEVEL>=LOG_DEBUG2
66 #define	NL_RAW_PID_LOG_LOG_DEBUG2	_NL_RAW_PID_LOG
67 #else
68 #define	NL_RAW_PID_LOG_LOG_DEBUG2(_l, _pid, _fmt, ...)
69 #endif
70 #if DEBUG_MAX_LEVEL>=LOG_DEBUG
71 #define	NL_RAW_PID_LOG_LOG_DEBUG	_NL_RAW_PID_LOG
72 #else
73 #define	NL_RAW_PID_LOG_LOG_DEBUG(_l, _pid, _fmt, ...)
74 #endif
75 #if DEBUG_MAX_LEVEL>=LOG_INFO
76 #define	NL_RAW_PID_LOG_LOG_INFO	_NL_RAW_PID_LOG
77 #else
78 #define	NL_RAW_PID_LOG_LOG_INFO(_l, _pid, _fmt, ...)
79 #endif
80 #define	NL_RAW_PID_LOG_LOG_NOTICE	_NL_RAW_PID_LOG
81 #define	NL_RAW_PID_LOG_LOG_ERR         _NL_RAW_PID_LOG
82 #define	NL_RAW_PID_LOG_LOG_WARNING	_NL_RAW_PID_LOG
83 
84 #endif	/* _KERNEL */
85 #endif	/* !_NETLINK_NETLINK_DEBUG_H_ */
86