From Martin Regner: fix dissection of non-standard parameters.
[obnox/wireshark/wip.git] / packet-fddi.c
1 /* packet-fddi.c
2  * Routines for FDDI packet disassembly
3  *
4  * Laurent Deniel <laurent.deniel@free.fr>
5  *
6  * $Id: packet-fddi.c,v 1.62 2003/08/29 10:59:09 sahlberg Exp $
7  *
8  * Ethereal - Network traffic analyzer
9  * By Gerald Combs <gerald@ethereal.com>
10  * Copyright 1998 Gerald Combs
11  *
12  * This program is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU General Public License
14  * as published by the Free Software Foundation; either version 2
15  * of the License, or (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25  */
26
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <stdio.h>
32 #include <string.h>
33 #include <glib.h>
34 #include <epan/bitswap.h>
35 #include <epan/packet.h>
36 #include "prefs.h"
37 #include "packet-fddi.h"
38 #include "packet-llc.h"
39 #include "tap.h"
40
41 #include <epan/resolv.h>
42
43 static int proto_fddi = -1;
44 static int hf_fddi_fc = -1;
45 static int hf_fddi_fc_clf = -1;
46 static int hf_fddi_fc_prio = -1;
47 static int hf_fddi_fc_smt_subtype = -1;
48 static int hf_fddi_fc_mac_subtype = -1;
49 static int hf_fddi_dst = -1;
50 static int hf_fddi_src = -1;
51 static int hf_fddi_addr = -1;
52
53 static gint ett_fddi = -1;
54 static gint ett_fddi_fc = -1;
55
56 static int fddi_tap = -1;
57
58 static gboolean fddi_padding = FALSE;
59
60 #define FDDI_PADDING            ((fddi_padding) ? 3 : 0)
61
62 /* FDDI Frame Control values */
63
64 #define FDDI_FC_VOID            0x00            /* Void frame */
65 #define FDDI_FC_NRT             0x80            /* Nonrestricted token */
66 #define FDDI_FC_RT              0xc0            /* Restricted token */
67 #define FDDI_FC_MAC             0xc0            /* MAC frame */
68 #define FDDI_FC_SMT             0x40            /* SMT frame */
69 #define FDDI_FC_SMT_INFO        0x41            /* SMT Info */
70 #define FDDI_FC_SMT_NSA         0x4F            /* SMT Next station adrs */
71 #define FDDI_FC_SMT_MIN         FDDI_FC_SMT_INFO
72 #define FDDI_FC_SMT_MAX         FDDI_FC_SMT_NSA
73 #define FDDI_FC_MAC_MIN         0xc1
74 #define FDDI_FC_MAC_BEACON      0xc2            /* MAC Beacon frame */
75 #define FDDI_FC_MAC_CLAIM       0xc3            /* MAC Claim frame */
76 #define FDDI_FC_MAC_MAX         0xcf
77 #define FDDI_FC_LLC_ASYNC       0x50            /* Async. LLC frame */
78 #define FDDI_FC_LLC_ASYNC_MIN   FDDI_FC_LLC_ASYNC
79 #define FDDI_FC_LLC_ASYNC_DEF   0x54
80 #define FDDI_FC_LLC_ASYNC_MAX   0x5f
81 #define FDDI_FC_LLC_SYNC        0xd0            /* Sync. LLC frame */
82 #define FDDI_FC_LLC_SYNC_MIN    FDDI_FC_LLC_SYNC
83 #define FDDI_FC_LLC_SYNC_MAX    0xd7
84 #define FDDI_FC_IMP_ASYNC       0x60            /* Implementor Async. */
85 #define FDDI_FC_IMP_ASYNC_MIN   FDDI_FC_IMP_ASYNC
86 #define FDDI_FC_IMP_ASYNC_MAX   0x6f
87 #define FDDI_FC_IMP_SYNC        0xe0            /* Implementor Synch. */
88
89 #define FDDI_FC_CLFF            0xF0            /* Class/Length/Format bits */
90 #define FDDI_FC_ZZZZ            0x0F            /* Control bits */
91
92 /*
93  * Async frame ZZZZ bits:
94  */
95 #define FDDI_FC_ASYNC_R         0x08            /* Reserved */
96 #define FDDI_FC_ASYNC_PRI       0x07            /* Priority */
97
98 #define CLFF_BITS(fc)   (((fc) & FDDI_FC_CLFF) >> 4)
99 #define ZZZZ_BITS(fc)   ((fc) & FDDI_FC_ZZZZ)
100
101 static const value_string clf_vals[] = {
102         { CLFF_BITS(FDDI_FC_VOID),      "Void" },
103         { CLFF_BITS(FDDI_FC_SMT),       "SMT" },
104         { CLFF_BITS(FDDI_FC_LLC_ASYNC), "Async LLC" },
105         { CLFF_BITS(FDDI_FC_IMP_ASYNC), "Implementor Async" },
106         { CLFF_BITS(FDDI_FC_NRT),       "Nonrestricted Token" },
107         { CLFF_BITS(FDDI_FC_MAC),       "MAC" },
108         { CLFF_BITS(FDDI_FC_LLC_SYNC),  "Sync LLC" },
109         { CLFF_BITS(FDDI_FC_IMP_SYNC),  "Implementor Sync" },
110         { 0,                            NULL }
111 };
112
113 static const value_string smt_subtype_vals[] = {
114         { ZZZZ_BITS(FDDI_FC_SMT_INFO), "Info" },
115         { ZZZZ_BITS(FDDI_FC_SMT_NSA),  "Next Station Address" },
116         { 0,                           NULL }
117 };
118
119 static const value_string mac_subtype_vals[] = {
120         { ZZZZ_BITS(FDDI_FC_MAC_BEACON), "Beacon" },
121         { ZZZZ_BITS(FDDI_FC_MAC_CLAIM),  "Claim" },
122         { 0,                             NULL }
123 };
124
125 #define FDDI_HEADER_SIZE        13
126
127 /* field positions */
128
129 #define FDDI_P_FC               0
130 #define FDDI_P_DHOST            1
131 #define FDDI_P_SHOST            7
132
133 static dissector_handle_t llc_handle;
134 static dissector_handle_t data_handle;
135
136 static void
137 swap_mac_addr(guint8 *swapped_addr, const guint8 *orig_addr)
138 {
139         int i;
140
141         for (i = 0; i < 6; i++) {
142                 swapped_addr[i] = BIT_SWAP(orig_addr[i]);
143         }
144 }
145
146
147 void
148 capture_fddi(const guchar *pd, int len, packet_counts *ld)
149 {
150   int        offset = 0, fc;
151
152   if (!BYTES_ARE_IN_FRAME(0, len, FDDI_HEADER_SIZE + FDDI_PADDING)) {
153     ld->other++;
154     return;
155   }
156   offset = FDDI_PADDING + FDDI_HEADER_SIZE;
157
158   fc = (int) pd[FDDI_P_FC+FDDI_PADDING];
159
160   switch (fc) {
161
162     /* From now, only 802.2 SNAP (Async. LCC frame) is supported */
163
164     case FDDI_FC_LLC_ASYNC + 0  :
165     case FDDI_FC_LLC_ASYNC + 1  :
166     case FDDI_FC_LLC_ASYNC + 2  :
167     case FDDI_FC_LLC_ASYNC + 3  :
168     case FDDI_FC_LLC_ASYNC + 4  :
169     case FDDI_FC_LLC_ASYNC + 5  :
170     case FDDI_FC_LLC_ASYNC + 6  :
171     case FDDI_FC_LLC_ASYNC + 7  :
172     case FDDI_FC_LLC_ASYNC + 8  :
173     case FDDI_FC_LLC_ASYNC + 9  :
174     case FDDI_FC_LLC_ASYNC + 10 :
175     case FDDI_FC_LLC_ASYNC + 11 :
176     case FDDI_FC_LLC_ASYNC + 12 :
177     case FDDI_FC_LLC_ASYNC + 13 :
178     case FDDI_FC_LLC_ASYNC + 14 :
179     case FDDI_FC_LLC_ASYNC + 15 :
180       capture_llc(pd, offset, len, ld);
181       return;
182     default :
183       ld->other++;
184       return;
185
186   } /* fc */
187
188 } /* capture_fddi */
189
190 static gchar *
191 fddifc_to_str(int fc)
192 {
193   static gchar strbuf[128+1];
194
195   switch (fc) {
196
197   case FDDI_FC_VOID:                    /* Void frame */
198     return "Void frame";
199
200   case FDDI_FC_NRT:                     /* Nonrestricted token */
201     return "Nonrestricted token";
202
203   case FDDI_FC_RT:                      /* Restricted token */
204     return "Restricted token";
205
206   case FDDI_FC_SMT_INFO:                /* SMT Info */
207     return "SMT info";
208
209   case FDDI_FC_SMT_NSA:                 /* SMT Next station adrs */
210     return "SMT Next station address";
211
212   case FDDI_FC_MAC_BEACON:              /* MAC Beacon frame */
213     return "MAC beacon";
214
215   case FDDI_FC_MAC_CLAIM:               /* MAC Claim frame */
216     return "MAC claim token";
217
218   default:
219     switch (fc & FDDI_FC_CLFF) {
220
221     case FDDI_FC_MAC:
222       sprintf(strbuf, "MAC frame, control %x", fc & FDDI_FC_ZZZZ);
223       return strbuf;
224
225     case FDDI_FC_SMT:
226       sprintf(strbuf, "SMT frame, control %x", fc & FDDI_FC_ZZZZ);
227       return strbuf;
228
229     case FDDI_FC_LLC_ASYNC:
230       if (fc & FDDI_FC_ASYNC_R)
231         sprintf(strbuf, "Async LLC frame, control %x", fc & FDDI_FC_ZZZZ);
232       else
233         sprintf(strbuf, "Async LLC frame, priority %d",
234                         fc & FDDI_FC_ASYNC_PRI);
235       return strbuf;
236
237     case FDDI_FC_LLC_SYNC:
238       if (fc & FDDI_FC_ZZZZ) {
239         sprintf(strbuf, "Sync LLC frame, control %x", fc & FDDI_FC_ZZZZ);
240         return strbuf;
241       } else
242         return "Sync LLC frame";
243
244     case FDDI_FC_IMP_ASYNC:
245       sprintf(strbuf, "Implementor async frame, control %x",
246                         fc & FDDI_FC_ZZZZ);
247       return strbuf;
248
249     case FDDI_FC_IMP_SYNC:
250       sprintf(strbuf, "Implementor sync frame, control %x",
251                         fc & FDDI_FC_ZZZZ);
252       return strbuf;
253       break;
254
255     default:
256       return "Unknown frame type";
257     }
258   }
259 }
260
261
262 static void
263 dissect_fddi(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree,
264                 gboolean bitswapped)
265 {
266   proto_tree *fh_tree = NULL;
267   proto_item *ti;
268   gchar      *fc_str;
269   proto_tree *fc_tree;
270   static guchar src[6], dst[6];
271   guchar     src_swapped[6], dst_swapped[6];
272   tvbuff_t   *next_tvb;
273   static fddi_hdr fddihdrs[4];
274   static int fddihdr_num=0;
275   fddi_hdr *fddihdr;
276
277   fddihdr_num++;
278   if(fddihdr_num>=4){
279      fddihdr_num=0;
280   }
281   fddihdr=&fddihdrs[fddihdr_num];
282
283   if (check_col(pinfo->cinfo, COL_PROTOCOL))
284     col_set_str(pinfo->cinfo, COL_PROTOCOL, "FDDI");
285
286   fddihdr->fc = tvb_get_guint8(tvb, FDDI_P_FC + FDDI_PADDING);
287   fc_str = fddifc_to_str(fddihdr->fc);
288
289   if (check_col(pinfo->cinfo, COL_INFO))
290     col_add_str(pinfo->cinfo, COL_INFO, fc_str);
291
292   if (tree) {
293     ti = proto_tree_add_protocol_format(tree, proto_fddi, tvb, 0, FDDI_HEADER_SIZE+FDDI_PADDING,
294                 "Fiber Distributed Data Interface, %s", fc_str);
295     fh_tree = proto_item_add_subtree(ti, ett_fddi);
296     ti = proto_tree_add_uint_format(fh_tree, hf_fddi_fc, tvb, FDDI_P_FC + FDDI_PADDING, 1, fddihdr->fc,
297         "Frame Control: 0x%02x (%s)", fddihdr->fc, fc_str);
298     fc_tree = proto_item_add_subtree(ti, ett_fddi_fc);
299     proto_tree_add_uint(fc_tree, hf_fddi_fc_clf, tvb, FDDI_P_FC + FDDI_PADDING, 1, fddihdr->fc);
300     switch ((fddihdr->fc) & FDDI_FC_CLFF) {
301
302     case FDDI_FC_SMT:
303       proto_tree_add_uint(fc_tree, hf_fddi_fc_smt_subtype, tvb, FDDI_P_FC + FDDI_PADDING, 1, fddihdr->fc);
304       break;
305
306     case FDDI_FC_MAC:
307       if (fddihdr->fc != FDDI_FC_RT)
308         proto_tree_add_uint(fc_tree, hf_fddi_fc_mac_subtype, tvb, FDDI_P_FC + FDDI_PADDING, 1, fddihdr->fc);
309       break;
310
311     case FDDI_FC_LLC_ASYNC:
312       if (!((fddihdr->fc) & FDDI_FC_ASYNC_R))
313         proto_tree_add_uint(fc_tree, hf_fddi_fc_prio, tvb, FDDI_P_FC + FDDI_PADDING, 1, fddihdr->fc);
314       break;
315     }
316   }
317
318   /* Extract the destination address, possibly bit-swapping it. */
319   if (bitswapped)
320     swap_mac_addr(dst, tvb_get_ptr(tvb, FDDI_P_DHOST + FDDI_PADDING, 6));
321   else
322     memcpy(dst, tvb_get_ptr(tvb, FDDI_P_DHOST + FDDI_PADDING, 6), sizeof dst);
323   swap_mac_addr(dst_swapped, tvb_get_ptr(tvb, FDDI_P_DHOST + FDDI_PADDING, 6));
324
325   /* XXX - copy them to some buffer associated with "pi", rather than
326      just making "dst" static? */
327   SET_ADDRESS(&pinfo->dl_dst, AT_ETHER, 6, &dst[0]);
328   SET_ADDRESS(&pinfo->dst, AT_ETHER, 6, &dst[0]);
329   SET_ADDRESS(&fddihdr->dst, AT_ETHER, 6, &dst[0]);
330
331   if (fh_tree) {
332     proto_tree_add_ether(fh_tree, hf_fddi_dst, tvb, FDDI_P_DHOST + FDDI_PADDING, 6, dst);
333     proto_tree_add_ether_hidden(fh_tree, hf_fddi_addr, tvb, FDDI_P_DHOST + FDDI_PADDING, 6, dst);
334
335     /* hide some bit-swapped mac address fields in the proto_tree, just in case */
336     proto_tree_add_ether_hidden(fh_tree, hf_fddi_dst, tvb, FDDI_P_DHOST + FDDI_PADDING, 6, dst_swapped);
337     proto_tree_add_ether_hidden(fh_tree, hf_fddi_addr, tvb, FDDI_P_DHOST + FDDI_PADDING, 6, dst_swapped);
338   }
339
340   /* Extract the source address, possibly bit-swapping it. */
341   if (bitswapped)
342     swap_mac_addr(src, tvb_get_ptr(tvb, FDDI_P_SHOST + FDDI_PADDING, 6));
343   else
344     memcpy(src, tvb_get_ptr(tvb, FDDI_P_SHOST + FDDI_PADDING, 6), sizeof src);
345   swap_mac_addr(src_swapped, tvb_get_ptr(tvb, FDDI_P_SHOST + FDDI_PADDING, 6));
346
347   /* XXX - copy them to some buffer associated with "pi", rather than
348      just making "src" static? */
349   SET_ADDRESS(&pinfo->dl_src, AT_ETHER, 6, &src[0]);
350   SET_ADDRESS(&pinfo->src, AT_ETHER, 6, &src[0]);
351   SET_ADDRESS(&fddihdr->src, AT_ETHER, 6, &src[0]);
352
353   if (fh_tree) {
354       proto_tree_add_ether(fh_tree, hf_fddi_src, tvb, FDDI_P_SHOST + FDDI_PADDING, 6, src);
355       proto_tree_add_ether_hidden(fh_tree, hf_fddi_addr, tvb, FDDI_P_SHOST + FDDI_PADDING, 6, src);
356
357       /* hide some bit-swapped mac address fields in the proto_tree, just in case */
358       proto_tree_add_ether_hidden(fh_tree, hf_fddi_src, tvb, FDDI_P_SHOST + FDDI_PADDING, 6, src_swapped);
359       proto_tree_add_ether_hidden(fh_tree, hf_fddi_addr, tvb, FDDI_P_SHOST + FDDI_PADDING, 6, src_swapped);
360   }
361
362   next_tvb = tvb_new_subset(tvb, FDDI_HEADER_SIZE + FDDI_PADDING, -1, -1);
363
364
365   tap_queue_packet(fddi_tap, pinfo, fddihdr);
366
367   switch (fddihdr->fc) {
368
369     /* From now, only 802.2 SNAP (Async. LCC frame) is supported */
370
371     case FDDI_FC_LLC_ASYNC + 0  :
372     case FDDI_FC_LLC_ASYNC + 1  :
373     case FDDI_FC_LLC_ASYNC + 2  :
374     case FDDI_FC_LLC_ASYNC + 3  :
375     case FDDI_FC_LLC_ASYNC + 4  :
376     case FDDI_FC_LLC_ASYNC + 5  :
377     case FDDI_FC_LLC_ASYNC + 6  :
378     case FDDI_FC_LLC_ASYNC + 7  :
379     case FDDI_FC_LLC_ASYNC + 8  :
380     case FDDI_FC_LLC_ASYNC + 9  :
381     case FDDI_FC_LLC_ASYNC + 10 :
382     case FDDI_FC_LLC_ASYNC + 11 :
383     case FDDI_FC_LLC_ASYNC + 12 :
384     case FDDI_FC_LLC_ASYNC + 13 :
385     case FDDI_FC_LLC_ASYNC + 14 :
386     case FDDI_FC_LLC_ASYNC + 15 :
387       call_dissector(llc_handle, next_tvb, pinfo, tree);
388       return;
389
390     default :
391       call_dissector(data_handle,next_tvb, pinfo, tree);
392       return;
393
394   } /* fc */
395 } /* dissect_fddi */
396
397
398 static void
399 dissect_fddi_bitswapped(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
400 {
401         dissect_fddi(tvb, pinfo, tree, TRUE);
402 }
403
404 static void
405 dissect_fddi_not_bitswapped(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
406 {
407         dissect_fddi(tvb, pinfo, tree, FALSE);
408 }
409
410 void
411 proto_register_fddi(void)
412 {
413         static hf_register_info hf[] = {
414
415                 /*
416                  * XXX - we want this guy to have his own private formatting
417                  * routine, using "fc_to_str()"; if "fc_to_str()" returns
418                  * NULL, just show the hex value, else show the string.
419                  */
420                 { &hf_fddi_fc,
421                 { "Frame Control",      "fddi.fc", FT_UINT8, BASE_HEX, NULL, 0x0,
422                         "", HFILL }},
423
424                 { &hf_fddi_fc_clf,
425                 { "Class/Length/Format", "fddi.fc.clf", FT_UINT8, BASE_HEX, VALS(clf_vals), FDDI_FC_CLFF,
426                         "", HFILL }},
427
428                 { &hf_fddi_fc_prio,
429                 { "Priority", "fddi.fc.prio", FT_UINT8, BASE_DEC, NULL, FDDI_FC_ASYNC_PRI,
430                         "", HFILL }},
431
432                 { &hf_fddi_fc_smt_subtype,
433                 { "SMT Subtype", "fddi.fc.smt_subtype", FT_UINT8, BASE_DEC, VALS(smt_subtype_vals), FDDI_FC_ZZZZ,
434                         "", HFILL }},
435
436                 { &hf_fddi_fc_mac_subtype,
437                 { "MAC Subtype", "fddi.fc.mac_subtype", FT_UINT8, BASE_DEC, VALS(mac_subtype_vals), FDDI_FC_ZZZZ,
438                         "", HFILL }},
439
440                 { &hf_fddi_dst,
441                 { "Destination",        "fddi.dst", FT_ETHER, BASE_NONE, NULL, 0x0,
442                         "Destination Hardware Address", HFILL }},
443
444                 { &hf_fddi_src,
445                 { "Source",             "fddi.src", FT_ETHER, BASE_NONE, NULL, 0x0,
446                         "", HFILL }},
447
448                 { &hf_fddi_addr,
449                 { "Source or Destination Address", "fddi.addr", FT_ETHER, BASE_NONE, NULL, 0x0,
450                         "Source or Destination Hardware Address", HFILL }},
451
452         };
453         static gint *ett[] = {
454                 &ett_fddi,
455                 &ett_fddi_fc,
456         };
457
458         module_t *fddi_module;
459
460         proto_fddi = proto_register_protocol("Fiber Distributed Data Interface",
461             "FDDI", "fddi");
462         proto_register_field_array(proto_fddi, hf, array_length(hf));
463         proto_register_subtree_array(ett, array_length(ett));
464
465         /*
466          * Called from various dissectors for encapsulated FDDI frames.
467          * We assume the MAC addresses in them aren't bitswapped.
468          */
469         register_dissector("fddi", dissect_fddi_not_bitswapped, proto_fddi);
470
471         fddi_module = prefs_register_protocol(proto_fddi, NULL);
472         prefs_register_bool_preference(fddi_module, "padding",
473                 "Add 3-byte padding to all FDDI packets",
474                 "Whether the FDDI dissector should add 3-byte padding to all "
475                 "captured FDDI packets (useful with e.g. Tru64 UNIX tcpdump)",
476                 &fddi_padding);
477
478         fddi_tap = register_tap("fddi");
479 }
480
481 void
482 proto_reg_handoff_fddi(void)
483 {
484         dissector_handle_t fddi_handle, fddi_bitswapped_handle;
485
486         /*
487          * Get a handle for the LLC dissector.
488          */
489         llc_handle = find_dissector("llc");
490         data_handle = find_dissector("data");
491
492         fddi_handle = find_dissector("fddi");
493         dissector_add("wtap_encap", WTAP_ENCAP_FDDI, fddi_handle);
494         fddi_bitswapped_handle =
495             create_dissector_handle(dissect_fddi_bitswapped, proto_fddi);
496         dissector_add("wtap_encap", WTAP_ENCAP_FDDI_BITSWAPPED,
497             fddi_bitswapped_handle);
498 }