vnet/vnet/unix/pcap.c

   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  * pcap.c: libpcap packet capture format
  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 <vnet/unix/pcap.h>
  41 #include <sys/fcntl.h>
  42
  43 /* Usage
  44
  45 #include <vnet/unix/pcap.h>
  46
  47 static pcap_main_t pcap = {
  48   .file_name = "/tmp/ip4",
  49   .n_packets_to_capture = 2,
  50   .packet_type = PCAP_PACKET_TYPE_ip,
  51 };
  52
  53 To add a buffer:
  54
  55   pcap_add_buffer (&pcap, vm, pi0, 128);
  56
  57 file will be written after n_packets_to_capture or call to pcap_write (&pcap).
  58
  59 */
  60
  61 clib_error_t *
  62 pcap_close (pcap_main_t * pm)
  63 {
  64   close (pm->file_descriptor);
  65   pm->flags &= ~PCAP_MAIN_INIT_DONE;
  66   pm->file_descriptor = -1;
  67   return 0;
  68 }
  69
  70 clib_error_t *
  71 pcap_write (pcap_main_t * pm)
  72 {
  73   clib_error_t * error = 0;
  74
  75   if (! (pm->flags & PCAP_MAIN_INIT_DONE))
  76     {
  77       pcap_file_header_t fh;
  78       int n;
  79
  80       if (! pm->file_name)
  81         pm->file_name = "/tmp/vnet.pcap";
  82
  83       pm->file_descriptor = open (pm->file_name, O_CREAT | O_TRUNC | O_WRONLY, 0664);
  84       if (pm->file_descriptor < 0)
  85         {
  86           error = clib_error_return_unix (0, "failed to open `%s'", pm->file_name);
  87           goto done;
  88         }
  89
  90       pm->flags |= PCAP_MAIN_INIT_DONE;
  91       pm->n_packets_captured = 0;
  92       pm->n_pcap_data_written = 0;
  93
  94       /* Write file header. */
  95       memset (&fh, 0, sizeof (fh));
  96       fh.magic = 0xa1b2c3d4;
  97       fh.major_version = 2;
  98       fh.minor_version = 4;
  99       fh.time_zone = 0;
 100       fh.max_packet_size_in_bytes = 1 << 16;
 101       fh.packet_type = pm->packet_type;
 102       n = write (pm->file_descriptor, &fh, sizeof (fh));
 103       if (n != sizeof (fh))
 104         {
 105           if (n < 0)
 106             error = clib_error_return_unix (0, "write file header `%s'", pm->file_name);
 107           else
 108             error = clib_error_return (0, "short write of file header `%s'", pm->file_name);
 109           goto done;
 110         }
 111     }
 112
 113   while (vec_len (pm->pcap_data) > pm->n_pcap_data_written)
 114     {
 115       int n = vec_len (pm->pcap_data) - pm->n_pcap_data_written;
 116
 117       n = write (pm->file_descriptor,
 118                  vec_elt_at_index (pm->pcap_data, pm->n_pcap_data_written), n);
 119
 120       if (n < 0 && unix_error_is_fatal (errno))
 121         {
 122           error = clib_error_return_unix (0, "write `%s'", pm->file_name);
 123           goto done;
 124         }
 125         pm->n_pcap_data_written += n;
 126       }
 127
 128   if (pm->n_pcap_data_written >= vec_len (pm->pcap_data))
 129     {
 130       vec_reset_length (pm->pcap_data);
 131       pm->n_pcap_data_written = 0;
 132     }
 133
 134   if (pm->n_packets_captured >= pm->n_packets_to_capture)
 135     pcap_close(pm);
 136
 137  done:
 138   if (error)
 139     {
 140       if (pm->file_descriptor >= 0)
 141         close (pm->file_descriptor);
 142     }
 143   return error;
 144 }
 145
 146 clib_error_t * pcap_read (pcap_main_t * pm)
 147 {
 148   clib_error_t * error = 0;
 149   int fd, need_swap, n;
 150   pcap_file_header_t fh;
 151   pcap_packet_header_t ph;
 152
 153   fd = open (pm->file_name, O_RDONLY);
 154   if (fd < 0)
 155     {
 156       error = clib_error_return_unix (0, "open `%s'", pm->file_name);
 157       goto done;
 158     }
 159
 160   if (read (fd, &fh, sizeof (fh)) != sizeof (fh))
 161     {
 162       error = clib_error_return_unix (0, "read file header `%s'", pm->file_name);
 163       goto done;
 164     }
 165
 166   need_swap = 0;
 167   if (fh.magic == 0xd4c3b2a1)
 168     {
 169       need_swap = 1;
 170 #define _(t,f) fh.f = clib_byte_swap_##t (fh.f);
 171       foreach_pcap_file_header;
 172 #undef _
 173     }
 174
 175   if (fh.magic != 0xa1b2c3d4)
 176     {
 177       error = clib_error_return (0, "bad magic `%s'", pm->file_name);
 178       goto done;
 179     }
 180
 181   pm->min_packet_bytes = 0;
 182   pm->max_packet_bytes = 0;
 183   while ((n = read (fd, &ph, sizeof (ph))) != 0)
 184     {
 185       u8 * data;
 186
 187       if (need_swap)
 188         {
 189 #define _(t,f) ph.f = clib_byte_swap_##t (ph.f);
 190           foreach_pcap_packet_header;
 191 #undef _
 192         }
 193
 194       data = vec_new (u8, ph.n_bytes_in_packet);
 195       if (read (fd, data, ph.n_packet_bytes_stored_in_file) != ph.n_packet_bytes_stored_in_file)
 196         {
 197           error = clib_error_return (0, "short read `%s'", pm->file_name);
 198           goto done;
 199         }
 200
 201       if (vec_len (pm->packets_read) == 0)
 202         pm->min_packet_bytes = pm->max_packet_bytes = ph.n_bytes_in_packet;
 203       else
 204         {
 205           pm->min_packet_bytes = clib_min (pm->min_packet_bytes, ph.n_bytes_in_packet);
 206           pm->max_packet_bytes = clib_max (pm->max_packet_bytes, ph.n_bytes_in_packet);
 207         }
 208
 209       vec_add1 (pm->packets_read, data);
 210     }
 211
 212  done:
 213   if (fd >= 0)
 214     close (fd);
 215   return error;
 216
 217 }