2 * decap.c: pppoe session decap packet processing
4 * Copyright (c) 2017 Intel 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 #include <vlib/vlib.h>
19 #include <vnet/ppp/packet.h>
20 #include <pppoe/pppoe.h>
29 static u8 * format_pppoe_rx_trace (u8 * s, va_list * args)
31 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
32 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
33 pppoe_rx_trace_t * t = va_arg (*args, pppoe_rx_trace_t *);
35 if (t->session_index != ~0)
37 s = format (s, "PPPoE decap from pppoe_session%d session_id %d next %d error %d",
38 t->session_index, t->session_id, t->next_index, t->error);
42 s = format (s, "PPPoE decap error - session for session_id %d does not exist",
48 VLIB_NODE_FN (pppoe_input_node) (vlib_main_t * vm,
49 vlib_node_runtime_t * node,
50 vlib_frame_t * from_frame)
52 u32 n_left_from, next_index, * from, * to_next;
53 pppoe_main_t * pem = &pppoe_main;
54 vnet_main_t * vnm = pem->vnet_main;
55 vnet_interface_main_t * im = &vnm->interface_main;
56 u32 pkts_decapsulated = 0;
57 u32 thread_index = vlib_get_thread_index();
58 u32 stats_sw_if_index, stats_n_packets, stats_n_bytes;
59 pppoe_entry_key_t cached_key;
60 pppoe_entry_result_t cached_result;
62 from = vlib_frame_vector_args (from_frame);
63 n_left_from = from_frame->n_vectors;
65 /* Clear the one-entry cache in case session table was updated */
67 cached_result.raw = ~0; /* warning be gone */
69 next_index = node->cached_next_index;
70 stats_sw_if_index = node->runtime_data[0];
71 stats_n_packets = stats_n_bytes = 0;
73 while (n_left_from > 0)
77 vlib_get_next_frame (vm, node, next_index,
78 to_next, n_left_to_next);
79 while (n_left_from >= 4 && n_left_to_next >= 2)
82 vlib_buffer_t * b0, * b1;
84 ethernet_header_t *h0, *h1;
85 ethernet_vlan_header_t *vlan0 = 0, *vlan1 = 0;
86 pppoe_header_t * pppoe0, * pppoe1;
87 u16 ppp_proto0 = 0, ppp_proto1 = 0;
88 pppoe_session_t * t0, * t1;
89 u32 error0 = 0, error1 = 0;
90 u32 sw_if_index0, sw_if_index1, len0, len1;
91 pppoe_entry_key_t key0, key1;
92 pppoe_entry_result_t result0, result1;
96 /* Prefetch next iteration. */
98 vlib_buffer_t * p2, * p3;
100 p2 = vlib_get_buffer (vm, from[2]);
101 p3 = vlib_get_buffer (vm, from[3]);
103 vlib_prefetch_buffer_header (p2, LOAD);
104 vlib_prefetch_buffer_header (p3, LOAD);
106 CLIB_PREFETCH (p2->data, 2*CLIB_CACHE_LINE_BYTES, LOAD);
107 CLIB_PREFETCH (p3->data, 2*CLIB_CACHE_LINE_BYTES, LOAD);
119 b0 = vlib_get_buffer (vm, bi0);
120 b1 = vlib_get_buffer (vm, bi1);
125 vlib_buffer_reset(b0);
126 h0 = vlib_buffer_get_current (b0);
128 /* get pppoe header */
129 type0 = clib_net_to_host_u16(h0->type);
130 if(type0 == ETHERNET_TYPE_VLAN){
131 vlan0 = (ethernet_vlan_header_t *)(h0+1);
132 type0 = clib_net_to_host_u16(vlan0->type);
133 pppoe0 = (pppoe_header_t*)(vlan0+1);
134 if( type0 != ETHERNET_TYPE_PPPOE_DISCOVERY && type0 != ETHERNET_TYPE_PPPOE_SESSION ) {
135 error0 = PPPOE_ERROR_BAD_VER_TYPE;
136 result0.fields.session_index =
137 ~0; // avoid tracing random data
138 next0 = PPPOE_INPUT_NEXT_DROP;
142 pppoe0 = (pppoe_header_t*)(h0+1);
145 ppp_proto0 = clib_net_to_host_u16(pppoe0->ppp_proto);
147 /* Manipulate packet 0 */
148 if ((ppp_proto0 != PPP_PROTOCOL_ip4)
149 && (ppp_proto0 != PPP_PROTOCOL_ip6))
152 vlib_buffer_advance(b0, sizeof(*h0))
154 vlib_buffer_advance(b0, sizeof(*h0)+sizeof(*vlan0));
155 error0 = PPPOE_ERROR_CONTROL_PLANE;
156 next0 = PPPOE_INPUT_NEXT_CP_INPUT;
157 result0.fields.session_index = ~0;
162 pppoe_lookup_1 (&pem->session_table, &cached_key, &cached_result,
163 h0->src_address, pppoe0->session_id,
164 &key0, &bucket0, &result0);
165 if (PREDICT_FALSE (result0.fields.session_index == ~0))
167 error0 = PPPOE_ERROR_NO_SUCH_SESSION;
168 next0 = PPPOE_INPUT_NEXT_DROP;
172 t0 = pool_elt_at_index (pem->sessions,
173 result0.fields.session_index);
175 /* Pop Eth and PPPoE header */
177 vlib_buffer_advance(b0, sizeof(*h0)+sizeof(*pppoe0))
179 vlib_buffer_advance(b0, sizeof(*h0)+sizeof(*vlan0)+sizeof(*pppoe0));
181 next0 = (ppp_proto0==PPP_PROTOCOL_ip4)?
182 PPPOE_INPUT_NEXT_IP4_INPUT
183 : PPPOE_INPUT_NEXT_IP6_INPUT;
185 sw_if_index0 = t0->sw_if_index;
186 len0 = vlib_buffer_length_in_chain (vm, b0);
187 vnet_buffer(b0)->sw_if_index[VLIB_RX] = sw_if_index0;
189 pkts_decapsulated ++;
190 stats_n_packets += 1;
191 stats_n_bytes += len0;
193 /* Batch stats increment on the same pppoe session so counter
194 is not incremented per packet */
195 if (PREDICT_FALSE (sw_if_index0 != stats_sw_if_index))
197 stats_n_packets -= 1;
198 stats_n_bytes -= len0;
200 vlib_increment_combined_counter
201 (im->combined_sw_if_counters + VNET_INTERFACE_COUNTER_RX,
202 thread_index, stats_sw_if_index,
203 stats_n_packets, stats_n_bytes);
205 stats_n_bytes = len0;
206 stats_sw_if_index = sw_if_index0;
210 b0->error = error0 ? node->errors[error0] : 0;
212 if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
215 = vlib_add_trace (vm, node, b0, sizeof (*tr));
216 tr->next_index = next0;
218 tr->session_index = result0.fields.session_index;
219 tr->session_id = clib_net_to_host_u32(pppoe0->session_id);
223 vlib_buffer_reset(b1);
224 h1 = vlib_buffer_get_current (b1);
226 /* get pppoe header */
227 type1 = clib_net_to_host_u16(h1->type);
228 if(type1 == ETHERNET_TYPE_VLAN){
229 vlan1 = (ethernet_vlan_header_t *)(h1+1);
230 type1 = clib_net_to_host_u16(vlan1->type);
231 pppoe1 = (pppoe_header_t*)(vlan1+1);
232 if( type1 != ETHERNET_TYPE_PPPOE_DISCOVERY && type1 != ETHERNET_TYPE_PPPOE_SESSION ) {
233 error1 = PPPOE_ERROR_BAD_VER_TYPE;
234 result1.fields.session_index =
235 ~0; // avoid tracing random data
236 next1 = PPPOE_INPUT_NEXT_DROP;
240 pppoe1 = (pppoe_header_t*)(h1+1);
243 ppp_proto1 = clib_net_to_host_u16(pppoe1->ppp_proto);
245 /* Manipulate packet 1 */
246 if ((ppp_proto1 != PPP_PROTOCOL_ip4)
247 && (ppp_proto1 != PPP_PROTOCOL_ip6))
250 vlib_buffer_advance(b1, sizeof(*h1))
252 vlib_buffer_advance(b1, sizeof(*h1)+sizeof(*vlan1));
253 error1 = PPPOE_ERROR_CONTROL_PLANE;
254 next1 = PPPOE_INPUT_NEXT_CP_INPUT;
255 result1.fields.session_index = ~0;
259 pppoe_lookup_1 (&pem->session_table, &cached_key, &cached_result,
260 h1->src_address, pppoe1->session_id,
261 &key1, &bucket1, &result1);
262 if (PREDICT_FALSE (result1.fields.session_index == ~0))
264 error1 = PPPOE_ERROR_NO_SUCH_SESSION;
265 next1 = PPPOE_INPUT_NEXT_DROP;
269 t1 = pool_elt_at_index (pem->sessions,
270 result1.fields.session_index);
272 /* Pop Eth and PPPoE header */
274 vlib_buffer_advance(b1, sizeof(*h1)+sizeof(*pppoe1))
276 vlib_buffer_advance(b1, sizeof(*h1)+sizeof(*vlan1)+sizeof(*pppoe1));
278 next1 = (ppp_proto1==PPP_PROTOCOL_ip4)?
279 PPPOE_INPUT_NEXT_IP4_INPUT
280 : PPPOE_INPUT_NEXT_IP6_INPUT;
282 sw_if_index1 = t1->sw_if_index;
283 len1 = vlib_buffer_length_in_chain (vm, b1);
284 vnet_buffer(b1)->sw_if_index[VLIB_RX] = sw_if_index1;
286 pkts_decapsulated ++;
287 stats_n_packets += 1;
288 stats_n_bytes += len1;
290 /* Batch stats increment on the same pppoe session so counter
291 is not incremented per packet */
292 if (PREDICT_FALSE (sw_if_index1 != stats_sw_if_index))
294 stats_n_packets -= 1;
295 stats_n_bytes -= len1;
297 vlib_increment_combined_counter
298 (im->combined_sw_if_counters + VNET_INTERFACE_COUNTER_RX,
299 thread_index, stats_sw_if_index,
300 stats_n_packets, stats_n_bytes);
302 stats_n_bytes = len1;
303 stats_sw_if_index = sw_if_index1;
307 b1->error = error1 ? node->errors[error1] : 0;
309 if (PREDICT_FALSE(b1->flags & VLIB_BUFFER_IS_TRACED))
312 = vlib_add_trace (vm, node, b1, sizeof (*tr));
313 tr->next_index = next1;
315 tr->session_index = result1.fields.session_index;
316 tr->session_id = clib_net_to_host_u32(pppoe1->session_id);
319 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
320 to_next, n_left_to_next,
321 bi0, bi1, next0, next1);
324 while (n_left_from > 0 && n_left_to_next > 0)
329 ethernet_header_t *h0;
330 ethernet_vlan_header_t *vlan0 = 0;
331 pppoe_header_t * pppoe0;
333 pppoe_session_t * t0;
335 u32 sw_if_index0, len0;
336 pppoe_entry_key_t key0;
337 pppoe_entry_result_t result0;
348 b0 = vlib_get_buffer (vm, bi0);
352 vlib_buffer_reset(b0);
353 h0 = vlib_buffer_get_current (b0);
355 /* get pppoe header */
356 type0 = clib_net_to_host_u16(h0->type);
357 if(type0 == ETHERNET_TYPE_VLAN){
358 vlan0 = (ethernet_vlan_header_t *)(h0+1);
359 type0 = clib_net_to_host_u16(vlan0->type);
360 pppoe0 = (pppoe_header_t*)(vlan0+1);
361 if( type0 != ETHERNET_TYPE_PPPOE_DISCOVERY && type0 != ETHERNET_TYPE_PPPOE_SESSION ) {
362 error0 = PPPOE_ERROR_BAD_VER_TYPE;
363 result0.fields.session_index =
364 ~0; // avoid tracing random data
365 next0 = PPPOE_INPUT_NEXT_DROP;
369 pppoe0 = (pppoe_header_t*)(h0+1);
372 ppp_proto0 = clib_net_to_host_u16(pppoe0->ppp_proto);
374 if ((ppp_proto0 != PPP_PROTOCOL_ip4)
375 && (ppp_proto0 != PPP_PROTOCOL_ip6))
378 vlib_buffer_advance(b0, sizeof(*h0))
380 vlib_buffer_advance(b0, sizeof(*h0)+sizeof(*vlan0));
381 error0 = PPPOE_ERROR_CONTROL_PLANE;
382 next0 = PPPOE_INPUT_NEXT_CP_INPUT;
383 result0.fields.session_index = ~0;
387 pppoe_lookup_1 (&pem->session_table, &cached_key, &cached_result,
388 h0->src_address, pppoe0->session_id,
389 &key0, &bucket0, &result0);
390 if (PREDICT_FALSE (result0.fields.session_index == ~0))
392 error0 = PPPOE_ERROR_NO_SUCH_SESSION;
393 next0 = PPPOE_INPUT_NEXT_DROP;
397 t0 = pool_elt_at_index (pem->sessions,
398 result0.fields.session_index);
400 /* Pop Eth and PPPoE header */
402 vlib_buffer_advance(b0, sizeof(*h0)+sizeof(*pppoe0))
404 vlib_buffer_advance(b0, sizeof(*h0)+sizeof(*vlan0)+sizeof(*pppoe0));
406 next0 = (ppp_proto0==PPP_PROTOCOL_ip4)?
407 PPPOE_INPUT_NEXT_IP4_INPUT
408 : PPPOE_INPUT_NEXT_IP6_INPUT;
410 sw_if_index0 = t0->sw_if_index;
411 len0 = vlib_buffer_length_in_chain (vm, b0);
412 vnet_buffer(b0)->sw_if_index[VLIB_RX] = sw_if_index0;
414 pkts_decapsulated ++;
415 stats_n_packets += 1;
416 stats_n_bytes += len0;
418 /* Batch stats increment on the same pppoe session so counter
419 is not incremented per packet */
420 if (PREDICT_FALSE (sw_if_index0 != stats_sw_if_index))
422 stats_n_packets -= 1;
423 stats_n_bytes -= len0;
425 vlib_increment_combined_counter
426 (im->combined_sw_if_counters + VNET_INTERFACE_COUNTER_RX,
427 thread_index, stats_sw_if_index,
428 stats_n_packets, stats_n_bytes);
430 stats_n_bytes = len0;
431 stats_sw_if_index = sw_if_index0;
435 b0->error = error0 ? node->errors[error0] : 0;
437 if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
440 = vlib_add_trace (vm, node, b0, sizeof (*tr));
441 tr->next_index = next0;
443 tr->session_index = result0.fields.session_index;
444 tr->session_id = clib_net_to_host_u16(pppoe0->session_id);
446 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
447 to_next, n_left_to_next,
451 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
453 /* Do we still need this now that session tx stats is kept? */
454 vlib_node_increment_counter (vm, pppoe_input_node.index,
455 PPPOE_ERROR_DECAPSULATED,
458 /* Increment any remaining batch stats */
461 vlib_increment_combined_counter
462 (im->combined_sw_if_counters + VNET_INTERFACE_COUNTER_RX,
463 thread_index, stats_sw_if_index, stats_n_packets, stats_n_bytes);
464 node->runtime_data[0] = stats_sw_if_index;
467 return from_frame->n_vectors;
470 #ifndef CLIB_MARCH_VARIANT
471 char * pppoe_error_strings[] = {
472 #define pppoe_error(n,s) s,
473 #include <pppoe/pppoe_error.def>
477 #endif /* CLIB_MARCH_VARIANT */
479 VLIB_REGISTER_NODE (pppoe_input_node) = {
480 .name = "pppoe-input",
481 /* Takes a vector of packets. */
482 .vector_size = sizeof (u32),
484 .n_errors = PPPOE_N_ERROR,
485 .error_strings = pppoe_error_strings,
487 .n_next_nodes = PPPOE_INPUT_N_NEXT,
489 #define _(s,n) [PPPOE_INPUT_NEXT_##s] = n,
490 foreach_pppoe_input_next
494 .format_trace = format_pppoe_rx_trace,
497 VNET_FEATURE_INIT (pppoe_input_node, static) =
499 .arc_name = "device-input",
500 .node_name = "pppoe-input",
501 .runs_before = VNET_FEATURES ("ethernet-input"),