The "file types" we have are actually combinations of types and
[metze/wireshark/wip.git] / wiretap / wtap.c
index 0735c7eb7803ca25e251c72fe6aa1a4ef13df567..bf9981a84c361fc23d4d81a6853d795baeda47f8 100644 (file)
@@ -20,9 +20,7 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 
-#ifdef HAVE_CONFIG_H
 #include "config.h"
-#endif
 
 #include <string.h>
 #include <errno.h>
 #include <unistd.h>
 #endif
 
+#ifdef HAVE_LIBZ
+#include <zlib.h>
+#endif
+
 #include "wtap-int.h"
-#include "wtap.h"
 
 #include "file_wrappers.h"
 #include <wsutil/file_util.h>
 gint64
 wtap_file_size(wtap *wth, int *err)
 {
-       struct stat statb;
+       ws_statb64 statb;
 
-       if (fstat(wth->fd, &statb) == -1) {
-               if (err != NULL)
-                       *err = errno;
+       if (file_fstat((wth->fh == NULL) ? wth->random_fh : wth->fh,
+           &statb, err) == -1)
                return -1;
-       }
        return statb.st_size;
 }
 
+/*
+ * Do an fstat on the file.
+ */
 int
-wtap_file_type(wtap *wth)
+wtap_fstat(wtap *wth, ws_statb64 *statb, int *err)
 {
-       return wth->file_type;
+       if (file_fstat((wth->fh == NULL) ? wth->random_fh : wth->fh,
+           statb, err) == -1)
+               return -1;
+       return 0;
 }
 
 int
+wtap_file_type_subtype(wtap *wth)
+{
+       return wth->file_type_subtype;
+}
+
+gboolean
+wtap_iscompressed(wtap *wth)
+{
+       return file_iscompressed((wth->fh == NULL) ? wth->random_fh : wth->fh);
+}
+
+guint
 wtap_snapshot_length(wtap *wth)
 {
        return wth->snapshot_length;
@@ -83,6 +100,46 @@ wtap_file_tsprecision(wtap *wth)
        return wth->tsprecision;
 }
 
