FD.io VPP  v21.01.1
Vector Packet Processing
output.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 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  * pg_output.c: packet generator output
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining
21  * a copy of this software and associated documentation files (the
22  * "Software"), to deal in the Software without restriction, including
23  * without limitation the rights to use, copy, modify, merge, publish,
24  * distribute, sublicense, and/or sell copies of the Software, and to
25  * permit persons to whom the Software is furnished to do so, subject to
26  * the following conditions:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
31  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38  */
39 
40 #include <vppinfra/string.h>
41 #include <vlib/vlib.h>
42 #include <vnet/vnet.h>
43 #include <vnet/pg/pg.h>
44 #include <vnet/ethernet/ethernet.h>
45 #include <vnet/gso/gro_func.h>
46 
47 uword
49 {
50  pg_main_t *pg = &pg_main;
51  u32 *buffers = vlib_frame_vector_args (frame);
52  uword n_buffers = frame->n_vectors;
53  uword n_left = n_buffers;
54  u32 to[GRO_TO_VECTOR_SIZE (n_buffers)];
55  uword n_to = 0;
56  vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
58 
59  if (PREDICT_FALSE (pif->lockp != 0))
60  while (clib_atomic_test_and_set (pif->lockp))
61  ;
62 
63  if (PREDICT_FALSE (pif->coalesce_enabled))
64  {
65  n_to = vnet_gro_inline (vm, pif->flow_table, buffers, n_left, to);
66  buffers = to;
67  n_left = n_to;
68  }
69 
70  while (n_left > 0)
71  {
72  n_left--;
73  u32 bi0 = buffers[0];
74  vlib_buffer_t *b = vlib_get_buffer (vm, bi0);
75  buffers++;
76 
77  if (b->flags & VLIB_BUFFER_IS_TRACED)
78  {
79  pg_output_trace_t *t = vlib_add_trace (vm, node, b, sizeof (*t));
80  t->buffer_index = bi0;
81  clib_memcpy_fast (&t->buffer, b,
82  sizeof (b[0]) - sizeof (b->pre_data));
84  sizeof (t->buffer.pre_data));
85  }
86 
87  if (pif->pcap_file_name != 0)
88  pcap_add_buffer (&pif->pcap_main, vm, bi0, ETHERNET_MAX_PACKET_BYTES);
89  }
90  if (pif->pcap_file_name != 0)
91  pcap_write (&pif->pcap_main);
92  if ((pif->pcap_main.flags & PCAP_MAIN_INIT_DONE)
93  && pif->pcap_main.n_packets_captured >=
94  pif->pcap_main.n_packets_to_capture)
95  pcap_close (&pif->pcap_main);
96 
97  if (PREDICT_FALSE (pif->coalesce_enabled))
98  {
99  n_buffers = n_to;
100  vlib_buffer_free (vm, to, n_to);
101  }
102  else
103  vlib_buffer_free (vm, vlib_frame_vector_args (frame), n_buffers);
104  if (PREDICT_FALSE (pif->lockp != 0))
105  clib_atomic_release (pif->lockp);
106 
107  return n_buffers;
108 }
109 
110 /*
111  * fd.io coding-style-patch-verification: ON
112  *
113  * Local Variables:
114  * eval: (c-set-style "gnu")
115  * End:
116  */
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:124
__clib_export clib_error_t * pcap_write(pcap_main_t *pm)
Write PCAP file.
Definition: pcap.c:89
static void vlib_buffer_free(vlib_main_t *vm, u32 *buffers, u32 n_buffers)
Free buffers Frees the entire buffer chain for each buffer.
Definition: buffer_funcs.h:937
u8 runtime_data[0]
Function dependent node-runtime data.
Definition: node.h:519
vlib_buffer_t buffer
Definition: pg.h:406
Definition: pg.h:327
Optimized string handling code, including c11-compliant "safe C library" variants.
i16 current_data
signed offset in data[], pre_data[] that we are currently processing.
Definition: buffer.h:110
#define clib_memcpy_fast(a, b, c)
Definition: string.h:81
u32 buffer_index
Definition: pg.h:405
vlib_main_t * vm
Definition: in2out_ed.c:1580
const cJSON *const b
Definition: cJSON.h:255
unsigned int u32
Definition: types.h:88
#define clib_atomic_test_and_set(a)
Definition: atomics.h:42
__clib_export clib_error_t * pcap_close(pcap_main_t *pm)
Close PCAP file.
Definition: pcap.c:74
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:546
#define clib_atomic_release(a)
Definition: atomics.h:43
#define PREDICT_FALSE(x)
Definition: clib.h:121
u16 n_vectors
Definition: node.h:397
u8 data[]
Packet data.
Definition: buffer.h:181
vlib_main_t vlib_node_runtime_t * node
Definition: in2out_ed.c:1580
#define PCAP_MAIN_INIT_DONE
Definition: pcap.h:175
static_always_inline u32 vnet_gro_inline(vlib_main_t *vm, gro_flow_table_t *flow_table, u32 *from, u16 n_left_from, u32 *to)
coalesce buffers with flow tables
Definition: gro_func.h:559
u8 pre_data[VLIB_BUFFER_PRE_DATA_SIZE]
Space for inserting data before buffer start.
Definition: buffer.h:178
vlib_main_t vlib_node_runtime_t vlib_frame_t * frame
Definition: in2out_ed.c:1581
#define GRO_TO_VECTOR_SIZE(X)
Definition: gro.h:27
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:297
uword pg_output(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: output.c:48
pg_main_t pg_main
Definition: init.c:44
#define ETHERNET_MAX_PACKET_BYTES
Definition: ethernet.h:133
void * vlib_add_trace(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_buffer_t *b, u32 n_data_bytes)
Definition: trace.c:634
static void pcap_add_buffer(pcap_main_t *pm, struct vlib_main_t *vm, u32 buffer_index, u32 n_bytes_in_trace)
Add buffer (vlib_buffer_t) to the trace.
Definition: pcap_funcs.h:67
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:85
pg_interface_t * interfaces
Definition: pg.h:339