src/plugins/snat/snat_ipfix_logging.h

   1 /*
   2  * snat_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_snat_ipfix_logging_h__
  18 #define __included_snat_ipfix_logging_h__
  19
  20 typedef enum {
  21   NAT_ADDRESSES_EXHAUTED = 3,
  22   NAT44_SESSION_CREATE = 4,
  23   NAT44_SESSION_DELETE = 5,
  24   NAT_PORTS_EXHAUSTED = 12,
  25 } nat_event_t;
  26
  27 typedef struct {
  28   /** S-NAT IPFIX logging enabled */
  29   u8 enabled;
  30
  31   /** ipfix buffers under construction */
  32   vlib_buffer_t *nat44_session_buffer;
  33   vlib_buffer_t *addr_exhausted_buffer;
  34
  35   /** frames containing ipfix buffers */
  36   vlib_frame_t *nat44_session_frame;
  37   vlib_frame_t *addr_exhausted_frame;
  38
  39   /** next record offset */
  40   u32 nat44_session_next_record_offset;
  41   u32 addr_exhausted_next_record_offset;
  42
  43   /** Time reference pair */
  44   u64 milisecond_time_0;
  45   f64 vlib_time_0;
  46
  47   /** template IDs */
  48   u16 nat44_session_template_id;
  49   u16 addr_exhausted_template_id;
  50
  51   /** stream index */
  52   u32 stream_index;
  53 } snat_ipfix_logging_main_t;
  54
  55 extern snat_ipfix_logging_main_t snat_ipfix_logging_main;
  56
  57 void snat_ipfix_logging_init (vlib_main_t * vm);
  58 int snat_ipfix_logging_enable_disable (int enable, u32 domain_id, u16 src_port);
  59 void snat_ipfix_logging_nat44_ses_create (u32 src_ip, u32 nat_src_ip,
  60                                           snat_protocol_t snat_proto,
  61                                           u16 src_port, u16 nat_src_port,
  62                                           u32 vrf_id);
  63 void snat_ipfix_logging_nat44_ses_delete (u32 src_ip, u32 nat_src_ip,
  64                                           snat_protocol_t snat_proto,
  65                                           u16 src_port, u16 nat_src_port,
  66                                           u32 vrf_id);
  67 void snat_ipfix_logging_addresses_exhausted(u32 pool_id);
  68 #endif /* __included_snat_ipfix_logging_h__ */