FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
pcap_funcs.h
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 #ifndef included_vppinfra_pcap_funcs_h
17 #define included_vppinfra_pcap_funcs_h
18 
19 /** Write out data to output file. */
22 
23 /** Read data from file. */
25 
26 /** Close the file created by pcap_write function. */
28 
29 /**
30  * @brief Add packet
31  *
32  * @param *pm - pcap_main_t
33  * @param time_now - f64
34  * @param n_bytes_in_trace - u32
35  * @param n_bytes_in_packet - u32
36  *
37  * @return Packet Data
38  *
39  */
40 static inline void *
42  f64 time_now, u32 n_bytes_in_trace, u32 n_bytes_in_packet)
43 {
45  u8 *d;
46 
47  vec_add2 (pm->pcap_data, d, sizeof (h[0]) + n_bytes_in_trace);
48  h = (void *) (d);
49  h->time_in_sec = time_now;
50  h->time_in_usec = 1e6 * (time_now - h->time_in_sec);
51  h->n_packet_bytes_stored_in_file = n_bytes_in_trace;
52  h->n_bytes_in_packet = n_bytes_in_packet;
53  pm->n_packets_captured++;
54  return h->data;
55 }
56 
57 /**
58  * @brief Add buffer (vlib_buffer_t) to the trace
59  *
60  * @param *pm - pcap_main_t
61  * @param *vm - vlib_main_t
62  * @param buffer_index - u32
63  * @param n_bytes_in_trace - u32
64  *
65  */
66 static inline void
68  struct vlib_main_t *vm, u32 buffer_index,
69  u32 n_bytes_in_trace)
70 {
71  vlib_buffer_t *b = vlib_get_buffer (vm, buffer_index);
72  u32 n = vlib_buffer_length_in_chain (vm, b);
73  i32 n_left = clib_min (n_bytes_in_trace, n);
74  f64 time_now = vlib_time_now (vm);
75  void *d;
76 
78  {
80  d = pcap_add_packet (pm, time_now, n_left, n);
81  while (1)
82  {
83  u32 copy_length = clib_min ((u32) n_left, b->current_length);
84  clib_memcpy_fast (d, b->data + b->current_data, copy_length);
85  n_left -= b->current_length;
86  if (n_left <= 0)
87  break;
88  d += b->current_length;
89  ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
90  b = vlib_get_buffer (vm, b->next_buffer);
91  }
93  }
94 }
95 
96 #endif /* included_vppinfra_pcap_funcs_h */
97 
98 /*
99  * fd.io coding-style-patch-verification: ON
100  *
101  * Local Variables:
102  * eval: (c-set-style "gnu")
103  * End:
104  */
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
#define clib_min(x, y)
Definition: clib.h:327
u32 n_packets_to_capture
Number of packets to capture.
Definition: pcap.h:165
#define PREDICT_TRUE(x)
Definition: clib.h:121
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
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:333
static_always_inline void clib_spinlock_unlock_if_init(clib_spinlock_t *p)
Definition: lock.h:127
u16 current_length
Nbytes between current data and the end of this buffer.
Definition: buffer.h:113
#define vec_add2(V, P, N)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:630
vlib_main_t * vm
Definition: in2out_ed.c:1582
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:402
unsigned char u8
Definition: types.h:56
double f64
Definition: types.h:142
PCAP main state data structure.
Definition: pcap.h:156
clib_spinlock_t lock
spinlock to protect e.g.
Definition: pcap.h:159
foreach_pcap_packet_header u8 data[0]
Packet data follows.
Definition: pcap.h:150
unsigned int u32
Definition: types.h:88
clib_error_t * pcap_read(pcap_main_t *pm)
Read data from file.
Definition: pcap.c:176
u8 * pcap_data
Vector of pcap data.
Definition: pcap.h:184
vec_header_t h
Definition: buffer.c:322
static void * pcap_add_packet(pcap_main_t *pm, f64 time_now, u32 n_bytes_in_trace, u32 n_bytes_in_packet)
Add packet.
Definition: pcap_funcs.h:41
clib_error_t * pcap_close(pcap_main_t *pm)
Write out data to output file.
Definition: pcap.c:74
u8 data[]
Packet data.
Definition: buffer.h:181
Packet header.
Definition: pcap.h:144
signed int i32
Definition: types.h:77
#define ASSERT(truth)
clib_error_t * pcap_write(pcap_main_t *pm)
Write PCAP file.
Definition: pcap.c:89
u32 next_buffer
Next buffer for this linked-list of buffers.
Definition: buffer.h:140
VLIB buffer representation.
Definition: buffer.h:102
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_always_inline void clib_spinlock_lock_if_init(clib_spinlock_t *p)
Definition: lock.h:104
u32 n_packets_captured
Number of packets currently captured.
Definition: pcap.h:171
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