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