Have "wtap_seek_read()" return 0 on success and -1 on failure, and take
[obnox/wireshark/wip.git] / wiretap / nettl.c
1 /* nettl.c
2  *
3  * $Id: nettl.c,v 1.24 2002/03/05 05:58:40 guy Exp $
4  *
5  * Wiretap Library
6  * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
7  * 
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  * 
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  */
22
23 #ifdef HAVE_CONFIG_H
24 #include "config.h"
25 #endif
26
27 #include <stdlib.h>
28 #include <errno.h>
29 #include <string.h>
30 #include "wtap-int.h"
31 #include "file_wrappers.h"
32 #include "buffer.h"
33 #include "nettl.h"
34
35 static u_char nettl_magic_hpux9[12] = {
36     0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x07, 0xD0, 0x00
37 };
38 static u_char nettl_magic_hpux10[12] = {
39     0x54, 0x52, 0x00, 0x64, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x80
40 };
41
42 /* HP nettl record header for the SX25L2 subsystem - The FCS is not included in the file. */
43 struct nettlrec_sx25l2_hdr {
44     guint8      xxa[8];
45     guint8      from_dce;
46     guint8      xxb[55];
47     guint8      length[2];
48     guint8      length2[2];    /* don't know which one is captured length / real length */
49     guint8      xxc[4];
50     guint8      sec[4];
51     guint8      usec[4];
52     guint8      xxd[4];
53 };
54
55 /* HP nettl record header for the NS_LS_IP subsystem */
56 /* This also works for BASE100 and GSC100BT */
57 struct nettlrec_ns_ls_ip_hdr {
58     guint8      xxa[28];
59     guint8      length[4];
60     guint8      length2[4];    /* don't know which one is captured length / real length */
61     guint8      sec[4];
62     guint8      usec[4];
63     guint8      xxb[16];
64 };
65
66
67 /* header is followed by data and once again the total length (2 bytes) ! */
68
69 static gboolean nettl_read(wtap *wth, int *err, long *data_offset);
70 static int nettl_seek_read(wtap *wth, long seek_off,
71                 union wtap_pseudo_header *pseudo_header, u_char *pd,
72                 int length, int *err);
73 static int nettl_read_rec_header(wtap *wth, FILE_T fh,
74                 struct wtap_pkthdr *phdr, union wtap_pseudo_header *pseudo_header,
75                 int *err);
76 static int nettl_read_rec_data(FILE_T fh, u_char *pd, int length, int *err);
77 static void nettl_close(wtap *wth);
78
79 int nettl_open(wtap *wth, int *err)
80 {
81     char magic[12], os_vers[2];
82     int bytes_read;
83
84     /* Read in the string that should be at the start of a HP file */
85     errno = WTAP_ERR_CANT_READ;
86     bytes_read = file_read(magic, 1, 12, wth->fh);
87     if (bytes_read != 12) {
88         *err = file_error(wth->fh);
89         if (*err != 0)
90             return -1;
91         return 0;
92     }
93
94     if (memcmp(magic, nettl_magic_hpux9, 12) &&
95         memcmp(magic, nettl_magic_hpux10, 12)) {
96         return 0;
97     }
98
99     if (file_seek(wth->fh, 0x63, SEEK_SET) == -1) {
100         *err = file_error(wth->fh);
101         return -1;
102     }
103     wth->data_offset = 0x63;
104     bytes_read = file_read(os_vers, 1, 2, wth->fh);
105     if (bytes_read != 2) {
106         *err = file_error(wth->fh);
107         if (*err != 0)
108             return -1;
109         return 0;
110     }
111
112     if (file_seek(wth->fh, 0x80, SEEK_SET) == -1) {
113         *err = file_error(wth->fh);
114         return -1;
115     }
116     wth->data_offset = 0x80;
117
118     /* This is an nettl file */
119     wth->file_type = WTAP_FILE_NETTL;
120     wth->capture.nettl = g_malloc(sizeof(nettl_t));
121     if (os_vers[0] == '1' && os_vers[1] == '1')
122         wth->capture.nettl->is_hpux_11 = TRUE;
123     else
124         wth->capture.nettl->is_hpux_11 = FALSE;
125     wth->subtype_read = nettl_read;
126     wth->subtype_seek_read = nettl_seek_read;
127     wth->subtype_close = nettl_close;
128     wth->snapshot_length = 0;   /* not available in header, only in frame */
129
130     return 1;
131 }
132
133 /* Read the next packet */
134 static gboolean nettl_read(wtap *wth, int *err, long *data_offset)
135 {
136     int ret;
137
138     /* Read record header. */
139     *data_offset = wth->data_offset;
140     ret = nettl_read_rec_header(wth, wth->fh, &wth->phdr, &wth->pseudo_header,
141         err);
142     if (ret <= 0) {
143         /* Read error or EOF */
144         return FALSE;
145     }
146     wth->data_offset += ret;
147
148     /*
149      * Read the packet data.
150      */
151     buffer_assure_space(wth->frame_buffer, wth->phdr.caplen);
152     if (nettl_read_rec_data(wth->fh, buffer_start_ptr(wth->frame_buffer),
153                 wth->phdr.caplen, err) < 0)
154         return FALSE;   /* Read error */
155     wth->data_offset += wth->phdr.caplen;
156     return TRUE;
157 }
158
159 static int
160 nettl_seek_read(wtap *wth, long seek_off,
161                 union wtap_pseudo_header *pseudo_header, u_char *pd,
162                 int length, int *err)
163 {
164     int ret;
165     struct wtap_pkthdr phdr;
166
167     if (file_seek(wth->random_fh, seek_off, SEEK_SET) == -1) {
168         *err = file_error(wth->random_fh);
169         return -1;
170     }
171
172     /* Read record header. */
173     ret = nettl_read_rec_header(wth, wth->random_fh, &phdr, pseudo_header,
174         err);
175     if (ret <= 0) {
176         /* Read error or EOF */
177         if (ret == 0) {
178             /* EOF means "short read" in random-access mode */
179             *err = WTAP_ERR_SHORT_READ;
180         }
181         return -1;
182     }
183
184     /*
185      * Read the packet data.
186      */
187     return nettl_read_rec_data(wth->random_fh, pd, length, err);
188 }
189
190 static int
191 nettl_read_rec_header(wtap *wth, FILE_T fh, struct wtap_pkthdr *phdr,
192                 union wtap_pseudo_header *pseudo_header, int *err)
193 {
194     int bytes_read;
195     struct nettlrec_sx25l2_hdr lapb_hdr;
196     struct nettlrec_ns_ls_ip_hdr ip_hdr;
197     guint16 length;
198     int offset = 0;
199     guint8 encap[4];
200     guint8 dummy[4];
201
202     errno = WTAP_ERR_CANT_READ;
203     bytes_read = file_read(encap, 1, 4, fh);
204     if (bytes_read != 4) {
205         *err = file_error(fh);
206         if (*err != 0)
207             return -1;
208         if (bytes_read != 0) {
209             *err = WTAP_ERR_SHORT_READ;
210             return -1;
211         }
212         return 0;
213     }
214     offset += 4;
215
216     switch (encap[3]) {
217         case NETTL_SUBSYS_BASE100 :
218         case NETTL_SUBSYS_GSC100BT :
219         case NETTL_SUBSYS_NS_LS_IP :
220             if (encap[3] == NETTL_SUBSYS_NS_LS_IP) {
221                 phdr->pkt_encap = WTAP_ENCAP_RAW_IP; 
222             } else {
223                 wth->file_encap = WTAP_ENCAP_ETHERNET;
224                 phdr->pkt_encap = WTAP_ENCAP_ETHERNET; 
225             }
226
227             bytes_read = file_read(&ip_hdr, 1, sizeof ip_hdr, fh);
228             if (bytes_read != sizeof ip_hdr) {
229                 *err = file_error(fh);
230                 if (*err != 0)
231                     return -1;
232                 if (bytes_read != 0) {
233                     *err = WTAP_ERR_SHORT_READ;
234                     return -1;
235                 }
236                 return 0;
237             }
238             offset += sizeof ip_hdr;
239
240             /* The packet header in HP-UX 11 nettl traces is 4 octets longer than
241              * HP-UX 9 and 10 */
242             if (wth->capture.nettl->is_hpux_11) {
243                 bytes_read = file_read(dummy, 1, 4, fh);
244                 if (bytes_read != 4) {
245                     *err = file_error(fh);
246                     if (*err != 0)
247                         return -1;
248                     if (bytes_read != 0) {
249                         *err = WTAP_ERR_SHORT_READ;
250                         return -1;
251                     }
252                     return 0;
253                 }
254                 offset += 4;
255             }
256
257             length = pntohl(&ip_hdr.length);
258             if (length <= 0) return 0;
259             phdr->len = length;
260             phdr->caplen = length;
261
262             phdr->ts.tv_sec = pntohl(&ip_hdr.sec);
263             phdr->ts.tv_usec = pntohl(&ip_hdr.usec);
264             break;
265         case NETTL_SUBSYS_SX25L2 :
266             phdr->pkt_encap = WTAP_ENCAP_LAPB;
267             bytes_read = file_read(&lapb_hdr, 1, sizeof lapb_hdr, fh);
268             if (bytes_read != sizeof lapb_hdr) {
269                 *err = file_error(fh);
270                 if (*err != 0)
271                     return -1;
272                 if (bytes_read != 0) {
273                     *err = WTAP_ERR_SHORT_READ;
274                     return -1;
275                 }
276                 return 0;
277             }
278             offset += sizeof lapb_hdr;
279
280             if (wth->capture.nettl->is_hpux_11) {
281                 bytes_read = file_read(dummy, 1, 4, fh);
282                 if (bytes_read != 4) {
283                     *err = file_error(fh);
284                     if (*err != 0)
285                         return -1;
286                     if (bytes_read != 0) {
287                         *err = WTAP_ERR_SHORT_READ;
288                         return -1;
289                     }
290                     return 0;
291                 }
292                 offset += 4;
293             }
294
295             length = pntohs(&lapb_hdr.length);
296             if (length <= 0) return 0;
297             phdr->len = length;
298             phdr->caplen = length;
299
300             phdr->ts.tv_sec = pntohl(&lapb_hdr.sec);
301             phdr->ts.tv_usec = pntohl(&lapb_hdr.usec);
302             pseudo_header->x25.flags = (lapb_hdr.from_dce & 0x20 ? 0x80 : 0x00);
303             break;
304         default:
305             g_message("nettl: network type %u unknown or unsupported",
306                     encap[3]);
307             *err = WTAP_ERR_UNSUPPORTED_ENCAP;
308             return -1;
309     }
310     return offset;
311 }
312
313 static int
314 nettl_read_rec_data(FILE_T fh, u_char *pd, int length, int *err)
315 {
316     int bytes_read;
317
318     bytes_read = file_read(pd, 1, length, fh);
319
320     if (bytes_read != length) {
321         *err = file_error(fh);
322         if (*err == 0)
323             *err = WTAP_ERR_SHORT_READ;
324         return -1;
325     }
326     return 0;
327 }
328
329 static void nettl_close(wtap *wth)
330 {
331     g_free(wth->capture.nettl);
332 }