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/ipfix-export/flow_report.h>
19 #include <vnet/api_errno.h>
20 #include <vnet/udp/udp.h>
22 flow_report_main_t flow_report_main;
24 static_always_inline u8
25 stream_index_valid (u32 index)
27 flow_report_main_t *frm = &flow_report_main;
28 return index < vec_len (frm->streams) &&
29 frm->streams[index].domain_id != ~0;
32 static_always_inline flow_report_stream_t *
35 flow_report_main_t *frm = &flow_report_main;
37 for (i = 0; i < vec_len (frm->streams); i++)
38 if (!stream_index_valid (i))
39 return &frm->streams[i];
40 u32 index = vec_len (frm->streams);
41 vec_validate (frm->streams, index);
42 return &frm->streams[index];
45 static_always_inline void
46 delete_stream (u32 index)
48 flow_report_main_t *frm = &flow_report_main;
49 ASSERT (index < vec_len (frm->streams));
50 ASSERT (frm->streams[index].domain_id != ~0);
51 frm->streams[index].domain_id = ~0;
55 find_stream (u32 domain_id, u16 src_port)
57 flow_report_main_t *frm = &flow_report_main;
58 flow_report_stream_t *stream;
60 for (i = 0; i < vec_len (frm->streams); i++)
61 if (stream_index_valid (i))
63 stream = &frm->streams[i];
64 if (domain_id == stream->domain_id)
66 if (src_port != stream->src_port)
70 else if (src_port == stream->src_port)
79 send_template_packet (flow_report_main_t * frm,
80 flow_report_t * fr, u32 * buffer_indexp)
84 ip4_ipfix_template_packet_t *tp;
85 ipfix_message_header_t *h;
88 vlib_main_t *vm = frm->vlib_main;
89 flow_report_stream_t *stream;
91 ASSERT (buffer_indexp);
93 if (fr->update_rewrite || fr->rewrite == 0)
95 if (frm->ipfix_collector.as_u32 == 0 || frm->src_address.as_u32 == 0)
97 vlib_node_set_state (frm->vlib_main, flow_report_process_node.index,
98 VLIB_NODE_STATE_DISABLED);
101 vec_free (fr->rewrite);
102 fr->update_rewrite = 1;
105 if (fr->update_rewrite)
107 fr->rewrite = fr->rewrite_callback (frm, fr,
108 &frm->ipfix_collector,
112 fr->n_report_elements,
114 fr->update_rewrite = 0;
117 if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
120 b0 = vlib_get_buffer (vm, bi0);
122 ASSERT (vec_len (fr->rewrite) < vlib_buffer_get_default_data_size (vm));
124 clib_memcpy_fast (b0->data, fr->rewrite, vec_len (fr->rewrite));
125 b0->current_data = 0;
126 b0->current_length = vec_len (fr->rewrite);
127 b0->flags |= (VLIB_BUFFER_TOTAL_LENGTH_VALID | VNET_BUFFER_F_FLOW_REPORT);
128 vnet_buffer (b0)->sw_if_index[VLIB_RX] = 0;
129 vnet_buffer (b0)->sw_if_index[VLIB_TX] = frm->fib_index;
131 tp = vlib_buffer_get_current (b0);
132 ip = (ip4_header_t *) & tp->ip4;
133 udp = (udp_header_t *) (ip + 1);
134 h = (ipfix_message_header_t *) (udp + 1);
136 /* FIXUP: message header export_time */
137 h->export_time = (u32)
138 (((f64) frm->unix_time_0) +
139 (vlib_time_now (frm->vlib_main) - frm->vlib_time_0));
140 h->export_time = clib_host_to_net_u32 (h->export_time);
142 stream = &frm->streams[fr->stream_index];
144 /* FIXUP: message header sequence_number. Templates do not increase it */
145 h->sequence_number = clib_host_to_net_u32 (stream->sequence_number);
147 /* FIXUP: udp length */
148 udp->length = clib_host_to_net_u16 (b0->current_length - sizeof (*ip));
150 if (frm->udp_checksum)
152 /* RFC 7011 section 10.3.2. */
153 udp->checksum = ip4_tcp_udp_compute_checksum (vm, b0, ip);
154 if (udp->checksum == 0)
155 udp->checksum = 0xffff;
158 *buffer_indexp = bi0;
160 fr->last_template_sent = vlib_time_now (vm);
166 vnet_flow_rewrite_generic_callback (flow_report_main_t * frm,
168 ip4_address_t * collector_address,
169 ip4_address_t * src_address,
171 ipfix_report_element_t * report_elts,
172 u32 n_elts, u32 * stream_indexp)
176 ipfix_message_header_t *h;
177 ipfix_set_header_t *s;
178 ipfix_template_header_t *t;
179 ipfix_field_specifier_t *f;
180 ipfix_field_specifier_t *first_field;
182 ip4_ipfix_template_packet_t *tp;
183 flow_report_stream_t *stream;
185 ipfix_report_element_t *ep;
187 ASSERT (stream_indexp);
189 ASSERT (report_elts);
191 stream = &frm->streams[fr->stream_index];
192 *stream_indexp = fr->stream_index;
194 /* allocate rewrite space */
195 vec_validate_aligned (rewrite,
196 sizeof (ip4_ipfix_template_packet_t)
197 + n_elts * sizeof (ipfix_field_specifier_t) - 1,
198 CLIB_CACHE_LINE_BYTES);
200 /* create the packet rewrite string */
201 tp = (ip4_ipfix_template_packet_t *) rewrite;
202 ip = (ip4_header_t *) & tp->ip4;
203 udp = (udp_header_t *) (ip + 1);
204 h = (ipfix_message_header_t *) (udp + 1);
205 s = (ipfix_set_header_t *) (h + 1);
206 t = (ipfix_template_header_t *) (s + 1);
207 first_field = f = (ipfix_field_specifier_t *) (t + 1);
209 ip->ip_version_and_header_length = 0x45;
211 ip->protocol = IP_PROTOCOL_UDP;
212 ip->src_address.as_u32 = src_address->as_u32;
213 ip->dst_address.as_u32 = collector_address->as_u32;
214 udp->src_port = clib_host_to_net_u16 (stream->src_port);
215 udp->dst_port = clib_host_to_net_u16 (collector_port);
216 udp->length = clib_host_to_net_u16 (vec_len (rewrite) - sizeof (*ip));
218 /* FIXUP LATER: message header export_time */
219 h->domain_id = clib_host_to_net_u32 (stream->domain_id);
223 for (i = 0; i < n_elts; i++)
225 f->e_id_length = ipfix_e_id_length (0, ep->info_element, ep->size);
230 /* Back to the template packet... */
231 ip = (ip4_header_t *) & tp->ip4;
232 udp = (udp_header_t *) (ip + 1);
234 ASSERT (f - first_field);
235 /* Field count in this template */
236 t->id_count = ipfix_id_count (fr->template_id, f - first_field);
238 /* set length in octets */
240 ipfix_set_id_length (2 /* set_id */ , (u8 *) f - (u8 *) s);
242 /* message length in octets */
243 h->version_length = version_length ((u8 *) f - (u8 *) h);
245 ip->length = clib_host_to_net_u16 ((u8 *) f - (u8 *) ip);
246 ip->checksum = ip4_header_checksum (ip);
252 flow_report_process (vlib_main_t * vm,
253 vlib_node_runtime_t * rt, vlib_frame_t * f)
255 flow_report_main_t *frm = &flow_report_main;
257 u32 ip4_lookup_node_index;
258 vlib_node_t *ip4_lookup_node;
259 vlib_frame_t *nf = 0;
264 f64 def_wait_time = 5.0;
267 uword *event_data = 0;
269 /* Wait for Godot... */
270 vlib_process_wait_for_event_or_clock (vm, 1e9);
271 event_type = vlib_process_get_events (vm, &event_data);
273 clib_warning ("bogus kickoff event received, %d", event_type);
274 vec_reset_length (event_data);
276 /* Enqueue pkts to ip4-lookup */
277 ip4_lookup_node = vlib_get_node_by_name (vm, (u8 *) "ip4-lookup");
278 ip4_lookup_node_index = ip4_lookup_node->index;
280 wait_time = def_wait_time;
284 vlib_process_wait_for_event_or_clock (vm, wait_time);
285 event_type = vlib_process_get_events (vm, &event_data);
286 vec_reset_length (event_data);
288 /* 5s delay by default, possibly reduced by template intervals */
289 wait_time = def_wait_time;
291 vec_foreach (fr, frm->reports)
294 now = vlib_time_now (vm);
296 /* Need to send a template packet? */
298 now > (fr->last_template_sent + frm->template_interval);
299 send_template += fr->last_template_sent == 0;
304 rv = send_template_packet (frm, fr, &template_bi);
309 /* decide if template should be sent sooner than current wait time */
311 (fr->last_template_sent + frm->template_interval) - now;
312 wait_time = clib_min (wait_time, next_template);
314 nf = vlib_get_frame_to_node (vm, ip4_lookup_node_index);
316 to_next = vlib_frame_vector_args (nf);
318 if (template_bi != ~0)
320 to_next[0] = template_bi;
325 nf = fr->flow_data_callback (frm, fr,
326 nf, to_next, ip4_lookup_node_index);
328 vlib_put_frame_to_node (vm, ip4_lookup_node_index, nf);
332 return 0; /* not so much */
336 VLIB_REGISTER_NODE (flow_report_process_node) = {
337 .function = flow_report_process,
338 .type = VLIB_NODE_TYPE_PROCESS,
339 .name = "flow-report-process",
344 vnet_flow_report_add_del (flow_report_main_t * frm,
345 vnet_flow_report_add_del_args_t * a,
349 int found_index = ~0;
351 flow_report_stream_t *stream;
354 si = find_stream (a->domain_id, a->src_port);
356 return VNET_API_ERROR_INVALID_VALUE;
357 if (si == -1 && a->is_add == 0)
358 return VNET_API_ERROR_NO_SUCH_ENTRY;
360 for (i = 0; i < vec_len (frm->reports); i++)
362 fr = vec_elt_at_index (frm->reports, i);
363 if (fr->opaque.as_uword == a->opaque.as_uword
364 && fr->rewrite_callback == a->rewrite_callback
365 && fr->flow_data_callback == a->flow_data_callback)
369 *template_id = fr->template_id;
376 if (found_index != ~0)
378 vec_delete (frm->reports, 1, found_index);
379 stream = &frm->streams[si];
381 if (stream->n_reports == 0)
385 return VNET_API_ERROR_NO_SUCH_ENTRY;
388 if (found_index != ~0)
389 return VNET_API_ERROR_VALUE_EXIST;
393 stream = add_stream ();
394 stream->domain_id = a->domain_id;
395 stream->src_port = a->src_port;
396 stream->sequence_number = 0;
397 stream->n_reports = 0;
398 si = stream - frm->streams;
401 stream = &frm->streams[si];
405 vec_add2 (frm->reports, fr, 1);
407 fr->stream_index = si;
408 fr->template_id = 256 + stream->next_template_no;
409 stream->next_template_no = (stream->next_template_no + 1) % (65536 - 256);
410 fr->update_rewrite = 1;
411 fr->opaque = a->opaque;
412 fr->rewrite_callback = a->rewrite_callback;
413 fr->flow_data_callback = a->flow_data_callback;
414 fr->report_elements = a->report_elements;
415 fr->n_report_elements = a->n_report_elements;
416 fr->stream_indexp = a->stream_indexp;
418 *template_id = fr->template_id;
424 flow_report_add_del_error_to_clib_error (int error)
430 case VNET_API_ERROR_NO_SUCH_ENTRY:
431 return clib_error_return (0, "Flow report not found");
432 case VNET_API_ERROR_VALUE_EXIST:
433 return clib_error_return (0, "Flow report already exists");
434 case VNET_API_ERROR_INVALID_VALUE:
435 return clib_error_return (0, "Expecting either still unused values "
436 "for both domain_id and src_port "
437 "or already used values for both fields");
439 return clib_error_return (0, "vnet_flow_report_add_del returned %d",
445 vnet_flow_reports_reset (flow_report_main_t * frm)
450 for (i = 0; i < vec_len (frm->streams); i++)
451 if (stream_index_valid (i))
452 frm->streams[i].sequence_number = 0;
454 vec_foreach (fr, frm->reports)
456 fr->update_rewrite = 1;
457 fr->last_template_sent = 0;
462 vnet_stream_reset (flow_report_main_t * frm, u32 stream_index)
466 frm->streams[stream_index].sequence_number = 0;
468 vec_foreach (fr, frm->reports)
469 if (frm->reports->stream_index == stream_index)
471 fr->update_rewrite = 1;
472 fr->last_template_sent = 0;
477 vnet_stream_change (flow_report_main_t * frm,
478 u32 old_domain_id, u16 old_src_port,
479 u32 new_domain_id, u16 new_src_port)
481 i32 stream_index = find_stream (old_domain_id, old_src_port);
482 if (stream_index < 0)
484 flow_report_stream_t *stream = &frm->streams[stream_index];
485 stream->domain_id = new_domain_id;
486 stream->src_port = new_src_port;
487 if (old_domain_id != new_domain_id || old_src_port != new_src_port)
488 vnet_stream_reset (frm, stream_index);
492 static clib_error_t *
493 set_ipfix_exporter_command_fn (vlib_main_t * vm,
494 unformat_input_t * input,
495 vlib_cli_command_t * cmd)
497 flow_report_main_t *frm = &flow_report_main;
498 ip4_address_t collector, src;
499 u16 collector_port = UDP_DST_PORT_ipfix;
503 collector.as_u32 = 0;
505 u32 path_mtu = 512; // RFC 7011 section 10.3.3.
506 u32 template_interval = 20;
509 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
511 if (unformat (input, "collector %U", unformat_ip4_address, &collector))
513 else if (unformat (input, "port %U", unformat_udp_port,
516 else if (unformat (input, "src %U", unformat_ip4_address, &src))
518 else if (unformat (input, "fib-id %u", &fib_id))
520 ip4_main_t *im = &ip4_main;
521 uword *p = hash_get (im->fib_index_by_table_id, fib_id);
523 return clib_error_return (0, "fib ID %d doesn't exist\n", fib_id);
526 else if (unformat (input, "path-mtu %u", &path_mtu))
528 else if (unformat (input, "template-interval %u", &template_interval))
530 else if (unformat (input, "udp-checksum"))
536 if (collector.as_u32 != 0 && src.as_u32 == 0)
537 return clib_error_return (0, "src address required");
539 if (path_mtu > 1450 /* vpp does not support fragmentation */ )
540 return clib_error_return (0, "too big path-mtu value, maximum is 1450");
543 return clib_error_return (0, "too small path-mtu value, minimum is 68");
545 /* Reset report streams if we are reconfiguring IP addresses */
546 if (frm->ipfix_collector.as_u32 != collector.as_u32 ||
547 frm->src_address.as_u32 != src.as_u32 ||
548 frm->collector_port != collector_port)
549 vnet_flow_reports_reset (frm);
551 frm->ipfix_collector.as_u32 = collector.as_u32;
552 frm->collector_port = collector_port;
553 frm->src_address.as_u32 = src.as_u32;
554 frm->fib_index = fib_index;
555 frm->path_mtu = path_mtu;
556 frm->template_interval = template_interval;
557 frm->udp_checksum = udp_checksum;
559 if (collector.as_u32)
560 vlib_cli_output (vm, "Collector %U, src address %U, "
561 "fib index %d, path MTU %u, "
562 "template resend interval %us, "
564 format_ip4_address, &frm->ipfix_collector,
565 format_ip4_address, &frm->src_address,
566 fib_index, path_mtu, template_interval,
567 udp_checksum ? "enabled" : "disabled");
569 vlib_cli_output (vm, "IPFIX Collector is disabled");
571 /* Turn on the flow reporting process */
572 vlib_process_signal_event (vm, flow_report_process_node.index, 1, 0);
577 VLIB_CLI_COMMAND (set_ipfix_exporter_command, static) = {
578 .path = "set ipfix exporter",
579 .short_help = "set ipfix exporter "
580 "collector <ip4-address> [port <port>] "
581 "src <ip4-address> [fib-id <fib-id>] "
582 "[path-mtu <path-mtu>] "
583 "[template-interval <template-interval>] "
585 .function = set_ipfix_exporter_command_fn,
590 static clib_error_t *
591 ipfix_flush_command_fn (vlib_main_t * vm,
592 unformat_input_t * input, vlib_cli_command_t * cmd)
594 /* poke the flow reporting process */
595 vlib_process_signal_event (vm, flow_report_process_node.index, 1, 0);
600 VLIB_CLI_COMMAND (ipfix_flush_command, static) = {
601 .path = "ipfix flush",
602 .short_help = "flush the current ipfix data [for make test]",
603 .function = ipfix_flush_command_fn,
607 static clib_error_t *
608 flow_report_init (vlib_main_t * vm)
610 flow_report_main_t *frm = &flow_report_main;
613 frm->vnet_main = vnet_get_main ();
614 frm->unix_time_0 = time (0);
615 frm->vlib_time_0 = vlib_time_now (frm->vlib_main);
621 VLIB_INIT_FUNCTION (flow_report_init);
623 * fd.io coding-style-patch-verification: ON
626 * eval: (c-set-style "gnu")