2 * l2_vtr.h : layer 2 vlan tag rewrite processing
4 * Copyright (c) 2013 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #ifndef included_vnet_l2_vtr_h
19 #define included_vnet_l2_vtr_h
21 #include <vlib/vlib.h>
22 #include <vnet/vnet.h>
23 #include <vnet/ethernet/ethernet.h>
24 #include <vnet/ethernet/packet.h>
25 #include <vnet/l2/l2_vtr.h>
27 /* VTR config options for API and CLI support */
42 * Per-interface vlan tag rewrite configuration
43 * There will be one instance of this struct for each sw_if_index
44 * for both input vtr and output vtr
51 * Up to two vlan tags to push.
52 * if there is only one vlan tag to push, it is in tags[1].
54 ethernet_vlan_header_tv_t tags[2];
62 u8 push_bytes; /* number of bytes to push for up to 2 vlans (0,4,8) */
63 u8 pop_bytes; /* number of bytes to pop for up to 2 vlans (0,4,8) */
65 u16 push_and_pop_bytes; /* if 0 then the feature is disabled */
71 * Perform the configured tag rewrite on the packet.
72 * Return 0 if ok, 1 if packet should be dropped (e.g. tried to pop
76 l2_vtr_process (vlib_buffer_t * b0, vtr_config_t * config)
82 eth = vlib_buffer_get_current (b0);
84 /* copy the 12B dmac and smac to a temporary location */
85 temp_8 = *((u64 *) eth);
86 temp_4 = *((u32 *) (eth + 8));
88 /* adjust for popped tags */
89 eth += config->pop_bytes;
91 /* if not enough tags to pop then drop packet */
92 if (PREDICT_FALSE ((vnet_buffer (b0)->l2.l2_len - 12) < config->pop_bytes))
97 /* copy the 2 new tags to the start of the packet */
98 *((u64 *) (eth + 12 - 8)) = config->raw_tags;
100 /* TODO: set cos bits */
102 /* adjust for pushed tags: */
103 eth -= config->push_bytes;
105 /* copy the 12 dmac and smac back to the packet */
106 *((u64 *) eth) = temp_8;
107 *((u32 *) (eth + 8)) = temp_4;
109 /* Update l2 parameters */
110 vnet_buffer (b0)->l2.l2_len +=
111 (word) config->push_bytes - (word) config->pop_bytes;
112 vnet_buffer (b0)->l2_hdr_offset -=
113 (word) config->push_bytes - (word) config->pop_bytes;
115 /* Update vlan tag count */
116 ethernet_buffer_adjust_vlan_count_by_bytes (b0,
117 (word) config->push_bytes -
118 (word) config->pop_bytes);
120 /* Update packet len */
121 vlib_buffer_advance (b0,
122 (word) config->pop_bytes - (word) config->push_bytes);
129 * Perform the egress pre-vlan tag rewrite EFP Filter check.
130 * The post-vlan tag rewrite check is a separate graph node.
132 * This check insures that a packet being output to an interface
133 * (before output vtr is performed) has vlan tags that match those
134 * on a packet received from that interface (after vtr has been performed).
135 * This means verifying that any tags pushed by input vtr are present
138 * Return 0 if ok, 1 if packet should be dropped.
139 * This function should be passed the input vtr config for the interface.
142 l2_efp_filter_process (vlib_buffer_t * b0, vtr_config_t * in_config)
148 eth = vlib_buffer_get_current (b0);
151 * If there are 2 tags pushed, they must match config->tags[0] and
153 * If there is one tag pushed, it must match config->tag[1].
154 * If there are 0 tags pushed, the check passes.
157 /* mask for two vlan id and ethertypes, no cos bits */
158 tag_mask = clib_net_to_host_u64 (0xFFFF0FFFFFFF0FFF);
159 /* mask for one vlan id and ethertype, no cos bits */
161 (in_config->push_bytes ==
162 4) ? clib_net_to_host_u64 (0xFFFF0FFF) : tag_mask;
163 /* mask for always match */
164 tag_mask = (in_config->push_bytes == 0) ? 0 : tag_mask;
167 * Read 8B from the packet, getting the proper set of vlan tags
168 * For 0 push bytes, the address doesn't matter since the mask
169 * clears the data to 0.
171 packet_tags = *((u64 *) (eth + 4 + in_config->push_bytes));
173 /* Check if the packet tags match the configured tags */
174 return (packet_tags & tag_mask) != in_config->raw_tags;
181 ethernet_pbb_header_t macs_tags;
194 u8 push_bytes; /* number of bytes to push pbb tags */
195 u8 pop_bytes; /* number of bytes to pop pbb tags */
197 u16 push_and_pop_bytes; /* if 0 then the feature is disabled */
202 l2_pbb_process (vlib_buffer_t * b0, ptr_config_t * config)
204 u8 *eth = vlib_buffer_get_current (b0);
206 if (config->pop_bytes > 0)
208 ethernet_pbb_header_packed_t *ph = (ethernet_pbb_header_packed_t *) eth;
210 // drop packet without PBB header or with wrong I-tag or B-tag
211 if (clib_net_to_host_u16 (ph->priority_dei_id) !=
212 clib_net_to_host_u16 (config->macs_tags.priority_dei_id)
213 || clib_net_to_host_u32 (ph->priority_dei_uca_res_sid) !=
214 clib_net_to_host_u32 (config->macs_tags.priority_dei_uca_res_sid))
217 eth += config->pop_bytes;
220 if (config->push_bytes > 0)
222 eth -= config->push_bytes;
223 // copy the B-DA (6B), B-SA (6B), B-TAG (4B), I-TAG (6B)
224 *((u64 *) eth) = config->raw_data.data1;
225 *((u64 *) (eth + 8)) = config->raw_data.data2;
226 *((u16 *) (eth + 16)) = config->raw_data.data3;
227 *((u32 *) (eth + 18)) = config->raw_data.data4;
231 vnet_buffer (b0)->l2.l2_len +=
232 (word) config->push_bytes - (word) config->pop_bytes;
233 /* Update packet len */
234 vlib_buffer_advance (b0,
235 (word) config->pop_bytes - (word) config->push_bytes);
240 u32 l2pbb_configure (vlib_main_t * vlib_main,
241 vnet_main_t * vnet_main, u32 sw_if_index, u32 vtr_op,
242 u8 * b_dmac, u8 * b_smac,
243 u16 b_vlanid, u32 i_sid, u16 vlan_outer_tag);
246 * Configure vtag tag rewrite on the given interface.
247 * Return 1 if there is an error, 0 if ok
249 u32 l2vtr_configure (vlib_main_t * vlib_main,
250 vnet_main_t * vnet_main,
252 u32 vtr_op, u32 push_dot1q, u32 vtr_tag1, u32 vtr_tag2);
255 * Get vtag tag rewrite on the given interface.
256 * Return 1 if there is an error, 0 if ok
258 u32 l2vtr_get (vlib_main_t * vlib_main,
259 vnet_main_t * vnet_main,
262 u32 * push_dot1q, u32 * vtr_tag1, u32 * vtr_tag2);
265 * Get pbb tag rewrite on the given interface.
266 * Return 1 if there is an error, 0 if ok
268 u32 l2pbb_get (vlib_main_t * vlib_main,
269 vnet_main_t * vnet_main,
273 ethernet_header_t * eth_hdr, u16 * b_vlanid, u32 * i_sid);
275 #endif /* included_vnet_l2_vtr_h */
279 * fd.io coding-style-patch-verification: ON
282 * eval: (c-set-style "gnu")