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")
50 #define _(s,n) HDLC_INPUT_NEXT_##s,
51 foreach_hdlc_input_next
60 static u8 * format_hdlc_input_trace (u8 * s, va_list * va)
62 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
63 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
64 hdlc_input_trace_t * t = va_arg (*va, hdlc_input_trace_t *);
66 s = format (s, "%U", format_hdlc_header, t->packet_data);
72 /* Sparse vector mapping hdlc protocol in network byte order
74 u16 * next_by_protocol;
76 u32 * sparse_index_by_next_index;
77 } hdlc_input_runtime_t;
80 hdlc_input (vlib_main_t * vm,
81 vlib_node_runtime_t * node,
82 vlib_frame_t * from_frame)
84 hdlc_input_runtime_t * rt = (void *) node->runtime_data;
85 u32 n_left_from, next_index, i_next, * from, * to_next;
87 from = vlib_frame_vector_args (from_frame);
88 n_left_from = from_frame->n_vectors;
90 if (node->flags & VLIB_NODE_FLAG_TRACE)
91 vlib_trace_frame_buffers_only (vm, node,
95 sizeof (hdlc_input_trace_t));
97 next_index = node->cached_next_index;
98 i_next = vec_elt (rt->sparse_index_by_next_index, next_index);
100 while (n_left_from > 0)
104 vlib_get_next_frame (vm, node, next_index,
105 to_next, n_left_to_next);
107 while (n_left_from >= 4 && n_left_to_next >= 2)
110 vlib_buffer_t * b0, * b1;
111 hdlc_header_t * h0, * h1;
112 u32 i0, i1, len0, len1, protocol0, protocol1, enqueue_code;
114 /* Prefetch next iteration. */
116 vlib_buffer_t * b2, * b3;
118 b2 = vlib_get_buffer (vm, from[2]);
119 b3 = vlib_get_buffer (vm, from[3]);
121 vlib_prefetch_buffer_header (b2, LOAD);
122 vlib_prefetch_buffer_header (b3, LOAD);
124 CLIB_PREFETCH (b2->data, sizeof (h0[0]), LOAD);
125 CLIB_PREFETCH (b3->data, sizeof (h1[0]), LOAD);
137 b0 = vlib_get_buffer (vm, bi0);
138 b1 = vlib_get_buffer (vm, bi1);
140 h0 = (void *) (b0->data + b0->current_data);
141 h1 = (void *) (b1->data + b1->current_data);
143 protocol0 = h0->protocol;
144 protocol1 = h1->protocol;
146 /* Add padding bytes for OSI protocols. */
147 len0 = sizeof (h0[0]);
148 len1 = sizeof (h1[0]);
150 len0 += protocol0 == clib_host_to_net_u16 (HDLC_PROTOCOL_osi);
151 len1 += protocol1 == clib_host_to_net_u16 (HDLC_PROTOCOL_osi);
153 b0->current_data += len0;
154 b1->current_data += len1;
156 b0->current_length -= len0;
157 b1->current_length -= len1;
159 /* Index sparse array with network byte order. */
160 sparse_vec_index2 (rt->next_by_protocol, protocol0, protocol1, &i0, &i1);
162 b0->error = node->errors[i0 == SPARSE_VEC_INVALID_INDEX ? HDLC_ERROR_UNKNOWN_PROTOCOL : HDLC_ERROR_NONE];
163 b1->error = node->errors[i1 == SPARSE_VEC_INVALID_INDEX ? HDLC_ERROR_UNKNOWN_PROTOCOL : HDLC_ERROR_NONE];
165 enqueue_code = (i0 != i_next) + 2*(i1 != i_next);
167 if (PREDICT_FALSE (enqueue_code != 0))
169 switch (enqueue_code)
176 vlib_set_next_frame_buffer (vm, node, vec_elt (rt->next_by_protocol, i0), bi0);
183 vlib_set_next_frame_buffer (vm, node, vec_elt (rt->next_by_protocol, i1), bi1);
190 vlib_set_next_frame_buffer (vm, node, vec_elt (rt->next_by_protocol, i0), bi0);
191 vlib_set_next_frame_buffer (vm, node, vec_elt (rt->next_by_protocol, i1), bi1);
194 vlib_put_next_frame (vm, node, next_index,
197 next_index = vec_elt (rt->next_by_protocol, i_next);
198 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
204 while (n_left_from > 0 && n_left_to_next > 0)
209 u32 i0, len0, protocol0;
218 b0 = vlib_get_buffer (vm, bi0);
220 h0 = (void *) (b0->data + b0->current_data);
222 protocol0 = h0->protocol;
224 /* Add padding bytes for OSI protocols. */
225 len0 = sizeof (h0[0]);
226 len0 += protocol0 == clib_host_to_net_u16 (HDLC_PROTOCOL_osi);
228 b0->current_data += len0;
229 b0->current_length -= len0;
231 i0 = sparse_vec_index (rt->next_by_protocol, protocol0);
233 b0->error = node->errors[i0 == SPARSE_VEC_INVALID_INDEX ? HDLC_ERROR_UNKNOWN_PROTOCOL : HDLC_ERROR_NONE];
235 /* Sent packet to wrong next? */
236 if (PREDICT_FALSE (i0 != i_next))
238 /* Return old frame; remove incorrectly enqueued packet. */
239 vlib_put_next_frame (vm, node, next_index, n_left_to_next + 1);
241 /* Send to correct next. */
243 next_index = vec_elt (rt->next_by_protocol, i_next);
244 vlib_get_next_frame (vm, node, next_index,
245 to_next, n_left_to_next);
253 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
256 return from_frame->n_vectors;
259 static char * hdlc_error_strings[] = {
260 #define hdlc_error(n,s) s,
265 VLIB_REGISTER_NODE (hdlc_input_node) = {
266 .function = hdlc_input,
267 .name = "hdlc-input",
268 /* Takes a vector of packets. */
269 .vector_size = sizeof (u32),
271 .runtime_data_bytes = sizeof (hdlc_input_runtime_t),
273 .n_errors = HDLC_N_ERROR,
274 .error_strings = hdlc_error_strings,
276 .n_next_nodes = HDLC_INPUT_N_NEXT,
278 #define _(s,n) [HDLC_INPUT_NEXT_##s] = n,
279 foreach_hdlc_input_next
283 .format_buffer = format_hdlc_header_with_length,
284 .format_trace = format_hdlc_input_trace,
285 .unformat_buffer = unformat_hdlc_header,
288 static clib_error_t * hdlc_input_runtime_init (vlib_main_t * vm)
290 hdlc_input_runtime_t * rt;
291 rt = vlib_node_get_runtime_data (vm, hdlc_input_node.index);
293 rt->next_by_protocol = sparse_vec_new
294 (/* elt bytes */ sizeof (rt->next_by_protocol[0]),
295 /* bits in index */ BITS (((hdlc_header_t *) 0)->protocol));
297 vec_validate (rt->sparse_index_by_next_index, HDLC_INPUT_NEXT_DROP);
298 vec_validate (rt->sparse_index_by_next_index, HDLC_INPUT_NEXT_PUNT);
299 rt->sparse_index_by_next_index[HDLC_INPUT_NEXT_DROP]
300 = SPARSE_VEC_INVALID_INDEX;
301 rt->sparse_index_by_next_index[HDLC_INPUT_NEXT_PUNT]
302 = SPARSE_VEC_INVALID_INDEX;
307 static clib_error_t * hdlc_input_init (vlib_main_t * vm)
311 clib_error_t * error = vlib_call_init_function (vm, hdlc_init);
313 clib_error_report (error);
316 hdlc_setup_node (vm, hdlc_input_node.index);
317 hdlc_input_runtime_init (vm);
322 VLIB_INIT_FUNCTION (hdlc_input_init);
323 VLIB_WORKER_INIT_FUNCTION (hdlc_input_runtime_init);
326 hdlc_register_input_protocol (vlib_main_t * vm,
327 hdlc_protocol_t protocol,
330 hdlc_main_t * em = &hdlc_main;
331 hdlc_protocol_info_t * pi;
332 hdlc_input_runtime_t * rt;
337 clib_error_t * error = vlib_call_init_function (vm, hdlc_input_init);
339 clib_error_report (error);
342 pi = hdlc_get_protocol_info (em, protocol);
343 pi->node_index = node_index;
344 pi->next_index = vlib_node_add_next (vm,
345 hdlc_input_node.index,
348 /* Setup hdlc protocol -> next index sparse vector mapping. */
349 rt = vlib_node_get_runtime_data (vm, hdlc_input_node.index);
350 n = sparse_vec_validate (rt->next_by_protocol, clib_host_to_net_u16 (protocol));
351 n[0] = pi->next_index;
353 /* Rebuild next index -> sparse index inverse mapping when sparse vector
355 vec_validate (rt->sparse_index_by_next_index, pi->next_index);
356 for (i = 1; i < vec_len (rt->next_by_protocol); i++)
357 rt->sparse_index_by_next_index[rt->next_by_protocol[i]] = i;