src/vlib/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  * node.c: VLIB processing nodes
  17  *
  18  * Copyright (c) 2008 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 <vlib/threads.h>
  42
  43 /* Query node given name. */
  44 vlib_node_t *
  45 vlib_get_node_by_name (vlib_main_t * vm, u8 * name)
  46 {
  47   vlib_node_main_t *nm = &vm->node_main;
  48   uword *p;
  49   u8 *key = name;
  50   if (!clib_mem_is_heap_object (key))
  51     key = format (0, "%s", key);
  52   p = hash_get (nm->node_by_name, key);
  53   if (key != name)
  54     vec_free (key);
  55   return p ? vec_elt (nm->nodes, p[0]) : 0;
  56 }
  57
  58 static void
  59 node_set_elog_name (vlib_main_t * vm, uword node_index)
  60 {
  61   vlib_node_t *n = vlib_get_node (vm, node_index);
  62   elog_event_type_t *t;
  63
  64   t = vec_elt_at_index (vm->node_call_elog_event_types, node_index);
  65   vec_free (t->format);
  66   t->format = (char *) format (0, "%v-call: %%d%c", n->name, 0);
  67
  68   t = vec_elt_at_index (vm->node_return_elog_event_types, node_index);
  69   vec_free (t->format);
  70   t->format = (char *) format (0, "%v-return: %%d%c", n->name, 0);
  71
  72   n->name_elog_string = elog_string (&vm->elog_main, "%v%c", n->name, 0);
  73 }
  74
  75 void
  76 vlib_node_rename (vlib_main_t * vm, u32 node_index, char *fmt, ...)
  77 {
  78   va_list va;
  79   vlib_node_main_t *nm = &vm->node_main;
  80   vlib_node_t *n = vlib_get_node (vm, node_index);
  81
  82   va_start (va, fmt);
  83   hash_unset (nm->node_by_name, n->name);
  84   vec_free (n->name);
  85   n->name = va_format (0, fmt, &va);
  86   va_end (va);
  87   hash_set (nm->node_by_name, n->name, n->index);
  88
  89   node_set_elog_name (vm, node_index);
  90 }
  91
  92 static void
  93 vlib_node_runtime_update (vlib_main_t * vm, u32 node_index, u32 next_index)
  94 {
  95   vlib_node_main_t *nm = &vm->node_main;
  96   vlib_node_runtime_t *r, *s;
  97   vlib_node_t *node, *next_node;
  98   vlib_next_frame_t *nf;
  99   vlib_pending_frame_t *pf;
 100   i32 i, j, n_insert;
 101
 102   ASSERT (vlib_get_thread_index () == 0);
 103
 104   vlib_worker_thread_barrier_sync (vm);
 105
 106   node = vec_elt (nm->nodes, node_index);
 107   r = vlib_node_get_runtime (vm, node_index);
 108
 109   n_insert = vec_len (node->next_nodes) - r->n_next_nodes;
 110   if (n_insert > 0)
 111     {
 112       i = r->next_frame_index + r->n_next_nodes;
 113       vec_insert (nm->next_frames, n_insert, i);
 114
 115       /* Initialize newly inserted next frames. */
 116       for (j = 0; j < n_insert; j++)
 117         vlib_next_frame_init (nm->next_frames + i + j);
 118
 119       /* Relocate other next frames at higher indices. */
 120       for (j = 0; j < vec_len (nm->nodes); j++)
 121         {
 122           s = vlib_node_get_runtime (vm, j);
 123           if (j != node_index && s->next_frame_index >= i)
 124             s->next_frame_index += n_insert;
 125         }
 126
 127       /* Pending frames may need to be relocated also. */
 128       vec_foreach (pf, nm->pending_frames)
 129       {
 130         if (pf->next_frame_index != VLIB_PENDING_FRAME_NO_NEXT_FRAME
 131             && pf->next_frame_index >= i)
 132           pf->next_frame_index += n_insert;
 133       }
 134       /* *INDENT-OFF* */
 135       pool_foreach (pf, nm->suspended_process_frames, ({
 136           if (pf->next_frame_index != ~0 && pf->next_frame_index >= i)
 137             pf->next_frame_index += n_insert;
 138       }));
 139       /* *INDENT-ON* */
 140
 141       r->n_next_nodes = vec_len (node->next_nodes);
 142     }
 143
 144   /* Set frame's node runtime index. */
 145   next_node = vlib_get_node (vm, node->next_nodes[next_index]);
 146   nf = nm->next_frames + r->next_frame_index + next_index;
 147   nf->node_runtime_index = next_node->runtime_index;
 148
 149   vlib_worker_thread_node_runtime_update ();
 150
 151   vlib_worker_thread_barrier_release (vm);
 152 }
 153
 154 uword
 155 vlib_node_get_next (vlib_main_t * vm, uword node_index, uword next_node_index)
 156 {
 157   vlib_node_main_t *nm = &vm->node_main;
 158   vlib_node_t *node;
 159   uword *p;
 160
 161   node = vec_elt (nm->nodes, node_index);
 162
 163   /* Runtime has to be initialized. */
 164   ASSERT (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED);
 165
 166   if ((p = hash_get (node->next_slot_by_node, next_node_index)))
 167     {
 168       return p[0];
 169     }
 170
 171   return (~0);
 172 }
 173
 174 /* Add next node to given node in given slot. */
 175 uword
 176 vlib_node_add_next_with_slot (vlib_main_t * vm,
 177                               uword node_index,
 178                               uword next_node_index, uword slot)
 179 {
 180   vlib_node_main_t *nm = &vm->node_main;
 181   vlib_node_t *node, *next;
 182   uword *p;
 183
 184   node = vec_elt (nm->nodes, node_index);
 185   next = vec_elt (nm->nodes, next_node_index);
 186
 187   /* Runtime has to be initialized. */
 188   ASSERT (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED);
 189
 190   if ((p = hash_get (node->next_slot_by_node, next_node_index)))
 191     {
 192       /* Next already exists: slot must match. */
 193       if (slot != ~0)
 194         ASSERT (slot == p[0]);
 195       return p[0];
 196     }
 197
 198   if (slot == ~0)
 199     slot = vec_len (node->next_nodes);
 200
 201   vec_validate_init_empty (node->next_nodes, slot, ~0);
 202   vec_validate (node->n_vectors_by_next_node, slot);
 203
 204   node->next_nodes[slot] = next_node_index;
 205   hash_set (node->next_slot_by_node, next_node_index, slot);
 206
 207   vlib_node_runtime_update (vm, node_index, slot);
 208
 209   next->prev_node_bitmap = clib_bitmap_ori (next->prev_node_bitmap,
 210                                             node_index);
 211
 212   /* Siblings all get same node structure. */
 213   {
 214     uword sib_node_index, sib_slot;
 215     vlib_node_t *sib_node;
 216     /* *INDENT-OFF* */
 217     clib_bitmap_foreach (sib_node_index, node->sibling_bitmap, ({
 218       sib_node = vec_elt (nm->nodes, sib_node_index);
 219       if (sib_node != node)
 220         {
 221           sib_slot = vlib_node_add_next_with_slot (vm, sib_node_index, next_node_index, slot);
 222           ASSERT (sib_slot == slot);
 223         }
 224     }));
 225     /* *INDENT-ON* */
 226   }
 227
 228   return slot;
 229 }
 230
 231 /* Add named next node to given node in given slot. */
 232 uword
 233 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
 234                                     uword node, char *name, uword slot)
 235 {
 236   vlib_node_main_t *nm;
 237   vlib_node_t *n, *n_next;
 238
 239   nm = &vm->node_main;
 240   n = vlib_get_node (vm, node);
 241
 242   n_next = vlib_get_node_by_name (vm, (u8 *) name);
 243   if (!n_next)
 244     {
 245       if (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED)
 246         return ~0;
 247
 248       if (slot == ~0)
 249         slot = clib_max (vec_len (n->next_node_names),
 250                          vec_len (n->next_nodes));
 251       vec_validate (n->next_node_names, slot);
 252       n->next_node_names[slot] = name;
 253       return slot;
 254     }
 255
 256   return vlib_node_add_next_with_slot (vm, node, n_next->index, slot);
 257 }
 258
 259 static void
 260 node_elog_init (vlib_main_t * vm, uword ni)
 261 {
 262   elog_event_type_t t;
 263
 264   memset (&t, 0, sizeof (t));
 265
 266   /* 2 event types for this node: one when node function is called.
 267      One when it returns. */
 268   vec_validate (vm->node_call_elog_event_types, ni);
 269   vm->node_call_elog_event_types[ni] = t;
 270
 271   vec_validate (vm->node_return_elog_event_types, ni);
 272   vm->node_return_elog_event_types[ni] = t;
 273
 274   node_set_elog_name (vm, ni);
 275 }
 276
 277 #ifdef CLIB_UNIX
 278 #define STACK_ALIGN (clib_mem_get_page_size())
 279 #else
 280 #define STACK_ALIGN CLIB_CACHE_LINE_BYTES
 281 #endif
 282
 283 static void
 284 register_node (vlib_main_t * vm, vlib_node_registration_t * r)
 285 {
 286   vlib_node_main_t *nm = &vm->node_main;
 287   vlib_node_t *n;
 288   u32 page_size = clib_mem_get_page_size ();
 289   int i;
 290
 291   if (CLIB_DEBUG > 0)
 292     {
 293       /* Default (0) type should match INTERNAL. */
 294       vlib_node_t zero = { 0 };
 295       ASSERT (VLIB_NODE_TYPE_INTERNAL == zero.type);
 296     }
 297
 298   ASSERT (r->function != 0);
 299
 300   n = clib_mem_alloc_no_fail (sizeof (n[0]));
 301   memset (n, 0, sizeof (n[0]));
 302   n->index = vec_len (nm->nodes);
 303
 304   vec_add1 (nm->nodes, n);
 305
 306   /* Name is always a vector so it can be formatted with %v. */
 307   if (clib_mem_is_heap_object (vec_header (r->name, 0)))
 308     n->name = vec_dup ((u8 *) r->name);
 309   else
 310     n->name = format (0, "%s", r->name);
 311
 312   if (!nm->node_by_name)
 313     nm->node_by_name = hash_create_vec ( /* size */ 32,
 314                                         sizeof (n->name[0]), sizeof (uword));
 315
 316   /* Node names must be unique. */
 317   {
 318     vlib_node_t *o = vlib_get_node_by_name (vm, n->name);
 319     if (o)
 320       clib_error ("more than one node named `%v'", n->name);
 321   }
 322
 323   hash_set (nm->node_by_name, n->name, n->index);
 324
 325   r->index = n->index;          /* save index in registration */
 326   n->function = r->function;
 327
 328   /* Node index of next sibling will be filled in by vlib_node_main_init. */
 329   n->sibling_of = r->sibling_of;
 330   if (r->sibling_of && r->n_next_nodes > 0)
 331     clib_error ("sibling node should not have any next nodes `%v'", n->name);
 332
 333   if (r->type == VLIB_NODE_TYPE_INTERNAL)
 334     ASSERT (r->vector_size > 0);
 335
 336 #define _(f) n->f = r->f
 337
 338   _(type);
 339   _(flags);
 340   _(state);
 341   _(scalar_size);
 342   _(vector_size);
 343   _(format_buffer);
 344   _(unformat_buffer);
 345   _(format_trace);
 346   _(validate_frame);
 347
 348   /* Register error counters. */
 349   vlib_register_errors (vm, n->index, r->n_errors, r->error_strings);
 350   node_elog_init (vm, n->index);
 351
 352   _(runtime_data_bytes);
 353   if (r->runtime_data_bytes > 0)
 354     {
 355       vec_resize (n->runtime_data, r->runtime_data_bytes);
 356       if (r->runtime_data)
 357         clib_memcpy (n->runtime_data, r->runtime_data, r->runtime_data_bytes);
 358     }
 359
 360   vec_resize (n->next_node_names, r->n_next_nodes);
 361   for (i = 0; i < r->n_next_nodes; i++)
 362     n->next_node_names[i] = r->next_nodes[i];
 363
 364   vec_validate_init_empty (n->next_nodes, r->n_next_nodes - 1, ~0);
 365   vec_validate (n->n_vectors_by_next_node, r->n_next_nodes - 1);
 366
 367   n->owner_node_index = n->owner_next_index = ~0;
 368
 369   /* Initialize node runtime. */
 370   {
 371     vlib_node_runtime_t *rt;
 372     u32 i;
 373
 374     if (n->type == VLIB_NODE_TYPE_PROCESS)
 375       {
 376         vlib_process_t *p;
 377         uword log2_n_stack_bytes;
 378
 379         log2_n_stack_bytes = clib_max (r->process_log2_n_stack_bytes, 15);
 380
 381 #ifdef CLIB_UNIX
 382         /*
 383          * Bump the stack size if running over a kernel with a large page size,
 384          * and the stack isn't any too big to begin with. Otherwise, we'll
 385          * trip over the stack guard page for sure.
 386          */
 387         if ((page_size > (4 << 10)) && log2_n_stack_bytes < 19)
 388           {
 389             if ((1 << log2_n_stack_bytes) <= page_size)
 390               log2_n_stack_bytes = min_log2 (page_size) + 1;
 391             else
 392               log2_n_stack_bytes++;
 393           }
 394 #endif
 395
 396         p = clib_mem_alloc_aligned_at_offset
 397           (sizeof (p[0]) + (1 << log2_n_stack_bytes),
 398            STACK_ALIGN, STRUCT_OFFSET_OF (vlib_process_t, stack),
 399            0 /* no, don't call os_out_of_memory */ );
 400         if (p == 0)
 401           clib_panic ("failed to allocate process stack (%d bytes)",
 402                       1 << log2_n_stack_bytes);
 403
 404         memset (p, 0, sizeof (p[0]));
 405         p->log2_n_stack_bytes = log2_n_stack_bytes;
 406
 407         /* Process node's runtime index is really index into process
 408            pointer vector. */
 409         n->runtime_index = vec_len (nm->processes);
 410
 411         vec_add1 (nm->processes, p);
 412
 413         /* Paint first stack word with magic number so we can at least
 414            detect process stack overruns. */
 415         p->stack[0] = VLIB_PROCESS_STACK_MAGIC;
 416
 417         /* Node runtime is stored inside of process. */
 418         rt = &p->node_runtime;
 419
 420 #ifdef CLIB_UNIX
 421         /*
 422          * Disallow writes to the bottom page of the stack, to
 423          * catch stack overflows.
 424          */
 425         if (mprotect (p->stack, page_size, PROT_READ) < 0)
 426           clib_unix_warning ("process stack");
 427 #endif
 428
 429       }
 430     else
 431       {
 432         vec_add2_aligned (nm->nodes_by_type[n->type], rt, 1,
 433                           /* align */ CLIB_CACHE_LINE_BYTES);
 434         n->runtime_index = rt - nm->nodes_by_type[n->type];
 435       }
 436
 437     if (n->type == VLIB_NODE_TYPE_INPUT)
 438       nm->input_node_counts_by_state[n->state] += 1;
 439
 440     rt->function = n->function;
 441     rt->flags = n->flags;
 442     rt->state = n->state;
 443     rt->node_index = n->index;
 444
 445     rt->n_next_nodes = r->n_next_nodes;
 446     rt->next_frame_index = vec_len (nm->next_frames);
 447
 448     vec_resize (nm->next_frames, rt->n_next_nodes);
 449     for (i = 0; i < rt->n_next_nodes; i++)
 450       vlib_next_frame_init (nm->next_frames + rt->next_frame_index + i);
 451
 452     vec_resize (rt->errors, r->n_errors);
 453     for (i = 0; i < vec_len (rt->errors); i++)
 454       rt->errors[i] = vlib_error_set (n->index, i);
 455
 456     STATIC_ASSERT_SIZEOF (vlib_node_runtime_t, 128);
 457     ASSERT (vec_len (n->runtime_data) <= VLIB_NODE_RUNTIME_DATA_SIZE);
 458
 459     if (vec_len (n->runtime_data) > 0)
 460       clib_memcpy (rt->runtime_data, n->runtime_data,
 461                    vec_len (n->runtime_data));
 462
 463     vec_free (n->runtime_data);
 464   }
 465 }
 466
 467 /* Register new packet processing node. */
 468 u32
 469 vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r)
 470 {
 471   register_node (vm, r);
 472   return r->index;
 473 }
 474
 475 static uword
 476 null_node_fn (vlib_main_t * vm,
 477               vlib_node_runtime_t * node, vlib_frame_t * frame)
 478 {
 479   u16 n_vectors = frame->n_vectors;
 480
 481   vlib_node_increment_counter (vm, node->node_index, 0, n_vectors);
 482   vlib_buffer_free (vm, vlib_frame_args (frame), n_vectors);
 483   vlib_frame_free (vm, node, frame);
 484
 485   return n_vectors;
 486 }
 487
 488 void
 489 vlib_register_all_static_nodes (vlib_main_t * vm)
 490 {
 491   vlib_node_registration_t *r;
 492
 493   static char *null_node_error_strings[] = {
 494     "blackholed packets",
 495   };
 496
 497   static vlib_node_registration_t null_node_reg = {
 498     .function = null_node_fn,
 499     .vector_size = sizeof (u32),
 500     .name = "null-node",
 501     .n_errors = 1,
 502     .error_strings = null_node_error_strings,
 503   };
 504
 505   /* make sure that node index 0 is not used by
 506      real node */
 507   register_node (vm, &null_node_reg);
 508
 509   r = vm->node_main.node_registrations;
 510   while (r)
 511     {
 512       register_node (vm, r);
 513       r = r->next_registration;
 514     }
 515 }
 516
 517 clib_error_t *
 518 vlib_node_main_init (vlib_main_t * vm)
 519 {
 520   vlib_node_main_t *nm = &vm->node_main;
 521   clib_error_t *error = 0;
 522   vlib_node_t *n;
 523   uword ni;
 524
 525   nm->frame_size_hash = hash_create (0, sizeof (uword));
 526   nm->flags |= VLIB_NODE_MAIN_RUNTIME_STARTED;
 527
 528   /* Generate sibling relationships */
 529   {
 530     vlib_node_t *n, *sib;
 531     uword si;
 532
 533     for (ni = 0; ni < vec_len (nm->nodes); ni++)
 534       {
 535         n = vec_elt (nm->nodes, ni);
 536
 537         if (!n->sibling_of)
 538           continue;
 539
 540         sib = vlib_get_node_by_name (vm, (u8 *) n->sibling_of);
 541         if (!sib)
 542           {
 543             error = clib_error_create ("sibling `%s' not found for node `%v'",
 544                                        n->sibling_of, n->name);
 545             goto done;
 546           }
 547
 548         /* *INDENT-OFF* */
 549         clib_bitmap_foreach (si, sib->sibling_bitmap, ({
 550               vlib_node_t * m = vec_elt (nm->nodes, si);
 551
 552               /* Connect all of sibling's siblings to us. */
 553               m->sibling_bitmap = clib_bitmap_ori (m->sibling_bitmap, n->index);
 554
 555               /* Connect us to all of sibling's siblings. */
 556               n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, si);
 557             }));
 558         /* *INDENT-ON* */
 559
 560         /* Connect sibling to us. */
 561         sib->sibling_bitmap = clib_bitmap_ori (sib->sibling_bitmap, n->index);
 562
 563         /* Connect us to sibling. */
 564         n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, sib->index);
 565       }
 566   }
 567
 568   /* Resolve next names into next indices. */
 569   for (ni = 0; ni < vec_len (nm->nodes); ni++)
 570     {
 571       uword i;
 572
 573       n = vec_elt (nm->nodes, ni);
 574
 575       for (i = 0; i < vec_len (n->next_node_names); i++)
 576         {
 577           char *a = n->next_node_names[i];
 578
 579           if (!a)
 580             continue;
 581
 582           if (~0 == vlib_node_add_named_next_with_slot (vm, n->index, a, i))
 583             {
 584               error = clib_error_create
 585                 ("node `%v' refers to unknown node `%s'", n->name, a);
 586               goto done;
 587             }
 588         }
 589
 590       vec_free (n->next_node_names);
 591     }
 592
 593   /* Set previous node pointers. */
 594   for (ni = 0; ni < vec_len (nm->nodes); ni++)
 595     {
 596       vlib_node_t *n_next;
 597       uword i;
 598
 599       n = vec_elt (nm->nodes, ni);
 600
 601       for (i = 0; i < vec_len (n->next_nodes); i++)
 602         {
 603           if (n->next_nodes[i] >= vec_len (nm->nodes))
 604             continue;
 605
 606           n_next = vec_elt (nm->nodes, n->next_nodes[i]);
 607           n_next->prev_node_bitmap =
 608             clib_bitmap_ori (n_next->prev_node_bitmap, n->index);
 609         }
 610     }
 611
 612   {
 613     vlib_next_frame_t *nf;
 614     vlib_node_runtime_t *r;
 615     vlib_node_t *next;
 616     uword i;
 617
 618     vec_foreach (r, nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
 619     {
 620       if (r->n_next_nodes == 0)
 621         continue;
 622
 623       n = vlib_get_node (vm, r->node_index);
 624       nf = vec_elt_at_index (nm->next_frames, r->next_frame_index);
 625
 626       for (i = 0; i < vec_len (n->next_nodes); i++)
 627         {
 628           next = vlib_get_node (vm, n->next_nodes[i]);
 629
 630           /* Validate node runtime indices are correctly initialized. */
 631           ASSERT (nf[i].node_runtime_index == next->runtime_index);
 632
 633           nf[i].flags = 0;
 634           if (next->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH)
 635             nf[i].flags |= VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
 636         }
 637     }
 638   }
 639
 640 done:
 641   return error;
 642 }
 643
 644 /*
 645  * fd.io coding-style-patch-verification: ON
 646  *
 647  * Local Variables:
 648  * eval: (c-set-style "gnu")
 649  * End:
 650  */