Removed trailing whitespaces from .h and .c files using the
[obnox/wireshark/wip.git] / packet-dec-bpdu.c
index 1d95fdfd405e361e4c8dbcf683ad13346956d152..b482a1f353228b608b768739bc00260a78c885e4 100644 (file)
@@ -1,7 +1,7 @@
 /* packet-dec-bpdu.c
  * Routines for DEC BPDU (DEC Spanning Tree Protocol) disassembly
  *
- * $Id: packet-dec-bpdu.c,v 1.10 2002/01/21 07:36:33 guy Exp $
+ * $Id: packet-dec-bpdu.c,v 1.14 2002/08/02 23:35:48 jmayer Exp $
  *
  * Copyright 2001 Paul Ionescu <paul@acorp.ro>
  * 
 # include "config.h"
 #endif
 
-#ifdef HAVE_SYS_TYPES_H
-# include <sys/types.h>
-#endif
-
-#ifdef HAVE_NETINET_IN_H
-# include <netinet/in.h>
-#endif
-
 #include <stdio.h>
 #include <string.h>
 #include <glib.h>
 
 #define DEC_BPDU_SIZE          27
 
+/* Flag bits */
+
+#define BPDU_FLAGS_SHORT_TIMERS                0x80
+#define BPDU_FLAGS_TCACK               0x02
+#define BPDU_FLAGS_TC                  0x01
 
 static int proto_dec_bpdu = -1;
+static int hf_dec_bpdu_proto_id = -1;
+static int hf_dec_bpdu_type = -1;
+static int hf_dec_bpdu_version_id = -1;
+static int hf_dec_bpdu_flags = -1;
+static int hf_dec_bpdu_flags_short_timers = -1;
+static int hf_dec_bpdu_flags_tcack = -1;
+static int hf_dec_bpdu_flags_tc = -1;
+static int hf_dec_bpdu_root_pri = -1;
+static int hf_dec_bpdu_root_mac = -1;
+static int hf_dec_bpdu_root_cost = -1;
+static int hf_dec_bpdu_bridge_pri = -1;
+static int hf_dec_bpdu_bridge_mac = -1;
+static int hf_dec_bpdu_port_id = -1;
+static int hf_dec_bpdu_msg_age = -1;
+static int hf_dec_bpdu_hello_time = -1;
+static int hf_dec_bpdu_max_age = -1;
+static int hf_dec_bpdu_forward_delay = -1;
 
 static gint ett_dec_bpdu = -1;
+static gint ett_dec_bpdu_flags = -1;
+
+static const value_string protocol_id_vals[] = {
+       { 0xe1, "DEC Spanning Tree Protocol" },
+       { 0,    NULL }
+};
+
+#define BPDU_TYPE_TOPOLOGY_CHANGE      2
+#define BPDU_TYPE_HELLO                        25
+
+static const value_string bpdu_type_vals[] = {
+       { BPDU_TYPE_TOPOLOGY_CHANGE, "Topology Change Notification" },
+       { BPDU_TYPE_HELLO,           "Hello Packet" },
+       { 0,                         NULL }
+};
+
+static const char initial_sep[] = " (";
+static const char cont_sep[] = ", ";
+
+#define APPEND_BOOLEAN_FLAG(flag, item, string) \
+       if(flag){                                                       \
+               if(item)                                                \
+                       proto_item_append_text(item, string, sep);      \
+               sep = cont_sep;                                         \
+       }
 
 static void
