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>
21 flow_report_main_t flow_report_main;
23 static_always_inline u8
24 stream_index_valid (u32 index)
26 flow_report_main_t *frm = &flow_report_main;
27 return index < vec_len (frm->streams) &&
28 frm->streams[index].domain_id != ~0;
31 static_always_inline flow_report_stream_t *
34 flow_report_main_t *frm = &flow_report_main;
36 for (i = 0; i < vec_len (frm->streams); i++)
37 if (!stream_index_valid (i))
38 return &frm->streams[i];
39 u32 index = vec_len (frm->streams);
40 vec_validate (frm->streams, index);
41 return &frm->streams[index];
44 static_always_inline void
45 delete_stream (u32 index)
47 flow_report_main_t *frm = &flow_report_main;
48 ASSERT (index < vec_len (frm->streams));
49 ASSERT (frm->streams[index].domain_id != ~0);
50 frm->streams[index].domain_id = ~0;
54 find_stream (u32 domain_id, u16 src_port)
56 flow_report_main_t *frm = &flow_report_main;
57 flow_report_stream_t *stream;
59 for (i = 0; i < vec_len (frm->streams); i++)
60 if (stream_index_valid (i))
62 stream = &frm->streams[i];
63 if (domain_id == stream->domain_id)
65 if (src_port != stream->src_port)
69 else if (src_port == stream->src_port)
78 send_template_packet (flow_report_main_t * frm,
79 flow_report_t * fr, u32 * buffer_indexp)
83 ip4_ipfix_template_packet_t *tp;
84 ipfix_message_header_t *h;
87 vlib_main_t *vm = frm->vlib_main;
88 flow_report_stream_t *stream;
90 ASSERT (buffer_indexp);
92 if (fr->update_rewrite || fr->rewrite == 0)
94 if (frm->ipfix_collector.as_u32 == 0 || frm->src_address.as_u32 == 0)
96 vlib_node_set_state (frm->vlib_main, flow_report_process_node.index,
97 VLIB_NODE_STATE_DISABLED);
100 vec_free (fr->rewrite);
101 fr->update_rewrite = 1;
104 if (fr->update_rewrite)
106 fr->rewrite = fr->rewrite_callback (frm, fr,
107 &frm->ipfix_collector,
111 fr->n_report_elements,
113 fr->update_rewrite = 0;
116 if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
119 b0 = vlib_get_buffer (vm, bi0);
121 /* Initialize the buffer */
122 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
124 ASSERT (vec_len (fr->rewrite) < vlib_buffer_get_default_data_size (vm));
126 clib_memcpy_fast (b0->data, fr->rewrite, vec_len (fr->rewrite));
127 b0->current_data = 0;
128 b0->current_length = vec_len (fr->rewrite);
129 b0->flags |= (VLIB_BUFFER_TOTAL_LENGTH_VALID | VNET_BUFFER_F_FLOW_REPORT);
130 vnet_buffer (b0)->sw_if_index[VLIB_RX] = 0;
131 vnet_buffer (b0)->sw_if_index[VLIB_TX] = frm->fib_index;
133 tp = vlib_buffer_get_current (b0);
134 ip = (ip4_header_t *) & tp->ip4;
135 udp = (udp_header_t *) (ip + 1);
136 h = (ipfix_message_header_t *) (udp + 1);
138 /* FIXUP: message header export_time */
139 h->export_time = (u32)
140 (((f64) frm->unix_time_0) +
141 (vlib_time_now (frm->vlib_main) - frm->vlib_time_0));
142 h->export_time = clib_host_to_net_u32 (h->export_time);
144 stream = &frm->streams[fr->stream_index];
146 /* FIXUP: message header sequence_number. Templates do not increase it */
147 h->sequence_number = clib_host_to_net_u32 (stream->sequence_number);
149 /* FIXUP: udp length */
150 udp->length = clib_host_to_net_u16 (b0->current_length - sizeof (*ip));
152 if (frm->udp_checksum)
154 /* RFC 7011 section 10.3.2. */
155 udp->checksum = ip4_tcp_udp_compute_checksum (vm, b0, ip);
156 if (udp->checksum == 0)
157 udp->checksum = 0xffff;
160 *buffer_indexp = bi0;
162 fr->last_template_sent = vlib_time_now (vm);
168 vnet_flow_rewrite_generic_callback (flow_report_main_t * frm,
170 ip4_address_t * collector_address,
171 ip4_address_t * src_address,
173 ipfix_report_element_t * report_elts,
174 u32 n_elts, u32 * stream_indexp)
178 ipfix_message_header_t *h;
179 ipfix_set_header_t *s;
180 ipfix_template_header_t *t;
181 ipfix_field_specifier_t *f;
182 ipfix_field_specifier_t *first_field;
184 ip4_ipfix_template_packet_t *tp;
185 flow_report_stream_t *stream;
187 ipfix_report_element_t *ep;
189 ASSERT (stream_indexp);
191 ASSERT (report_elts);
193 stream = &frm->streams[fr->stream_index];
194 *stream_indexp = fr->stream_index;
196 /* allocate rewrite space */
197 vec_validate_aligned (rewrite,
198 sizeof (ip4_ipfix_template_packet_t)
199 + n_elts * sizeof (ipfix_field_specifier_t) - 1,
200 CLIB_CACHE_LINE_BYTES);
202 /* create the packet rewrite string */
203 tp = (ip4_ipfix_template_packet_t *) rewrite;
204 ip = (ip4_header_t *) & tp->ip4;
205 udp = (udp_header_t *) (ip + 1);
206 h = (ipfix_message_header_t *) (udp + 1);
207 s = (ipfix_set_header_t *) (h + 1);
208 t = (ipfix_template_header_t *) (s + 1);
209 first_field = f = (ipfix_field_specifier_t *) (t + 1);
211 ip->ip_version_and_header_length = 0x45;
213 ip->protocol = IP_PROTOCOL_UDP;
214 ip->src_address.as_u32 = src_address->as_u32;
215 ip->dst_address.as_u32 = collector_address->as_u32;
216 udp->src_port = clib_host_to_net_u16 (stream->src_port);
217 udp->dst_port = clib_host_to_net_u16 (collector_port);
218 udp->length = clib_host_to_net_u16 (vec_len (rewrite) - sizeof (*ip));
220 /* FIXUP LATER: message header export_time */
221 h->domain_id = clib_host_to_net_u32 (stream->domain_id);
225 for (i = 0; i < n_elts; i++)
227 f->e_id_length = ipfix_e_id_length (0, ep->info_element, ep->size);
232 /* Back to the template packet... */
233 ip = (ip4_header_t *) & tp->ip4;
234 udp = (udp_header_t *) (ip + 1);
236 ASSERT (f - first_field);
237 /* Field count in this template */
238 t->id_count = ipfix_id_count (fr->template_id, f - first_field);
240 /* set length in octets */
242 ipfix_set_id_length (2 /* set_id */ , (u8 *) f - (u8 *) s);
244 /* message length in octets */
245 h->version_length = version_length ((u8 *) f - (u8 *) h);
247 ip->length = clib_host_to_net_u16 ((u8 *) f - (u8 *) ip);
248 ip->checksum = ip4_header_checksum (ip);
254 flow_report_process (vlib_main_t * vm,
255 vlib_node_runtime_t * rt, vlib_frame_t * f)
257 flow_report_main_t *frm = &flow_report_main;
259 u32 ip4_lookup_node_index;
260 vlib_node_t *ip4_lookup_node;
261 vlib_frame_t *nf = 0;
268 uword *event_data = 0;
270 /* Wait for Godot... */
271 vlib_process_wait_for_event_or_clock (vm, 1e9);
272 event_type = vlib_process_get_events (vm, &event_data);
274 clib_warning ("bogus kickoff event received, %d", event_type);
275 vec_reset_length (event_data);
277 /* Enqueue pkts to ip4-lookup */
278 ip4_lookup_node = vlib_get_node_by_name (vm, (u8 *) "ip4-lookup");
279 ip4_lookup_node_index = ip4_lookup_node->index;
283 vlib_process_wait_for_event_or_clock (vm, 5.0);
284 event_type = vlib_process_get_events (vm, &event_data);
285 vec_reset_length (event_data);
287 vec_foreach (fr, frm->reports)
289 now = vlib_time_now (vm);
291 /* Need to send a template packet? */
293 now > (fr->last_template_sent + frm->template_interval);
294 send_template += fr->last_template_sent == 0;
299 rv = send_template_packet (frm, fr, &template_bi);
304 nf = vlib_get_frame_to_node (vm, ip4_lookup_node_index);
306 to_next = vlib_frame_vector_args (nf);
308 if (template_bi != ~0)
310 to_next[0] = template_bi;
315 nf = fr->flow_data_callback (frm, fr,
316 nf, to_next, ip4_lookup_node_index);
318 vlib_put_frame_to_node (vm, ip4_lookup_node_index, nf);
322 return 0; /* not so much */
326 VLIB_REGISTER_NODE (flow_report_process_node) = {
327 .function = flow_report_process,
328 .type = VLIB_NODE_TYPE_PROCESS,
329 .name = "flow-report-process",
334 vnet_flow_report_add_del (flow_report_main_t * frm,
335 vnet_flow_report_add_del_args_t * a,
339 int found_index = ~0;
341 flow_report_stream_t *stream;
344 si = find_stream (a->domain_id, a->src_port);
346 return VNET_API_ERROR_INVALID_VALUE;
347 if (si == -1 && a->is_add == 0)
348 return VNET_API_ERROR_NO_SUCH_ENTRY;
350 for (i = 0; i < vec_len (frm->reports); i++)
352 fr = vec_elt_at_index (frm->reports, i);
353 if (fr->opaque.as_uword == a->opaque.as_uword
354 && fr->rewrite_callback == a->rewrite_callback
355 && fr->flow_data_callback == a->flow_data_callback)
359 *template_id = fr->template_id;
366 if (found_index != ~0)
368 vec_delete (frm->reports, 1, found_index);
369 stream = &frm->streams[si];
371 if (stream->n_reports == 0)
375 return VNET_API_ERROR_NO_SUCH_ENTRY;
378 if (found_index != ~0)
379 return VNET_API_ERROR_VALUE_EXIST;
383 stream = add_stream ();
384 stream->domain_id = a->domain_id;
385 stream->src_port = a->src_port;
386 stream->sequence_number = 0;
387 stream->n_reports = 0;
388 si = stream - frm->streams;
391 stream = &frm->streams[si];
395 vec_add2 (frm->reports, fr, 1);
397 fr->stream_index = si;
398 fr->template_id = 256 + stream->next_template_no;
399 stream->next_template_no = (stream->next_template_no + 1) % (65536 - 256);
400 fr->update_rewrite = 1;
401 fr->opaque = a->opaque;
402 fr->rewrite_callback = a->rewrite_callback;
403 fr->flow_data_callback = a->flow_data_callback;
404 fr->report_elements = a->report_elements;
405 fr->n_report_elements = a->n_report_elements;
406 fr->stream_indexp = a->stream_indexp;
408 *template_id = fr->template_id;
414 flow_report_add_del_error_to_clib_error (int error)
420 case VNET_API_ERROR_NO_SUCH_ENTRY:
421 return clib_error_return (0, "Flow report not found");
422 case VNET_API_ERROR_VALUE_EXIST:
423 return clib_error_return (0, "Flow report already exists");
424 case VNET_API_ERROR_INVALID_VALUE:
425 return clib_error_return (0, "Expecting either still unused values "
426 "for both domain_id and src_port "
427 "or already used values for both fields");
429 return clib_error_return (0, "vnet_flow_report_add_del returned %d",
435 vnet_flow_reports_reset (flow_report_main_t * frm)
440 for (i = 0; i < vec_len (frm->streams); i++)
441 if (stream_index_valid (i))
442 frm->streams[i].sequence_number = 0;
444 vec_foreach (fr, frm->reports)
446 fr->update_rewrite = 1;
447 fr->last_template_sent = 0;
452 vnet_stream_reset (flow_report_main_t * frm, u32 stream_index)
456 frm->streams[stream_index].sequence_number = 0;
458 vec_foreach (fr, frm->reports)
459 if (frm->reports->stream_index == stream_index)
461 fr->update_rewrite = 1;
462 fr->last_template_sent = 0;
467 vnet_stream_change (flow_report_main_t * frm,
468 u32 old_domain_id, u16 old_src_port,
469 u32 new_domain_id, u16 new_src_port)
471 i32 stream_index = find_stream (old_domain_id, old_src_port);
472 if (stream_index < 0)
474 flow_report_stream_t *stream = &frm->streams[stream_index];
475 stream->domain_id = new_domain_id;
476 stream->src_port = new_src_port;
477 if (old_domain_id != new_domain_id || old_src_port != new_src_port)
478 vnet_stream_reset (frm, stream_index);
482 static clib_error_t *
483 set_ipfix_exporter_command_fn (vlib_main_t * vm,
484 unformat_input_t * input,
485 vlib_cli_command_t * cmd)
487 flow_report_main_t *frm = &flow_report_main;
488 ip4_address_t collector, src;
489 u16 collector_port = UDP_DST_PORT_ipfix;
493 collector.as_u32 = 0;
495 u32 path_mtu = 512; // RFC 7011 section 10.3.3.
496 u32 template_interval = 20;
499 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
501 if (unformat (input, "collector %U", unformat_ip4_address, &collector))
503 else if (unformat (input, "port %u", &collector_port))
505 else if (unformat (input, "src %U", unformat_ip4_address, &src))
507 else if (unformat (input, "fib-id %u", &fib_id))
509 ip4_main_t *im = &ip4_main;
510 uword *p = hash_get (im->fib_index_by_table_id, fib_id);
512 return clib_error_return (0, "fib ID %d doesn't exist\n", fib_id);
515 else if (unformat (input, "path-mtu %u", &path_mtu))
517 else if (unformat (input, "template-interval %u", &template_interval))
519 else if (unformat (input, "udp-checksum"))
525 if (collector.as_u32 != 0 && src.as_u32 == 0)
526 return clib_error_return (0, "src address required");
528 if (path_mtu > 1450 /* vpp does not support fragmentation */ )
529 return clib_error_return (0, "too big path-mtu value, maximum is 1450");
532 return clib_error_return (0, "too small path-mtu value, minimum is 68");
534 /* Reset report streams if we are reconfiguring IP addresses */
535 if (frm->ipfix_collector.as_u32 != collector.as_u32 ||
536 frm->src_address.as_u32 != src.as_u32 ||
537 frm->collector_port != collector_port)
538 vnet_flow_reports_reset (frm);
540 frm->ipfix_collector.as_u32 = collector.as_u32;
541 frm->collector_port = collector_port;
542 frm->src_address.as_u32 = src.as_u32;
543 frm->fib_index = fib_index;
544 frm->path_mtu = path_mtu;
545 frm->template_interval = template_interval;
546 frm->udp_checksum = udp_checksum;
548 if (collector.as_u32)
549 vlib_cli_output (vm, "Collector %U, src address %U, "
550 "fib index %d, path MTU %u, "
551 "template resend interval %us, "
553 format_ip4_address, &frm->ipfix_collector,
554 format_ip4_address, &frm->src_address,
555 fib_index, path_mtu, template_interval,
556 udp_checksum ? "enabled" : "disabled");
558 vlib_cli_output (vm, "IPFIX Collector is disabled");
560 /* Turn on the flow reporting process */
561 vlib_process_signal_event (vm, flow_report_process_node.index, 1, 0);
566 VLIB_CLI_COMMAND (set_ipfix_exporter_command, static) = {
567 .path = "set ipfix exporter",
568 .short_help = "set ipfix exporter "
569 "collector <ip4-address> [port <port>] "
570 "src <ip4-address> [fib-id <fib-id>] "
571 "[path-mtu <path-mtu>] "
572 "[template-interval <template-interval>]",
574 .function = set_ipfix_exporter_command_fn,
579 static clib_error_t *
580 ipfix_flush_command_fn (vlib_main_t * vm,
581 unformat_input_t * input, vlib_cli_command_t * cmd)
583 /* poke the flow reporting process */
584 vlib_process_signal_event (vm, flow_report_process_node.index, 1, 0);
589 VLIB_CLI_COMMAND (ipfix_flush_command, static) = {
590 .path = "ipfix flush",
591 .short_help = "flush the current ipfix data [for make test]",
592 .function = ipfix_flush_command_fn,
596 static clib_error_t *
597 flow_report_init (vlib_main_t * vm)
599 flow_report_main_t *frm = &flow_report_main;
602 frm->vnet_main = vnet_get_main ();
603 frm->unix_time_0 = time (0);
604 frm->vlib_time_0 = vlib_time_now (frm->vlib_main);
610 VLIB_INIT_FUNCTION (flow_report_init);
612 * fd.io coding-style-patch-verification: ON
615 * eval: (c-set-style "gnu")