LCOV - code coverage report
Current view: top level - vlib - node.c (source / functions) Hit Total Coverage
Test: coverage-filtered.info Lines: 359 390 92.1 %
Date: 2023-07-05 22:20:52 Functions: 16 17 94.1 %

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

Generated by: LCOV version 1.14