src/vnet/ipfix-export/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/udp/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/ipfix-export/ipfix_packet.h>
  33
  34 /* ipfix field definitions for a particular report */
  35 typedef struct
  36 {
  37   u32 info_element;
  38   u32 size;
  39 } ipfix_report_element_t;
  40
  41 /* Used to build the rewrite */
  42 typedef struct
  43 {
  44   ip4_header_t ip4;
  45   udp_header_t udp;
  46   ipfix_template_packet_t ipfix;
  47 } ip4_ipfix_template_packet_t;
  48
  49 struct flow_report_main;
  50 struct flow_report;
  51
  52 typedef vlib_frame_t *(vnet_flow_data_callback_t) (struct flow_report_main *,
  53                                                    struct flow_report *,
  54                                                    vlib_frame_t *, u32 *,
  55                                                    u32);
  56
  57 typedef u8 *(vnet_flow_rewrite_callback_t) (struct flow_report_main *,
  58                                             struct flow_report *,
  59                                             ip4_address_t *,
  60                                             ip4_address_t *, u16,
  61                                             ipfix_report_element_t * elts,
  62                                             u32 n_elts, u32 * stream_index);
  63
  64 u8 *vnet_flow_rewrite_generic_callback (struct flow_report_main *,
  65                                         struct flow_report *,
  66                                         ip4_address_t *,
  67                                         ip4_address_t *, u16,
  68                                         ipfix_report_element_t * elts,
  69                                         u32 n_elts, u32 * stream_index);
  70
  71 typedef union
  72 {
  73   void *as_ptr;
  74   uword as_uword;
  75 } opaque_t;
  76
  77 typedef struct
  78 {
  79   u32 domain_id;
  80   u32 sequence_number;
  81   u16 src_port;
  82   u16 n_reports;
  83   u16 next_template_no;
  84 } flow_report_stream_t;
  85
  86 typedef struct flow_report
  87 {
  88   /* ipfix rewrite, set by callback */
  89   u8 *rewrite;
  90   u16 template_id;
  91   u32 stream_index;
  92   f64 last_template_sent;
  93   int update_rewrite;
  94
  95   /* Bitmap of fields to send */
  96   uword *fields_to_send;
  97
  98   /* Opaque data */
  99   opaque_t opaque;
 100
 101   /* build-the-template-packet rewrite callback */
 102   vnet_flow_rewrite_callback_t *rewrite_callback;
 103   ipfix_report_element_t *report_elements;
 104   u32 n_report_elements;
 105   u32 *stream_indexp;
 106
 107   /* Send-flow-data callback */
 108   vnet_flow_data_callback_t *flow_data_callback;
 109 } flow_report_t;
 110
 111 typedef struct flow_report_main
 112 {
 113   flow_report_t *reports;
 114   flow_report_stream_t *streams;
 115
 116   /* ipfix collector ip address, port, our ip address, fib index */
 117   ip4_address_t ipfix_collector;
 118   u16 collector_port;
 119   ip4_address_t src_address;
 120   u32 fib_index;
 121
 122   /* Path MTU */
 123   u32 path_mtu;
 124
 125   /* time interval in seconds after which to resend templates */
 126   u32 template_interval;
 127
 128   /* UDP checksum calculation enable flag */
 129   u8 udp_checksum;
 130
 131   /* time scale transform. Joy. */
 132   u32 unix_time_0;
 133   f64 vlib_time_0;
 134
 135   /* convenience variables */
 136   vlib_main_t *vlib_main;
 137   vnet_main_t *vnet_main;
 138 } flow_report_main_t;
 139
 140 extern flow_report_main_t flow_report_main;
 141
 142 extern vlib_node_registration_t flow_report_process_node;
 143
 144 int vnet_flow_report_enable_disable (u32 sw_if_index, u32 table_index,
 145                                      int enable_disable);
 146 typedef struct
 147 {
 148   vnet_flow_data_callback_t *flow_data_callback;
 149   vnet_flow_rewrite_callback_t *rewrite_callback;
 150   ipfix_report_element_t *report_elements;
 151   u32 n_report_elements;
 152   opaque_t opaque;
 153   int is_add;
 154   u32 domain_id;
 155   u16 src_port;
 156   u32 *stream_indexp;
 157 } vnet_flow_report_add_del_args_t;
 158
 159 int vnet_flow_report_add_del (flow_report_main_t * frm,
 160                               vnet_flow_report_add_del_args_t * a,
 161                               u16 * template_id);
 162
 163 clib_error_t *flow_report_add_del_error_to_clib_error (int error);
 164
 165 void vnet_flow_reports_reset (flow_report_main_t * frm);
 166
 167 void vnet_stream_reset (flow_report_main_t * frm, u32 stream_index);
 168
 169 int vnet_stream_change (flow_report_main_t * frm,
 170                         u32 old_domain_id, u16 old_src_port,
 171                         u32 new_domain_id, u16 new_src_port);
 172
 173 #endif /* __included_vnet_flow_report_h__ */
 174
 175 /*
 176  * fd.io coding-style-patch-verification: ON
 177  *
 178  * Local Variables:
 179  * eval: (c-set-style "gnu")
 180  * End:
 181  */