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   key = format (0, "%s", key);
  51   p = hash_get (nm->node_by_name, key);
  52   if (key != name)
  53     vec_free (key);
  54   return p ? vec_elt (nm->nodes, p[0]) : 0;
  55 }
  56
  57 static void
  58 node_set_elog_name (vlib_main_t * vm, uword node_index)
  59 {
  60   vlib_node_t *n = vlib_get_node (vm, node_index);
  61   elog_event_type_t *t;
  62
  63   t = vec_elt_at_index (vm->node_call_elog_event_types, node_index);
  64   vec_free (t->format);
  65   t->format = (char *) format (0, "%v-call: %%d%c", n->name, 0);
  66
  67   t = vec_elt_at_index (vm->node_return_elog_event_types, node_index);
  68   vec_free (t->format);
  69   t->format = (char *) format (0, "%v-return: %%d%c", n->name, 0);
  70
  71   n->name_elog_string =
  72     elog_string (&vlib_global_main.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   /* Propagate the change to all worker threads */
  92   vlib_worker_thread_node_runtime_update ();
  93 }
  94
  95 static void
  96 vlib_node_runtime_update (vlib_main_t * vm, u32 node_index, u32 next_index)
  97 {
  98   vlib_node_main_t *nm = &vm->node_main;
  99   vlib_node_runtime_t *r, *s;
 100   vlib_node_t *node, *next_node;
 101   vlib_next_frame_t *nf;
 102   vlib_pending_frame_t *pf;
 103   i32 i, j, n_insert;
 104
 105   node = vec_elt (nm->nodes, node_index);
 106   r = vlib_node_get_runtime (vm, node_index);
 107
 108   n_insert = vec_len (node->next_nodes) - r->n_next_nodes;
 109   if (n_insert > 0)
 110     {
 111       i = r->next_frame_index + r->n_next_nodes;
 112       vec_insert (nm->next_frames, n_insert, i);
 113
 114       /* Initialize newly inserted next frames. */
 115       for (j = 0; j < n_insert; j++)
 116         vlib_next_frame_init (nm->next_frames + i + j);
 117
 118       /* Relocate other next frames at higher indices. */
 119       for (j = 0; j < vec_len (nm->nodes); j++)
 120         {
 121           s = vlib_node_get_runtime (vm, j);
 122           if (j != node_index && s->next_frame_index >= i)
 123             s->next_frame_index += n_insert;
 124         }
 125
 126       /* Pending frames may need to be relocated also. */
 127       vec_foreach (pf, nm->pending_frames)
 128       {
 129         if (pf->next_frame_index != VLIB_PENDING_FRAME_NO_NEXT_FRAME
 130             && pf->next_frame_index >= i)
 131           pf->next_frame_index += n_insert;
 132       }
 133       /* *INDENT-OFF* */
 134       pool_foreach (pf, nm->suspended_process_frames)  {
 135           if (pf->next_frame_index != ~0 && pf->next_frame_index >= i)
 136             pf->next_frame_index += n_insert;
 137       }
 138       /* *INDENT-ON* */
 139
 140       r->n_next_nodes = vec_len (node->next_nodes);
 141     }
 142
 143   /* Set frame's node runtime index. */
 144   next_node = vlib_get_node (vm, node->next_nodes[next_index]);
 145   nf = nm->next_frames + r->next_frame_index + next_index;
 146   nf->node_runtime_index = next_node->runtime_index;
 147
 148   vlib_worker_thread_node_runtime_update ();
 149 }
 150
 151 uword
 152 vlib_node_get_next (vlib_main_t * vm, uword node_index, uword next_node_index)
 153 {
 154   vlib_node_main_t *nm = &vm->node_main;
 155   vlib_node_t *node;
 156   uword *p;
 157
 158   node = vec_elt (nm->nodes, node_index);
 159
 160   /* Runtime has to be initialized. */
 161   ASSERT (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED);
 162
 163   if ((p = hash_get (node->next_slot_by_node, next_node_index)))
 164     {
 165       return p[0];
 166     }
 167
 168   return (~0);
 169 }
 170
 171 /* Add next node to given node in given slot. */
 172 uword
 173 vlib_node_add_next_with_slot (vlib_main_t * vm,
 174                               uword node_index,
 175                               uword next_node_index, uword slot)
 176 {
 177   vlib_node_main_t *nm = &vm->node_main;
 178   vlib_node_t *node, *next, *old_next;
 179   u32 old_next_index;
 180   uword *p;
 181
 182   ASSERT (vlib_get_thread_index () == 0);
 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   vlib_worker_thread_barrier_sync (vm);
 199
 200   if (slot == ~0)
 201     slot = vec_len (node->next_nodes);
 202
 203   vec_validate_init_empty (node->next_nodes, slot, ~0);
 204   vec_validate (node->n_vectors_by_next_node, slot);
 205
 206   if ((old_next_index = node->next_nodes[slot]) != ~0u)
 207     {
 208       hash_unset (node->next_slot_by_node, old_next_index);
 209       old_next = vlib_get_node (vm, old_next_index);
 210       old_next->prev_node_bitmap =
 211         clib_bitmap_andnoti (old_next->prev_node_bitmap, node_index);
 212     }
 213
 214   node->next_nodes[slot] = next_node_index;
 215   hash_set (node->next_slot_by_node, next_node_index, slot);
 216
 217   vlib_node_runtime_update (vm, node_index, slot);
 218
 219   next->prev_node_bitmap = clib_bitmap_ori (next->prev_node_bitmap,
 220                                             node_index);
 221
 222   /* Siblings all get same node structure. */
 223   {
 224     uword sib_node_index, sib_slot;
 225     vlib_node_t *sib_node;
 226     /* *INDENT-OFF* */
 227     clib_bitmap_foreach (sib_node_index, node->sibling_bitmap)  {
 228       sib_node = vec_elt (nm->nodes, sib_node_index);
 229       if (sib_node != node)
 230         {
 231           sib_slot = vlib_node_add_next_with_slot (vm, sib_node_index, next_node_index, slot);
 232           ASSERT (sib_slot == slot);
 233         }
 234     }
 235     /* *INDENT-ON* */
 236   }
 237
 238   vlib_worker_thread_barrier_release (vm);
 239   return slot;
 240 }
 241
 242 /* Add named next node to given node in given slot. */
 243 uword
 244 vlib_node_add_named_next_with_slot (vlib_main_t * vm,
 245                                     uword node, char *name, uword slot)
 246 {
 247   vlib_node_main_t *nm;
 248   vlib_node_t *n, *n_next;
 249
 250   nm = &vm->node_main;
 251   n = vlib_get_node (vm, node);
 252
 253   n_next = vlib_get_node_by_name (vm, (u8 *) name);
 254   if (!n_next)
 255     {
 256       if (nm->flags & VLIB_NODE_MAIN_RUNTIME_STARTED)
 257         return ~0;
 258
 259       if (slot == ~0)
 260         slot = clib_max (vec_len (n->next_node_names),
 261                          vec_len (n->next_nodes));
 262       vec_validate (n->next_node_names, slot);
 263       n->next_node_names[slot] = name;
 264       return slot;
 265     }
 266
 267   return vlib_node_add_next_with_slot (vm, node, n_next->index, slot);
 268 }
 269
 270 static void
 271 node_elog_init (vlib_main_t * vm, uword ni)
 272 {
 273   elog_event_type_t t;
 274
 275   clib_memset (&t, 0, sizeof (t));
 276
 277   /* 2 event types for this node: one when node function is called.
 278      One when it returns. */
 279   vec_validate (vm->node_call_elog_event_types, ni);
 280   vm->node_call_elog_event_types[ni] = t;
 281
 282   vec_validate (vm->node_return_elog_event_types, ni);
 283   vm->node_return_elog_event_types[ni] = t;
 284
 285   node_set_elog_name (vm, ni);
 286 }
 287
 288 #ifdef CLIB_UNIX
 289 #define STACK_ALIGN (clib_mem_get_page_size())
 290 #else
 291 #define STACK_ALIGN CLIB_CACHE_LINE_BYTES
 292 #endif
 293
 294 vlib_node_function_t *
 295 vlib_node_get_preferred_node_fn_variant (vlib_main_t *vm,
 296                                          vlib_node_fn_registration_t *regs)
 297 {
 298   vlib_node_main_t *nm = &vm->node_main;
 299   vlib_node_fn_registration_t *r;
 300   vlib_node_fn_variant_t *v;
 301   vlib_node_function_t *fn = 0;
 302   int priority = -1;
 303
 304   if (nm->node_fn_default_march_variant != ~0)
 305     {
 306       r = regs;
 307       while (r)
 308         {
 309           if (r->march_variant == nm->node_fn_default_march_variant)
 310             return r->function;
 311           r = r->next_registration;
 312         }
 313     }
 314
 315   r = regs;
 316   while (r)
 317     {
 318       v = vec_elt_at_index (nm->variants, r->march_variant);
 319       if (v->priority > priority)
 320         {
 321           priority = v->priority;
 322           fn = r->function;
 323         }
 324       r = r->next_registration;
 325     }
 326
 327   ASSERT (fn);
 328   return fn;
 329 }
 330
 331 static void
 332 register_node (vlib_main_t * vm, vlib_node_registration_t * r)
 333 {
 334   vlib_node_main_t *nm = &vm->node_main;
 335   vlib_node_t *n;
 336   u32 size;
 337   int i;
 338
 339   if (CLIB_DEBUG > 0)
 340     {
 341       /* Default (0) type should match INTERNAL. */
 342       vlib_node_t zero = { 0 };
 343       ASSERT (VLIB_NODE_TYPE_INTERNAL == zero.type);
 344     }
 345
 346   if (r->node_fn_registrations)
 347     {
 348       /* to avoid confusion, please remove ".function " statiement from
 349          CLIB_NODE_REGISTRATION() if using function function candidates */
 350       ASSERT (r->function == 0);
 351
 352       r->function =
 353         vlib_node_get_preferred_node_fn_variant (vm, r->node_fn_registrations);
 354     }
 355
 356   ASSERT (r->function != 0);
 357
 358   n = clib_mem_alloc_no_fail (sizeof (n[0]));
 359   clib_memset (n, 0, sizeof (n[0]));
 360   n->index = vec_len (nm->nodes);
 361   n->node_fn_registrations = r->node_fn_registrations;
 362   n->protocol_hint = r->protocol_hint;
 363
 364   vec_add1 (nm->nodes, n);
 365
 366   /* Name is always a vector so it can be formatted with %v. */
 367   if (clib_mem_is_heap_object (vec_header (r->name, 0)))
 368     n->name = vec_dup ((u8 *) r->name);
 369   else
 370     n->name = format (0, "%s", r->name);
 371
 372   if (!nm->node_by_name)
 373     nm->node_by_name = hash_create_vec ( /* size */ 32,
 374                                         sizeof (n->name[0]), sizeof (uword));
 375
 376   /* Node names must be unique. */
 377   {
 378     /* vlib_get_node_by_name() expects NULL-terminated strings */
 379     u8 *name = format (0, "%v%c", n->name, 0);
 380     vlib_node_t *o = vlib_get_node_by_name (vm, name);
 381     vec_free (name);
 382     if (o)
 383       clib_error ("more than one node named `%v'", n->name);
 384   }
 385
 386   hash_set (nm->node_by_name, n->name, n->index);
 387
 388   r->index = n->index;          /* save index in registration */
 389   n->function = r->function;
 390
 391   /* Node index of next sibling will be filled in by vlib_node_main_init. */
 392   n->sibling_of = r->sibling_of;
 393   if (r->sibling_of && r->n_next_nodes > 0)
 394     clib_error ("sibling node should not have any next nodes `%v'", n->name);
 395
 396   if (r->type == VLIB_NODE_TYPE_INTERNAL)
 397     ASSERT (r->vector_size > 0);
 398
 399 #define _(f) n->f = r->f
 400
 401   _(type);
 402   _(flags);
 403   _(state);
 404   _(format_buffer);
 405   _(unformat_buffer);
 406   _(format_trace);
 407   _(validate_frame);
 408
 409   size = round_pow2 (sizeof (vlib_frame_t), VLIB_FRAME_DATA_ALIGN);
 410
 411   /* scalar data size */
 412   if (r->scalar_size)
 413     {
 414       n->scalar_offset = size;
 415       size += round_pow2 (r->scalar_size, VLIB_FRAME_DATA_ALIGN);
 416     }
 417   else
 418     n->scalar_offset = 0;
 419
 420   /* Vecor data size */
 421   n->vector_offset = size;
 422   size += r->vector_size * VLIB_FRAME_SIZE;
 423
 424   /* Allocate a few extra slots of vector data to support
 425      speculative vector enqueues which overflow vector data in next frame. */
 426   size += r->vector_size * VLIB_FRAME_SIZE_EXTRA;
 427
 428   /* space for VLIB_FRAME_MAGIC */
 429   n->magic_offset = size;
 430   size += sizeof (u32);
 431
 432   /* round size to VLIB_FRAME_DATA_ALIGN */
 433   size = round_pow2 (size, VLIB_FRAME_DATA_ALIGN);
 434
 435   if (r->aux_size)
 436     {
 437       n->aux_offset = size;
 438       size += r->aux_size * VLIB_FRAME_SIZE;
 439     }
 440   else
 441     n->aux_offset = 0;
 442
 443   /* final size */
 444   n->frame_size = size = round_pow2 (size, CLIB_CACHE_LINE_BYTES);
 445   ASSERT (size <= __UINT16_MAX__);
 446
 447   vlib_frame_size_t *fs = 0;
 448
 449   n->frame_size_index = (u16) ~0;
 450   vec_foreach (fs, nm->frame_sizes)
 451     if (fs->frame_size == size)
 452       {
 453         n->frame_size_index = fs - nm->frame_sizes;
 454         break;
 455       }
 456
 457   if (n->frame_size_index == (u16) ~0)
 458     {
 459       vec_add2 (nm->frame_sizes, fs, 1);
 460       fs->frame_size = size;
 461       n->frame_size_index = fs - nm->frame_sizes;
 462     }
 463
 464   /* Register error counters. */
 465   vlib_register_errors (vm, n->index, r->n_errors, r->error_strings,
 466                         r->error_counters);
 467   node_elog_init (vm, n->index);
 468
 469   _(runtime_data_bytes);
 470   if (r->runtime_data_bytes > 0)
 471     {
 472       vec_resize (n->runtime_data, r->runtime_data_bytes);
 473       if (r->runtime_data)
 474         clib_memcpy (n->runtime_data, r->runtime_data, r->runtime_data_bytes);
 475     }
 476
 477   vec_resize (n->next_node_names, r->n_next_nodes);
 478   for (i = 0; i < r->n_next_nodes; i++)
 479     n->next_node_names[i] = r->next_nodes[i];
 480
 481   vec_validate_init_empty (n->next_nodes, r->n_next_nodes - 1, ~0);
 482   vec_validate (n->n_vectors_by_next_node, r->n_next_nodes - 1);
 483
 484   n->owner_node_index = n->owner_next_index = ~0;
 485
 486   /* Initialize node runtime. */
 487   {
 488     vlib_node_runtime_t *rt;
 489     u32 i;
 490
 491     if (n->type == VLIB_NODE_TYPE_PROCESS)
 492       {
 493         vlib_process_t *p;
 494         uword log2_n_stack_bytes;
 495
 496         log2_n_stack_bytes = clib_max (r->process_log2_n_stack_bytes,
 497                                        VLIB_PROCESS_LOG2_STACK_SIZE);
 498         log2_n_stack_bytes = clib_max (log2_n_stack_bytes,
 499                                        clib_mem_get_log2_page_size ());
 500
 501         p = clib_mem_alloc_aligned (sizeof (p[0]), CLIB_CACHE_LINE_BYTES);
 502         clib_memset (p, 0, sizeof (p[0]));
 503         p->log2_n_stack_bytes = log2_n_stack_bytes;
 504
 505         p->stack = clib_mem_vm_map_stack (1ULL << log2_n_stack_bytes,
 506                                           CLIB_MEM_PAGE_SZ_DEFAULT,
 507                                           "process stack: %U",
 508                                           format_vlib_node_name, vm,
 509                                           n->index);
 510
 511         if (p->stack == CLIB_MEM_VM_MAP_FAILED)
 512           clib_panic ("failed to allocate process stack (%d bytes)",
 513                       1ULL << log2_n_stack_bytes);
 514
 515         /* Process node's runtime index is really index into process
 516            pointer vector. */
 517         n->runtime_index = vec_len (nm->processes);
 518
 519         vec_add1 (nm->processes, p);
 520
 521         /* Paint first stack word with magic number so we can at least
 522            detect process stack overruns. */
 523         p->stack[0] = VLIB_PROCESS_STACK_MAGIC;
 524
 525         /* Node runtime is stored inside of process. */
 526         rt = &p->node_runtime;
 527       }
 528     else
 529       {
 530         vec_add2_aligned (nm->nodes_by_type[n->type], rt, 1,
 531                           /* align */ CLIB_CACHE_LINE_BYTES);
 532         if (n->type == VLIB_NODE_TYPE_INPUT)
 533           clib_interrupt_resize (&nm->interrupts,
 534                                  vec_len (nm->nodes_by_type[n->type]));
 535         n->runtime_index = rt - nm->nodes_by_type[n->type];
 536       }
 537
 538     if (n->type == VLIB_NODE_TYPE_INPUT)
 539       nm->input_node_counts_by_state[n->state] += 1;
 540
 541     rt->function = n->function;
 542     rt->flags = n->flags;
 543     rt->state = n->state;
 544     rt->node_index = n->index;
 545
 546     rt->n_next_nodes = r->n_next_nodes;
 547     rt->next_frame_index = vec_len (nm->next_frames);
 548
 549     vec_resize (nm->next_frames, rt->n_next_nodes);
 550     for (i = 0; i < rt->n_next_nodes; i++)
 551       vlib_next_frame_init (nm->next_frames + rt->next_frame_index + i);
 552
 553     vec_resize (rt->errors, r->n_errors);
 554     for (i = 0; i < vec_len (rt->errors); i++)
 555       rt->errors[i] = n->error_heap_index + i;
 556
 557     STATIC_ASSERT_SIZEOF (vlib_node_runtime_t, 128);
 558     ASSERT (vec_len (n->runtime_data) <= VLIB_NODE_RUNTIME_DATA_SIZE);
 559
 560     if (vec_len (n->runtime_data) > 0)
 561       clib_memcpy (rt->runtime_data, n->runtime_data,
 562                    vec_len (n->runtime_data));
 563     else
 564       clib_memset (rt->runtime_data, 0, VLIB_NODE_RUNTIME_DATA_SIZE);
 565
 566     vec_free (n->runtime_data);
 567   }
 568 #undef _
 569 }
 570
 571 /* Register new packet processing node. */
 572 u32
 573 vlib_register_node (vlib_main_t * vm, vlib_node_registration_t * r)
 574 {
 575   register_node (vm, r);
 576   return r->index;
 577 }
 578
 579 static uword
 580 null_node_fn (vlib_main_t * vm,
 581               vlib_node_runtime_t * node, vlib_frame_t * frame)
 582 {
 583   u16 n_vectors = frame->n_vectors;
 584
 585   vlib_node_increment_counter (vm, node->node_index, 0, n_vectors);
 586   vlib_buffer_free (vm, vlib_frame_vector_args (frame), n_vectors);
 587   vlib_frame_free (vm, node, frame);
 588
 589   return n_vectors;
 590 }
 591
 592 void
 593 vlib_register_all_node_march_variants (vlib_main_t *vm)
 594 {
 595   vlib_node_main_t *nm = &vm->node_main;
 596   vlib_node_fn_variant_t *v;
 597   int prio = -1;
 598
 599   nm->node_fn_default_march_variant = ~0;
 600   ASSERT (nm->variants == 0);
 601   vec_add2 (nm->variants, v, 1);
 602   v->desc = v->suffix = "default";
 603   v->index = CLIB_MARCH_VARIANT_TYPE;
 604
 605 #define _(s, n)                                                               \
 606   vec_add2 (nm->variants, v, 1);                                              \
 607   v->suffix = #s;                                                             \
 608   v->index = CLIB_MARCH_VARIANT_TYPE_##s;                                     \
 609   v->priority = clib_cpu_march_priority_##s ();                               \
 610   v->desc = n;
 611
 612   foreach_march_variant;
 613 #undef _
 614
 615   nm->node_fn_march_variant_by_suffix = hash_create_string (0, sizeof (u32));
 616
 617   vec_foreach (v, nm->variants)
 618     {
 619       ASSERT (v->index == v - nm->variants);
 620       hash_set (nm->node_fn_march_variant_by_suffix, v->suffix, v->index);
 621       if (v->priority > prio)
 622         prio = v->priority;
 623     }
 624 }
 625
 626 void
 627 vlib_register_all_static_nodes (vlib_main_t * vm)
 628 {
 629   vlib_global_main_t *vgm = vlib_get_global_main ();
 630   vlib_node_registration_t *r;
 631
 632   static char *null_node_error_strings[] = {
 633     "blackholed packets",
 634   };
 635
 636   static vlib_node_registration_t null_node_reg = {
 637     .function = null_node_fn,
 638     .vector_size = sizeof (u32),
 639     .name = "null-node",
 640     .n_errors = 1,
 641     .error_strings = null_node_error_strings,
 642   };
 643
 644   /* make sure that node index 0 is not used by
 645      real node */
 646   register_node (vm, &null_node_reg);
 647
 648   r = vgm->node_registrations;
 649   while (r)
 650     {
 651       register_node (vm, r);
 652       r = r->next_registration;
 653     }
 654 }
 655
 656 void
 657 vlib_node_get_nodes (vlib_main_t * vm, u32 max_threads, int include_stats,
 658                      int barrier_sync, vlib_node_t **** node_dupsp,
 659                      vlib_main_t *** stat_vmsp)
 660 {
 661   vlib_node_main_t *nm = &vm->node_main;
 662   vlib_node_t *n;
 663   vlib_node_t ***node_dups = *node_dupsp;
 664   vlib_node_t **nodes;
 665   vlib_main_t **stat_vms = *stat_vmsp;
 666   vlib_main_t *stat_vm;
 667   uword i, j;
 668   u32 threads_to_serialize;
 669
 670   if (vec_len (stat_vms) == 0)
 671     {
 672       for (i = 0; i < vlib_get_n_threads (); i++)
 673         {
 674           stat_vm = vlib_get_main_by_index (i);
 675           if (stat_vm)
 676             vec_add1 (stat_vms, stat_vm);
 677         }
 678     }
 679
 680   threads_to_serialize = clib_min (max_threads, vec_len (stat_vms));
 681
 682   vec_validate (node_dups, threads_to_serialize - 1);
 683
 684   /*
 685    * Barrier sync across stats scraping.
 686    * Otherwise, the counts will be grossly inaccurate.
 687    */
 688   if (barrier_sync)
 689     vlib_worker_thread_barrier_sync (vm);
 690
 691   for (j = 0; j < threads_to_serialize; j++)
 692     {
 693       stat_vm = stat_vms[j];
 694       nm = &stat_vm->node_main;
 695
 696       if (include_stats)
 697         {
 698           for (i = 0; i < vec_len (nm->nodes); i++)
 699             {
 700               n = nm->nodes[i];
 701               vlib_node_sync_stats (stat_vm, n);
 702             }
 703         }
 704
 705       nodes = node_dups[j];
 706       vec_validate (nodes, vec_len (nm->nodes) - 1);
 707       clib_memcpy (nodes, nm->nodes, vec_len (nm->nodes) * sizeof (nodes[0]));
 708       node_dups[j] = nodes;
 709     }
 710
 711   if (barrier_sync)
 712     vlib_worker_thread_barrier_release (vm);
 713
 714   *node_dupsp = node_dups;
 715   *stat_vmsp = stat_vms;
 716 }
 717
 718 clib_error_t *
 719 vlib_node_main_init (vlib_main_t * vm)
 720 {
 721   vlib_node_main_t *nm = &vm->node_main;
 722   clib_error_t *error = 0;
 723   vlib_node_t *n;
 724   uword ni;
 725
 726   nm->flags |= VLIB_NODE_MAIN_RUNTIME_STARTED;
 727
 728   /* Generate sibling relationships */
 729   {
 730     vlib_node_t *n, *sib;
 731     uword si;
 732
 733     for (ni = 0; ni < vec_len (nm->nodes); ni++)
 734       {
 735         n = vec_elt (nm->nodes, ni);
 736
 737         if (!n->sibling_of)
 738           continue;
 739
 740         sib = vlib_get_node_by_name (vm, (u8 *) n->sibling_of);
 741         if (!sib)
 742           {
 743             error = clib_error_create ("sibling `%s' not found for node `%v'",
 744                                        n->sibling_of, n->name);
 745             goto done;
 746           }
 747
 748         /* *INDENT-OFF* */
 749         clib_bitmap_foreach (si, sib->sibling_bitmap)  {
 750               vlib_node_t * m = vec_elt (nm->nodes, si);
 751
 752               /* Connect all of sibling's siblings to us. */
 753               m->sibling_bitmap = clib_bitmap_ori (m->sibling_bitmap, n->index);
 754
 755               /* Connect us to all of sibling's siblings. */
 756               n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, si);
 757             }
 758         /* *INDENT-ON* */
 759
 760         /* Connect sibling to us. */
 761         sib->sibling_bitmap = clib_bitmap_ori (sib->sibling_bitmap, n->index);
 762
 763         /* Connect us to sibling. */
 764         n->sibling_bitmap = clib_bitmap_ori (n->sibling_bitmap, sib->index);
 765       }
 766   }
 767
 768   /* Resolve next names into next indices. */
 769   for (ni = 0; ni < vec_len (nm->nodes); ni++)
 770     {
 771       uword i;
 772
 773       n = vec_elt (nm->nodes, ni);
 774
 775       for (i = 0; i < vec_len (n->next_node_names); i++)
 776         {
 777           char *a = n->next_node_names[i];
 778
 779           if (!a)
 780             continue;
 781
 782           if (~0 == vlib_node_add_named_next_with_slot (vm, n->index, a, i))
 783             {
 784               error = clib_error_create
 785                 ("node `%v' refers to unknown node `%s'", n->name, a);
 786               goto done;
 787             }
 788         }
 789
 790       vec_free (n->next_node_names);
 791     }
 792
 793   /* Set previous node pointers. */
 794   for (ni = 0; ni < vec_len (nm->nodes); ni++)
 795     {
 796       vlib_node_t *n_next;
 797       uword i;
 798
 799       n = vec_elt (nm->nodes, ni);
 800
 801       for (i = 0; i < vec_len (n->next_nodes); i++)
 802         {
 803           if (n->next_nodes[i] >= vec_len (nm->nodes))
 804             continue;
 805
 806           n_next = vec_elt (nm->nodes, n->next_nodes[i]);
 807           n_next->prev_node_bitmap =
 808             clib_bitmap_ori (n_next->prev_node_bitmap, n->index);
 809         }
 810     }
 811
 812   {
 813     vlib_next_frame_t *nf;
 814     vlib_node_runtime_t *r;
 815     vlib_node_t *next;
 816     uword i;
 817
 818     vec_foreach (r, nm->nodes_by_type[VLIB_NODE_TYPE_INTERNAL])
 819     {
 820       if (r->n_next_nodes == 0)
 821         continue;
 822
 823       n = vlib_get_node (vm, r->node_index);
 824       nf = vec_elt_at_index (nm->next_frames, r->next_frame_index);
 825
 826       for (i = 0; i < vec_len (n->next_nodes); i++)
 827         {
 828           next = vlib_get_node (vm, n->next_nodes[i]);
 829
 830           /* Validate node runtime indices are correctly initialized. */
 831           ASSERT (nf[i].node_runtime_index == next->runtime_index);
 832
 833           nf[i].flags = 0;
 834           if (next->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH)
 835             nf[i].flags |= VLIB_FRAME_NO_FREE_AFTER_DISPATCH;
 836         }
 837     }
 838   }
 839
 840 done:
 841   return error;
 842 }
 843
 844 u32
 845 vlib_process_create (vlib_main_t * vm, char *name,
 846                      vlib_node_function_t * f, u32 log2_n_stack_bytes)
 847 {
 848   vlib_node_registration_t r;
 849   vlib_node_t *n;
 850
 851   memset (&r, 0, sizeof (r));
 852
 853   r.name = (char *) format (0, "%s", name, 0);
 854   r.function = f;
 855   r.process_log2_n_stack_bytes = log2_n_stack_bytes;
 856   r.type = VLIB_NODE_TYPE_PROCESS;
 857
 858   vlib_worker_thread_barrier_sync (vm);
 859
 860   vlib_register_node (vm, &r);
 861   vec_free (r.name);
 862
 863   vlib_worker_thread_node_runtime_update ();
 864   vlib_worker_thread_barrier_release (vm);
 865
 866   n = vlib_get_node (vm, r.index);
 867   vlib_start_process (vm, n->runtime_index);
 868
 869   return (r.index);
 870 }
 871
 872 int
 873 vlib_node_set_march_variant (vlib_main_t *vm, u32 node_index,
 874                              clib_march_variant_type_t march_variant)
 875 {
 876   vlib_node_fn_registration_t *fnr;
 877   vlib_node_fn_variant_t *v;
 878   vlib_node_t *n = vlib_get_node (vm, node_index);
 879
 880   if (n->node_fn_registrations == 0)
 881     return -1;
 882
 883   fnr = n->node_fn_registrations;
 884   v = vec_elt_at_index (vm->node_main.variants, march_variant);
 885
 886   while (fnr)
 887     {
 888       if (fnr->march_variant == v->index)
 889         {
 890           n->function = fnr->function;
 891
 892           for (int i = 0; i < vlib_get_n_threads (); i++)
 893             {
 894               vlib_node_runtime_t *nrt;
 895               nrt =
 896                 vlib_node_get_runtime (vlib_get_main_by_index (i), n->index);
 897               nrt->function = fnr->function;
 898             }
 899           return 0;
 900         }
 901       fnr = fnr->next_registration;
 902     }
 903   return -1;
 904 }
 905 /*
 906  * fd.io coding-style-patch-verification: ON
 907  *
 908  * Local Variables:
 909  * eval: (c-set-style "gnu")
 910  * End:
 911  */