xref: /freebsd/sys/net/if_gre.h (revision d34048812292b714a0bf99967270d18fe3097c62)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 1998 The NetBSD Foundation, Inc.
5  * Copyright (c) 2014 Andrey V. Elsukov <ae@FreeBSD.org>
6  * All rights reserved
7  *
8  * This code is derived from software contributed to The NetBSD Foundation
9  * by Heiko W.Rupp <hwr@pilhuhn.de>
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  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  *
32  * $NetBSD: if_gre.h,v 1.13 2003/11/10 08:51:52 wiz Exp $
33  * $FreeBSD$
34  */
35 
36 #ifndef _NET_IF_GRE_H_
37 #define _NET_IF_GRE_H_
38 
39 #ifdef _KERNEL
40 /* GRE header according to RFC 2784 and RFC 2890 */
41 struct grehdr {
42 	uint16_t	gre_flags;	/* GRE flags */
43 #define	GRE_FLAGS_CP	0x8000		/* checksum present */
44 #define	GRE_FLAGS_KP	0x2000		/* key present */
45 #define	GRE_FLAGS_SP	0x1000		/* sequence present */
46 #define	GRE_FLAGS_MASK	(GRE_FLAGS_CP|GRE_FLAGS_KP|GRE_FLAGS_SP)
47 	uint16_t	gre_proto;	/* protocol type */
48 	uint32_t	gre_opts[0];	/* optional fields */
49 } __packed;
50 
51 #ifdef INET
52 struct greip {
53 	struct ip	gi_ip;
54 	struct grehdr	gi_gre;
55 } __packed;
56 #endif
57 
58 #ifdef INET6
59 struct greip6 {
60 	struct ip6_hdr	gi6_ip6;
61 	struct grehdr	gi6_gre;
62 } __packed;
63 #endif
64 
65 struct gre_softc {
66 	struct ifnet		*gre_ifp;
67 	int			gre_family;	/* AF of delivery header */
68 	uint32_t		gre_iseq;
69 	uint32_t		gre_oseq;
70 	uint32_t		gre_key;
71 	uint32_t		gre_options;
72 	u_int			gre_fibnum;
73 	u_int			gre_hlen;	/* header size */
74 	union {
75 		void		*hdr;
76 #ifdef INET
77 		struct greip	*gihdr;
78 #endif
79 #ifdef INET6
80 		struct greip6	*gi6hdr;
81 #endif
82 	} gre_uhdr;
83 
84 	CK_LIST_ENTRY(gre_softc) chain;
85 	CK_LIST_ENTRY(gre_softc) srchash;
86 };
87 CK_LIST_HEAD(gre_list, gre_softc);
88 MALLOC_DECLARE(M_GRE);
89 
90 #ifndef GRE_HASH_SIZE
91 #define	GRE_HASH_SIZE	(1 << 4)
92 #endif
93 
94 #define	GRE2IFP(sc)		((sc)->gre_ifp)
95 #define	GRE_RLOCK_TRACKER	struct epoch_tracker gre_et
96 #define	GRE_RLOCK()		epoch_enter_preempt(net_epoch_preempt, &gre_et)
97 #define	GRE_RUNLOCK()		epoch_exit_preempt(net_epoch_preempt, &gre_et)
98 #define	GRE_WAIT()		epoch_wait_preempt(net_epoch_preempt)
99 
100 #define	gre_hdr			gre_uhdr.hdr
101 #define	gre_gihdr		gre_uhdr.gihdr
102 #define	gre_gi6hdr		gre_uhdr.gi6hdr
103 #define	gre_oip			gre_gihdr->gi_ip
104 #define	gre_oip6		gre_gi6hdr->gi6_ip6
105 
106 struct gre_list *gre_hashinit(void);
107 void gre_hashdestroy(struct gre_list *);
108 
109 int	gre_input(struct mbuf *, int, int, void *);
110 void	gre_updatehdr(struct gre_softc *, struct grehdr *);
111 
112 void	in_gre_init(void);
113 void	in_gre_uninit(void);
114 void	in_gre_setopts(struct gre_softc *, u_long, uint32_t);
115 int	in_gre_ioctl(struct gre_softc *, u_long, caddr_t);
116 int	in_gre_output(struct mbuf *, int, int);
117 
118 void	in6_gre_init(void);
119 void	in6_gre_uninit(void);
120 void	in6_gre_setopts(struct gre_softc *, u_long, uint32_t);
121 int	in6_gre_ioctl(struct gre_softc *, u_long, caddr_t);
122 int	in6_gre_output(struct mbuf *, int, int);
123 /*
124  * CISCO uses special type for GRE tunnel created as part of WCCP
125  * connection, while in fact those packets are just IPv4 encapsulated
126  * into GRE.
127  */
128 #define ETHERTYPE_WCCP		0x883E
129 #endif /* _KERNEL */
130 
131 #define GRESADDRS	_IOW('i', 101, struct ifreq)
132 #define GRESADDRD	_IOW('i', 102, struct ifreq)
133 #define GREGADDRS	_IOWR('i', 103, struct ifreq)
134 #define GREGADDRD	_IOWR('i', 104, struct ifreq)
135 #define GRESPROTO	_IOW('i' , 105, struct ifreq)
136 #define GREGPROTO	_IOWR('i', 106, struct ifreq)
137 
138 #define	GREGKEY		_IOWR('i', 107, struct ifreq)
139 #define	GRESKEY		_IOW('i', 108, struct ifreq)
140 #define	GREGOPTS	_IOWR('i', 109, struct ifreq)
141 #define	GRESOPTS	_IOW('i', 110, struct ifreq)
142 
143 #define	GRE_ENABLE_CSUM		0x0001
144 #define	GRE_ENABLE_SEQ		0x0002
145 #define	GRE_OPTMASK		(GRE_ENABLE_CSUM|GRE_ENABLE_SEQ)
146 
147 #endif /* _NET_IF_GRE_H_ */
148