summaryrefslogtreecommitdiffstats
path: root/src/vlibapi/node_serialize.c
blob: b50d79e292294a7f39ac062334d9b8a97365a28f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
/*
 * Copyright (c) 2016 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#include <vlib/vlib.h>

#include <vppinfra/serialize.h>

/* serialized representation of state strings */

#define foreach_state_string_code               \
_(STATE_DONE, "done")                           \
_(STATE_DISABLED, "disabled")                   \
_(STATE_TIME_WAIT, "time wait")                 \
_(STATE_EVENT_WAIT, "event wait")               \
_(STATE_ANY_WAIT, "any wait")                   \
_(STATE_POLLING, "polling")                     \
_(STATE_INTERRUPT_WAIT, "interrupt wait")       \
_(STATE_INTERNAL, "internal")

typedef enum
{
#define _(a,b) a,
  foreach_state_string_code
#undef _
} state_string_enum_t;

static char *state_strings[] = {
#define _(a,b) b,
  foreach_state_string_code
#undef _
};

/*
 * Serialize a vlib_node_main_t. Appends the result to vector.
 * Pass 0 to create a new vector, use vec_reset_length(vector)
 * to recycle a vector / avoid memory allocation, etc.
 * Switch heaps before/after to serialize into API client shared memory.
 */
u8 *
vlib_node_serialize (vlib_main_t * vm, vlib_node_t *** node_dups, u8 * vector,
		     int include_nexts, int include_stats)
{
  serialize_main_t _sm, *sm = &_sm;
  vlib_node_t *n;
  vlib_node_t **nodes;
  u8 *namep;
  u32 name_bytes;
  uword i, j, k;
  u64 l, v, c, d;
  state_string_enum_t state_code;

  serialize_open_vector (sm, vector);
  serialize_likely_small_unsigned_integer (sm, vec_len (node_dups));

  for (j = 0; j < vec_len (node_dups); j++)
    {
      nodes = node_dups[j];

      serialize_likely_small_unsigned_integer (sm, vec_len (nodes));

      for (i = 0; i < vec_len (nodes); i++)
	{
	  n = nodes[i];

	  l = n->stats_total.clocks - n->stats_last_clear.clocks;
	  v = n->stats_total.vectors - n->stats_last_clear.vectors;
	  c = n->stats_total.calls - n->stats_last_clear.calls;
	  d = n->stats_total.suspends - n->stats_last_clear.suspends;

	  state_code = STATE_INTERNAL;

	  if (n->type == VLIB_NODE_TYPE_PROCESS)
	    {
	      vlib_process_t *p = vlib_get_process_from_node (vm, n);

	      switch (p->flags
		      & (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK
			 | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT))
		{
		default:
		  if (!(p->flags & VLIB_PROCESS_IS_RUNNING))
		    state_code = STATE_DONE;
		  break;

		case VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK:
		  state_code = STATE_TIME_WAIT;
		  break;

		case VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT:
		  state_code = STATE_EVENT_WAIT;
		  break;

		case (VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_EVENT | VLIB_PROCESS_IS_SUSPENDED_WAITING_FOR_CLOCK):
		  state_code =
		    STATE_ANY_WAIT;
		  break;
		}
	    }
	  else if (n->type != VLIB_NODE_TYPE_INTERNAL)
	    {
	      state_code = STATE_POLLING;
	      if (n->state == VLIB_NODE_STATE_DISABLED)
		state_code = STATE_DISABLED;
	      else if (n->state == VLIB_NODE_STATE_INTERRUPT)
		state_code = STATE_INTERRUPT_WAIT;
	    }

	  /* See unserialize_cstring */
	  name_bytes = vec_len (n->name);
	  serialize_likely_small_unsigned_integer (sm, name_bytes);
	  namep = serialize_get (sm, name_bytes);
	  memcpy (namep, n->name, name_bytes);

	  serialize_likely_small_unsigned_integer (sm, (u64) state_code);
	  serialize_likely_small_unsigned_integer (sm, n->type);
	  serialize_likely_small_unsigned_integer (sm, n->flags);

	  if (include_nexts)
	    {
	      serialize_likely_small_unsigned_integer
		(sm, vec_len (n->next_nodes));
	      for (k = 0; k < vec_len (n->next_nodes); k++)
		serialize_likely_small_unsigned_integer (sm,
							 n->next_nodes[k]);
	    }
	  else
	    serialize_likely_small_unsigned_integer (sm, 0);

	  if (include_stats)
	    {
	      /* stats present */
	      serialize_likely_small_unsigned_integer (sm, 1);
	      /* total clocks */
	      serialize_integer (sm, l, 8);
	      /* Total calls */
	      serialize_integer (sm, c, 8);
	      /* Total vectors */
	      serialize_integer (sm, v, 8);
	      /* Total suspends */
	      serialize_integer (sm, d, 8);
	    }
	  else			/* no stats */
	    serialize_likely_small_unsigned_integer (sm, 0);
	}
    }
  return (serialize_close_vector (sm));
}

