vnet/vnet/flow/flow_report.h

   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 #ifndef __included_vnet_flow_report_h__
  16 #define __included_vnet_flow_report_h__
  17
  18 #include <vlib/vlib.h>
  19 #include <vnet/vnet.h>
  20 #include <vnet/pg/pg.h>
  21 #include <vnet/ethernet/ethernet.h>
  22 #include <vnet/ethernet/packet.h>
  23 #include <vnet/ip/ip_packet.h>
  24 #include <vnet/ip/ip4_packet.h>
  25 #include <vnet/ip/ip6_packet.h>
  26 #include <vnet/ip/udp.h>
  27 #include <vlib/cli.h>
  28 #include <vppinfra/error.h>
  29 #include <vppinfra/hash.h>
  30 #include <vppinfra/cache.h>
  31
  32 #include <vnet/flow/ipfix_packet.h>
  33
  34 /* Used to build the rewrite */
  35 typedef struct {
  36   ip4_header_t ip4;
  37   udp_header_t udp;
  38   ipfix_template_packet_t ipfix;
  39 } ip4_ipfix_template_packet_t;
  40
  41 struct flow_report_main;
  42 struct flow_report;
  43
  44 typedef u8 * (vnet_flow_rewrite_callback_t)(struct flow_report_main *,
  45                                             struct flow_report *,
  46                                             ip4_address_t *,
  47                                             ip4_address_t *,
  48                                             u16);
  49
  50 typedef vlib_frame_t * (vnet_flow_data_callback_t) (struct flow_report_main *,
  51                                                     struct flow_report *,
  52                                                     vlib_frame_t *, u32 *,
  53                                                     u32);
  54 typedef struct flow_report {
  55   /* ipfix rewrite, set by callback */
  56   u8 * rewrite;
  57   u32 sequence_number;
  58   u32 domain_id;
  59   u16 src_port;
  60   f64 last_template_sent;
  61   int update_rewrite;
  62
  63   /* Bitmap of fields to send */
  64   uword * fields_to_send;
  65
  66   /* Opaque data */
  67   void * opaque;
  68
  69   /* build-the-rewrite callback */
  70   vnet_flow_rewrite_callback_t *rewrite_callback;
  71
  72   /* Send-flow-data callback */
  73   vnet_flow_data_callback_t *flow_data_callback;
  74 } flow_report_t;
  75
  76 typedef struct flow_report_main {
  77   flow_report_t * reports;
  78
  79   /* ipfix collector ip address, port, our ip address, fib index */
  80   ip4_address_t ipfix_collector;
  81   u16 collector_port;
  82   ip4_address_t src_address;
  83   u32 fib_index;
  84
  85   /* Path MTU */
  86   u32 path_mtu;
  87
  88   /* time interval in seconds after which to resend templates */
  89   u32 template_interval;
  90
  91   /* time scale transform. Joy. */
  92   u32 unix_time_0;
  93   f64 vlib_time_0;
  94
  95   /* convenience variables */
  96   vlib_main_t * vlib_main;
  97   vnet_main_t * vnet_main;
  98 } flow_report_main_t;
  99
 100 extern flow_report_main_t flow_report_main;
 101
 102 extern vlib_node_registration_t flow_report_process_node;
 103
 104 int vnet_flow_report_enable_disable (u32 sw_if_index, u32 table_index,
 105                                        int enable_disable);
 106 typedef struct {
 107   vnet_flow_data_callback_t *flow_data_callback;
 108   vnet_flow_rewrite_callback_t *rewrite_callback;
 109   void * opaque;
 110   int is_add;
 111   u32 domain_id;
 112   u16 src_port;
 113 } vnet_flow_report_add_del_args_t;
 114
 115 int vnet_flow_report_add_del (flow_report_main_t *frm,
 116                               vnet_flow_report_add_del_args_t *a);
 117
 118 void vnet_flow_reports_reset (flow_report_main_t * frm);
 119
 120 #endif /* __included_vnet_flow_report_h__ */