Make it possible to edit capture comments
[obnox/wireshark/wip.git] / wiretap / wtap.c
index 206d9e77e9d36e735bb35c86499ad8da2cd769e8..7a6ee5ca48c5072b41883f5bc7bbf21b88034701 100644 (file)
 #include <unistd.h>
 #endif
 
+#ifdef HAVE_LIBZ
+#include <zlib.h>
+#endif
+
 #include "wtap-int.h"
-#include "wtap.h"
 
 #include "file_wrappers.h"
-#include "file_util.h"
+#include <wsutil/file_util.h>
 #include "buffer.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_fstat(wtap *wth, ws_statb64 *statb, int *err)
+{
+       if (file_fstat((wth->fh == NULL) ? wth->random_fh : wth->fh,
+           statb, err) == -1)
+               return -1;
+       return 0;
+}
+
 int
 wtap_file_type(wtap *wth)
 {
        return wth->file_type;
 }
 
-int
+guint
 wtap_snapshot_length(wtap *wth)
 {
        return wth->snapshot_length;
@@ -83,13 +96,50 @@ wtap_file_tsprecision(wtap *wth)
        return wth->tsprecision;
 }
 
+wtapng_section_t* wtap_file_get_shb_info(wtap *wth)
+{
+       wtapng_section_t                *shb_hdr;
+
+       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. */
-static const struct encap_type_info {
+struct encap_type_info {
        const char *name;
        const char *short_name;
-} encap_table[WTAP_NUM_ENCAP_TYPES] = {
+};
+
+static struct encap_type_info encap_table_base[] = {
        /* WTAP_ENCAP_UNKNOWN */
-       { "Unknown", NULL },
+       { "Unknown", "unknown" },
 
        /* WTAP_ENCAP_ETHERNET */
        { "Ethernet", "ether" },
@@ -348,12 +398,12 @@ static const struct encap_type_info {
 
        /* WTAP_ENCAP_JUNIPER_CHDLC */
        { "Juniper C-HDLC", "juniper-chdlc" },
-    
+
        /* WTAP_ENCAP_JUNIPER_GGSN */
        { "Juniper GGSN", "juniper-ggsn" },
 
-       /* WTAP_ENCAP_LINUX_LAPD */
-       { "LAPD", "lapd" },
+       /* WTAP_ENCAP_LINUX_LAPD */
+       { "LAPD", "lapd" },
 
        /* WTAP_ENCAP_CATAPULT_DCT2000 */
        { "Catapult DCT2000", "dct2000" },
@@ -373,16 +423,183 @@ static const struct encap_type_info {
        /* WTAP_ENCAP_NETTL_RAW_TELNET */
        { "Raw telnet with nettl headers", "raw-telnet-nettl" },
 
+       /* WTAP_ENCAP_USB_LINUX */
+       { "USB packets with Linux header", "usb-linux" },
+
        /* WTAP_ENCAP_MPEG */
        { "MPEG", "mpeg" },
+
+       /* WTAP_ENCAP_PPI */
+       { "Per-Packet Information header", "ppi" },
+
+       /* WTAP_ENCAP_ERF */
+       { "Endace Record File", "erf" },
+
+       /* WTAP_ENCAP_BLUETOOTH_H4_WITH_PHDR */
+       { "Bluetooth H4 with linux header", "bluetooth-h4-linux" },
+
+       /* WTAP_ENCAP_SITA */
+       { "SITA WAN packets", "sita-wan" },
+
+       /* WTAP_ENCAP_SCCP */
+       { "SS7 SCCP", "sccp" },
+
+       /* WTAP_ENCAP_BLUETOOTH_HCI */
+       { "Bluetooth without transport layer", "bluetooth-hci" },
+
+       /* WTAP_ENCAP_IPMB */
+       { "Intelligent Platform Management Bus", "ipmb" },
+
+       /* WTAP_ENCAP_IEEE802_15_4 */
+       { "IEEE 802.15.4 Wireless PAN", "wpan" },
+
+       /* WTAP_ENCAP_X2E_XORAYA */
+       { "X2E Xoraya", "x2e-xoraya" },
+
+       /* WTAP_ENCAP_FLEXRAY */
+       { "FlexRay", "flexray" },
+
+       /* WTAP_ENCAP_LIN */
+       { "Local Interconnect Network", "lin" },
+
+       /* WTAP_ENCAP_MOST */
+       { "Media Oriented Systems Transport", "most" },
+
+       /* WTAP_ENCAP_CAN20B */
+       { "Controller Area Network 2.0B", "can20b" },
+
+       /* WTAP_ENCAP_LAYER1_EVENT */
+       { "EyeSDN Layer 1 event", "layer1-event" },
+
+       /* WTAP_ENCAP_X2E_SERIAL */
+       { "X2E serial line capture", "x2e-serial" },
+
+       /* WTAP_ENCAP_I2C */
+       { "I2C", "i2c" },
+
+       /* WTAP_ENCAP_IEEE802_15_4_NONASK_PHY */
+       { "IEEE 802.15.4 Wireless PAN non-ASK PHY", "wpan-nonask-phy" },
+
+       /* WTAP_ENCAP_TNEF */
+       { "Transport-Neutral Encapsulation Format", "tnef" },
+
+       /* 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" },
+
+       /* WTAP_ENCAP_NSTRACE_2_0 */
+       { "NetScaler Encapsulation 2.0 of Ethernet", "nstrace20" },
+
+       /* WTAP_ENCAP_FIBRE_CHANNEL_FC2 */
+       { "Fibre Channel FC-2", "fc2" },
+
+       /* WTAP_ENCAP_FIBRE_CHANNEL_FC2_WITH_FRAME_DELIMS */
+       { "Fibre Channel FC-2 With Frame Delimiter", "fc2sof"},
+
+       /* WTAP_ENCAP_JPEG_JFIF */
+       { "JPEG/JFIF", "jfif" },
+
+       /* WTAP_ENCAP_IPNET */
+       { "Solaris IPNET", "ipnet" },
+
+       /* WTAP_ENCAP_SOCKETCAN */
+       { "SocketCAN", "socketcan" },
+
+       /* WTAP_ENCAP_IEEE802_11_NETMON_RADIO */
+       { "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 header", "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" }
 };
 
+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;
+
+static void wtap_init_encap_types(void) {
+
+       if (encap_table_arr) return;
+
+       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) {
+       wtap_init_encap_types();
+       return wtap_num_encap_types;
+}
+
+
+int wtap_register_encap_type(char* name, char* short_name) {
+       struct encap_type_info e;
+       wtap_init_encap_types();
+
+       e.name = g_strdup(name);
+       e.short_name = g_strdup(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)
 {
-       if (encap < 0 || encap >= WTAP_NUM_ENCAP_TYPES)
-               return NULL;
+       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;
 }
@@ -391,8 +608,10 @@ const char
 const char
 *wtap_encap_short_string(int encap)
 {
-       if (encap < 0 || encap >= WTAP_NUM_ENCAP_TYPES)
-               return NULL;
+       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;
 }
@@ -424,12 +643,16 @@ 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,
+       "Uncompression error",
+       "Internal error"
 };
 #define        WTAP_ERRLIST_SIZE       (sizeof wtap_errlist / sizeof wtap_errlist[0])
 
@@ -440,24 +663,16 @@ const char
        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. */
-                       sprintf(errbuf, "Uncompression error: %s",
-                           zError(err - WTAP_ERR_ZLIB));
-                       return errbuf;
-               }
-#endif
                wtap_errlist_index = -1 - err;
                if (wtap_errlist_index >= WTAP_ERRLIST_SIZE) {
-                       sprintf(errbuf, "Error %d", err);
+                       g_snprintf(errbuf, 128, "Error %d", err);
                        return errbuf;
                }
                if (wtap_errlist[wtap_errlist_index] == NULL)
                        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.
@@ -486,6 +701,12 @@ wtap_sequential_close(wtap *wth)
        }
 }
 
+static void
+g_fast_seek_item_free(gpointer data, gpointer user_data _U_)
+{
+       g_free(data);
+}
+
 void
 wtap_close(wtap *wth)
 {
@@ -497,9 +718,32 @@ 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);
+       }
        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)
 {
@@ -513,8 +757,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
@@ -539,17 +795,9 @@ wtap_read(wtap *wth, int *err, gchar **err_info, gint64 *data_offset)
  * from the file so far.  (gint64, in case that's 64 bits.)
  */
 gint64
-wtap_read_so_far(wtap *wth, int *err)
+wtap_read_so_far(wtap *wth)
 {
-       off_t file_pos;
-
-       file_pos = eth_lseek(wth->fd, 0, SEEK_CUR);
-       if (file_pos == -1) {
-               if (err != NULL)
-                       *err = errno;
-               return -1;
-       }
-       return file_pos;
+       return file_tell_raw(wth->fh);
 }
 
 struct wtap_pkthdr*