vlib_node_t ***
vlib_node_unserialize (u8 * vector)
{
  serialize_main_t _sm, *sm = &_sm;
  u32 nnodes, nnexts;
  u32 nstat_vms;
  vlib_node_t *node;
  vlib_node_t **nodes;
  vlib_node_t ***nodes_by_thread = 0;
  int i, j, k;
  u64 l, v, c, d;
  state_string_enum_t state_code;
  int stats_present;

  serialize_open_vector (sm, vector);

  nstat_vms = unserialize_likely_small_unsigned_integer (sm);

  vec_validate (nodes_by_thread, nstat_vms - 1);
  _vec_len (nodes_by_thread) = 0;

  for (i = 0; i < nstat_vms; i++)
    {
      nnodes = unserialize_likely_small_unsigned_integer (sm);

      nodes = 0;
      vec_validate (nodes, nnodes - 1);
      vec_add1 (nodes_by_thread, nodes);

      for (j = 0; j < nnodes; j++)
	{
	  node = 0;
	  vec_validate (node, 0);
	  nodes[j] = node;

	  unserialize_cstring (sm, (char **) &(node->name));
	  state_code = unserialize_likely_small_unsigned_integer (sm);
	  node->state_string = (u8 *) state_strings[state_code];

	  node->type = unserialize_likely_small_unsigned_integer (sm);
	  node->flags = unserialize_likely_small_unsigned_integer (sm);
	  nnexts = unserialize_likely_small_unsigned_integer (sm);
	  if (nnexts > 0)
	    vec_validate (node->next_nodes, nnexts - 1);
	  for (k = 0; k < nnexts; k++)
	    node->next_nodes[k] =
	      unserialize_likely_small_unsigned_integer (sm);

	  stats_present = unserialize_likely_small_unsigned_integer (sm);

	  if (stats_present)
	    {
	      /* total clocks */
	      unserialize_integer (sm, &l, 8);
	      node->stats_total.clocks = l;
	      node->stats_last_clear.clocks = 0;

	      /* Total calls */
	      unserialize_integer (sm, &c, 8);
	      node->stats_total.calls = c;

	      /* Total vectors */
	      unserialize_integer (sm, &v, 8);
	      node->stats_total.vectors = v;

	      /* Total suspends */
	      unserialize_integer (sm, &d, 8);
	      node->stats_total.suspends = d;
	    }
	}
    }
  return nodes_by_thread;
}

#if TEST_CODE

static clib_error_t *
test_node_serialize_command_fn (vlib_main_t * vm,
				unformat_input_t * input,
				vlib_cli_command_t * cmd)
{
  vlib_node_main_t *nm = &vm->node_main;
  u8 *vector = 0;
  vlib_node_t ***nodes_by_thread;
  vlib_node_t **nodes;
  vlib_node_t *node;
  vlib_node_t *next_node;
  int i, j, k;
  u32 max_threads = (u32) ~ 0;
  int include_nexts = 0;
  int include_stats = 0;

  while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
    {
      if (unformat (input, "max-threads %d", &max_threads))
	;
      else if (unformat (input, "stats"))
	include_stats = 1;
      else if (unformat (input, "nexts"))
	include_nexts = 1;
      else
	break;
    }

  /*
   * Keep the number of memcpy ops to a minimum (e.g. 1).
   * The current size of the serialized vector is
   * slightly under 4K.
   */
  vec_validate (vector, 16383);
  vec_reset_length (vector);

  vector = vlib_node_serialize (nm, vector, max_threads,
				include_nexts, include_stats);

  vlib_cli_output (vm, "result vector %d bytes", vec_len (vector));

  nodes_by_thread = vlib_node_unserialize (vector);

  vec_free (vector);

  for (i = 0; i < vec_len (nodes_by_thread); i++)
    {
      nodes = nodes_by_thread[i];

      vlib_cli_output (vm, "thread %d", i);

      for (j = 0; j < vec_len (nodes); j++)
	{
	  node = nodes[j];

	  vlib_cli_output (vm, "[%d] %s state %s", j, node->name,
			   node->state_string);

	  vlib_cli_output
	    (vm, "    clocks %lld calls %lld suspends"
	     " %lld vectors %lld",
	     node->stats_total.clocks,
	     node->stats_total.calls,
	     node->stats_total.suspends, node->stats_total.vectors);

	  for (k = 0; k < vec_len (node->next_nodes); k++)
	    {
	      if (node->next_nodes[k] != ~0)
		{
		  next_node = nodes[node->next_nodes[k]];
		  vlib_cli_output (vm, "  [%d] %s", k, next_node->name);
		}
	    }
	}
    }

  for (j = 0; j < vec_len (nodes_by_thread); j++)
    {
      nodes = nodes_by_thread[j];

      for (i = 0; i < vec_len (nodes); i++)
	{
	  vec_free (nodes[i]->name);
	  vec_free (nodes[i]->next_nodes);
	  vec_free (nodes[i]);
	}
      vec_free (nodes);
    }
  vec_free (nodes_by_thread);

  return 0;
}

