FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
nat66_out2in.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 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 /**
16  * @file
17  * @brief NAT66 outside to inside network translation
18  */
19 
20 #include <nat/nat66/nat66.h>
21 #include <vnet/ip/ip6_to_ip4.h>
22 #include <vnet/fib/fib_table.h>
23 
24 typedef struct
25 {
29 
30 static u8 *
31 format_nat66_out2in_trace (u8 * s, va_list * args)
32 {
33  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
34  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
35  nat66_out2in_trace_t *t = va_arg (*args, nat66_out2in_trace_t *);
36 
37  s =
38  format (s, "NAT66-out2in: sw_if_index %d, next index %d", t->sw_if_index,
39  t->next_index);
40 
41  return s;
42 }
43 
44 #define foreach_nat66_out2in_error \
45 _(NO_TRANSLATION, "no translation") \
46 _(UNKNOWN, "unknown")
47 
48 typedef enum
49 {
50 #define _(sym,str) NAT66_OUT2IN_ERROR_##sym,
52 #undef _
55 
56 static char *nat66_out2in_error_strings[] = {
57 #define _(sym,string) string,
59 #undef _
60 };
61 
62 typedef enum
63 {
68 
72 {
73  u32 n_left_from, *from, *to_next;
77 
79  n_left_from = frame->n_vectors;
80  next_index = node->cached_next_index;
81 
82  while (n_left_from > 0)
83  {
84  u32 n_left_to_next;
85 
86  vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
87 
88  while (n_left_from > 0 && n_left_to_next > 0)
89  {
90  u32 bi0;
91  vlib_buffer_t *b0;
93  ip6_header_t *ip60;
94  u16 l4_offset0, frag_offset0;
95  u8 l4_protocol0;
97  u32 sw_if_index0, fib_index0;
98  udp_header_t *udp0;
99  tcp_header_t *tcp0;
100  icmp46_header_t *icmp0;
101  u16 *checksum0 = 0;
102  ip_csum_t csum0;
103 
104  /* speculatively enqueue b0 to the current next frame */
105  bi0 = from[0];
106  to_next[0] = bi0;
107  from += 1;
108  to_next += 1;
109  n_left_from -= 1;
110  n_left_to_next -= 1;
111 
112  b0 = vlib_get_buffer (vm, bi0);
113  ip60 = vlib_buffer_get_current (b0);
114 
115  if (PREDICT_FALSE
116  (ip6_parse
117  (vm, b0, ip60, b0->current_length, &l4_protocol0, &l4_offset0,
118  &frag_offset0)))
119  {
120  next0 = NAT66_OUT2IN_NEXT_DROP;
121  b0->error = node->errors[NAT66_OUT2IN_ERROR_UNKNOWN];
122  goto trace0;
123  }
124 
125  sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
126  fib_index0 =
128  sw_if_index0);
129 
130  sm0 = nat66_static_mapping_get (&ip60->dst_address, fib_index0, 0);
131  if (PREDICT_FALSE (!sm0))
132  {
133  goto trace0;
134  }
135 
136  if (l4_protocol0 == IP_PROTOCOL_UDP)
137  {
138  udp0 = (udp_header_t *) u8_ptr_add (ip60, l4_offset0);
139  checksum0 = &udp0->checksum;
140  }
141  else if (l4_protocol0 == IP_PROTOCOL_TCP)
142  {
143  tcp0 = (tcp_header_t *) u8_ptr_add (ip60, l4_offset0);
144  checksum0 = &tcp0->checksum;
145  }
146  else if (l4_protocol0 == IP_PROTOCOL_ICMP6)
147  {
148  icmp0 = (icmp46_header_t *) u8_ptr_add (ip60, l4_offset0);
149  checksum0 = &icmp0->checksum;
150  }
151  else
152  goto skip_csum0;
153 
154  csum0 = ip_csum_sub_even (*checksum0, ip60->dst_address.as_u64[0]);
155  csum0 = ip_csum_sub_even (csum0, ip60->dst_address.as_u64[1]);
156  csum0 = ip_csum_add_even (csum0, sm0->l_addr.as_u64[0]);
157  csum0 = ip_csum_add_even (csum0, sm0->l_addr.as_u64[1]);
158  *checksum0 = ip_csum_fold (csum0);
159 
160  skip_csum0:
161  ip60->dst_address.as_u64[0] = sm0->l_addr.as_u64[0];
162  ip60->dst_address.as_u64[1] = sm0->l_addr.as_u64[1];
163  vnet_buffer (b0)->sw_if_index[VLIB_TX] = sm0->fib_index;
164 
165  vlib_increment_combined_counter (&nm->session_counters,
166  thread_index, sm0 - nm->sm, 1,
168  b0));
169 
170  trace0:
171  if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
172  && (b0->flags & VLIB_BUFFER_IS_TRACED)))
173  {
175  vlib_add_trace (vm, node, b0, sizeof (*t));
176  t->sw_if_index = vnet_buffer (b0)->sw_if_index[VLIB_RX];
177  t->next_index = next0;
178  }
179 
180  if (next0 != NAT66_OUT2IN_NEXT_DROP)
181  {
182  vlib_increment_simple_counter (&nm->out2in_packets,
183  thread_index, sw_if_index0, 1);
184  }
185 
186  /* verify speculative enqueue, maybe switch current next frame */
188  n_left_to_next, bi0, next0);
189  }
190  vlib_put_next_frame (vm, node, next_index, n_left_to_next);
191  }
192 
193  return frame->n_vectors;
194 }
195 
196 /* *INDENT-OFF* */
198  .name = "nat66-out2in",
199  .vector_size = sizeof (u32),
200  .format_trace = format_nat66_out2in_trace,
203  .error_strings = nat66_out2in_error_strings,
204  .n_next_nodes = NAT66_OUT2IN_N_NEXT,
205  /* edit / add dispositions here */
206  .next_nodes = {
207  [NAT66_OUT2IN_NEXT_DROP] = "error-drop",
208  [NAT66_OUT2IN_NEXT_IP6_LOOKUP] = "ip6-lookup",
209  },
210 };
211 /* *INDENT-ON* */
212 
213 /*
214  * fd.io coding-style-patch-verification: ON
215  *
216  * Local Variables:
217  * eval: (c-set-style "gnu")
218  * End:
219  */
nat66_out2in_error_t
nat66_out2in_error_t
Definition: nat66_out2in.c:48
nat66_out2in_next_t
nat66_out2in_next_t
Definition: nat66_out2in.c:62
nat66_static_mapping_get
nat66_static_mapping_t * nat66_static_mapping_get(ip6_address_t *addr, u32 fib_index, u8 is_local)
Definition: nat66.c:215
thread_index
u32 thread_index
Definition: nat44_ei_hairpinning.c:492
u8_ptr_add
#define u8_ptr_add(ptr, index)
Definition: ip_types.h:56
frame
vlib_main_t vlib_node_runtime_t vlib_frame_t * frame
Definition: nat44_ei.c:3048
next_index
nat44_ei_hairpin_src_next_t next_index
Definition: nat44_ei_hairpinning.c:412
vlib_get_buffer
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:111
NAT66_OUT2IN_NEXT_DROP
@ NAT66_OUT2IN_NEXT_DROP
Definition: nat66_out2in.c:65
nat66_static_mapping_t::l_addr
ip6_address_t l_addr
Definition: nat66.h:28
tcp_header_t
struct _tcp_header tcp_header_t
VLIB_NODE_TYPE_INTERNAL
@ VLIB_NODE_TYPE_INTERNAL
Definition: node.h:72
node
vlib_main_t vlib_node_runtime_t * node
Definition: nat44_ei.c:3047
fib_table.h
nat66_static_mapping_t::fib_index
u32 fib_index
Definition: nat66.h:30
u16
unsigned short u16
Definition: types.h:57
vm
vlib_main_t * vm
X-connect all packets from the HOST to the PHY.
Definition: nat44_ei.c:3047
VLIB_RX
@ VLIB_RX
Definition: defs.h:46
NAT66_OUT2IN_N_NEXT
@ NAT66_OUT2IN_N_NEXT
Definition: nat66_out2in.c:66
vlib_frame_t
Definition: node.h:372
vlib_buffer_length_in_chain
static uword vlib_buffer_length_in_chain(vlib_main_t *vm, vlib_buffer_t *b)
Get length in bytes of the buffer chain.
Definition: buffer_funcs.h:433
udp_header_t
Definition: udp_packet.h:45
NAT66_OUT2IN_N_ERROR
@ NAT66_OUT2IN_N_ERROR
Definition: nat66_out2in.c:53
format_nat66_out2in_trace
static u8 * format_nat66_out2in_trace(u8 *s, va_list *args)
Definition: nat66_out2in.c:31
vlib_increment_simple_counter
static void vlib_increment_simple_counter(vlib_simple_counter_main_t *cm, u32 thread_index, u32 index, u64 increment)
Increment a simple counter.
Definition: counter.h:74
ip6_parse
static_always_inline int ip6_parse(vlib_main_t *vm, vlib_buffer_t *b, const ip6_header_t *ip6, u32 buff_len, u8 *l4_protocol, u16 *l4_offset, u16 *frag_hdr_offset)
Parse some useful information from IPv6 header.
Definition: ip6_to_ip4.h:65
nat66_out2in_error_strings
static char * nat66_out2in_error_strings[]
Definition: nat66_out2in.c:56
vlib_buffer_t::error
vlib_error_t error
Error code for buffers to be enqueued to error handler.
Definition: buffer.h:145
VLIB_NODE_FN
#define VLIB_NODE_FN(node)
Definition: node.h:202
CLIB_UNUSED
#define CLIB_UNUSED(x)
Definition: clib.h:90
vnet_buffer
#define vnet_buffer(b)
Definition: buffer.h:437
VLIB_NODE_FLAG_TRACE
#define VLIB_NODE_FLAG_TRACE
Definition: node.h:291
PREDICT_FALSE
#define PREDICT_FALSE(x)
Definition: clib.h:124
ARRAY_LEN
#define ARRAY_LEN(x)
Definition: clib.h:70
vlib_frame_vector_args
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:301
vlib_main_t::thread_index
u32 thread_index
Definition: main.h:213
ip6_header_t::dst_address
ip6_address_t dst_address
Definition: ip6_packet.h:310
nat66_main_t
Definition: nat66.h:58
ip6_to_ip4.h
IPv6 to IPv4 translation.
nat66_out2in_trace_t
Definition: nat66_out2in.c:24
vlib_node_registration_t
struct _vlib_node_registration vlib_node_registration_t
vlib_buffer_t::current_length
u16 current_length
Nbytes between current data and the end of this buffer.
Definition: buffer.h:122
udp_header_t::checksum
u16 checksum
Definition: udp_packet.h:55
ip_csum_sub_even
static ip_csum_t ip_csum_sub_even(ip_csum_t c, ip_csum_t x)
Definition: ip_packet.h:273
vlib_validate_buffer_enqueue_x1
#define vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, bi0, next0)
Finish enqueueing one buffer forward in the graph.
Definition: buffer_node.h:224
format
description fragment has unexpected format
Definition: map.api:433
vlib_put_next_frame
vlib_put_next_frame(vm, node, next_index, 0)
fib_table_get_index_for_sw_if_index
u32 fib_table_get_index_for_sw_if_index(fib_protocol_t proto, u32 sw_if_index)
Get the index of the FIB bound to the interface.
Definition: fib_table.c:998
u32
unsigned int u32
Definition: types.h:88
NAT66_OUT2IN_NEXT_IP6_LOOKUP
@ NAT66_OUT2IN_NEXT_IP6_LOOKUP
Definition: nat66_out2in.c:64
nat66_out2in_trace_t::next_index
u32 next_index
Definition: nat66_out2in.c:27
FIB_PROTOCOL_IP6
@ FIB_PROTOCOL_IP6
Definition: fib_types.h:37
nat66_main
nat66_main_t nat66_main
Definition: nat66.c:25
nm
nat44_ei_main_t * nm
Definition: nat44_ei_hairpinning.c:413
ip6_header_t
Definition: ip6_packet.h:294
vlib_main_t
Definition: main.h:102
vlib_node_t
Definition: node.h:247
vlib_add_trace
void * vlib_add_trace(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_buffer_t *b, u32 n_data_bytes)
Definition: trace.c:628
u8
unsigned char u8
Definition: types.h:56
vlib_buffer_get_current
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:257
ip_csum_t
uword ip_csum_t
Definition: ip_packet.h:245
nat66_out2in_trace_t::sw_if_index
u32 sw_if_index
Definition: nat66_out2in.c:26
nat66.h
NAT66 global declarations.
nat66_out2in_node
vlib_node_registration_t nat66_out2in_node
(constructor) VLIB_REGISTER_NODE (nat66_out2in_node)
Definition: nat66_out2in.c:197
foreach_nat66_out2in_error
#define foreach_nat66_out2in_error
Definition: nat66_out2in.c:44
vlib_node_runtime_t
Definition: node.h:454
from
from
Definition: nat44_ei_hairpinning.c:415
ip_csum_add_even
static ip_csum_t ip_csum_add_even(ip_csum_t c, ip_csum_t x)
Definition: ip_packet.h:256
vlib_get_next_frame
#define vlib_get_next_frame(vm, node, next_index, vectors, n_vectors_left)
Get pointer to next frame vector data by (vlib_node_runtime_t, next_index).
Definition: node_funcs.h:395
ip_csum_fold
static u16 ip_csum_fold(ip_csum_t c)
Definition: ip_packet.h:301
nat66_static_mapping_t
Definition: nat66.h:26
VLIB_TX
@ VLIB_TX
Definition: defs.h:47
n_left_from
n_left_from
Definition: nat44_ei_hairpinning.c:416
type
vl_api_fib_path_type_t type
Definition: fib_types.api:123
vlib_increment_combined_counter
vlib_increment_combined_counter(ccm, ti, sw_if_index, n_buffers, n_bytes)
vlib_buffer_t::flags
u32 flags
buffer flags: VLIB_BUFFER_FREE_LIST_INDEX_MASK: bits used to store free list index,...
Definition: buffer.h:133
vlib_buffer_t
VLIB buffer representation.
Definition: buffer.h:111
VLIB_REGISTER_NODE
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:169