BVI Interface
[vpp.git] / src / vnet / l2 / l2_bvi.h
1 /*
2  * l2_bvi.h : layer 2 Bridged Virtual Interface
3  *
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:
8  *
9  *     http://www.apache.org/licenses/LICENSE-2.0
10  *
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.
16  */
17
18 #ifndef included_l2bvi_h
19 #define included_l2bvi_h
20
21 #include <vlib/vlib.h>
22 #include <vnet/ethernet/ethernet.h>
23 #include <vppinfra/sparse_vec.h>
24
25 #include <vnet/l2/l2_input.h>
26
27 #define TO_BVI_ERR_OK        0
28 #define TO_BVI_ERR_BAD_MAC   1
29 #define TO_BVI_ERR_ETHERTYPE 2
30
31 /**
32  * Send a packet from L2 processing to L3 via the BVI interface.
33  * Set next0 to the proper L3 input node.
34  * Return an error if the packet isn't what we expect.
35  */
36
37 static_always_inline u32
38 l2_to_bvi (vlib_main_t * vlib_main,
39            vnet_main_t * vnet_main,
40            vlib_buffer_t * b0,
41            u32 bvi_sw_if_index, next_by_ethertype_t * l3_next, u16 * next0)
42 {
43   /* Perform L3 my-mac filter */
44   ethernet_header_t *e0 = vlib_buffer_get_current (b0);
45   if (!ethernet_address_cast (e0->dst_address))
46     {
47       vnet_hw_interface_t *hi =
48         vnet_get_sup_hw_interface (vnet_main, bvi_sw_if_index);
49       if (!ethernet_mac_address_equal (e0->dst_address, hi->hw_address))
50         return TO_BVI_ERR_BAD_MAC;
51     }
52
53   /* Save L2 header position which may be changed due to packet replication */
54   vnet_buffer (b0)->l2_hdr_offset = b0->current_data;
55
56   /* Strip L2 header */
57   u8 l2_len = vnet_buffer (b0)->l2.l2_len;
58   vlib_buffer_advance (b0, l2_len);
59
60   u8 *l3h = vlib_buffer_get_current (b0);
61   u16 ethertype = clib_net_to_host_u16 (*(u16 *) (l3h - 2));
62
63   /* Set the input interface to be the BVI interface */
64   vnet_buffer (b0)->sw_if_index[VLIB_RX] = bvi_sw_if_index;
65   vnet_buffer (b0)->sw_if_index[VLIB_TX] = ~0;
66
67   /* Go to appropriate L3 input node */
68   if (ethertype == ETHERNET_TYPE_IP4)
69     {
70       *next0 = l3_next->input_next_ip4;
71     }
72   else if (ethertype == ETHERNET_TYPE_IP6)
73     {
74       *next0 = l3_next->input_next_ip6;
75     }
76   else
77     {
78       /* uncommon ethertype, check table */
79       u32 i0 = sparse_vec_index (l3_next->input_next_by_type, ethertype);
80       *next0 = vec_elt (l3_next->input_next_by_type, i0);
81
82       if (i0 == SPARSE_VEC_INVALID_INDEX)
83         {
84           return TO_BVI_ERR_ETHERTYPE;
85         }
86     }
87
88   /* increment BVI RX interface stat */
89   vlib_increment_combined_counter
90     (vnet_main->interface_main.combined_sw_if_counters
91      + VNET_INTERFACE_COUNTER_RX,
92      vlib_main->thread_index, bvi_sw_if_index,
93      1, vlib_buffer_length_in_chain (vlib_main, b0));
94   return TO_BVI_ERR_OK;
95 }
96
97 void
98 l2bvi_register_input_type (vlib_main_t * vm,
99                            ethernet_type_t type, u32 node_index);
100
101 extern int l2_bvi_create (u32 instance, const mac_address_t * mac,
102                           u32 * sw_if_index);
103 extern int l2_bvi_delete (u32 sw_if_index);
104
105 #endif
106
107 /*
108  * fd.io coding-style-patch-verification: ON
109  *
110  * Local Variables:
111  * eval: (c-set-style "gnu")
112  * End:
113  */