Make it possible to edit capture comments
[obnox/wireshark/wip.git] / wiretap / wtap.c
index dda21fde40605cd367c7af0955cd99e34d1027c1..7a6ee5ca48c5072b41883f5bc7bbf21b88034701 100644 (file)
@@ -17,7 +17,7 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */
 
 #ifdef HAVE_CONFIG_H
 #include <string.h>
 #include <errno.h>
 
+#ifdef HAVE_SYS_TYPES_H
+#include <sys/types.h>
+#endif
+
+#ifdef HAVE_UNISTD_H
+#include <unistd.h>
+#endif
+
+#ifdef HAVE_LIBZ
+#include <zlib.h>
+#endif
+
 #include "wtap-int.h"
+
 #include "file_wrappers.h"
+#include <wsutil/file_util.h>
 #include "buffer.h"
 
+/*
+ * Return the size of the file, as reported by the OS.
+ * (gint64, in case that's 64 bits.)
+ */
+gint64
+wtap_file_size(wtap *wth, int *err)
+{
+       ws_statb64 statb;
+
+       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_fd(wtap *wth)
+wtap_fstat(wtap *wth, ws_statb64 *statb, int *err)
 {
-       return wth->fd;
+       if (file_fstat((wth->fh == NULL) ? wth->random_fh : wth->fh,
+           statb, err) == -1)
+               return -1;
+       return 0;
 }
 
 int
@@ -43,7 +78,7 @@ wtap_file_type(wtap *wth)
        return wth->file_type;
 }
 
-int
+guint
 wtap_snapshot_length(wtap *wth)
 {
        return wth->snapshot_length;
@@ -55,13 +90,56 @@ wtap_file_encap(wtap *wth)
        return wth->file_encap;
 }
 
