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/ethernet/ethernet.h>
  21 #include <vnet/ethernet/packet.h>
  22 #include <vnet/ip/ip_packet.h>
  23 #include <vnet/ip/ip4_packet.h>
  24 #include <vnet/ip/ip6_packet.h>
  25 #include <vnet/udp/udp_packet.h>
  26 #include <vlib/cli.h>
  27 #include <vppinfra/error.h>
  28 #include <vppinfra/hash.h>
  29 #include <vppinfra/cache.h>
  30
  31 #include <vnet/ipfix-export/ipfix_packet.h>
  32
  33 /* ipfix field definitions for a particular report */
  34 typedef struct
  35 {
  36   u32 info_element;
  37   u32 size;
  38 } ipfix_report_element_t;
  39
  40 /* Used to build the rewrite */
  41 typedef struct
  42 {
  43   ip4_header_t ip4;
  44   udp_header_t udp;
  45   ipfix_template_packet_t ipfix;
  46 } ip4_ipfix_template_packet_t;
  47
  48 struct flow_report_main;
  49 struct flow_report;
  50 struct ipfix_exporter;
  51
  52 typedef vlib_frame_t *(vnet_flow_data_callback_t) (
  53   struct flow_report_main *frm, struct ipfix_exporter *exp,
  54   struct flow_report *, vlib_frame_t *, u32 *, u32);
  55
  56 typedef u8 *(vnet_flow_rewrite_callback_t) (struct ipfix_exporter *exp,
  57                                             struct flow_report *,
  58                                             ip4_address_t *, ip4_address_t *,
  59                                             u16, ipfix_report_element_t *elts,
  60                                             u32 n_elts, u32 *stream_index);
  61
  62 u8 *vnet_flow_rewrite_generic_callback (struct ipfix_exporter *exp,
  63                                         struct flow_report *, ip4_address_t *,
  64                                         ip4_address_t *, u16,
  65                                         ipfix_report_element_t *elts,
  66                                         u32 n_elts, u32 *stream_index);
  67
  68 typedef union
  69 {
  70   void *as_ptr;
  71   uword as_uword;
  72 } opaque_t;
  73
  74 typedef struct
  75 {
  76   u32 domain_id;
  77   u32 sequence_number;
  78   u16 src_port;
  79   u16 n_reports;
  80   u16 next_template_no;
  81 } flow_report_stream_t;
  82
  83 typedef struct flow_report
  84 {
  85   /* ipfix rewrite, set by callback */
  86   u8 *rewrite;
  87   u16 template_id;
  88   u32 stream_index;
  89   f64 last_template_sent;
  90   int update_rewrite;
  91
  92   /* Bitmap of fields to send */
  93   uword *fields_to_send;
  94
  95   /* Opaque data */
  96   opaque_t opaque;
  97
  98   /* build-the-template-packet rewrite callback */
  99   vnet_flow_rewrite_callback_t *rewrite_callback;
 100   ipfix_report_element_t *report_elements;
 101   u32 n_report_elements;
 102   u32 *stream_indexp;
 103
 104   /* Send-flow-data callback */
 105   vnet_flow_data_callback_t *flow_data_callback;
 106 } flow_report_t;
 107
 108 /*
 109  * The maximum number of ipfix exporters we can have at once
 110  */
 111 #define IPFIX_EXPORTERS_MAX 5
 112
 113 /*
 114  * We support multiple exporters. Each one has its own configured
 115  * destination, and its own set of reports and streams.
 116  */
 117 typedef struct ipfix_exporter
 118 {
 119   flow_report_t *reports;
 120   flow_report_stream_t *streams;
 121
 122   /* ipfix collector ip address, port, our ip address, fib index */
 123   ip4_address_t ipfix_collector;
 124   u16 collector_port;
 125   ip4_address_t src_address;
 126   u32 fib_index;
 127
 128   /* Path MTU */
 129   u32 path_mtu;
 130
 131   /* time interval in seconds after which to resend templates */
 132   u32 template_interval;
 133
 134   /* UDP checksum calculation enable flag */
 135   u8 udp_checksum;
 136 } ipfix_exporter_t;
 137
 138 typedef struct flow_report_main
 139 {
 140   /*
 141    * A pool of the exporters. Entry 0 is always there for backwards
 142    * compatability reasons. Entries 1 and above have to be created by
 143    * the users.
 144    */
 145   ipfix_exporter_t *exporters;
 146
 147   /* time scale transform. Joy. */
 148   u32 unix_time_0;
 149   f64 vlib_time_0;
 150
 151   /* convenience variables */
 152   vlib_main_t *vlib_main;
 153   vnet_main_t *vnet_main;
 154
 155   u16 msg_id_base;
 156 } flow_report_main_t;
 157
 158 extern flow_report_main_t flow_report_main;
 159
 160 extern vlib_node_registration_t flow_report_process_node;
 161
 162 typedef struct
 163 {
 164   vnet_flow_data_callback_t *flow_data_callback;
 165   vnet_flow_rewrite_callback_t *rewrite_callback;
 166   ipfix_report_element_t *report_elements;
 167   u32 n_report_elements;
 168   opaque_t opaque;
 169   int is_add;
 170   u32 domain_id;
 171   u16 src_port;
 172   u32 *stream_indexp;
 173 } vnet_flow_report_add_del_args_t;
 174
 175 int vnet_flow_report_add_del (ipfix_exporter_t *exp,
 176                               vnet_flow_report_add_del_args_t *a,
 177                               u16 *template_id);
 178
 179 clib_error_t *flow_report_add_del_error_to_clib_error (int error);
 180
 181 void vnet_flow_reports_reset (ipfix_exporter_t *exp);
 182
 183 void vnet_stream_reset (ipfix_exporter_t *exp, u32 stream_index);
 184
 185 int vnet_stream_change (ipfix_exporter_t *exp, u32 old_domain_id,
 186                         u16 old_src_port, u32 new_domain_id, u16 new_src_port);
 187
 188 #endif /* __included_vnet_flow_report_h__ */
 189
 190 /*
 191  * fd.io coding-style-patch-verification: ON
 192  *
 193  * Local Variables:
 194  * eval: (c-set-style "gnu")
 195  * End:
 196  */