xref: /freebsd/sys/net/if_gif.h (revision 6573d7580b851d794b6c3cbd5ee3d7bf0b4c0ccb)
1 /*	$FreeBSD$	*/
2 /*	$KAME: if_gif.h,v 1.17 2000/09/11 11:36:41 sumikawa Exp $	*/
3 
4 /*-
5  * SPDX-License-Identifier: BSD-3-Clause
6  *
7  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
8  * Copyright (c) 2018 Andrey V. Elsukov <ae@FreeBSD.org>
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. Neither the name of the project nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  */
35 
36 #ifndef _NET_IF_GIF_H_
37 #define _NET_IF_GIF_H_
38 
39 #ifdef _KERNEL
40 
41 struct ip;
42 struct ip6_hdr;
43 
44 extern	void (*ng_gif_input_p)(struct ifnet *ifp, struct mbuf **mp,
45 		int af);
46 extern	void (*ng_gif_input_orphan_p)(struct ifnet *ifp, struct mbuf *m,
47 		int af);
48 extern	int  (*ng_gif_output_p)(struct ifnet *ifp, struct mbuf **mp);
49 extern	void (*ng_gif_attach_p)(struct ifnet *ifp);
50 extern	void (*ng_gif_detach_p)(struct ifnet *ifp);
51 
52 struct gif_softc {
53 	struct ifnet		*gif_ifp;
54 	int			gif_family;
55 	int			gif_flags;
56 	u_int			gif_fibnum;
57 	u_int			gif_options;
58 	void			*gif_netgraph;	/* netgraph node info */
59 	union {
60 		void		*hdr;
61 		struct ip	*iphdr;
62 		struct ip6_hdr	*ip6hdr;
63 	} gif_uhdr;
64 
65 	CK_LIST_ENTRY(gif_softc) chain;
66 };
67 CK_LIST_HEAD(gif_list, gif_softc);
68 MALLOC_DECLARE(M_GIF);
69 
70 #ifndef GIF_HASH_SIZE
71 #define	GIF_HASH_SIZE	(1 << 4)
72 #endif
73 
74 #define	GIF2IFP(sc)	((sc)->gif_ifp)
75 #define	gif_iphdr	gif_uhdr.iphdr
76 #define	gif_hdr		gif_uhdr.hdr
77 #define	gif_ip6hdr	gif_uhdr.ip6hdr
78 
79 #define GIF_MTU		(1280)	/* Default MTU */
80 #define	GIF_MTU_MIN	(1280)	/* Minimum MTU */
81 #define	GIF_MTU_MAX	(8192)	/* Maximum MTU */
82 
83 struct etherip_header {
84 #if BYTE_ORDER == LITTLE_ENDIAN
85 	u_int	eip_resvl:4,	/* reserved */
86 		eip_ver:4;	/* version */
87 #endif
88 #if BYTE_ORDER == BIG_ENDIAN
89 	u_int	eip_ver:4,	/* version */
90 		eip_resvl:4;	/* reserved */
91 #endif
92 	u_int8_t eip_resvh;	/* reserved */
93 } __packed;
94 
95 #define ETHERIP_VERSION			0x3
96 /* mbuf adjust factor to force 32-bit alignment of IP header */
97 #define	ETHERIP_ALIGN		2
98 
99 #define	GIF_RLOCK()	struct epoch_tracker gif_et; epoch_enter_preempt(net_epoch_preempt, &gif_et)
100 #define	GIF_RUNLOCK()	epoch_exit_preempt(net_epoch_preempt, &gif_et)
101 #define	GIF_WAIT()	epoch_wait_preempt(net_epoch_preempt)
102 
103 /* Prototypes */
104 struct gif_list *gif_hashinit(void);
105 void gif_hashdestroy(struct gif_list *);
106 
107 void gif_input(struct mbuf *, struct ifnet *, int, uint8_t);
108 int gif_output(struct ifnet *, struct mbuf *, const struct sockaddr *,
109 	       struct route *);
110 
111 void in_gif_init(void);
112 void in_gif_uninit(void);
113 int in_gif_output(struct ifnet *, struct mbuf *, int, uint8_t);
114 int in_gif_ioctl(struct gif_softc *, u_long, caddr_t);
115 int in_gif_setopts(struct gif_softc *, u_int);
116 
117 void in6_gif_init(void);
118 void in6_gif_uninit(void);
119 int in6_gif_output(struct ifnet *, struct mbuf *, int, uint8_t);
120 int in6_gif_ioctl(struct gif_softc *, u_long, caddr_t);
121 int in6_gif_setopts(struct gif_softc *, u_int);
122 #endif /* _KERNEL */
123 
124 #define GIFGOPTS	_IOWR('i', 150, struct ifreq)
125 #define GIFSOPTS	_IOW('i', 151, struct ifreq)
126 
127 #define	GIF_IGNORE_SOURCE	0x0002
128 #define	GIF_OPTMASK		(GIF_IGNORE_SOURCE)
129 
130 #endif /* _NET_IF_GIF_H_ */
131