FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
ipsec_if_out.c
Go to the documentation of this file.
1 /*
2  * ipsec_if_out.c : IPSec interface output node
3  *
4  * Copyright (c) 2015 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 
18 #include <vnet/vnet.h>
19 #include <vnet/api_errno.h>
20 #include <vnet/ip/ip.h>
21 
22 #include <vnet/ipsec/ipsec.h>
23 
24 /* Statistics (not really errors) */
25 #define foreach_ipsec_if_output_error \
26 _(TX, "good packets transmitted")
27 
29 #define _(sym,string) string,
31 #undef _
32 };
33 
34 typedef enum
35 {
36 #define _(sym,str) IPSEC_IF_OUTPUT_ERROR_##sym,
38 #undef _
41 
42 
43 typedef struct
44 {
48 
49 u8 *
50 format_ipsec_if_output_trace (u8 * s, va_list * args)
51 {
52  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
53  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
54  ipsec_if_output_trace_t *t = va_arg (*args, ipsec_if_output_trace_t *);
55 
56  s = format (s, "IPSec: spi %u seq %u", t->spi, t->seq);
57  return s;
58 }
59 
60 static uword
62  vlib_frame_t * from_frame)
63 {
64  ipsec_main_t *im = &ipsec_main;
65  vnet_main_t *vnm = im->vnet_main;
67  u32 *from, *to_next = 0, next_index;
68  u32 n_left_from, sw_if_index0, last_sw_if_index = ~0;
69  u32 thread_index = vlib_get_thread_index ();
70  u32 n_bytes = 0, n_packets = 0;
71 
72  from = vlib_frame_vector_args (from_frame);
73  n_left_from = from_frame->n_vectors;
74  next_index = node->cached_next_index;
75 
76  while (n_left_from > 0)
77  {
78  u32 n_left_to_next;
79 
80  vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
81 
82  while (n_left_from > 0 && n_left_to_next > 0)
83  {
84  u32 bi0, next0, len0;
85  vlib_buffer_t *b0;
88 
89  bi0 = to_next[0] = from[0];
90  from += 1;
91  n_left_from -= 1;
92  to_next += 1;
93  n_left_to_next -= 1;
94  b0 = vlib_get_buffer (vm, bi0);
95  sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
96  hi0 = vnet_get_sup_hw_interface (vnm, sw_if_index0);
98  vnet_buffer (b0)->ipsec.sad_index = t0->output_sa_index;
99  next0 = im->esp_encrypt_next_index;
100 
101  len0 = vlib_buffer_length_in_chain (vm, b0);
102 
103  if (PREDICT_TRUE (sw_if_index0 == last_sw_if_index))
104  {
105  n_packets++;
106  n_bytes += len0;
107  }
108  else
109  {
112  thread_index, sw_if_index0,
113  n_packets, n_bytes);
114  last_sw_if_index = sw_if_index0;
115  n_packets = 1;
116  n_bytes = len0;
117  }
118 
120  {
122  vlib_add_trace (vm, node, b0, sizeof (*tr));
123  ipsec_sa_t *sa0 =
125  tr->spi = sa0->spi;
126  tr->seq = sa0->seq;
127  }
128 
129  vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
130  n_left_to_next, bi0, next0);
131  }
132  vlib_put_next_frame (vm, node, next_index, n_left_to_next);
133  }
134 
135  if (last_sw_if_index != ~0)
136  {
139  thread_index,
140  last_sw_if_index, n_packets, n_bytes);
141  }
142 
144  IPSEC_IF_OUTPUT_ERROR_TX,
145  from_frame->n_vectors);
146 
147  return from_frame->n_vectors;
148 }
149 
150 /* *INDENT-OFF* */
152  .function = ipsec_if_output_node_fn,
153  .name = "ipsec-if-output",
154  .vector_size = sizeof (u32),
155  .format_trace = format_ipsec_if_output_trace,
156  .type = VLIB_NODE_TYPE_INTERNAL,
157 
159  .error_strings = ipsec_if_output_error_strings,
160 
161  .sibling_of = "ipsec-output-ip4",
162 };
163 /* *INDENT-ON* */
164 
166 /*
167  * fd.io coding-style-patch-verification: ON
168  *
169  * Local Variables:
170  * eval: (c-set-style "gnu")
171  * End:
172  */
u8 * format_ipsec_if_output_trace(u8 *s, va_list *args)
Definition: ipsec_if_out.c:50
static uword ipsec_if_output_node_fn(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *from_frame)
Definition: ipsec_if_out.c:61
#define CLIB_UNUSED(x)
Definition: clib.h:79
ipsec_tunnel_if_t * tunnel_interfaces
Definition: ipsec.h:261
static void vlib_increment_combined_counter(vlib_combined_counter_main_t *cm, u32 thread_index, u32 index, u64 n_packets, u64 n_bytes)
Increment a combined counter.
Definition: counter.h:211
static vnet_hw_interface_t * vnet_get_sup_hw_interface(vnet_main_t *vnm, u32 sw_if_index)
vnet_interface_main_t interface_main
Definition: vnet.h:56
#define PREDICT_TRUE(x)
Definition: clib.h:106
static char * ipsec_if_output_error_strings[]
Definition: ipsec_if_out.c:28
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
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:107
u32 spi
Definition: ipsec.h:114
u32 esp_encrypt_next_index
Definition: ipsec.h:288
ipsec_main_t ipsec_main
Definition: ipsec.c:28
vlib_combined_counter_main_t * combined_sw_if_counters
Definition: interface.h:672
ipsec_if_output_error_t
Definition: ipsec_if_out.c:34
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:459
vnet_main_t * vnet_main
Definition: ipsec.h:270
#define PREDICT_FALSE(x)
Definition: clib.h:105
#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:218
#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:364
static void vlib_node_increment_counter(vlib_main_t *vm, u32 node_index, u32 counter_index, u64 increment)
Definition: node_funcs.h:1158
u16 n_vectors
Definition: node.h:344
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:221
vlib_main_t * vm
Definition: buffer.c:283
#define VLIB_BUFFER_IS_TRACED
Definition: buffer.h:93
#define foreach_ipsec_if_output_error
Definition: ipsec_if_out.c:25
#define ARRAY_LEN(x)
Definition: clib.h:59
void vlib_put_next_frame(vlib_main_t *vm, vlib_node_runtime_t *r, u32 next_index, u32 n_vectors_left)
Release pointer to next frame vector data.
Definition: main.c:454
u32 output_sa_index
Definition: ipsec.h:244
u16 cached_next_index
Next frame index that vector arguments were last enqueued to last time this node ran.
Definition: node.h:456
unsigned int u32
Definition: types.h:88
ipsec_sa_t * sad
Definition: ipsec.h:258
u32 seq
Definition: ipsec.h:136
u64 uword
Definition: types.h:112
static void * vlib_add_trace(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_buffer_t *b, u32 n_data_bytes)
Definition: trace_funcs.h:55
Definition: defs.h:47
unsigned char u8
Definition: types.h:56
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:267
vlib_node_registration_t ipsec_if_output_node
(constructor) VLIB_REGISTER_NODE (ipsec_if_output_node)
Definition: ipsec_if_out.c:151
#define vnet_buffer(b)
Definition: buffer.h:326
#define VLIB_NODE_FUNCTION_MULTIARCH(node, fn)
Definition: node.h:158
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:143
u32 flags
buffer flags: VLIB_BUFFER_FREE_LIST_INDEX_MASK: bits used to store free list index, VLIB_BUFFER_IS_TRACED: trace this buffer.
Definition: buffer.h:75
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:57