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