Adding 802.1BR E-Tag dissector
authorKim Kempf <kim.kempf@apcon.com>
Tue, 12 Jul 2016 17:28:38 +0000 (10:28 -0700)
committerMichael Mann <mmann78@netscape.net>
Wed, 13 Jul 2016 21:58:38 +0000 (21:58 +0000)
Based on IEEE Std 802.1BR-2012

Bug: 12613
Change-Id: Ic5198471f67a1af728df40a09443a1cab2621169
Reviewed-on: https://code.wireshark.org/review/16402
Reviewed-by: Michael Mann <mmann78@netscape.net>
AUTHORS.src
docbook/release-notes.asciidoc
epan/dissectors/CMakeLists.txt
epan/dissectors/Makefile.am
epan/dissectors/packet-etag.c [new file with mode: 0644]
epan/dissectors/packet-ethertype.c
epan/etypes.h

index 8da77b2cbb1b86fcae3a40753839df61b8de5a6a..c49dd10b9d99ae2faf47edafd3473b0710516d4a 100644 (file)
@@ -3679,6 +3679,10 @@ Sumit Kumar Jha          <sjha3[AT]ncsu.edu> {
        Generic Protocol Extension Support for VXLAN
 }
 
+Kim Kempf              <kim.kempf[AT]apcon.com> {
+       802.1BR E-Tag dissector
+}
+
 and by:
 
 Georgi Guninski                <guninski[AT]guninski.com>
@@ -3931,7 +3935,6 @@ Chidambaram Arunachalam   <carunach[AT]cisco.com>
 João Valverde         <joao.valverde[AT]tecnico.ulisboa.pt>
 Benoît Canet          <benoit[AT]scylladb.com>
 
-
 Acknowledgements
 ------------
 Dan Lasley <dlasley[AT]promus.com> gave permission for his
index a52d444edff7347251a0310d4b638e44c99085d4..d6382a53f3967a2f012e4181eccd5b38948e0acb 100644 (file)
@@ -106,6 +106,7 @@ Bachmann bluecom Protocol
 Apache Cassandra - CQL version 3.0
 Real Time Location System (RTLS)
 Network-Based IP Flow Mobility (NBIFOM)
+IEEE 802.1BR E-Tag
 
 --sort-and-group--
 