/* *INDENT-OFF* */
VLIB_CLI_COMMAND (test_node_serialize_node, static) = {
    .path = "test node serialize",
    .short_help = "test node serialize [max-threads NN] nexts stats",
    .function = test_node_serialize_command_fn,
};
/* *INDENT-ON* */
#endif

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */
IPFIX logging @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param domain_id - observation domain ID @param src_port - source port number @param enable - 1 if enable, 0 if disable */ autoreply define nat_ipfix_enable_disable { u32 client_index; u32 context; u32 domain_id; u16 src_port; u8 enable; }; /** \brief Set NAT virtual fragmentation reassembly @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param timeout - reassembly timeout @param max_reass - maximum number of concurrent reassemblies @param max_frag - maximum number of fragmets per reassembly @param drop_frag - if 0 translate fragments, otherwise drop fragments @param is_ip6 - 1 if IPv6, 0 if IPv4 */ autoreply define nat_set_reass { u32 client_index; u32 context; u32 timeout; u16 max_reass; u8 max_frag; u8 drop_frag; u8 is_ip6; }; /** \brief Get NAT virtual fragmentation reassembly configuration @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define nat_get_reass { u32 client_index; u32 context; }; /** \brief Get NAT virtual fragmentation reassembly configuration reply @param context - sender context, to match reply w/ request @param retval - return code @param ip4_timeout - reassembly timeout @param ip4_max_reass - maximum number of concurrent reassemblies @param ip4_max_frag - maximum number of fragmets per reassembly @param ip4_drop_frag - if 0 translate fragments, otherwise drop fragments @param ip6_timeout - reassembly timeout @param ip6_max_reass - maximum number of concurrent reassemblies @param ip6_max_frag - maximum number of fragmets per reassembly @param ip6_drop_frag - if 0 translate fragments, otherwise drop fragments */ define nat_get_reass_reply { u32 context; i32 retval; u32 ip4_timeout; u16 ip4_max_reass; u8 ip4_max_frag; u8 ip4_drop_frag; u32 ip6_timeout; u16 ip6_max_reass; u8 ip6_max_frag; u8 ip6_drop_frag; }; /** \brief Dump NAT virtual fragmentation reassemblies @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define nat_reass_dump { u32 client_index; u32 context; }; /** \brief NAT virtual fragmentation reassemblies response @param context - sender context, to match reply w/ request @param is_ip4 - 1 if address type is IPv4 @param src_addr - source IP address @param dst_addr - destination IP address @param frag_id - fragment ID @param proto - protocol @param frag_n - number of cached fragments */ define nat_reass_details { u32 context; u8 is_ip4; u8 src_addr[16]; u8 dst_addr[16]; u32 frag_id; u8 proto; u8 frag_n; }; /* * NAT44 APIs */ /** \brief Add/del NAT44 address range @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param first_ip_address - first IPv4 address @param last_ip_address - last IPv4 address @param vrf_id - VRF id of tenant, ~0 means independent of VRF @param twice_nat - twice NAT address range for extenal hosts @param is_add - 1 if add, 0 if delete */ autoreply define nat44_add_del_address_range { u32 client_index; u32 context; u8 first_ip_address[4]; u8 last_ip_address[4]; u32 vrf_id; u8 twice_nat; u8 is_add; }; /** \brief Dump NAT44 addresses @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define nat44_address_dump { u32 client_index; u32 context; }; /** \brief NAT44 address details response @param context - sender context, to match reply w/ request @param ip_address - IPv4 address @param twice_nat - twice NAT address range for extenal hosts @param vrf_id - VRF id of tenant, ~0 means independent of VRF */ define nat44_address_details { u32 context; u8 ip_address[4]; u8 twice_nat; u32 vrf_id; }; /** \brief Enable/disable NAT44 feature on the interface @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - 1 if add, 0 if delete @param is_inside - 1 if inside, 0 if outside @param sw_if_index - software index of the interface */ autoreply define nat44_interface_add_del_feature { u32 client_index; u32 context; u8 is_add; u8 is_inside; u32 sw_if_index; }; /** \brief Dump interfaces with NAT44 feature @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define nat44_interface_dump { u32 client_index; u32 context; }; /** \brief NAT44 interface details response @param context - sender context, to match reply w/ request @param is_inside - 1 if inside, 0 if outside, 2 if inside and outside @param sw_if_index - software index of the interface */ define nat44_interface_details { u32 context; u8 is_inside; u32 sw_if_index; }; /** \brief Enable/disbale NAT44 as an interface output feature (postrouting in2out translation) @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - 1 if add, 0 if delete @param is_inside - 1 if inside, 0 if outside @param sw_if_index - software index of the interface */ autoreply define nat44_interface_add_del_output_feature { u32 client_index; u32 context; u8 is_add; u8 is_inside; u32 sw_if_index; }; /** \brief Dump interfaces with NAT44 output feature @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define nat44_interface_output_feature_dump { u32 client_index; u32 context; }; /** \brief NAT44 interface with output feature details response @param context - sender context, to match reply w/ request @param is_inside - 1 if inside, 0 if outside @param sw_if_index - software index of the interface */ define nat44_interface_output_feature_details { u32 context; u8 is_inside; u32 sw_if_index; }; /** \brief Add/delete NAT44 static mapping @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - 1 if add, 0 if delete @param addr_only - 1 if address only mapping @param local_ip_address - local IPv4 address @param external_ip_address - external IPv4 address @param protocol - IP protocol, used only if addr_only=0 @param local_port - local port number, used only if addr_only=0 @param external_port - external port number, used only if addr_only=0 @param external_sw_if_index - external interface (if set external_ip_address is ignored, ~0 means not used) @param vfr_id - VRF ID @param twice_nat - if 1 translate external host address and port, only for 1:1 NAPT (addr_only must be 0) @param self_twice_nat - if 1 translate external host address and port whenever external host address equals local address of internal host @param out2in_only - if 1 rule match only out2in direction @param tag - opaque string tag */ autoreply define nat44_add_del_static_mapping { u32 client_index; u32 context; u8 is_add; u8 addr_only; u8 local_ip_address[4]; u8 external_ip_address[4]; u8 protocol; u16 local_port; u16 external_port; u32 external_sw_if_index; u32 vrf_id; u8 twice_nat; u8 self_twice_nat; u8 out2in_only; u8 tag[64]; }; /** \brief Dump NAT44 static mappings @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define nat44_static_mapping_dump { u32 client_index; u32 context; }; /** \brief NAT44 static mapping details response @param context - sender context, to match reply w/ request @param addr_only - 1 if address only mapping @param local_ip_address - local IPv4 address @param external_ip_address - external IPv4 address @param protocol - IP protocol, valid only if addr_only=0 @param local_port - local port number, valid only if addr_only=0 @param external_port - external port number, valid only if addr_only=0 @param external_sw_if_index - external interface @param vfr_id - VRF ID @param twice_nat - if 1 translate external host address and port @param self_twice_nat - if 1 translate external host address and port whenever external host address equals local address of internal host @param out2in_only - if 1 rule match only out2in direction @param tag - opaque string tag */ define nat44_static_mapping_details { u32 context; u8 addr_only; u8 local_ip_address[4]; u8 external_ip_address[4]; u8 protocol; u16 local_port; u16 external_port; u32 external_sw_if_index; u32 vrf_id; u8 twice_nat; u8 self_twice_nat; u8 out2in_only; u8 tag[64]; }; /** \brief Add/delete NAT44 identity mapping @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - 1 if add, 0 if delete @param addr_only - 1 if address only mapping @param ip_address - IPv4 address @param protocol - IP protocol @param port - port number @param sw_if_index - interface (if set ip_address is ignored, ~0 means not used) @param vfr_id - VRF ID (if ~0 use default VRF) @param tag - opaque string tag */ autoreply define nat44_add_del_identity_mapping { u32 client_index; u32 context; u8 is_add; u8 addr_only; u8 ip_address[4]; u8 protocol; u16 port; u32 sw_if_index; u32 vrf_id; u8 tag[64]; }; /** \brief Dump NAT44 identity mappings @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define nat44_identity_mapping_dump { u32 client_index; u32 context; }; /** \brief NAT44 identity mapping details response @param context - sender context, to match reply w/ request @param addr_only - 1 if address only mapping @param ip_address - IPv4 address @param protocol - IP protocol @param port - port number @param sw_if_index - interface @param vfr_id - VRF ID @param tag - opaque string tag */ define nat44_identity_mapping_details { u32 context; u8 addr_only; u8 ip_address[4]; u8 protocol; u16 port; u32 sw_if_index; u32 vrf_id; u8 tag[64]; }; /** \brief Add/delete NAT44 pool address from specific interfce @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - 1 if add, 0 if delete @param twice_nat - twice NAT address for extenal hosts @param sw_if_index - software index of the interface */ autoreply define nat44_add_del_interface_addr { u32 client_index; u32 context; u8 is_add; u8 twice_nat; u32 sw_if_index; }; /** \brief Dump NAT44 pool addresses interfaces @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define nat44_interface_addr_dump { u32 client_index; u32 context; }; /** \brief NAT44 pool addresses interfaces details response @param context - sender context, to match reply w/ request @param sw_if_index - software index of the interface @param twice_nat - twice NAT address for extenal hosts */ define nat44_interface_addr_details { u32 context; u32 sw_if_index; u8 twice_nat; }; /** \brief Dump NAT44 users @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define nat44_user_dump { u32 client_index; u32 context; }; /** \brief NAT44 users response @param context - sender context, to match reply w/ request @vrf_id - VRF ID @param ip_adress - IPv4 address @param nsessions - number of dynamic sessions @param nstaticsessions - number of static sessions */ define nat44_user_details { u32 context; u32 vrf_id; u8 ip_address[4]; u32 nsessions; u32 nstaticsessions; }; /** \brief NAT44 user's sessions @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_ip4 - 1 if address type is IPv4 @param user_ip - IP address of the user to dump @param vrf_id - VRF_ID */ define nat44_user_session_dump { u32 client_index; u32 context; u8 ip_address[4]; u32 vrf_id; }; /** \brief NAT44 user's sessions response @param context - sender context, to match reply w/ request @param outside_ip_address - outside IPv4 address @param outside_port - outside port @param inside_ip_address - inside IPv4 address @param inside_port - inside port @param protocol - protocol @param is_static - 1 if session is static @param last_heard - last heard timer @param total_bytes - count of bytes sent through session @param total_pkts - count of pakets sent through session @param is_twicenat - 1 if session is twice-nat @param ext_host_valid - 1 if external host address and port are valid @param ext_host_address - external host IPv4 address @param ext_host_port - external host port @param ext_host_nat_address - post-NAT external host IPv4 address (valid only if twice-nat session) @param ext_host_nat_port - post-NAT external host port (valid only if twice-nat session) */ define nat44_user_session_details { u32 context; u8 outside_ip_address[4]; u16 outside_port; u8 inside_ip_address[4]; u16 inside_port; u16 protocol; u8 is_static; u64 last_heard; u64 total_bytes; u32 total_pkts; u8 is_twicenat; u8 ext_host_valid; u8 ext_host_address[4]; u16 ext_host_port; u8 ext_host_nat_address[4]; u16 ext_host_nat_port; }; /** \brief NAT44 load-balancing address and port pair @param addr - IPv4 address of the internal node @param port - L4 port number of the internal node @param probability - probability of the internal node to be randomly matched */ typeonly manual_endian define nat44_lb_addr_port { u8 addr[4]; u16 port; u8 probability; u32 vrf_id; }; /** \brief Add/delete NAT44 load-balancing static mapping rule @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - 1 if add, 0 if delete @param external_addr - external IPv4 address of the service @param external_port - external L4 port number of the service @param protocol - IP protocol number of the service @param twice_nat - if 1 translate external host address and port @param self_twice_nat - if 1 translate external host address and port whenever external host address equals local address of internal host @param out2in_only - if 1 rule match only out2in direction @param tag - opaque string tag @param local_num - number of local network nodes @param locals - local network nodes */ autoreply manual_endian define nat44_add_del_lb_static_mapping { u32 client_index; u32 context; u8 is_add; u8 external_addr[4]; u16 external_port; u8 protocol; u8 twice_nat; u8 self_twice_nat; u8 out2in_only; u8 tag[64]; u8 local_num; vl_api_nat44_lb_addr_port_t locals[local_num]; }; /** \brief Dump NAT44 load-balancing static mapping rules @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define nat44_lb_static_mapping_dump { u32 client_index; u32 context; }; /** \brief NAT44 load-balancing static mapping rule details response @param context - sender context, to match reply w/ request @param is_add - 1 if add, 0 if delete @param external_addr - external IPv4 address of the service @param external_port - external L4 port number of the service @param protocol - IP protocol number of the service @param twice_nat - if 1 translate external host address and port @param self_twice_nat - if 1 translate external host address and port whenever external host address equals local address of internal host @param out2in_only - if 1 rule match only out2in direction @param tag - opaque string tag @param local_num - number of local network nodes @param locals - local network nodes */ manual_endian define nat44_lb_static_mapping_details { u32 context; u8 external_addr[4]; u16 external_port; u8 protocol; u8 twice_nat; u8 self_twice_nat; u8 out2in_only; u8 tag[64]; u8 local_num; vl_api_nat44_lb_addr_port_t locals[local_num]; }; /** \brief Delete NAT44 session @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_in - 1 if inside network addres and port pari, 0 if outside @param ip_address - IPv4 address @param protocol - IP protocol @param port - port number @param vfr_id - VRF ID @param ext_host_valid - 1 if external host address and port are valid @param ext_host_address - external host IPv4 address @param ext_host_port - external host port */ autoreply define nat44_del_session { u32 client_index; u32 context; u8 is_in; u8 address[4]; u8 protocol; u16 port; u32 vrf_id; u8 ext_host_valid; u8 ext_host_address[4]; u16 ext_host_port; }; /** \brief Enable/disable forwarding for NAT44 Forward packets which don't match existing translation or static mapping instead of dropping them. @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param enable - 0 for enable, 1 for disable */ autoreply define nat44_forwarding_enable_disable { u32 client_index; u32 context; u8 enable; }; /** \brief Check if forwarding is enabled or disabled @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define nat44_forwarding_is_enabled { u32 client_index; u32 context; }; /** \brief Response to check if forwarding is enabled or disabled @param context - sender context, to match reply w/ request @param enabled - 1 if enabled, 0 if disabled */ define nat44_forwarding_is_enabled_reply { u32 context; u8 enabled; }; /* * Deterministic NAT (CGN) APIs */ /** \brief Add/delete NAT deterministic mapping @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - 1 if add, 0 if delete @param is_nat44 - 1 if NAT44 @param in_addr - inside IP address @param in_plen - inside IP address prefix length @param out_addr - outside IPv4 address @param out_addr - outside IPv4 address prefix length */ autoreply define nat_det_add_del_map { u32 client_index; u32 context; u8 is_add; u8 is_nat44; u8 addr_only; u8 in_addr[16]; u8 in_plen; u8 out_addr[4]; u8 out_plen; }; /** \brief Get outside address and port range from inside address @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_nat44 - 1 if NAT44 @param in_addr - inside IP address */ define nat_det_forward { u32 client_index; u32 context; u8 is_nat44; u8 in_addr[16]; }; /** \brief Get outside address and port range from inside address @param context - sender context, to match reply w/ request @param retval - return code @param out_port_lo - outside port range start @param out_port_hi - outside port range end @param out_addr - outside IPv4 address */ define nat_det_forward_reply { u32 context; i32 retval; u16 out_port_lo; u16 out_port_hi; u8 out_addr[4]; }; /** \brief Get inside address from outside address and port @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param out_port - outside port @param out_addr - outside IPv4 address */ define nat_det_reverse { u32 client_index; u32 context; u16 out_port; u8 out_addr[4]; }; /** \brief Get inside address from outside address and port reply @param context - sender context, to match reply w/ request @param retval - return code @param is_nat44 - 1 if NAT44 @param in_addr - inside IP address */ define nat_det_reverse_reply { u32 context; i32 retval; u8 is_nat44; u8 in_addr[16]; }; /** \brief Dump NAT deterministic mappings @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define nat_det_map_dump { u32 client_index; u32 context; }; /** \brief NAT users response @param context - sender context, to match reply w/ request @param is_nat44 - 1 if NAT44 @param in_addr - inside IP address @param in_plen - inside IP address prefix length @param out_addr - outside IPv4 address @param out_plen - outside IPv4 address prefix length @param sharing_ratio - outside to inside address sharing ratio @param ports_per_host - number of ports available to a host @param ses_num - number of sessions belonging to this mapping */ define nat_det_map_details { u32 context; u8 is_nat44; u8 in_addr[16]; u8 in_plen; u8 out_addr[4]; u8 out_plen; u32 sharing_ratio; u16 ports_per_host; u32 ses_num; }; /** \brief Set values of timeouts for deterministic NAT (seconds, 0 = default) @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param udp - UDP timeout (default 300sec) @param tcp_established - TCP established timeout (default 7440sec) @param tcp_transitory - TCP transitory timeout (default 240sec) @param icmp - ICMP timeout (default 60sec) */ autoreply define nat_det_set_timeouts { u32 client_index; u32 context; u32 udp; u32 tcp_established; u32 tcp_transitory; u32 icmp; }; /** \brief Get values of timeouts for deterministic NAT (seconds) @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define nat_det_get_timeouts { u32 client_index; u32 context; }; /** \brief Get values of timeouts for deterministic NAT reply @param context - sender context, to match reply w/ request @param retval - return code @param udp - UDP timeout (default 300sec) @param tcp_established - TCP established timeout (default 7440sec) @param tcp_transitory - TCP transitory timeout (default 240sec) @param icmp - ICMP timeout (default 60sec) */ define nat_det_get_timeouts_reply { u32 context; i32 retval; u32 udp; u32 tcp_established; u32 tcp_transitory; u32 icmp; }; /** \brief Close deterministic NAT session by outside address and port @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param out_addr - outside IPv4 address @param out_port - outside port @param ext_addr - external host IPv4 address @param ext_port - external host port */ autoreply define nat_det_close_session_out { u32 client_index; u32 context; u8 out_addr[4]; u16 out_port; u8 ext_addr[4]; u16 ext_port; }; /** \brief Close deterministic NAT session by inside address and port @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_nat44 - 1 if NAT44 @param in_addr - inside IP address @param in_port - inside port @param ext_addr - external host IP address @param ext_port - external host port */ autoreply define nat_det_close_session_in { u32 client_index; u32 context; u8 is_nat44; u8 in_addr[16]; u16 in_port; u8 ext_addr[16]; u16 ext_port; }; /** \brief Dump determinstic NAT sessions @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_nat44 - 1 if NAT44 @param user_addr - address of an inside user whose sessions to dump */ define nat_det_session_dump { u32 client_index; u32 context; u8 is_nat44; u8 user_addr[16]; }; /** \brief Deterministic NAT sessions reply @param context - sender context, to match reply w/ request @param in_port - inside port @param ext_addr - external host address @param ext_port - external host port @param out_port - outside NAT port @param state - session state @param expire - session expiration timestamp */ define nat_det_session_details { u32 client_index; u32 context; u16 in_port; u8 ext_addr[4]; u16 ext_port; u16 out_port; u8 state; u32 expire; }; /* * NAT64 APIs */ /** \brief Add/delete address range to NAT64 pool @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param start_addr - start address of the range @param end_addr - end address of the range @param vrf_id - VRF id of tenant, ~0 means independent of VRF @param is_add - 1 if add, 0 if delete */ autoreply define nat64_add_del_pool_addr_range { u32 client_index; u32 context; u8 start_addr[4]; u8 end_addr[4]; u32 vrf_id; u8 is_add; }; /** \brief Dump NAT64 pool addresses @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define nat64_pool_addr_dump { u32 client_index; u32 context; }; /** \brief NAT64 pool address details response @param context - sender context, to match reply w/ request @param address - IPv4 address @param vfr_id - VRF id of tenant, ~0 means independent of VRF */ define nat64_pool_addr_details { u32 context; u8 address[4]; u32 vrf_id; }; /** \brief Enable/disable NAT64 feature on the interface @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param sw_if_index - index of the interface @param is_inside - 1 if inside, 0 if outside @param is_add - 1 if add, 0 if delete */ autoreply define nat64_add_del_interface { u32 client_index; u32 context; u32 sw_if_index; u8 is_inside; u8 is_add; }; /** \brief Dump interfaces with NAT64 feature @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define nat64_interface_dump { u32 client_index; u32 context; }; /** \brief NAT64 interface details response @param context - sender context, to match reply w/ request @param is_inside - 1 if inside, 0 if outside @param sw_if_index - index of the interface */ define nat64_interface_details { u32 context; u8 is_inside; u32 sw_if_index; }; /** \brief Add/delete NAT64 static BIB entry @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param i_addr - inside IPv6 address @param o_addr - outside IPv4 address @param i_port - inside port number @param o_port - outside port number @param vrf_id - VRF id of tenant @param proto - protocol number @param is_add - 1 if add, 0 if delete */ autoreply define nat64_add_del_static_bib { u32 client_index; u32 context; u8 i_addr[16]; u8 o_addr[4]; u16 i_port; u16 o_port; u32 vrf_id; u8 proto; u8 is_add; }; /** \brief Dump NAT64 BIB @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param proto - protocol of the BIB: 255 - all BIBs 6 - TCP BIB 17 - UDP BIB 1/58 - ICMP BIB otherwise - "unknown" protocol BIB */ define nat64_bib_dump { u32 client_index; u32 context; u8 proto; }; /** \brief NAT64 BIB details response @param context - sender context, to match reply w/ request @param i_addr - inside IPv6 address @param o_addr - outside IPv4 address @param i_port - inside port number @param o_port - outside port number @param vrf_id - VRF id of tenant @param proto - protocol number @param is_static - 1 if static BIB entry, 0 if dynamic @param ses_num - number of sessions associated with the BIB entry */ define nat64_bib_details { u32 context; u8 i_addr[16]; u8 o_addr[4]; u16 i_port; u16 o_port; u32 vrf_id; u8 proto; u8 is_static; u32 ses_num; }; /** \brief Set values of timeouts for NAT64 (seconds, 0 = default) @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param udp - UDP timeout (default 300sec) @param icmp - ICMP timeout (default 60sec) @param tcp_trans - TCP transitory timeout (default 240sec) @param tcp_est - TCP established timeout (default 7440sec) @param tcp_incoming_syn - TCP incoming SYN timeout (default 6sec) */ autoreply define nat64_set_timeouts { u32 client_index; u32 context; u32 udp; u32 icmp; u32 tcp_trans; u32 tcp_est; u32 tcp_incoming_syn; }; /** \brief Get values of timeouts for NAT64 (seconds) @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define nat64_get_timeouts { u32 client_index; u32 context; }; /** \brief Get values of timeouts for NAT64 reply @param context - sender context, to match reply w/ request @param retval - return code @param udp - UDP timeout @param icmp - ICMP timeout @param tcp_trans - TCP transitory timeout @param tcp_est - TCP established timeout @param tcp_incoming_syn - TCP incoming SYN timeout */ define nat64_get_timeouts_reply { u32 context; i32 retval; u32 udp; u32 icmp; u32 tcp_trans; u32 tcp_est; u32 tcp_incoming_syn; }; /** \brief Dump NAT64 session table @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param proto - protocol of the session table: 255 - all STs 6 - TCP ST 17 - UDP ST 1/58 - ICMP ST otherwise - "unknown" proto ST */ define nat64_st_dump { u32 client_index; u32 context; u8 proto; }; /** \brief NAT64 session table details response @param context - sender context, to match reply w/ request @param il_addr - inside IPv6 address of the local host @param ol_addr - outside IPv4 address of the local host @param il_port - inside port number id of the local host/inside ICMP id @param ol_port - outside port number of the local host/outside ICMP id @param il_addr - inside IPv6 address of the remote host @param ol_addr - outside IPv4 address of the remote host @param l_port - port number of the remote host (not used for ICMP) @param vrf_id - VRF id of tenant @param proto - protocol number */ define nat64_st_details { u32 context; u8 il_addr[16]; u8 ol_addr[4]; u16 il_port; u16 ol_port; u8 ir_addr[16]; u8 or_addr[4]; u16 r_port; u32 vrf_id; u8 proto; }; /** \brief Add/del NAT64 prefix @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param prefix - NAT64 prefix @param prefix - NAT64 prefix length @param vrf_id - VRF id of tenant @param is_add - 1 if add, 0 if delete */ autoreply define nat64_add_del_prefix { u32 client_index; u32 context; u8 prefix[16]; u8 prefix_len; u32 vrf_id; u8 is_add; }; /** \brief Dump NAT64 prefix @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define nat64_prefix_dump { u32 client_index; u32 context; }; /** \brief Dump NAT64 prefix details response @param context - sender context, to match reply w/ request @param prefix - NAT64 prefix @param prefix - NAT64 prefix length @param vrf_id - VRF id of tenant */ define nat64_prefix_details { u32 context; u8 prefix[16]; u8 prefix_len; u32 vrf_id; }; /** \brief Add/delete NAT64 pool address from specific interfce @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - 1 if add, 0 if delete @param sw_if_index - software index of the interface */ autoreply define nat64_add_del_interface_addr { u32 client_index; u32 context; u8 is_add; u8 is_inside; u32 sw_if_index; }; /* * DS-Lite APIs */ /** \brief Add/delete address range to DS-Lite pool @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param start_addr - start address of the range @param end_addr - end address of the range @param is_add - 1 if add, 0 if delete */ autoreply define dslite_add_del_pool_addr_range { u32 client_index; u32 context; u8 start_addr[4]; u8 end_addr[4]; u8 is_add; }; /** \brief Dump DS-Lite addresses @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define dslite_address_dump { u32 client_index; u32 context; }; /** \brief DS-Lite address details response @param context - sender context, to match reply w/ request @param ip_address - IPv4 address */ define dslite_address_details { u32 context; u8 ip_address[4]; }; /** \brief Set AFTR IPv6 and IPv4 addresses @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param ip4_addr - IPv4 address @param ip6_addr - IP64 address */ autoreply define dslite_set_aftr_addr { u32 client_index; u32 context; u8 ip4_addr[4]; u8 ip6_addr[16]; }; /** \brief Get AFTR IPv6 and IPv4 addresses @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define dslite_get_aftr_addr { u32 client_index; u32 context; }; /** \brief Response to get AFTR IPv6 and IPv4 addresses @param context - sender context, to match reply w/ request @param retval - return code @param ip4_addr - IPv4 address @param ip6_addr - IP64 address */ define dslite_get_aftr_addr_reply { u32 context; i32 retval; u8 ip4_addr[4]; u8 ip6_addr[16]; }; /** \brief Set B4 IPv6 and IPv4 addresses @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param ip4_addr - IPv4 address @param ip6_addr - IP64 address */ autoreply define dslite_set_b4_addr { u32 client_index; u32 context; u8 ip4_addr[4]; u8 ip6_addr[16]; }; /** \brief Get B4 IPv6 and IPv4 addresses @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define dslite_get_b4_addr { u32 client_index; u32 context; }; /** \brief Response to get B4 IPv6 and IPv4 addresses @param context - sender context, to match reply w/ request @param retval - return code @param ip4_addr - IPv4 address @param ip6_addr - IP64 address */ define dslite_get_b4_addr_reply { u32 context; i32 retval; u8 ip4_addr[4]; u8 ip6_addr[16]; }; /* * NAT66 APIs */ /** \brief Enable/disable NAT66 feature on the interface @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - 1 if add, 0 if delete @param is_inside - 1 if inside, 0 if outside @param sw_if_index - software index of the interface */ autoreply define nat66_add_del_interface { u32 client_index; u32 context; u8 is_add; u8 is_inside; u32 sw_if_index; }; /** \brief Dump interfaces with NAT66 feature @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define nat66_interface_dump { u32 client_index; u32 context; }; /** \brief NAT66 interface details response @param context - sender context, to match reply w/ request @param is_inside - 1 if inside, 0 if outside @param sw_if_index - software index of the interface */ define nat66_interface_details { u32 context; u8 is_inside; u32 sw_if_index; }; /** \brief Add/delete 1:1 NAT66 @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - 1 if add, 0 if delete @param local_ip_address - local IPv6 address @param external_ip_address - external IPv6 address @param vrf_id - VRF id of tenant */ autoreply define nat66_add_del_static_mapping { u32 client_index; u32 context; u8 is_add; u8 local_ip_address[16]; u8 external_ip_address[16]; u32 vrf_id; }; /** \brief Dump NAT66 static mappings @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request */ define nat66_static_mapping_dump { u32 client_index; u32 context; }; /** \brief NAT66 static mapping details response @param context - sender context, to match reply w/ request @param local_ip_address - local IPv6 address @param external_ip_address - external IPv6 address @param vrf_id - VRF id of tenant @param total_bytes - count of bytes sent through static mapping @param total_pkts - count of pakets sent through static mapping */ define nat66_static_mapping_details { u32 context; u8 local_ip_address[16]; u8 external_ip_address[16]; u32 vrf_id; u64 total_bytes; u64 total_pkts; };