2 * l2_output.h : layer 2 output packet 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_output_h
19 #define included_vnet_l2_output_h
21 #include <vlib/vlib.h>
22 #include <vnet/vnet.h>
23 #include <vnet/l2/feat_bitmap.h>
24 #include <vnet/l2/l2_vtr.h>
27 // The L2 output feature configuration, a per-interface struct
32 // vlan tag rewrite for ingress and egress
33 // ingress vtr is located here because the same config data is used for
34 // the egress EFP filter check
35 vtr_config_t input_vtr;
36 vtr_config_t output_vtr;
38 // some of these flags may get integrated into the feature bitmap
42 // split horizon group
48 // The set of next nodes for features and interface output.
49 // Each output feature node should include this.
51 // vector of output next node index, indexed by sw_if_index.
52 // used when all output features have been executed and the
53 // next nodes are the interface output nodes.
54 u32 * output_node_index_vec;
56 // array of next node index for each output feature, indexed
57 // by l2output_feat_t. Used to determine next feature node.
58 u32 feat_next_node_index[32];
60 } l2_output_next_nodes_st;
64 // Next nodes for features and output interfaces
65 l2_output_next_nodes_st next_nodes;
67 /* config vector indexed by sw_if_index */
68 l2_output_config_t *configs;
70 /* Convenience variables */
71 vlib_main_t * vlib_main;
72 vnet_main_t * vnet_main;
75 l2output_main_t l2output_main;
76 vlib_node_registration_t l2output_node;
80 // Mappings from feature ID to graph node name
81 #define foreach_l2output_feat \
82 _(SPAN, "feature-bitmap-drop") \
83 _(CFM, "feature-bitmap-drop") \
84 _(QOS, "feature-bitmap-drop") \
85 _(ACL, "l2-output-acl") \
86 _(L2PT, "feature-bitmap-drop") \
87 _(EFP_FILTER, "l2-efp-filter") \
88 _(IPIW, "feature-bitmap-drop") \
89 _(STP_BLOCKED, "feature-bitmap-drop") \
90 _(LINESTATUS_DOWN, "feature-bitmap-drop") \
93 // Feature bitmap positions
95 #define _(sym,str) L2OUTPUT_FEAT_##sym##_BIT,
103 #define _(sym,str) L2OUTPUT_FEAT_##sym = (1<<L2OUTPUT_FEAT_##sym##_BIT),
104 foreach_l2output_feat
106 } l2output_feat_masks_t;
108 // Return an array of strings containing graph node names of each feature
109 char **l2output_get_feat_names(void);
112 // The next set of functions is for use by output feature graph nodes.
113 // When the last bit has been cleared from the output feature bitmap,
114 // the next node is the output graph node for the TX sw_if_index.
115 // These functions help the feature nodes get that node index.
117 // Create a mapping to the output graph node for the given sw_if_index
118 u32 l2output_create_output_node_mapping (
119 vlib_main_t * vlib_main,
120 vnet_main_t * vnet_main,
121 u32 node_index, // index of current node
122 u32 * output_node_index_vec,
125 // Initialize the next node mapping table
127 void l2output_init_output_node_vec (u32 **output_node_index_vec) {
129 // Size it at 100 sw_if_indexes initially
130 // Uninitialized mappings are set to ~0
131 vec_validate_init_empty(*output_node_index_vec, 100, ~0);
135 // Get a mapping from the output node mapping table,
136 // creating the entry if necessary.
138 u32 l2output_get_output_node (vlib_main_t * vlib_main,
139 vnet_main_t * vnet_main,
140 u32 node_index, // index of current node
142 u32 ** output_node_index_vec) // may be updated
144 u32 next; // index of next graph node
146 // Insure the vector is big enough
147 vec_validate_init_empty(*output_node_index_vec, sw_if_index, ~0);
149 // Get the mapping for the sw_if_index
150 next = vec_elt(*output_node_index_vec, sw_if_index);
153 // Mapping doesn't exist so create it
154 next = l2output_create_output_node_mapping (vlib_main,
157 *output_node_index_vec,
165 // Determine the next L2 node based on the output feature bitmap
167 l2_output_dispatch (vlib_main_t * vlib_main,
168 vnet_main_t * vnet_main,
169 vlib_node_runtime_t * node,
171 u32 * cached_sw_if_index,
172 u32 * cached_next_index,
173 l2_output_next_nodes_st *next_nodes,
179 if (feature_bitmap) {
180 // There are some features to execute
182 // Save bitmap for the next feature graph nodes
183 vnet_buffer(b0)->l2.feature_bitmap = feature_bitmap;
185 // Determine the next node
186 *next0 = feat_bitmap_get_next_node_index(next_nodes->feat_next_node_index,
189 // There are no features. Send packet to TX node for sw_if_index0
190 // This is a little tricky in that the output interface next node indexes
191 // are not precomputed at init time.
193 if (sw_if_index == *cached_sw_if_index) {
194 // We hit in the one-entry cache. Use it.
195 *next0 = *cached_next_index;
197 // Look up the output TX node
198 *next0 = l2output_get_output_node(vlib_main,
202 &next_nodes->output_node_index_vec);
204 // Update the one-entry cache
205 *cached_sw_if_index = sw_if_index;
206 *cached_next_index = *next0;
211 // Get a pointer to the config for the given interface
212 l2_output_config_t * l2output_intf_config (u32 sw_if_index);
214 // Enable (or disable) the feature in the bitmap for the given interface
215 void l2output_intf_bitmap_enable (u32 sw_if_index,