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:
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.
18 #include <vnet/flow/flow_report.h>
19 #include <vnet/api_errno.h>
21 flow_report_main_t flow_report_main;
23 static_always_inline u8 stream_index_valid (u32 index)
25 flow_report_main_t * frm = &flow_report_main;
26 return index < vec_len(frm->streams) &&
27 frm->streams[index].domain_id != ~0;
30 static_always_inline flow_report_stream_t * add_stream (void)
32 flow_report_main_t * frm = &flow_report_main;
34 for (i = 0; i < vec_len(frm->streams); i++)
35 if (!stream_index_valid(i))
36 return &frm->streams[i];
37 u32 index = vec_len(frm->streams);
38 vec_validate(frm->streams, index);
39 return &frm->streams[index];
42 static_always_inline void delete_stream (u32 index)
44 flow_report_main_t * frm = &flow_report_main;
45 ASSERT (index < vec_len(frm->streams));
46 ASSERT (frm->streams[index].domain_id != ~0);
47 frm->streams[index].domain_id = ~0;
50 static i32 find_stream (u32 domain_id, u16 src_port)
52 flow_report_main_t * frm = &flow_report_main;
53 flow_report_stream_t * stream;
55 for (i = 0; i < vec_len(frm->streams); i++)
56 if (stream_index_valid(i)) {
57 stream = &frm->streams[i];
58 if (domain_id == stream->domain_id) {
59 if (src_port != stream->src_port)
62 } else if (src_port == stream->src_port) {
69 int send_template_packet (flow_report_main_t *frm,
75 ip4_ipfix_template_packet_t * tp;
76 ipfix_message_header_t * h;
79 vlib_main_t * vm = frm->vlib_main;
80 flow_report_stream_t * stream;
81 vlib_buffer_free_list_t *fl;
83 ASSERT (buffer_indexp);
85 if (fr->update_rewrite || fr->rewrite == 0)
87 if (frm->ipfix_collector.as_u32 == 0
88 || frm->src_address.as_u32 == 0)
90 vlib_node_set_state (frm->vlib_main, flow_report_process_node.index,
91 VLIB_NODE_STATE_DISABLED);
94 vec_free (fr->rewrite);
95 fr->update_rewrite = 1;
98 if (fr->update_rewrite)
100 fr->rewrite = fr->rewrite_callback (frm, fr,
101 &frm->ipfix_collector,
103 frm->collector_port);
104 fr->update_rewrite = 0;
107 if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
110 b0 = vlib_get_buffer (vm, bi0);
112 /* Initialize the buffer */
113 fl = vlib_buffer_get_free_list (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
114 vlib_buffer_init_for_free_list (b0, fl);
115 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
117 ASSERT (vec_len (fr->rewrite) < VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES);
119 clib_memcpy (b0->data, fr->rewrite, vec_len (fr->rewrite));
120 b0->current_data = 0;
121 b0->current_length = vec_len (fr->rewrite);
122 b0->flags |= (VLIB_BUFFER_TOTAL_LENGTH_VALID | VLIB_BUFFER_FLOW_REPORT);
123 vnet_buffer (b0)->sw_if_index[VLIB_RX] = 0;
124 vnet_buffer (b0)->sw_if_index[VLIB_TX] = frm->fib_index;
126 tp = vlib_buffer_get_current (b0);
127 ip = (ip4_header_t *) &tp->ip4;
128 udp = (udp_header_t *) (ip+1);
129 h = (ipfix_message_header_t *)(udp+1);
131 /* FIXUP: message header export_time */
132 h->export_time = (u32)
133 (((f64)frm->unix_time_0) +
134 (vlib_time_now(frm->vlib_main) - frm->vlib_time_0));
135 h->export_time = clib_host_to_net_u32(h->export_time);
137 stream = &frm->streams[fr->stream_index];
139 /* FIXUP: message header sequence_number. Templates do not increase it */
140 h->sequence_number = clib_host_to_net_u32(stream->sequence_number);
142 /* FIXUP: udp length */
143 udp->length = clib_host_to_net_u16 (b0->current_length - sizeof (*ip));
145 if (frm->udp_checksum)
147 /* RFC 7011 section 10.3.2. */
148 udp->checksum = ip4_tcp_udp_compute_checksum (vm, b0, ip);
149 if (udp->checksum == 0)
150 udp->checksum = 0xffff;
153 *buffer_indexp = bi0;
155 fr->last_template_sent = vlib_time_now (vm);
161 flow_report_process (vlib_main_t * vm,
162 vlib_node_runtime_t * rt,
165 flow_report_main_t * frm = &flow_report_main;
167 u32 ip4_lookup_node_index;
168 vlib_node_t * ip4_lookup_node;
169 vlib_frame_t * nf = 0;
176 uword *event_data = 0;
178 /* Wait for Godot... */
179 vlib_process_wait_for_event_or_clock (vm, 1e9);
180 event_type = vlib_process_get_events (vm, &event_data);
182 clib_warning ("bogus kickoff event received, %d", event_type);
183 vec_reset_length (event_data);
185 /* Enqueue pkts to ip4-lookup */
186 ip4_lookup_node = vlib_get_node_by_name (vm, (u8 *) "ip4-lookup");
187 ip4_lookup_node_index = ip4_lookup_node->index;
191 vlib_process_wait_for_event_or_clock (vm, 5.0);
192 event_type = vlib_process_get_events (vm, &event_data);
193 vec_reset_length (event_data);
195 vec_foreach (fr, frm->reports)
197 now = vlib_time_now (vm);
199 /* Need to send a template packet? */
201 now > (fr->last_template_sent + frm->template_interval);
202 send_template += fr->last_template_sent == 0;
207 rv = send_template_packet (frm, fr, &template_bi);
212 nf = vlib_get_frame_to_node (vm, ip4_lookup_node_index);
214 to_next = vlib_frame_vector_args (nf);
216 if (template_bi != ~0)
218 to_next[0] = template_bi;
223 nf = fr->flow_data_callback (frm, fr,
224 nf, to_next, ip4_lookup_node_index);
226 vlib_put_frame_to_node (vm, ip4_lookup_node_index, nf);
230 return 0; /* not so much */
233 VLIB_REGISTER_NODE (flow_report_process_node) = {
234 .function = flow_report_process,
235 .type = VLIB_NODE_TYPE_PROCESS,
236 .name = "flow-report-process",
239 int vnet_flow_report_add_del (flow_report_main_t *frm,
240 vnet_flow_report_add_del_args_t *a,
244 int found_index = ~0;
246 flow_report_stream_t * stream;
249 si = find_stream(a->domain_id, a->src_port);
251 return VNET_API_ERROR_INVALID_VALUE;
252 if (si == -1 && a->is_add == 0)
253 return VNET_API_ERROR_NO_SUCH_ENTRY;
255 for (i = 0; i < vec_len(frm->reports); i++)
257 fr = vec_elt_at_index (frm->reports, i);
258 if (fr->opaque.as_uword == a->opaque.as_uword
259 && fr->rewrite_callback == a->rewrite_callback
260 && fr->flow_data_callback == a->flow_data_callback)
264 *template_id = fr->template_id;
271 if (found_index != ~0)
273 vec_delete (frm->reports, 1, found_index);
274 stream = &frm->streams[si];
276 if (stream->n_reports == 0)
280 return VNET_API_ERROR_NO_SUCH_ENTRY;
283 if (found_index != ~0)
284 return VNET_API_ERROR_VALUE_EXIST;
288 stream = add_stream();
289 stream->domain_id = a->domain_id;
290 stream->src_port = a->src_port;
291 stream->sequence_number = 0;
292 stream->n_reports = 0;
293 si = stream - frm->streams;
296 stream = &frm->streams[si];
300 vec_add2 (frm->reports, fr, 1);
302 fr->stream_index = si;
303 fr->template_id = 256 + stream->next_template_no;
304 stream->next_template_no = (stream->next_template_no + 1) % (65536 - 256);
305 fr->update_rewrite = 1;
306 fr->opaque = a->opaque;
307 fr->rewrite_callback = a->rewrite_callback;
308 fr->flow_data_callback = a->flow_data_callback;
311 *template_id = fr->template_id;
316 clib_error_t * flow_report_add_del_error_to_clib_error (int error)
322 case VNET_API_ERROR_NO_SUCH_ENTRY:
323 return clib_error_return (0, "Flow report not found");
324 case VNET_API_ERROR_VALUE_EXIST:
325 return clib_error_return (0, "Flow report already exists");
326 case VNET_API_ERROR_INVALID_VALUE:
327 return clib_error_return (0, "Expecting either still unused values "
328 "for both domain_id and src_port "
329 "or already used values for both fields");
331 return clib_error_return (0, "vnet_flow_report_add_del returned %d",
336 void vnet_flow_reports_reset (flow_report_main_t * frm)
341 for (i = 0; i < vec_len(frm->streams); i++)
342 if (stream_index_valid(i))
343 frm->streams[i].sequence_number = 0;
345 vec_foreach (fr, frm->reports)
347 fr->update_rewrite = 1;
348 fr->last_template_sent = 0;
352 void vnet_stream_reset (flow_report_main_t * frm, u32 stream_index)
356 frm->streams[stream_index].sequence_number = 0;
358 vec_foreach (fr, frm->reports)
359 if (frm->reports->stream_index == stream_index) {
360 fr->update_rewrite = 1;
361 fr->last_template_sent = 0;
365 int vnet_stream_change (flow_report_main_t * frm,
366 u32 old_domain_id, u16 old_src_port,
367 u32 new_domain_id, u16 new_src_port)
369 i32 stream_index = find_stream (old_domain_id, old_src_port);
370 if (stream_index < 0)
372 flow_report_stream_t * stream = &frm->streams[stream_index];
373 stream->domain_id = new_domain_id;
374 stream->src_port = new_src_port;
375 if (old_domain_id != new_domain_id || old_src_port != new_src_port)
376 vnet_stream_reset (frm, stream_index);
380 static clib_error_t *
381 set_ipfix_exporter_command_fn (vlib_main_t * vm,
382 unformat_input_t * input,
383 vlib_cli_command_t * cmd)
385 flow_report_main_t * frm = &flow_report_main;
386 ip4_address_t collector, src;
387 u16 collector_port = UDP_DST_PORT_ipfix;
391 collector.as_u32 = 0;
393 u32 path_mtu = 512; // RFC 7011 section 10.3.3.
394 u32 template_interval = 20;
397 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT) {
398 if (unformat (input, "collector %U", unformat_ip4_address, &collector))
400 else if (unformat (input, "port %u", &collector_port))
402 else if (unformat (input, "src %U", unformat_ip4_address, &src))
404 else if (unformat (input, "fib-id %u", &fib_id))
406 ip4_main_t * im = &ip4_main;
407 uword * p = hash_get (im->fib_index_by_table_id, fib_id);
409 return clib_error_return (0, "fib ID %d doesn't exist\n",
413 else if (unformat (input, "path-mtu %u", &path_mtu))
415 else if (unformat (input, "template-interval %u", &template_interval))
417 else if (unformat (input, "udp-checksum"))
423 if (collector.as_u32 != 0 && src.as_u32 == 0)
424 return clib_error_return (0, "src address required");
426 if (path_mtu > 1450 /* vpp does not support fragmentation */)
427 return clib_error_return (0, "too big path-mtu value, maximum is 1450");
430 return clib_error_return (0, "too small path-mtu value, minimum is 68");
432 /* Reset report streams if we are reconfiguring IP addresses */
433 if (frm->ipfix_collector.as_u32 != collector.as_u32 ||
434 frm->src_address.as_u32 != src.as_u32 ||
435 frm->collector_port != collector_port)
436 vnet_flow_reports_reset(frm);
438 frm->ipfix_collector.as_u32 = collector.as_u32;
439 frm->collector_port = collector_port;
440 frm->src_address.as_u32 = src.as_u32;
441 frm->fib_index = fib_index;
442 frm->path_mtu = path_mtu;
443 frm->template_interval = template_interval;
444 frm->udp_checksum = udp_checksum;
446 if (collector.as_u32)
447 vlib_cli_output (vm, "Collector %U, src address %U, "
448 "fib index %d, path MTU %u, "
449 "template resend interval %us, "
451 format_ip4_address, &frm->ipfix_collector,
452 format_ip4_address, &frm->src_address,
453 fib_index, path_mtu, template_interval,
454 udp_checksum ? "enabled" : "disabled");
456 vlib_cli_output (vm, "IPFIX Collector is disabled");
458 /* Turn on the flow reporting process */
459 vlib_process_signal_event (vm, flow_report_process_node.index,
464 VLIB_CLI_COMMAND (set_ipfix_exporter_command, static) = {
465 .path = "set ipfix exporter",
466 .short_help = "set ipfix exporter "
467 "collector <ip4-address> [port <port>] "
468 "src <ip4-address> [fib-id <fib-id>] "
469 "[path-mtu <path-mtu>] "
470 "[template-interval <template-interval>]",
472 .function = set_ipfix_exporter_command_fn,
476 static clib_error_t *
477 ipfix_flush_command_fn (vlib_main_t * vm,
478 unformat_input_t * input,
479 vlib_cli_command_t * cmd)
481 /* poke the flow reporting process */
482 vlib_process_signal_event (vm, flow_report_process_node.index,
487 VLIB_CLI_COMMAND (ipfix_flush_command, static) = {
488 .path = "ipfix flush",
489 .short_help = "flush the current ipfix data [for make test]",
490 .function = ipfix_flush_command_fn,
493 static clib_error_t *
494 flow_report_init (vlib_main_t *vm)
496 flow_report_main_t * frm = &flow_report_main;
499 frm->vnet_main = vnet_get_main();
500 frm->unix_time_0 = time(0);
501 frm->vlib_time_0 = vlib_time_now(frm->vlib_main);
507 VLIB_INIT_FUNCTION (flow_report_init)