From yami:
[obnox/wireshark/wip.git] / wiretap / wtap.c
index 7e26cf326cb2473f669ba2a89ba6ddf4ea339400..e31e58bbe283cd7b8235caf6486a591e0e353ef1 100644 (file)
@@ -1,39 +1,62 @@
 /* wtap.c
  *
- * $Id: wtap.c,v 1.68 2002/07/29 06:09:59 guy Exp $
+ * $Id$
  *
  * Wiretap Library
  * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
- * 
+ *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation; either version 2
  * of the License, or (at your option) any later version.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- * 
+ *
  * 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 "config.h"
+#endif
+
 #include <string.h>
 #include <errno.h>
 
-#ifdef HAVE_CONFIG_H
-#include "config.h"
+#ifdef HAVE_SYS_TYPES_H
+#include <sys/types.h>
+#endif
+
+#ifdef HAVE_UNISTD_H
+#include <unistd.h>
 #endif
+
 #include "wtap-int.h"
+#include "wtap.h"
+
 #include "file_wrappers.h"
+#include <wsutil/file_util.h>
 #include "buffer.h"
 
-int
-wtap_fd(wtap *wth)
+/*
+ * 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)
 {
-       return wth->fd;
+       struct stat statb;
+
+       if (fstat(wth->fd, &statb) == -1) {
+               if (err != NULL)
+                       *err = errno;
+               return -1;
+       }
+       return statb.st_size;
 }
 
 int
@@ -54,18 +77,26 @@ wtap_file_encap(wtap *wth)
        return wth->file_encap;
 }
 
+int
+wtap_file_tsprecision(wtap *wth)
+{
+       return wth->tsprecision;
+}
+
 /* 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 },
 
        /* WTAP_ENCAP_ETHERNET */
        { "Ethernet", "ether" },
 
-       /* WTAP_ENCAP_TR */
+       /* WTAP_ENCAP_TOKEN_RING */
        { "Token Ring", "tr" },
 
        /* WTAP_ENCAP_SLIP */
