src/plugins/flowprobe/flowprobe.h

   1 /*
   2  * flowprobe.h - ipfix probe plug-in header file
   3  *
   4  * Copyright (c) 2016 Cisco and/or its affiliates.
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17 #ifndef __included_flowprobe_h__
  18 #define __included_flowprobe_h__
  19
  20 #include <vnet/vnet.h>
  21 #include <vnet/ip/ip.h>
  22 #include <vnet/ethernet/ethernet.h>
  23
  24 #include <vppinfra/hash.h>
  25 #include <vppinfra/error.h>
  26 #include <vnet/ipfix-export/flow_report.h>
  27 #include <vnet/ipfix-export/flow_report_classify.h>
  28 #include <vppinfra/tw_timer_2t_1w_2048sl.h>
  29
  30 /* Default timers in seconds */
  31 #define FLOWPROBE_TIMER_ACTIVE   (15)
  32 #define FLOWPROBE_TIMER_PASSIVE  120    // XXXX: FOR TESTING (30*60)
  33 #define FLOWPROBE_LOG2_HASHSIZE  (18)
  34
  35 typedef enum
  36 {
  37   FLOW_RECORD_L2 = 1 << 0,
  38   FLOW_RECORD_L3 = 1 << 1,
  39   FLOW_RECORD_L4 = 1 << 2,
  40   FLOW_RECORD_L2_IP4 = 1 << 3,
  41   FLOW_RECORD_L2_IP6 = 1 << 4,
  42   FLOW_N_RECORDS = 1 << 5,
  43 } flowprobe_record_t;
  44
  45 /* *INDENT-OFF* */
  46 typedef enum __attribute__ ((__packed__))
  47 {
  48   FLOW_VARIANT_IP4,
  49   FLOW_VARIANT_IP6,
  50   FLOW_VARIANT_L2,
  51   FLOW_VARIANT_L2_IP4,
  52   FLOW_VARIANT_L2_IP6,
  53   FLOW_N_VARIANTS,
  54 } flowprobe_variant_t;
  55 /* *INDENT-ON* */
  56
  57 STATIC_ASSERT (sizeof (flowprobe_variant_t) == 1,
  58                "flowprobe_variant_t is expected to be 1 byte, "
  59                "revisit padding in flowprobe_key_t");
  60
  61 #define FLOW_MAXIMUM_EXPORT_ENTRIES     (1024)
  62
  63 typedef struct
  64 {
  65   /* what to collect per variant */
  66   flowprobe_record_t flags;
  67   /** ipfix buffers under construction, per-worker thread */
  68   vlib_buffer_t **buffers_per_worker;
  69   /** frames containing ipfix buffers, per-worker thread */
  70   vlib_frame_t **frames_per_worker;
  71   /** next record offset, per worker thread */
  72   u16 *next_record_offset_per_worker;
  73 } flowprobe_protocol_context_t;
  74
  75 /* *INDENT-OFF* */
  76 typedef struct __attribute__ ((aligned (8))) {
  77   u32 rx_sw_if_index;
  78   u32 tx_sw_if_index;
  79   u8 src_mac[6];
  80   u8 dst_mac[6];
  81   u16 ethertype;
  82   ip46_address_t src_address;
  83   ip46_address_t dst_address;
  84   u8 protocol;
  85   u16 src_port;
  86   u16 dst_port;
  87   flowprobe_variant_t which;
  88 } flowprobe_key_t;
  89 /* *INDENT-ON* */
  90
  91 typedef struct
  92 {
  93   u32 sec;
  94   u32 nsec;
  95 } timestamp_nsec_t;
  96
  97 typedef struct
  98 {
  99   flowprobe_key_t key;
 100   u64 packetcount;
 101   u64 octetcount;
 102   timestamp_nsec_t flow_start;
 103   timestamp_nsec_t flow_end;
 104   f64 last_updated;
 105   f64 last_exported;
 106   u32 passive_timer_handle;
 107   union
 108   {
 109     struct
 110     {
 111       u16 flags;
 112     } tcp;
 113   } prot;
 114 } flowprobe_entry_t;
 115
 116 /**
 117  * @file
 118  * @brief flow-per-packet plugin header file
 119  */
 120 typedef struct
 121 {
 122   /** API message ID base */
 123   u16 msg_id_base;
 124
 125   flowprobe_protocol_context_t context[FLOW_N_VARIANTS];
 126   u16 template_reports[FLOW_N_RECORDS];
 127   u16 template_size[FLOW_N_RECORDS];
 128
 129   /** Time reference pair */
 130   u64 nanosecond_time_0;
 131   f64 vlib_time_0;
 132
 133   /** Per CPU flow-state */
 134   u8 ht_log2len;                /* Hash table size is 2^log2len */
 135   u32 **hash_per_worker;
 136   flowprobe_entry_t **pool_per_worker;
 137   /* *INDENT-OFF* */
 138   TWT (tw_timer_wheel) ** timers_per_worker;
 139   /* *INDENT-ON* */
 140   u32 **expired_passive_per_worker;
 141
 142   flowprobe_record_t record;
 143   u32 active_timer;
 144   u32 passive_timer;
 145   flowprobe_entry_t *stateless_entry;
 146
 147   bool initialized;
 148   bool disabled;
 149
 150   u16 template_per_flow[FLOW_N_VARIANTS];
 151   u8 *flow_per_interface;
 152
 153   /** convenience vlib_main_t pointer */
 154   vlib_main_t *vlib_main;
 155   /** convenience vnet_main_t pointer */
 156   vnet_main_t *vnet_main;
 157 } flowprobe_main_t;
 158
 159 extern flowprobe_main_t flowprobe_main;
 160
 161 void flowprobe_flush_callback_ip4 (void);
 162 void flowprobe_flush_callback_ip6 (void);
 163 void flowprobe_flush_callback_l2 (void);
 164 u8 *format_flowprobe_entry (u8 * s, va_list * args);
 165
 166 #endif
 167
 168 /*
 169  * fd.io coding-style-patch-verification: ON
 170  *
 171  * Local Variables:
 172  * eval: (c-set-style "gnu")
 173  * End:
 174  */