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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #include <vlib/vlib.h>
17 #include <vppinfra/serialize.h>
19 /* serialized representation of state strings */
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")
34 foreach_state_string_code
36 } state_string_enum_t;
38 static char *state_strings[] = {
40 foreach_state_string_code
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.
51 vlib_node_serialize (vlib_main_t * vm, vlib_node_t *** node_dups, u8 * vector,
52 int include_nexts, int include_stats)
54 serialize_main_t _sm, *sm = &_sm;
61 state_string_enum_t state_code;
63 serialize_open_vector (sm, vector);
64 serialize_likely_small_unsigned_integer (sm, vec_len (node_dups));
66 for (j = 0; j < vec_len (node_dups); j++)
70 serialize_likely_small_unsigned_integer (sm, vec_len (nodes));
72 for (i = 0; i < vec_len (nodes); i++)
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;
81 state_code = STATE_INTERNAL;
83 if (n->type == VLIB_NODE_TYPE_PROCESS)
85 vlib_process_t *p = vlib_get_process_from_node (vm, n);
88 & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
89 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT))
92 if (!(p->flags & VLIB_PROCESS_IS_RUNNING))
93 state_code = STATE_DONE;
96 case VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK:
97 state_code = STATE_TIME_WAIT;
100 case VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT:
101 state_code = STATE_EVENT_WAIT;
104 case (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK):
110 else if (n->type != VLIB_NODE_TYPE_INTERNAL)
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;
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);
125 serialize_likely_small_unsigned_integer (sm, (u64) state_code);
126 serialize_likely_small_unsigned_integer (sm, n->type);
127 serialize_likely_small_unsigned_integer (sm, n->flags);
131 serialize_likely_small_unsigned_integer
132 (sm, vec_len (n->next_nodes));
133 for (k = 0; k < vec_len (n->next_nodes); k++)
134 serialize_likely_small_unsigned_integer (sm,
138 serialize_likely_small_unsigned_integer (sm, 0);
143 serialize_likely_small_unsigned_integer (sm, 1);
145 serialize_integer (sm, l, 8);
147 serialize_integer (sm, c, 8);
149 serialize_integer (sm, v, 8);
151 serialize_integer (sm, d, 8);
154 serialize_likely_small_unsigned_integer (sm, 0);
157 return (serialize_close_vector (sm));
161 vlib_node_unserialize (u8 * vector)
163 serialize_main_t _sm, *sm = &_sm;
168 vlib_node_t ***nodes_by_thread = 0;
171 state_string_enum_t state_code;
174 serialize_open_vector (sm, vector);
176 nstat_vms = unserialize_likely_small_unsigned_integer (sm);
178 vec_validate (nodes_by_thread, nstat_vms - 1);
179 _vec_len (nodes_by_thread) = 0;
181 for (i = 0; i < nstat_vms; i++)
183 nnodes = unserialize_likely_small_unsigned_integer (sm);
186 vec_validate (nodes, nnodes - 1);
187 vec_add1 (nodes_by_thread, nodes);
189 for (j = 0; j < nnodes; j++)
192 vec_validate (node, 0);
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];
199 node->type = unserialize_likely_small_unsigned_integer (sm);
200 node->flags = unserialize_likely_small_unsigned_integer (sm);
201 nnexts = unserialize_likely_small_unsigned_integer (sm);
203 vec_validate (node->next_nodes, nnexts - 1);
204 for (k = 0; k < nnexts; k++)
205 node->next_nodes[k] =
206 unserialize_likely_small_unsigned_integer (sm);
208 stats_present = unserialize_likely_small_unsigned_integer (sm);
213 unserialize_integer (sm, &l, 8);
214 node->stats_total.clocks = l;
215 node->stats_last_clear.clocks = 0;
218 unserialize_integer (sm, &c, 8);
219 node->stats_total.calls = c;
222 unserialize_integer (sm, &v, 8);
223 node->stats_total.vectors = v;
226 unserialize_integer (sm, &d, 8);
227 node->stats_total.suspends = d;
231 return nodes_by_thread;
236 static clib_error_t *
237 test_node_serialize_command_fn (vlib_main_t * vm,
238 unformat_input_t * input,
239 vlib_cli_command_t * cmd)
241 vlib_node_main_t *nm = &vm->node_main;
243 vlib_node_t ***nodes_by_thread;
246 vlib_node_t *next_node;
248 u32 max_threads = (u32) ~ 0;
249 int include_nexts = 0;
250 int include_stats = 0;
252 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
254 if (unformat (input, "max-threads %d", &max_threads))
256 else if (unformat (input, "stats"))
258 else if (unformat (input, "nexts"))
265 * Keep the number of memcpy ops to a minimum (e.g. 1).
266 * The current size of the serialized vector is
269 vec_validate (vector, 16383);
270 vec_reset_length (vector);
272 vector = vlib_node_serialize (nm, vector, max_threads,
273 include_nexts, include_stats);
275 vlib_cli_output (vm, "result vector %d bytes", vec_len (vector));
277 nodes_by_thread = vlib_node_unserialize (vector);
281 for (i = 0; i < vec_len (nodes_by_thread); i++)
283 nodes = nodes_by_thread[i];
285 vlib_cli_output (vm, "thread %d", i);
287 for (j = 0; j < vec_len (nodes); j++)
291 vlib_cli_output (vm, "[%d] %s state %s", j, node->name,
295 (vm, " clocks %lld calls %lld suspends"
296 " %lld vectors %lld",
297 node->stats_total.clocks,
298 node->stats_total.calls,
299 node->stats_total.suspends, node->stats_total.vectors);
301 for (k = 0; k < vec_len (node->next_nodes); k++)
303 if (node->next_nodes[k] != ~0)
305 next_node = nodes[node->next_nodes[k]];
306 vlib_cli_output (vm, " [%d] %s", k, next_node->name);
312 for (j = 0; j < vec_len (nodes_by_thread); j++)
314 nodes = nodes_by_thread[j];
316 for (i = 0; i < vec_len (nodes); i++)
318 vec_free (nodes[i]->name);
319 vec_free (nodes[i]->next_nodes);
324 vec_free (nodes_by_thread);
330 VLIB_CLI_COMMAND (test_node_serialize_node, static) = {
331 .path = "test node serialize",
332 .short_help = "test node serialize [max-threads NN] nexts stats",
333 .function = test_node_serialize_command_fn,
339 * fd.io coding-style-patch-verification: ON
342 * eval: (c-set-style "gnu")