2 * Copyright (c) 2018 Cisco and/or its affiliates.
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.
15 #ifndef __included_vxlan_gbp_packet_h__
16 #define __included_vxlan_gbp_packet_h__ 1
18 #include <vlib/vlib.h>
21 * From draft-smith-vxlan-group-policy-04.txt
24 * 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
25 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
26 * |G|R|R|R|I|R|R|R|R|D|E|S|A|R|R|R| Group Policy ID |
27 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
28 * | VXLAN Network Identifier (VNI) | Reserved |
29 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
31 * G bit: Bit 0 of the initial word is defined as the G (Group Based
32 * Policy Extension) bit.
34 * I bit: where the I flag MUST be set to 1 for a valid
35 * VXLAN Network ID (VNI).
37 * D bit: Bit 9 of the initial word is defined as the Don't Learn bit.
38 * When set, this bit indicates that the egress VTEP MUST NOT learn the
39 * source address of the encapsulated frame.
41 * E bit: Bit 10 of the initial word is defined as the bounce packet.
42 * When set, this bit indicates that packet is bounced and must be
45 * S bit: Bit 11 of the initial word is defined as the source policy
48 * A bit: Bit 12 of the initial word is defined as the A (Policy
49 * Applied) bit. This bit is only defined as the A bit when the G bit
52 * A = 1 indicates that the group policy has already been applied to
53 * this packet. Policies MUST NOT be applied by devices when the A
56 * A = 0 indicates that the group policy has not been applied to this
57 * packet. Group policies MUST be applied by devices when the A bit
58 * is set to 0 and the destination Group has been determined.
59 * Devices that apply the Group policy MUST set the A bit to 1 after
60 * the policy has been applied.
62 * Group Policy ID: 16 bit identifier that indicates the source TSI
63 * Group membership being encapsulated by VXLAN. Its value is source
66 * FOR INTERNAL USE ONLY
67 * R bit: Bit 12 of the initial word is defined as the reflection bit
68 * Set on packet rx checked on tx and dropped if set. this prevents
69 * packets recieved on an iVXLAN tunnel being reflected back to
90 u32 flags_sclass_as_u32;
95 #define foreach_vxlan_gbp_flags \
101 VXLAN_GBP_FLAGS_NONE = 0,
102 #define _(n,f) VXLAN_GBP_FLAGS_##f = n,
103 foreach_vxlan_gbp_flags
105 } __attribute__ ((packed)) vxlan_gbp_flags_t;
107 #define foreach_vxlan_gbp_gpflags \
116 VXLAN_GBP_GPFLAGS_NONE = 0,
117 #define _(n,f) VXLAN_GBP_GPFLAGS_##f = n,
118 foreach_vxlan_gbp_gpflags
120 } __attribute__ ((packed)) vxlan_gbp_gpflags_t;
123 vxlan_gbp_get_vni (vxlan_gbp_header_t * h)
125 u32 vni_reserved_host_byte_order;
127 vni_reserved_host_byte_order = clib_net_to_host_u32 (h->vni_reserved);
128 return vni_reserved_host_byte_order >> 8;
132 vxlan_gbp_get_sclass (vxlan_gbp_header_t * h)
134 u16 sclass_host_byte_order;
136 sclass_host_byte_order = clib_net_to_host_u16 (h->sclass);
137 return sclass_host_byte_order;
140 static inline vxlan_gbp_gpflags_t
141 vxlan_gbp_get_gpflags (vxlan_gbp_header_t * h)
146 static inline vxlan_gbp_flags_t
147 vxlan_gbp_get_flags (vxlan_gbp_header_t * h)
153 vxlan_gbp_set_header (vxlan_gbp_header_t * h, u32 vni)
155 h->vni_reserved = clib_host_to_net_u32 (vni << 8);
156 h->flags_sclass_as_u32 = 0;
157 h->flag_g_i = VXLAN_GBP_FLAGS_I | VXLAN_GBP_FLAGS_G;
160 extern u8 *format_vxlan_gbp_header_flags (u8 * s, va_list * args);
161 extern u8 *format_vxlan_gbp_header_gpflags (u8 * s, va_list * args);
163 #endif /* __included_vxlan_gbp_packet_h__ */
166 * fd.io coding-style-patch-verification: ON
169 * eval: (c-set-style "gnu")