xref: /freebsd/sys/net/if_gif.h (revision eb69d1f144a6fcc765d1b9d44a5ae8082353e70b)
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  * 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 _NET_IF_GIF_H_
36 #define _NET_IF_GIF_H_
37 
38 #ifdef _KERNEL
39 #include "opt_inet.h"
40 #include "opt_inet6.h"
41 
42 #include <netinet/in.h>
43 
44 struct ip;
45 struct ip6_hdr;
46 struct encaptab;
47 
48 extern	void (*ng_gif_input_p)(struct ifnet *ifp, struct mbuf **mp,
49 		int af);
50 extern	void (*ng_gif_input_orphan_p)(struct ifnet *ifp, struct mbuf *m,
51 		int af);
52 extern	int  (*ng_gif_output_p)(struct ifnet *ifp, struct mbuf **mp);
53 extern	void (*ng_gif_attach_p)(struct ifnet *ifp);
54 extern	void (*ng_gif_detach_p)(struct ifnet *ifp);
55 
56 struct gif_softc {
57 	struct ifnet		*gif_ifp;
58 	struct rmlock		gif_lock;
59 	const struct encaptab	*gif_ecookie;
60 	int			gif_family;
61 	int			gif_flags;
62 	u_int			gif_fibnum;
63 	u_int			gif_options;
64 	void			*gif_netgraph;	/* netgraph node info */
65 	union {
66 		void		*hdr;
67 		struct ip	*iphdr;
68 #ifdef INET6
69 		struct ip6_hdr	*ip6hdr;
70 #endif
71 	} gif_uhdr;
72 	LIST_ENTRY(gif_softc)	gif_list; /* all gif's are linked */
73 };
74 #define	GIF2IFP(sc)	((sc)->gif_ifp)
75 #define	GIF_LOCK_INIT(sc)	rm_init(&(sc)->gif_lock, "gif softc")
76 #define	GIF_LOCK_DESTROY(sc)	rm_destroy(&(sc)->gif_lock)
77 #define	GIF_RLOCK_TRACKER	struct rm_priotracker gif_tracker
78 #define	GIF_RLOCK(sc)		rm_rlock(&(sc)->gif_lock, &gif_tracker)
79 #define	GIF_RUNLOCK(sc)		rm_runlock(&(sc)->gif_lock, &gif_tracker)
80 #define	GIF_RLOCK_ASSERT(sc)	rm_assert(&(sc)->gif_lock, RA_RLOCKED)
81 #define	GIF_WLOCK(sc)		rm_wlock(&(sc)->gif_lock)
82 #define	GIF_WUNLOCK(sc)		rm_wunlock(&(sc)->gif_lock)
83 #define	GIF_WLOCK_ASSERT(sc)	rm_assert(&(sc)->gif_lock, RA_WLOCKED)
84 
85 #define	gif_iphdr	gif_uhdr.iphdr
86 #define	gif_hdr		gif_uhdr.hdr
87 #ifdef INET6
88 #define	gif_ip6hdr	gif_uhdr.ip6hdr
89 #endif
90 
91 #define GIF_MTU		(1280)	/* Default MTU */
92 #define	GIF_MTU_MIN	(1280)	/* Minimum MTU */
93 #define	GIF_MTU_MAX	(8192)	/* Maximum MTU */
94 
95 struct etherip_header {
96 #if BYTE_ORDER == LITTLE_ENDIAN
97 	u_int	eip_resvl:4,	/* reserved */
98 		eip_ver:4;	/* version */
99 #endif
100 #if BYTE_ORDER == BIG_ENDIAN
101 	u_int	eip_ver:4,	/* version */
102 		eip_resvl:4;	/* reserved */
103 #endif
104 	u_int8_t eip_resvh;	/* reserved */
105 } __packed;
106 
107 #define ETHERIP_VERSION			0x3
108 /* mbuf adjust factor to force 32-bit alignment of IP header */
109 #define	ETHERIP_ALIGN		2
110 
111 /* Prototypes */
112 void gif_input(struct mbuf *, struct ifnet *, int, uint8_t);
113 int gif_output(struct ifnet *, struct mbuf *, const struct sockaddr *,
114 	       struct route *);
115 int gif_encapcheck(const struct mbuf *, int, int, void *);
116 #ifdef INET
117 int in_gif_output(struct ifnet *, struct mbuf *, int, uint8_t);
118 int in_gif_encapcheck(const struct mbuf *, int, int, void *);
119 int in_gif_attach(struct gif_softc *);
120 #endif
121 #ifdef INET6
122 int in6_gif_output(struct ifnet *, struct mbuf *, int, uint8_t);
123 int in6_gif_encapcheck(const struct mbuf *, int, int, void *);
124 int in6_gif_attach(struct gif_softc *);
125 #endif
126 #endif /* _KERNEL */
127 
128 #define GIFGOPTS	_IOWR('i', 150, struct ifreq)
129 #define GIFSOPTS	_IOW('i', 151, struct ifreq)
130 
131 #define	GIF_IGNORE_SOURCE	0x0002
132 #define	GIF_OPTMASK		(GIF_IGNORE_SOURCE)
133 
134 #endif /* _NET_IF_GIF_H_ */
135