src/plugins/nat/nat_ipfix_logging.h

   1 /*
   2  * nat_ipfix_logging.h - NAT Events IPFIX logging
   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_nat_ipfix_logging_h__
  18 #define __included_nat_ipfix_logging_h__
  19
  20 #include <nat/nat.h>
  21
  22 typedef enum {
  23   NAT_ADDRESSES_EXHAUTED = 3,
  24   NAT44_SESSION_CREATE = 4,
  25   NAT44_SESSION_DELETE = 5,
  26   NAT64_SESSION_CREATE = 6,
  27   NAT64_SESSION_DELETE = 7,
  28   NAT64_BIB_CREATE = 10,
  29   NAT64_BIB_DELETE = 11,
  30   NAT_PORTS_EXHAUSTED = 12,
  31   QUOTA_EXCEEDED = 13,
  32 } nat_event_t;
  33
  34 typedef enum {
  35   MAX_SESSION_ENTRIES = 1,
  36   MAX_BIB_ENTRIES = 2,
  37   MAX_ENTRIES_PER_USER = 3,
  38 } quota_exceed_event_t;
  39
  40 typedef struct {
  41
  42   /** ipfix buffers under construction */
  43   vlib_buffer_t *nat44_session_buffer;
  44   vlib_buffer_t *addr_exhausted_buffer;
  45   vlib_buffer_t *max_entries_per_user_buffer;
  46   vlib_buffer_t *max_sessions_buffer;
  47   vlib_buffer_t *max_bibs_buffer;
  48   vlib_buffer_t *max_frags_ip4_buffer;
  49   vlib_buffer_t *max_frags_ip6_buffer;
  50   vlib_buffer_t *nat64_bib_buffer;
  51   vlib_buffer_t *nat64_ses_buffer;
  52
  53   /** frames containing ipfix buffers */
  54   vlib_frame_t *nat44_session_frame;
  55   vlib_frame_t *addr_exhausted_frame;
  56   vlib_frame_t *max_entries_per_user_frame;
  57   vlib_frame_t *max_sessions_frame;
  58   vlib_frame_t *max_bibs_frame;
  59   vlib_frame_t *max_frags_ip4_frame;
  60   vlib_frame_t *max_frags_ip6_frame;
  61   vlib_frame_t *nat64_bib_frame;
  62   vlib_frame_t *nat64_ses_frame;
  63
  64   /** next record offset */
  65   u32 nat44_session_next_record_offset;
  66   u32 addr_exhausted_next_record_offset;
  67   u32 max_entries_per_user_next_record_offset;
  68   u32 max_sessions_next_record_offset;
  69   u32 max_bibs_next_record_offset;
  70   u32 max_frags_ip4_next_record_offset;
  71   u32 max_frags_ip6_next_record_offset;
  72   u32 nat64_bib_next_record_offset;
  73   u32 nat64_ses_next_record_offset;
  74
  75 } snat_ipfix_per_thread_data_t;
  76
  77 typedef struct {
  78   /** NAT plugin IPFIX logging enabled */
  79   u8 enabled;
  80
  81   /** Time reference pair */
  82   u64 milisecond_time_0;
  83   f64 vlib_time_0;
  84
  85   /* Per thread data */
  86   snat_ipfix_per_thread_data_t *per_thread_data;
  87
  88   /** template IDs */
  89   u16 nat44_session_template_id;
  90   u16 addr_exhausted_template_id;
  91   u16 max_entries_per_user_template_id;
  92   u16 max_sessions_template_id;
  93   u16 max_bibs_template_id;
  94   u16 max_frags_ip4_template_id;
  95   u16 max_frags_ip6_template_id;
  96   u16 nat64_bib_template_id;
  97   u16 nat64_ses_template_id;
  98
  99   /** stream index */
 100   u32 stream_index;
 101
 102   /** vector of worker vlib mains */
 103   vlib_main_t **worker_vms;
 104
 105   /** nat data callbacks call counter */
 106   u16 call_counter;
 107
 108 } snat_ipfix_logging_main_t;
 109
 110 extern snat_ipfix_logging_main_t snat_ipfix_logging_main;
 111
 112 void snat_ipfix_logging_init (vlib_main_t * vm);
 113 int snat_ipfix_logging_enable_disable (int enable, u32 domain_id, u16 src_port);
 114 void snat_ipfix_logging_nat44_ses_create (u32 thread_index, u32 src_ip,
 115                                           u32 nat_src_ip,
 116                                           snat_protocol_t snat_proto,
 117                                           u16 src_port, u16 nat_src_port,
 118                                           u32 vrf_id);
 119 void snat_ipfix_logging_nat44_ses_delete (u32 thread_index, u32 src_ip,
 120                                           u32 nat_src_ip,
 121                                           snat_protocol_t snat_proto,
 122                                           u16 src_port, u16 nat_src_port,
 123                                           u32 vrf_id);
 124 void snat_ipfix_logging_addresses_exhausted(u32 thread_index, u32 pool_id);
 125 void snat_ipfix_logging_max_entries_per_user(u32 thread_index,
 126                                              u32 limit, u32 src_ip);
 127 void nat_ipfix_logging_max_sessions(u32 thread_index, u32 limit);
 128 void nat_ipfix_logging_max_bibs(u32 thread_index, u32 limit);
 129 void nat_ipfix_logging_nat64_session(u32 thread_index,
 130                                      ip6_address_t * src_ip,
 131                                      ip4_address_t * nat_src_ip, u8 proto,
 132                                      u16 src_port, u16 nat_src_port,
 133                                      ip6_address_t * dst_ip,
 134                                      ip4_address_t * nat_dst_ip,
 135                                      u16 dst_port, u16 nat_dst_port,
 136                                      u32 vrf_id, u8 is_create);
 137 void nat_ipfix_logging_nat64_bib(u32 thread_index,
 138                                  ip6_address_t * src_ip,
 139                                  ip4_address_t * nat_src_ip, u8 proto,
 140                                  u16 src_port, u16 nat_src_port,
 141                                  u32 vrf_id, u8 is_create);
 142
 143 #endif /* __included_nat_ipfix_logging_h__ */