src/plugins/pppoe/pppoe_decap.c

   1 /*
   2  * decap.c: pppoe session decap packet processing
   3  *
   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:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.
  16  */
  17
  18 #include <vlib/vlib.h>
  19 #include <vnet/ppp/packet.h>
  20 #include <pppoe/pppoe.h>
  21
  22 typedef struct {
  23   u32 next_index;
  24   u32 session_index;
  25   u32 session_id;
  26   u32 error;
  27 } pppoe_rx_trace_t;
  28
  29 static u8 * format_pppoe_rx_trace (u8 * s, va_list * args)
  30 {
  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 *);
  34
  35   if (t->session_index != ~0)
  36     {
  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);
  39     }
  40   else
  41     {
  42       s = format (s, "PPPoE decap error - session for session_id %d does not exist",
  43                   t->session_id);
  44     }
  45   return s;
  46 }
  47
  48 VLIB_NODE_FN (pppoe_input_node) (vlib_main_t * vm,
  49              vlib_node_runtime_t * node,
  50              vlib_frame_t * from_frame)
  51 {
  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;
  61
  62   from = vlib_frame_vector_args (from_frame);
  63   n_left_from = from_frame->n_vectors;
  64
  65   /* Clear the one-entry cache in case session table was updated */
  66   cached_key.raw = ~0;
  67   cached_result.raw = ~0;       /* warning be gone */
  68
  69   next_index = node->cached_next_index;
  70   stats_sw_if_index = node->runtime_data[0];
  71   stats_n_packets = stats_n_bytes = 0;
  72
  73   while (n_left_from > 0)
  74     {
  75       u32 n_left_to_next;
  76
  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)
  80         {
  81           u32 bi0, bi1;
  82           vlib_buffer_t * b0, * b1;
  83           u32 next0, next1;
  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;
  93           u32 bucket0, bucket1;
  94           u16 type0, type1;
  95
  96           /* Prefetch next iteration. */
  97           {
  98             vlib_buffer_t * p2, * p3;
  99
 100             p2 = vlib_get_buffer (vm, from[2]);
 101             p3 = vlib_get_buffer (vm, from[3]);
 102
 103             vlib_prefetch_buffer_header (p2, LOAD);
 104             vlib_prefetch_buffer_header (p3, LOAD);
 105
 106             CLIB_PREFETCH (p2->data, 2*CLIB_CACHE_LINE_BYTES, LOAD);
 107             CLIB_PREFETCH (p3->data, 2*CLIB_CACHE_LINE_BYTES, LOAD);
 108           }
 109
 110           bi0 = from[0];
 111           bi1 = from[1];
 112           to_next[0] = bi0;
 113           to_next[1] = bi1;
 114           from += 2;
 115           to_next += 2;
 116           n_left_to_next -= 2;
 117           n_left_from -= 2;
 118
 119           b0 = vlib_get_buffer (vm, bi0);
 120           b1 = vlib_get_buffer (vm, bi1);
 121           error0 = 0;
 122           error1 = 0;
 123
 124                   /* get client mac */
 125           vlib_buffer_reset(b0);
 126           h0 = vlib_buffer_get_current (b0);
 127
 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;
 139                                 goto trace0;
 140                           }
 141                   } else {
 142                           pppoe0 = (pppoe_header_t*)(h0+1);
 143                   }
 144
 145           ppp_proto0 = clib_net_to_host_u16(pppoe0->ppp_proto);
 146
 147           /* Manipulate packet 0 */
 148           if ((ppp_proto0 != PPP_PROTOCOL_ip4)
 149              && (ppp_proto0 != PPP_PROTOCOL_ip6))
 150             {
 151                   vlan0 == 0 ?
 152                     vlib_buffer_advance(b0, sizeof(*h0))
 153               :
 154                     vlib_buffer_advance(b0, sizeof(*h0)+sizeof(*vlan0));
 155               error0 = PPPOE_ERROR_CONTROL_PLANE;
 156               next0 = PPPOE_INPUT_NEXT_CP_INPUT;
 157               goto trace0;
 158             }
 159
 160
 161           pppoe_lookup_1 (&pem->session_table, &cached_key, &cached_result,
 162                           h0->src_address, pppoe0->session_id,
 163                           &key0, &bucket0, &result0);
 164           if (PREDICT_FALSE (result0.fields.session_index == ~0))
 165             {
 166               error0 = PPPOE_ERROR_NO_SUCH_SESSION;
 167               next0 = PPPOE_INPUT_NEXT_DROP;
 168               goto trace0;
 169             }
 170
 171           t0 = pool_elt_at_index (pem->sessions,
 172                                   result0.fields.session_index);
 173
 174           /* Pop Eth and PPPoE header */
 175           vlan0 == 0 ?
 176                 vlib_buffer_advance(b0, sizeof(*h0)+sizeof(*pppoe0))
 177           :
 178                 vlib_buffer_advance(b0, sizeof(*h0)+sizeof(*vlan0)+sizeof(*pppoe0));
 179
 180           next0 = (ppp_proto0==PPP_PROTOCOL_ip4)?
 181                   PPPOE_INPUT_NEXT_IP4_INPUT
 182                   : PPPOE_INPUT_NEXT_IP6_INPUT;
 183
 184           sw_if_index0 = t0->sw_if_index;
 185           len0 = vlib_buffer_length_in_chain (vm, b0);
 186                   vnet_buffer(b0)->sw_if_index[VLIB_RX] = sw_if_index0;
 187
 188           pkts_decapsulated ++;
 189           stats_n_packets += 1;
 190           stats_n_bytes += len0;
 191
 192           /* Batch stats increment on the same pppoe session so counter
 193              is not incremented per packet */
 194           if (PREDICT_FALSE (sw_if_index0 != stats_sw_if_index))
 195             {
 196               stats_n_packets -= 1;
 197               stats_n_bytes -= len0;
 198               if (stats_n_packets)
 199                 vlib_increment_combined_counter
 200                   (im->combined_sw_if_counters + VNET_INTERFACE_COUNTER_RX,
 201                    thread_index, stats_sw_if_index,
 202                    stats_n_packets, stats_n_bytes);
 203               stats_n_packets = 1;
 204               stats_n_bytes = len0;
 205               stats_sw_if_index = sw_if_index0;
 206             }
 207
 208         trace0:
 209           b0->error = error0 ? node->errors[error0] : 0;
 210
 211           if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
 212             {
 213               pppoe_rx_trace_t *tr
 214                 = vlib_add_trace (vm, node, b0, sizeof (*tr));
 215               tr->next_index = next0;
 216               tr->error = error0;
 217               tr->session_index = result0.fields.session_index;
 218               tr->session_id = clib_net_to_host_u32(pppoe0->session_id);
 219             }
 220
 221           /* get client mac */
 222           vlib_buffer_reset(b1);
 223           h1 = vlib_buffer_get_current (b1);
 224
 225                   /* get pppoe header */
 226                   type1 = clib_net_to_host_u16(h1->type);
 227                   if(type1 == ETHERNET_TYPE_VLAN){
 228                           vlan1 = (ethernet_vlan_header_t *)(h1+1);
 229                           type1 = clib_net_to_host_u16(vlan1->type);
 230                           pppoe1 = (pppoe_header_t*)(vlan1+1);
 231                           if( type1 != ETHERNET_TYPE_PPPOE_DISCOVERY && type1 != ETHERNET_TYPE_PPPOE_SESSION ) {
 232                                 error1 = PPPOE_ERROR_BAD_VER_TYPE;
 233                                 result1.fields.session_index =
 234                                   ~0; // avoid tracing random data
 235                                 next1 = PPPOE_INPUT_NEXT_DROP;
 236                                 goto trace1;
 237                           }
 238                   } else {
 239                           pppoe1 = (pppoe_header_t*)(h1+1);
 240                   }
 241
 242                   ppp_proto1 = clib_net_to_host_u16(pppoe1->ppp_proto);
 243
 244           /* Manipulate packet 1 */
 245           if ((ppp_proto1 != PPP_PROTOCOL_ip4)
 246              && (ppp_proto1 != PPP_PROTOCOL_ip6))
 247             {
 248                   vlan1 == 0 ?
 249                     vlib_buffer_advance(b1, sizeof(*h1))
 250               :
 251                     vlib_buffer_advance(b1, sizeof(*h1)+sizeof(*vlan1));
 252               error1 = PPPOE_ERROR_CONTROL_PLANE;
 253               next1 = PPPOE_INPUT_NEXT_CP_INPUT;
 254               goto trace1;
 255             }
 256
 257           pppoe_lookup_1 (&pem->session_table, &cached_key, &cached_result,
 258                           h1->src_address, pppoe1->session_id,
 259                           &key1, &bucket1, &result1);
 260           if (PREDICT_FALSE (result1.fields.session_index == ~0))
 261             {
 262               error1 = PPPOE_ERROR_NO_SUCH_SESSION;
 263               next1 = PPPOE_INPUT_NEXT_DROP;
 264               goto trace1;
 265             }
 266
 267           t1 = pool_elt_at_index (pem->sessions,
 268                                   result1.fields.session_index);
 269
 270           /* Pop Eth and PPPoE header */
 271           vlan1 == 0 ?
 272                 vlib_buffer_advance(b1, sizeof(*h1)+sizeof(*pppoe1))
 273           :
 274                 vlib_buffer_advance(b1, sizeof(*h1)+sizeof(*vlan1)+sizeof(*pppoe1));
 275
 276           next1 = (ppp_proto1==PPP_PROTOCOL_ip4)?
 277                   PPPOE_INPUT_NEXT_IP4_INPUT
 278                   : PPPOE_INPUT_NEXT_IP6_INPUT;
 279
 280           sw_if_index1 = t1->sw_if_index;
 281           len1 = vlib_buffer_length_in_chain (vm, b1);
 282                   vnet_buffer(b1)->sw_if_index[VLIB_RX] = sw_if_index1;
 283
 284           pkts_decapsulated ++;
 285           stats_n_packets += 1;
 286           stats_n_bytes += len1;
 287
 288           /* Batch stats increment on the same pppoe session so counter
 289              is not incremented per packet */
 290           if (PREDICT_FALSE (sw_if_index1 != stats_sw_if_index))
 291             {
 292               stats_n_packets -= 1;
 293               stats_n_bytes -= len1;
 294               if (stats_n_packets)
 295                 vlib_increment_combined_counter
 296                   (im->combined_sw_if_counters + VNET_INTERFACE_COUNTER_RX,
 297                    thread_index, stats_sw_if_index,
 298                    stats_n_packets, stats_n_bytes);
 299               stats_n_packets = 1;
 300               stats_n_bytes = len1;
 301               stats_sw_if_index = sw_if_index1;
 302             }
 303
 304         trace1:
 305           b1->error = error1 ? node->errors[error1] : 0;
 306
 307           if (PREDICT_FALSE(b1->flags & VLIB_BUFFER_IS_TRACED))
 308             {
 309               pppoe_rx_trace_t *tr
 310                 = vlib_add_trace (vm, node, b1, sizeof (*tr));
 311               tr->next_index = next1;
 312               tr->error = error1;
 313               tr->session_index = result1.fields.session_index;
 314               tr->session_id = clib_net_to_host_u32(pppoe1->session_id);
 315             }
 316
 317           vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
 318                                            to_next, n_left_to_next,
 319                                            bi0, bi1, next0, next1);
 320         }
 321
 322       while (n_left_from > 0 && n_left_to_next > 0)
 323         {
 324           u32 bi0;
 325           vlib_buffer_t * b0;
 326           u32 next0;
 327           ethernet_header_t *h0;
 328           ethernet_vlan_header_t *vlan0 = 0;
 329           pppoe_header_t * pppoe0;
 330           u16 ppp_proto0 = 0;
 331           pppoe_session_t * t0;
 332           u32 error0;
 333           u32 sw_if_index0, len0;
 334           pppoe_entry_key_t key0;
 335           pppoe_entry_result_t result0;
 336           u32 bucket0;
 337           u32 type0;
 338
 339           bi0 = from[0];
 340           to_next[0] = bi0;
 341           from += 1;
 342           to_next += 1;
 343           n_left_from -= 1;
 344           n_left_to_next -= 1;
 345
 346           b0 = vlib_get_buffer (vm, bi0);
 347           error0 = 0;
 348
 349           /* get client mac */
 350           vlib_buffer_reset(b0);
 351           h0 = vlib_buffer_get_current (b0);
 352
 353                   /* get pppoe header */
 354                   type0 = clib_net_to_host_u16(h0->type);
 355                   if(type0 == ETHERNET_TYPE_VLAN){
 356                           vlan0 = (ethernet_vlan_header_t *)(h0+1);
 357                           type0 = clib_net_to_host_u16(vlan0->type);
 358                           pppoe0 = (pppoe_header_t*)(vlan0+1);
 359                           if( type0 != ETHERNET_TYPE_PPPOE_DISCOVERY && type0 != ETHERNET_TYPE_PPPOE_SESSION ) {
 360                                 error0 = PPPOE_ERROR_BAD_VER_TYPE;
 361                                 result0.fields.session_index =
 362                                   ~0; // avoid tracing random data
 363                                 next0 = PPPOE_INPUT_NEXT_DROP;
 364                                 goto trace00;
 365                           }
 366                   } else {
 367                           pppoe0 = (pppoe_header_t*)(h0+1);
 368                   }
 369
 370           ppp_proto0 = clib_net_to_host_u16(pppoe0->ppp_proto);
 371
 372           if ((ppp_proto0 != PPP_PROTOCOL_ip4)
 373              && (ppp_proto0 != PPP_PROTOCOL_ip6))
 374             {
 375                   vlan0 == 0 ?
 376                     vlib_buffer_advance(b0, sizeof(*h0))
 377               :
 378                     vlib_buffer_advance(b0, sizeof(*h0)+sizeof(*vlan0));
 379               error0 = PPPOE_ERROR_CONTROL_PLANE;
 380               next0 = PPPOE_INPUT_NEXT_CP_INPUT;
 381               goto trace00;
 382             }
 383
 384           pppoe_lookup_1 (&pem->session_table, &cached_key, &cached_result,
 385                           h0->src_address, pppoe0->session_id,
 386                           &key0, &bucket0, &result0);
 387           if (PREDICT_FALSE (result0.fields.session_index == ~0))
 388             {
 389               error0 = PPPOE_ERROR_NO_SUCH_SESSION;
 390               next0 = PPPOE_INPUT_NEXT_DROP;
 391               goto trace00;
 392             }
 393
 394           t0 = pool_elt_at_index (pem->sessions,
 395                                   result0.fields.session_index);
 396
 397           /* Pop Eth and PPPoE header */
 398           vlan0 == 0 ?
 399                 vlib_buffer_advance(b0, sizeof(*h0)+sizeof(*pppoe0))
 400           :
 401                 vlib_buffer_advance(b0, sizeof(*h0)+sizeof(*vlan0)+sizeof(*pppoe0));
 402
 403           next0 = (ppp_proto0==PPP_PROTOCOL_ip4)?
 404                   PPPOE_INPUT_NEXT_IP4_INPUT
 405                   : PPPOE_INPUT_NEXT_IP6_INPUT;
 406
 407           sw_if_index0 = t0->sw_if_index;
 408           len0 = vlib_buffer_length_in_chain (vm, b0);
 409           vnet_buffer(b0)->sw_if_index[VLIB_RX] = sw_if_index0;
 410
 411           pkts_decapsulated ++;
 412           stats_n_packets += 1;
 413           stats_n_bytes += len0;
 414
 415           /* Batch stats increment on the same pppoe session so counter
 416              is not incremented per packet */
 417           if (PREDICT_FALSE (sw_if_index0 != stats_sw_if_index))
 418             {
 419               stats_n_packets -= 1;
 420               stats_n_bytes -= len0;
 421               if (stats_n_packets)
 422                 vlib_increment_combined_counter
 423                   (im->combined_sw_if_counters + VNET_INTERFACE_COUNTER_RX,
 424                    thread_index, stats_sw_if_index,
 425                    stats_n_packets, stats_n_bytes);
 426               stats_n_packets = 1;
 427               stats_n_bytes = len0;
 428               stats_sw_if_index = sw_if_index0;
 429             }
 430
 431         trace00:
 432           b0->error = error0 ? node->errors[error0] : 0;
 433
 434           if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
 435             {
 436               pppoe_rx_trace_t *tr
 437                 = vlib_add_trace (vm, node, b0, sizeof (*tr));
 438               tr->next_index = next0;
 439               tr->error = error0;
 440               tr->session_index = result0.fields.session_index;
 441               tr->session_id = clib_net_to_host_u16(pppoe0->session_id);
 442             }
 443           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 444                                            to_next, n_left_to_next,
 445                                            bi0, next0);
 446         }
 447
 448       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 449     }
 450   /* Do we still need this now that session tx stats is kept? */
 451   vlib_node_increment_counter (vm, pppoe_input_node.index,
 452                                PPPOE_ERROR_DECAPSULATED,
 453                                pkts_decapsulated);
 454
 455   /* Increment any remaining batch stats */
 456   if (stats_n_packets)
 457     {
 458       vlib_increment_combined_counter
 459         (im->combined_sw_if_counters + VNET_INTERFACE_COUNTER_RX,
 460          thread_index, stats_sw_if_index, stats_n_packets, stats_n_bytes);
 461       node->runtime_data[0] = stats_sw_if_index;
 462     }
 463
 464   return from_frame->n_vectors;
 465 }
 466
 467 #ifndef CLIB_MARCH_VARIANT
 468 char * pppoe_error_strings[] = {
 469 #define pppoe_error(n,s) s,
 470 #include <pppoe/pppoe_error.def>
 471 #undef pppoe_error
 472 #undef _
 473 };
 474 #endif /* CLIB_MARCH_VARIANT */
 475
 476 VLIB_REGISTER_NODE (pppoe_input_node) = {
 477   .name = "pppoe-input",
 478   /* Takes a vector of packets. */
 479   .vector_size = sizeof (u32),
 480
 481   .n_errors = PPPOE_N_ERROR,
 482   .error_strings = pppoe_error_strings,
 483
 484   .n_next_nodes = PPPOE_INPUT_N_NEXT,
 485   .next_nodes = {
 486 #define _(s,n) [PPPOE_INPUT_NEXT_##s] = n,
 487     foreach_pppoe_input_next
 488 #undef _
 489   },
 490
 491   .format_trace = format_pppoe_rx_trace,
 492 };
 493
 494 /* *INDENT-OFF* */
 495 VNET_FEATURE_INIT (pppoe_input_node, static) =
 496 {
 497   .arc_name = "device-input",
 498   .node_name = "pppoe-input",
 499   .runs_before = VNET_FEATURES ("ethernet-input"),
 500 };
 501 /* *INDENT-ON */