src/vlibapi/node_serialize.c

   1 /*
   2  * Copyright (c) 2016 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 #include <vlib/vlib.h>
  16
  17 #include <vppinfra/serialize.h>
  18
  19 /* serialized representation of state strings */
  20
  21 #define foreach_state_string_code               \
  22 _(STATE_DONE, "done")                           \
  23 _(STATE_DISABLED, "disabled")                   \
  24 _(STATE_TIME_WAIT, "time wait")                 \
  25 _(STATE_EVENT_WAIT, "event wait")               \
  26 _(STATE_ANY_WAIT, "any wait")                   \
  27 _(STATE_POLLING, "polling")                     \
  28 _(STATE_INTERRUPT_WAIT, "interrupt wait")       \
  29 _(STATE_INTERNAL, "internal")
  30
  31 typedef enum
  32 {
  33 #define _(a,b) a,
  34   foreach_state_string_code
  35 #undef _
  36 } state_string_enum_t;
  37
  38 static char *state_strings[] = {
  39 #define _(a,b) b,
  40   foreach_state_string_code
  41 #undef _
  42 };
  43
  44 /*
  45  * Serialize a vlib_node_main_t. Appends the result to vector.
  46  * Pass 0 to create a new vector, use vec_reset_length(vector)
  47  * to recycle a vector / avoid memory allocation, etc.
  48  * Switch heaps before/after to serialize into API client shared memory.
  49  */
  50 u8 *
  51 vlib_node_serialize (vlib_main_t * vm, vlib_node_t *** node_dups, u8 * vector,
  52                      int include_nexts, int include_stats)
  53 {
  54   serialize_main_t _sm, *sm = &_sm;
  55   vlib_node_t *n;
  56   vlib_node_t **nodes;
  57   u8 *namep;
  58   u32 name_bytes;
  59   uword i, j, k;
  60   u64 l, v, c, d;
  61   state_string_enum_t state_code;
  62
  63   serialize_open_vector (sm, vector);
  64   serialize_likely_small_unsigned_integer (sm, vec_len (node_dups));
  65
  66   for (j = 0; j < vec_len (node_dups); j++)
  67     {
  68       nodes = node_dups[j];
  69
  70       serialize_likely_small_unsigned_integer (sm, vec_len (nodes));
  71
  72       for (i = 0; i < vec_len (nodes); i++)
  73         {
  74           n = nodes[i];
  75
  76           l = n->stats_total.clocks - n->stats_last_clear.clocks;
  77           v = n->stats_total.vectors - n->stats_last_clear.vectors;
  78           c = n->stats_total.calls - n->stats_last_clear.calls;
  79           d = n->stats_total.suspends - n->stats_last_clear.suspends;
  80
  81           state_code = STATE_INTERNAL;
  82
  83           if (n->type == VLIB_NODE_TYPE_PROCESS)
  84             {
  85               vlib_process_t *p = vlib_get_process_from_node (vm, n);
  86
  87               switch (p->flags
  88                       & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
  89                          | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT))
  90                 {
  91                 default:
  92                   if (!(p->flags & VLIB_PROCESS_IS_RUNNING))
  93                     state_code = STATE_DONE;
  94                   break;
  95
  96                 case VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK:
  97                   state_code = STATE_TIME_WAIT;
  98                   break;
  99
 100                 case VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT:
 101                   state_code = STATE_EVENT_WAIT;
 102                   break;
 103
 104                 case (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK):
 105                   state_code =
 106                     STATE_ANY_WAIT;
 107                   break;
 108                 }
 109             }
 110           else if (n->type != VLIB_NODE_TYPE_INTERNAL)
 111             {
 112               state_code = STATE_POLLING;
 113               if (n->state == VLIB_NODE_STATE_DISABLED)
 114                 state_code = STATE_DISABLED;
 115               else if (n->state == VLIB_NODE_STATE_INTERRUPT)
 116                 state_code = STATE_INTERRUPT_WAIT;
 117             }
 118
 119           /* See unserialize_cstring */
 120           name_bytes = vec_len (n->name);
 121           serialize_likely_small_unsigned_integer (sm, name_bytes);
 122           namep = serialize_get (sm, name_bytes);
 123           memcpy (namep, n->name, name_bytes);
 124
 125           serialize_likely_small_unsigned_integer (sm, (u64) state_code);
 126           serialize_likely_small_unsigned_integer (sm, n->type);
 127
 128           if (include_nexts)
 129             {
 130               serialize_likely_small_unsigned_integer
 131                 (sm, vec_len (n->next_nodes));
 132               for (k = 0; k < vec_len (n->next_nodes); k++)
 133                 serialize_likely_small_unsigned_integer (sm,
 134                                                          n->next_nodes[k]);
 135             }
 136           else
 137             serialize_likely_small_unsigned_integer (sm, 0);
 138
 139           if (include_stats)
 140             {
 141               /* stats present */
 142               serialize_likely_small_unsigned_integer (sm, 1);
 143               /* total clocks */
 144               serialize_integer (sm, l, 8);
 145               /* Total calls */
 146               serialize_integer (sm, c, 8);
 147               /* Total vectors */
 148               serialize_integer (sm, v, 8);
 149               /* Total suspends */
 150               serialize_integer (sm, d, 8);
 151             }
 152           else                  /* no stats */
 153             serialize_likely_small_unsigned_integer (sm, 0);
 154         }
 155       vec_free (nodes);
 156     }
 157   return (serialize_close_vector (sm));
 158 }
 159
 160 vlib_node_t ***
 161 vlib_node_unserialize (u8 * vector)
 162 {
 163   serialize_main_t _sm, *sm = &_sm;
 164   u32 nnodes, nnexts;
 165   u32 nstat_vms;
 166   vlib_node_t *node;
 167   vlib_node_t **nodes;
 168   vlib_node_t ***nodes_by_thread = 0;
 169   int i, j, k;
 170   u64 l, v, c, d;
 171   state_string_enum_t state_code;
 172   int stats_present;
 173
 174   serialize_open_vector (sm, vector);
 175
 176   nstat_vms = unserialize_likely_small_unsigned_integer (sm);
 177
 178   vec_validate (nodes_by_thread, nstat_vms - 1);
 179   _vec_len (nodes_by_thread) = 0;
 180
 181   for (i = 0; i < nstat_vms; i++)
 182     {
 183       nnodes = unserialize_likely_small_unsigned_integer (sm);
 184
 185       nodes = 0;
 186       vec_validate (nodes, nnodes - 1);
 187       vec_add1 (nodes_by_thread, nodes);
 188
 189       for (j = 0; j < nnodes; j++)
 190         {
 191           node = 0;
 192           vec_validate (node, 0);
 193           nodes[j] = node;
 194
 195           unserialize_cstring (sm, (char **) &(node->name));
 196           state_code = unserialize_likely_small_unsigned_integer (sm);
 197           node->state_string = (u8 *) state_strings[state_code];
 198
 199           node->type = unserialize_likely_small_unsigned_integer (sm);
 200           nnexts = unserialize_likely_small_unsigned_integer (sm);
 201           if (nnexts > 0)
 202             vec_validate (node->next_nodes, nnexts - 1);
 203           for (k = 0; k < nnexts; k++)
 204             node->next_nodes[k] =
 205               unserialize_likely_small_unsigned_integer (sm);
 206
 207           stats_present = unserialize_likely_small_unsigned_integer (sm);
 208
 209           if (stats_present)
 210             {
 211               /* total clocks */
 212               unserialize_integer (sm, &l, 8);
 213               node->stats_total.clocks = l;
 214               node->stats_last_clear.clocks = 0;
 215
 216               /* Total calls */
 217               unserialize_integer (sm, &c, 8);
 218               node->stats_total.calls = c;
 219
 220               /* Total vectors */
 221               unserialize_integer (sm, &v, 8);
 222               node->stats_total.vectors = v;
 223
 224               /* Total suspends */
 225               unserialize_integer (sm, &d, 8);
 226               node->stats_total.suspends = d;
 227             }
 228         }
 229     }
 230   return nodes_by_thread;
 231 }
 232
 233 #if TEST_CODE
 234
 235 static clib_error_t *
 236 test_node_serialize_command_fn (vlib_main_t * vm,
 237                                 unformat_input_t * input,
 238                                 vlib_cli_command_t * cmd)
 239 {
 240   vlib_node_main_t *nm = &vm->node_main;
 241   u8 *vector = 0;
 242   vlib_node_t ***nodes_by_thread;
 243   vlib_node_t **nodes;
 244   vlib_node_t *node;
 245   vlib_node_t *next_node;
 246   int i, j, k;
 247   u32 max_threads = (u32) ~ 0;
 248   int include_nexts = 0;
 249   int include_stats = 0;
 250
 251   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 252     {
 253       if (unformat (input, "max-threads %d", &max_threads))
 254         ;
 255       else if (unformat (input, "stats"))
 256         include_stats = 1;
 257       else if (unformat (input, "nexts"))
 258         include_nexts = 1;
 259       else
 260         break;
 261     }
 262
 263   /*
 264    * Keep the number of memcpy ops to a minimum (e.g. 1).
 265    * The current size of the serialized vector is
 266    * slightly under 4K.
 267    */
 268   vec_validate (vector, 16383);
 269   vec_reset_length (vector);
 270
 271   vector = vlib_node_serialize (nm, vector, max_threads,
 272                                 include_nexts, include_stats);
 273
 274   vlib_cli_output (vm, "result vector %d bytes", vec_len (vector));
 275
 276   nodes_by_thread = vlib_node_unserialize (vector);
 277
 278   vec_free (vector);
 279
 280   for (i = 0; i < vec_len (nodes_by_thread); i++)
 281     {
 282       nodes = nodes_by_thread[i];
 283
 284       vlib_cli_output (vm, "thread %d", i);
 285
 286       for (j = 0; j < vec_len (nodes); j++)
 287         {
 288           node = nodes[j];
 289
 290           vlib_cli_output (vm, "[%d] %s state %s", j, node->name,
 291                            node->state_string);
 292
 293           vlib_cli_output
 294             (vm, "    clocks %lld calls %lld suspends"
 295              " %lld vectors %lld",
 296              node->stats_total.clocks,
 297              node->stats_total.calls,
 298              node->stats_total.suspends, node->stats_total.vectors);
 299
 300           for (k = 0; k < vec_len (node->next_nodes); k++)
 301             {
 302               if (node->next_nodes[k] != ~0)
 303                 {
 304                   next_node = nodes[node->next_nodes[k]];
 305                   vlib_cli_output (vm, "  [%d] %s", k, next_node->name);
 306                 }
 307             }
 308         }
 309     }
 310
 311   for (j = 0; j < vec_len (nodes_by_thread); j++)
 312     {
 313       nodes = nodes_by_thread[j];
 314
 315       for (i = 0; i < vec_len (nodes); i++)
 316         {
 317           vec_free (nodes[i]->name);
 318           vec_free (nodes[i]->next_nodes);
 319           vec_free (nodes[i]);
 320         }
 321       vec_free (nodes);
 322     }
 323   vec_free (nodes_by_thread);
 324
 325   return 0;
 326 }
 327
 328 /* *INDENT-OFF* */
 329 VLIB_CLI_COMMAND (test_node_serialize_node, static) = {
 330     .path = "test node serialize",
 331     .short_help = "test node serialize [max-threads NN] nexts stats",
 332     .function = test_node_serialize_command_fn,
 333 };
 334 /* *INDENT-ON* */
 335 #endif
 336
 337 /*
 338  * fd.io coding-style-patch-verification: ON
 339  *
 340  * Local Variables:
 341  * eval: (c-set-style "gnu")
 342  * End:
 343  */