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>
33 #include <vlibsocket/api.h>
35 /* define message IDs */
36 #include <flowprobe/flowprobe_msg_enum.h>
38 /* define message structures */
40 #include <flowprobe/flowprobe_all_api_h.h>
43 /* define generated endian-swappers */
45 #include <flowprobe/flowprobe_all_api_h.h>
48 /* instantiate all the print functions we know about */
49 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
51 #include <flowprobe/flowprobe_all_api_h.h>
54 flowprobe_main_t flowprobe_main;
55 vlib_node_registration_t flowprobe_walker_node;
56 static vlib_node_registration_t flowprobe_timer_node;
57 uword flowprobe_walker_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
60 /* Get the API version number */
61 #define vl_api_version(n,v) static u32 api_version=(v);
62 #include <flowprobe/flowprobe_all_api_h.h>
65 #define REPLY_MSG_ID_BASE fm->msg_id_base
66 #include <vlibapi/api_helper_macros.h>
68 /* Define the per-interface configurable features */
70 VNET_FEATURE_INIT (flow_perpacket_ip4, static) =
72 .arc_name = "ip4-output",
73 .node_name = "flowprobe-ip4",
74 .runs_before = VNET_FEATURES ("interface-output"),
77 VNET_FEATURE_INIT (flow_perpacket_ip6, static) =
79 .arc_name = "ip6-output",
80 .node_name = "flowprobe-ip6",
81 .runs_before = VNET_FEATURES ("interface-output"),
84 VNET_FEATURE_INIT (flow_perpacket_l2, static) =
86 .arc_name = "interface-output",
87 .node_name = "flowprobe-l2",
88 .runs_before = VNET_FEATURES ("interface-tx"),
92 /* Macro to finish up custom dump fns */
95 vl_print (handle, (char *)s); \
99 static inline ipfix_field_specifier_t *
100 flowprobe_template_ip4_fields (ipfix_field_specifier_t * f)
102 #define flowprobe_template_ip4_field_count() 4
103 /* sourceIpv4Address, TLV type 8, u32 */
104 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
105 sourceIPv4Address, 4);
107 /* destinationIPv4Address, TLV type 12, u32 */
108 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
109 destinationIPv4Address, 4);
111 /* protocolIdentifier, TLV type 4, u8 */
112 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
113 protocolIdentifier, 1);
115 /* octetDeltaCount, TLV type 1, u64 */
116 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
122 static inline ipfix_field_specifier_t *
123 flowprobe_template_ip6_fields (ipfix_field_specifier_t * f)
125 #define flowprobe_template_ip6_field_count() 4
126 /* sourceIpv6Address, TLV type 27, 16 octets */
127 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
128 sourceIPv6Address, 16);
130 /* destinationIPv6Address, TLV type 28, 16 octets */
131 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
132 destinationIPv6Address, 16);
134 /* protocolIdentifier, TLV type 4, u8 */
135 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
136 protocolIdentifier, 1);
138 /* octetDeltaCount, TLV type 1, u64 */
139 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
145 static inline ipfix_field_specifier_t *
146 flowprobe_template_l2_fields (ipfix_field_specifier_t * f)
148 #define flowprobe_template_l2_field_count() 3
149 /* sourceMacAddress, TLV type 56, u8[6] we hope */
150 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
151 sourceMacAddress, 6);
153 /* destinationMacAddress, TLV type 80, u8[6] we hope */
154 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
155 destinationMacAddress, 6);
157 /* ethernetType, TLV type 256, u16 */
158 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
164 static inline ipfix_field_specifier_t *
165 flowprobe_template_common_fields (ipfix_field_specifier_t * f)
167 #define flowprobe_template_common_field_count() 5
168 /* ingressInterface, TLV type 10, u32 */
169 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
170 ingressInterface, 4);
173 /* egressInterface, TLV type 14, u32 */
174 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
178 /* packetDeltaCount, TLV type 2, u64 */
179 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
180 packetDeltaCount, 8);
183 /* flowStartNanoseconds, TLV type 156, u64 */
184 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
185 flowStartNanoseconds, 8);
188 /* flowEndNanoseconds, TLV type 157, u64 */
189 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
190 flowEndNanoseconds, 8);
196 static inline ipfix_field_specifier_t *
197 flowprobe_template_l4_fields (ipfix_field_specifier_t * f)
199 #define flowprobe_template_l4_field_count() 3
200 /* sourceTransportPort, TLV type 7, u16 */
201 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
202 sourceTransportPort, 2);
204 /* destinationTransportPort, TLV type 11, u16 */
205 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
206 destinationTransportPort, 2);
208 /* tcpControlBits, TLV type 6, u16 */
209 f->e_id_length = ipfix_e_id_length (0 /* enterprise */ ,
217 * @brief Create an IPFIX template packet rewrite string
218 * @param frm flow_report_main_t *
219 * @param fr flow_report_t *
220 * @param collector_address ip4_address_t * the IPFIX collector address
221 * @param src_address ip4_address_t * the source address we should use
222 * @param collector_port u16 the collector port we should use, host byte order
223 * @returns u8 * vector containing the indicated IPFIX template packet
226 flowprobe_template_rewrite_inline (flow_report_main_t * frm,
228 ip4_address_t * collector_address,
229 ip4_address_t * src_address,
231 flowprobe_variant_t which)
235 ipfix_message_header_t *h;
236 ipfix_set_header_t *s;
237 ipfix_template_header_t *t;
238 ipfix_field_specifier_t *f;
239 ipfix_field_specifier_t *first_field;
241 ip4_ipfix_template_packet_t *tp;
243 flow_report_stream_t *stream;
244 flowprobe_main_t *fm = &flowprobe_main;
245 flowprobe_record_t flags = fr->opaque.as_uword;
246 bool collect_ip4 = false, collect_ip6 = false;
248 stream = &frm->streams[fr->stream_index];
250 if (flags & FLOW_RECORD_L3)
252 collect_ip4 = which == FLOW_VARIANT_L2_IP4 || which == FLOW_VARIANT_IP4;
253 collect_ip6 = which == FLOW_VARIANT_L2_IP6 || which == FLOW_VARIANT_IP6;
254 if (which == FLOW_VARIANT_L2_IP4)
255 flags |= FLOW_RECORD_L2_IP4;
256 if (which == FLOW_VARIANT_L2_IP6)
257 flags |= FLOW_RECORD_L2_IP6;
260 field_count += flowprobe_template_common_field_count ();
261 if (flags & FLOW_RECORD_L2)
262 field_count += flowprobe_template_l2_field_count ();
264 field_count += flowprobe_template_ip4_field_count ();
266 field_count += flowprobe_template_ip6_field_count ();
267 if (flags & FLOW_RECORD_L4)
268 field_count += flowprobe_template_l4_field_count ();
270 /* allocate rewrite space */
272 (rewrite, sizeof (ip4_ipfix_template_packet_t)
273 + field_count * sizeof (ipfix_field_specifier_t) - 1,
274 CLIB_CACHE_LINE_BYTES);
276 tp = (ip4_ipfix_template_packet_t *) rewrite;
277 ip = (ip4_header_t *) & tp->ip4;
278 udp = (udp_header_t *) (ip + 1);
279 h = (ipfix_message_header_t *) (udp + 1);
280 s = (ipfix_set_header_t *) (h + 1);
281 t = (ipfix_template_header_t *) (s + 1);
282 first_field = f = (ipfix_field_specifier_t *) (t + 1);
284 ip->ip_version_and_header_length = 0x45;
286 ip->protocol = IP_PROTOCOL_UDP;
287 ip->src_address.as_u32 = src_address->as_u32;
288 ip->dst_address.as_u32 = collector_address->as_u32;
289 udp->src_port = clib_host_to_net_u16 (stream->src_port);
290 udp->dst_port = clib_host_to_net_u16 (collector_port);
291 udp->length = clib_host_to_net_u16 (vec_len (rewrite) - sizeof (*ip));
293 /* FIXUP: message header export_time */
294 /* FIXUP: message header sequence_number */
295 h->domain_id = clib_host_to_net_u32 (stream->domain_id);
297 /* Add TLVs to the template */
298 f = flowprobe_template_common_fields (f);
300 if (flags & FLOW_RECORD_L2)
301 f = flowprobe_template_l2_fields (f);
303 f = flowprobe_template_ip4_fields (f);
305 f = flowprobe_template_ip6_fields (f);
306 if (flags & FLOW_RECORD_L4)
307 f = flowprobe_template_l4_fields (f);
309 /* Back to the template packet... */
310 ip = (ip4_header_t *) & tp->ip4;
311 udp = (udp_header_t *) (ip + 1);
313 ASSERT (f - first_field);
314 /* Field count in this template */
315 t->id_count = ipfix_id_count (fr->template_id, f - first_field);
317 fm->template_size[flags] = (u8 *) f - (u8 *) s;
319 /* set length in octets */
321 ipfix_set_id_length (2 /* set_id */ , (u8 *) f - (u8 *) s);
323 /* message length in octets */
324 h->version_length = version_length ((u8 *) f - (u8 *) h);
326 ip->length = clib_host_to_net_u16 ((u8 *) f - (u8 *) ip);
327 ip->checksum = ip4_header_checksum (ip);
333 flowprobe_template_rewrite_ip6 (flow_report_main_t * frm,
335 ip4_address_t * collector_address,
336 ip4_address_t * src_address,
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,
351 return flowprobe_template_rewrite_inline
352 (frm, fr, collector_address, src_address, collector_port,
357 flowprobe_template_rewrite_l2 (flow_report_main_t * frm,
359 ip4_address_t * collector_address,
360 ip4_address_t * src_address,
363 return flowprobe_template_rewrite_inline
364 (frm, fr, collector_address, src_address, collector_port,
369 flowprobe_template_rewrite_l2_ip4 (flow_report_main_t * frm,
371 ip4_address_t * collector_address,
372 ip4_address_t * src_address,
375 return flowprobe_template_rewrite_inline
376 (frm, fr, collector_address, src_address, collector_port,
377 FLOW_VARIANT_L2_IP4);
381 flowprobe_template_rewrite_l2_ip6 (flow_report_main_t * frm,
383 ip4_address_t * collector_address,
384 ip4_address_t * src_address,
387 return flowprobe_template_rewrite_inline
388 (frm, fr, collector_address, src_address, collector_port,
389 FLOW_VARIANT_L2_IP6);
393 * @brief Flush accumulated data
394 * @param frm flow_report_main_t *
395 * @param fr flow_report_t *
396 * @param f vlib_frame_t *
399 * This function must simply return the incoming frame, or no template packets
403 flowprobe_data_callback_ip4 (flow_report_main_t * frm,
405 vlib_frame_t * f, u32 * to_next, u32 node_index)
407 flowprobe_flush_callback_ip4 ();
412 flowprobe_data_callback_ip6 (flow_report_main_t * frm,
414 vlib_frame_t * f, u32 * to_next, u32 node_index)
416 flowprobe_flush_callback_ip6 ();
421 flowprobe_data_callback_l2 (flow_report_main_t * frm,
423 vlib_frame_t * f, u32 * to_next, u32 node_index)
425 flowprobe_flush_callback_l2 ();
430 flowprobe_template_add_del (u32 domain_id, u16 src_port,
431 flowprobe_record_t flags,
432 vnet_flow_data_callback_t * flow_data_callback,
433 vnet_flow_rewrite_callback_t * rewrite_callback,
434 bool is_add, u16 * template_id)
436 flow_report_main_t *frm = &flow_report_main;
437 vnet_flow_report_add_del_args_t a = {
438 .rewrite_callback = rewrite_callback,
439 .flow_data_callback = flow_data_callback,
441 .domain_id = domain_id,
442 .src_port = src_port,
443 .opaque.as_uword = flags,
445 return vnet_flow_report_add_del (frm, &a, template_id);
449 flowprobe_expired_timer_callback (u32 * expired_timers)
451 vlib_main_t *vm = vlib_get_main ();
452 flowprobe_main_t *fm = &flowprobe_main;
453 u32 my_cpu_number = vm->thread_index;
457 for (i = 0; i < vec_len (expired_timers); i++)
459 poolindex = expired_timers[i] & 0x7FFFFFFF;
460 vec_add1 (fm->expired_passive_per_worker[my_cpu_number], poolindex);
464 static clib_error_t *
465 flowprobe_create_state_tables (u32 active_timer)
467 flowprobe_main_t *fm = &flowprobe_main;
468 vlib_thread_main_t *tm = &vlib_thread_main;
469 vlib_main_t *vm = vlib_get_main ();
470 clib_error_t *error = 0;
474 /* Decide how many worker threads we have */
475 num_threads = 1 /* main thread */ + tm->n_threads;
477 /* Hash table per worker */
478 fm->ht_log2len = FLOWPROBE_LOG2_HASHSIZE;
480 /* Init per worker flow state and timer wheels */
483 vec_validate (fm->timers_per_worker, num_threads - 1);
484 vec_validate (fm->expired_passive_per_worker, num_threads - 1);
485 vec_validate (fm->hash_per_worker, num_threads - 1);
486 vec_validate (fm->pool_per_worker, num_threads - 1);
488 for (i = 0; i < num_threads; i++)
491 pool_alloc (fm->pool_per_worker[i], 1 << fm->ht_log2len);
492 vec_resize (fm->hash_per_worker[i], 1 << fm->ht_log2len);
493 for (j = 0; j < (1 << fm->ht_log2len); j++)
494 fm->hash_per_worker[i][j] = ~0;
495 fm->timers_per_worker[i] =
496 clib_mem_alloc (sizeof (TWT (tw_timer_wheel)));
497 tw_timer_wheel_init_2t_1w_2048sl (fm->timers_per_worker[i],
498 flowprobe_expired_timer_callback,
505 f64 now = vlib_time_now (vm);
506 vec_validate (fm->stateless_entry, num_threads - 1);
507 for (i = 0; i < num_threads; i++)
508 fm->stateless_entry[i].last_exported = now;
509 fm->disabled = false;
511 fm->initialized = true;
516 validate_feature_on_interface (flowprobe_main_t * fm, u32 sw_if_index,
519 vec_validate_init_empty (fm->flow_per_interface, sw_if_index, ~0);
521 if (fm->flow_per_interface[sw_if_index] == (u8) ~ 0)
523 else if (fm->flow_per_interface[sw_if_index] != which)
530 * @brief configure / deconfigure the IPFIX flow-per-packet
531 * @param fm flowprobe_main_t * fm
532 * @param sw_if_index u32 the desired interface
533 * @param is_add int 1 to enable the feature, 0 to disable it
534 * @returns 0 if successful, non-zero otherwise
538 flowprobe_tx_interface_add_del_feature (flowprobe_main_t * fm,
539 u32 sw_if_index, u8 which, int is_add)
541 vlib_main_t *vm = vlib_get_main ();
544 flowprobe_record_t flags = fm->record;
546 fm->flow_per_interface[sw_if_index] = (is_add) ? which : (u8) ~ 0;
547 fm->template_per_flow[which] += (is_add) ? 1 : -1;
548 if (is_add && fm->template_per_flow[which] > 1)
549 template_id = fm->template_reports[flags];
551 if ((is_add && fm->template_per_flow[which] == 1) ||
552 (!is_add && fm->template_per_flow[which] == 0))
554 if (which == FLOW_VARIANT_L2)
556 if (fm->record & FLOW_RECORD_L2)
558 rv = flowprobe_template_add_del (1, UDP_DST_PORT_ipfix, flags,
559 flowprobe_data_callback_l2,
560 flowprobe_template_rewrite_l2,
561 is_add, &template_id);
563 if (fm->record & FLOW_RECORD_L3 || fm->record & FLOW_RECORD_L4)
565 rv = flowprobe_template_add_del (1, UDP_DST_PORT_ipfix, flags,
566 flowprobe_data_callback_l2,
567 flowprobe_template_rewrite_l2_ip4,
568 is_add, &template_id);
569 fm->template_reports[flags | FLOW_RECORD_L2_IP4] =
570 (is_add) ? template_id : 0;
572 flowprobe_template_add_del (1, UDP_DST_PORT_ipfix, flags,
573 flowprobe_data_callback_l2,
574 flowprobe_template_rewrite_l2_ip6,
575 is_add, &template_id);
576 fm->template_reports[flags | FLOW_RECORD_L2_IP6] =
577 (is_add) ? template_id : 0;
579 /* Special case L2 */
580 fm->context[FLOW_VARIANT_L2_IP4].flags =
581 flags | FLOW_RECORD_L2_IP4;
582 fm->context[FLOW_VARIANT_L2_IP6].flags =
583 flags | FLOW_RECORD_L2_IP6;
585 fm->template_reports[flags] = template_id;
588 else if (which == FLOW_VARIANT_IP4)
589 rv = flowprobe_template_add_del (1, UDP_DST_PORT_ipfix, flags,
590 flowprobe_data_callback_ip4,
591 flowprobe_template_rewrite_ip4,
592 is_add, &template_id);
593 else if (which == FLOW_VARIANT_IP6)
594 rv = flowprobe_template_add_del (1, UDP_DST_PORT_ipfix, flags,
595 flowprobe_data_callback_ip6,
596 flowprobe_template_rewrite_ip6,
597 is_add, &template_id);
599 if (rv && rv != VNET_API_ERROR_VALUE_EXIST)
601 clib_warning ("vnet_flow_report_add_del returned %d", rv);
605 if (which != (u8) ~ 0)
607 fm->context[which].flags = fm->record;
608 fm->template_reports[flags] = (is_add) ? template_id : 0;
611 if (which == FLOW_VARIANT_IP4)
612 vnet_feature_enable_disable ("ip4-output", "flowprobe-ip4",
613 sw_if_index, is_add, 0, 0);
614 else if (which == FLOW_VARIANT_IP6)
615 vnet_feature_enable_disable ("ip6-output", "flowprobe-ip6",
616 sw_if_index, is_add, 0, 0);
617 else if (which == FLOW_VARIANT_L2)
618 vnet_feature_enable_disable ("interface-output", "flowprobe-l2",
619 sw_if_index, is_add, 0, 0);
621 /* Stateful flow collection */
622 if (is_add && !fm->initialized)
624 flowprobe_create_state_tables (fm->active_timer);
625 if (fm->active_timer)
626 vlib_process_signal_event (vm, flowprobe_timer_node.index, 1, 0);
633 * @brief API message handler
634 * @param mp vl_api_flowprobe_tx_interface_add_del_t * mp the api message
636 void vl_api_flowprobe_tx_interface_add_del_t_handler
637 (vl_api_flowprobe_tx_interface_add_del_t * mp)
639 flowprobe_main_t *fm = &flowprobe_main;
640 vl_api_flowprobe_tx_interface_add_del_reply_t *rmp;
641 u32 sw_if_index = ntohl (mp->sw_if_index);
644 VALIDATE_SW_IF_INDEX (mp);
646 if (mp->which != FLOW_VARIANT_IP4 && mp->which != FLOW_VARIANT_L2
647 && mp->which != FLOW_VARIANT_IP6)
649 rv = VNET_API_ERROR_UNIMPLEMENTED;
655 clib_warning ("Please specify flowprobe params record first...");
656 rv = VNET_API_ERROR_CANNOT_ENABLE_DISABLE_FEATURE;
660 rv = validate_feature_on_interface (fm, sw_if_index, mp->which);
661 if ((rv == 1 && mp->is_add == 1) || rv == 0)
663 rv = VNET_API_ERROR_CANNOT_ENABLE_DISABLE_FEATURE;
667 rv = flowprobe_tx_interface_add_del_feature
668 (fm, sw_if_index, mp->which, mp->is_add);
671 BAD_SW_IF_INDEX_LABEL;
673 REPLY_MACRO (VL_API_FLOWPROBE_TX_INTERFACE_ADD_DEL_REPLY);
677 * @brief API message custom-dump function
678 * @param mp vl_api_flowprobe_tx_interface_add_del_t * mp the api message
679 * @param handle void * print function handle
680 * @returns u8 * output string
682 static void *vl_api_flowprobe_tx_interface_add_del_t_print
683 (vl_api_flowprobe_tx_interface_add_del_t * mp, void *handle)
687 s = format (0, "SCRIPT: flowprobe_tx_interface_add_del ");
688 s = format (s, "sw_if_index %d is_add %d which %d ",
689 clib_host_to_net_u32 (mp->sw_if_index),
690 (int) mp->is_add, (int) mp->which);
694 #define vec_neg_search(v,E) \
697 while (_v(i) < vec_len(v) && v[_v(i)] == E) \
701 if (_v(i) == vec_len(v)) \
707 flowprobe_params (flowprobe_main_t * fm, u8 record_l2,
708 u8 record_l3, u8 record_l4,
709 u32 active_timer, u32 passive_timer)
711 flowprobe_record_t flags = 0;
713 if (vec_neg_search (fm->flow_per_interface, (u8) ~ 0) != ~0)
717 flags |= FLOW_RECORD_L2;
719 flags |= FLOW_RECORD_L3;
721 flags |= FLOW_RECORD_L4;
726 * Timers: ~0 is default, 0 is off
729 (active_timer == (u32) ~ 0 ? FLOWPROBE_TIMER_ACTIVE : active_timer);
731 (passive_timer == (u32) ~ 0 ? FLOWPROBE_TIMER_PASSIVE : passive_timer);
737 vl_api_flowprobe_params_t_handler (vl_api_flowprobe_params_t * mp)
739 flowprobe_main_t *fm = &flowprobe_main;
740 vl_api_flowprobe_params_reply_t *rmp;
743 rv = flowprobe_params
744 (fm, mp->record_l2, mp->record_l3, mp->record_l4,
745 clib_net_to_host_u32 (mp->active_timer),
746 clib_net_to_host_u32 (mp->passive_timer));
748 REPLY_MACRO (VL_API_FLOWPROBE_PARAMS_REPLY);
751 /* List of message types that this plugin understands */
752 #define foreach_flowprobe_plugin_api_msg \
753 _(FLOWPROBE_TX_INTERFACE_ADD_DEL, flowprobe_tx_interface_add_del) \
754 _(FLOWPROBE_PARAMS, flowprobe_params)
757 VLIB_PLUGIN_REGISTER () = {
758 .version = VPP_BUILD_VER,
759 .description = "Flow per Packet",
764 format_flowprobe_entry (u8 * s, va_list * args)
766 flowprobe_entry_t *e = va_arg (*args, flowprobe_entry_t *);
767 s = format (s, " %d/%d", e->key.rx_sw_if_index, e->key.tx_sw_if_index);
769 s = format (s, " %U %U", format_ethernet_address, &e->key.src_mac,
770 format_ethernet_address, &e->key.dst_mac);
771 s = format (s, " %U -> %U",
772 format_ip46_address, &e->key.src_address, IP46_TYPE_ANY,
773 format_ip46_address, &e->key.dst_address, IP46_TYPE_ANY);
774 s = format (s, " %d", e->key.protocol);
775 s = format (s, " %d %d\n", clib_net_to_host_u16 (e->key.src_port),
776 clib_net_to_host_u16 (e->key.dst_port));
781 static clib_error_t *
782 flowprobe_show_table_fn (vlib_main_t * vm,
783 unformat_input_t * input, vlib_cli_command_t * cm)
785 flowprobe_main_t *fm = &flowprobe_main;
787 flowprobe_entry_t *e;
789 vlib_cli_output (vm, "Dumping IPFIX table");
791 for (i = 0; i < vec_len (fm->pool_per_worker); i++)
794 pool_foreach (e, fm->pool_per_worker[i], (
796 vlib_cli_output (vm, "%U",
797 format_flowprobe_entry,
806 static clib_error_t *
807 flowprobe_show_stats_fn (vlib_main_t * vm,
808 unformat_input_t * input, vlib_cli_command_t * cm)
810 flowprobe_main_t *fm = &flowprobe_main;
813 vlib_cli_output (vm, "IPFIX table statistics");
814 vlib_cli_output (vm, "Flow entry size: %d\n", sizeof (flowprobe_entry_t));
815 vlib_cli_output (vm, "Flow pool size per thread: %d\n",
816 0x1 << FLOWPROBE_LOG2_HASHSIZE);
818 for (i = 0; i < vec_len (fm->pool_per_worker); i++)
819 vlib_cli_output (vm, "Pool utilisation thread %d is %d%%\n", i,
820 (100 * pool_elts (fm->pool_per_worker[i])) /
821 (0x1 << FLOWPROBE_LOG2_HASHSIZE));
825 static clib_error_t *
826 flowprobe_tx_interface_add_del_feature_command_fn (vlib_main_t * vm,
827 unformat_input_t * input,
828 vlib_cli_command_t * cmd)
830 flowprobe_main_t *fm = &flowprobe_main;
831 u32 sw_if_index = ~0;
833 u8 which = FLOW_VARIANT_IP4;
836 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
838 if (unformat (input, "disable"))
840 else if (unformat (input, "%U", unformat_vnet_sw_interface,
841 fm->vnet_main, &sw_if_index));
842 else if (unformat (input, "ip4"))
843 which = FLOW_VARIANT_IP4;
844 else if (unformat (input, "ip6"))
845 which = FLOW_VARIANT_IP6;
846 else if (unformat (input, "l2"))
847 which = FLOW_VARIANT_L2;
853 return clib_error_return (0,
854 "Please specify flowprobe params record first...");
856 if (sw_if_index == ~0)
857 return clib_error_return (0, "Please specify an interface...");
859 rv = validate_feature_on_interface (fm, sw_if_index, which);
863 return clib_error_return (0,
864 "Datapath is already enabled for given interface...");
867 return clib_error_return (0,
868 "Interface has enable different datapath ...");
871 flowprobe_tx_interface_add_del_feature (fm, sw_if_index, which, is_add);
877 case VNET_API_ERROR_INVALID_SW_IF_INDEX:
878 return clib_error_return
879 (0, "Invalid interface, only works on physical ports");
882 case VNET_API_ERROR_UNIMPLEMENTED:
883 return clib_error_return (0, "ip6 not supported");
887 return clib_error_return (0, "flowprobe_enable_disable returned %d",
893 static clib_error_t *
894 flowprobe_params_command_fn (vlib_main_t * vm,
895 unformat_input_t * input,
896 vlib_cli_command_t * cmd)
898 flowprobe_main_t *fm = &flowprobe_main;
899 bool record_l2 = false, record_l3 = false, record_l4 = false;
900 u32 active_timer = ~0;
901 u32 passive_timer = ~0;
903 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
905 if (unformat (input, "active %d", &active_timer))
907 else if (unformat (input, "passive %d", &passive_timer))
909 else if (unformat (input, "record"))
910 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
912 if (unformat (input, "l2"))
914 else if (unformat (input, "l3"))
916 else if (unformat (input, "l4"))
925 if (passive_timer > 0 && active_timer > passive_timer)
926 return clib_error_return (0,
927 "Passive timer has to be greater than active one...");
929 if (flowprobe_params (fm, record_l2, record_l3, record_l4,
930 active_timer, passive_timer))
931 return clib_error_return (0,
932 "Couldn't change flowperpacket params when feature is enabled on some interface ...");
937 * '<em>flowprobe feature add-del</em>' commands to enable/disable
938 * per-packet IPFIX flow record generation on an interface
942 * To enable per-packet IPFIX flow-record generation on an interface:
943 * @cliexcmd{flowprobe feature add-del GigabitEthernet2/0/0}
945 * To disable per-packet IPFIX flow-record generation on an interface:
946 * @cliexcmd{flowprobe feature add-del GigabitEthernet2/0/0 disable}
951 VLIB_CLI_COMMAND (flowprobe_enable_disable_command, static) = {
952 .path = "flowprobe feature add-del",
954 "flowprobe feature add-del <interface-name> <l2|ip4|ip6> disable",
955 .function = flowprobe_tx_interface_add_del_feature_command_fn,
957 VLIB_CLI_COMMAND (flowprobe_params_command, static) = {
958 .path = "flowprobe params",
960 "flowprobe params record <[l2] [l3] [l4]> [active <timer> passive <timer>]",
961 .function = flowprobe_params_command_fn,
963 VLIB_CLI_COMMAND (flowprobe_show_table_command, static) = {
964 .path = "show flowprobe table",
965 .short_help = "show flowprobe table",
966 .function = flowprobe_show_table_fn,
968 VLIB_CLI_COMMAND (flowprobe_show_stats_command, static) = {
969 .path = "show flowprobe statistics",
970 .short_help = "show flowprobe statistics",
971 .function = flowprobe_show_stats_fn,
976 * @brief Set up the API message handling tables
977 * @param vm vlib_main_t * vlib main data structure pointer
978 * @returns 0 to indicate all is well
980 static clib_error_t *
981 flowprobe_plugin_api_hookup (vlib_main_t * vm)
983 flowprobe_main_t *fm = &flowprobe_main;
985 vl_msg_api_set_handlers((VL_API_##N + fm->msg_id_base), \
987 vl_api_##n##_t_handler, \
989 vl_api_##n##_t_endian, \
990 vl_api_##n##_t_print, \
991 sizeof(vl_api_##n##_t), 1);
992 foreach_flowprobe_plugin_api_msg;
998 #define vl_msg_name_crc_list
999 #include <flowprobe/flowprobe_all_api_h.h>
1000 #undef vl_msg_name_crc_list
1003 setup_message_id_table (flowprobe_main_t * fm, api_main_t * am)
1005 #define _(id,n,crc) \
1006 vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + fm->msg_id_base);
1007 foreach_vl_msg_name_crc_flowprobe;
1012 * Main-core process, sending an interrupt to the per worker input
1013 * process that spins the per worker timer wheel.
1016 timer_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
1018 uword *event_data = 0;
1019 vlib_main_t **worker_vms = 0, *worker_vm;
1020 flowprobe_main_t *fm = &flowprobe_main;
1022 /* Wait for Godot... */
1023 vlib_process_wait_for_event_or_clock (vm, 1e9);
1024 uword event_type = vlib_process_get_events (vm, &event_data);
1025 if (event_type != 1)
1026 clib_warning ("bogus kickoff event received, %d", event_type);
1027 vec_reset_length (event_data);
1030 if (vec_len (vlib_mains) == 0)
1031 vec_add1 (worker_vms, vm);
1034 for (i = 0; i < vec_len (vlib_mains); i++)
1036 worker_vm = vlib_mains[i];
1038 vec_add1 (worker_vms, worker_vm);
1041 f64 sleep_duration = 0.1;
1045 /* Send an interrupt to each timer input node */
1046 sleep_duration = 0.1;
1047 for (i = 0; i < vec_len (worker_vms); i++)
1049 worker_vm = worker_vms[i];
1052 vlib_node_set_interrupt_pending (worker_vm,
1053 flowprobe_walker_node.index);
1055 (fm->expired_passive_per_worker[i] > 0) ? 1e-4 : 0.1;
1058 vlib_process_suspend (vm, sleep_duration);
1060 return 0; /* or not */
1064 VLIB_REGISTER_NODE (flowprobe_timer_node,static) = {
1065 .function = timer_process,
1066 .name = "flowprobe-timer-process",
1067 .type = VLIB_NODE_TYPE_PROCESS,
1072 * @brief Set up the API message handling tables
1073 * @param vm vlib_main_t * vlib main data structure pointer
1074 * @returns 0 to indicate all is well, or a clib_error_t
1076 static clib_error_t *
1077 flowprobe_init (vlib_main_t * vm)
1079 flowprobe_main_t *fm = &flowprobe_main;
1080 vlib_thread_main_t *tm = &vlib_thread_main;
1081 clib_error_t *error = 0;
1086 fm->vnet_main = vnet_get_main ();
1088 /* Construct the API name */
1089 name = format (0, "flowprobe_%08x%c", api_version, 0);
1091 /* Ask for a correctly-sized block of API message decode slots */
1092 fm->msg_id_base = vl_msg_api_get_msg_ids
1093 ((char *) name, VL_MSG_FIRST_AVAILABLE);
1095 /* Hook up message handlers */
1096 error = flowprobe_plugin_api_hookup (vm);
1098 /* Add our API messages to the global name_crc hash table */
1099 setup_message_id_table (fm, &api_main);
1103 /* Set up time reference pair */
1104 fm->vlib_time_0 = vlib_time_now (vm);
1105 fm->nanosecond_time_0 = unix_time_now_nsec ();
1107 memset (fm->template_reports, 0, sizeof (fm->template_reports));
1108 memset (fm->template_size, 0, sizeof (fm->template_size));
1109 memset (fm->template_per_flow, 0, sizeof (fm->template_per_flow));
1111 /* Decide how many worker threads we have */
1112 num_threads = 1 /* main thread */ + tm->n_threads;
1114 /* Allocate per worker thread vectors per flavour */
1115 for (i = 0; i < FLOW_N_VARIANTS; i++)
1117 vec_validate (fm->context[i].buffers_per_worker, num_threads - 1);
1118 vec_validate (fm->context[i].frames_per_worker, num_threads - 1);
1119 vec_validate (fm->context[i].next_record_offset_per_worker,
1123 fm->active_timer = FLOWPROBE_TIMER_ACTIVE;
1124 fm->passive_timer = FLOWPROBE_TIMER_PASSIVE;
1129 VLIB_INIT_FUNCTION (flowprobe_init);
1132 * fd.io coding-style-patch-verification: ON
1135 * eval: (c-set-style "gnu")