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 * ppp_node.c: ppp 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/ppp/ppp.h>
43 #include <vppinfra/sparse_vec.h>
45 #define foreach_ppp_input_next \
46 _ (PUNT, "error-punt") \
47 _ (DROP, "error-drop")
51 #define _(s,n) PPP_INPUT_NEXT_##s,
52 foreach_ppp_input_next
63 format_ppp_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 ppp_input_trace_t *t = va_arg (*va, ppp_input_trace_t *);
69 s = format (s, "%U", format_ppp_header, t->packet_data);
76 /* Sparse vector mapping ppp protocol in network byte order
78 u16 *next_by_protocol;
80 u32 *sparse_index_by_next_index;
81 } ppp_input_runtime_t;
84 ppp_input (vlib_main_t * vm,
85 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
87 ppp_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 (ppp_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 ppp_header_t *h0, *h1;
114 u32 i0, i1, protocol0, protocol1, enqueue_code;
116 /* Prefetch next iteration. */
118 vlib_buffer_t *p2, *p3;
120 p2 = vlib_get_buffer (vm, from[2]);
121 p3 = vlib_get_buffer (vm, from[3]);
123 vlib_prefetch_buffer_header (p2, LOAD);
124 vlib_prefetch_buffer_header (p3, LOAD);
126 CLIB_PREFETCH (p2->data, sizeof (h0[0]), LOAD);
127 CLIB_PREFETCH (p3->data, sizeof (h1[0]), LOAD);
139 b0 = vlib_get_buffer (vm, bi0);
140 b1 = vlib_get_buffer (vm, bi1);
142 h0 = (void *) (b0->data + b0->current_data);
143 h1 = (void *) (b1->data + b1->current_data);
145 b0->current_data += sizeof (h0[0]);
146 b1->current_data += sizeof (h1[0]);
148 b0->current_length -= sizeof (h0[0]);
149 b1->current_length -= sizeof (h1[0]);
151 /* Index sparse array with network byte order. */
152 protocol0 = h0->protocol;
153 protocol1 = h1->protocol;
154 sparse_vec_index2 (rt->next_by_protocol, protocol0, protocol1, &i0,
159 SPARSE_VEC_INVALID_INDEX ? PPP_ERROR_UNKNOWN_PROTOCOL
163 SPARSE_VEC_INVALID_INDEX ? PPP_ERROR_UNKNOWN_PROTOCOL
166 enqueue_code = (i0 != i_next) + 2 * (i1 != i_next);
168 if (PREDICT_FALSE (enqueue_code != 0))
170 switch (enqueue_code)
177 vlib_set_next_frame_buffer (vm, node,
178 vec_elt (rt->next_by_protocol,
186 vlib_set_next_frame_buffer (vm, node,
187 vec_elt (rt->next_by_protocol,
195 vlib_set_next_frame_buffer (vm, node,
196 vec_elt (rt->next_by_protocol,
198 vlib_set_next_frame_buffer (vm, node,
199 vec_elt (rt->next_by_protocol,
203 vlib_put_next_frame (vm, node, next_index,
206 next_index = vec_elt (rt->next_by_protocol, i_next);
207 vlib_get_next_frame (vm, node, next_index, to_next,
214 while (n_left_from > 0 && n_left_to_next > 0)
228 b0 = vlib_get_buffer (vm, bi0);
230 h0 = (void *) (b0->data + b0->current_data);
232 b0->current_data += sizeof (h0[0]);
233 b0->current_length -= sizeof (h0[0]);
235 protocol0 = h0->protocol;
236 i0 = sparse_vec_index (rt->next_by_protocol, protocol0);
240 SPARSE_VEC_INVALID_INDEX ? PPP_ERROR_UNKNOWN_PROTOCOL
243 /* Sent packet to wrong next? */
244 if (PREDICT_FALSE (i0 != i_next))
246 /* Return old frame; remove incorrectly enqueued packet. */
247 vlib_put_next_frame (vm, node, next_index, n_left_to_next + 1);
249 /* Send to correct next. */
251 next_index = vec_elt (rt->next_by_protocol, i_next);
252 vlib_get_next_frame (vm, node, next_index,
253 to_next, n_left_to_next);
260 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
263 return from_frame->n_vectors;
266 static char *ppp_error_strings[] = {
267 #define ppp_error(n,s) s,
273 VLIB_REGISTER_NODE (ppp_input_node) = {
274 .function = ppp_input,
276 /* Takes a vector of packets. */
277 .vector_size = sizeof (u32),
279 .runtime_data_bytes = sizeof (ppp_input_runtime_t),
281 .n_errors = PPP_N_ERROR,
282 .error_strings = ppp_error_strings,
284 .n_next_nodes = PPP_INPUT_N_NEXT,
286 #define _(s,n) [PPP_INPUT_NEXT_##s] = n,
287 foreach_ppp_input_next
291 .format_buffer = format_ppp_header_with_length,
292 .format_trace = format_ppp_input_trace,
293 .unformat_buffer = unformat_ppp_header,
297 static clib_error_t *
298 ppp_input_runtime_init (vlib_main_t * vm)
300 ppp_input_runtime_t *rt;
302 rt = vlib_node_get_runtime_data (vm, ppp_input_node.index);
304 rt->next_by_protocol = sparse_vec_new
305 ( /* elt bytes */ sizeof (rt->next_by_protocol[0]),
306 /* bits in index */ BITS (((ppp_header_t *) 0)->protocol));
308 vec_validate (rt->sparse_index_by_next_index, PPP_INPUT_NEXT_DROP);
309 vec_validate (rt->sparse_index_by_next_index, PPP_INPUT_NEXT_PUNT);
310 rt->sparse_index_by_next_index[PPP_INPUT_NEXT_DROP]
311 = SPARSE_VEC_INVALID_INDEX;
312 rt->sparse_index_by_next_index[PPP_INPUT_NEXT_PUNT]
313 = SPARSE_VEC_INVALID_INDEX;
318 static clib_error_t *
319 ppp_input_init (vlib_main_t * vm)
323 clib_error_t *error = vlib_call_init_function (vm, ppp_init);
325 clib_error_report (error);
328 ppp_setup_node (vm, ppp_input_node.index);
329 ppp_input_runtime_init (vm);
334 VLIB_INIT_FUNCTION (ppp_input_init);
335 VLIB_WORKER_INIT_FUNCTION (ppp_input_runtime_init);
338 ppp_register_input_protocol (vlib_main_t * vm,
339 ppp_protocol_t protocol, u32 node_index)
341 ppp_main_t *em = &ppp_main;
342 ppp_protocol_info_t *pi;
343 ppp_input_runtime_t *rt;
348 clib_error_t *error = vlib_call_init_function (vm, ppp_input_init);
350 clib_error_report (error);
353 pi = ppp_get_protocol_info (em, protocol);
354 pi->node_index = node_index;
355 pi->next_index = vlib_node_add_next (vm, ppp_input_node.index, node_index);
357 /* Setup ppp protocol -> next index sparse vector mapping. */
358 rt = vlib_node_get_runtime_data (vm, ppp_input_node.index);
360 sparse_vec_validate (rt->next_by_protocol,
361 clib_host_to_net_u16 (protocol));
362 n[0] = pi->next_index;
364 /* Rebuild next index -> sparse index inverse mapping when sparse vector
366 vec_validate (rt->sparse_index_by_next_index, pi->next_index);
367 for (i = 1; i < vec_len (rt->next_by_protocol); i++)
368 rt->sparse_index_by_next_index[rt->next_by_protocol[i]] = i;
372 * fd.io coding-style-patch-verification: ON
375 * eval: (c-set-style "gnu")