+wtapng_section_t *
+wtap_file_get_shb_info(wtap *wth)
+{
+       wtapng_section_t                *shb_hdr;
+
+       if(wth == NULL)
+               return NULL;
+       shb_hdr = g_new(wtapng_section_t,1);
+       shb_hdr->section_length = wth->shb_hdr.section_length;
+       /* options */
+       shb_hdr->opt_comment   =        wth->shb_hdr.opt_comment;       /* NULL if not available */
+       shb_hdr->shb_hardware  =        wth->shb_hdr.shb_hardware;      /* NULL if not available, UTF-8 string containing the description of the hardware used to create this section. */
+       shb_hdr->shb_os        =        wth->shb_hdr.shb_os;            /* NULL if not available, UTF-8 string containing the name of the operating system used to create this section. */
+       shb_hdr->shb_user_appl =        wth->shb_hdr.shb_user_appl;     /* NULL if not available, UTF-8 string containing the name of the application used to create this section. */
+
+
+       return shb_hdr;
+}
+
+void
+wtap_write_shb_comment(wtap *wth, gchar *comment)
+{
+       g_free(wth->shb_hdr.opt_comment);
+       wth->shb_hdr.opt_comment = comment;
+
+}
+
+wtapng_iface_descriptions_t *
+wtap_file_get_idb_info(wtap *wth)
+{
+       wtapng_iface_descriptions_t *idb_info;
+
+       idb_info = g_new(wtapng_iface_descriptions_t,1);
+
+       idb_info->number_of_interfaces  = wth->number_of_interfaces;
+       idb_info->interface_data        = wth->interface_data;
+
+       return idb_info;
+}
+
 /* Table of the encapsulation types we know about. */
 struct encap_type_info {
        const char *name;
@@ -153,17 +210,17 @@ static struct encap_type_info encap_table_base[] = {
        /* WTAP_ENCAP_IEEE_802_11 */
        { "IEEE 802.11 Wireless LAN", "ieee-802-11" },
 
-       /* WTAP_ENCAP_PRISM_HEADER */
-       { "IEEE 802.11 plus Prism II monitor mode header", "prism" },
+       /* WTAP_ENCAP_IEEE_802_11_PRISM */
+       { "IEEE 802.11 plus Prism II monitor mode radio header", "ieee-802-11-prism" },
 
        /* WTAP_ENCAP_IEEE_802_11_WITH_RADIO */
        { "IEEE 802.11 Wireless LAN with radio information", "ieee-802-11-radio" },
 
-       /* WTAP_ENCAP_IEEE_802_11_WLAN_RADIOTAP */
-       { "IEEE 802.11 plus radiotap WLAN header", "ieee-802-11-radiotap" },
+       /* WTAP_ENCAP_IEEE_802_11_RADIOTAP */
+       { "IEEE 802.11 plus radiotap radio header", "ieee-802-11-radiotap" },
 
-       /* WTAP_ENCAP_IEEE_802_11_WLAN_AVS */
-       { "IEEE 802.11 plus AVS WLAN header", "ieee-802-11-avs" },
+       /* WTAP_ENCAP_IEEE_802_11_AVS */
+       { "IEEE 802.11 plus AVS radio header", "ieee-802-11-avs" },
 
        /* WTAP_ENCAP_SLL */
        { "Linux cooked-mode capture", "linux-sll" },
@@ -328,7 +385,7 @@ static struct encap_type_info encap_table_base[] = {
        { "GCOM Serial", "gcom-serial" },
 
        /* WTAP_ENCAP_NETTL_X25 */
-       { "X25 with nettl headers", "x25-nettl" },
+       { "X.25 with nettl headers", "x25-nettl" },
 
        /* WTAP_ENCAP_K12 */
        { "K12 protocol analyzer", "k12" },
@@ -355,7 +412,7 @@ static struct encap_type_info encap_table_base[] = {
        { "Juniper GGSN", "juniper-ggsn" },
 
        /* WTAP_ENCAP_LINUX_LAPD */
-       { "LAPD", "lapd" },
+       { "LAPD with Linux pseudo-header", "linux-lapd" },
 
        /* WTAP_ENCAP_CATAPULT_DCT2000 */
        { "Catapult DCT2000", "dct2000" },
@@ -385,10 +442,10 @@ static struct encap_type_info encap_table_base[] = {
        { "Per-Packet Information header", "ppi" },
 
        /* WTAP_ENCAP_ERF */
-       { "Endace Record File", "erf" },
+       { "Extensible Record Format", "erf" },
 
-       /* WTAP_ENCAP_BT_H4 */
-       { "Bluetooth H4 with linux header", "bluetooth-h4" },
+       /* WTAP_ENCAP_BLUETOOTH_H4_WITH_PHDR */
+       { "Bluetooth H4 with linux header", "bluetooth-h4-linux" },
 
        /* WTAP_ENCAP_SITA */
        { "SITA WAN packets", "sita-wan" },
@@ -435,12 +492,18 @@ static struct encap_type_info encap_table_base[] = {
        /* WTAP_ENCAP_TNEF */
        { "Transport-Neutral Encapsulation Format", "tnef" },
 
-       /* WTAP_ENCAP_USB_LINUX_MMAP */
+       /* WTAP_ENCAP_USB_LINUX_MMAPPED */
        { "USB packets with Linux header and padding", "usb-linux-mmap" },
 
        /* WTAP_ENCAP_GSM_UM */
        { "GSM Um Interface", "gsm_um" },
 
+       /* WTAP_ENCAP_DPNSS */
+       { "Digital Private Signalling System No 1 Link Layer", "dpnss_link" },
+
+       /* WTAP_ENCAP_PACKETLOGGER */
+       { "PacketLogger", "packetlogger" },
+
        /* WTAP_ENCAP_NSTRACE_1_0 */
        { "NetScaler Encapsulation 1.0 of Ethernet", "nstrace10" },
 
@@ -457,13 +520,111 @@ static struct encap_type_info encap_table_base[] = {
        { "JPEG/JFIF", "jfif" },
 
        /* WTAP_ENCAP_IPNET */
-       { "Solaris IPNET", "ipnet" }
+       { "Solaris IPNET", "ipnet" },
+
+       /* WTAP_ENCAP_SOCKETCAN */
+       { "SocketCAN", "socketcan" },
+
+       /* WTAP_ENCAP_IEEE_802_11_NETMON */
+       { "IEEE 802.11 plus Network Monitor radio header", "ieee-802-11-netmon" },
+
+       /* WTAP_ENCAP_IEEE802_15_4_NOFCS */
+       { "IEEE 802.15.4 Wireless PAN with FCS not present", "wpan-nofcs" },
+
+       /* WTAP_ENCAP_RAW_IPFIX */
+       { "IPFIX", "ipfix" },
+
+       /* WTAP_ENCAP_RAW_IP4 */
+       { "Raw IPv4", "rawip4" },
+
+       /* WTAP_ENCAP_RAW_IP6 */
+       { "Raw IPv6", "rawip6" },
+
+       /* WTAP_ENCAP_LAPD */
+       { "LAPD", "lapd" },
+
+       /* WTAP_ENCAP_DVBCI */
+       { "DVB-CI (Common Interface)", "dvbci"},
+
+       /* WTAP_ENCAP_MUX27010 */
+       { "MUX27010", "mux27010"},
+
+       /* WTAP_ENCAP_MIME */
+       { "MIME", "mime" },
+
+       /* WTAP_ENCAP_NETANALYZER */
+       { "netANALYZER", "netanalyzer" },
+
+       /* WTAP_ENCAP_NETANALYZER_TRANSPARENT */
+       { "netANALYZER-Transparent", "netanalyzer-transparent" },
+
+       /* WTAP_ENCAP_IP_OVER_IB */
+       { "IP over Infiniband", "ip-over-ib" },
+
+       /* WTAP_ENCAP_MPEG_2_TS */
+       { "ISO/IEC 13818-1 MPEG2-TS", "mp2ts" },
+
+       /* WTAP_ENCAP_PPP_ETHER */
+       { "PPP-over-Ethernet session", "pppoes" },
+
+       /* WTAP_ENCAP_NFC_LLCP */
+       { "NFC LLCP", "nfc-llcp" },
+
+       /* WTAP_ENCAP_NFLOG */
+       { "NFLOG", "nflog" },
+
+       /* WTAP_ENCAP_V5_EF */
+       { "V5 Envelope Function", "v5-ef" },
+
+       /* WTAP_ENCAP_BACNET_MS_TP_WITH_PHDR */
+       { "BACnet MS/TP with Directional Info", "bacnet-ms-tp-with-direction" },
+       /* WTAP_ENCAP_IXVERIWAVE */
+       { "IxVeriWave header and stats block", "ixveriwave" },
+
+       /* WTAP_ENCAP_IEEE_802_11_AIROPEEK */
+       { "IEEE 802.11 plus AiroPeek radio header", "ieee-802-11-airopeek" },
+
+       /* WTAP_ENCAP_SDH */
+       { "SDH", "sdh" },
+
+       /* WTAP_ENCAP_DBUS */
+       { "D-Bus", "dbus" },
+
+       /* WTAP_ENCAP_AX25_KISS */
+       { "AX.25 with KISS header", "ax25-kiss" },
+
+       /* WTAP_ENCAP_AX25 */
+       { "Amateur Radio AX.25", "ax25" },
+
+       /* WTAP_ENCAP_SCTP */
+       { "SCTP", "sctp" },
 
+       /* WTAP_ENCAP_INFINIBAND */
+       { "InfiniBand", "infiniband" },
+
+       /* WTAP_ENCAP_JUNIPER_SVCS */
+       { "Juniper Services", "juniper-svcs" },
+
+       /* WTAP_ENCAP_USBPCAP */
+       { "USB packets with USBPcap header", "usb-usbpcap" },
+
+       /* WTAP_ENCAP_RTAC_SERIAL */
+       { "RTAC serial-line", "rtac-serial" },
+
+       /* WTAP_ENCAP_BLUETOOTH_LE_LL */
+       { "Bluetooth Low Energy Link Layer", "bluetooth-le-ll" },
+
+       /* WTAP_ENCAP_WIRESHARK_UPPER_PDU */
+       { "Wireshark Upper PDU export", "wireshark-upper-pdu" },
 };
 
+WS_DLL_LOCAL
 gint wtap_num_encap_types = sizeof(encap_table_base) / sizeof(struct encap_type_info);
 static GArray* encap_table_arr = NULL;
-static const struct encap_type_info* encap_table = NULL;
+
+#define encap_table_entry(encap)       \
+       g_array_index(encap_table_arr, struct encap_type_info, encap)
 
 static void wtap_init_encap_types(void) {
 
@@ -472,8 +633,6 @@ static void wtap_init_encap_types(void) {
        encap_table_arr = g_array_new(FALSE,TRUE,sizeof(struct encap_type_info));
 
        g_array_append_vals(encap_table_arr,encap_table_base,wtap_num_encap_types);
-
-       encap_table = (void*)encap_table_arr->data;
 }
 
 int wtap_get_num_encap_types(void) {
@@ -482,7 +641,7 @@ int wtap_get_num_encap_types(void) {
 }
 
 
-int wtap_register_encap_type(char* name, char* short_name) {
+int wtap_register_encap_type(const char* name, const char* short_name) {
        struct encap_type_info e;
        wtap_init_encap_types();
 
@@ -491,34 +650,32 @@ int wtap_register_encap_type(char* name, char* short_name) {
 
        g_array_append_val(encap_table_arr,e);
 
-       encap_table = (void*)encap_table_arr->data;
-
        return wtap_num_encap_types++;
 }
 
 
 /* Name that should be somewhat descriptive. */
-const char
-*wtap_encap_string(int encap)
+const char *
+wtap_encap_string(int encap)
 {
        if (encap < WTAP_ENCAP_PER_PACKET || encap >= WTAP_NUM_ENCAP_TYPES)
                return "Illegal";
        else if (encap == WTAP_ENCAP_PER_PACKET)
                return "Per packet";
        else
-               return encap_table[encap].name;
+               return encap_table_entry(encap).name;
 }
 
 /* Name to use in, say, a command-line flag specifying the type. */
-const char
-*wtap_encap_short_string(int encap)
+const char *
+wtap_encap_short_string(int encap)
 {
        if (encap < WTAP_ENCAP_PER_PACKET || encap >= WTAP_NUM_ENCAP_TYPES)
                return "illegal";
        else if (encap == WTAP_ENCAP_PER_PACKET)
                return "per-packet";
        else
-               return encap_table[encap].short_name;
+               return encap_table_entry(encap).short_name;
 }
 
 /* Translate a short name to a capture file type. */
@@ -528,8 +685,8 @@ wtap_short_string_to_encap(const char *short_name)
        int encap;
 
        for (encap = 0; encap < WTAP_NUM_ENCAP_TYPES; encap++) {
-               if (encap_table[encap].short_name != NULL &&
-                   strcmp(short_name, encap_table[encap].short_name) == 0)
+               if (encap_table_entry(encap).short_name != NULL &&
+                   strcmp(short_name, encap_table_entry(encap).short_name) == 0)
                        return encap;
        }
        return -1;      /* no such encapsulation type */
@@ -548,30 +705,27 @@ static const char *wtap_errlist[] = {
        NULL,
        NULL,
        "Less data was read than was expected",
-       "File contains a record that's not valid",
+       "The file appears to be damaged or corrupt.",
        "Less data was written than was requested",
        "Uncompression error: data oddly truncated",
        "Uncompression error: data would overflow buffer",
        "Uncompression error: bad LZ77 offset",
-       "The standard input cannot be opened for random access"
+       "The standard input cannot be opened for random access",
+       "That file format doesn't support compression",
+       NULL,
+       NULL,
+       "Uncompression error",
+       "Internal error"
 };
 #define        WTAP_ERRLIST_SIZE       (sizeof wtap_errlist / sizeof wtap_errlist[0])
 
-const char
-*wtap_strerror(int err)
+const char *
+wtap_strerror(int err)
 {
        static char errbuf[128];
        unsigned int wtap_errlist_index;
 
        if (err < 0) {
-#ifdef HAVE_LIBZ
-               if (err >= WTAP_ERR_ZLIB_MIN && err <= WTAP_ERR_ZLIB_MAX) {
-                       /* Assume it's a zlib error. */
-                       g_snprintf(errbuf, 128, "Uncompression error: %s",
-                           zError(err - WTAP_ERR_ZLIB));
-                       return errbuf;
-               }
-#endif
                wtap_errlist_index = -1 - err;
                if (wtap_errlist_index >= WTAP_ERRLIST_SIZE) {
                        g_snprintf(errbuf, 128, "Error %d", err);
@@ -581,7 +735,7 @@ const char
                        return "Unknown reason";
                return wtap_errlist[wtap_errlist_index];
        } else
-               return strerror(err);
+               return g_strerror(err);
 }
 
 /* Close only the sequential side, freeing up memory it uses.
@@ -610,9 +764,34 @@ wtap_sequential_close(wtap *wth)
        }
 }
 
+static void
+g_fast_seek_item_free(gpointer data, gpointer user_data _U_)
+{
+       g_free(data);
+}
+
+/*
+ * Close the file descriptors for the sequential and random streams, but
+ * don't discard any information about those streams.  Used on Windows if
+ * we need to rename a file that we have open or if we need to rename on
+ * top of a file we have open.
+ */
+void
+wtap_fdclose(wtap *wth)
+{
+       if (wth->fh != NULL)
+               file_fdclose(wth->fh);
+       if (wth->random_fh != NULL)
+               file_fdclose(wth->random_fh);
+}
+
 void
 wtap_close(wtap *wth)
 {
+       gint i, j;
+       wtapng_if_descr_t *wtapng_if_descr;
+       wtapng_if_stats_t *if_stats;
+
        wtap_sequential_close(wth);
 
        if (wth->subtype_close != NULL)
@@ -621,9 +800,65 @@ wtap_close(wtap *wth)
        if (wth->random_fh != NULL)
                file_close(wth->random_fh);
 
+       if (wth->priv != NULL)
+               g_free(wth->priv);
+
+       if (wth->fast_seek != NULL) {
+               g_ptr_array_foreach(wth->fast_seek, g_fast_seek_item_free, NULL);
+               g_ptr_array_free(wth->fast_seek, TRUE);
+       }
+       for(i = 0; i < (gint)wth->number_of_interfaces; i++) {
+               wtapng_if_descr = &g_array_index(wth->interface_data, wtapng_if_descr_t, i);
+               if(wtapng_if_descr->opt_comment != NULL){
+                       g_free(wtapng_if_descr->opt_comment);
+               }
+               if(wtapng_if_descr->if_name != NULL){
+                       g_free(wtapng_if_descr->if_name);
+               }
+               if(wtapng_if_descr->if_description != NULL){
+                       g_free(wtapng_if_descr->if_description);
+               }
+               if(wtapng_if_descr->if_filter_str != NULL){
+                       g_free(wtapng_if_descr->if_filter_str);
+               }
+               if(wtapng_if_descr->if_filter_bpf_bytes != NULL){
+                       g_free(wtapng_if_descr->if_filter_bpf_bytes);
+               }
+               if(wtapng_if_descr->if_os != NULL){
+                       g_free(wtapng_if_descr->if_os);
+               }
+               for(j = 0; j < (gint)wtapng_if_descr->num_stat_entries; j++) {
+                       if_stats = &g_array_index(wtapng_if_descr->interface_statistics, wtapng_if_stats_t, j);
+                       if(if_stats->opt_comment != NULL){
+                               g_free(if_stats->opt_comment);
+                       }
+               }
+               if(wtapng_if_descr->num_stat_entries != 0){
+                        g_array_free(wtapng_if_descr->interface_statistics, TRUE);
+               }
+       }
+       if(wth->number_of_interfaces != 0){
+                g_array_free(wth->interface_data, TRUE);
+       }
        g_free(wth);
 }
 
+void
+wtap_cleareof(wtap *wth) {
+       /* Reset EOF */
+       file_clearerr(wth->fh);
+}
+
+void wtap_set_cb_new_ipv4(wtap *wth, wtap_new_ipv4_callback_t add_new_ipv4) {
+       if (wth)
+               wth->add_new_ipv4 = add_new_ipv4;
+}
+
+void wtap_set_cb_new_ipv6(wtap *wth, wtap_new_ipv6_callback_t add_new_ipv6) {
+       if (wth)
+               wth->add_new_ipv6 = add_new_ipv6;
+}
+
 gboolean
 wtap_read(wtap *wth, int *err, gchar **err_info, gint64 *data_offset)
 {
@@ -637,8 +872,20 @@ wtap_read(wtap *wth, int *err, gchar **err_info, gint64 *data_offset)
         */
        wth->phdr.pkt_encap = wth->file_encap;
 
-       if (!wth->subtype_read(wth, err, err_info, data_offset))
+       if (!wth->subtype_read(wth, err, err_info, data_offset)) {
+               /*
+                * If we didn't get an error indication, we read
+                * the last packet.  See if there's any deferred
+                * error, as might, for example, occur if we're
+                * reading a compressed file, and we got an error
+                * reading compressed data from the file, but
+                * got enough compressed data to decompress the
+                * last packet of the file.
+                */
+               if (*err == 0)
+                       *err = file_error(wth->fh, err_info);
                return FALSE;   /* failure */
+       }
 
        /*
         * It makes no sense for the captured data length to be bigger
@@ -659,36 +906,50 @@ wtap_read(wtap *wth, int *err, gchar **err_info, gint64 *data_offset)
 }
 
 /*
- * Return an approximation of the amount of data we've read sequentially
- * from the file so far.  (gint64, in case that's 64 bits.)
+ * Read packet data into a Buffer, growing the buffer as necessary.
+ *
+ * This returns an error on a short read, even if the short read hit
+ * the EOF immediately.  (The assumption is that each packet has a
+ * header followed by raw packet data, and that we've already read the
+ * header, so if we get an EOF trying to read the packet data, the file
+ * has been cut short, even if the read didn't read any data at all.)
  */
-gint64
-wtap_read_so_far(wtap *wth, int *err)
+gboolean
+wtap_read_packet_bytes(FILE_T fh, Buffer *buf, guint length, int *err,
+    gchar **err_info)
 {
-       off_t file_pos;
+       int     bytes_read;
 
-       file_pos = ws_lseek(wth->fd, 0, SEEK_CUR);
-       if (file_pos == -1) {
-               if (err != NULL)
-                       *err = errno;
-               return -1;
+       buffer_assure_space(buf, length);
+       errno = WTAP_ERR_CANT_READ;
+       bytes_read = file_read(buffer_start_ptr(buf), length, fh);
+
+       if (bytes_read < 0 || (guint)bytes_read != length) {
+               *err = file_error(fh, err_info);
+               if (*err == 0)
+                       *err = WTAP_ERR_SHORT_READ;
+               return FALSE;
        }
-       return file_pos;
+       return TRUE;
 }
 
-struct wtap_pkthdr*
-wtap_phdr(wtap *wth)
+/*
+ * Return an approximation of the amount of data we've read sequentially
+ * from the file so far.  (gint64, in case that's 64 bits.)
+ */
+gint64
+wtap_read_so_far(wtap *wth)
 {
-       return &wth->phdr;
+       return file_tell_raw(wth->fh);
 }
 
-union wtap_pseudo_header*
-wtap_pseudoheader(wtap *wth)
+struct wtap_pkthdr *
+wtap_phdr(wtap *wth)
 {
-       return &wth->pseudo_header;
+       return &wth->phdr;
 }
 
-guint8*
+guint8 *
 wtap_buf_ptr(wtap *wth)
 {
        return buffer_start_ptr(wth->frame_buffer);
@@ -696,9 +957,9 @@ wtap_buf_ptr(wtap *wth)
 
 gboolean
 wtap_seek_read(wtap *wth, gint64 seek_off,
-       union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
+       struct wtap_pkthdr *phdr, Buffer *buf, int len,
        int *err, gchar **err_info)
 {
-       return wth->subtype_seek_read(wth, seek_off, pseudo_header, pd, len,
+       return wth->subtype_seek_read(wth, seek_off, phdr, buf, len,
                err, err_info);
 }