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.c: 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.
41 #include <vppinfra/pcap.h>
45 * @brief PCAP function.
50 * \#include <vppinfra/pcap.h>
52 * static pcap_main_t pcap = {
53 * .file_name = "/tmp/ip4",
54 * .n_packets_to_capture = 2,
55 * .packet_type = PCAP_PACKET_TYPE_ip,
61 * <code><pre>pcap_add_buffer (&pcap, vm, pi0, 128);</pre></code>
63 * File will be written after @c n_packets_to_capture or call to pcap_write (&pcap).
68 * @brief Close PCAP file
70 * @return rc - clib_error_t
73 __clib_export clib_error_t *
74 pcap_close (pcap_main_t * pm)
76 close (pm->file_descriptor);
77 pm->flags &= ~PCAP_MAIN_INIT_DONE;
78 pm->file_descriptor = -1;
83 * @brief Write PCAP file
85 * @return rc - clib_error_t
88 __clib_export clib_error_t *
89 pcap_write (pcap_main_t * pm)
91 clib_error_t *error = 0;
93 if (!(pm->flags & PCAP_MAIN_INIT_DONE))
95 pcap_file_header_t fh;
99 pm->file_name = "/tmp/vnet.pcap";
101 pm->file_descriptor =
102 open (pm->file_name, O_CREAT | O_TRUNC | O_WRONLY, 0664);
103 if (pm->file_descriptor < 0)
106 clib_error_return_unix (0, "failed to open `%s'", pm->file_name);
110 pm->flags |= PCAP_MAIN_INIT_DONE;
111 pm->n_packets_captured = 0;
112 pm->n_pcap_data_written = 0;
113 clib_spinlock_init (&pm->lock);
115 /* Write file header. */
116 clib_memset (&fh, 0, sizeof (fh));
117 fh.magic = 0xa1b2c3d4;
118 fh.major_version = 2;
119 fh.minor_version = 4;
121 fh.max_packet_size_in_bytes = 1 << 16;
122 fh.packet_type = pm->packet_type;
123 n = write (pm->file_descriptor, &fh, sizeof (fh));
124 if (n != sizeof (fh))
128 clib_error_return_unix (0, "write file header `%s'",
132 clib_error_return (0, "short write of file header `%s'",
138 while (vec_len (pm->pcap_data) > pm->n_pcap_data_written)
140 i64 n = vec_len (pm->pcap_data) - pm->n_pcap_data_written;
142 n = write (pm->file_descriptor,
143 vec_elt_at_index (pm->pcap_data, pm->n_pcap_data_written),
146 if (n < 0 && unix_error_is_fatal (errno))
148 error = clib_error_return_unix (0, "write `%s'", pm->file_name);
151 pm->n_pcap_data_written += n;
154 if (pm->n_pcap_data_written >= vec_len (pm->pcap_data))
156 vec_reset_length (pm->pcap_data);
157 pm->n_pcap_data_written = 0;
163 if (pm->file_descriptor >= 0)
164 close (pm->file_descriptor);
170 * @brief Read PCAP file
172 * @return rc - clib_error_t
175 __clib_export clib_error_t *
176 pcap_read (pcap_main_t * pm)
178 clib_error_t *error = 0;
179 int fd, need_swap, n;
180 pcap_file_header_t fh;
181 pcap_packet_header_t ph;
183 fd = open (pm->file_name, O_RDONLY);
186 error = clib_error_return_unix (0, "open `%s'", pm->file_name);
190 if (read (fd, &fh, sizeof (fh)) != sizeof (fh))
193 clib_error_return_unix (0, "read file header `%s'", pm->file_name);
198 if (fh.magic == 0xd4c3b2a1)
201 #define _(t,f) fh.f = clib_byte_swap_##t (fh.f);
202 foreach_pcap_file_header;
206 if (fh.magic != 0xa1b2c3d4)
208 error = clib_error_return (0, "bad magic `%s'", pm->file_name);
212 pm->min_packet_bytes = 0;
213 pm->max_packet_bytes = 0;
214 while ((n = read (fd, &ph, sizeof (ph))) != 0)
223 #define _(t,f) ph.f = clib_byte_swap_##t (ph.f);
224 foreach_pcap_packet_header;
228 data = vec_new (u8, ph.n_bytes_in_packet);
229 if (read (fd, data, ph.n_packet_bytes_stored_in_file) !=
230 ph.n_packet_bytes_stored_in_file)
232 error = clib_error_return (0, "short read `%s'", pm->file_name);
236 if (vec_len (pm->packets_read) == 0)
237 pm->min_packet_bytes = pm->max_packet_bytes = ph.n_bytes_in_packet;
240 pm->min_packet_bytes =
241 clib_min (pm->min_packet_bytes, ph.n_bytes_in_packet);
242 pm->max_packet_bytes =
243 clib_max (pm->max_packet_bytes, ph.n_bytes_in_packet);
246 timestamp_sec = ph.time_in_sec;
247 timestamp_usec = ph.time_in_usec;
248 timestamp = ((u64) timestamp_sec) * 1000000 + (u64) timestamp_usec;
249 vec_add1 (pm->packets_read, data);
250 vec_add1 (pm->timestamps, timestamp);
261 * fd.io coding-style-patch-verification: ON
264 * eval: (c-set-style "gnu")