FD.io VPP  v21.01.1
Vector Packet Processing
ipfix_logging.h
Go to the documentation of this file.
1 /*
2  * 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_lib_ipfix_logging_h__
18 #define __included_nat_lib_ipfix_logging_h__
19 
20 #include <vlib/buffer.h>
21 #include <vlib/node.h>
22 
23 #include <nat/lib/lib.h>
24 
25 typedef enum {
35 } nat_event_t;
36 
37 typedef enum {
42 
43 typedef struct {
44 
45  /** ipfix buffers under construction */
55 
56  /** frames containing ipfix buffers */
66 
67  /** next record offset */
77 
79 
80 typedef struct {
81  /** NAT plugin IPFIX logging enabled */
83 
84  /** Time reference pair */
87 
88  /* Per thread data */
90 
91  /** template IDs */
101 
102  /** stream index */
104 
105  /** vector of worker vlib mains */
107 
108  /** nat data callbacks call counter */
110 
112 
114 
116 
118 int nat_ipfix_logging_enable_disable (int enable, u32 domain_id, u16 src_port);
120  u32 nat_src_ip,
121  nat_protocol_t nat_proto,
122  u16 src_port, u16 nat_src_port,
123  u32 fib_index);
125  u32 nat_src_ip,
126  nat_protocol_t nat_proto,
127  u16 src_port, u16 nat_src_port,
128  u32 fib_index);
129 void nat_ipfix_logging_addresses_exhausted(u32 thread_index, u32 pool_id);
131  u32 limit, u32 src_ip);
132 void nat_ipfix_logging_max_sessions(u32 thread_index, u32 limit);
133 void nat_ipfix_logging_max_bibs(u32 thread_index, u32 limit);
134 void nat_ipfix_logging_nat64_session(u32 thread_index,
135  ip6_address_t * src_ip,
136  ip4_address_t * nat_src_ip, u8 proto,
137  u16 src_port, u16 nat_src_port,
138  ip6_address_t * dst_ip,
139  ip4_address_t * nat_dst_ip,
140  u16 dst_port, u16 nat_dst_port,
141  u32 vrf_id, u8 is_create);
142 void nat_ipfix_logging_nat64_bib(u32 thread_index,
143  ip6_address_t * src_ip,
144  ip4_address_t * nat_src_ip, u8 proto,
145  u16 src_port, u16 nat_src_port,
146  u32 vrf_id, u8 is_create);
147 
148 #endif /* __included_nat_lib_ipfix_logging_h__ */
u32 stream_index
stream index
int nat_ipfix_logging_enabled()
vlib_frame_t * addr_exhausted_frame
Definition: ipfix_logging.h:58
vlib_buffer_t * max_frags_ip6_buffer
Definition: ipfix_logging.h:52
unsigned long u64
Definition: types.h:89
vl_api_ip_port_and_mask_t dst_port
Definition: flow_types.api:92
vlib_buffer_t * nat64_ses_buffer
Definition: ipfix_logging.h:54
void nat_ipfix_logging_max_entries_per_user(u32 thread_index, u32 limit, u32 src_ip)
Generate maximum entries per user exceeded event.
void nat_ipfix_logging_nat64_bib(u32 thread_index, ip6_address_t *src_ip, ip4_address_t *nat_src_ip, u8 proto, u16 src_port, u16 nat_src_port, u32 vrf_id, u8 is_create)
Generate NAT64 BIB create and delete events.
u32 vrf_id
Definition: nat44.api:1029
vlib_main_t * vm
Definition: in2out_ed.c:1580
void nat_ipfix_logging_nat44_ses_create(u32 thread_index, u32 src_ip, u32 nat_src_ip, nat_protocol_t nat_proto, u16 src_port, u16 nat_src_port, u32 fib_index)
Generate NAT44 session create event.
nat_protocol_t
Definition: lib.h:63
NAT port/address allocation lib.
vlib_buffer_t * max_entries_per_user_buffer
Definition: ipfix_logging.h:48
unsigned char u8
Definition: types.h:56
vlib_frame_t * max_sessions_frame
Definition: ipfix_logging.h:60
nat_ipfix_per_thread_data_t * per_thread_data
Definition: ipfix_logging.h:89
double f64
Definition: types.h:142
vlib_frame_t * max_frags_ip6_frame
Definition: ipfix_logging.h:63
vlib_frame_t * max_bibs_frame
Definition: ipfix_logging.h:61
vlib_frame_t * nat64_bib_frame
Definition: ipfix_logging.h:64
unsigned int u32
Definition: types.h:88
vlib_buffer_t * max_sessions_buffer
Definition: ipfix_logging.h:49
void nat_ipfix_logging_nat64_session(u32 thread_index, ip6_address_t *src_ip, ip4_address_t *nat_src_ip, u8 proto, u16 src_port, u16 nat_src_port, ip6_address_t *dst_ip, ip4_address_t *nat_dst_ip, u16 dst_port, u16 nat_dst_port, u32 vrf_id, u8 is_create)
Generate NAT64 session create and delete events.
vl_api_ip_proto_t proto
Definition: acl_types.api:51
unsigned short u16
Definition: types.h:57
void nat_ipfix_logging_init(vlib_main_t *vm)
Initialize NAT plugin IPFIX logging.
nat_ipfix_logging_main_t nat_ipfix_logging_main
Definition: ipfix_logging.c:28
void nat_ipfix_logging_max_bibs(u32 thread_index, u32 limit)
Generate maximum BIB entries exceeded event.
vl_api_ip_port_and_mask_t src_port
Definition: flow_types.api:91
vlib_buffer_t * nat44_session_buffer
ipfix buffers under construction
Definition: ipfix_logging.h:46
void nat_ipfix_logging_nat44_ses_delete(u32 thread_index, u32 src_ip, u32 nat_src_ip, nat_protocol_t nat_proto, u16 src_port, u16 nat_src_port, u32 fib_index)
Generate NAT44 session delete event.
int nat_ipfix_logging_enable_disable(int enable, u32 domain_id, u16 src_port)
Enable/disable NAT plugin IPFIX logging.
vlib_buffer_t * nat64_bib_buffer
Definition: ipfix_logging.h:53
u32 nat44_session_next_record_offset
next record offset
Definition: ipfix_logging.h:68
vlib buffer structure definition and a few select access methods.
u16 nat44_session_template_id
template IDs
Definition: ipfix_logging.h:92
vlib_frame_t * max_frags_ip4_frame
Definition: ipfix_logging.h:62
u8 enabled
NAT plugin IPFIX logging enabled.
Definition: ipfix_logging.h:82
void nat_ipfix_logging_addresses_exhausted(u32 thread_index, u32 pool_id)
Generate NAT addresses exhausted event.
nat_event_t
Definition: ipfix_logging.h:25
vlib_frame_t * max_entries_per_user_frame
Definition: ipfix_logging.h:59
quota_exceed_event_t
Definition: ipfix_logging.h:37
u16 call_counter
nat data callbacks call counter
vlib_buffer_t * max_bibs_buffer
Definition: ipfix_logging.h:50
vlib_buffer_t * addr_exhausted_buffer
Definition: ipfix_logging.h:47
VLIB buffer representation.
Definition: buffer.h:102
vl_api_address_t src_ip
Definition: wireguard.api:38
vlib_main_t ** worker_vms
vector of worker vlib mains
vl_api_address_t dst_ip
Definition: udp.api:44
vlib_buffer_t * max_frags_ip4_buffer
Definition: ipfix_logging.h:51
vlib_frame_t * nat64_ses_frame
Definition: ipfix_logging.h:65
vlib_frame_t * nat44_session_frame
frames containing ipfix buffers
Definition: ipfix_logging.h:57
void nat_ipfix_logging_max_sessions(u32 thread_index, u32 limit)
Generate maximum session entries exceeded event.
u64 milisecond_time_0
Time reference pair.
Definition: ipfix_logging.h:85