Don't guard col_set_str (COL_INFO) with col_check
[metze/wireshark/wip.git] / epan / dissectors / 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$
6  *
7  * Wireshark - Network traffic analyzer
8  * By Gerald Combs <gerald@wireshark.org>
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 <epan/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 ? 4 : 2;
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   case ARCNET_PROTO_IPX:
126     ld->ipx++;
127     break;
128
129   default:
130     ld->other++;
131     break;
132   }
133 }
134
135 static void
136 dissect_arcnet_common (tvbuff_t * tvb, packet_info * pinfo, proto_tree * tree,
137                        gboolean has_offset, gboolean has_exception)
138 {
139   int offset = 0;
140   guint8 dst, src, protID, split_flag;
141   tvbuff_t *next_tvb;
142   proto_item *ti = NULL;
143   proto_tree *arcnet_tree = NULL;
144
145   col_set_str (pinfo->cinfo, COL_PROTOCOL, "ARCNET");
146
147   col_set_str(pinfo->cinfo, COL_INFO, "ARCNET");
148
149   src = tvb_get_guint8 (tvb, 0);
150   dst = tvb_get_guint8 (tvb, 1);
151   SET_ADDRESS(&pinfo->dl_src,   AT_ARCNET, 1, tvb_get_ptr(tvb, 0, 1));
152   SET_ADDRESS(&pinfo->src,      AT_ARCNET, 1, tvb_get_ptr(tvb, 0, 1));
153   SET_ADDRESS(&pinfo->dl_dst,   AT_ARCNET, 1, tvb_get_ptr(tvb, 1, 1));
154   SET_ADDRESS(&pinfo->dst,      AT_ARCNET, 1, tvb_get_ptr(tvb, 1, 1));
155
156   if (tree)
157     {
158       ti =
159         proto_tree_add_item (tree, proto_arcnet, tvb, 0, -1, FALSE);
160
161       arcnet_tree = proto_item_add_subtree (ti, ett_arcnet);
162
163       proto_tree_add_uint (tree, hf_arcnet_src, tvb, offset, 1, src);
164     }
165   offset++;
166
167   if (tree)
168       proto_tree_add_uint (tree, hf_arcnet_dst, tvb, offset, 1, dst);
169   offset++;
170
171   if (has_offset) {
172     if (tree)
173         proto_tree_add_item (tree, hf_arcnet_offset, tvb, offset, 2, FALSE);
174     offset += 2;
175   }
176
177   protID = tvb_get_guint8 (tvb, offset);
178   if (tree)
179       proto_tree_add_uint (tree, hf_arcnet_protID, tvb, offset, 1, protID);
180   offset++;
181
182   switch (protID) {
183
184   case ARCNET_PROTO_IP_1051:
185   case ARCNET_PROTO_ARP_1051:
186   case ARCNET_PROTO_DIAGNOSE:
187   case ARCNET_PROTO_BACNET:     /* XXX - no fragmentation? */
188     /* No fragmentation stuff in the header */
189     break;
190
191   default:
192     /*
193      * Show the fragmentation stuff - flag and sequence ID.
194      *
195      * XXX - on at least some versions of NetBSD, it appears that
196      * we might get ARCNET frames, not reassembled packets; if so,
197      * we should reassemble them.
198      *
199      * XXX - but on FreeBSD it appears that we get reassembled packets
200      * on input (but apparently we get frames on output - or maybe
201      * we get the packet *and* all its frames!); how to tell the
202      * difference?  It looks from the FreeBSD reassembly code as if
203      * the reassembled packet arrives with the header for the first
204      * frame.  It also looks as if, on output, we first get the
205      * full packet, with a header containing none of the fragmentation
206      * stuff, and then get the frames.
207      *
208      * On Linux, we get only reassembled packets, and the exception
209      * frame stuff is hidden - there's a split flag and sequence
210      * number, but it appears that it will never have the exception
211      * frame stuff.
212      *
213      * XXX - what about OpenBSD?  And, for that matter, what about
214      * Windows?  (I suspect Windows supplies reassembled frames,
215      * as WinPcap, like PF_PACKET sockets, taps into the networking
216      * stack just as other protocols do.)
217      */
218     split_flag = tvb_get_guint8 (tvb, offset);
219     if (has_exception && split_flag == 0xff) {
220       /* This is an exception packet.  The flag value there is the
221          "this is an exception flag" packet; the next two bytes
222          after it are padding. */
223       if (tree) {
224         proto_tree_add_uint (tree, hf_arcnet_exception_flag, tvb, offset, 1,
225                              split_flag);
226       }
227       offset++;  
228
229       if (tree)
230         proto_tree_add_text (tree, tvb, offset, 2, "Padding");
231       offset += 2;
232
233       /* Another copy of the packet type appears after the padding. */
234       if (tree)
235         proto_tree_add_item (tree, hf_arcnet_protID, tvb, offset, 1, FALSE);
236       offset++;
237
238       /* And after that comes the real split flag. */
239       split_flag = tvb_get_guint8 (tvb, offset);
240     } 
241     if (tree) {
242       proto_tree_add_uint (tree, hf_arcnet_split_flag, tvb, offset, 1,
243                            split_flag);
244     }
245     offset++;
246                           
247     if (tree)
248       proto_tree_add_item (tree, hf_arcnet_sequence, tvb, offset, 2, FALSE);
249     offset += 2;
250
251     break;
252   }
253
254   /* Set the length of the ARCNET header protocol tree item. */
255   if (tree)
256     proto_item_set_len(ti, offset);
257   
258   next_tvb = tvb_new_subset (tvb, offset, -1, -1);
259
260   if (!dissector_try_port (arcnet_dissector_table, protID,
261                            next_tvb, pinfo, tree))
262     {
263       if (check_col (pinfo->cinfo, COL_PROTOCOL))
264         {
265           col_add_fstr (pinfo->cinfo, COL_PROTOCOL, "0x%04x", protID);
266         }
267       call_dissector (data_handle, next_tvb, pinfo, tree);
268     }
269
270 }
271
272 /*
273  * BSD-style ARCNET headers - they don't have the offset field from the
274  * ARCNET hardware packet, but we might get an exception frame header.
275  */
276 static void
277 dissect_arcnet (tvbuff_t * tvb, packet_info * pinfo, proto_tree * tree)
278 {
279         dissect_arcnet_common (tvb, pinfo, tree, FALSE, TRUE);
280 }
281
282 /*
283  * Linux-style ARCNET headers - they *do* have the offset field from the
284  * ARCNET hardware packet, but we should never see an exception frame
285  * header.
286  */
287 static void
288 dissect_arcnet_linux (tvbuff_t * tvb, packet_info * pinfo, proto_tree * tree)
289 {
290         dissect_arcnet_common (tvb, pinfo, tree, TRUE, FALSE);
291 }
292
293 static const value_string arcnet_prot_id_vals[] = {
294   {ARCNET_PROTO_IP_1051,          "RFC 1051 IP"},
295   {ARCNET_PROTO_ARP_1051,         "RFC 1051 ARP"},
296   {ARCNET_PROTO_IP_1201,          "RFC 1201 IP"},
297   {ARCNET_PROTO_ARP_1201,         "RFC 1201 ARP"},
298   {ARCNET_PROTO_RARP_1201,        "RFC 1201 RARP"},
299   {ARCNET_PROTO_IPX,              "IPX"},
300   {ARCNET_PROTO_NOVELL_EC,        "Novell of some sort"},
301   {ARCNET_PROTO_IPv6,             "IPv6"},
302   {ARCNET_PROTO_ETHERNET,         "Encapsulated Ethernet"},
303   {ARCNET_PROTO_DATAPOINT_BOOT,   "Datapoint boot"},
304   {ARCNET_PROTO_DATAPOINT_MOUNT,  "Datapoint mount"},
305   {ARCNET_PROTO_POWERLAN_BEACON,  "PowerLAN beacon"},
306   {ARCNET_PROTO_POWERLAN_BEACON2, "PowerLAN beacon2"},
307   {ARCNET_PROTO_APPLETALK,        "Appletalk"},
308   {ARCNET_PROTO_BANYAN,           "Banyan VINES"},
309   {ARCNET_PROTO_DIAGNOSE,         "Diagnose"},
310   {ARCNET_PROTO_BACNET,           "BACnet"},
311   {0,                             NULL}
312 };
313
314 void
315 proto_register_arcnet (void)
316 {
317
318 /* Setup list of header fields  See Section 1.6.1 for details*/
319   static hf_register_info hf[] = {
320     {&hf_arcnet_src,
321      {"Source", "arcnet.src",
322       FT_UINT8, BASE_HEX, NULL, 0,
323       "Source ID", HFILL}
324      },
325     {&hf_arcnet_dst,
326      {"Dest", "arcnet.dst",
327       FT_UINT8, BASE_HEX, NULL, 0,
328       "Dest ID", HFILL}
329      },
330     {&hf_arcnet_offset,
331      {"Offset", "arcnet.offset",
332       FT_BYTES, BASE_NONE, NULL, 0,
333       NULL, HFILL}
334      },
335     {&hf_arcnet_protID,
336      {"Protocol ID", "arcnet.protID",
337       FT_UINT8, BASE_HEX, VALS(arcnet_prot_id_vals), 0,
338       "Proto type", HFILL}
339      },
340     {&hf_arcnet_split_flag,
341      {"Split Flag", "arcnet.split_flag",
342       FT_UINT8, BASE_DEC, NULL, 0,
343       "Split flag", HFILL}
344      },
345     {&hf_arcnet_exception_flag,
346      {"Exception Flag", "arcnet.exception_flag",
347       FT_UINT8, BASE_HEX, NULL, 0,
348       "Exception flag", HFILL}
349      },
350     {&hf_arcnet_sequence,
351      {"Sequence", "arcnet.sequence",
352       FT_UINT16, BASE_DEC, NULL, 0,
353       "Sequence number", HFILL}
354      },
355   };
356
357 /* Setup protocol subtree array */
358   static gint *ett[] = {
359     &ett_arcnet,
360   };
361
362   arcnet_dissector_table = register_dissector_table ("arcnet.protocol_id",
363                                                      "ARCNET Protocol ID",
364                                                      FT_UINT8, BASE_HEX);
365
366 /* Register the protocol name and description */
367   proto_arcnet = proto_register_protocol ("ARCNET", "ARCNET", "arcnet");
368
369 /* Required function calls to register the header fields and subtrees used */
370   proto_register_field_array (proto_arcnet, hf, array_length (hf));
371   proto_register_subtree_array (ett, array_length (ett));
372 }
373
374
375 void
376 proto_reg_handoff_arcnet (void)
377 {
378   dissector_handle_t arcnet_handle, arcnet_linux_handle;
379
380   arcnet_handle = create_dissector_handle (dissect_arcnet, proto_arcnet);
381   dissector_add ("wtap_encap", WTAP_ENCAP_ARCNET, arcnet_handle);
382
383   arcnet_linux_handle = create_dissector_handle (dissect_arcnet_linux,
384                                                  proto_arcnet);
385   dissector_add ("wtap_encap", WTAP_ENCAP_ARCNET_LINUX, arcnet_linux_handle);
386   data_handle = find_dissector ("data");
387 }