2 * flowprobe.c - ipfix probe plugin
4 * Copyright (c) 2016 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
20 * @brief Per-packet IPFIX flow record generator plugin
22 * This file implements vpp plugin registration mechanics,
23 * debug CLI, and binary API handling.
26 #include <vnet/vnet.h>
27 #include <vpp/app/version.h>
28 #include <vnet/plugin/plugin.h>
29 #include <flowprobe/flowprobe.h>
31 #include <vlibapi/api.h>
32 #include <vlibmemory/api.h>
34 /* define message IDs */
35 #include <flowprobe/flowprobe_msg_enum.h>
37 /* define message structures */
39 #include <flowprobe/flowprobe_all_api_h.h>
42 /* define generated endian-swappers */
44 #include <flowprobe/flowprobe_all_api_h.h>
47 /* instantiate all the print functions we know about */
48 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
50 #include <flowprobe/flowprobe_all_api_h.h>
53 flowprobe_main_t flowprobe_main;
54 static vlib_node_registration_t flowprobe_timer_node;
55 uword flowprobe_walker_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
58 /* Get the API version number */
59 #define vl_api_version(n,v) static u32 api_version=(v);
60 #include <flowprobe/flowprobe_all_api_h.h>
63 #define REPLY_MSG_ID_BASE fm->msg_id_base
64 #include <vlibapi/api_helper_macros.h>
66 /* Define the per-interface configurable features */
68 VNET_FEATURE_INIT (flow_perpacket_ip4, static) =
70 .arc_name = "ip4-output",
71 .node_name = "flowprobe-ip4",
72 .runs_before = VNET_FEATURES ("interface-output"),
75 VNET_FEATURE_INIT (flow_perpacket_ip6, static) =
77 .arc_name = "ip6-output",
78 .node_name = "flowprobe-ip6",
79 .runs_before = VNET_FEATURES ("interface-output"),
82 VNET_FEATURE_INIT (flow_perpacket_l2, static) =
84 .arc_name = "interface-output",
85 .node_name = "flowprobe-l2",
86 .runs_before = VNET_FEATURES ("interface-tx"),
90 /* Macro to finish up custom dump fns */
93 vl_print (handle, (char *)s); \
97 static inline ipfix_field_specifier_t *
98 flowprobe_template_ip4_fields (ipfix_field_specifier_t * f)
100 #define flowprobe_template_ip4_field_count() 4
101 /* sourceIpv4Address, TLV type 8, u32 */
102 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
103 sourceIPv4Address, 4);
105 /* destinationIPv4Address, TLV type 12, u32 */
106 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
107 destinationIPv4Address, 4);
109 /* protocolIdentifier, TLV type 4, u8 */
110 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
111 protocolIdentifier, 1);
113 /* octetDeltaCount, TLV type 1, u64 */
114 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
120 static inline ipfix_field_specifier_t *
121 flowprobe_template_ip6_fields (ipfix_field_specifier_t * f)
123 #define flowprobe_template_ip6_field_count() 4
124 /* sourceIpv6Address, TLV type 27, 16 octets */
125 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
126 sourceIPv6Address, 16);
128 /* destinationIPv6Address, TLV type 28, 16 octets */
129 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
130 destinationIPv6Address, 16);
132 /* protocolIdentifier, TLV type 4, u8 */
133 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
134 protocolIdentifier, 1);
136 /* octetDeltaCount, TLV type 1, u64 */
137 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
143 static inline ipfix_field_specifier_t *
144 flowprobe_template_l2_fields (ipfix_field_specifier_t * f)
146 #define flowprobe_template_l2_field_count() 3
147 /* sourceMacAddress, TLV type 56, u8[6] we hope */
148 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
149 sourceMacAddress, 6);
151 /* destinationMacAddress, TLV type 80, u8[6] we hope */
152 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
153 destinationMacAddress, 6);
155 /* ethernetType, TLV type 256, u16 */
156 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
162 static inline ipfix_field_specifier_t *
163 flowprobe_template_common_fields (ipfix_field_specifier_t * f)
165 #define flowprobe_template_common_field_count() 5
166 /* ingressInterface, TLV type 10, u32 */
167 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
168 ingressInterface, 4);
171 /* egressInterface, TLV type 14, u32 */
172 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
176 /* packetDeltaCount, TLV type 2, u64 */
177 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
178 packetDeltaCount, 8);
181 /* flowStartNanoseconds, TLV type 156, u64 */
182 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
183 flowStartNanoseconds, 8);
186 /* flowEndNanoseconds, TLV type 157, u64 */
187 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
188 flowEndNanoseconds, 8);
194 static inline ipfix_field_specifier_t *
195 flowprobe_template_l4_fields (ipfix_field_specifier_t * f)
197 #define flowprobe_template_l4_field_count() 3
198 /* sourceTransportPort, TLV type 7, u16 */
199 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
200 sourceTransportPort, 2);
202 /* destinationTransportPort, TLV type 11, u16 */
203 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
204 destinationTransportPort, 2);
206 /* tcpControlBits, TLV type 6, u16 */
207 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
215 * @brief Create an IPFIX template packet rewrite string
216 * @param frm flow_report_main_t *
217 * @param fr flow_report_t *
218 * @param collector_address ip4_address_t * the IPFIX collector address
219 * @param src_address ip4_address_t * the source address we should use
220 * @param collector_port u16 the collector port we should use, host byte order
221 * @returns u8 * vector containing the indicated IPFIX template packet
224 flowprobe_template_rewrite_inline (flow_report_main_t * frm,
226 ip4_address_t * collector_address,
227 ip4_address_t * src_address,
229 flowprobe_variant_t which)
233 ipfix_message_header_t *h;
234 ipfix_set_header_t *s;
235 ipfix_template_header_t *t;
236 ipfix_field_specifier_t *f;
237 ipfix_field_specifier_t *first_field;
239 ip4_ipfix_template_packet_t *tp;
241 flow_report_stream_t *stream;
242 flowprobe_main_t *fm = &flowprobe_main;
243 flowprobe_record_t flags = fr->opaque.as_uword;
244 bool collect_ip4 = false, collect_ip6 = false;
246 stream = &frm->streams[fr->stream_index];
248 if (flags & FLOW_RECORD_L3)
250 collect_ip4 = which == FLOW_VARIANT_L2_IP4 || which == FLOW_VARIANT_IP4;
251 collect_ip6 = which == FLOW_VARIANT_L2_IP6 || which == FLOW_VARIANT_IP6;
252 if (which == FLOW_VARIANT_L2_IP4)
253 flags |= FLOW_RECORD_L2_IP4;
254 if (which == FLOW_VARIANT_L2_IP6)
255 flags |= FLOW_RECORD_L2_IP6;
258 field_count += flowprobe_template_common_field_count ();
259 if (flags & FLOW_RECORD_L2)
260 field_count += flowprobe_template_l2_field_count ();
262 field_count += flowprobe_template_ip4_field_count ();
264 field_count += flowprobe_template_ip6_field_count ();
265 if (flags & FLOW_RECORD_L4)
266 field_count += flowprobe_template_l4_field_count ();
268 /* allocate rewrite space */
270 (rewrite, sizeof (ip4_ipfix_template_packet_t)
271 + field_count * sizeof (ipfix_field_specifier_t) - 1,
272 CLIB_CACHE_LINE_BYTES);
274 tp = (ip4_ipfix_template_packet_t *) rewrite;
275 ip = (ip4_header_t *) & tp->ip4;
276 udp = (udp_header_t *) (ip + 1);
277 h = (ipfix_message_header_t *) (udp + 1);
278 s = (ipfix_set_header_t *) (h + 1);
279 t = (ipfix_template_header_t *) (s + 1);
280 first_field = f = (ipfix_field_specifier_t *) (t + 1);
282 ip->ip_version_and_header_length = 0x45;
284 ip->protocol = IP_PROTOCOL_UDP;
285 ip->src_address.as_u32 = src_address->as_u32;
286 ip->dst_address.as_u32 = collector_address->as_u32;
287 udp->src_port = clib_host_to_net_u16 (stream->src_port);
288 udp->dst_port = clib_host_to_net_u16 (collector_port);
289 udp->length = clib_host_to_net_u16 (vec_len (rewrite) - sizeof (*ip));
291 /* FIXUP: message header export_time */
292 /* FIXUP: message header sequence_number */
293 h->domain_id = clib_host_to_net_u32 (stream->domain_id);
295 /* Add TLVs to the template */
296 f = flowprobe_template_common_fields (f);
298 if (flags & FLOW_RECORD_L2)
299 f = flowprobe_template_l2_fields (f);
301 f = flowprobe_template_ip4_fields (f);
303 f = flowprobe_template_ip6_fields (f);
304 if (flags & FLOW_RECORD_L4)
305 f = flowprobe_template_l4_fields (f);
307 /* Back to the template packet... */
308 ip = (ip4_header_t *) & tp->ip4;
309 udp = (udp_header_t *) (ip + 1);
311 ASSERT (f - first_field);
312 /* Field count in this template */
313 t->id_count = ipfix_id_count (fr->template_id, f - first_field);
315 fm->template_size[flags] = (u8 *) f - (u8 *) s;
317 /* set length in octets */
319 ipfix_set_id_length (2 /* set_id */ , (u8 *) f - (u8 *) s);
321 /* message length in octets */
322 h->version_length = version_length ((u8 *) f - (u8 *) h);
324 ip->length = clib_host_to_net_u16 ((u8 *) f - (u8 *) ip);
325 ip->checksum = ip4_header_checksum (ip);
331 flowprobe_template_rewrite_ip6 (flow_report_main_t * frm,
333 ip4_address_t * collector_address,
334 ip4_address_t * src_address,
336 ipfix_report_element_t * elts,
337 u32 n_elts, u32 * stream_index)
339 return flowprobe_template_rewrite_inline
340 (frm, fr, collector_address, src_address, collector_port,
345 flowprobe_template_rewrite_ip4 (flow_report_main_t * frm,
347 ip4_address_t * collector_address,
348 ip4_address_t * src_address,
350 ipfix_report_element_t * elts,
351 u32 n_elts, u32 * stream_index)
353 return flowprobe_template_rewrite_inline
354 (frm, fr, collector_address, src_address, collector_port,
359 flowprobe_template_rewrite_l2 (flow_report_main_t * frm,
361 ip4_address_t * collector_address,
362 ip4_address_t * src_address,
364 ipfix_report_element_t * elts,
365 u32 n_elts, u32 * stream_index)
367 return flowprobe_template_rewrite_inline
368 (frm, fr, collector_address, src_address, collector_port,
373 flowprobe_template_rewrite_l2_ip4 (flow_report_main_t * frm,
375 ip4_address_t * collector_address,
376 ip4_address_t * src_address,
378 ipfix_report_element_t * elts,
379 u32 n_elts, u32 * stream_index)
381 return flowprobe_template_rewrite_inline
382 (frm, fr, collector_address, src_address, collector_port,
383 FLOW_VARIANT_L2_IP4);
387 flowprobe_template_rewrite_l2_ip6 (flow_report_main_t * frm,
389 ip4_address_t * collector_address,
390 ip4_address_t * src_address,
392 ipfix_report_element_t * elts,
393 u32 n_elts, u32 * stream_index)
395 return flowprobe_template_rewrite_inline
396 (frm, fr, collector_address, src_address, collector_port,
397 FLOW_VARIANT_L2_IP6);
401 * @brief Flush accumulated data
402 * @param frm flow_report_main_t *
403 * @param fr flow_report_t *
404 * @param f vlib_frame_t *
407 * This function must simply return the incoming frame, or no template packets
411 flowprobe_data_callback_ip4 (flow_report_main_t * frm,
413 vlib_frame_t * f, u32 * to_next, u32 node_index)
415 flowprobe_flush_callback_ip4 ();
420 flowprobe_data_callback_ip6 (flow_report_main_t * frm,
422 vlib_frame_t * f, u32 * to_next, u32 node_index)
424 flowprobe_flush_callback_ip6 ();
429 flowprobe_data_callback_l2 (flow_report_main_t * frm,
431 vlib_frame_t * f, u32 * to_next, u32 node_index)
433 flowprobe_flush_callback_l2 ();
438 flowprobe_template_add_del (u32 domain_id, u16 src_port,
439 flowprobe_record_t flags,
440 vnet_flow_data_callback_t * flow_data_callback,
441 vnet_flow_rewrite_callback_t * rewrite_callback,
442 bool is_add, u16 * template_id)
444 flow_report_main_t *frm = &flow_report_main;
445 vnet_flow_report_add_del_args_t a = {
446 .rewrite_callback = rewrite_callback,
447 .flow_data_callback = flow_data_callback,
449 .domain_id = domain_id,
450 .src_port = src_port,
451 .opaque.as_uword = flags,
453 return vnet_flow_report_add_del (frm, &a, template_id);
457 flowprobe_expired_timer_callback (u32 * expired_timers)
459 vlib_main_t *vm = vlib_get_main ();
460 flowprobe_main_t *fm = &flowprobe_main;
461 u32 my_cpu_number = vm->thread_index;
465 for (i = 0; i < vec_len (expired_timers); i++)
467 poolindex = expired_timers[i] & 0x7FFFFFFF;
468 vec_add1 (fm->expired_passive_per_worker[my_cpu_number], poolindex);
472 static clib_error_t *
473 flowprobe_create_state_tables (u32 active_timer)
475 flowprobe_main_t *fm = &flowprobe_main;
476 vlib_thread_main_t *tm = &vlib_thread_main;
477 vlib_main_t *vm = vlib_get_main ();
478 clib_error_t *error = 0;
482 /* Decide how many worker threads we have */
483 num_threads = 1 /* main thread */ + tm->n_threads;
485 /* Hash table per worker */
486 fm->ht_log2len = FLOWPROBE_LOG2_HASHSIZE;
488 /* Init per worker flow state and timer wheels */
491 vec_validate (fm->timers_per_worker, num_threads - 1);
492 vec_validate (fm->expired_passive_per_worker, num_threads - 1);
493 vec_validate (fm->hash_per_worker, num_threads - 1);
494 vec_validate (fm->pool_per_worker, num_threads - 1);
496 for (i = 0; i < num_threads; i++)
499 pool_alloc (fm->pool_per_worker[i], 1 << fm->ht_log2len);
500 vec_resize (fm->hash_per_worker[i], 1 << fm->ht_log2len);
501 for (j = 0; j < (1 << fm->ht_log2len); j++)
502 fm->hash_per_worker[i][j] = ~0;
503 fm->timers_per_worker[i] =
504 clib_mem_alloc (sizeof (TWT (tw_timer_wheel)));
505 tw_timer_wheel_init_2t_1w_2048sl (fm->timers_per_worker[i],
506 flowprobe_expired_timer_callback,
513 f64 now = vlib_time_now (vm);
514 vec_validate (fm->stateless_entry, num_threads - 1);
515 for (i = 0; i < num_threads; i++)
516 fm->stateless_entry[i].last_exported = now;
517 fm->disabled = false;
519 fm->initialized = true;
524 validate_feature_on_interface (flowprobe_main_t * fm, u32 sw_if_index,
527 vec_validate_init_empty (fm->flow_per_interface, sw_if_index, ~0);
529 if (fm->flow_per_interface[sw_if_index] == (u8) ~ 0)
531 else if (fm->flow_per_interface[sw_if_index] != which)
538 * @brief configure / deconfigure the IPFIX flow-per-packet
539 * @param fm flowprobe_main_t * fm
540 * @param sw_if_index u32 the desired interface
541 * @param is_add int 1 to enable the feature, 0 to disable it
542 * @returns 0 if successful, non-zero otherwise
546 flowprobe_tx_interface_add_del_feature (flowprobe_main_t * fm,
547 u32 sw_if_index, u8 which, int is_add)
549 vlib_main_t *vm = vlib_get_main ();
552 flowprobe_record_t flags = fm->record;
554 fm->flow_per_interface[sw_if_index] = (is_add) ? which : (u8) ~ 0;
555 fm->template_per_flow[which] += (is_add) ? 1 : -1;
556 if (is_add && fm->template_per_flow[which] > 1)
557 template_id = fm->template_reports[flags];
559 if ((is_add && fm->template_per_flow[which] == 1) ||
560 (!is_add && fm->template_per_flow[which] == 0))
562 if (which == FLOW_VARIANT_L2)
564 if (fm->record & FLOW_RECORD_L2)
566 rv = flowprobe_template_add_del (1, UDP_DST_PORT_ipfix, flags,
567 flowprobe_data_callback_l2,
568 flowprobe_template_rewrite_l2,
569 is_add, &template_id);
571 if (fm->record & FLOW_RECORD_L3 || fm->record & FLOW_RECORD_L4)
573 rv = flowprobe_template_add_del (1, UDP_DST_PORT_ipfix, flags,
574 flowprobe_data_callback_l2,
575 flowprobe_template_rewrite_l2_ip4,
576 is_add, &template_id);
577 fm->template_reports[flags | FLOW_RECORD_L2_IP4] =
578 (is_add) ? template_id : 0;
580 flowprobe_template_add_del (1, UDP_DST_PORT_ipfix, flags,
581 flowprobe_data_callback_l2,
582 flowprobe_template_rewrite_l2_ip6,
583 is_add, &template_id);
584 fm->template_reports[flags | FLOW_RECORD_L2_IP6] =
585 (is_add) ? template_id : 0;
587 /* Special case L2 */
588 fm->context[FLOW_VARIANT_L2_IP4].flags =
589 flags | FLOW_RECORD_L2_IP4;
590 fm->context[FLOW_VARIANT_L2_IP6].flags =
591 flags | FLOW_RECORD_L2_IP6;
593 fm->template_reports[flags] = template_id;
596 else if (which == FLOW_VARIANT_IP4)
597 rv = flowprobe_template_add_del (1, UDP_DST_PORT_ipfix, flags,
598 flowprobe_data_callback_ip4,
599 flowprobe_template_rewrite_ip4,
600 is_add, &template_id);
601 else if (which == FLOW_VARIANT_IP6)
602 rv = flowprobe_template_add_del (1, UDP_DST_PORT_ipfix, flags,
603 flowprobe_data_callback_ip6,
604 flowprobe_template_rewrite_ip6,
605 is_add, &template_id);
607 if (rv && rv != VNET_API_ERROR_VALUE_EXIST)
609 clib_warning ("vnet_flow_report_add_del returned %d", rv);
613 if (which != (u8) ~ 0)
615 fm->context[which].flags = fm->record;
616 fm->template_reports[flags] = (is_add) ? template_id : 0;
619 if (which == FLOW_VARIANT_IP4)
620 vnet_feature_enable_disable ("ip4-output", "flowprobe-ip4",
621 sw_if_index, is_add, 0, 0);
622 else if (which == FLOW_VARIANT_IP6)
623 vnet_feature_enable_disable ("ip6-output", "flowprobe-ip6",
624 sw_if_index, is_add, 0, 0);
625 else if (which == FLOW_VARIANT_L2)
626 vnet_feature_enable_disable ("interface-output", "flowprobe-l2",
627 sw_if_index, is_add, 0, 0);
629 /* Stateful flow collection */
630 if (is_add && !fm->initialized)
632 flowprobe_create_state_tables (fm->active_timer);
633 if (fm->active_timer)
634 vlib_process_signal_event (vm, flowprobe_timer_node.index, 1, 0);
641 * @brief API message handler
642 * @param mp vl_api_flowprobe_tx_interface_add_del_t * mp the api message
644 void vl_api_flowprobe_tx_interface_add_del_t_handler
645 (vl_api_flowprobe_tx_interface_add_del_t * mp)
647 flowprobe_main_t *fm = &flowprobe_main;
648 vl_api_flowprobe_tx_interface_add_del_reply_t *rmp;
649 u32 sw_if_index = ntohl (mp->sw_if_index);
652 VALIDATE_SW_IF_INDEX (mp);
654 if (mp->which != FLOW_VARIANT_IP4 && mp->which != FLOW_VARIANT_L2
655 && mp->which != FLOW_VARIANT_IP6)
657 rv = VNET_API_ERROR_UNIMPLEMENTED;
663 clib_warning ("Please specify flowprobe params record first...");
664 rv = VNET_API_ERROR_CANNOT_ENABLE_DISABLE_FEATURE;
668 rv = validate_feature_on_interface (fm, sw_if_index, mp->which);
669 if ((rv == 1 && mp->is_add == 1) || rv == 0)
671 rv = VNET_API_ERROR_CANNOT_ENABLE_DISABLE_FEATURE;
675 rv = flowprobe_tx_interface_add_del_feature
676 (fm, sw_if_index, mp->which, mp->is_add);
679 BAD_SW_IF_INDEX_LABEL;
681 REPLY_MACRO (VL_API_FLOWPROBE_TX_INTERFACE_ADD_DEL_REPLY);
685 * @brief API message custom-dump function
686 * @param mp vl_api_flowprobe_tx_interface_add_del_t * mp the api message
687 * @param handle void * print function handle
688 * @returns u8 * output string
690 static void *vl_api_flowprobe_tx_interface_add_del_t_print
691 (vl_api_flowprobe_tx_interface_add_del_t * mp, void *handle)
695 s = format (0, "SCRIPT: flowprobe_tx_interface_add_del ");
696 s = format (s, "sw_if_index %d is_add %d which %d ",
697 clib_host_to_net_u32 (mp->sw_if_index),
698 (int) mp->is_add, (int) mp->which);
702 #define vec_neg_search(v,E) \
705 while (_v(i) < vec_len(v) && v[_v(i)] == E) \
709 if (_v(i) == vec_len(v)) \
715 flowprobe_params (flowprobe_main_t * fm, u8 record_l2,
716 u8 record_l3, u8 record_l4,
717 u32 active_timer, u32 passive_timer)
719 flowprobe_record_t flags = 0;
721 if (vec_neg_search (fm->flow_per_interface, (u8) ~ 0) != ~0)
725 flags |= FLOW_RECORD_L2;
727 flags |= FLOW_RECORD_L3;
729 flags |= FLOW_RECORD_L4;
734 * Timers: ~0 is default, 0 is off
737 (active_timer == (u32) ~ 0 ? FLOWPROBE_TIMER_ACTIVE : active_timer);
739 (passive_timer == (u32) ~ 0 ? FLOWPROBE_TIMER_PASSIVE : passive_timer);
745 vl_api_flowprobe_params_t_handler (vl_api_flowprobe_params_t * mp)
747 flowprobe_main_t *fm = &flowprobe_main;
748 vl_api_flowprobe_params_reply_t *rmp;
751 rv = flowprobe_params
752 (fm, mp->record_l2, mp->record_l3, mp->record_l4,
753 clib_net_to_host_u32 (mp->active_timer),
754 clib_net_to_host_u32 (mp->passive_timer));
756 REPLY_MACRO (VL_API_FLOWPROBE_PARAMS_REPLY);
759 /* List of message types that this plugin understands */
760 #define foreach_flowprobe_plugin_api_msg \
761 _(FLOWPROBE_TX_INTERFACE_ADD_DEL, flowprobe_tx_interface_add_del) \
762 _(FLOWPROBE_PARAMS, flowprobe_params)
765 VLIB_PLUGIN_REGISTER () = {
766 .version = VPP_BUILD_VER,
767 .description = "Flow per Packet",
772 format_flowprobe_entry (u8 * s, va_list * args)
774 flowprobe_entry_t *e = va_arg (*args, flowprobe_entry_t *);
775 s = format (s, " %d/%d", e->key.rx_sw_if_index, e->key.tx_sw_if_index);
777 s = format (s, " %U %U", format_ethernet_address, &e->key.src_mac,
778 format_ethernet_address, &e->key.dst_mac);
779 s = format (s, " %U -> %U",
780 format_ip46_address, &e->key.src_address, IP46_TYPE_ANY,
781 format_ip46_address, &e->key.dst_address, IP46_TYPE_ANY);
782 s = format (s, " %d", e->key.protocol);
783 s = format (s, " %d %d\n", clib_net_to_host_u16 (e->key.src_port),
784 clib_net_to_host_u16 (e->key.dst_port));
789 static clib_error_t *
790 flowprobe_show_table_fn (vlib_main_t * vm,
791 unformat_input_t * input, vlib_cli_command_t * cm)
793 flowprobe_main_t *fm = &flowprobe_main;
795 flowprobe_entry_t *e;
797 vlib_cli_output (vm, "Dumping IPFIX table");
799 for (i = 0; i < vec_len (fm->pool_per_worker); i++)
802 pool_foreach (e, fm->pool_per_worker[i], (
804 vlib_cli_output (vm, "%U",
805 format_flowprobe_entry,
814 static clib_error_t *
815 flowprobe_show_stats_fn (vlib_main_t * vm,
816 unformat_input_t * input, vlib_cli_command_t * cm)
818 flowprobe_main_t *fm = &flowprobe_main;
821 vlib_cli_output (vm, "IPFIX table statistics");
822 vlib_cli_output (vm, "Flow entry size: %d\n", sizeof (flowprobe_entry_t));
823 vlib_cli_output (vm, "Flow pool size per thread: %d\n",
824 0x1 << FLOWPROBE_LOG2_HASHSIZE);
826 for (i = 0; i < vec_len (fm->pool_per_worker); i++)
827 vlib_cli_output (vm, "Pool utilisation thread %d is %d%%\n", i,
828 (100 * pool_elts (fm->pool_per_worker[i])) /
829 (0x1 << FLOWPROBE_LOG2_HASHSIZE));
833 static clib_error_t *
834 flowprobe_tx_interface_add_del_feature_command_fn (vlib_main_t * vm,
835 unformat_input_t * input,
836 vlib_cli_command_t * cmd)
838 flowprobe_main_t *fm = &flowprobe_main;
839 u32 sw_if_index = ~0;
841 u8 which = FLOW_VARIANT_IP4;
844 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
846 if (unformat (input, "disable"))
848 else if (unformat (input, "%U", unformat_vnet_sw_interface,
849 fm->vnet_main, &sw_if_index));
850 else if (unformat (input, "ip4"))
851 which = FLOW_VARIANT_IP4;
852 else if (unformat (input, "ip6"))
853 which = FLOW_VARIANT_IP6;
854 else if (unformat (input, "l2"))
855 which = FLOW_VARIANT_L2;
861 return clib_error_return (0,
862 "Please specify flowprobe params record first...");
864 if (sw_if_index == ~0)
865 return clib_error_return (0, "Please specify an interface...");
867 rv = validate_feature_on_interface (fm, sw_if_index, which);
871 return clib_error_return (0,
872 "Datapath is already enabled for given interface...");
875 return clib_error_return (0,
876 "Interface has enable different datapath ...");
879 flowprobe_tx_interface_add_del_feature (fm, sw_if_index, which, is_add);
885 case VNET_API_ERROR_INVALID_SW_IF_INDEX:
886 return clib_error_return
887 (0, "Invalid interface, only works on physical ports");
890 case VNET_API_ERROR_UNIMPLEMENTED:
891 return clib_error_return (0, "ip6 not supported");
895 return clib_error_return (0, "flowprobe_enable_disable returned %d",
901 static clib_error_t *
902 flowprobe_params_command_fn (vlib_main_t * vm,
903 unformat_input_t * input,
904 vlib_cli_command_t * cmd)
906 flowprobe_main_t *fm = &flowprobe_main;
907 bool record_l2 = false, record_l3 = false, record_l4 = false;
908 u32 active_timer = ~0;
909 u32 passive_timer = ~0;
911 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
913 if (unformat (input, "active %d", &active_timer))
915 else if (unformat (input, "passive %d", &passive_timer))
917 else if (unformat (input, "record"))
918 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
920 if (unformat (input, "l2"))
922 else if (unformat (input, "l3"))
924 else if (unformat (input, "l4"))
933 if (passive_timer > 0 && active_timer > passive_timer)
934 return clib_error_return (0,
935 "Passive timer has to be greater than active one...");
937 if (flowprobe_params (fm, record_l2, record_l3, record_l4,
938 active_timer, passive_timer))
939 return clib_error_return (0,
940 "Couldn't change flowperpacket params when feature is enabled on some interface ...");
945 * '<em>flowprobe feature add-del</em>' commands to enable/disable
946 * per-packet IPFIX flow record generation on an interface
950 * To enable per-packet IPFIX flow-record generation on an interface:
951 * @cliexcmd{flowprobe feature add-del GigabitEthernet2/0/0}
953 * To disable per-packet IPFIX flow-record generation on an interface:
954 * @cliexcmd{flowprobe feature add-del GigabitEthernet2/0/0 disable}
959 VLIB_CLI_COMMAND (flowprobe_enable_disable_command, static) = {
960 .path = "flowprobe feature add-del",
962 "flowprobe feature add-del <interface-name> <l2|ip4|ip6> disable",
963 .function = flowprobe_tx_interface_add_del_feature_command_fn,
965 VLIB_CLI_COMMAND (flowprobe_params_command, static) = {
966 .path = "flowprobe params",
968 "flowprobe params record <[l2] [l3] [l4]> [active <timer> passive <timer>]",
969 .function = flowprobe_params_command_fn,
971 VLIB_CLI_COMMAND (flowprobe_show_table_command, static) = {
972 .path = "show flowprobe table",
973 .short_help = "show flowprobe table",
974 .function = flowprobe_show_table_fn,
976 VLIB_CLI_COMMAND (flowprobe_show_stats_command, static) = {
977 .path = "show flowprobe statistics",
978 .short_help = "show flowprobe statistics",
979 .function = flowprobe_show_stats_fn,
984 * @brief Set up the API message handling tables
985 * @param vm vlib_main_t * vlib main data structure pointer
986 * @returns 0 to indicate all is well
988 static clib_error_t *
989 flowprobe_plugin_api_hookup (vlib_main_t * vm)
991 flowprobe_main_t *fm = &flowprobe_main;
993 vl_msg_api_set_handlers((VL_API_##N + fm->msg_id_base), \
995 vl_api_##n##_t_handler, \
997 vl_api_##n##_t_endian, \
998 vl_api_##n##_t_print, \
999 sizeof(vl_api_##n##_t), 1);
1000 foreach_flowprobe_plugin_api_msg;
1006 #define vl_msg_name_crc_list
1007 #include <flowprobe/flowprobe_all_api_h.h>
1008 #undef vl_msg_name_crc_list
1011 setup_message_id_table (flowprobe_main_t * fm, api_main_t * am)
1013 #define _(id,n,crc) \
1014 vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + fm->msg_id_base);
1015 foreach_vl_msg_name_crc_flowprobe;
1020 * Main-core process, sending an interrupt to the per worker input
1021 * process that spins the per worker timer wheel.
1024 timer_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
1026 uword *event_data = 0;
1027 vlib_main_t **worker_vms = 0, *worker_vm;
1028 flowprobe_main_t *fm = &flowprobe_main;
1030 /* Wait for Godot... */
1031 vlib_process_wait_for_event_or_clock (vm, 1e9);
1032 uword event_type = vlib_process_get_events (vm, &event_data);
1033 if (event_type != 1)
1034 clib_warning ("bogus kickoff event received, %d", event_type);
1035 vec_reset_length (event_data);
1038 if (vec_len (vlib_mains) == 0)
1039 vec_add1 (worker_vms, vm);
1042 for (i = 0; i < vec_len (vlib_mains); i++)
1044 worker_vm = vlib_mains[i];
1046 vec_add1 (worker_vms, worker_vm);
1049 f64 sleep_duration = 0.1;
1053 /* Send an interrupt to each timer input node */
1054 sleep_duration = 0.1;
1055 for (i = 0; i < vec_len (worker_vms); i++)
1057 worker_vm = worker_vms[i];
1060 vlib_node_set_interrupt_pending (worker_vm,
1061 flowprobe_walker_node.index);
1063 (fm->expired_passive_per_worker[i] > 0) ? 1e-4 : 0.1;
1066 vlib_process_suspend (vm, sleep_duration);
1068 return 0; /* or not */
1072 VLIB_REGISTER_NODE (flowprobe_timer_node,static) = {
1073 .function = timer_process,
1074 .name = "flowprobe-timer-process",
1075 .type = VLIB_NODE_TYPE_PROCESS,
1080 * @brief Set up the API message handling tables
1081 * @param vm vlib_main_t * vlib main data structure pointer
1082 * @returns 0 to indicate all is well, or a clib_error_t
1084 static clib_error_t *
1085 flowprobe_init (vlib_main_t * vm)
1087 flowprobe_main_t *fm = &flowprobe_main;
1088 vlib_thread_main_t *tm = &vlib_thread_main;
1089 clib_error_t *error = 0;
1094 fm->vnet_main = vnet_get_main ();
1096 /* Construct the API name */
1097 name = format (0, "flowprobe_%08x%c", api_version, 0);
1099 /* Ask for a correctly-sized block of API message decode slots */
1100 fm->msg_id_base = vl_msg_api_get_msg_ids
1101 ((char *) name, VL_MSG_FIRST_AVAILABLE);
1103 /* Hook up message handlers */
1104 error = flowprobe_plugin_api_hookup (vm);
1106 /* Add our API messages to the global name_crc hash table */
1107 setup_message_id_table (fm, &api_main);
1111 /* Set up time reference pair */
1112 fm->vlib_time_0 = vlib_time_now (vm);
1113 fm->nanosecond_time_0 = unix_time_now_nsec ();
1115 clib_memset (fm->template_reports, 0, sizeof (fm->template_reports));
1116 clib_memset (fm->template_size, 0, sizeof (fm->template_size));
1117 clib_memset (fm->template_per_flow, 0, sizeof (fm->template_per_flow));
1119 /* Decide how many worker threads we have */
1120 num_threads = 1 /* main thread */ + tm->n_threads;
1122 /* Allocate per worker thread vectors per flavour */
1123 for (i = 0; i < FLOW_N_VARIANTS; i++)
1125 vec_validate (fm->context[i].buffers_per_worker, num_threads - 1);
1126 vec_validate (fm->context[i].frames_per_worker, num_threads - 1);
1127 vec_validate (fm->context[i].next_record_offset_per_worker,
1131 fm->active_timer = FLOWPROBE_TIMER_ACTIVE;
1132 fm->passive_timer = FLOWPROBE_TIMER_PASSIVE;
1137 VLIB_INIT_FUNCTION (flowprobe_init);
1140 * fd.io coding-style-patch-verification: ON
1143 * eval: (c-set-style "gnu")