@@ -86,6 +117,9 @@ static const struct encap_type_info {
        /* WTAP_ENCAP_ARCNET */
        { "ARCNET", "arcnet" },
 
+       /* WTAP_ENCAP_ARCNET_LINUX */
+       { "Linux ARCNET", "arcnet_linux" },
+
        /* WTAP_ENCAP_ATM_RFC1483 */
        { "RFC 1483 ATM", "atm-rfc1483" },
 
@@ -95,8 +129,11 @@ static const struct encap_type_info {
        /* WTAP_ENCAP_LAPB */
        { "LAPB", "lapb" },
 
-       /* WTAP_ENCAP_ATM_SNIFFER */
-       { "ATM Sniffer", "atm-sniffer" },
+       /* WTAP_ENCAP_ATM_PDUS */
+       { "ATM PDUs", "atm-pdus" },
+
+       /* WTAP_ENCAP_ATM_PDUS_UNTRUNCATED */
+       { "ATM PDUs - untruncated", "atm-pdus-untruncated" },
 
        /* WTAP_ENCAP_NULL */
        { "NULL", "null" },
@@ -104,11 +141,11 @@ static const struct encap_type_info {
        /* WTAP_ENCAP_ASCEND */
        { "Lucent/Ascend access equipment", "ascend" },
 
-       /* WTAP_ENCAP_LAPD */
-       { "LAPD", "lapd" },
+       /* WTAP_ENCAP_ISDN */
+       { "ISDN", "isdn" },
 
-       /* WTAP_ENCAP_V120 */
-       { "V.120", "v120" },
+       /* WTAP_ENCAP_IP_OVER_FC */
+       { "RFC 2625 IP-over-Fibre Channel", "ip-over-fc" },
 
        /* WTAP_ENCAP_PPP_WITH_PHDR */
        { "PPP with Directional Info", "ppp-with-direction" },
@@ -116,15 +153,27 @@ static const struct encap_type_info {
        /* 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_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_WLAN_AVS */
+       { "IEEE 802.11 plus AVS WLAN header", "ieee-802-11-avs" },
+
        /* WTAP_ENCAP_SLL */
        { "Linux cooked-mode capture", "linux-sll" },
 
        /* WTAP_ENCAP_FRELAY */
        { "Frame Relay", "frelay" },
 
+       /* WTAP_ENCAP_FRELAY_WITH_PHDR */
+       { "Frame Relay with Directional Info", "frelay-with-direction" },
+
        /* WTAP_ENCAP_CHDLC */
        { "Cisco HDLC", "chdlc" },
 
@@ -134,16 +183,292 @@ static const struct encap_type_info {
        /* WTAP_ENCAP_LOCALTALK */
        { "Localtalk", "ltalk" },
 
-       /* WTAP_ENCAP_PRISM_HEADER */
-       { "IEEE 802.11 plus Prism II monitor mode header", "prism" },
+       /* WTAP_ENCAP_OLD_PFLOG  */
+       { "OpenBSD PF Firewall logs, pre-3.4", "pflog-old" },
+
+       /* WTAP_ENCAP_HHDLC */
+       { "HiPath HDLC", "hhdlc" },
+
+       /* WTAP_ENCAP_DOCSIS */
+       { "Data Over Cable Service Interface Specification", "docsis" },
+
+       /* WTAP_ENCAP_COSINE */
+       { "CoSine L2 debug log", "cosine" },
+
+       /* WTAP_ENCAP_WFLEET_HDLC */
+       { "Wellfleet HDLC", "whdlc" },
+
+       /* WTAP_ENCAP_SDLC */
+       { "SDLC", "sdlc" },
+
+       /* WTAP_ENCAP_TZSP */
+       { "Tazmen sniffer protocol", "tzsp" },
+
+       /* WTAP_ENCAP_ENC */
+       { "OpenBSD enc(4) encapsulating interface", "enc" },
 
        /* WTAP_ENCAP_PFLOG  */
        { "OpenBSD PF Firewall logs", "pflog" },
 
-       /* WTAP_ENCAP_HHDLC */
-       { "HiPath HDLC", "hhdlc" },
+       /* WTAP_ENCAP_CHDLC_WITH_PHDR */
+       { "Cisco HDLC with Directional Info", "chdlc-with-direction" },
+
+       /* WTAP_ENCAP_BLUETOOTH_H4 */
+       { "Bluetooth H4", "bluetooth-h4" },
+
+       /* WTAP_ENCAP_MTP2 */
+       { "SS7 MTP2", "mtp2" },
+
+       /* WTAP_ENCAP_MTP3 */
+       { "SS7 MTP3", "mtp3" },
+
+       /* WTAP_ENCAP_IRDA */
+       { "IrDA", "irda" },
+
+       /* WTAP_ENCAP_USER0 */
+       { "USER 0", "user0" },
+
+       /* WTAP_ENCAP_USER1 */
+       { "USER 1", "user1" },
+
+       /* WTAP_ENCAP_USER2 */
+       { "USER 2", "user2" },
+
+       /* WTAP_ENCAP_USER3 */
+       { "USER 3", "user3" },
+
+       /* WTAP_ENCAP_USER4 */
+       { "USER 4", "user4" },
+
+       /* WTAP_ENCAP_USER5 */
+       { "USER 5", "user5" },
+
+       /* WTAP_ENCAP_USER6 */
+       { "USER 6", "user6" },
+
+       /* WTAP_ENCAP_USER7 */
+       { "USER 7", "user7" },
+
+       /* WTAP_ENCAP_USER8 */
+       { "USER 8", "user8" },
+
+       /* WTAP_ENCAP_USER9 */
+       { "USER 9", "user9" },
+
+       /* WTAP_ENCAP_USER10 */
+       { "USER 10", "user10" },
+
+       /* WTAP_ENCAP_USER11 */
+       { "USER 11", "user11" },
+
+       /* WTAP_ENCAP_USER12 */
+       { "USER 12", "user12" },
+
+       /* WTAP_ENCAP_USER13 */
+       { "USER 13", "user13" },
+
+       /* WTAP_ENCAP_USER14 */
+       { "USER 14", "user14" },
+
+       /* WTAP_ENCAP_USER15 */
+       { "USER 15", "user15" },
+
+       /* WTAP_ENCAP_SYMANTEC */
+       { "Symantec Enterprise Firewall", "symantec" },
+
+       /* WTAP_ENCAP_APPLE_IP_OVER_IEEE1394 */
+       { "Apple IP-over-IEEE 1394", "ap1394" },
+
+       /* 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_BT_H4 */
+       { "Bluetooth H4 with linux header", "bluetooth-h4" },
+
+       /* 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" }
 };
 
+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)
@@ -196,6 +521,7 @@ static const char *wtap_errlist[] = {
        "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"
 };
 #define        WTAP_ERRLIST_SIZE       (sizeof wtap_errlist / sizeof wtap_errlist[0])
 
@@ -209,14 +535,14 @@ const char
 #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",
+                       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) {
-                       sprintf(errbuf, "Error %d", err);
+                       g_snprintf(errbuf, 128, "Error %d", err);
                        return errbuf;
                }
                if (wtap_errlist[wtap_errlist_index] == NULL)
@@ -231,7 +557,7 @@ const char
    Note that we do *not* want to call the subtype's close function,
    as it would free any per-subtype data, and that data may be
    needed by the random-access side.
-   
+
    Instead, if the subtype has a "sequential close" function, we call it,
    to free up stuff used only by the sequential side. */
 void
@@ -267,9 +593,55 @@ wtap_close(wtap *wth)
 }
 
 gboolean
-wtap_read(wtap *wth, int *err, long *data_offset)
+wtap_read(wtap *wth, int *err, gchar **err_info, gint64 *data_offset)
+{
+       /*
+        * Set the packet encapsulation to the file's encapsulation
+        * value; if that's not WTAP_ENCAP_PER_PACKET, it's the
+        * right answer (and means that the read routine for this
+        * capture file type doesn't have to set it), and if it
+        * *is* WTAP_ENCAP_PER_PACKET, the caller needs to set it
+        * anyway.
+        */
+       wth->phdr.pkt_encap = wth->file_encap;
+
+       if (!wth->subtype_read(wth, err, err_info, data_offset))
+               return FALSE;   /* failure */
+
+       /*
+        * It makes no sense for the captured data length to be bigger
+        * than the actual data length.
+        */
+       if (wth->phdr.caplen > wth->phdr.len)
+               wth->phdr.caplen = wth->phdr.len;
+
+       /*
+        * Make sure that it's not WTAP_ENCAP_PER_PACKET, as that
+        * probably means the file has that encapsulation type
+        * but the read routine didn't set this packet's
+        * encapsulation type.
+        */
+       g_assert(wth->phdr.pkt_encap != WTAP_ENCAP_PER_PACKET);
+
+       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, int *err)
 {
-       return wth->subtype_read(wth, err, data_offset);
+       off_t file_pos;
+
+       file_pos = ws_lseek(wth->fd, 0, SEEK_CUR);
+       if (file_pos == -1) {
+               if (err != NULL)
+                       *err = errno;
+               return -1;
+       }
+       return file_pos;
 }
 
 struct wtap_pkthdr*
@@ -291,32 +663,10 @@ wtap_buf_ptr(wtap *wth)
 }
 
 gboolean
-wtap_loop(wtap *wth, int count, wtap_handler callback, guchar* user, int *err)
-{
-       long            data_offset;
-       int             loop = 0;
-
-       /* Start by clearing error flag */
-       *err = 0;
-
-       while ( (wtap_read(wth, err, &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)
+       int *err, gchar **err_info)
 {
        return wth->subtype_seek_read(wth, seek_off, pseudo_header, pd, len,
-               err);
+               err, err_info);
 }