Use an enum for the open-routine return value, as per Evan Huus's suggestion.
[metze/wireshark/wip.git] / wiretap / vms.c
index 905405d32ebe1eeb3b9d717fad552eb0cd1e0858..6a1c5fb6a2822ebd50225ffd9a617b2cd68c748f 100644 (file)
@@ -1,6 +1,4 @@
 /* vms.c
- *
- * $Id$
  *
  * Wiretap Library
  * Copyright (c) 2001 by Marc Milgram <ethereal@mmilgram.NOSPAMmail.net>
@@ -17,7 +15,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.
  */
 
 /* Notes:
  *   TCPIPTRACE_FRAGMENTS_HAVE_HEADER_LINE to expect the first line to be
  *   at the start of every packet.
  */
-#ifdef HAVE_CONFIG_H
 #include "config.h"
-#endif
 #include "wtap-int.h"
-#include "buffer.h"
+#include <wsutil/buffer.h>
 #include "vms.h"
 #include "file_wrappers.h"
 
 
    Example UCX$TRACE output data:
 
-    UCX INTERnet trace RCV packet seq # = 1 at 14-MAY-2003 11:32:10.93 
+    UCX INTERnet trace RCV packet seq # = 1 at 14-MAY-2003 11:32:10.93
 
-   IP Version = 4,  IHL = 5,  TOS = 00,   Total Length = 583 = ^x0247 
-   IP Identifier  = ^x702E,  Flags (0=0,DF=0,MF=0),  
-         Fragment Offset = 0 = ^x0000,   Calculated Offset = 0 = ^x0000 
-   IP TTL = 128 = ^x80,  Protocol = 17 = ^x11,  Header Checksum = ^x70EC 
-   IP Source Address      = 10.20.4.159 
-   IP Destination Address = 10.20.4.255 
+   IP Version = 4,  IHL = 5,  TOS = 00,   Total Length = 583 = ^x0247
+   IP Identifier  = ^x702E,  Flags (0=0,DF=0,MF=0),
+         Fragment Offset = 0 = ^x0000,   Calculated Offset = 0 = ^x0000
+   IP TTL = 128 = ^x80,  Protocol = 17 = ^x11,  Header Checksum = ^x70EC
+   IP Source Address      = 10.20.4.159
+   IP Destination Address = 10.20.4.255
 
-   UDP Source Port = 138,   UDP Destination Port = 138 
-   UDP Header and Datagram Length = 563 = ^x0233,   Checksum = ^xB913 
+   UDP Source Port = 138,   UDP Destination Port = 138
+   UDP Header and Datagram Length = 563 = ^x0233,   Checksum = ^xB913
 
    9F04140A   70EC1180   0000702E   47020045    0000    E..G.p.....p....
    B1B80E11 | B9133302   8A008A00 | FF04140A    0010    .........3......
@@ -121,7 +117,7 @@ Format 2:
 
  ... packet seq # = nn at DD-MMM-YYYY hh:mm:ss.ss
 
-If there are other formats then code will have to be written in parse_vms_rec_hdr()
+If there are other formats then code will have to be written in parse_vms_packet()
 to handle them.
 
 --------------------------------------------------------------------------------
@@ -146,53 +142,41 @@ to handle them.
 static gboolean vms_read(wtap *wth, int *err, gchar **err_info,
     gint64 *data_offset);
 static gboolean vms_seek_read(wtap *wth, gint64 seek_off,
-    union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
-    int *err, gchar **err_info);
+    struct wtap_pkthdr *phdr, Buffer *buf, int *err, gchar **err_info);
 static gboolean parse_single_hex_dump_line(char* rec, guint8 *buf,
     long byte_offset, int in_off, int remaining_bytes);