index 38e2149ba15e8dd6ab7c89f6e607ab25fdc1f530..120466913f975fbecf266d4758f0c3b239589ad8 100644 (file)
@@ -551,6 +551,7 @@ set(DISSECTOR_SRC
        packet-erldp.c
        packet-esio.c
        packet-esis.c
+       packet-etag.c
        packet-etch.c
        packet-eth.c
        packet-etherip.c
index 70edc66e62a7ad2dfdf66264e7a64fc310d1f93e..45286c9460ecbb57419da6c6de40125c723f042b 100644 (file)
@@ -580,6 +580,7 @@ DISSECTOR_SRC = \
        packet-erldp.c          \
        packet-esio.c           \
        packet-esis.c           \
+       packet-etag.c           \
        packet-etch.c           \
        packet-eth.c            \
        packet-etherip.c        \
diff --git a/epan/dissectors/packet-etag.c b/epan/dissectors/packet-etag.c
new file mode 100644 (file)
index 0000000..98ed113
--- /dev/null
@@ -0,0 +1,252 @@
+/* packet-etag.c
+ *
+ * 802.1BR E-Tag dissector
+ * Inspired by packet-vntag.c
+ *
+ * Copyright 2016 APCON, Inc.
+ * Kim Kempf <kim.kempf@apcon.com>
+ *
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
+ * Copyright 1998 Gerald Combs
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ */
+
+#include "config.h"
+
+#include <epan/packet.h>
+#include <epan/etypes.h>
+#include <epan/prefs.h>
+
+void proto_register_etag(void);
+void proto_reg_handoff_etag(void);
+
+static dissector_handle_t ethertype_handle;
+
+static int proto_etag = -1;
+
+static gboolean etag_summary_in_tree = TRUE;
+
+static int hf_etag_etype = -1;
+static int hf_etag_pcp = -1;
+static int hf_etag_dei = -1;
+static int hf_etag_res = -1;
+static int hf_etag_grp = -1;
+static int hf_etag_iecid_base = -1;
+static int hf_etag_iecid_ext = -1;
+static int hf_etag_ecid_base = -1;
+static int hf_etag_ecid_ext = -1;
+
+static int hf_etag_trailer = -1;
+
+static gint ett_etag = -1;
+
+#define IEEE8021BR_LEN 8    /* length including ethertype */
+
+/* From Table G-2 of IEEE standard 802.1D-2004 */
+static const value_string pri_vals[] = {
+    { 1, "Background"                        },
+    { 2, "Spare"                             },
+    { 0, "Best Effort (default)"             },
+    { 3, "Excellent Effort"                  },
+    { 4, "Controlled Load"                   },
+    { 5, "Video, < 100ms latency and jitter" },
+    { 6, "Voice, < 10ms latency and jitter"  },
+    { 7, "Network Control"                   },
+    { 0, NULL                                }
+};
+
+
+static const value_string grp_vals[] = {
+    { 0, "Point-to-point"                    },
+    { 1, "Point-to-multipoint"               },
+    { 2, "Point-to-multipoint"               },
+    { 3, "Point-to-multipoint"               },
+    { 0, NULL                                }
+};
+
+/*
+    From 801.2BR 7.5 E-TAG Control Information
+    0                   1
+    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
+    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    |                               |
+    |                               |
+    |      E-Tag EtherType          |
+    |          0x893F               |
+    |                               |
+    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    |     |E|                       |
+    |     |-|                       |
+    |E-PCP|D|  Ingress_E-CID_base   |
+    |     |E|                       |
+    |     |I|                       |
+    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    |   |   |                       |
+    | R | G |                       |
+    | E | R |  E-CID_base           |
+    | S | P |                       |
+    | V |   |                       |
+    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+    |               |               |
+    |               |               |
+    |Ingress_E-CID_ |  E_CID_ext    |
+    |     ext       |               |
+    |               |               |
+    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+*/
+
+static int
+dissect_etag(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data _U_)
+{
+    guint16     encap_proto;
+    proto_tree *etag_tree = NULL;
+    ethertype_data_t ethertype_data;
+
+    guint64 tci;
+
+    /* Decoding per IEEE802.1BR-2012 */
+    static const int * fields1[] = {
+        &hf_etag_pcp,
+        &hf_etag_dei,
+        &hf_etag_iecid_base,
+        NULL
+    };
+
+    static const int * fields2[] = {
+        &hf_etag_res,
+        &hf_etag_grp,
+        &hf_etag_ecid_base,
+        NULL
+    };
+
+    tci = tvb_get_ntoh48( tvb, 0);
+
+    col_set_str(pinfo->cinfo, COL_PROTOCOL, "ETAG");
+    col_clear(pinfo->cinfo, COL_INFO);
+
+    if (tree) {
+        guint32 e_cid, ing_e_cid;
+
+        proto_item *ti = proto_tree_add_item(tree, proto_etag, tvb, 0, IEEE8021BR_LEN - 2, ENC_NA);
+
+        e_cid =     (((tci >> 16) & 0xFFF) |  (tci << 12))            & 0xFFFFF;    /* E-CID_base | E-CID_ext */
+        ing_e_cid = (((tci >> 32) & 0xFFF) | ((tci <<  4) & 0xFF000)) & 0xFFFFF;    /* Ingress_E-CID_base | Ingress_E-CID ext */
+
+        if (etag_summary_in_tree) {
+            proto_item_append_text(ti, ", TCI: 0x%" G_GINT64_MODIFIER "x Ingress_E-CID: %u E-CID: %u", tci, ing_e_cid, e_cid);
+        }
+        etag_tree = proto_item_add_subtree(ti, ett_etag);
+
+        proto_tree_add_bitmask_list(etag_tree, tvb, 0, 2, fields1, ENC_BIG_ENDIAN);
+        proto_tree_add_bitmask_list(etag_tree, tvb, 2, 2, fields2, ENC_BIG_ENDIAN);
+
+        proto_tree_add_item(etag_tree, hf_etag_iecid_ext, tvb, 4, 1, ENC_BIG_ENDIAN);
+        proto_tree_add_item(etag_tree, hf_etag_ecid_ext, tvb, 5, 1, ENC_BIG_ENDIAN);
+    }
+
+    encap_proto = tvb_get_ntohs(tvb, IEEE8021BR_LEN - 2);
+
+    ethertype_data.etype = encap_proto;
+    ethertype_data.offset_after_ethertype = IEEE8021BR_LEN;
+    ethertype_data.fh_tree = etag_tree;
+    ethertype_data.etype_id = hf_etag_etype;
+    ethertype_data.trailer_id = hf_etag_trailer;
+    ethertype_data.fcs_len = 0;
+
+    call_dissector_with_data(ethertype_handle, tvb, pinfo, tree, &ethertype_data);
+
+    return tvb_captured_length(tvb);
+}
+
+void
+proto_register_etag(void)
+{
+    static hf_register_info hf[] = {
+        { &hf_etag_pcp,
+            { "E-PCP", "etag.pcp", FT_UINT16, BASE_DEC, VALS(pri_vals), 0xE000,
+                "Descriptions are recommendations from IEEE standard 802.1D-2004", HFILL }
+        },
+        { &hf_etag_dei,
+            { "E-DEI", "etag.dei", FT_UINT16, BASE_DEC, NULL, 0x1000, NULL, HFILL }
+        },
+        { &hf_etag_iecid_base,
+            { "Ingress_E-CID_base", "etag.iecid_base", FT_UINT16, BASE_HEX, NULL, 0x0FFF, NULL, HFILL }
+        },
+        { &hf_etag_res,
+            { "Reserved", "etag.resv", FT_UINT16, BASE_DEC, NULL, 0xC000, NULL, HFILL }
+        },
+        { &hf_etag_grp,
+            { "GRP", "etag.group", FT_UINT16, BASE_DEC, VALS(grp_vals), 0x3000, NULL, HFILL }
+        },
+        { &hf_etag_ecid_base,
+            { "E-CID_base", "etag.ecid_base", FT_UINT16, BASE_HEX, NULL, 0xFFF, NULL, HFILL }
+        },
+        { &hf_etag_iecid_ext,
+            { "Ingress_E-CID_ext", "etag.iecid_ext", FT_UINT8, BASE_HEX, NULL, 0, NULL, HFILL }
+        },
+        { &hf_etag_ecid_ext,
+            { "E-CID_ext", "etag.ecid_ext", FT_UINT8, BASE_HEX, NULL, 0, NULL, HFILL }
+        },
+        { &hf_etag_etype,
+            { "Type", "etag.etype", FT_UINT16, BASE_HEX, VALS(etype_vals), 0x0, NULL, HFILL }
+        },
+        { &hf_etag_trailer,
+            { "Trailer", "etag.trailer", FT_BYTES, BASE_NONE, NULL, 0x0, NULL, HFILL }
+        },
+    };
+
+    static gint *ett[] = {
+        &ett_etag
+    };
+
+    module_t *etag_module;
+
+    proto_etag = proto_register_protocol("802.1BR E-Tag", "ETAG", "etag");
+    proto_register_field_array(proto_etag, hf, array_length(hf));
+    proto_register_subtree_array(ett, array_length(ett));
+
+    etag_module = prefs_register_protocol(proto_etag, proto_reg_handoff_etag);
+        prefs_register_bool_preference(etag_module, "summary_in_tree",
+        "Show E-Tag summary in protocol tree",
+        "Whether the E-Tag summary line should be shown in the protocol tree",
+        &etag_summary_in_tree);
+}
+
+void
+proto_reg_handoff_etag(void)
+{
+    dissector_handle_t etag_handle;
+
+    etag_handle = create_dissector_handle(dissect_etag, proto_etag);
+    dissector_add_uint("ethertype", ETHERTYPE_IEEE_802_1BR, etag_handle);
+
+    ethertype_handle = find_dissector_add_dependency("ethertype", proto_etag);
+}
+
+/*
+ * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
+ *
+ * Local variables:
+ * c-basic-offset: 4
+ * tab-width: 8
+ * indent-tabs-mode: t
+ * End:
+ *
+ * vi: set shiftwidth=8 tabstop=8 noexpandtab:
+ * :indentSize=8:tabSize=8:noTabs=false:
+ */
index e39ce84b59c8118bde9fbacb8dd136c62737d3b4..f5a2057d4bc97a206aa18517393520f9b07f7af1 100644 (file)
@@ -85,6 +85,7 @@ const value_string etype_vals[] = {
        { ETHERTYPE_HOMEPLUG_AV,          "Homeplug AV" },
        { ETHERTYPE_IEEE_802_1AD,         "802.1ad Provider Bridge (Q-in-Q)" },
        { ETHERTYPE_IEEE_802_1AH,         "802.1ah Provider Backbone Bridge (mac-in-mac)" },
+       { ETHERTYPE_IEEE_802_1BR,         "802.1br Bridge Port Extension E-Tag" },
        { ETHERTYPE_EAPOL,                "802.1X Authentication" },
        { ETHERTYPE_RSN_PREAUTH,          "802.11i Pre-Authentication" },
        { ETHERTYPE_MPLS,                 "MPLS label switched packet" },
index 67d668e1508d6300be24b41f91527948560d9abc..2e5acc7c80b36df8041b18fc29def2ae7e243770 100644 (file)
@@ -545,6 +545,10 @@ extern "C" {
 #define ETHERTYPE_HSR                  0x892F  /* High-availability Seamless Redundancy (IEC62439 Part 3) */
 #endif
 
+#ifndef ETHERTYPE_IEEE_802_1BR
+#define ETHERTYPE_IEEE_802_1BR         0x893F  /* IEEE 802.1br E-Tag, Bridge Port Extension */
+#endif
+
 #ifndef ETHERTYPE_ECP
 #define ETHERTYPE_ECP                  0x8940  /* Edge Control Protocol */
 #endif