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