1 /*      $OpenBSD: if_gre.h,v 1.10 2005/05/14 19:24:23 brad Exp $ */
2 /*	$NetBSD: if_gre.h,v 1.5 1999/11/19 20:41:19 thorpej Exp $ */
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 struct gre_softc {
44 	struct ifnet sc_if;
45 	LIST_ENTRY(gre_softc) sc_list;
46 	int gre_unit;
47 	int gre_flags;
48 	struct    in_addr g_src;  /* source address of gre packets */
49 	struct    in_addr g_dst;  /* destination address of gre packets */
50 	struct route route;	/* routing entry that determines, where a
51                                    encapsulated packet should go */
52 	u_char g_proto;		/* protocol of encapsulator */
53 };
54 
55 
56 struct gre_h {
57 	u_int16_t flags;	/* GRE flags */
58 	u_int16_t ptype;	/* protocol type of payload typically
59                                Ether protocol type*/
60 /*
61  *  from here on: fields are optional, presence indicated by flags
62  *
63 	u_int_16 checksum	 checksum (one-complements of GRE header
64                              and payload
65                              Present if (ck_pres | rt_pres == 1).
66                              Valid if (ck_pres == 1).
67 	u_int_16 offset			 offset from start of routing filed to
68                              first octet of active SRE (see below).
69                              Present if (ck_pres | rt_pres == 1).
70                              Valid if (rt_pres == 1).
71 	u_int_32 key         inserted by encapsulator e.g. for
72                              authentication
73                              Present if (key_pres ==1 ).
74 	u_int_32 seq_num     Sequence number to allow for packet order
75                              Present if (seq_pres ==1 ).
76 
77     struct gre_sre[] routing Routing fileds (see below)
78                              Present if (rt_pres == 1)
79 */
80 } __packed;
81 
82 struct greip {
83 	struct ip gi_i;
84 	struct gre_h  gi_g;
85 } __packed;
86 
87 #define gi_pr           gi_i.ip_p
88 #define gi_len          gi_i.ip_len
89 #define gi_src          gi_i.ip_src
90 #define gi_dst          gi_i.ip_dst
91 #define gi_ptype	gi_g.ptype
92 #define gi_flags	gi_g.flags
93 
94 #define GRE_CP          0x8000  /* Checksum Present */
95 #define GRE_RP          0x4000  /* Routing Present */
96 #define GRE_KP          0x2000  /* Key Present */
97 #define GRE_SP          0x1000  /* Sequence Present */
98 #define GRE_SS		0x0800	/* Strict Source Route */
99 
100 /* gre_sre defines a Source route Entry. These are needed if packets
101  *  should be routed over more than one tunnel hop by hop
102  */
103 
104 struct gre_sre {
105 	u_int16_t sre_family;	/* address family */
106 	u_char  sre_offset;	/* offset to first octet of active entry */
107 	u_char  sre_length;	/* number of octets in the SRE.
108                                sre_lengthl==0 -> last entry. */
109 	u_char  *sre_rtinfo;	/* the routing information */
110 };
111 
112 struct greioctl {
113 	int unit;
114 	struct    in_addr addr;
115 };
116 
117 /* for mobile encaps */
118 
119 struct mobile_h {
120 	u_int16_t proto;		/* protocol and S-bit */
121 	u_int16_t hcrc;			/* header checksum */
122 	u_int32_t odst;			/* original destination address */
123 	u_int32_t osrc;			/* original source addr, if S-bit set */
124 } __packed;
125 
126 struct mobip_h {
127 	struct ip       mi;
128 	struct mobile_h mh;
129 } __packed;
130 
131 
132 #define MOB_H_SIZ_S		(sizeof(struct mobile_h) - sizeof(u_int32_t))
133 #define MOB_H_SIZ_L		(sizeof(struct mobile_h))
134 #define MOB_H_SBIT	0x0080
135 
136 
137 /*
138  * ioctls needed to manipulate the interface
139  */
140 
141 #ifdef _KERNEL
142 extern  LIST_HEAD(gre_softc_head, gre_softc) gre_softc_list;
143 extern  int gre_allow;
144 extern  int gre_wccp;
145 extern  int ip_mobile_allow;
146 
147 void	greattach(int);
148 int     gre_ioctl(struct ifnet *, u_long, caddr_t);
149 int     gre_output(struct ifnet *, struct mbuf *, struct sockaddr *,
150 	    struct rtentry *);
151 u_int16_t gre_in_cksum(u_int16_t *, u_int);
152 #endif /* _KERNEL */
153 #endif /* _NET_IF_GRE_H_ */
154