if_gre.h revision 179894
1123992Ssobomax/* $NetBSD: if_gre.h,v 1.13 2003/11/10 08:51:52 wiz Exp $ */ 2103026Ssobomax/* $FreeBSD: head/sys/net/if_gre.h 179894 2008-06-20 17:26:34Z thompsa $ */ 3103026Ssobomax 4139823Simp/*- 5103026Ssobomax * Copyright (c) 1998 The NetBSD Foundation, Inc. 6103026Ssobomax * All rights reserved 7103026Ssobomax * 8103026Ssobomax * This code is derived from software contributed to The NetBSD Foundation 9103026Ssobomax * by Heiko W.Rupp <hwr@pilhuhn.de> 10103026Ssobomax * 11103026Ssobomax * Redistribution and use in source and binary forms, with or without 12103026Ssobomax * modification, are permitted provided that the following conditions 13103026Ssobomax * are met: 14103026Ssobomax * 1. Redistributions of source code must retain the above copyright 15103026Ssobomax * notice, this list of conditions and the following disclaimer. 16103026Ssobomax * 2. Redistributions in binary form must reproduce the above copyright 17103026Ssobomax * notice, this list of conditions and the following disclaimer in the 18103026Ssobomax * documentation and/or other materials provided with the distribution. 19103026Ssobomax * 3. All advertising materials mentioning features or use of this software 20103026Ssobomax * must display the following acknowledgement: 21103026Ssobomax * This product includes software developed by the NetBSD 22103026Ssobomax * Foundation, Inc. and its contributors. 23103026Ssobomax * 4. Neither the name of The NetBSD Foundation nor the names of its 24103026Ssobomax * contributors may be used to endorse or promote products derived 25103026Ssobomax * from this software without specific prior written permission. 26125020Ssobomax * 27103026Ssobomax * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 28103026Ssobomax * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 29103026Ssobomax * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30103026Ssobomax * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 31103026Ssobomax * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32103026Ssobomax * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33103026Ssobomax * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34103026Ssobomax * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35103026Ssobomax * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36103026Ssobomax * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37103026Ssobomax * POSSIBILITY OF SUCH DAMAGE. 38103026Ssobomax */ 39103026Ssobomax 40103026Ssobomax#ifndef _NET_IF_GRE_H 41103026Ssobomax#define _NET_IF_GRE_H 42103026Ssobomax 43103026Ssobomax#include <sys/ioccom.h> 44103120Ssobomax#ifdef _KERNEL 45103026Ssobomax#include <sys/queue.h> 46103026Ssobomax 47125024Ssobomax/* 48125024Ssobomax * Version of the WCCP, need to be configured manually since 49125024Ssobomax * header for version 2 is the same but IP payload is prepended 50125024Ssobomax * with additional 4-bytes field. 51125024Ssobomax */ 52125024Ssobomaxtypedef enum { 53125024Ssobomax WCCP_V1 = 0, 54125024Ssobomax WCCP_V2 55125024Ssobomax} wccp_ver_t; 56125024Ssobomax 57103026Ssobomaxstruct gre_softc { 58147256Sbrooks struct ifnet *sc_ifp; 59103026Ssobomax LIST_ENTRY(gre_softc) sc_list; 60103026Ssobomax int gre_unit; 61103026Ssobomax int gre_flags; 62178888Sjulian u_int gre_fibnum; /* use this fib for envelopes */ 63103026Ssobomax struct in_addr g_src; /* source address of gre packets */ 64103026Ssobomax struct in_addr g_dst; /* destination address of gre packets */ 65103026Ssobomax struct route route; /* routing entry that determines, where a 66103026Ssobomax encapsulated packet should go */ 67103026Ssobomax u_char g_proto; /* protocol of encapsulator */ 68103026Ssobomax 69103026Ssobomax const struct encaptab *encap; /* encapsulation cookie */ 70103026Ssobomax 71103026Ssobomax int called; /* infinite recursion preventer */ 72125024Ssobomax 73179894Sthompsa uint32_t key; /* key included in outgoing GRE packets */ 74179894Sthompsa /* zero means none */ 75179894Sthompsa 76125024Ssobomax wccp_ver_t wccp_ver; /* version of the WCCP */ 77125020Ssobomax}; 78147256Sbrooks#define GRE2IFP(sc) ((sc)->sc_ifp) 79103026Ssobomax 80103026Ssobomax 81103026Ssobomaxstruct gre_h { 82103026Ssobomax u_int16_t flags; /* GRE flags */ 83125020Ssobomax u_int16_t ptype; /* protocol type of payload typically 84103026Ssobomax Ether protocol type*/ 85179894Sthompsa uint32_t options[0]; /* optional options */ 86125020Ssobomax/* 87125020Ssobomax * from here on: fields are optional, presence indicated by flags 88103026Ssobomax * 89103026Ssobomax u_int_16 checksum checksum (one-complements of GRE header 90103026Ssobomax and payload 91103026Ssobomax Present if (ck_pres | rt_pres == 1). 92103026Ssobomax Valid if (ck_pres == 1). 93103026Ssobomax u_int_16 offset offset from start of routing filed to 94103026Ssobomax first octet of active SRE (see below). 95103026Ssobomax Present if (ck_pres | rt_pres == 1). 96103026Ssobomax Valid if (rt_pres == 1). 97103026Ssobomax u_int_32 key inserted by encapsulator e.g. for 98103026Ssobomax authentication 99103026Ssobomax Present if (key_pres ==1 ). 100103026Ssobomax u_int_32 seq_num Sequence number to allow for packet order 101103026Ssobomax Present if (seq_pres ==1 ). 102103026Ssobomax struct gre_sre[] routing Routing fileds (see below) 103103026Ssobomax Present if (rt_pres == 1) 104103026Ssobomax */ 105103842Salfred} __packed; 106103026Ssobomax 107103026Ssobomaxstruct greip { 108103026Ssobomax struct ip gi_i; 109103026Ssobomax struct gre_h gi_g; 110103842Salfred} __packed; 111103026Ssobomax 112103026Ssobomax#define gi_pr gi_i.ip_p 113103026Ssobomax#define gi_len gi_i.ip_len 114103026Ssobomax#define gi_src gi_i.ip_src 115103026Ssobomax#define gi_dst gi_i.ip_dst 116103026Ssobomax#define gi_ptype gi_g.ptype 117103026Ssobomax#define gi_flags gi_g.flags 118179894Sthompsa#define gi_options gi_g.options 119103026Ssobomax 120103026Ssobomax#define GRE_CP 0x8000 /* Checksum Present */ 121103026Ssobomax#define GRE_RP 0x4000 /* Routing Present */ 122103026Ssobomax#define GRE_KP 0x2000 /* Key Present */ 123103026Ssobomax#define GRE_SP 0x1000 /* Sequence Present */ 124103026Ssobomax#define GRE_SS 0x0800 /* Strict Source Route */ 125103026Ssobomax 126103026Ssobomax/* 127107670Ssobomax * CISCO uses special type for GRE tunnel created as part of WCCP 128107670Ssobomax * connection, while in fact those packets are just IPv4 encapsulated 129107670Ssobomax * into GRE. 130107670Ssobomax */ 131107670Ssobomax#define WCCP_PROTOCOL_TYPE 0x883E 132107670Ssobomax 133107670Ssobomax/* 134103026Ssobomax * gre_sre defines a Source route Entry. These are needed if packets 135103026Ssobomax * should be routed over more than one tunnel hop by hop 136103026Ssobomax */ 137103026Ssobomaxstruct gre_sre { 138123992Ssobomax u_int16_t sre_family; /* address family */ 139103026Ssobomax u_char sre_offset; /* offset to first octet of active entry */ 140125020Ssobomax u_char sre_length; /* number of octets in the SRE. 141103026Ssobomax sre_lengthl==0 -> last entry. */ 142103026Ssobomax u_char *sre_rtinfo; /* the routing information */ 143103026Ssobomax}; 144103026Ssobomax 145103026Ssobomaxstruct greioctl { 146103026Ssobomax int unit; 147103026Ssobomax struct in_addr addr; 148103026Ssobomax}; 149103026Ssobomax 150103026Ssobomax/* for mobile encaps */ 151103026Ssobomax 152103026Ssobomaxstruct mobile_h { 153103026Ssobomax u_int16_t proto; /* protocol and S-bit */ 154103026Ssobomax u_int16_t hcrc; /* header checksum */ 155103026Ssobomax u_int32_t odst; /* original destination address */ 156103026Ssobomax u_int32_t osrc; /* original source addr, if S-bit set */ 157103842Salfred} __packed; 158103026Ssobomax 159103026Ssobomaxstruct mobip_h { 160103026Ssobomax struct ip mi; 161103026Ssobomax struct mobile_h mh; 162103842Salfred} __packed; 163103026Ssobomax 164103026Ssobomax 165103026Ssobomax#define MOB_H_SIZ_S (sizeof(struct mobile_h) - sizeof(u_int32_t)) 166103026Ssobomax#define MOB_H_SIZ_L (sizeof(struct mobile_h)) 167103026Ssobomax#define MOB_H_SBIT 0x0080 168103026Ssobomax 169103026Ssobomax#define GRE_TTL 30 170103026Ssobomax 171103120Ssobomax#endif /* _KERNEL */ 172103120Ssobomax 173125020Ssobomax/* 174125020Ssobomax * ioctls needed to manipulate the interface 175103026Ssobomax */ 176103026Ssobomax 177103026Ssobomax#define GRESADDRS _IOW('i', 101, struct ifreq) 178125020Ssobomax#define GRESADDRD _IOW('i', 102, struct ifreq) 179103026Ssobomax#define GREGADDRS _IOWR('i', 103, struct ifreq) 180103026Ssobomax#define GREGADDRD _IOWR('i', 104, struct ifreq) 181103026Ssobomax#define GRESPROTO _IOW('i' , 105, struct ifreq) 182103026Ssobomax#define GREGPROTO _IOWR('i', 106, struct ifreq) 183179894Sthompsa#define GREGKEY _IOWR('i', 107, struct ifreq) 184179894Sthompsa#define GRESKEY _IOW('i', 108, struct ifreq) 185103026Ssobomax 186103026Ssobomax#ifdef _KERNEL 187103026SsobomaxLIST_HEAD(gre_softc_head, gre_softc); 188127307Srwatsonextern struct mtx gre_mtx; 189103026Ssobomaxextern struct gre_softc_head gre_softc_list; 190103026Ssobomax 191123992Ssobomaxu_int16_t gre_in_cksum(u_int16_t *, u_int); 192103026Ssobomax#endif /* _KERNEL */ 193103026Ssobomax 194103026Ssobomax#endif 195