2 * Copyright (c) 2017 SUSE LLC.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #ifndef included_vnet_geneve_packet_h
17 #define included_vnet_geneve_packet_h
21 * As per draft https://tools.ietf.org/html/draft-ietf-nvo3-geneve-05
25 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
26 * | Option Class | Type |R|R|R| Length |
27 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
28 * | Variable Option Data |
29 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
31 #define GENEVE_MAX_OPT_LENGTH 128
35 * As per draft https://tools.ietf.org/html/draft-ietf-nvo3-geneve-05
39 * +----------------+--------------------------------------+
40 * | Option Class | Description |
41 * +----------------+--------------------------------------+
42 * | 0x0000..0x00FF | Unassigned - IETF Review |
44 * | 0x0101 | Open vSwitch |
45 * | 0x0102 | Open Virtual Networking (OVN) |
46 * | 0x0103 | In-band Network Telemetry (INT) |
48 * | 0x0105..0xFFEF | Unassigned - First Come First Served |
49 * | 0xFFF0..FFFF | Experimental |
50 * +----------------+--------------------------------------+
52 #define LINUX_OPT_CLASS 0x0100
53 #define OVS_OPT_CLASS 0x0101
54 #define OVN_OPT_CLASS 0x0102
55 #define INT_OPT_CLASS 0x0103
56 #define VMWARE_OPT_CLASS 0x0104
60 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
61 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
62 * | Option Class | Type |R|R|R| Length |
63 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
64 * | Variable Option Data |
65 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
71 /* The 3 reserved bits are for future use;
72 * Need to be 0 on sending and ignored on receipt.
75 /* Length is expressed in 4-bytes multiples excluding the options header. */
82 * As per draft https://tools.ietf.org/html/draft-ietf-nvo3-geneve-05
86 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
87 * |Ver| Opt Len |O|C| Rsvd. | Protocol Type |
88 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
89 * | Virtual Network Identifier (VNI) | Reserved |
90 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
91 * | Variable Length Options |
92 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
95 #define GENEVE_BASE_HEADER_LENGTH 8 // GENEVE BASE HEADER in bytes
96 #define GENEVE_MAX_TOTAL_HDR_LENGTH 260
98 #define GENEVE_VERSION 0
99 #define GENEVE_ETH_PROTOCOL 0x6558
104 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
105 * |Ver| Opt Len |O|C| Rsvd. | Protocol Type |
106 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
111 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
112 * | Virtual Network Identifier (VNI) | Reserved |
113 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
116 geneve_options_t opts[];
119 #define GENEVE_VERSION_SHIFT 30
120 #define GENEVE_OPTLEN_SHIFT 24
121 #define GENEVE_O_BIT_SHIFT 23
122 #define GENEVE_C_BIT_SHIFT 22
123 #define GENEVE_6_RESERVED_SHIFT 16
124 #define GENEVE_VNI_SHIFT 8
126 #define GENEVE_VERSION_MASK 0xC0000000
127 #define GENEVE_OPTLEN_MASK 0x3F000000
128 #define GENEVE_O_BIT_MASK 0x00800000
129 #define GENEVE_C_BIT_MASK 0x00400000
130 #define GENEVE_6_RESERVED_MASK 0x003F0000
131 #define GENEVE_PROTOCOL_MASK 0x0000FFFF
132 #define GENEVE_VNI_MASK 0xFFFFFF00
135 * Return the VNI in host-byte order
138 vnet_get_geneve_vni (geneve_header_t * h)
140 return (clib_net_to_host_u32 (h->vni_rsvd & GENEVE_VNI_MASK) >>
145 * Return the VNI in network-byte order
147 * To be used in the DECAP phase to create the lookup key (IP + VNI)
150 vnet_get_geneve_vni_bigendian (geneve_header_t * h)
152 u32 vni_host = vnet_get_geneve_vni (h);
153 return clib_host_to_net_u32 ((vni_host << GENEVE_VNI_SHIFT) &
158 vnet_set_geneve_vni (geneve_header_t * h, u32 vni)
160 h->vni_rsvd &= ~(GENEVE_VNI_MASK);
162 clib_host_to_net_u32 ((vni << GENEVE_VNI_SHIFT) & GENEVE_VNI_MASK);
166 vnet_get_geneve_version (geneve_header_t * h)
168 return ((h->first_word & GENEVE_VERSION_MASK) >> GENEVE_VERSION_SHIFT);
172 vnet_set_geneve_version (geneve_header_t * h, u8 version)
174 h->first_word &= ~(GENEVE_VERSION_MASK);
175 h->first_word |= ((version << GENEVE_VERSION_SHIFT) & GENEVE_VERSION_MASK);
179 vnet_get_geneve_options_len (geneve_header_t * h)
181 return ((h->first_word & GENEVE_OPTLEN_MASK) >> GENEVE_OPTLEN_SHIFT);
185 vnet_set_geneve_options_len (geneve_header_t * h, u8 len)
187 h->first_word &= ~(GENEVE_OPTLEN_MASK);
188 h->first_word |= ((len << GENEVE_OPTLEN_SHIFT) & GENEVE_OPTLEN_MASK);
192 vnet_get_geneve_oamframe_bit (geneve_header_t * h)
194 return ((h->first_word & GENEVE_O_BIT_MASK) >> GENEVE_O_BIT_SHIFT);
198 vnet_set_geneve_oamframe_bit (geneve_header_t * h, u8 oam)
200 h->first_word &= ~(GENEVE_O_BIT_MASK);
201 h->first_word |= ((oam << GENEVE_O_BIT_SHIFT) & GENEVE_O_BIT_MASK);
205 vnet_get_geneve_critical_bit (geneve_header_t * h)
207 return ((h->first_word & GENEVE_C_BIT_MASK) >> GENEVE_C_BIT_SHIFT);
211 vnet_set_geneve_critical_bit (geneve_header_t * h, u8 critical_opts)
213 h->first_word &= ~(GENEVE_C_BIT_MASK);
215 ((critical_opts << GENEVE_C_BIT_SHIFT) & GENEVE_C_BIT_MASK);
219 vnet_get_geneve_protocol (geneve_header_t * h)
221 return (h->first_word & GENEVE_PROTOCOL_MASK);
225 vnet_set_geneve_protocol (geneve_header_t * h, u16 protocol)
227 h->first_word &= ~(GENEVE_PROTOCOL_MASK);
228 h->first_word |= (protocol & GENEVE_PROTOCOL_MASK);
232 vnet_geneve_hdr_1word_ntoh (geneve_header_t * h)
234 h->first_word = clib_net_to_host_u32 (h->first_word);
238 vnet_geneve_hdr_1word_hton (geneve_header_t * h)
240 h->first_word = clib_host_to_net_u32 (h->first_word);
246 * fd.io coding-style-patch-verification: ON
249 * eval: (c-set-style "gnu")