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.
15 #include <vnet/ipfix-export/flow_report.h>
16 #include <vnet/ipfix-export/flow_report_classify.h>
17 #include <vnet/api_errno.h>
18 #include <vnet/classify/vnet_classify.h>
19 #include <vnet/ip/ip4.h>
20 #include <vnet/udp/udp_local.h>
22 /* Common prefix of tcp and udp headers
23 * containing only source and destination port fields */
26 u16 src_port, dst_port;
29 flow_report_classify_main_t flow_report_classify_main;
32 ipfix_classify_template_rewrite (ipfix_exporter_t *exp, flow_report_t *fr,
34 ipfix_report_element_t *elts, u32 n_elts,
37 flow_report_classify_main_t *fcm = &flow_report_classify_main;
38 vnet_classify_table_t *tblp;
39 vnet_classify_main_t *vcm = &vnet_classify_main;
40 u32 flow_table_index = fr->opaque.as_uword;
44 tcpudp_header_t *tcpudp;
46 ipfix_message_header_t *h;
47 ipfix_set_header_t *s;
48 ipfix_template_header_t *t;
49 ipfix_field_specifier_t *f;
50 ipfix_field_specifier_t *first_field;
52 ip4_ipfix_template_packet_t *tp;
55 flow_report_stream_t *stream;
57 u8 transport_protocol;
61 stream = &exp->streams[fr->stream_index];
63 ipfix_classify_table_t *table = &fcm->tables[flow_table_index];
65 ip_version = table->ip_version;
66 transport_protocol = table->transport_protocol;
68 tblp = pool_elt_at_index (vcm->tables, table->classify_table_index);
70 virt_mask = (u8 *) (tblp->mask - tblp->skip_n_vectors);
71 real_mask = (u8 *) (tblp->mask);
73 /* Determine field count */
74 ip_start = virt_mask + sizeof (ethernet_header_t);
75 #define _(field,mask,item,length) \
76 if (((u8 *)&field >= real_mask) && (memcmp(&field, &mask, length) == 0)) \
80 fr->fields_to_send = clib_bitmap_set (fr->fields_to_send, \
87 /* Add packetTotalCount manually */
90 /* $$$ enterprise fields, at some later date */
92 /* allocate rewrite space */
93 vec_validate_aligned (rewrite,
94 sizeof (ip4_ipfix_template_packet_t)
95 + field_count * sizeof (ipfix_field_specifier_t) - 1,
96 CLIB_CACHE_LINE_BYTES);
98 tp = (ip4_ipfix_template_packet_t *) rewrite;
99 ip = (ip4_header_t *) & tp->ip4;
100 udp = (udp_header_t *) (ip + 1);
101 h = (ipfix_message_header_t *) (udp + 1);
102 s = (ipfix_set_header_t *) (h + 1);
103 t = (ipfix_template_header_t *) (s + 1);
104 first_field = f = (ipfix_field_specifier_t *) (t + 1);
106 ip->ip_version_and_header_length = 0x45;
108 ip->protocol = IP_PROTOCOL_UDP;
109 ip->src_address.as_u32 = exp->src_address.ip.ip4.as_u32;
110 ip->dst_address.as_u32 = exp->ipfix_collector.ip.ip4.as_u32;
111 udp->src_port = clib_host_to_net_u16 (stream->src_port);
112 udp->dst_port = clib_host_to_net_u16 (collector_port);
113 udp->length = clib_host_to_net_u16 (vec_len (rewrite) - sizeof (*ip));
115 /* FIXUP: message header export_time */
116 /* FIXUP: message header sequence_number */
117 h->domain_id = clib_host_to_net_u32 (stream->domain_id);
119 /* Take another trip through the mask and build the template */
120 ip_start = virt_mask + sizeof (ethernet_header_t);
121 #define _(field,mask,item,length) \
122 if (((u8 *)&field >= real_mask) && (memcmp(&field, &mask, length) == 0)) \
124 f->e_id_length = ipfix_e_id_length (0 /* enterprise */, \
131 /* Add packetTotalCount manually */
133 ipfix_e_id_length (0 /* enterprise */ , packetTotalCount, 8);
136 /* Back to the template packet... */
137 ip = (ip4_header_t *) & tp->ip4;
138 udp = (udp_header_t *) (ip + 1);
140 ASSERT (f - first_field);
141 /* Field count in this template */
142 t->id_count = ipfix_id_count (fr->template_id, f - first_field);
144 /* set length in octets */
146 ipfix_set_id_length (2 /* set_id */ , (u8 *) f - (u8 *) s);
148 /* message length in octets */
149 h->version_length = version_length ((u8 *) f - (u8 *) h);
151 ip->length = clib_host_to_net_u16 ((u8 *) f - (u8 *) ip);
152 ip->checksum = ip4_header_checksum (ip);
158 ipfix_classify_send_flows (flow_report_main_t *frm, ipfix_exporter_t *exp,
159 flow_report_t *fr, vlib_frame_t *f, u32 *to_next,
162 flow_report_classify_main_t *fcm = &flow_report_classify_main;
163 vnet_classify_main_t *vcm = &vnet_classify_main;
164 u32 flow_table_index = fr->opaque.as_uword;
165 vnet_classify_table_t *t;
166 vnet_classify_bucket_t *b;
167 vnet_classify_entry_t *v, *save_v;
168 vlib_buffer_t *b0 = 0;
170 u32 record_offset = 0;
173 ip4_ipfix_template_packet_t *tp;
174 ipfix_message_header_t *h = 0;
175 ipfix_set_header_t *s = 0;
179 tcpudp_header_t *tcpudp;
182 u32 records_this_buffer;
185 vlib_main_t *vm = frm->vlib_main;
186 flow_report_stream_t *stream;
188 u8 transport_protocol;
191 stream = &exp->streams[fr->stream_index];
193 ipfix_classify_table_t *table = &fcm->tables[flow_table_index];
195 ip_version = table->ip_version;
196 transport_protocol = table->transport_protocol;
198 t = pool_elt_at_index (vcm->tables, table->classify_table_index);
200 clib_spinlock_lock (&t->writer_lock);
202 for (i = 0; i < t->nbuckets; i++)
208 save_v = vnet_classify_get_entry (t, b->offset);
209 for (j = 0; j < (1 << b->log2_pages); j++)
211 for (k = 0; k < t->entries_per_page; k++)
213 v = vnet_classify_entry_at_index
214 (t, save_v, j * t->entries_per_page + k);
216 if (vnet_classify_entry_is_free (v))
219 /* OK, we have something to send... */
220 if (PREDICT_FALSE (b0 == 0))
222 if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
224 b0 = vlib_get_buffer (vm, bi0);
226 u32 copy_len = sizeof (ip4_header_t) +
227 sizeof (udp_header_t) + sizeof (ipfix_message_header_t);
228 clib_memcpy_fast (b0->data, fr->rewrite, copy_len);
229 b0->current_data = 0;
230 b0->current_length = copy_len;
231 b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
232 vnet_buffer (b0)->sw_if_index[VLIB_RX] = 0;
233 vnet_buffer (b0)->sw_if_index[VLIB_TX] = exp->fib_index;
235 tp = vlib_buffer_get_current (b0);
236 ip = (ip4_header_t *) & tp->ip4;
237 udp = (udp_header_t *) (ip + 1);
238 h = (ipfix_message_header_t *) (udp + 1);
239 s = (ipfix_set_header_t *) (h + 1);
241 /* FIXUP: message header export_time */
242 h->export_time = (u32)
243 (((f64) frm->unix_time_0) +
244 (vlib_time_now (frm->vlib_main) - frm->vlib_time_0));
245 h->export_time = clib_host_to_net_u32 (h->export_time);
247 /* FIXUP: message header sequence_number */
248 h->sequence_number = stream->sequence_number;
250 clib_host_to_net_u32 (h->sequence_number);
252 next_offset = (u32) (((u8 *) (s + 1)) - (u8 *) tp);
253 record_offset = next_offset;
254 records_this_buffer = 0;
258 virt_key = (u8 *) (v->key - t->skip_n_vectors);
259 ip_start = virt_key + sizeof (ethernet_header_t);
260 #define _(field,mask,item,length) \
261 if (clib_bitmap_get (fr->fields_to_send, field_index)) \
263 clib_memcpy_fast (b0->data + next_offset, &field, \
265 next_offset += length; \
271 /* Add packetTotalCount manually */
273 u64 packets = clib_host_to_net_u64 (v->hits);
274 clib_memcpy_fast (b0->data + next_offset, &packets,
276 next_offset += sizeof (packets);
278 records_this_buffer++;
279 stream->sequence_number++;
281 /* Next record will have the same size as this record */
282 u32 next_record_size = next_offset - record_offset;
283 record_offset = next_offset;
285 if (next_offset + next_record_size > exp->path_mtu)
287 s->set_id_length = ipfix_set_id_length (fr->template_id,
293 version_length (next_offset -
294 (sizeof (*ip) + sizeof (*udp)));
295 b0->current_length = next_offset;
296 b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
298 tp = vlib_buffer_get_current (b0);
299 ip = (ip4_header_t *) & tp->ip4;
300 udp = (udp_header_t *) (ip + 1);
304 new_l0 = clib_host_to_net_u16 ((u16) next_offset);
306 sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
307 length /* changed member */ );
309 ip->checksum = ip_csum_fold (sum0);
312 clib_host_to_net_u16 (b0->current_length - sizeof (*ip));
314 if (exp->udp_checksum)
316 /* RFC 7011 section 10.3.2. */
318 ip4_tcp_udp_compute_checksum (vm, b0, ip);
319 if (udp->checksum == 0)
320 udp->checksum = 0xffff;
323 ASSERT (ip4_header_checksum_is_valid (ip));
329 if (f->n_vectors == VLIB_FRAME_SIZE)
331 vlib_put_frame_to_node (vm, node_index, f);
332 f = vlib_get_frame_to_node (vm, node_index);
334 to_next = vlib_frame_vector_args (f);
346 s->set_id_length = ipfix_set_id_length (fr->template_id,
348 (sizeof (*ip) + sizeof (*udp) +
350 h->version_length = version_length (next_offset -
351 (sizeof (*ip) + sizeof (*udp)));
352 b0->current_length = next_offset;
353 b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
355 tp = vlib_buffer_get_current (b0);
356 ip = (ip4_header_t *) & tp->ip4;
357 udp = (udp_header_t *) (ip + 1);
361 new_l0 = clib_host_to_net_u16 ((u16) next_offset);
363 sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
364 length /* changed member */ );
366 ip->checksum = ip_csum_fold (sum0);
368 udp->length = clib_host_to_net_u16 (b0->current_length - sizeof (*ip));
370 if (exp->udp_checksum)
372 /* RFC 7011 section 10.3.2. */
373 udp->checksum = ip4_tcp_udp_compute_checksum (vm, b0, ip);
374 if (udp->checksum == 0)
375 udp->checksum = 0xffff;
378 ASSERT (ip4_header_checksum_is_valid (ip));
387 clib_spinlock_unlock (&t->writer_lock);
391 static clib_error_t *
392 ipfix_classify_table_add_del_command_fn (vlib_main_t * vm,
393 unformat_input_t * input,
394 vlib_cli_command_t * cmd)
396 flow_report_classify_main_t *fcm = &flow_report_classify_main;
397 ipfix_exporter_t *exp = &flow_report_main.exporters[0];
398 vnet_flow_report_add_del_args_t args;
399 ipfix_classify_table_t *table;
402 u32 classify_table_index = ~0;
404 u8 transport_protocol = 255;
405 clib_error_t *error = 0;
407 if (fcm->src_port == 0)
408 clib_error_return (0, "call 'set ipfix classify stream' first");
410 clib_memset (&args, 0, sizeof (args));
412 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
414 if (unformat (input, "add"))
416 else if (unformat (input, "del"))
418 else if (unformat (input, "%d", &classify_table_index))
420 else if (unformat (input, "ip4"))
422 else if (unformat (input, "ip6"))
424 else if (unformat (input, "tcp"))
425 transport_protocol = 6;
426 else if (unformat (input, "udp"))
427 transport_protocol = 17;
429 return clib_error_return (0, "unknown input `%U'",
430 format_unformat_error, input);
434 return clib_error_return (0, "expecting: add|del");
435 if (classify_table_index == ~0)
436 return clib_error_return (0, "classifier table not specified");
438 return clib_error_return (0, "IP version not specified");
442 for (i = 0; i < vec_len (fcm->tables); i++)
443 if (ipfix_classify_table_index_valid (i))
444 if (fcm->tables[i].classify_table_index == classify_table_index)
446 table = &fcm->tables[i];
453 return clib_error_return (0,
454 "Specified classifier table already used");
455 table = ipfix_classify_add_table ();
456 table->classify_table_index = classify_table_index;
461 return clib_error_return (0,
462 "Specified classifier table not registered");
465 table->ip_version = ip_version;
466 table->transport_protocol = transport_protocol;
468 args.opaque.as_uword = table - fcm->tables;
469 args.rewrite_callback = ipfix_classify_template_rewrite;
470 args.flow_data_callback = ipfix_classify_send_flows;
471 args.is_add = is_add;
472 args.domain_id = fcm->domain_id;
473 args.src_port = fcm->src_port;
475 rv = vnet_flow_report_add_del (exp, &args, NULL);
477 error = flow_report_add_del_error_to_clib_error (rv);
479 /* If deleting, or add failed */
480 if (is_add == 0 || (rv && is_add))
481 ipfix_classify_delete_table (table - fcm->tables);
487 VLIB_CLI_COMMAND (ipfix_classify_table_add_del_command, static) = {
488 .path = "ipfix classify table",
489 .short_help = "ipfix classify table add|del <table-index>",
490 .function = ipfix_classify_table_add_del_command_fn,
494 static clib_error_t *
495 set_ipfix_classify_stream_command_fn (vlib_main_t * vm,
496 unformat_input_t * input,
497 vlib_cli_command_t * cmd)
499 flow_report_classify_main_t *fcm = &flow_report_classify_main;
500 ipfix_exporter_t *exp = &flow_report_main.exporters[0];
502 u32 src_port = UDP_DST_PORT_ipfix;
504 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
506 if (unformat (input, "domain %d", &domain_id))
508 else if (unformat (input, "src-port %d", &src_port))
511 return clib_error_return (0, "unknown input `%U'",
512 format_unformat_error, input);
515 if (fcm->src_port != 0 &&
516 (fcm->domain_id != domain_id || fcm->src_port != (u16) src_port))
518 int rv = vnet_stream_change (exp, fcm->domain_id, fcm->src_port,
519 domain_id, (u16) src_port);
523 fcm->domain_id = domain_id;
524 fcm->src_port = (u16) src_port;
530 VLIB_CLI_COMMAND (set_ipfix_classify_stream_command, static) = {
531 .path = "set ipfix classify stream",
532 .short_help = "set ipfix classify stream"
533 "[domain <domain-id>] [src-port <src-port>]",
534 .function = set_ipfix_classify_stream_command_fn,
538 static clib_error_t *
539 flow_report_classify_init (vlib_main_t * vm)
543 if ((error = vlib_call_init_function (vm, flow_report_init)))
549 VLIB_INIT_FUNCTION (flow_report_classify_init);
552 * fd.io coding-style-patch-verification: ON
555 * eval: (c-set-style "gnu")