-static gboolean parse_vms_hex_dump(FILE_T fh, int pkt_len, guint8* buf,
-    int *err, gchar **err_info);
-static int parse_vms_rec_hdr(wtap *wth, FILE_T fh, int *err, gchar **err_info);
+static gboolean parse_vms_packet(FILE_T fh, struct wtap_pkthdr *phdr,
+    Buffer *buf, int *err, gchar **err_info);
 
 #ifdef TCPIPTRACE_FRAGMENTS_HAVE_HEADER_LINE
 /* Seeks to the beginning of the next packet, and returns the
-   byte offset.  Returns -1 on failure, and sets "*err" to the error. */
-static long vms_seek_next_packet(wtap *wth, int *err)
+   byte offset.  Returns -1 on failure, and sets "*err" to the error
+   and sets "*err_info" to null or an additional error string. */
+static long vms_seek_next_packet(wtap *wth, int *err, gchar **err_info)
 {
-  long cur_off;
-  char buf[VMS_LINE_LENGTH];
-  
-  while (1) {
-    cur_off = file_tell(wth->fh);
-    if (cur_off == -1) {
-      /* Error */
-      *err = file_error(wth->fh);
-      hdr = NULL;
-      return -1;
-    }
-    if (file_gets(buf, sizeof(buf), wth->fh) != NULL) {
-      if (strstr(buf, VMS_REC_MAGIC_STR1) ||
-         strstr(buf, VMS_REC_MAGIC_STR2) ||
-         strstr(buf, VMS_REC_MAGIC_STR2)) {
-                 g_strlcpy(hdr, buf,VMS_LINE_LENGTH);
-                 return cur_off;
-      }
-    } else {
-      if (file_eof(wth->fh)) {
-       /* We got an EOF. */
-       *err = 0;
-      } else {
-       /* We (presumably) got an error (there's no
-          equivalent to "ferror()" in zlib, alas,
-          so we don't have a wrapper to check for
-          an error). */
-       *err = file_error(wth->fh);
-      }
-      break;
+    long cur_off;
+    char buf[VMS_LINE_LENGTH];
+
+    while (1) {
+        cur_off = file_tell(wth->fh);
+        if (cur_off == -1) {
+            /* Error */
+            *err = file_error(wth->fh, err_info);
+            return -1;
+        }
+        if (file_gets(buf, sizeof(buf), wth->fh) == NULL) {
+            /* EOF or error. */
+            *err = file_error(wth->fh, err_info);
+            break;
+        }
+        if (strstr(buf, VMS_REC_MAGIC_STR1) ||
+            strstr(buf, VMS_REC_MAGIC_STR2) ||
+            strstr(buf, VMS_REC_MAGIC_STR2)) {
+            g_strlcpy(hdr, buf,VMS_LINE_LENGTH);
+            return cur_off;
+        }
     }
-  }
-  hdr = NULL;
-  return -1;
+    return -1;
 }
 #endif /* TCPIPTRACE_FRAGMENTS_HAVE_HEADER_LINE */
 
@@ -200,79 +184,74 @@ static long vms_seek_next_packet(wtap *wth, int *err)
  * a VMS trace file.
  *
  * Returns TRUE if it is, FALSE if it isn't or if we get an I/O error;
- * if we get an I/O error, "*err" will be set to a non-zero value.
+ * if we get an I/O error, "*err" will be set to a non-zero value and
+ * "*err_info will be set to null or an additional error string.
  *
- * Leaves file handle at begining of line that contains the VMS Magic
+ * Leaves file handle at beginning of line that contains the VMS Magic
  * identifier.
  */
-static gboolean vms_check_file_type(wtap *wth, int *err)
+static gboolean vms_check_file_type(wtap *wth, int *err, gchar **err_info)
 {
-  char buf[VMS_LINE_LENGTH];
-  guint        reclen, line;
-  gint64 mpos;
-  
-  buf[VMS_LINE_LENGTH-1] = '\0';
-  
-  for (line = 0; line < VMS_HEADER_LINES_TO_CHECK; line++) {
-    mpos = file_tell(wth->fh);
-    if (mpos == -1) {
-      /* Error. */
-      *err = file_error(wth->fh);
-      return FALSE;
-    }
-    if (file_gets(buf, VMS_LINE_LENGTH, wth->fh) != NULL) {
-      
-      reclen = (guint) strlen(buf);
-      if (reclen < strlen(VMS_HDR_MAGIC_STR1) ||
-         reclen < strlen(VMS_HDR_MAGIC_STR2) || 
-         reclen < strlen(VMS_HDR_MAGIC_STR3)) {
-       continue;
-      }
-      
-      if (strstr(buf, VMS_HDR_MAGIC_STR1) ||
-         strstr(buf, VMS_HDR_MAGIC_STR2) ||
-         strstr(buf, VMS_HDR_MAGIC_STR3)) {
-       /* Go back to the beginning of this line, so we will
-        * re-read it. */
-       if (file_seek(wth->fh, mpos, SEEK_SET, err) == -1) {
-         /* Error. */
-         return FALSE;
-       }
-       return TRUE;
-      }
-    } else {
-      /* EOF or error. */
-      if (file_eof(wth->fh))
-       *err = 0;
-      else
-       *err = file_error(wth->fh);
-      return FALSE;
+    char buf[VMS_LINE_LENGTH];
+    guint reclen, line;
+    gint64 mpos;
+
+    buf[VMS_LINE_LENGTH-1] = '\0';
+
+    for (line = 0; line < VMS_HEADER_LINES_TO_CHECK; line++) {
+        mpos = file_tell(wth->fh);
+        if (mpos == -1) {
+            /* Error. */
+            *err = file_error(wth->fh, err_info);
+            return FALSE;
+        }
+        if (file_gets(buf, VMS_LINE_LENGTH, wth->fh) == NULL) {
+            /* EOF or error. */
+            *err = file_error(wth->fh, err_info);
+            return FALSE;
+        }
+
+        reclen = (guint) strlen(buf);
+        if (reclen < strlen(VMS_HDR_MAGIC_STR1) ||
+            reclen < strlen(VMS_HDR_MAGIC_STR2) ||
+            reclen < strlen(VMS_HDR_MAGIC_STR3)) {
+            continue;
+        }
+
+        if (strstr(buf, VMS_HDR_MAGIC_STR1) ||
+            strstr(buf, VMS_HDR_MAGIC_STR2) ||
+            strstr(buf, VMS_HDR_MAGIC_STR3)) {
+            /* Go back to the beginning of this line, so we will
+             * re-read it. */
+            if (file_seek(wth->fh, mpos, SEEK_SET, err) == -1) {
+                /* Error. */
+                return FALSE;
+            }
+            return TRUE;
+        }
     }
-  }
-  *err = 0;
-  return FALSE;
+    *err = 0;
+    return FALSE;
 }
 
 
-int vms_open(wtap *wth, int *err, gchar **err_info _U_)
+wtap_open_return_val vms_open(wtap *wth, int *err, gchar **err_info)
 {
     /* Look for VMS header */
-    if (!vms_check_file_type(wth, err)) {
-        if (*err == 0)
-            return 0;
-        else
-            return -1;
+    if (!vms_check_file_type(wth, err, err_info)) {
+        if (*err != 0 && *err != WTAP_ERR_SHORT_READ)
+            return WTAP_OPEN_ERROR;
+        return WTAP_OPEN_NOT_MINE;
     }
 
-    wth->data_offset = 0;
     wth->file_encap = WTAP_ENCAP_RAW_IP;
-    wth->file_type = WTAP_FILE_VMS;
+    wth->file_type_subtype = WTAP_FILE_TYPE_SUBTYPE_VMS;
     wth->snapshot_length = 0; /* not known */
     wth->subtype_read = vms_read;
     wth->subtype_seek_read = vms_seek_read;
-       wth->tsprecision = WTAP_FILE_TSPREC_CSEC;
+    wth->file_tsprec = WTAP_TSPREC_CSEC;
 
-    return 1;
+    return WTAP_OPEN_MINE;
 }
 
 /* Find the next packet and parse it; called from wtap_read(). */
@@ -280,59 +259,37 @@ static gboolean vms_read(wtap *wth, int *err, gchar **err_info,
     gint64 *data_offset)
 {
     gint64   offset = 0;
-    guint8    *buf;
-    int    pkt_len;
 
     /* Find the next packet */
 #ifdef TCPIPTRACE_FRAGMENTS_HAVE_HEADER_LINE
-    offset = vms_seek_next_packet(wth, err);
+    offset = vms_seek_next_packet(wth, err, err_info);
 #else
     offset = file_tell(wth->fh);
 #endif
-    if (offset < 1)
+    if (offset < 1) {
+        *err = file_error(wth->fh, err_info);
         return FALSE;
-
-    /* Parse the header */
-    pkt_len = parse_vms_rec_hdr(wth, wth->fh, err, err_info);
-    if (pkt_len == -1)
-       return FALSE;
-
-    /* Make sure we have enough room for the packet */
-    buffer_assure_space(wth->frame_buffer, pkt_len);
-    buf = buffer_start_ptr(wth->frame_buffer);
-
-    /* Convert the ASCII hex dump to binary data */
-    if (!parse_vms_hex_dump(wth->fh, pkt_len, buf, err, err_info))
-        return FALSE;
-
-    wth->data_offset = offset;
+    }
     *data_offset = offset;
-    return TRUE;
+
+    /* Parse the packet */
+    return parse_vms_packet(wth->fh, &wth->phdr, wth->frame_buffer, err, err_info);
 }
 
 /* Used to read packets in random-access fashion */
 static gboolean
-vms_seek_read (wtap *wth, gint64 seek_off,
-    union wtap_pseudo_header *pseudo_header _U_,
-    guint8 *pd, int len, int *err, gchar **err_info)
+vms_seek_read(wtap *wth, gint64 seek_off, struct wtap_pkthdr *phdr,
+    Buffer *buf, int *err, gchar **err_info)
 {
-    int    pkt_len;
-
     if (file_seek(wth->random_fh, seek_off - 1, SEEK_SET, err) == -1)
         return FALSE;
 
-    pkt_len = parse_vms_rec_hdr(NULL, wth->random_fh, err, err_info);
-
-    if (pkt_len != len) {
-        if (pkt_len != -1) {
-            *err = WTAP_ERR_BAD_RECORD;
-            *err_info = g_strdup_printf("vms: requested length %d doesn't match length %d",
-                len, pkt_len);
-        }
+    if (!parse_vms_packet(wth->random_fh, phdr, buf, err, err_info)) {
+        if (*err == 0)
+            *err = WTAP_ERR_SHORT_READ;
         return FALSE;
     }
-
-    return parse_vms_hex_dump(wth->random_fh, pkt_len, pd, err, err_info);
+    return TRUE;
 }
 
 /* isdumpline assumes that dump lines start with some non-alphanumerics
@@ -360,9 +317,9 @@ isdumpline( gchar *line )
     return isspace((guchar)*line);
 }
 
-/* Parses a packet record header. */
-static int
-parse_vms_rec_hdr(wtap *wth, FILE_T fh, int *err, gchar **err_info)
+/* Parses a packet record. */
+static gboolean
+parse_vms_packet(FILE_T fh, struct wtap_pkthdr *phdr, Buffer *buf, int *err, gchar **err_info)
 {
     char   line[VMS_LINE_LENGTH + 1];
     int    num_items_scanned;
@@ -372,9 +329,14 @@ parse_vms_rec_hdr(wtap *wth, FILE_T fh, int *err, gchar **err_info)
     struct tm tm;
     char mon[4] = {'J', 'A', 'N', 0};
     gchar *p;
-    static gchar months[] = "JANFEBMARAPRMAYJUNJULAUGSEPOCTNOVDEC";
+    static const gchar months[] = "JANFEBMARAPRMAYJUNJULAUGSEPOCTNOVDEC";
+    int    i;
+    int    offset = 0;
+    guint8 *pd;
 
     tm.tm_year = 1970;
+    tm.tm_mon = 0;
+    tm.tm_mday = 1;
     tm.tm_hour = 1;
     tm.tm_min = 1;
     tm.tm_sec = 1;
@@ -382,114 +344,119 @@ parse_vms_rec_hdr(wtap *wth, FILE_T fh, int *err, gchar **err_info)
     /* Skip lines until one starts with a hex number */
     do {
         if (file_gets(line, VMS_LINE_LENGTH, fh) == NULL) {
-            *err = file_error(fh);
+            *err = file_error(fh, err_info);
            if ((*err == 0) && (csec != 101)) {
                *err = WTAP_ERR_SHORT_READ;
             }
-            return -1;
+            return FALSE;
         }
        line[VMS_LINE_LENGTH] = '\0';
 
-       if ((csec == 101) && (p = strstr(line, "packet "))
+       if ((csec == 101) && (p = strstr(line, "packet ")) != NULL
            && (! strstr(line, "could not save "))) {
            /* Find text in line starting with "packet ". */
 
            /* First look for the Format 1 type sequencing */
-           num_items_scanned = sscanf(p,  
-                                      "packet %d at %d-%3s-%d %d:%d:%d.%d",
-                                      &pktnum, &tm.tm_mday, mon,
+           num_items_scanned = sscanf(p,
+                                      "packet %9d at %2d-%3s-%4d %2d:%2d:%2d.%9d",
+                                      &pktnum, &tm.tm_mday, mon,
                                       &tm.tm_year, &tm.tm_hour,
                                       &tm.tm_min, &tm.tm_sec, &csec);
            /* Next look for the Format 2 type sequencing */
            if (num_items_scanned != 8) {
              num_items_scanned = sscanf(p,
-                                        "packet seq # = %d at %d-%3s-%d %d:%d:%d.%d",
-                                        &pktnum, &tm.tm_mday, mon,
-                                        &tm.tm_year, &tm.tm_hour,
-                                        &tm.tm_min, &tm.tm_sec, &csec);
+                                        "packet seq # = %9d at %2d-%3s-%4d %2d:%2d:%2d.%9d",
+                                        &pktnum, &tm.tm_mday, mon,
+                                        &tm.tm_year, &tm.tm_hour,
+                                        &tm.tm_min, &tm.tm_sec, &csec);
            }
            /* if unknown format then exit with error        */
            /* We will need to add code to handle new format */
            if (num_items_scanned != 8) {
-               *err = WTAP_ERR_BAD_RECORD;
-               *err_info = g_strdup_printf("vms: header line not valid");
-               return -1;
+               *err = WTAP_ERR_BAD_FILE;
+               *err_info = g_strdup_printf("vms: header line not valid");
+               return FALSE;
            }
        }
-        if ( (! pkt_len) && (p = strstr(line, "Length"))) {
-            p += sizeof("Length ");
-            while (*p && ! isdigit((guchar)*p))
-                p++;
-
-            if ( !*p ) {
-                *err = WTAP_ERR_BAD_RECORD;
-               *err_info = g_strdup_printf("vms: Length field not valid");
-                return -1;
-            }
+       if ( (! pkt_len) && (p = strstr(line, "Length"))) {
+           p += sizeof("Length ");
+           while (*p && ! isdigit((guchar)*p))
+               p++;
+
+           if ( !*p ) {
+               *err = WTAP_ERR_BAD_FILE;
+               *err_info = g_strdup_printf("vms: Length field not valid");
+               return FALSE;
+           }
 
-            pkt_len = atoi(p);
+           pkt_len = atoi(p);
            break;
-        }
+       }
     } while (! isdumpline(line));
 
-    if (wth) {
-        p = strstr(months, mon);
-        if (p)
-            tm.tm_mon = (int) (p - months) / 3;
-        tm.tm_year -= 1900;
-
-       tm.tm_isdst = -1;
-        wth->phdr.ts.secs = mktime(&tm);
-        wth->phdr.ts.nsecs = csec * 10000000;
-        wth->phdr.caplen = pkt_len;
-        wth->phdr.len = pkt_len;
-    }
+    p = strstr(months, mon);
+    if (p)
+       tm.tm_mon = (int) (p - months) / 3;
+    tm.tm_year -= 1900;
+    tm.tm_isdst = -1;
 
-    return pkt_len;
-}
+    phdr->rec_type = REC_TYPE_PACKET;
+    phdr->presence_flags = WTAP_HAS_TS;
+    phdr->ts.secs = mktime(&tm);
+    phdr->ts.nsecs = csec * 10000000;
+    phdr->caplen = pkt_len;
+    phdr->len = pkt_len;
 
-/* Converts ASCII hex dump to binary data */
-static gboolean
-parse_vms_hex_dump(FILE_T fh, int pkt_len, guint8* buf, int *err,
-    gchar **err_info)
-{
-    gchar line[VMS_LINE_LENGTH + 1];
-    int    i;
-    int    offset = 0;
+    /* Make sure we have enough room for the packet */
+    ws_buffer_assure_space(buf, pkt_len);
+    pd = ws_buffer_start_ptr(buf);
 
+    /* Convert the ASCII hex dump to binary data */
     for (i = 0; i < pkt_len; i += 16) {
-        if (file_gets(line, VMS_LINE_LENGTH, fh) == NULL) {
-            *err = file_error(fh);
-            if (*err == 0) {
-                *err = WTAP_ERR_SHORT_READ;
-            }
-            return FALSE;
-        }
+       if (file_gets(line, VMS_LINE_LENGTH, fh) == NULL) {
+           *err = file_error(fh, err_info);
+           if (*err == 0) {
+               *err = WTAP_ERR_SHORT_READ;
+           }
+           return FALSE;
+       }
        line[VMS_LINE_LENGTH] = '\0';
-        if (i == 0) {
+       if (i == 0) {
            while (! isdumpline(line)) { /* advance to start of hex data */
-               if (file_gets(line, VMS_LINE_LENGTH, fh) == NULL) {
-                   *err = file_error(fh);
+               if (file_gets(line, VMS_LINE_LENGTH, fh) == NULL) {
+                   *err = file_error(fh, err_info);
                    if (*err == 0) {
-                       *err = WTAP_ERR_SHORT_READ;
+                       *err = WTAP_ERR_SHORT_READ;
                    }
                    return FALSE;
                }
                line[VMS_LINE_LENGTH] = '\0';
            }
-            while (line[offset] && !isxdigit((guchar)line[offset]))
-                offset++;
+           while (line[offset] && !isxdigit((guchar)line[offset]))
+               offset++;
        }
-       if (!parse_single_hex_dump_line(line, buf, i,
+       if (!parse_single_hex_dump_line(line, pd, i,
                                        offset, pkt_len - i)) {
-            *err = WTAP_ERR_BAD_RECORD;
+           *err = WTAP_ERR_BAD_FILE;
            *err_info = g_strdup_printf("vms: hex dump not valid");
-            return FALSE;
-        }
+           return FALSE;
+       }
     }
     /* Avoid TCPIPTRACE-W-BUFFERSFUL, TCPIPtrace could not save n packets.
-     * errors. */
-    file_gets(line, VMS_LINE_LENGTH, fh);
+     * errors.
+     *
+     * XXX - when we support packet drop report information in the
+     * Wiretap API, we should parse those lines and return "n" as
+     * a packet drop count. */
+    if (!file_gets(line, VMS_LINE_LENGTH, fh)) {
+       *err = file_error(fh, err_info);
+       if (*err == 0) {
+           /* There is no next line, so there's no "TCPIPtrace could not
+            * save n packets" line; not an error. */
+           return TRUE;
+       }
+       return FALSE;
+    }
     return TRUE;
 }
 
@@ -517,16 +484,16 @@ parse_single_hex_dump_line(char* rec, guint8 *buf, long byte_offset,
     int        i;
     char        *s;
     int        value;
-    static int offsets[16] = {39,37,35,33,28,26,24,22,17,15,13,11,6,4,2,0};
+    static const int offsets[16] = {39,37,35,33,28,26,24,22,17,15,13,11,6,4,2,0};
     char lbuf[3] = {0,0,0};
 
 
     /* Get the byte_offset directly from the record */
     s = rec;
-    value = strtoul(s + 45 + in_off, NULL, 16);
+    value = (int)strtoul(s + 45 + in_off, NULL, 16);   /* XXX - error check? */
 
     if (value != byte_offset) {
-        return FALSE;
+       return FALSE;
     }
 
     if (remaining > 16)
@@ -537,10 +504,10 @@ parse_single_hex_dump_line(char* rec, guint8 *buf, long byte_offset,
      */
 
     for (i = 0; i < remaining; i++) {
-        lbuf[0] = rec[offsets[i] + in_off];
-        lbuf[1] = rec[offsets[i] + 1 + in_off];
+       lbuf[0] = rec[offsets[i] + in_off];
+       lbuf[1] = rec[offsets[i] + 1 + in_off];
 
-        buf[byte_offset + i] = (guint8) strtoul(lbuf, NULL, 16);
+       buf[byte_offset + i] = (guint8) strtoul(lbuf, NULL, 16);
     }
 
     return TRUE;