-dissect_dec_bpdu(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree) {
-      guint8  protocol_identifier;
+dissect_dec_bpdu(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
+{
       guint8  protocol_version;
       guint8  bpdu_type;
       guint8  flags;
       proto_tree *bpdu_tree;
+      proto_tree *flags_tree;
       proto_item *ti;
+      const char *sep;
 
       if (check_col(pinfo->cinfo, COL_PROTOCOL)) {
            col_set_str(pinfo->cinfo, COL_PROTOCOL, "DEC_STP");
@@ -85,79 +126,164 @@ dissect_dec_bpdu(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree) {
       }
 
       bpdu_type = tvb_get_guint8(tvb, BPDU_TYPE);
-      flags=tvb_get_guint8(tvb,BPDU_FLAGS);
       
       if (check_col(pinfo->cinfo, COL_INFO)) {
-           if (bpdu_type == 25)
-                 col_add_fstr(pinfo->cinfo, COL_INFO, "Hello Packet");
-           else if (bpdu_type == 0x02)
-                 col_add_fstr(pinfo->cinfo, COL_INFO, "Topology Change Notification");
+           col_add_str(pinfo->cinfo, COL_INFO,
+                       val_to_str(bpdu_type, bpdu_type_vals,
+                                  "Unknown BPDU type (%u)"));
       }
       
-      tvb_set_reported_length(tvb, DEC_BPDU_SIZE);
+      set_actual_length(tvb, DEC_BPDU_SIZE);
 
       if (tree) {
-           protocol_identifier = tvb_get_guint8(tvb, BPDU_DEC_CODE);
+           ti = proto_tree_add_item(tree, proto_dec_bpdu, tvb, 0, DEC_BPDU_SIZE,
+                               FALSE);
+           bpdu_tree = proto_item_add_subtree(ti, ett_dec_bpdu);
 
            protocol_version = tvb_get_guint8(tvb, BPDU_VERSION);
 
-           ti = proto_tree_add_protocol_format(tree, proto_dec_bpdu, tvb, 0, DEC_BPDU_SIZE,
-                               "DEC Spanning Tree Protocol");
-           bpdu_tree = proto_item_add_subtree(ti, ett_dec_bpdu);
+           proto_tree_add_item(bpdu_tree, hf_dec_bpdu_proto_id, tvb,
+                               BPDU_DEC_CODE, 1, FALSE);
+
+           proto_tree_add_uint(bpdu_tree, hf_dec_bpdu_type, tvb,
+                               BPDU_TYPE, 1, bpdu_type);
+
+           proto_tree_add_item(bpdu_tree, hf_dec_bpdu_version_id, tvb,
+                               BPDU_VERSION, 1, FALSE);
 
-           proto_tree_add_text(bpdu_tree, tvb, BPDU_DEC_CODE, 1, "Protocol ID: 0x%02x (%s)",
-                protocol_identifier,
-                protocol_identifier==0xe1?"DEC Spanning Tree Protocol":
-                "Unknown protocol, the dissection may be wrong");
-
-           proto_tree_add_text(bpdu_tree, tvb, BPDU_TYPE,1, "BPDU Type: %u (%s)", bpdu_type,
-               (bpdu_type==25?"Hello Packet":(bpdu_type==2?"Topology change notice":"Unknown")));
-
-           proto_tree_add_text(bpdu_tree, tvb, BPDU_VERSION,1, "BPDU Version: %u (%s)",
-               protocol_version,protocol_version==1?"DEC STP Version 1":"Unknown Version");
-
-           proto_tree_add_text(bpdu_tree, tvb, BPDU_FLAGS,1, "Flags: 0x%02x",flags);
-
-           if (flags & 0x80)
-                 proto_tree_add_text(bpdu_tree, tvb, BPDU_FLAGS, 1, "      1... ....  Use short timers");
-           if (flags & 0x02)
-                 proto_tree_add_text(bpdu_tree, tvb, BPDU_FLAGS, 1, "      .... ..1.  Topology Change Acknowledgment");
-           if (flags & 0x01)
-                 proto_tree_add_text(bpdu_tree, tvb, BPDU_FLAGS, 1, "      .... ...1  Topology Change");
-           
-           proto_tree_add_text(bpdu_tree, tvb, BPDU_ROOT_PRI,2, "Root priority: %u",
-               tvb_get_ntohs(tvb,BPDU_ROOT_PRI));
-           proto_tree_add_text(bpdu_tree, tvb, BPDU_ROOT_MAC,6, "Root MAC: %s",
-               ether_to_str(tvb_get_ptr(tvb,BPDU_ROOT_MAC,6)));
-           proto_tree_add_text(bpdu_tree, tvb, BPDU_ROOT_PATH_COST,2, "Root path cost: %u",
-               tvb_get_ntohs(tvb,BPDU_ROOT_PATH_COST));
-           proto_tree_add_text(bpdu_tree, tvb, BPDU_BRIDGE_PRI,2, "Root priority: %u",
-               tvb_get_ntohs(tvb,BPDU_BRIDGE_PRI));
-           proto_tree_add_text(bpdu_tree, tvb, BPDU_BRIDGE_MAC,6, "Root MAC: %s",
-               ether_to_str(tvb_get_ptr(tvb,BPDU_BRIDGE_MAC,6)));
-           proto_tree_add_text(bpdu_tree, tvb, BPDU_PORT_IDENTIFIER,1, "Port identifier: %u",
-               tvb_get_guint8(tvb,BPDU_PORT_IDENTIFIER));
-           proto_tree_add_text(bpdu_tree, tvb, BPDU_MESSAGE_AGE,1, "Age: %u",
-               tvb_get_guint8(tvb,BPDU_MESSAGE_AGE));
-           proto_tree_add_text(bpdu_tree, tvb, BPDU_HELLO_TIME,1, "Hello time: %u",
-               tvb_get_guint8(tvb,BPDU_HELLO_TIME));
-           proto_tree_add_text(bpdu_tree, tvb, BPDU_MAX_AGE,1, "Max Age: %u",
-               tvb_get_guint8(tvb,BPDU_MAX_AGE));
-           proto_tree_add_text(bpdu_tree, tvb, BPDU_FORWARD_DELAY,1, "Forward Delay: %u",
-               tvb_get_guint8(tvb,BPDU_FORWARD_DELAY));
+           flags = tvb_get_guint8(tvb, BPDU_FLAGS);
+           ti = proto_tree_add_uint(bpdu_tree, hf_dec_bpdu_flags, tvb,
+                                    BPDU_FLAGS, 1, flags);
+           flags_tree = proto_item_add_subtree(ti, ett_dec_bpdu_flags);
+           sep = initial_sep;
+           APPEND_BOOLEAN_FLAG(flags & BPDU_FLAGS_SHORT_TIMERS, ti,
+                               "%sUse short timers");
+           proto_tree_add_boolean(flags_tree, hf_dec_bpdu_flags_short_timers, tvb,
+                                  BPDU_FLAGS, 1, flags);
+           APPEND_BOOLEAN_FLAG(flags & BPDU_FLAGS_TCACK, ti,
+                               "%sTopology Change Acknowledgment");
+           proto_tree_add_boolean(flags_tree, hf_dec_bpdu_flags_tcack, tvb,
+                                  BPDU_FLAGS, 1, flags);
+           APPEND_BOOLEAN_FLAG(flags & BPDU_FLAGS_TC, ti,
+                               "%sTopology Change");
+           proto_tree_add_boolean(flags_tree, hf_dec_bpdu_flags_tc, tvb,
+                                  BPDU_FLAGS, 1, flags);
+           if (sep != initial_sep) {
+             /* We put something in; put in the terminating ")" */
+             proto_item_append_text(ti, ")");
+           }
+
+           proto_tree_add_item(bpdu_tree, hf_dec_bpdu_root_pri, tvb,
+                               BPDU_ROOT_PRI, 2, FALSE);
+           proto_tree_add_item(bpdu_tree, hf_dec_bpdu_root_mac, tvb,
+                               BPDU_ROOT_MAC, 6, FALSE);
+           proto_tree_add_item(bpdu_tree, hf_dec_bpdu_root_cost, tvb,
+                               BPDU_ROOT_PATH_COST, 2, FALSE);
+           proto_tree_add_item(bpdu_tree, hf_dec_bpdu_bridge_pri, tvb,
+                               BPDU_BRIDGE_PRI, 2, FALSE);
+           proto_tree_add_item(bpdu_tree, hf_dec_bpdu_bridge_mac, tvb,
+                               BPDU_BRIDGE_MAC, 6, FALSE);
+           proto_tree_add_item(bpdu_tree, hf_dec_bpdu_port_id, tvb,
+                               BPDU_PORT_IDENTIFIER, 1, FALSE);
+           proto_tree_add_item(bpdu_tree, hf_dec_bpdu_msg_age, tvb,
+                               BPDU_MESSAGE_AGE, 1, FALSE);
+           proto_tree_add_item(bpdu_tree, hf_dec_bpdu_hello_time, tvb,
+                               BPDU_HELLO_TIME, 1, FALSE);
+           proto_tree_add_item(bpdu_tree, hf_dec_bpdu_max_age, tvb,
+                               BPDU_MAX_AGE, 1, FALSE);
+           proto_tree_add_item(bpdu_tree, hf_dec_bpdu_forward_delay, tvb,
+                               BPDU_FORWARD_DELAY, 1, FALSE);
 
       }
 }
 
+static const true_false_string yesno = {  
+       "Yes",
+       "No"
+};
+
 void
 proto_register_dec_bpdu(void)
 {
+
+  static hf_register_info hf[] = {
+    { &hf_dec_bpdu_proto_id,
+      { "Protocol Identifier",         "dec_stp.protocol",
+       FT_UINT8,       BASE_HEX,       VALS(&protocol_id_vals), 0x0,
+       "", HFILL }},
+    { &hf_dec_bpdu_type,
+      { "BPDU Type",                   "dec_stp.type",
+       FT_UINT8,       BASE_DEC,       VALS(&bpdu_type_vals),  0x0,
+       "", HFILL }},
+    { &hf_dec_bpdu_version_id,
+      { "BPDU Version",                        "dec_stp.version",
+       FT_UINT8,       BASE_DEC,       NULL,   0x0,
+       "", HFILL }},
+    { &hf_dec_bpdu_flags,
+      { "BPDU flags",                  "dec_stp.flags",
+       FT_UINT8,       BASE_HEX,       NULL,   0x0,
+       "", HFILL }},
+    { &hf_dec_bpdu_flags_short_timers,
+      { "Use short timers",            "dec_stp.flags.short_timers",
+       FT_BOOLEAN,     8,              TFS(&yesno),    BPDU_FLAGS_SHORT_TIMERS,
+       "", HFILL }},
+    { &hf_dec_bpdu_flags_tcack,
+      { "Topology Change Acknowledgment",  "dec_stp.flags.tcack",
+       FT_BOOLEAN,     8,              TFS(&yesno),    BPDU_FLAGS_TCACK,
+       "", HFILL }},
+    { &hf_dec_bpdu_flags_tc,
+      { "Topology Change",             "dec_stp.flags.tc",
+       FT_BOOLEAN,     8,              TFS(&yesno),    BPDU_FLAGS_TC,
+       "", HFILL }},
+    { &hf_dec_bpdu_root_pri,
+      { "Root Priority",               "dec_stp.root.pri",
+       FT_UINT16,      BASE_DEC,       NULL,   0x0,
+       "", HFILL }},
+    { &hf_dec_bpdu_root_mac,
+      { "Root MAC",                    "dec_stp.root.mac",
+       FT_ETHER,       BASE_NONE,      NULL,   0x0,
+       "", HFILL }},
+    { &hf_dec_bpdu_root_cost,
+      { "Root Path Cost",              "dec_stp.root.cost",
+       FT_UINT16,      BASE_DEC,       NULL,   0x0,
+       "", HFILL }},
+    { &hf_dec_bpdu_bridge_pri,
+      { "Bridge Priority",             "dec_stp.bridge.pri",
+       FT_UINT16,      BASE_DEC,       NULL,   0x0,
+       "", HFILL }},
+    { &hf_dec_bpdu_bridge_mac,
+      { "Bridge MAC",                  "dec_stp.bridge.mac",
+       FT_ETHER,       BASE_NONE,      NULL,   0x0,
+       "", HFILL }},
+    { &hf_dec_bpdu_port_id,
+      { "Port identifier",             "dec_stp.port",
+       FT_UINT8,       BASE_DEC,       NULL,   0x0,
+       "", HFILL }},
+    { &hf_dec_bpdu_msg_age,
+      { "Message Age",                 "dec_stp.msg_age",
+       FT_UINT8,       BASE_DEC,       NULL,   0x0,
+       "", HFILL }},
+    { &hf_dec_bpdu_hello_time,
+      { "Hello Time",                  "dec_stp.hello",
+       FT_UINT8,       BASE_DEC,       NULL,   0x0,
+       "", HFILL }},
+    { &hf_dec_bpdu_max_age,
+      { "Max Age",                     "dec_stp.max_age",
+       FT_UINT8,       BASE_DEC,       NULL,   0x0,
+       "", HFILL }},
+    { &hf_dec_bpdu_forward_delay,
+      { "Forward Delay",               "dec_stp.forward",
+       FT_UINT8,       BASE_DEC,       NULL,   0x0,
+       "", HFILL }},
+  };
   static gint *ett[] = {
     &ett_dec_bpdu,
+    &ett_dec_bpdu_flags,
   };
 
   proto_dec_bpdu = proto_register_protocol("DEC Spanning Tree Protocol",
                                           "DEC_STP", "dec_stp");
+  proto_register_field_array(proto_dec_bpdu, hf, array_length(hf));
   proto_register_subtree_array(ett, array_length(ett));
 }