Put "WTP" into the Info column for segmented invoke/result PDUs on which
[obnox/wireshark/wip.git] / packet-arcnet.c
1 /* packet-arcnet.c
2  * Routines for arcnet dissection
3  * Copyright 2001-2002, Peter Fales <ethereal@fales-lorenz.net>
4  *
5  * $Id: packet-arcnet.c,v 1.9 2003/01/23 10:11:54 guy Exp $
6  *
7  * Ethereal - Network traffic analyzer
8  * By Gerald Combs <gerald@ethereal.com>
9  * Copyright 1998 Gerald Combs
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  * 
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  * 
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24  */
25
26 #ifdef HAVE_CONFIG_H
27 # include "config.h"
28 #endif
29
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include <string.h>
33
34 #include <glib.h>
35
36 #include <epan/packet.h>
37 #include "packet-arcnet.h"
38 #include "arcnet_pids.h"
39 #include "packet-ip.h"
40
41 /* Initialize the protocol and registered fields */
42 static int proto_arcnet = -1;
43 static int hf_arcnet_src = -1;
44 static int hf_arcnet_dst = -1;
45 static int hf_arcnet_offset = -1;
46 static int hf_arcnet_protID = -1;
47 static int hf_arcnet_exception_flag = -1;
48 static int hf_arcnet_split_flag = -1;
49 static int hf_arcnet_sequence = -1;
50
51 /* Initialize the subtree pointers */
52 static gint ett_arcnet = -1;
53
54 static dissector_table_t arcnet_dissector_table;
55 static dissector_handle_t data_handle;
56
57 void
58 capture_arcnet (const guchar *pd, int len, packet_counts *ld,
59                 gboolean has_offset, gboolean has_exception)
60 {
61   int offset = has_offset ? 2 : 4;
62
63   if (!BYTES_ARE_IN_FRAME(offset, len, 1)) {
64     ld->other++;
65     return;
66   }
67
68   switch (pd[offset]) {
69
70   case ARCNET_PROTO_IP_1051:
71     /* No fragmentation stuff in the header */
72     capture_ip(pd, offset + 1, len, ld);
73     break;
74
75   case ARCNET_PROTO_IP_1201:
76     /*
77      * There's fragmentation stuff in the header.
78      *
79      * XXX - on at least some versions of NetBSD, it appears that we
80      * might we get ARCNET frames, not reassembled packets; we should
81      * perhaps bump "ld->other" for all but the first frame of a packet.
82      *
83      * XXX - but on FreeBSD it appears that we get reassembled packets
84      * on input (but apparently we get frames on output - or maybe
85      * we get the packet *and* all its frames!); how to tell the
86      * difference?  It looks from the FreeBSD reassembly code as if
87      * the reassembled packet arrives with the header for the first
88      * frame.  It also looks as if, on output, we first get the
89      * full packet, with a header containing none of the fragmentation
90      * stuff, and then get the frames.
91      *
92      * On Linux, we get only reassembled packets, and the exception
93      * frame stuff is hidden - there's a split flag and sequence
94      * number, but it appears that it will never have the exception
95      * frame stuff.
96      *
97      * XXX - what about OpenBSD?  And, for that matter, what about
98      * Windows?  (I suspect Windows supplies reassembled frames,
99      * as WinPcap, like PF_PACKET sockets, taps into the networking
100      * stack just as other protocols do.)
101      */
102     offset++;
103     if (!BYTES_ARE_IN_FRAME(offset, len, 1)) {
104       ld->other++;
105       return;
106     }
107     if (has_exception && pd[offset] == 0xff) {
108       /* This is an exception packet.  The flag value there is the
109          "this is an exception flag" packet; the next two bytes
110          after it are padding, and another copy of the packet
111          type appears after the padding. */
112       offset += 4;
113     }
114     capture_ip(pd, offset + 3, len, ld);
115     break;
116
117   case ARCNET_PROTO_ARP_1051:
118   case ARCNET_PROTO_ARP_1201:
119     /*
120      * XXX - do we have to worry about fragmentation for ARP?
121      */
122     ld->arp++;
123     break;
124
125   default:
126     ld->other++;
127     break;
128   }
129 }
130
131 static void
132 dissect_arcnet_common (tvbuff_t * tvb, packet_info * pinfo, proto_tree * tree,
133                        gboolean has_offset, gboolean has_exception)
134 {
135   int offset = 0;
136   guint8 dst, src, protID, split_flag;
137   tvbuff_t *next_tvb;
138   proto_item *ti = NULL;
139   proto_tree *arcnet_tree = NULL;
140
141   if (check_col (pinfo->cinfo, COL_PROTOCOL))
142     col_set_str (pinfo->cinfo, COL_PROTOCOL, "ARCNET");
143
144   if (check_col (pinfo->cinfo, COL_INFO))
145     col_set_str (pinfo->cinfo, COL_INFO, "ARCNET");
146
147   src = tvb_get_guint8 (tvb, 0);
148   dst = tvb_get_guint8 (tvb, 1);
149   SET_ADDRESS(&pinfo->dl_src,   AT_ARCNET, 1, tvb_get_ptr(tvb, 0, 1));
150   SET_ADDRESS(&pinfo->src,      AT_ARCNET, 1, tvb_get_ptr(tvb, 0, 1));
151   SET_ADDRESS(&pinfo->dl_dst,   AT_ARCNET, 1, tvb_get_ptr(tvb, 1, 1));
152   SET_ADDRESS(&pinfo->dst,      AT_ARCNET, 1, tvb_get_ptr(tvb, 1, 1));
153
154   if (tree)
155     {
156       ti =
157         proto_tree_add_item (tree, proto_arcnet, tvb, 0, -1, FALSE);
158
159       arcnet_tree = proto_item_add_subtree (ti, ett_arcnet);
160
161       proto_tree_add_uint (tree, hf_arcnet_src, tvb, offset, 1, src);
162     }
163   offset++;
164
165   if (tree)
166       proto_tree_add_uint (tree, hf_arcnet_dst, tvb, offset, 1, dst);
167   offset++;
168
169   if (has_offset) {
170     if (tree)
171         proto_tree_add_item (tree, hf_arcnet_offset, tvb, offset, 2, FALSE);
172     offset += 2;
173   }
174
175   protID = tvb_get_guint8 (tvb, offset);
176   if (tree)
177       proto_tree_add_uint (tree, hf_arcnet_protID, tvb, offset, 1, protID);
178   offset++;
179
180   switch (protID) {
181
182   case ARCNET_PROTO_IP_1051:
183   case ARCNET_PROTO_ARP_1051:
184   case ARCNET_PROTO_DIAGNOSE:
185   case ARCNET_PROTO_BACNET:     /* XXX - no fragmentation? */
186     /* No fragmentation stuff in the header */
187     break;
188
189   default:
190     /*
191      * Show the fragmentation stuff - flag and sequence ID.
192      *
193      * XXX - on at least some versions of NetBSD, it appears that
194      * we might get ARCNET frames, not reassembled packets; if so,
195      * we should reassemble them.
196      *
197      * XXX - but on FreeBSD it appears that we get reassembled packets
198      * on input (but apparently we get frames on output - or maybe
199      * we get the packet *and* all its frames!); how to tell the
200      * difference?  It looks from the FreeBSD reassembly code as if
201      * the reassembled packet arrives with the header for the first
202      * frame.  It also looks as if, on output, we first get the
203      * full packet, with a header containing none of the fragmentation
204      * stuff, and then get the frames.
205      *
206      * On Linux, we get only reassembled packets, and the exception
207      * frame stuff is hidden - there's a split flag and sequence
208      * number, but it appears that it will never have the exception
209      * frame stuff.
210      *
211      * XXX - what about OpenBSD?  And, for that matter, what about
212      * Windows?  (I suspect Windows supplies reassembled frames,
213      * as WinPcap, like PF_PACKET sockets, taps into the networking
214      * stack just as other protocols do.)
215      */
216     split_flag = tvb_get_guint8 (tvb, offset);
217     if (has_exception && split_flag == 0xff) {
218       /* This is an exception packet.  The flag value there is the
219          "this is an exception flag" packet; the next two bytes
220          after it are padding. */
221       if (tree) {
222         proto_tree_add_uint (tree, hf_arcnet_exception_flag, tvb, offset, 1,
223                              split_flag);
224       }
225       offset++;  
226
227       if (tree)
228         proto_tree_add_text (tree, tvb, offset, 2, "Padding");
229       offset += 2;
230
231       /* Another copy of the packet type appears after the padding. */
232       if (tree)
233         proto_tree_add_item (tree, hf_arcnet_protID, tvb, offset, 1, FALSE);
234       offset++;
235
236       /* And after that comes the real split flag. */
237       split_flag = tvb_get_guint8 (tvb, offset);
238     } 
239     if (tree) {
240       proto_tree_add_uint (tree, hf_arcnet_split_flag, tvb, offset, 1,
241                            split_flag);
242     }
243     offset++;
244                           
245     if (tree)
246       proto_tree_add_item (tree, hf_arcnet_sequence, tvb, offset, 2, FALSE);
247     offset += 2;
248
249     break;
250   }
251
252   /* Set the length of the ARCNET header protocol tree item. */
253   if (tree)
254     proto_item_set_len(ti, offset);
255   
256   next_tvb = tvb_new_subset (tvb, offset, -1, -1);
257
258   if (!dissector_try_port (arcnet_dissector_table, protID,
259                            next_tvb, pinfo, tree))
260     {
261       if (check_col (pinfo->cinfo, COL_PROTOCOL))
262         {
263           col_add_fstr (pinfo->cinfo, COL_PROTOCOL, "0x%04x", protID);
264         }
265       call_dissector (data_handle, next_tvb, pinfo, tree);
266     }
267
268 }
269
270 /*
271  * BSD-style ARCNET headers - they don't have the offset field from the
272  * ARCNET hardware packet, but we might get an exception frame header.
273  */
274 static void
275 dissect_arcnet (tvbuff_t * tvb, packet_info * pinfo, proto_tree * tree)
276 {
277         dissect_arcnet_common (tvb, pinfo, tree, FALSE, TRUE);
278 }
279
280 /*
281  * Linux-style ARCNET headers - they *do* have the offset field from the
282  * ARCNET hardware packet, but we should never see an exception frame
283  * header.
284  */
285 static void
286 dissect_arcnet_linux (tvbuff_t * tvb, packet_info * pinfo, proto_tree * tree)
287 {
288         dissect_arcnet_common (tvb, pinfo, tree, TRUE, FALSE);
289 }
290
291 static const value_string arcnet_prot_id_vals[] = {
292   {ARCNET_PROTO_IP_1051,          "RFC 1051 IP"},
293   {ARCNET_PROTO_ARP_1051,         "RFC 1051 ARP"},
294   {ARCNET_PROTO_IP_1201,          "RFC 1201 IP"},
295   {ARCNET_PROTO_ARP_1201,         "RFC 1201 ARP"},
296   {ARCNET_PROTO_RARP_1201,        "RFC 1201 RARP"},
297   {ARCNET_PROTO_IPX,              "IPX"},
298   {ARCNET_PROTO_NOVELL_EC,        "Novell of some sort"},
299   {ARCNET_PROTO_IPv6,             "IPv6"},
300   {ARCNET_PROTO_ETHERNET,         "Encapsulated Ethernet"},
301   {ARCNET_PROTO_DATAPOINT_BOOT,   "Datapoint boot"},
302   {ARCNET_PROTO_DATAPOINT_MOUNT,  "Datapoint mount"},
303   {ARCNET_PROTO_POWERLAN_BEACON,  "PowerLAN beacon"},
304   {ARCNET_PROTO_POWERLAN_BEACON2, "PowerLAN beacon2"},
305   {ARCNET_PROTO_APPLETALK,        "Appletalk"},
306   {ARCNET_PROTO_BANYAN,           "Banyan VINES"},
307   {ARCNET_PROTO_DIAGNOSE,         "Diagnose"},
308   {ARCNET_PROTO_BACNET,           "BACnet"},
309   {0,                             NULL}
310 };
311
312 void
313 proto_register_arcnet (void)
314 {
315
316 /* Setup list of header fields  See Section 1.6.1 for details*/
317   static hf_register_info hf[] = {
318     {&hf_arcnet_src,
319      {"Source", "arcnet.src",
320       FT_UINT8, BASE_HEX, NULL, 0,
321       "Source ID", HFILL}
322      },
323     {&hf_arcnet_dst,
324      {"Dest", "arcnet.dst",
325       FT_UINT8, BASE_HEX, NULL, 0,
326       "Dest ID", HFILL}
327      },
328     {&hf_arcnet_offset,
329      {"Offset", "arcnet.offset",
330       FT_BYTES, BASE_NONE, NULL, 0,
331       "Offset", HFILL}
332      },
333     {&hf_arcnet_protID,
334      {"Protocol ID", "arcnet.protID",
335       FT_UINT8, BASE_HEX, VALS(arcnet_prot_id_vals), 0,
336       "Proto type", HFILL}
337      },
338     {&hf_arcnet_split_flag,
339      {"Split Flag", "arcnet.split_flag",
340       FT_UINT8, BASE_DEC, NULL, 0,
341       "Split flag", HFILL}
342      },
343     {&hf_arcnet_exception_flag,
344      {"Exception Flag", "arcnet.exception_flag",
345       FT_UINT8, BASE_HEX, NULL, 0,
346       "Exception flag", HFILL}
347      },
348     {&hf_arcnet_sequence,
349      {"Sequence", "arcnet.sequence",
350       FT_UINT16, BASE_DEC, NULL, 0,
351       "Sequence number", HFILL}
352      },
353   };
354
355 /* Setup protocol subtree array */
356   static gint *ett[] = {
357     &ett_arcnet,
358   };
359
360   arcnet_dissector_table = register_dissector_table ("arcnet.protocol_id",
361                                                      "ARCNET Protocol ID",
362                                                      FT_UINT8, BASE_HEX);
363
364 /* Register the protocol name and description */
365   proto_arcnet = proto_register_protocol ("ARCNET", "ARCNET", "arcnet");
366
367 /* Required function calls to register the header fields and subtrees used */
368   proto_register_field_array (proto_arcnet, hf, array_length (hf));
369   proto_register_subtree_array (ett, array_length (ett));
370 }
371
372
373 void
374 proto_reg_handoff_arcnet (void)
375 {
376   dissector_handle_t arcnet_handle, arcnet_linux_handle;
377
378   arcnet_handle = create_dissector_handle (dissect_arcnet, proto_arcnet);
379   dissector_add ("wtap_encap", WTAP_ENCAP_ARCNET, arcnet_handle);
380
381   arcnet_linux_handle = create_dissector_handle (dissect_arcnet_linux,
382                                                  proto_arcnet);
383   dissector_add ("wtap_encap", WTAP_ENCAP_ARCNET_LINUX, arcnet_linux_handle);
384   data_handle = find_dissector ("data");
385 }