src/vnet/unix/pcap.h

   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.h: 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  * @file
  41  * @brief PCAP utility definitions
  42  */
  43 #ifndef included_vnet_pcap_h
  44 #define included_vnet_pcap_h
  45
  46 #include <vlib/vlib.h>
  47
  48 /**
  49  * @brief Packet types supported by PCAP
  50  *
  51  * null 0
  52  * ethernet 1
  53  * ppp 9
  54  * ip 12
  55  * hdlc 104
  56  */
  57 #define foreach_vnet_pcap_packet_type           \
  58   _ (null, 0)                                   \
  59   _ (ethernet, 1)                               \
  60   _ (ppp, 9)                                    \
  61   _ (ip, 12)                                    \
  62   _ (hdlc, 104)
  63
  64 typedef enum
  65 {
  66 #define _(f,n) PCAP_PACKET_TYPE_##f = (n),
  67   foreach_vnet_pcap_packet_type
  68 #undef _
  69 } pcap_packet_type_t;
  70
  71 #define foreach_pcap_file_header                        \
  72   /** 0xa1b2c3d4 host byte order.                       \
  73      0xd4c3b2a1 => need to byte swap everything. */     \
  74   _ (u32, magic)                                        \
  75                                                         \
  76   /** Currently major 2 minor 4. */                     \
  77   _ (u16, major_version)                                \
  78   _ (u16, minor_version)                                \
  79                                                         \
  80   /** 0 for GMT. */                                     \
  81   _ (u32, time_zone)                                    \
  82                                                         \
  83   /** Accuracy of timestamps.  Typically set to 0. */   \
  84   _ (u32, sigfigs)                                      \
  85                                                         \
  86   /** Size of largest packet in file. */                \
  87   _ (u32, max_packet_size_in_bytes)                     \
  88                                                         \
  89   /** One of vnet_pcap_packet_type_t. */                \
  90   _ (u32, packet_type)
  91
  92 /** File header struct */
  93 typedef struct
  94 {
  95 #define _(t, f) t f;
  96   foreach_pcap_file_header
  97 #undef _
  98 } pcap_file_header_t;
  99
 100 #define foreach_pcap_packet_header                                      \
 101   /** Time stamp in seconds  */                                         \
 102   _ (u32, time_in_sec)                                                  \
 103   /** Time stamp in microseconds. */                                    \
 104   _ (u32, time_in_usec)                                                 \
 105                                                                         \
 106   /** Number of bytes stored in file. */                                \
 107   _ (u32, n_packet_bytes_stored_in_file)                                \
 108   /** Number of bytes in actual packet. */                              \
 109   _ (u32, n_bytes_in_packet)
 110
 111 /** Packet header. */
 112 typedef struct
 113 {
 114 #define _(t, f) t f;
 115   foreach_pcap_packet_header
 116 #undef _
 117   /** Packet data follows. */
 118   u8 data[0];
 119 } pcap_packet_header_t;
 120
 121 /**
 122  * @brief PCAP main state data structure
 123  */
 124 typedef struct
 125 {
 126   /** spinlock to protect e.g. pcap_data */
 127   clib_spinlock_t lock;
 128
 129   /** File name of pcap output. */
 130   char *file_name;
 131
 132   /** Number of packets to capture. */
 133   u32 n_packets_to_capture;
 134
 135   /** Packet type */
 136   pcap_packet_type_t packet_type;
 137
 138   /** Number of packets currently captured. */
 139   u32 n_packets_captured;
 140
 141   /** flags */
 142   u32 flags;
 143 #define PCAP_MAIN_INIT_DONE (1 << 0)
 144
 145   /** File descriptor for reading/writing. */
 146   int file_descriptor;
 147
 148   /** Bytes written */
 149   u32 n_pcap_data_written;
 150
 151   /** Vector of pcap data. */
 152   u8 *pcap_data;
 153
 154   /** Packets read from file. */
 155   u8 **packets_read;
 156
 157   /** Timestamps */
 158   u64 *timestamps;
 159
 160   /** Min/Max Packet bytes */
 161   u32 min_packet_bytes, max_packet_bytes;
 162 } pcap_main_t;
 163
 164 /** Write out data to output file. */
 165 clib_error_t *pcap_write (pcap_main_t * pm);
 166
 167 /** Read data from file. */
 168 clib_error_t *pcap_read (pcap_main_t * pm);
 169
 170 /**
 171  * @brief Add packet
 172  *
 173  * @param *pm - pcap_main_t
 174  * @param time_now - f64
 175  * @param n_bytes_in_trace - u32
 176  * @param n_bytes_in_packet - u32
 177  *
 178  * @return Packet Data
 179  *
 180  */
 181 static inline void *
 182 pcap_add_packet (pcap_main_t * pm,
 183                  f64 time_now, u32 n_bytes_in_trace, u32 n_bytes_in_packet)
 184 {
 185   pcap_packet_header_t *h;
 186   u8 *d;
 187
 188   vec_add2 (pm->pcap_data, d, sizeof (h[0]) + n_bytes_in_trace);
 189   h = (void *) (d);
 190   h->time_in_sec = time_now;
 191   h->time_in_usec = 1e6 * (time_now - h->time_in_sec);
 192   h->n_packet_bytes_stored_in_file = n_bytes_in_trace;
 193   h->n_bytes_in_packet = n_bytes_in_packet;
 194   pm->n_packets_captured++;
 195   return h->data;
 196 }
 197
 198 /**
 199  * @brief Add buffer (vlib_buffer_t) to the trace
 200  *
 201  * @param *pm - pcap_main_t
 202  * @param *vm - vlib_main_t
 203  * @param buffer_index - u32
 204  * @param n_bytes_in_trace - u32
 205  *
 206  */
 207 static inline void
 208 pcap_add_buffer (pcap_main_t * pm,
 209                  vlib_main_t * vm, u32 buffer_index, u32 n_bytes_in_trace)
 210 {
 211   vlib_buffer_t *b = vlib_get_buffer (vm, buffer_index);
 212   u32 n = vlib_buffer_length_in_chain (vm, b);
 213   i32 n_left = clib_min (n_bytes_in_trace, n);
 214   f64 time_now = vlib_time_now (vm);
 215   void *d;
 216
 217   if (PREDICT_TRUE (pm->n_packets_captured < pm->n_packets_to_capture))
 218     {
 219       clib_spinlock_lock_if_init (&pm->lock);
 220       d = pcap_add_packet (pm, time_now, n_left, n);
 221       while (1)
 222         {
 223           u32 copy_length = clib_min ((u32) n_left, b->current_length);
 224           clib_memcpy_fast (d, b->data + b->current_data, copy_length);
 225           n_left -= b->current_length;
 226           if (n_left <= 0)
 227             break;
 228           d += b->current_length;
 229           ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
 230           b = vlib_get_buffer (vm, b->next_buffer);
 231         }
 232       clib_spinlock_unlock_if_init (&pm->lock);
 233     }
 234 }
 235
 236 #endif /* included_vnet_pcap_h */
 237
 238 /*
 239  * fd.io coding-style-patch-verification: ON
 240  *
 241  * Local Variables:
 242  * eval: (c-set-style "gnu")
 243  * End:
 244  */