Home | History | Annotate | Line # | Download | only in netinet
ip_encap.h revision 1.27
      1 /*	$NetBSD: ip_encap.h,v 1.27 2022/12/07 08:28:46 knakahara Exp $	*/
      2 /*	$KAME: ip_encap.h,v 1.7 2000/03/25 07:23:37 sumikawa Exp $	*/
      3 
      4 /*
      5  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
      6  * All rights reserved.
      7  *
      8  * Redistribution and use in source and binary forms, with or without
      9  * modification, are permitted provided that the following conditions
     10  * are met:
     11  * 1. Redistributions of source code must retain the above copyright
     12  *    notice, this list of conditions and the following disclaimer.
     13  * 2. Redistributions in binary form must reproduce the above copyright
     14  *    notice, this list of conditions and the following disclaimer in the
     15  *    documentation and/or other materials provided with the distribution.
     16  * 3. Neither the name of the project nor the names of its contributors
     17  *    may be used to endorse or promote products derived from this software
     18  *    without specific prior written permission.
     19  *
     20  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
     21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
     24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     30  * SUCH DAMAGE.
     31  */
     32 
     33 #ifndef _NETINET_IP_ENCAP_H_
     34 #define _NETINET_IP_ENCAP_H_
     35 
     36 #ifdef _KERNEL
     37 
     38 #ifndef RNF_NORMAL
     39 #include <net/radix.h>
     40 #endif
     41 
     42 #include <sys/pslist.h>
     43 #include <sys/psref.h>
     44 
     45 struct encapsw {
     46 	union {
     47 		struct encapsw4 {
     48 			void	(*pr_input)	/* input to protocol (from below) */
     49 				(struct mbuf *, int, int, void *);
     50 			void	*(*pr_ctlinput)		/* control input (from below) */
     51 				(int, const struct sockaddr *, void *, void *);
     52 		} _encapsw4;
     53 		struct encapsw6 {
     54 			int	(*pr_input)	/* input to protocol (from below) */
     55 				(struct mbuf **, int *, int, void *);
     56 			void	*(*pr_ctlinput)		/* control input (from below) */
     57 				(int, const struct sockaddr *, void *, void *);
     58 		} _encapsw6;
     59 	} encapsw46;
     60 };
     61 
     62 #define encapsw4 encapsw46._encapsw4
     63 #define encapsw6 encapsw46._encapsw6
     64 
     65 typedef	int encap_priofunc_t(struct mbuf *, int, int, void *);
     66 
     67 struct encap_key {
     68 	union  {
     69 		struct sockaddr		local_u_sa;
     70 		struct sockaddr_in	local_u_sin;
     71 		struct sockaddr_in6	local_u_sin6;
     72 	}	local_u;
     73 #define local_sa	local_u.local_u_sa
     74 #define local_sin	local_u.local_u_sin
     75 #define local_sin6	local_u.local_u_sin6
     76 
     77 	union  {
     78 		struct sockaddr		remote_u_sa;
     79 		struct sockaddr_in	remote_u_sin;
     80 		struct sockaddr_in6	remote_u_sin6;
     81 	}	remote_u;
     82 #define remote_sa	remote_u.remote_u_sa
     83 #define remote_sin	remote_u.remote_u_sin
     84 #define remote_sin6	remote_u.remote_u_sin6
     85 
     86 	u_int seq;
     87 };
     88 
     89 struct encaptab {
     90 	struct radix_node nodes[2];
     91 	struct pslist_entry chain;
     92 	int af;
     93 	int proto;			/* -1: don't care, I'll check myself */
     94 	struct sockaddr *addrpack;	/* malloc'ed, for radix lookup */
     95 	struct sockaddr *maskpack;	/* ditto */
     96 	struct sockaddr *src;		/* my addr */
     97 	struct sockaddr *srcmask;
     98 	struct sockaddr *dst;		/* remote addr */
     99 	struct sockaddr *dstmask;
    100 	encap_priofunc_t *func;
    101 	const struct encapsw *esw;
    102 	void *arg;
    103 	struct encap_key key;
    104 	u_int flag;
    105 	struct psref_target	psref;
    106 };
    107 
    108 #define IP_ENCAP_ADDR_ENABLE	__BIT(0)
    109 
    110 /* to lookup a pair of address using radix tree */
    111 struct sockaddr_pack {
    112 	u_int8_t sp_len;
    113 	u_int8_t sp_family;	/* not really used */
    114 	/* followed by variable-length data */
    115 };
    116 
    117 struct ip_pack4 {
    118 	struct sockaddr_pack p;
    119 	struct sockaddr_in mine;
    120 	struct sockaddr_in yours;
    121 };
    122 struct ip_pack6 {
    123 	struct sockaddr_pack p;
    124 	struct sockaddr_in6 mine;
    125 	struct sockaddr_in6 yours;
    126 };
    127 
    128 void	encapinit(void);
    129 
    130 void	encap_init(void);
    131 void	encap4_input(struct mbuf *, int, int);
    132 int	encap6_input(struct mbuf **, int *, int);
    133 const struct encaptab *encap_attach(int, int, const struct sockaddr *,
    134 	const struct sockaddr *, const struct sockaddr *,
    135 	const struct sockaddr *, const struct encapsw *, void *);
    136 const struct encaptab *encap_attach_func(int, int,
    137 	encap_priofunc_t *,
    138 	const struct encapsw *, void *);
    139 const struct encaptab *encap_attach_addr(int, int,
    140 	const struct sockaddr *, const struct sockaddr *,
    141 	encap_priofunc_t *, const struct encapsw *, void *);
    142 void	*encap6_ctlinput(int, const struct sockaddr *, void *);
    143 int	encap_detach(const struct encaptab *);
    144 
    145 int	encap_lock_enter(void);
    146 void	encap_lock_exit(void);
    147 bool	encap_lock_held(void);
    148 
    149 #define	ENCAP_PR_WRAP_CTLINPUT(name)				\
    150 static void *							\
    151 name##_wrapper(int a, const struct sockaddr *b, void *c, void *d) \
    152 {								\
    153 	void *rv;						\
    154 	KERNEL_LOCK(1, NULL);					\
    155 	rv = name(a, b, c, d);					\
    156 	KERNEL_UNLOCK_ONE(NULL);				\
    157 	return rv;						\
    158 }
    159 #endif
    160 
    161 #endif /* !_NETINET_IP_ENCAP_H_ */
    162