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 57 struct greudp { 58 struct ip gi_ip; 59 struct udphdr gi_udp; 60 struct grehdr gi_gre; 61 } __packed; 62 #endif /* INET */ 63 64 #ifdef INET6 65 struct greip6 { 66 struct ip6_hdr gi6_ip6; 67 struct grehdr gi6_gre; 68 } __packed; 69 70 struct greudp6 { 71 struct ip6_hdr gi6_ip6; 72 struct udphdr gi6_udp; 73 struct grehdr gi6_gre; 74 } __packed; 75 #endif /* INET6 */ 76 77 CK_LIST_HEAD(gre_list, gre_softc); 78 CK_LIST_HEAD(gre_sockets, gre_socket); 79 struct gre_socket { 80 struct socket *so; 81 struct gre_list list; 82 CK_LIST_ENTRY(gre_socket) chain; 83 struct epoch_context epoch_ctx; 84 }; 85 86 struct gre_softc { 87 struct ifnet *gre_ifp; 88 int gre_family; /* AF of delivery header */ 89 uint32_t gre_iseq; 90 uint32_t gre_oseq; 91 uint32_t gre_key; 92 uint32_t gre_options; 93 uint32_t gre_csumflags; 94 uint32_t gre_port; 95 u_int gre_fibnum; 96 u_int gre_hlen; /* header size */ 97 union { 98 void *hdr; 99 #ifdef INET 100 struct greip *iphdr; 101 struct greudp *udphdr; 102 #endif 103 #ifdef INET6 104 struct greip6 *ip6hdr; 105 struct greudp6 *udp6hdr; 106 #endif 107 } gre_uhdr; 108 struct gre_socket *gre_so; 109 110 CK_LIST_ENTRY(gre_softc) chain; 111 CK_LIST_ENTRY(gre_softc) srchash; 112 }; 113 MALLOC_DECLARE(M_GRE); 114 115 #ifndef GRE_HASH_SIZE 116 #define GRE_HASH_SIZE (1 << 4) 117 #endif 118 119 #define GRE2IFP(sc) ((sc)->gre_ifp) 120 #define GRE_RLOCK_TRACKER struct epoch_tracker gre_et 121 #define GRE_RLOCK() epoch_enter_preempt(net_epoch_preempt, &gre_et) 122 #define GRE_RUNLOCK() epoch_exit_preempt(net_epoch_preempt, &gre_et) 123 #define GRE_WAIT() epoch_wait_preempt(net_epoch_preempt) 124 125 #define gre_hdr gre_uhdr.hdr 126 #define gre_iphdr gre_uhdr.iphdr 127 #define gre_ip6hdr gre_uhdr.ip6hdr 128 #define gre_udphdr gre_uhdr.udphdr 129 #define gre_udp6hdr gre_uhdr.udp6hdr 130 131 #define gre_oip gre_iphdr->gi_ip 132 #define gre_udp gre_udphdr->gi_udp 133 #define gre_oip6 gre_ip6hdr->gi6_ip6 134 #define gre_udp6 gre_udp6hdr->gi6_udp 135 136 struct gre_list *gre_hashinit(void); 137 void gre_hashdestroy(struct gre_list *); 138 139 int gre_input(struct mbuf *, int, int, void *); 140 void gre_update_hdr(struct gre_softc *, struct grehdr *); 141 void gre_update_udphdr(struct gre_softc *, struct udphdr *, uint16_t); 142 void gre_sofree(epoch_context_t); 143 144 void in_gre_init(void); 145 void in_gre_uninit(void); 146 int in_gre_setopts(struct gre_softc *, u_long, uint32_t); 147 int in_gre_ioctl(struct gre_softc *, u_long, caddr_t); 148 int in_gre_output(struct mbuf *, int, int); 149 150 void in6_gre_init(void); 151 void in6_gre_uninit(void); 152 int in6_gre_setopts(struct gre_softc *, u_long, uint32_t); 153 int in6_gre_ioctl(struct gre_softc *, u_long, caddr_t); 154 int in6_gre_output(struct mbuf *, int, int, uint32_t); 155 /* 156 * CISCO uses special type for GRE tunnel created as part of WCCP 157 * connection, while in fact those packets are just IPv4 encapsulated 158 * into GRE. 159 */ 160 #define ETHERTYPE_WCCP 0x883E 161 #endif /* _KERNEL */ 162 163 #define GRESADDRS _IOW('i', 101, struct ifreq) 164 #define GRESADDRD _IOW('i', 102, struct ifreq) 165 #define GREGADDRS _IOWR('i', 103, struct ifreq) 166 #define GREGADDRD _IOWR('i', 104, struct ifreq) 167 #define GRESPROTO _IOW('i' , 105, struct ifreq) 168 #define GREGPROTO _IOWR('i', 106, struct ifreq) 169 170 #define GREGKEY _IOWR('i', 107, struct ifreq) 171 #define GRESKEY _IOW('i', 108, struct ifreq) 172 #define GREGOPTS _IOWR('i', 109, struct ifreq) 173 #define GRESOPTS _IOW('i', 110, struct ifreq) 174 #define GREGPORT _IOWR('i', 111, struct ifreq) 175 #define GRESPORT _IOW('i', 112, struct ifreq) 176 177 /* GRE-in-UDP encapsulation destination port as defined in RFC8086 */ 178 #define GRE_UDPPORT 4754 179 180 #define GRE_ENABLE_CSUM 0x0001 181 #define GRE_ENABLE_SEQ 0x0002 182 #define GRE_UDPENCAP 0x0004 183 #define GRE_OPTMASK (GRE_ENABLE_CSUM|GRE_ENABLE_SEQ|GRE_UDPENCAP) 184 185 #endif /* _NET_IF_GRE_H_ */ 186