2 * Copyright (c) 2015 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.
16 * hdlc_node.c: hdlc packet processing
18 * Copyright (c) 2010 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 #include <vlib/vlib.h>
41 #include <vnet/pg/pg.h>
42 #include <vnet/hdlc/hdlc.h>
43 #include <vppinfra/sparse_vec.h>
45 #define foreach_hdlc_input_next \
46 _ (PUNT, "error-punt") \
47 _ (DROP, "error-drop")
51 #define _(s,n) HDLC_INPUT_NEXT_##s,
52 foreach_hdlc_input_next
63 format_hdlc_input_trace (u8 * s, va_list * va)
65 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
66 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
67 hdlc_input_trace_t *t = va_arg (*va, hdlc_input_trace_t *);
69 s = format (s, "%U", format_hdlc_header, t->packet_data);
76 /* Sparse vector mapping hdlc protocol in network byte order
78 u16 *next_by_protocol;
80 u32 *sparse_index_by_next_index;
81 } hdlc_input_runtime_t;
84 hdlc_input (vlib_main_t * vm,
85 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
87 hdlc_input_runtime_t *rt = (void *) node->runtime_data;
88 u32 n_left_from, next_index, i_next, *from, *to_next;
90 from = vlib_frame_vector_args (from_frame);
91 n_left_from = from_frame->n_vectors;
93 if (node->flags & VLIB_NODE_FLAG_TRACE)
94 vlib_trace_frame_buffers_only (vm, node,
98 sizeof (hdlc_input_trace_t));
100 next_index = node->cached_next_index;
101 i_next = vec_elt (rt->sparse_index_by_next_index, next_index);
103 while (n_left_from > 0)
107 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
109 while (n_left_from >= 4 && n_left_to_next >= 2)
112 vlib_buffer_t *b0, *b1;
113 hdlc_header_t *h0, *h1;
114 u32 i0, i1, len0, len1, protocol0, protocol1, enqueue_code;
116 /* Prefetch next iteration. */
118 vlib_buffer_t *b2, *b3;
120 b2 = vlib_get_buffer (vm, from[2]);
121 b3 = vlib_get_buffer (vm, from[3]);
123 vlib_prefetch_buffer_header (b2, LOAD);
124 vlib_prefetch_buffer_header (b3, LOAD);
126 CLIB_PREFETCH (b2->data, sizeof (h0[0]), LOAD);
127 CLIB_PREFETCH (b3->data, sizeof (h1[0]), LOAD);
139 b0 = vlib_get_buffer (vm, bi0);
140 b1 = vlib_get_buffer (vm, bi1);
142 h0 = vlib_buffer_get_current (b0);
143 h1 = vlib_buffer_get_current (b1);
145 protocol0 = h0->protocol;
146 protocol1 = h1->protocol;
148 /* Add padding bytes for OSI protocols. */
149 len0 = sizeof (h0[0]);
150 len1 = sizeof (h1[0]);
152 len0 += protocol0 == clib_host_to_net_u16 (HDLC_PROTOCOL_osi);
153 len1 += protocol1 == clib_host_to_net_u16 (HDLC_PROTOCOL_osi);
155 vlib_buffer_advance (b0, len0);
156 vlib_buffer_advance (b1, len1);
158 /* Index sparse array with network byte order. */
159 sparse_vec_index2 (rt->next_by_protocol, protocol0, protocol1, &i0,
164 SPARSE_VEC_INVALID_INDEX ?
165 HDLC_ERROR_UNKNOWN_PROTOCOL : HDLC_ERROR_NONE];
168 SPARSE_VEC_INVALID_INDEX ?
169 HDLC_ERROR_UNKNOWN_PROTOCOL : HDLC_ERROR_NONE];
171 enqueue_code = (i0 != i_next) + 2 * (i1 != i_next);
173 if (PREDICT_FALSE (enqueue_code != 0))
175 switch (enqueue_code)
182 vlib_set_next_frame_buffer (vm, node,
183 vec_elt (rt->next_by_protocol,
191 vlib_set_next_frame_buffer (vm, node,
192 vec_elt (rt->next_by_protocol,
200 vlib_set_next_frame_buffer (vm, node,
201 vec_elt (rt->next_by_protocol,
203 vlib_set_next_frame_buffer (vm, node,
204 vec_elt (rt->next_by_protocol,
208 vlib_put_next_frame (vm, node, next_index,
211 next_index = vec_elt (rt->next_by_protocol, i_next);
212 vlib_get_next_frame (vm, node, next_index, to_next,
219 while (n_left_from > 0 && n_left_to_next > 0)
224 u32 i0, len0, protocol0;
233 b0 = vlib_get_buffer (vm, bi0);
235 h0 = vlib_buffer_get_current (b0);
237 protocol0 = h0->protocol;
239 /* Add padding bytes for OSI protocols. */
240 len0 = sizeof (h0[0]);
241 len0 += protocol0 == clib_host_to_net_u16 (HDLC_PROTOCOL_osi);
243 vlib_buffer_advance (b0, len0);
245 i0 = sparse_vec_index (rt->next_by_protocol, protocol0);
249 SPARSE_VEC_INVALID_INDEX ?
250 HDLC_ERROR_UNKNOWN_PROTOCOL : HDLC_ERROR_NONE];
252 /* Sent packet to wrong next? */
253 if (PREDICT_FALSE (i0 != i_next))
255 /* Return old frame; remove incorrectly enqueued packet. */
256 vlib_put_next_frame (vm, node, next_index, n_left_to_next + 1);
258 /* Send to correct next. */
260 next_index = vec_elt (rt->next_by_protocol, i_next);
261 vlib_get_next_frame (vm, node, next_index,
262 to_next, n_left_to_next);
270 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
273 return from_frame->n_vectors;
276 static char *hdlc_error_strings[] = {
277 #define hdlc_error(n,s) s,
283 VLIB_REGISTER_NODE (hdlc_input_node) = {
284 .function = hdlc_input,
285 .name = "hdlc-input",
286 /* Takes a vector of packets. */
287 .vector_size = sizeof (u32),
289 .runtime_data_bytes = sizeof (hdlc_input_runtime_t),
291 .n_errors = HDLC_N_ERROR,
292 .error_strings = hdlc_error_strings,
294 .n_next_nodes = HDLC_INPUT_N_NEXT,
296 #define _(s,n) [HDLC_INPUT_NEXT_##s] = n,
297 foreach_hdlc_input_next
301 .format_buffer = format_hdlc_header_with_length,
302 .format_trace = format_hdlc_input_trace,
303 .unformat_buffer = unformat_hdlc_header,
307 static clib_error_t *
308 hdlc_input_runtime_init (vlib_main_t * vm)
310 hdlc_input_runtime_t *rt;
311 rt = vlib_node_get_runtime_data (vm, hdlc_input_node.index);
313 rt->next_by_protocol = sparse_vec_new
314 ( /* elt bytes */ sizeof (rt->next_by_protocol[0]),
315 /* bits in index */ BITS (((hdlc_header_t *) 0)->protocol));
317 vec_validate (rt->sparse_index_by_next_index, HDLC_INPUT_NEXT_DROP);
318 vec_validate (rt->sparse_index_by_next_index, HDLC_INPUT_NEXT_PUNT);
319 rt->sparse_index_by_next_index[HDLC_INPUT_NEXT_DROP]
320 = SPARSE_VEC_INVALID_INDEX;
321 rt->sparse_index_by_next_index[HDLC_INPUT_NEXT_PUNT]
322 = SPARSE_VEC_INVALID_INDEX;
327 static clib_error_t *
328 hdlc_input_init (vlib_main_t * vm)
332 clib_error_t *error = vlib_call_init_function (vm, hdlc_init);
334 clib_error_report (error);
337 hdlc_setup_node (vm, hdlc_input_node.index);
338 hdlc_input_runtime_init (vm);
343 VLIB_INIT_FUNCTION (hdlc_input_init);
344 VLIB_WORKER_INIT_FUNCTION (hdlc_input_runtime_init);
347 hdlc_register_input_protocol (vlib_main_t * vm,
348 hdlc_protocol_t protocol, u32 node_index)
350 hdlc_main_t *em = &hdlc_main;
351 hdlc_protocol_info_t *pi;
352 hdlc_input_runtime_t *rt;
357 clib_error_t *error = vlib_call_init_function (vm, hdlc_input_init);
359 clib_error_report (error);
362 pi = hdlc_get_protocol_info (em, protocol);
363 pi->node_index = node_index;
364 pi->next_index = vlib_node_add_next (vm, hdlc_input_node.index, node_index);
366 /* Setup hdlc protocol -> next index sparse vector mapping. */
367 rt = vlib_node_get_runtime_data (vm, hdlc_input_node.index);
369 sparse_vec_validate (rt->next_by_protocol,
370 clib_host_to_net_u16 (protocol));
371 n[0] = pi->next_index;
373 /* Rebuild next index -> sparse index inverse mapping when sparse vector
375 vec_validate (rt->sparse_index_by_next_index, pi->next_index);
376 for (i = 1; i < vec_len (rt->next_by_protocol); i++)
377 rt->sparse_index_by_next_index[rt->next_by_protocol[i]] = i;
381 * fd.io coding-style-patch-verification: ON
384 * eval: (c-set-style "gnu")