FD.io VPP  v17.01.1-3-gc6833f8
Vector Packet Processing
flow_report_classify.c
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 #include <vnet/flow/flow_report.h>
17 #include <vnet/api_errno.h>
18 
19 /* Common prefix of tcp and udp headers
20  * containing only source and destination port fields */
21 typedef struct {
22  u16 src_port, dst_port;
24 
26 
28  flow_report_t * fr,
29  ip4_address_t * collector_address,
30  ip4_address_t * src_address,
31  u16 collector_port)
32 {
34  vnet_classify_table_t * tblp;
36  u32 flow_table_index = fr->opaque.as_uword;
37  u8 * ip_start;
38  ip4_header_t * ip;
39  ip6_header_t * ip6;
40  tcpudp_header_t * tcpudp;
41  udp_header_t * udp;
46  ipfix_field_specifier_t * first_field;
47  u8 * rewrite = 0;
49  i32 l3_offset = -2; /* sizeof (ethernet_header_t) - sizeof (u32x4) */
50  u32 field_count = 0;
51  u32 field_index = 0;
52  flow_report_stream_t * stream;
53  u8 ip_version;
54  u8 transport_protocol;
55 
56  stream = &frm->streams[fr->stream_index];
57 
58  ipfix_classify_table_t * table = &fcm->tables[flow_table_index];
59 
60  ip_version = table->ip_version;
61  transport_protocol = table->transport_protocol;
62 
63  tblp = pool_elt_at_index (vcm->tables, table->classify_table_index);
64 
65  /*
66  * Mumble, assumes that we're not classifying on L2 or first 2 octets
67  * of L3..
68  */
69 
70  /* Determine field count */
71  ip_start = ((u8 *)(tblp->mask)) + l3_offset;
72 #define _(field,mask,item,length) \
73  if (memcmp(&field, &mask, length) == 0) \
74  { \
75  field_count++; \
76  \
77  fr->fields_to_send = clib_bitmap_set (fr->fields_to_send, \
78  field_index, 1); \
79  } \
80  field_index++;
82 #undef _
83 
84  /* Add packetTotalCount manually */
85  field_count += 1;
86 
87  /* $$$ enterprise fields, at some later date */
88 
89  /* allocate rewrite space */
90  vec_validate_aligned (rewrite,
92  + field_count * sizeof (ipfix_field_specifier_t) - 1,
94 
95  tp = (ip4_ipfix_template_packet_t *) rewrite;
96  ip = (ip4_header_t *) &tp->ip4;
97  udp = (udp_header_t *) (ip+1);
98  h = (ipfix_message_header_t *)(udp+1);
99  s = (ipfix_set_header_t *)(h+1);
100  t = (ipfix_template_header_t *)(s+1);
101  first_field = f = (ipfix_field_specifier_t *)(t+1);
102 
103  ip->ip_version_and_header_length = 0x45;
104  ip->ttl = 254;
105  ip->protocol = IP_PROTOCOL_UDP;
106  ip->src_address.as_u32 = src_address->as_u32;
107  ip->dst_address.as_u32 = collector_address->as_u32;
108  udp->src_port = clib_host_to_net_u16 (stream->src_port);
109  udp->dst_port = clib_host_to_net_u16 (collector_port);
110  udp->length = clib_host_to_net_u16 (vec_len(rewrite) - sizeof (*ip));
111 
112  /* FIXUP: message header export_time */
113  /* FIXUP: message header sequence_number */
114  h->domain_id = clib_host_to_net_u32 (stream->domain_id);
115 
116  /* Take another trip through the mask and build the template */
117  ip_start = ((u8 *)(tblp->mask)) + l3_offset;
118 #define _(field,mask,item,length) \
119  if (memcmp(&field, &mask, length) == 0) \
120  { \
121  f->e_id_length = ipfix_e_id_length (0 /* enterprise */, \
122  item, length); \
123  f++; \
124  }
126 #undef _
127 
128  /* Add packetTotalCount manually */
129  f->e_id_length = ipfix_e_id_length (0 /* enterprise */, packetTotalCount, 8);
130  f++;
131 
132  /* Back to the template packet... */
133  ip = (ip4_header_t *) &tp->ip4;
134  udp = (udp_header_t *) (ip+1);
135 
136  ASSERT (f - first_field);
137  /* Field count in this template */
138  t->id_count = ipfix_id_count (fr->template_id, f - first_field);
139 
140  /* set length in octets*/
141  s->set_id_length = ipfix_set_id_length (2 /* set_id */, (u8 *) f - (u8 *)s);
142 
143  /* message length in octets */
144  h->version_length = version_length ((u8 *)f - (u8 *)h);
145 
146  ip->length = clib_host_to_net_u16 ((u8 *)f - (u8 *)ip);
147  ip->checksum = ip4_header_checksum (ip);
148 
149  return rewrite;
150 }
151 
153  flow_report_t * fr,
154  vlib_frame_t * f,
155  u32 * to_next,
156  u32 node_index)
157 {
160  u32 flow_table_index = fr->opaque.as_uword;
163  vnet_classify_entry_t * v, * save_v;
164  vlib_buffer_t *b0 = 0;
165  u32 next_offset = 0;
166  u32 record_offset = 0;
167  u32 bi0 = ~0;
168  int i, j, k;
170  ipfix_message_header_t * h = 0;
171  ipfix_set_header_t * s = 0;
172  u8 * ip_start;
173  ip4_header_t * ip;
174  ip6_header_t * ip6;
175  tcpudp_header_t * tcpudp;
176  udp_header_t * udp;
177  int field_index;
178  u32 records_this_buffer;
179  u16 new_l0, old_l0;
180  ip_csum_t sum0;
181  vlib_main_t * vm = frm->vlib_main;
182  flow_report_stream_t * stream;
183  u8 ip_version;
184  u8 transport_protocol;
185 
186  stream = &frm->streams[fr->stream_index];
187 
188  ipfix_classify_table_t * table = &fcm->tables[flow_table_index];
189 
190  ip_version = table->ip_version;
191  transport_protocol = table->transport_protocol;
192 
193  t = pool_elt_at_index (vcm->tables, table->classify_table_index);
194 
195  while (__sync_lock_test_and_set (t->writer_lock, 1))
196  ;
197 
198  for (i = 0; i < t->nbuckets; i++)
199  {
200  b = &t->buckets [i];
201  if (b->offset == 0)
202  continue;
203 
204  save_v = vnet_classify_get_entry (t, b->offset);
205  for (j = 0; j < (1<<b->log2_pages); j++)
206  {
207  for (k = 0; k < t->entries_per_page; k++)
208  {
210  (t, save_v, j*t->entries_per_page + k);
211 
213  continue;
214 
215  /* OK, we have something to send... */
216  if (PREDICT_FALSE (b0 == 0))
217  {
218  if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
219  goto flush;
220  b0 = vlib_get_buffer (vm, bi0);
221 
222  u32 copy_len = sizeof(ip4_header_t) +
223  sizeof(udp_header_t) +
224  sizeof(ipfix_message_header_t);
225  clib_memcpy (b0->data, fr->rewrite, copy_len);
226  b0->current_data = 0;
227  b0->current_length = copy_len;
229  vnet_buffer (b0)->sw_if_index[VLIB_RX] = 0;
230  vnet_buffer (b0)->sw_if_index[VLIB_TX] = frm->fib_index;
231 
232  tp = vlib_buffer_get_current (b0);
233  ip = (ip4_header_t *) &tp->ip4;
234  udp = (udp_header_t *) (ip+1);
235  h = (ipfix_message_header_t *)(udp+1);
236  s = (ipfix_set_header_t *)(h+1);
237 
238  /* FIXUP: message header export_time */
239  h->export_time = (u32)
240  (((f64)frm->unix_time_0) +
241  (vlib_time_now(frm->vlib_main) - frm->vlib_time_0));
242  h->export_time = clib_host_to_net_u32(h->export_time);
243 
244  /* FIXUP: message header sequence_number */
245  h->sequence_number = stream->sequence_number;
246  h->sequence_number = clib_host_to_net_u32 (h->sequence_number);
247 
248  next_offset = (u32) (((u8 *)(s+1)) - (u8 *)tp);
249  record_offset = next_offset;
250  records_this_buffer = 0;
251  }
252 
253  field_index = 0;
254  ip_start = ((u8 *)v->key) - 2;
255 #define _(field,mask,item,length) \
256  if (clib_bitmap_get (fr->fields_to_send, field_index)) \
257  { \
258  clib_memcpy (b0->data + next_offset, &field, \
259  length); \
260  next_offset += length; \
261  } \
262  field_index++;
264 #undef _
265 
266  /* Add packetTotalCount manually */
267  {
268  u64 packets = clib_host_to_net_u64 (v->hits);
269  clib_memcpy (b0->data + next_offset, &packets, sizeof (packets));
270  next_offset += sizeof (packets);
271  }
272  records_this_buffer++;
273  stream->sequence_number++;
274 
275  /* Next record will have the same size as this record */
276  u32 next_record_size = next_offset - record_offset;
277  record_offset = next_offset;
278 
279  if (next_offset + next_record_size > frm->path_mtu)
280  {
282  next_offset -
283  (sizeof (*ip) + sizeof (*udp) +
284  sizeof (*h)));
285  h->version_length = version_length (next_offset -
286  (sizeof (*ip) + sizeof (*udp)));
287  b0->current_length = next_offset;
289 
290  tp = vlib_buffer_get_current (b0);
291  ip = (ip4_header_t *) &tp->ip4;
292  udp = (udp_header_t *) (ip+1);
293 
294  sum0 = ip->checksum;
295  old_l0 = ip->length;
296  new_l0 =
297  clib_host_to_net_u16 ((u16)next_offset);
298 
299  sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
300  length /* changed member */);
301 
302  ip->checksum = ip_csum_fold (sum0);
303  ip->length = new_l0;
304  udp->length =
305  clib_host_to_net_u16 (b0->current_length - sizeof (*ip));
306 
307  if (frm->udp_checksum)
308  {
309  /* RFC 7011 section 10.3.2. */
310  udp->checksum = ip4_tcp_udp_compute_checksum (vm, b0, ip);
311  if (udp->checksum == 0)
312  udp->checksum = 0xffff;
313  }
314 
315  ASSERT (ip->checksum == ip4_header_checksum (ip));
316 
317  to_next[0] = bi0;
318  f->n_vectors++;
319  to_next++;
320 
321  if (f->n_vectors == VLIB_FRAME_SIZE)
322  {
323  vlib_put_frame_to_node (vm, node_index, f);
324  f = vlib_get_frame_to_node (vm, node_index);
325  f->n_vectors = 0;
326  to_next = vlib_frame_vector_args (f);
327  }
328  b0 = 0;
329  bi0 = ~0;
330  }
331  }
332  }
333  }
334 
335  flush:
336  if (b0)
337  {
339  next_offset -
340  (sizeof (*ip) + sizeof (*udp) +
341  sizeof (*h)));
342  h->version_length = version_length (next_offset -
343  (sizeof (*ip) + sizeof (*udp)));
344  b0->current_length = next_offset;
346 
347  tp = vlib_buffer_get_current (b0);
348  ip = (ip4_header_t *) &tp->ip4;
349  udp = (udp_header_t *) (ip+1);
350 
351  sum0 = ip->checksum;
352  old_l0 = ip->length;
353  new_l0 = clib_host_to_net_u16 ((u16)next_offset);
354 
355  sum0 = ip_csum_update (sum0, old_l0, new_l0, ip4_header_t,
356  length /* changed member */);
357 
358  ip->checksum = ip_csum_fold (sum0);
359  ip->length = new_l0;
360  udp->length = clib_host_to_net_u16 (b0->current_length - sizeof (*ip));
361 
362  if (frm->udp_checksum)
363  {
364  /* RFC 7011 section 10.3.2. */
365  udp->checksum = ip4_tcp_udp_compute_checksum (vm, b0, ip);
366  if (udp->checksum == 0)
367  udp->checksum = 0xffff;
368  }
369 
370  ASSERT (ip->checksum == ip4_header_checksum (ip));
371 
372  to_next[0] = bi0;
373  f->n_vectors++;
374 
375  b0 = 0;
376  bi0 = ~0;
377  }
378 
379  *(t->writer_lock) = 0;
380  return f;
381 }
382 
383 static clib_error_t *
385  unformat_input_t * input,
386  vlib_cli_command_t * cmd)
387 {
391  ipfix_classify_table_t * table;
392  int rv;
393  int is_add = -1;
394  u32 classify_table_index = ~0;
395  u8 ip_version = 0;
396  u8 transport_protocol = 255;
397  clib_error_t * error = 0;
398 
399  if (fcm->src_port == 0)
400  clib_error_return (0, "call 'set ipfix classify stream' first");
401 
402  memset (&args, 0, sizeof (args));
403 
404  while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT) {
405  if (unformat (input, "add"))
406  is_add = 1;
407  else if (unformat (input, "del"))
408  is_add = 0;
409  else if (unformat (input, "%d", &classify_table_index))
410  ;
411  else if (unformat (input, "ip4"))
412  ip_version = 4;
413  else if (unformat (input, "ip6"))
414  ip_version = 6;
415  else if (unformat (input, "tcp"))
416  transport_protocol = 6;
417  else if (unformat (input, "udp"))
418  transport_protocol = 17;
419  else
420  return clib_error_return (0, "unknown input `%U'",
421  format_unformat_error, input);
422  }
423 
424  if (is_add == -1)
425  return clib_error_return (0, "expecting: add|del");
426  if (classify_table_index == ~0)
427  return clib_error_return (0, "classifier table not specified");
428  if (ip_version == 0)
429  return clib_error_return (0, "IP version not specified");
430 
431  table = 0;
432  int i;
433  for (i = 0; i < vec_len(fcm->tables); i++)
435  if (fcm->tables[i].classify_table_index == classify_table_index) {
436  table = &fcm->tables[i];
437  break;
438  }
439 
440  if (is_add) {
441  if (table)
442  return clib_error_return (0, "Specified classifier table already used");
443  table = ipfix_classify_add_table();
444  table->classify_table_index = classify_table_index;
445  } else {
446  if (!table)
447  return clib_error_return (0, "Specified classifier table not registered");
448  }
449 
450  table->ip_version = ip_version;
451  table->transport_protocol = transport_protocol;
452 
453  args.opaque.as_uword = table - fcm->tables;
456  args.is_add = is_add;
457  args.domain_id = fcm->domain_id;
458  args.src_port = fcm->src_port;
459 
460  rv = vnet_flow_report_add_del (frm, &args);
461 
463 
464  /* If deleting, or add failed */
465  if (is_add == 0 || (rv && is_add))
466  ipfix_classify_delete_table (table - fcm->tables);
467 
468  return error;
469 }
470 
471 VLIB_CLI_COMMAND (ipfix_classify_table_add_del_command, static) = {
472  .path = "ipfix classify table",
473  .short_help = "ipfix classify table add|del <table-index>",
475 };
476 
477 static clib_error_t *
479  unformat_input_t * input,
480  vlib_cli_command_t * cmd)
481 {
484  u32 domain_id = 1;
485  u32 src_port = UDP_DST_PORT_ipfix;
486 
487  while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT) {
488  if (unformat (input, "domain %d", &domain_id))
489  ;
490  else if (unformat (input, "src-port %d", &src_port))
491  ;
492  else
493  return clib_error_return (0, "unknown input `%U'",
494  format_unformat_error, input);
495  }
496 
497  if (fcm->src_port != 0 &&
498  (fcm->domain_id != domain_id ||
499  fcm->src_port != (u16)src_port)) {
500  int rv = vnet_stream_change (frm, fcm->domain_id, fcm->src_port,
501  domain_id, (u16)src_port);
502  ASSERT (rv == 0);
503  }
504 
505  fcm->domain_id = domain_id;
506  fcm->src_port = (u16)src_port;
507 
508  return 0;
509 }
510 
511 VLIB_CLI_COMMAND (set_ipfix_classify_stream_command, static) = {
512  .path = "set ipfix classify stream",
513  .short_help = "set ipfix classify stream"
514  "[domain <domain-id>] [src-port <src-port>]",
516 };
517 
518 static clib_error_t *
520 {
521  clib_error_t * error;
522 
523  if ((error = vlib_call_init_function (vm, flow_report_init)))
524  return error;
525 
526  return 0;
527 }
528 
clib_error_t * flow_report_add_del_error_to_clib_error(int error)
Definition: flow_report.c:309
sll srl srl sll sra u16x4 i
Definition: vector_sse2.h:343
uword unformat(unformat_input_t *i, char *fmt,...)
Definition: unformat.c:966
ip4_address_t src_address
Definition: ip4_packet.h:163
static_always_inline void ipfix_classify_delete_table(u32 index)
uword as_uword
Definition: flow_report.h:57
static_always_inline u8 ipfix_classify_table_index_valid(u32 index)
#define UNFORMAT_END_OF_INPUT
Definition: format.h:143
static u32 ipfix_e_id_length(int e, u16 id, u16 length)
Definition: ipfix_packet.h:72
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:182
u32 stream_index
Definition: flow_report.h:72
opaque_t opaque
Definition: flow_report.h:80
uword ip_csum_t
Definition: ip_packet.h:90
#define vec_validate_aligned(V, I, A)
Make sure vector is long enough for given index (no header, specified alignment)
Definition: vec.h:407
flow_report_stream_t * streams
Definition: flow_report.h:91
i16 current_data
signed offset in data[], pre_data[] that we are currently processing.
Definition: buffer.h:78
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:111
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:194
ip4_address_t dst_address
Definition: ip4_packet.h:163
vnet_flow_rewrite_callback_t * rewrite_callback
Definition: flow_report.h:125
int i32
Definition: types.h:81
unsigned long u64
Definition: types.h:89
#define vlib_call_init_function(vm, x)
Definition: init.h:161
static int vnet_classify_entry_is_free(vnet_classify_entry_t *e)
flow_report_main_t flow_report_main
Definition: flow_report.c:21
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:369
flow_report_classify_main_t flow_report_classify_main
u16 current_length
Nbytes between current data and the end of this buffer.
Definition: buffer.h:82
#define v
Definition: acl.c:314
u8 * rewrite
Definition: flow_report.h:70
#define PREDICT_FALSE(x)
Definition: clib.h:97
#define VLIB_FRAME_SIZE
Definition: node.h:328
void vlib_put_frame_to_node(vlib_main_t *vm, u32 to_node_index, vlib_frame_t *f)
Definition: main.c:196
static u32 version_length(u16 length)
Definition: ipfix_packet.h:31
static vnet_classify_entry_t * vnet_classify_entry_at_index(vnet_classify_table_t *t, vnet_classify_entry_t *e, u32 index)
ipfix_classify_table_t * tables
u16 n_vectors
Definition: node.h:344
static u32 ipfix_id_count(u16 id, u16 count)
Definition: ipfix_packet.h:175
#define clib_memcpy(a, b, c)
Definition: string.h:69
#define VLIB_BUFFER_TOTAL_LENGTH_VALID
Definition: buffer.h:99
static clib_error_t * ipfix_classify_table_add_del_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
static_always_inline ipfix_classify_table_t * ipfix_classify_add_table(void)
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:154
struct _vnet_classify_main vnet_classify_main_t
Definition: vnet_classify.h:69
#define ASSERT(truth)
static clib_error_t * set_ipfix_classify_stream_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
unsigned int u32
Definition: types.h:88
vlib_main_t * vlib_main
Definition: flow_report.h:113
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
#define vnet_buffer(b)
Definition: buffer.h:361
u16 ip4_tcp_udp_compute_checksum(vlib_main_t *vm, vlib_buffer_t *p0, ip4_header_t *ip0)
Definition: ip4_forward.c:1368
u16 template_id
Definition: flow_report.h:71
vnet_classify_main_t vnet_classify_main
Definition: vnet_classify.c:22
u32 vlib_buffer_alloc(vlib_main_t *vm, u32 *buffers, u32 n_buffers)
Allocate buffers into supplied array.
#define foreach_ipfix_field
static u32 ipfix_set_id_length(u16 set_id, u16 length)
Definition: ipfix_packet.h:114
Definition: defs.h:47
unsigned short u16
Definition: types.h:57
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
double f64
Definition: types.h:142
vnet_classify_bucket_t * buckets
unsigned char u8
Definition: types.h:56
int vnet_stream_change(flow_report_main_t *frm, u32 old_domain_id, u16 old_src_port, u32 new_domain_id, u16 new_src_port)
Definition: flow_report.c:358
u8 * ipfix_classify_template_rewrite(flow_report_main_t *frm, flow_report_t *fr, ip4_address_t *collector_address, ip4_address_t *src_address, u16 collector_port)
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:253
#define ip_csum_update(sum, old, new, type, field)
Definition: ip_packet.h:139
volatile u32 * writer_lock
vnet_flow_data_callback_t * flow_data_callback
Definition: flow_report.h:124
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:169
u8 data[0]
Packet data.
Definition: buffer.h:158
#define clib_error_return(e, args...)
Definition: error.h:111
static clib_error_t * flow_report_classify_init(vlib_main_t *vm)
u8 ip_version_and_header_length
Definition: ip4_packet.h:131
struct _unformat_input_t unformat_input_t
vlib_frame_t * vlib_get_frame_to_node(vlib_main_t *vm, u32 to_node_index)
Definition: main.c:187
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:67
u32 flags
buffer flags: VLIB_BUFFER_IS_TRACED: trace this buffer.
Definition: buffer.h:85
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:57
static u16 ip4_header_checksum(ip4_header_t *i)
Definition: ip4_packet.h:238
vlib_frame_t * ipfix_classify_send_flows(flow_report_main_t *frm, flow_report_t *fr, vlib_frame_t *f, u32 *to_next, u32 node_index)
static clib_error_t * flow_report_init(vlib_main_t *vm)
Definition: flow_report.c:469
static u16 ip_csum_fold(ip_csum_t c)
Definition: ip_packet.h:145
Definition: defs.h:46
static vnet_classify_entry_t * vnet_classify_get_entry(vnet_classify_table_t *t, uword offset)
int vnet_flow_report_add_del(flow_report_main_t *frm, vnet_flow_report_add_del_args_t *a)
Definition: flow_report.c:238