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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * pcap.h: libpcap packet capture format
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #ifndef included_vnet_pcap_h
41 #define included_vnet_pcap_h
43 #include <vlib/vlib.h>
45 #define foreach_vnet_pcap_packet_type \
53 #define _(f,n) PCAP_PACKET_TYPE_##f = (n),
54 foreach_vnet_pcap_packet_type
58 #define foreach_pcap_file_header \
59 /* 0xa1b2c3d4 host byte order. \
60 0xd4c3b2a1 => need to byte swap everything. */ \
63 /* Currently major 2 minor 4. */ \
64 _ (u16, major_version) \
65 _ (u16, minor_version) \
70 /* Accuracy of timestamps. Typically set to 0. */ \
73 /* Size of largest packet in file. */ \
74 _ (u32, max_packet_size_in_bytes) \
76 /* One of vnet_pcap_packet_type_t. */ \
82 foreach_pcap_file_header
86 #define foreach_pcap_packet_header \
87 /* Time stamp in seconds and microseconds. */ \
88 _ (u32, time_in_sec) \
89 _ (u32, time_in_usec) \
91 /* Number of bytes stored in file and size of actual packet. */ \
92 _ (u32, n_packet_bytes_stored_in_file) \
93 _ (u32, n_bytes_in_packet)
98 foreach_pcap_packet_header
101 /* Packet data follows. */
103 } pcap_packet_header_t;
106 /* File name of pcap output. */
109 /* Number of packets to capture. */
110 u32 n_packets_to_capture;
112 pcap_packet_type_t packet_type;
114 /* Number of packets currently captured. */
115 u32 n_packets_captured;
118 #define PCAP_MAIN_INIT_DONE (1 << 0)
120 /* File descriptor for reading/writing. */
123 u32 n_pcap_data_written;
125 /* Vector of pcap data. */
128 /* Packets read from file. */
131 u32 min_packet_bytes, max_packet_bytes;
134 /* Write out data to output file. */
135 clib_error_t * pcap_write (pcap_main_t * pm);
137 clib_error_t * pcap_read (pcap_main_t * pm);
140 pcap_add_packet (pcap_main_t * pm,
142 u32 n_bytes_in_trace,
143 u32 n_bytes_in_packet)
145 pcap_packet_header_t * h;
148 vec_add2 (pm->pcap_data, d, sizeof (h[0]) + n_bytes_in_trace);
150 h->time_in_sec = time_now;
151 h->time_in_usec = 1e6*(time_now - h->time_in_sec);
152 h->n_packet_bytes_stored_in_file = n_bytes_in_trace;
153 h->n_bytes_in_packet = n_bytes_in_packet;
154 pm->n_packets_captured++;
159 pcap_add_buffer (pcap_main_t * pm,
160 vlib_main_t * vm, u32 buffer_index,
161 u32 n_bytes_in_trace)
163 vlib_buffer_t * b = vlib_get_buffer (vm, buffer_index);
164 u32 n = vlib_buffer_length_in_chain (vm, b);
165 i32 n_left = clib_min (n_bytes_in_trace, n);
166 f64 time_now = vlib_time_now (vm);
169 d = pcap_add_packet (pm, time_now, n_bytes_in_trace, n_left);
172 memcpy (d, b->data + b->current_data, b->current_length);
173 n_left -= b->current_length;
176 d += b->current_length;
177 ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
178 b = vlib_get_buffer (vm, b->next_buffer);
181 /* Flush output vector. */
182 if (vec_len (pm->pcap_data) >= 64*1024
183 || pm->n_packets_captured >= pm->n_packets_to_capture)
187 #endif /* included_vnet_pcap_h */