src/vnet/ppp/node.c

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15 /*
  16  * ppp_node.c: ppp packet processing
  17  *
  18  * Copyright (c) 2010 Eliot Dresselhaus
  19  *
  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:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  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.
  38  */
  39
  40 #include <vlib/vlib.h>
  41 #include <vnet/pg/pg.h>
  42 #include <vnet/ppp/ppp.h>
  43 #include <vppinfra/sparse_vec.h>
  44
  45 #define foreach_ppp_input_next                  \
  46   _ (PUNT, "error-punt")                        \
  47   _ (DROP, "error-drop")
  48
  49 typedef enum
  50 {
  51 #define _(s,n) PPP_INPUT_NEXT_##s,
  52   foreach_ppp_input_next
  53 #undef _
  54     PPP_INPUT_N_NEXT,
  55 } ppp_input_next_t;
  56
  57 typedef struct
  58 {
  59   u8 packet_data[32];
  60 } ppp_input_trace_t;
  61
  62 static u8 *
  63 format_ppp_input_trace (u8 * s, va_list * va)
  64 {
  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 *);
  68
  69   s = format (s, "%U", format_ppp_header, t->packet_data);
  70
  71   return s;
  72 }
  73
  74 typedef struct
  75 {
  76   /* Sparse vector mapping ppp protocol in network byte order
  77      to next index. */
  78   u16 *next_by_protocol;
  79
  80   u32 *sparse_index_by_next_index;
  81 } ppp_input_runtime_t;
  82
  83 static uword
  84 ppp_input (vlib_main_t * vm,
  85            vlib_node_runtime_t * node, vlib_frame_t * from_frame)
  86 {
  87   ppp_input_runtime_t *rt = (void *) node->runtime_data;
  88   u32 n_left_from, next_index, i_next, *from, *to_next;
  89
  90   from = vlib_frame_vector_args (from_frame);
  91   n_left_from = from_frame->n_vectors;
  92
  93   if (node->flags & VLIB_NODE_FLAG_TRACE)
  94     vlib_trace_frame_buffers_only (vm, node,
  95                                    from,
  96                                    n_left_from,
  97                                    sizeof (from[0]),
  98                                    sizeof (ppp_input_trace_t));
  99
 100   next_index = node->cached_next_index;
 101   i_next = vec_elt (rt->sparse_index_by_next_index, next_index);
 102
 103   while (n_left_from > 0)
 104     {
 105       u32 n_left_to_next;
 106
 107       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 108
 109       while (n_left_from >= 4 && n_left_to_next >= 2)
 110         {
 111           u32 bi0, bi1;
 112           vlib_buffer_t *b0, *b1;
 113           ppp_header_t *h0, *h1;
 114           u32 i0, i1, protocol0, protocol1, enqueue_code;
 115
 116           /* Prefetch next iteration. */
 117           {
 118             vlib_buffer_t *p2, *p3;
 119
 120             p2 = vlib_get_buffer (vm, from[2]);
 121             p3 = vlib_get_buffer (vm, from[3]);
 122
 123             vlib_prefetch_buffer_header (p2, LOAD);
 124             vlib_prefetch_buffer_header (p3, LOAD);
 125
 126             CLIB_PREFETCH (p2->data, sizeof (h0[0]), LOAD);
 127             CLIB_PREFETCH (p3->data, sizeof (h1[0]), LOAD);
 128           }
 129
 130           bi0 = from[0];
 131           bi1 = from[1];
 132           to_next[0] = bi0;
 133           to_next[1] = bi1;
 134           from += 2;
 135           to_next += 2;
 136           n_left_to_next -= 2;
 137           n_left_from -= 2;
 138
 139           b0 = vlib_get_buffer (vm, bi0);
 140           b1 = vlib_get_buffer (vm, bi1);
 141
 142           h0 = (void *) (b0->data + b0->current_data);
 143           h1 = (void *) (b1->data + b1->current_data);
 144
 145           b0->current_data += sizeof (h0[0]);
 146           b1->current_data += sizeof (h1[0]);
 147
 148           b0->current_length -= sizeof (h0[0]);
 149           b1->current_length -= sizeof (h1[0]);
 150
 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,
 155                              &i1);
 156
 157           b0->error =
 158             node->errors[i0 ==
 159                          SPARSE_VEC_INVALID_INDEX ? PPP_ERROR_UNKNOWN_PROTOCOL
 160                          : PPP_ERROR_NONE];
 161           b1->error =
 162             node->errors[i1 ==
 163                          SPARSE_VEC_INVALID_INDEX ? PPP_ERROR_UNKNOWN_PROTOCOL
 164                          : PPP_ERROR_NONE];
 165
 166           enqueue_code = (i0 != i_next) + 2 * (i1 != i_next);
 167
 168           if (PREDICT_FALSE (enqueue_code != 0))
 169             {
 170               switch (enqueue_code)
 171                 {
 172                 case 1:
 173                   /* A B A */
 174                   to_next[-2] = bi1;
 175                   to_next -= 1;
 176                   n_left_to_next += 1;
 177                   vlib_set_next_frame_buffer (vm, node,
 178                                               vec_elt (rt->next_by_protocol,
 179                                                        i0), bi0);
 180                   break;
 181
 182                 case 2:
 183                   /* A A B */
 184                   to_next -= 1;
 185                   n_left_to_next += 1;
 186                   vlib_set_next_frame_buffer (vm, node,
 187                                               vec_elt (rt->next_by_protocol,
 188                                                        i1), bi1);
 189                   break;
 190
 191                 case 3:
 192                   /* A B B or A B C */
 193                   to_next -= 2;
 194                   n_left_to_next += 2;
 195                   vlib_set_next_frame_buffer (vm, node,
 196                                               vec_elt (rt->next_by_protocol,
 197                                                        i0), bi0);
 198                   vlib_set_next_frame_buffer (vm, node,
 199                                               vec_elt (rt->next_by_protocol,
 200                                                        i1), bi1);
 201                   if (i0 == i1)
 202                     {
 203                       vlib_put_next_frame (vm, node, next_index,
 204                                            n_left_to_next);
 205                       i_next = i1;
 206                       next_index = vec_elt (rt->next_by_protocol, i_next);
 207                       vlib_get_next_frame (vm, node, next_index, to_next,
 208                                            n_left_to_next);
 209                     }
 210                 }
 211             }
 212         }
 213
 214       while (n_left_from > 0 && n_left_to_next > 0)
 215         {
 216           u32 bi0;
 217           vlib_buffer_t *b0;
 218           ppp_header_t *h0;
 219           u32 i0, protocol0;
 220
 221           bi0 = from[0];
 222           to_next[0] = bi0;
 223           from += 1;
 224           to_next += 1;
 225           n_left_from -= 1;
 226           n_left_to_next -= 1;
 227
 228           b0 = vlib_get_buffer (vm, bi0);
 229
 230           h0 = (void *) (b0->data + b0->current_data);
 231
 232           b0->current_data += sizeof (h0[0]);
 233           b0->current_length -= sizeof (h0[0]);
 234
 235           protocol0 = h0->protocol;
 236           i0 = sparse_vec_index (rt->next_by_protocol, protocol0);
 237
 238           b0->error =
 239             node->errors[i0 ==
 240                          SPARSE_VEC_INVALID_INDEX ? PPP_ERROR_UNKNOWN_PROTOCOL
 241                          : PPP_ERROR_NONE];
 242
 243           /* Sent packet to wrong next? */
 244           if (PREDICT_FALSE (i0 != i_next))
 245             {
 246               /* Return old frame; remove incorrectly enqueued packet. */
 247               vlib_put_next_frame (vm, node, next_index, n_left_to_next + 1);
 248
 249               /* Send to correct next. */
 250               i_next = i0;
 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);
 254               to_next[0] = bi0;
 255               to_next += 1;
 256               n_left_to_next -= 1;
 257             }
 258         }
 259
 260       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 261     }
 262
 263   return from_frame->n_vectors;
 264 }
 265
 266 static char *ppp_error_strings[] = {
 267 #define ppp_error(n,s) s,
 268 #include "error.def"
 269 #undef ppp_error
 270 };
 271
 272 /* *INDENT-OFF* */
 273 VLIB_REGISTER_NODE (ppp_input_node) = {
 274   .function = ppp_input,
 275   .name = "ppp-input",
 276   /* Takes a vector of packets. */
 277   .vector_size = sizeof (u32),
 278
 279   .runtime_data_bytes = sizeof (ppp_input_runtime_t),
 280
 281   .n_errors = PPP_N_ERROR,
 282   .error_strings = ppp_error_strings,
 283
 284   .n_next_nodes = PPP_INPUT_N_NEXT,
 285   .next_nodes = {
 286 #define _(s,n) [PPP_INPUT_NEXT_##s] = n,
 287     foreach_ppp_input_next
 288 #undef _
 289   },
 290
 291   .format_buffer = format_ppp_header_with_length,
 292   .format_trace = format_ppp_input_trace,
 293   .unformat_buffer = unformat_ppp_header,
 294 };
 295 /* *INDENT-ON* */
 296
 297 static clib_error_t *
 298 ppp_input_init (vlib_main_t * vm)
 299 {
 300   ppp_input_runtime_t *rt;
 301
 302   {
 303     clib_error_t *error = vlib_call_init_function (vm, ppp_init);
 304     if (error)
 305       clib_error_report (error);
 306   }
 307
 308   ppp_setup_node (vm, ppp_input_node.index);
 309
 310   rt = vlib_node_get_runtime_data (vm, ppp_input_node.index);
 311
 312   rt->next_by_protocol = sparse_vec_new
 313     ( /* elt bytes */ sizeof (rt->next_by_protocol[0]),
 314      /* bits in index */ BITS (((ppp_header_t *) 0)->protocol));
 315
 316   vec_validate (rt->sparse_index_by_next_index, PPP_INPUT_NEXT_DROP);
 317   vec_validate (rt->sparse_index_by_next_index, PPP_INPUT_NEXT_PUNT);
 318   rt->sparse_index_by_next_index[PPP_INPUT_NEXT_DROP]
 319     = SPARSE_VEC_INVALID_INDEX;
 320   rt->sparse_index_by_next_index[PPP_INPUT_NEXT_PUNT]
 321     = SPARSE_VEC_INVALID_INDEX;
 322
 323   return 0;
 324 }
 325
 326 VLIB_INIT_FUNCTION (ppp_input_init);
 327
 328 void
 329 ppp_register_input_protocol (vlib_main_t * vm,
 330                              ppp_protocol_t protocol, u32 node_index)
 331 {
 332   ppp_main_t *em = &ppp_main;
 333   ppp_protocol_info_t *pi;
 334   ppp_input_runtime_t *rt;
 335   u16 *n;
 336   u32 i;
 337
 338   {
 339     clib_error_t *error = vlib_call_init_function (vm, ppp_input_init);
 340     if (error)
 341       clib_error_report (error);
 342   }
 343
 344   pi = ppp_get_protocol_info (em, protocol);
 345   pi->node_index = node_index;
 346   pi->next_index = vlib_node_add_next (vm, ppp_input_node.index, node_index);
 347
 348   /* Setup ppp protocol -> next index sparse vector mapping. */
 349   rt = vlib_node_get_runtime_data (vm, ppp_input_node.index);
 350   n =
 351     sparse_vec_validate (rt->next_by_protocol,
 352                          clib_host_to_net_u16 (protocol));
 353   n[0] = pi->next_index;
 354
 355   /* Rebuild next index -> sparse index inverse mapping when sparse vector
 356      is updated. */
 357   vec_validate (rt->sparse_index_by_next_index, pi->next_index);
 358   for (i = 1; i < vec_len (rt->next_by_protocol); i++)
 359     rt->sparse_index_by_next_index[rt->next_by_protocol[i]] = i;
 360 }
 361
 362 /*
 363  * fd.io coding-style-patch-verification: ON
 364  *
 365  * Local Variables:
 366  * eval: (c-set-style "gnu")
 367  * End:
 368  */