if_gre.h revision 103026 
1/*	$NetBSD: if_gre.h,v 1.10 2002/02/24 17:22:20 martin Exp $ */
2/*	 $FreeBSD: head/sys/net/if_gre.h 103026 2002-09-06 17:12:50Z sobomax $ */
3
4/*
5 * Copyright (c) 1998 The NetBSD Foundation, Inc.
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 * 3. All advertising materials mentioning features or use of this software
20 *    must display the following acknowledgement:
21 *        This product includes software developed by the NetBSD
22 *        Foundation, Inc. and its contributors.
23 * 4. Neither the name of The NetBSD Foundation nor the names of its
24 *    contributors may be used to endorse or promote products derived
25 *    from this software without specific prior written permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGE.
38 */
39
40#ifndef _NET_IF_GRE_H
41#define _NET_IF_GRE_H
42
43#include <sys/ioccom.h>
44#include <sys/queue.h>
45
46struct gre_softc {
47	struct ifnet sc_if;
48	LIST_ENTRY(gre_softc) sc_list;
49	int gre_unit;
50	int gre_flags;
51	struct in_addr g_src;	/* source address of gre packets */
52	struct in_addr g_dst;	/* destination address of gre packets */
53	struct route route;	/* routing entry that determines, where a
54				   encapsulated packet should go */
55	u_char g_proto;		/* protocol of encapsulator */
56
57	const struct encaptab *encap;	/* encapsulation cookie */
58
59	int called;		/* infinite recursion preventer */
60};
61
62
63struct gre_h {
64	u_int16_t flags;	/* GRE flags */
65	u_int16_t ptype;	/* protocol type of payload typically
66				   Ether protocol type*/
67/*
68 *  from here on: fields are optional, presence indicated by flags
69 *
70	u_int_16 checksum	checksum (one-complements of GRE header
71				and payload
72				Present if (ck_pres | rt_pres == 1).
73				Valid if (ck_pres == 1).
74	u_int_16 offset		offset from start of routing filed to
75				first octet of active SRE (see below).
76				Present if (ck_pres | rt_pres == 1).
77				Valid if (rt_pres == 1).
78	u_int_32 key		inserted by encapsulator e.g. for
79				authentication
80				Present if (key_pres ==1 ).
81	u_int_32 seq_num	Sequence number to allow for packet order
82				Present if (seq_pres ==1 ).
83	struct gre_sre[] routing Routing fileds (see below)
84				Present if (rt_pres == 1)
85 */
86} __attribute__((__packed__));
87
88struct greip {
89	struct ip gi_i;
90	struct gre_h  gi_g;
91} __attribute__((__packed__));
92
93#define gi_pr		gi_i.ip_p
94#define gi_len		gi_i.ip_len
95#define gi_src		gi_i.ip_src
96#define gi_dst		gi_i.ip_dst
97#define gi_ptype	gi_g.ptype
98#define gi_flags	gi_g.flags
99
100#define GRE_CP		0x8000  /* Checksum Present */
101#define GRE_RP		0x4000  /* Routing Present */
102#define GRE_KP		0x2000  /* Key Present */
103#define GRE_SP		0x1000  /* Sequence Present */
104#define GRE_SS		0x0800	/* Strict Source Route */
105
106/*
107 * gre_sre defines a Source route Entry. These are needed if packets
108 * should be routed over more than one tunnel hop by hop
109 */
110struct gre_sre {
111	u_int16_t sre_family;	/* adress family */
112	u_char	sre_offset;	/* offset to first octet of active entry */
113	u_char	sre_length;	/* number of octets in the SRE.
114				   sre_lengthl==0 -> last entry. */
115	u_char	*sre_rtinfo;	/* the routing information */
116};
117
118struct greioctl {
119	int unit;
120	struct in_addr addr;
121};
122
123/* for mobile encaps */
124
125struct mobile_h {
126	u_int16_t proto;		/* protocol and S-bit */
127	u_int16_t hcrc;			/* header checksum */
128	u_int32_t odst;			/* original destination address */
129	u_int32_t osrc;			/* original source addr, if S-bit set */
130} __attribute__((__packed__));
131
132struct mobip_h {
133	struct ip	mi;
134	struct mobile_h	mh;
135} __attribute__((__packed__));
136
137
138#define MOB_H_SIZ_S		(sizeof(struct mobile_h) - sizeof(u_int32_t))
139#define MOB_H_SIZ_L		(sizeof(struct mobile_h))
140#define MOB_H_SBIT	0x0080
141
142#define	GRE_TTL	30
143extern int ip_gre_ttl;
144
145/*
146 * ioctls needed to manipulate the interface
147 */
148
149#define GRESADDRS	_IOW('i', 101, struct ifreq)
150#define GRESADDRD	_IOW('i', 102, struct ifreq)
151#define GREGADDRS	_IOWR('i', 103, struct ifreq)
152#define GREGADDRD	_IOWR('i', 104, struct ifreq)
153#define GRESPROTO	_IOW('i' , 105, struct ifreq)
154#define GREGPROTO	_IOWR('i', 106, struct ifreq)
155
156#ifdef _KERNEL
157LIST_HEAD(gre_softc_head, gre_softc);
158extern struct gre_softc_head gre_softc_list;
159
160int	gre_ioctl __P((struct ifnet *, u_long, caddr_t));
161int	gre_output __P((struct ifnet *, struct mbuf *, struct sockaddr *,
162	    struct rtentry *rt));
163u_short	gre_in_cksum(u_short *p, u_int len);
164#endif /* _KERNEL */
165
166#endif
167