src/vnet/osi/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  * osi_node.c: osi 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/osi/osi.h>
  43 #include <vnet/ppp/ppp.h>
  44 #include <vnet/hdlc/hdlc.h>
  45 #include <vnet/llc/llc.h>
  46
  47 #define foreach_osi_input_next                  \
  48   _ (PUNT, "error-punt")                        \
  49   _ (DROP, "error-drop")
  50
  51 typedef enum
  52 {
  53 #define _(s,n) OSI_INPUT_NEXT_##s,
  54   foreach_osi_input_next
  55 #undef _
  56     OSI_INPUT_N_NEXT,
  57 } osi_input_next_t;
  58
  59 typedef struct
  60 {
  61   u8 packet_data[32];
  62 } osi_input_trace_t;
  63
  64 static u8 *
  65 format_osi_input_trace (u8 * s, va_list * va)
  66 {
  67   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
  68   CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
  69   osi_input_trace_t *t = va_arg (*va, osi_input_trace_t *);
  70
  71   s = format (s, "%U", format_osi_header, t->packet_data);
  72
  73   return s;
  74 }
  75
  76 static uword
  77 osi_input (vlib_main_t * vm,
  78            vlib_node_runtime_t * node, vlib_frame_t * from_frame)
  79 {
  80   osi_main_t *lm = &osi_main;
  81   u32 n_left_from, next_index, *from, *to_next;
  82
  83   from = vlib_frame_vector_args (from_frame);
  84   n_left_from = from_frame->n_vectors;
  85
  86   if (node->flags & VLIB_NODE_FLAG_TRACE)
  87     vlib_trace_frame_buffers_only (vm, node,
  88                                    from,
  89                                    n_left_from,
  90                                    sizeof (from[0]),
  91                                    sizeof (osi_input_trace_t));
  92
  93   next_index = node->cached_next_index;
  94
  95   while (n_left_from > 0)
  96     {
  97       u32 n_left_to_next;
  98
  99       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 100
 101       while (n_left_from >= 4 && n_left_to_next >= 2)
 102         {
 103           u32 bi0, bi1;
 104           vlib_buffer_t *b0, *b1;
 105           osi_header_t *h0, *h1;
 106           u8 next0, next1, enqueue_code;
 107
 108           /* Prefetch next iteration. */
 109           {
 110             vlib_buffer_t *b2, *b3;
 111
 112             b2 = vlib_get_buffer (vm, from[2]);
 113             b3 = vlib_get_buffer (vm, from[3]);
 114
 115             vlib_prefetch_buffer_header (b2, LOAD);
 116             vlib_prefetch_buffer_header (b3, LOAD);
 117
 118             CLIB_PREFETCH (b2->data, sizeof (h0[0]), LOAD);
 119             CLIB_PREFETCH (b3->data, sizeof (h1[0]), LOAD);
 120           }
 121
 122           bi0 = from[0];
 123           bi1 = from[1];
 124           to_next[0] = bi0;
 125           to_next[1] = bi1;
 126           from += 2;
 127           to_next += 2;
 128           n_left_to_next -= 2;
 129           n_left_from -= 2;
 130
 131           b0 = vlib_get_buffer (vm, bi0);
 132           b1 = vlib_get_buffer (vm, bi1);
 133
 134           h0 = vlib_buffer_get_current (b0);
 135           h1 = vlib_buffer_get_current (b1);
 136
 137           next0 = lm->input_next_by_protocol[h0->protocol];
 138           next1 = lm->input_next_by_protocol[h1->protocol];
 139
 140           b0->error =
 141             node->errors[next0 ==
 142                          OSI_INPUT_NEXT_DROP ? OSI_ERROR_UNKNOWN_PROTOCOL :
 143                          OSI_ERROR_NONE];
 144           b1->error =
 145             node->errors[next1 ==
 146                          OSI_INPUT_NEXT_DROP ? OSI_ERROR_UNKNOWN_PROTOCOL :
 147                          OSI_ERROR_NONE];
 148
 149           enqueue_code = (next0 != next_index) + 2 * (next1 != next_index);
 150
 151           if (PREDICT_FALSE (enqueue_code != 0))
 152             {
 153               switch (enqueue_code)
 154                 {
 155                 case 1:
 156                   /* A B A */
 157                   to_next[-2] = bi1;
 158                   to_next -= 1;
 159                   n_left_to_next += 1;
 160                   vlib_set_next_frame_buffer (vm, node, next0, bi0);
 161                   break;
 162
 163                 case 2:
 164                   /* A A B */
 165                   to_next -= 1;
 166                   n_left_to_next += 1;
 167                   vlib_set_next_frame_buffer (vm, node, next1, bi1);
 168                   break;
 169
 170                 case 3:
 171                   /* A B B or A B C */
 172                   to_next -= 2;
 173                   n_left_to_next += 2;
 174                   vlib_set_next_frame_buffer (vm, node, next0, bi0);
 175                   vlib_set_next_frame_buffer (vm, node, next1, bi1);
 176                   if (next0 == next1)
 177                     {
 178                       vlib_put_next_frame (vm, node, next_index,
 179                                            n_left_to_next);
 180                       next_index = next1;
 181                       vlib_get_next_frame (vm, node, next_index, to_next,
 182                                            n_left_to_next);
 183                     }
 184                 }
 185             }
 186         }
 187
 188       while (n_left_from > 0 && n_left_to_next > 0)
 189         {
 190           u32 bi0;
 191           vlib_buffer_t *b0;
 192           osi_header_t *h0;
 193           u8 next0;
 194
 195           bi0 = from[0];
 196           to_next[0] = bi0;
 197           from += 1;
 198           to_next += 1;
 199           n_left_from -= 1;
 200           n_left_to_next -= 1;
 201
 202           b0 = vlib_get_buffer (vm, bi0);
 203
 204           h0 = vlib_buffer_get_current (b0);
 205
 206           next0 = lm->input_next_by_protocol[h0->protocol];
 207
 208           b0->error =
 209             node->errors[next0 ==
 210                          OSI_INPUT_NEXT_DROP ? OSI_ERROR_UNKNOWN_PROTOCOL :
 211                          OSI_ERROR_NONE];
 212
 213           /* Sent packet to wrong next? */
 214           if (PREDICT_FALSE (next0 != next_index))
 215             {
 216               /* Return old frame; remove incorrectly enqueued packet. */
 217               vlib_put_next_frame (vm, node, next_index, n_left_to_next + 1);
 218
 219               /* Send to correct next. */
 220               next_index = next0;
 221               vlib_get_next_frame (vm, node, next_index, to_next,
 222                                    n_left_to_next);
 223
 224               to_next[0] = bi0;
 225               to_next += 1;
 226               n_left_to_next -= 1;
 227             }
 228         }
 229
 230       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 231     }
 232
 233   return from_frame->n_vectors;
 234 }
 235
 236 static char *osi_error_strings[] = {
 237 #define _(f,s) s,
 238   foreach_osi_error
 239 #undef _
 240 };
 241
 242 /* *INDENT-OFF* */
 243 VLIB_REGISTER_NODE (osi_input_node) = {
 244   .function = osi_input,
 245   .name = "osi-input",
 246   /* Takes a vector of packets. */
 247   .vector_size = sizeof (u32),
 248
 249   .n_errors = OSI_N_ERROR,
 250   .error_strings = osi_error_strings,
 251
 252   .n_next_nodes = OSI_INPUT_N_NEXT,
 253   .next_nodes = {
 254 #define _(s,n) [OSI_INPUT_NEXT_##s] = n,
 255     foreach_osi_input_next
 256 #undef _
 257   },
 258
 259   .format_buffer = format_osi_header_with_length,
 260   .format_trace = format_osi_input_trace,
 261   .unformat_buffer = unformat_osi_header,
 262 };
 263 /* *INDENT-ON* */
 264
 265 static void
 266 osi_setup_node (vlib_main_t *vm, u32 node_index)
 267 {
 268   vlib_node_t *n = vlib_get_node (vm, node_index);
 269   pg_node_t *pn = pg_get_node (node_index);
 270
 271   n->format_buffer = format_osi_header_with_length;
 272   n->unformat_buffer = unformat_osi_header;
 273   pn->unformat_edit = unformat_pg_osi_header;
 274 }
 275
 276 static clib_error_t *
 277 osi_input_init (vlib_main_t * vm)
 278 {
 279   clib_error_t *error = 0;
 280   osi_main_t *lm = &osi_main;
 281
 282   if ((error = vlib_call_init_function (vm, osi_init)))
 283     return error;
 284
 285   osi_setup_node (vm, osi_input_node.index);
 286
 287   {
 288     int i;
 289     for (i = 0; i < ARRAY_LEN (lm->input_next_by_protocol); i++)
 290       lm->input_next_by_protocol[i] = OSI_INPUT_NEXT_DROP;
 291   }
 292
 293   ppp_register_input_protocol (vm, PPP_PROTOCOL_osi, osi_input_node.index);
 294   hdlc_register_input_protocol (vm, HDLC_PROTOCOL_osi, osi_input_node.index);
 295   llc_register_input_protocol (vm, LLC_PROTOCOL_osi_layer1,
 296                                osi_input_node.index);
 297   llc_register_input_protocol (vm, LLC_PROTOCOL_osi_layer2,
 298                                osi_input_node.index);
 299   llc_register_input_protocol (vm, LLC_PROTOCOL_osi_layer3,
 300                                osi_input_node.index);
 301   llc_register_input_protocol (vm, LLC_PROTOCOL_osi_layer4,
 302                                osi_input_node.index);
 303   llc_register_input_protocol (vm, LLC_PROTOCOL_osi_layer5,
 304                                osi_input_node.index);
 305
 306   return 0;
 307 }
 308
 309 VLIB_INIT_FUNCTION (osi_input_init);
 310
 311 void
 312 osi_register_input_protocol (osi_protocol_t protocol, u32 node_index)
 313 {
 314   osi_main_t *lm = &osi_main;
 315   vlib_main_t *vm = lm->vlib_main;
 316   osi_protocol_info_t *pi;
 317
 318   {
 319     clib_error_t *error = vlib_call_init_function (vm, osi_input_init);
 320     if (error)
 321       clib_error_report (error);
 322   }
 323
 324   pi = osi_get_protocol_info (lm, protocol);
 325   pi->node_index = node_index;
 326   pi->next_index = vlib_node_add_next (vm, osi_input_node.index, node_index);
 327
 328   lm->input_next_by_protocol[protocol] = pi->next_index;
 329 }
 330
 331 /*
 332  * fd.io coding-style-patch-verification: ON
 333  *
 334  * Local Variables:
 335  * eval: (c-set-style "gnu")
 336  * End:
 337  */