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 (ipfix_exporter_t *exp, u32 index)
27 return index < vec_len (exp->streams) && exp->streams[index].domain_id != ~0;
30 static_always_inline flow_report_stream_t *
31 add_stream (ipfix_exporter_t *exp)
34 for (i = 0; i < vec_len (exp->streams); i++)
35 if (!stream_index_valid (exp, i))
36 return &exp->streams[i];
37 u32 index = vec_len (exp->streams);
38 vec_validate (exp->streams, index);
39 return &exp->streams[index];
42 static_always_inline void
43 delete_stream (ipfix_exporter_t *exp, u32 index)
45 ASSERT (index < vec_len (exp->streams));
46 ASSERT (exp->streams[index].domain_id != ~0);
47 exp->streams[index].domain_id = ~0;
51 find_stream (ipfix_exporter_t *exp, u32 domain_id, u16 src_port)
53 flow_report_stream_t *stream;
55 for (i = 0; i < vec_len (exp->streams); i++)
56 if (stream_index_valid (exp, i))
58 stream = &exp->streams[i];
59 if (domain_id == stream->domain_id)
61 if (src_port != stream->src_port)
65 else if (src_port == stream->src_port)
74 send_template_packet (flow_report_main_t * frm,
75 flow_report_t * fr, u32 * buffer_indexp)
79 ip4_ipfix_template_packet_t *tp;
80 ipfix_message_header_t *h;
83 vlib_main_t *vm = frm->vlib_main;
84 flow_report_stream_t *stream;
85 ipfix_exporter_t *exp = pool_elt_at_index (frm->exporters, 0);
87 ASSERT (buffer_indexp);
89 if (fr->update_rewrite || fr->rewrite == 0)
91 if (exp->ipfix_collector.as_u32 == 0 || exp->src_address.as_u32 == 0)
93 vlib_node_set_state (frm->vlib_main, flow_report_process_node.index,
94 VLIB_NODE_STATE_DISABLED);
97 vec_free (fr->rewrite);
98 fr->update_rewrite = 1;
101 if (fr->update_rewrite)
103 fr->rewrite = fr->rewrite_callback (
104 exp, fr, &exp->ipfix_collector, &exp->src_address, exp->collector_port,
105 fr->report_elements, fr->n_report_elements, fr->stream_indexp);
106 fr->update_rewrite = 0;
109 if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
112 b0 = vlib_get_buffer (vm, bi0);
114 ASSERT (vec_len (fr->rewrite) < vlib_buffer_get_default_data_size (vm));
116 clib_memcpy_fast (b0->data, fr->rewrite, vec_len (fr->rewrite));
117 b0->current_data = 0;
118 b0->current_length = vec_len (fr->rewrite);
119 b0->flags |= (VLIB_BUFFER_TOTAL_LENGTH_VALID | VNET_BUFFER_F_FLOW_REPORT);
120 vnet_buffer (b0)->sw_if_index[VLIB_RX] = 0;
121 vnet_buffer (b0)->sw_if_index[VLIB_TX] = exp->fib_index;
123 tp = vlib_buffer_get_current (b0);
124 ip = (ip4_header_t *) & tp->ip4;
125 udp = (udp_header_t *) (ip + 1);
126 h = (ipfix_message_header_t *) (udp + 1);
128 /* FIXUP: message header export_time */
129 h->export_time = (u32)
130 (((f64) frm->unix_time_0) +
131 (vlib_time_now (frm->vlib_main) - frm->vlib_time_0));
132 h->export_time = clib_host_to_net_u32 (h->export_time);
134 stream = &exp->streams[fr->stream_index];
136 /* FIXUP: message header sequence_number. Templates do not increase it */
137 h->sequence_number = clib_host_to_net_u32 (stream->sequence_number);
139 /* FIXUP: udp length */
140 udp->length = clib_host_to_net_u16 (b0->current_length - sizeof (*ip));
142 if (exp->udp_checksum)
144 /* RFC 7011 section 10.3.2. */
145 udp->checksum = ip4_tcp_udp_compute_checksum (vm, b0, ip);
146 if (udp->checksum == 0)
147 udp->checksum = 0xffff;
150 *buffer_indexp = bi0;
152 fr->last_template_sent = vlib_time_now (vm);
158 vnet_flow_rewrite_generic_callback (ipfix_exporter_t *exp, flow_report_t *fr,
159 ip4_address_t *collector_address,
160 ip4_address_t *src_address,
162 ipfix_report_element_t *report_elts,
163 u32 n_elts, u32 *stream_indexp)
167 ipfix_message_header_t *h;
168 ipfix_set_header_t *s;
169 ipfix_template_header_t *t;
170 ipfix_field_specifier_t *f;
171 ipfix_field_specifier_t *first_field;
173 ip4_ipfix_template_packet_t *tp;
174 flow_report_stream_t *stream;
176 ipfix_report_element_t *ep;
178 ASSERT (stream_indexp);
180 ASSERT (report_elts);
182 stream = &exp->streams[fr->stream_index];
183 *stream_indexp = fr->stream_index;
185 /* allocate rewrite space */
186 vec_validate_aligned (rewrite,
187 sizeof (ip4_ipfix_template_packet_t)
188 + n_elts * sizeof (ipfix_field_specifier_t) - 1,
189 CLIB_CACHE_LINE_BYTES);
191 /* create the packet rewrite string */
192 tp = (ip4_ipfix_template_packet_t *) rewrite;
193 ip = (ip4_header_t *) & tp->ip4;
194 udp = (udp_header_t *) (ip + 1);
195 h = (ipfix_message_header_t *) (udp + 1);
196 s = (ipfix_set_header_t *) (h + 1);
197 t = (ipfix_template_header_t *) (s + 1);
198 first_field = f = (ipfix_field_specifier_t *) (t + 1);
200 ip->ip_version_and_header_length = 0x45;
202 ip->protocol = IP_PROTOCOL_UDP;
203 ip->src_address.as_u32 = src_address->as_u32;
204 ip->dst_address.as_u32 = collector_address->as_u32;
205 udp->src_port = clib_host_to_net_u16 (stream->src_port);
206 udp->dst_port = clib_host_to_net_u16 (collector_port);
207 udp->length = clib_host_to_net_u16 (vec_len (rewrite) - sizeof (*ip));
209 /* FIXUP LATER: message header export_time */
210 h->domain_id = clib_host_to_net_u32 (stream->domain_id);
214 for (i = 0; i < n_elts; i++)
216 f->e_id_length = ipfix_e_id_length (0, ep->info_element, ep->size);
221 /* Back to the template packet... */
222 ip = (ip4_header_t *) & tp->ip4;
223 udp = (udp_header_t *) (ip + 1);
225 ASSERT (f - first_field);
226 /* Field count in this template */
227 t->id_count = ipfix_id_count (fr->template_id, f - first_field);
229 /* set length in octets */
231 ipfix_set_id_length (2 /* set_id */ , (u8 *) f - (u8 *) s);
233 /* message length in octets */
234 h->version_length = version_length ((u8 *) f - (u8 *) h);
236 ip->length = clib_host_to_net_u16 ((u8 *) f - (u8 *) ip);
237 ip->checksum = ip4_header_checksum (ip);
243 flow_report_process (vlib_main_t * vm,
244 vlib_node_runtime_t * rt, vlib_frame_t * f)
246 flow_report_main_t *frm = &flow_report_main;
248 u32 ip4_lookup_node_index;
249 vlib_node_t *ip4_lookup_node;
250 vlib_frame_t *nf = 0;
255 f64 def_wait_time = 5.0;
258 uword *event_data = 0;
260 /* Wait for Godot... */
261 vlib_process_wait_for_event_or_clock (vm, 1e9);
262 event_type = vlib_process_get_events (vm, &event_data);
264 clib_warning ("bogus kickoff event received, %d", event_type);
265 vec_reset_length (event_data);
267 /* Enqueue pkts to ip4-lookup */
268 ip4_lookup_node = vlib_get_node_by_name (vm, (u8 *) "ip4-lookup");
269 ip4_lookup_node_index = ip4_lookup_node->index;
271 wait_time = def_wait_time;
275 vlib_process_wait_for_event_or_clock (vm, wait_time);
276 event_type = vlib_process_get_events (vm, &event_data);
277 vec_reset_length (event_data);
278 ipfix_exporter_t *exp = pool_elt_at_index (frm->exporters, 0);
280 /* 5s delay by default, possibly reduced by template intervals */
281 wait_time = def_wait_time;
283 vec_foreach (fr, exp->reports)
286 now = vlib_time_now (vm);
288 /* Need to send a template packet? */
290 now > (fr->last_template_sent + exp->template_interval);
291 send_template += fr->last_template_sent == 0;
296 rv = send_template_packet (frm, fr, &template_bi);
301 /* decide if template should be sent sooner than current wait time */
303 (fr->last_template_sent + exp->template_interval) - now;
304 wait_time = clib_min (wait_time, next_template);
306 nf = vlib_get_frame_to_node (vm, ip4_lookup_node_index);
308 to_next = vlib_frame_vector_args (nf);
310 if (template_bi != ~0)
312 to_next[0] = template_bi;
317 nf = fr->flow_data_callback (frm, exp, fr, nf, to_next,
318 ip4_lookup_node_index);
320 vlib_put_frame_to_node (vm, ip4_lookup_node_index, nf);
324 return 0; /* not so much */
328 VLIB_REGISTER_NODE (flow_report_process_node) = {
329 .function = flow_report_process,
330 .type = VLIB_NODE_TYPE_PROCESS,
331 .name = "flow-report-process",
336 vnet_flow_report_add_del (ipfix_exporter_t *exp,
337 vnet_flow_report_add_del_args_t *a, u16 *template_id)
340 int found_index = ~0;
342 flow_report_stream_t *stream;
345 si = find_stream (exp, a->domain_id, a->src_port);
347 return VNET_API_ERROR_INVALID_VALUE;
348 if (si == -1 && a->is_add == 0)
349 return VNET_API_ERROR_NO_SUCH_ENTRY;
351 for (i = 0; i < vec_len (exp->reports); i++)
353 fr = vec_elt_at_index (exp->reports, i);
354 if (fr->opaque.as_uword == a->opaque.as_uword
355 && fr->rewrite_callback == a->rewrite_callback
356 && fr->flow_data_callback == a->flow_data_callback)
360 *template_id = fr->template_id;
367 if (found_index != ~0)
369 vec_delete (exp->reports, 1, found_index);
370 stream = &exp->streams[si];
372 if (stream->n_reports == 0)
373 delete_stream (exp, si);
376 return VNET_API_ERROR_NO_SUCH_ENTRY;
379 if (found_index != ~0)
380 return VNET_API_ERROR_VALUE_EXIST;
384 stream = add_stream (exp);
385 stream->domain_id = a->domain_id;
386 stream->src_port = a->src_port;
387 stream->sequence_number = 0;
388 stream->n_reports = 0;
389 si = stream - exp->streams;
392 stream = &exp->streams[si];
396 vec_add2 (exp->reports, fr, 1);
398 fr->stream_index = si;
399 fr->template_id = 256 + stream->next_template_no;
400 stream->next_template_no = (stream->next_template_no + 1) % (65536 - 256);
401 fr->update_rewrite = 1;
402 fr->opaque = a->opaque;
403 fr->rewrite_callback = a->rewrite_callback;
404 fr->flow_data_callback = a->flow_data_callback;
405 fr->report_elements = a->report_elements;
406 fr->n_report_elements = a->n_report_elements;
407 fr->stream_indexp = a->stream_indexp;
409 *template_id = fr->template_id;
415 flow_report_add_del_error_to_clib_error (int error)
421 case VNET_API_ERROR_NO_SUCH_ENTRY:
422 return clib_error_return (0, "Flow report not found");
423 case VNET_API_ERROR_VALUE_EXIST:
424 return clib_error_return (0, "Flow report already exists");
425 case VNET_API_ERROR_INVALID_VALUE:
426 return clib_error_return (0, "Expecting either still unused values "
427 "for both domain_id and src_port "
428 "or already used values for both fields");
430 return clib_error_return (0, "vnet_flow_report_add_del returned %d",
436 vnet_flow_reports_reset (ipfix_exporter_t *exp)
441 for (i = 0; i < vec_len (exp->streams); i++)
442 if (stream_index_valid (exp, i))
443 exp->streams[i].sequence_number = 0;
445 vec_foreach (fr, exp->reports)
447 fr->update_rewrite = 1;
448 fr->last_template_sent = 0;
453 vnet_stream_reset (ipfix_exporter_t *exp, u32 stream_index)
457 exp->streams[stream_index].sequence_number = 0;
459 vec_foreach (fr, exp->reports)
460 if (exp->reports->stream_index == stream_index)
462 fr->update_rewrite = 1;
463 fr->last_template_sent = 0;
468 vnet_stream_change (ipfix_exporter_t *exp, u32 old_domain_id, u16 old_src_port,
469 u32 new_domain_id, u16 new_src_port)
471 i32 stream_index = find_stream (exp, old_domain_id, old_src_port);
473 if (stream_index < 0)
475 flow_report_stream_t *stream = &exp->streams[stream_index];
476 stream->domain_id = new_domain_id;
477 stream->src_port = new_src_port;
478 if (old_domain_id != new_domain_id || old_src_port != new_src_port)
479 vnet_stream_reset (exp, stream_index);
483 static clib_error_t *
484 set_ipfix_exporter_command_fn (vlib_main_t * vm,
485 unformat_input_t * input,
486 vlib_cli_command_t * cmd)
488 flow_report_main_t *frm = &flow_report_main;
489 ip4_address_t collector, src;
490 u16 collector_port = UDP_DST_PORT_ipfix;
494 collector.as_u32 = 0;
496 u32 path_mtu = 512; // RFC 7011 section 10.3.3.
497 u32 template_interval = 20;
499 ipfix_exporter_t *exp = pool_elt_at_index (frm->exporters, 0);
501 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
503 if (unformat (input, "collector %U", unformat_ip4_address, &collector))
505 else if (unformat (input, "port %U", unformat_udp_port,
508 else if (unformat (input, "src %U", unformat_ip4_address, &src))
510 else if (unformat (input, "fib-id %u", &fib_id))
512 ip4_main_t *im = &ip4_main;
513 uword *p = hash_get (im->fib_index_by_table_id, fib_id);
515 return clib_error_return (0, "fib ID %d doesn't exist\n", fib_id);
518 else if (unformat (input, "path-mtu %u", &path_mtu))
520 else if (unformat (input, "template-interval %u", &template_interval))
522 else if (unformat (input, "udp-checksum"))
528 if (collector.as_u32 != 0 && src.as_u32 == 0)
529 return clib_error_return (0, "src address required");
531 if (path_mtu > 1450 /* vpp does not support fragmentation */ )
532 return clib_error_return (0, "too big path-mtu value, maximum is 1450");
535 return clib_error_return (0, "too small path-mtu value, minimum is 68");
537 /* Reset report streams if we are reconfiguring IP addresses */
538 if (exp->ipfix_collector.as_u32 != collector.as_u32 ||
539 exp->src_address.as_u32 != src.as_u32 ||
540 exp->collector_port != collector_port)
541 vnet_flow_reports_reset (exp);
543 exp->ipfix_collector.as_u32 = collector.as_u32;
544 exp->collector_port = collector_port;
545 exp->src_address.as_u32 = src.as_u32;
546 exp->fib_index = fib_index;
547 exp->path_mtu = path_mtu;
548 exp->template_interval = template_interval;
549 exp->udp_checksum = udp_checksum;
551 if (collector.as_u32)
553 "Collector %U, src address %U, "
554 "fib index %d, path MTU %u, "
555 "template resend interval %us, "
557 format_ip4_address, exp->ipfix_collector,
558 format_ip4_address, exp->src_address, fib_index, path_mtu,
559 template_interval, udp_checksum ? "enabled" : "disabled");
561 vlib_cli_output (vm, "IPFIX Collector is disabled");
563 /* Turn on the flow reporting process */
564 vlib_process_signal_event (vm, flow_report_process_node.index, 1, 0);
569 VLIB_CLI_COMMAND (set_ipfix_exporter_command, static) = {
570 .path = "set ipfix exporter",
571 .short_help = "set ipfix exporter "
572 "collector <ip4-address> [port <port>] "
573 "src <ip4-address> [fib-id <fib-id>] "
574 "[path-mtu <path-mtu>] "
575 "[template-interval <template-interval>] "
577 .function = set_ipfix_exporter_command_fn,
582 static clib_error_t *
583 ipfix_flush_command_fn (vlib_main_t * vm,
584 unformat_input_t * input, vlib_cli_command_t * cmd)
586 /* poke the flow reporting process */
587 vlib_process_signal_event (vm, flow_report_process_node.index, 1, 0);
592 VLIB_CLI_COMMAND (ipfix_flush_command, static) = {
593 .path = "ipfix flush",
594 .short_help = "flush the current ipfix data [for make test]",
595 .function = ipfix_flush_command_fn,
599 static clib_error_t *
600 flow_report_init (vlib_main_t * vm)
602 flow_report_main_t *frm = &flow_report_main;
603 ipfix_exporter_t *exp;
606 frm->vnet_main = vnet_get_main ();
607 frm->unix_time_0 = time (0);
608 frm->vlib_time_0 = vlib_time_now (frm->vlib_main);
610 * Make sure that we can always access the first exporter for
611 * backwards compatibility reasons.
613 pool_alloc (frm->exporters, IPFIX_EXPORTERS_MAX);
614 pool_get (frm->exporters, exp);
615 /* Verify that this is at index 0 */
616 ASSERT (frm->exporters == exp);
621 VLIB_INIT_FUNCTION (flow_report_init);
623 * fd.io coding-style-patch-verification: ON
626 * eval: (c-set-style "gnu")