+int
+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" },
@@ -129,8 +207,8 @@ static const struct encap_type_info {
        /* 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_BSD */
-       { "IEEE 802.11 plus BSD WLAN header", "ieee-802-11-bsd" },
+       /* WTAP_ENCAP_IEEE_802_11_WLAN_RADIOTAP */
+       { "IEEE 802.11 plus radiotap WLAN header", "ieee-802-11-radiotap" },
 
        /* WTAP_ENCAP_IEEE_802_11_WLAN_AVS */
        { "IEEE 802.11 plus AVS WLAN header", "ieee-802-11-avs" },
@@ -251,14 +329,277 @@ static const struct encap_type_info {
 
        /* WTAP_ENCAP_BACNET_MS_TP */
        { "BACnet MS/TP", "bacnet-ms-tp" },
+
+       /* WTAP_ENCAP_NETTL_RAW_ICMP */
+       { "Raw ICMP with nettl headers", "raw-icmp-nettl" },
+
+       /* WTAP_ENCAP_NETTL_RAW_ICMPV6 */
+       { "Raw ICMPv6 with nettl headers", "raw-icmpv6-nettl" },
+
+       /* WTAP_ENCAP_GPRS_LLC */
+       { "GPRS LLC", "gprs-llc" },
+
+       /* WTAP_ENCAP_JUNIPER_ATM1 */
+       { "Juniper ATM1", "juniper-atm1" },
+
+       /* WTAP_ENCAP_JUNIPER_ATM2 */
+       { "Juniper ATM2", "juniper-atm2" },
+
+       /* WTAP_ENCAP_REDBACK */
+       { "Redback SmartEdge", "redback" },
+
+       /* WTAP_ENCAP_NETTL_RAW_IP */
+       { "Raw IP with nettl headers", "rawip-nettl" },
+
+       /* WTAP_ENCAP_NETTL_ETHERNET */
+       { "Ethernet with nettl headers", "ether-nettl" },
+
+       /* WTAP_ENCAP_NETTL_TOKEN_RING */
+       { "Token Ring with nettl headers", "tr-nettl" },
+
+       /* WTAP_ENCAP_NETTL_FDDI */
+       { "FDDI with nettl headers", "fddi-nettl" },
+
+       /* WTAP_ENCAP_NETTL_UNKNOWN */
+       { "Unknown link-layer type with nettl headers", "unknown-nettl" },
+
+       /* WTAP_ENCAP_MTP2_WITH_PHDR */
+       { "MTP2 with pseudoheader", "mtp2-with-phdr" },
+
+       /* WTAP_ENCAP_JUNIPER_PPPOE */
+       { "Juniper PPPoE", "juniper-pppoe" },
+
+       /* WTAP_ENCAP_GCOM_TIE1 */
+       { "GCOM TIE1", "gcom-tie1" },
+
+       /* WTAP_ENCAP_GCOM_SERIAL */
+       { "GCOM Serial", "gcom-serial" },
+
+       /* WTAP_ENCAP_NETTL_X25 */
+       { "X25 with nettl headers", "x25-nettl" },
+
+       /* WTAP_ENCAP_K12 */
+       { "K12 protocol analyzer", "k12" },
+
+       /* WTAP_ENCAP_JUNIPER_MLPPP */
+       { "Juniper MLPPP", "juniper-mlppp" },
+
+       /* WTAP_ENCAP_JUNIPER_MLFR */
+       { "Juniper MLFR", "juniper-mlfr" },
+
+       /* WTAP_ENCAP_JUNIPER_ETHER */
+       { "Juniper Ethernet", "juniper-ether" },
+
+       /* WTAP_ENCAP_JUNIPER_PPP */
+       { "Juniper PPP", "juniper-ppp" },
+
+       /* WTAP_ENCAP_JUNIPER_FRELAY */
+       { "Juniper Frame-Relay", "juniper-frelay" },
+
+       /* 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_CATAPULT_DCT2000 */
+       { "Catapult DCT2000", "dct2000" },
+
+       /* WTAP_ENCAP_BER */
+       { "ASN.1 Basic Encoding Rules", "ber" },
+
+       /* WTAP_ENCAP_JUNIPER_VP */
+       { "Juniper Voice PIC", "juniper-vp" },
+
+       /* WTAP_ENCAP_USB */
+       { "Raw USB packets", "usb" },
+
+       /* WTAP_ENCAP_IEEE802_16_MAC_CPS */
+       { "IEEE 802.16 MAC Common Part Sublayer", "ieee-802-16-mac-cps" },
+
+       /* 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;
 }
@@ -267,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;
 }
@@ -300,11 +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",
+       "That file format doesn't support compression",
+       NULL,
+       "Uncompression error",
+       "Internal error"
 };
 #define        WTAP_ERRLIST_SIZE       (sizeof wtap_errlist / sizeof wtap_errlist[0])
 
@@ -315,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.
@@ -361,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)
 {
@@ -372,11 +718,34 @@ 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, long *data_offset)
+wtap_read(wtap *wth, int *err, gchar **err_info, gint64 *data_offset)
 {
        /*
         * Set the packet encapsulation to the file's encapsulation
@@ -388,8 +757,20 @@ wtap_read(wtap *wth, int *err, gchar **err_info, long *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
@@ -409,6 +790,16 @@ wtap_read(wtap *wth, int *err, gchar **err_info, long *data_offset)
        return TRUE;    /* success */
 }
 
+/*
+ * 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 file_tell_raw(wth->fh);
+}
+
 struct wtap_pkthdr*
 wtap_phdr(wtap *wth)
 {
@@ -428,30 +819,7 @@ wtap_buf_ptr(wtap *wth)
 }
 
 gboolean
-wtap_loop(wtap *wth, int count, wtap_handler callback, guchar* user, int *err,
-    gchar **err_info)
-{
-       long            data_offset;
-       int             loop = 0;
-
-       /* Start by clearing error flag */
-       *err = 0;
-
-       while ( (wtap_read(wth, err, err_info, &data_offset)) ) {
-               callback(user, &wth->phdr, data_offset,
-                   &wth->pseudo_header, buffer_start_ptr(wth->frame_buffer));
-               if (count > 0 && ++loop >= count)
-                       break;
-       }
-
-       if (*err == 0)
-               return TRUE;    /* success */
-       else
-               return FALSE;   /* failure */
-}
-
-gboolean
-wtap_seek_read(wtap *wth, long seek_off,
+wtap_seek_read(wtap *wth, gint64 seek_off,
        union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
        int *err, gchar **err_info)
 {