xref: /freebsd/sys/netipsec/key_debug.h (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1 /*	$FreeBSD$	*/
2 /*	$KAME: key_debug.h,v 1.10 2001/08/05 08:37:52 itojun Exp $	*/
3 
4 /*-
5  * SPDX-License-Identifier: BSD-3-Clause
6  *
7  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the project nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34 
35 #ifndef _NETIPSEC_KEY_DEBUG_H_
36 #define _NETIPSEC_KEY_DEBUG_H_
37 
38 #ifdef _KERNEL
39 /* debug flags */
40 #define KEYDEBUG_STAMP		0x00000001 /* path */
41 #define KEYDEBUG_DATA		0x00000002 /* data */
42 #define KEYDEBUG_DUMP		0x00000004 /* dump */
43 
44 #define KEYDEBUG_KEY		0x00000010 /* key processing */
45 #define KEYDEBUG_ALG		0x00000020 /* ciph & auth algorithm */
46 #define KEYDEBUG_IPSEC		0x00000040 /* ipsec processing */
47 
48 #define KEYDEBUG_KEY_STAMP	(KEYDEBUG_KEY | KEYDEBUG_STAMP)
49 #define KEYDEBUG_KEY_DATA	(KEYDEBUG_KEY | KEYDEBUG_DATA)
50 #define KEYDEBUG_KEY_DUMP	(KEYDEBUG_KEY | KEYDEBUG_DUMP)
51 #define KEYDEBUG_ALG_STAMP	(KEYDEBUG_ALG | KEYDEBUG_STAMP)
52 #define KEYDEBUG_ALG_DATA	(KEYDEBUG_ALG | KEYDEBUG_DATA)
53 #define KEYDEBUG_ALG_DUMP	(KEYDEBUG_ALG | KEYDEBUG_DUMP)
54 #define KEYDEBUG_IPSEC_STAMP	(KEYDEBUG_IPSEC | KEYDEBUG_STAMP)
55 #define KEYDEBUG_IPSEC_DATA	(KEYDEBUG_IPSEC | KEYDEBUG_DATA)
56 #define KEYDEBUG_IPSEC_DUMP	(KEYDEBUG_IPSEC | KEYDEBUG_DUMP)
57 
58 #ifdef IPSEC_DEBUG
59 #define KEYDBG(lev, arg)	\
60     if ((V_key_debug_level & (KEYDEBUG_ ## lev)) == (KEYDEBUG_ ## lev)) { \
61 	    arg;		\
62     }
63 #else
64 #define	KEYDBG(lev, arg)
65 #endif /* !IPSEC_DEBUG */
66 
67 VNET_DECLARE(uint32_t, key_debug_level);
68 #define	V_key_debug_level	VNET(key_debug_level)
69 #endif /*_KERNEL*/
70 
71 struct sadb_msg;
72 struct sadb_ext;
73 extern void kdebug_sadb(struct sadb_msg *);
74 extern void kdebug_sadb_x_policy(struct sadb_ext *);
75 
76 #ifdef _KERNEL
77 struct secpolicy;
78 struct secpolicyindex;
79 struct secasindex;
80 struct secashead;
81 struct secasvar;
82 struct secreplay;
83 struct mbuf;
84 union sockaddr_union;
85 const char* kdebug_secpolicy_state(u_int);
86 const char* kdebug_secpolicy_policy(u_int);
87 const char* kdebug_secpolicyindex_dir(u_int);
88 const char* kdebug_ipsecrequest_level(u_int);
89 const char* kdebug_secasindex_mode(u_int);
90 const char* kdebug_secasv_state(u_int);
91 void kdebug_secpolicy(struct secpolicy *);
92 void kdebug_secpolicyindex(struct secpolicyindex *, const char *);
93 void kdebug_secasindex(const struct secasindex *, const char *);
94 void kdebug_secash(struct secashead *, const char *);
95 void kdebug_secasv(struct secasvar *);
96 void kdebug_mbufhdr(const struct mbuf *);
97 void kdebug_mbuf(const struct mbuf *);
98 char *ipsec_address(const union sockaddr_union *, char *, socklen_t);
99 char *ipsec_sa2str(struct secasvar *, char *, size_t);
100 #endif /*_KERNEL*/
101 
102 struct sockaddr;
103 extern void kdebug_sockaddr(struct sockaddr *);
104 
105 extern void ipsec_hexdump(caddr_t, int);
106 extern void ipsec_bindump(caddr_t, int);
107 
108 #endif /* _NETIPSEC_KEY_DEBUG_H_ */
109