osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity
wireshark/epan/dissectors/packet-cpfi.c

549 lines
17 KiB
C
Raw Permalink Blame History

/* packet-cpfi.c
* Routines for CPFI Cross Point Frame Injector dissection
* CPFI - Cross Point Frame Injector is a CNT proprietary
* protocol used to carry Fibre Channel data over UDP
*
* Copyright 2003, Dave Sclarsky <dave_sclarsky[AT]cnt.com>
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* Copied from packet-m2tp.c
* Thanks to Heinz Prantner for his motivation and assistance
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "config.h"
#include <epan/packet.h>
#include <epan/prefs.h>
#include "packet-fc.h"
void proto_register_cpfi(void);
void proto_reg_handoff_cpfi(void);
#define CPFI_DEFAULT_UDP_PORT 5000 /* Not IANA registered */
#define CPFI_DEFAULT_TTOT_UDP_PORT 5001 /* Not IANA registered */
#define FIRST_TIO_CARD_ADDRESS 0x380
/* SOF defines */
#define CPFI_FRAME_TYPE_MASK 0xF0000000
#define CPFI_FRAME_TYPE_SHIFT 28
#define CPFI_SOURCE_MASK 0x0FFC0000
#define CPFI_SOURCE_SHIFT 18
#define CPFI_DEST_MASK 0x0003FF00
#define CPFI_DEST_SHIFT 8
#define CPFI_SOF_TYPE_MASK 0x000000F0
#define CPFI_SPEED_MASK 0x0000000C
#define CPFI_OPM_ERROR_MASK 0x00000002
#define CPFI_FROM_LCM_MASK 0x00000001
/* EOF defines */
#define CPFI_EOF_TYPE_MASK 0x78000000
#define CPFI_EOF_ERROR_MASK 0x7FE00000
/* configurable parameters */
static guint gbl_cpfi_ttot_udp_port = CPFI_DEFAULT_TTOT_UDP_PORT;
static gboolean cpfi_arrow_moves = TRUE;
/* Initialize the protocol and registered fields */
static int proto_cpfi = -1;
static int hf_cpfi_word_one = -1;
static int hf_cpfi_word_two = -1;
/* SOF word 1: */
static int hf_cpfi_frame_type = -1;
static int hf_cpfi_source = -1;
static int hf_cpfi_dest = -1;
static int hf_cpfi_SOF_type = -1;
static int hf_cpfi_speed = -1;
static int hf_cpfi_OPM_error = -1;
static int hf_cpfi_from_LCM = -1;
/* EOF */
static int hf_cpfi_CRC_32 = -1;
static int hf_cpfi_EOF_type = -1;
/* Hidden items */
static int hf_cpfi_t_instance = -1;
static int hf_cpfi_t_src_instance = -1;
static int hf_cpfi_t_dst_instance = -1;
static int hf_cpfi_t_board = -1;
static int hf_cpfi_t_src_board = -1;
static int hf_cpfi_t_dst_board = -1;
static int hf_cpfi_t_port = -1;
static int hf_cpfi_t_src_port = -1;
static int hf_cpfi_t_dst_port = -1;
static char src_str[20];
static char dst_str[20];
static const char l_to_r_arrow[] = "-->";
static const char r_to_l_arrow[] = "<--";
static const char *left = src_str;
static const char *right = dst_str;
static const char *arrow = l_to_r_arrow;
static const char direction_and_port_string[] = "[%s %s %s] ";
/* Initialize the subtree pointers */
static gint ett_cpfi = -1;
static gint ett_cpfi_header = -1;
static gint ett_cpfi_footer = -1;
static dissector_handle_t fc_handle;
static const value_string sof_type_vals[] = {
{0, "SOFf"},
{1, "SOFi2"},
{2, "SOFn2"},
{3, "SOFi3"},
{4, "SOFn3"},
{5, "SOFc1"},
{6, "SOFi1"},
{7, "SOFn1"},
{8, "SOFc4"},
{9, "SOFi4"},
{10, "SOFn4"},
{0, NULL},
};
static const value_string speed_vals[] = {
{0, "1 GBIT"},
{1, "2 GBIT"},
{2, "4 GBIT"},
{3, "10 GBIT"},
{0, NULL},
};
static const value_string eof_type_vals[] = {
{0, "EOFn"},
{1, "EOFt"},
{2, "EOFni"},
{3, "EOFa"},
{4, "EOFdt"},
{5, "EOFdti"},
{6, "EOFrt"},
{7, "EOFrti"},
{0, NULL},
};
/* Header */
static void
dissect_cpfi_header(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
{
guint32 word1;
#if 0
guint32 word2;
#endif
guint32 tda;
guint32 src;
guint8 src_instance = 0;
guint8 src_board = 0;
guint8 src_port = 0;
guint32 dst;
guint8 dst_instance = 0;
guint8 dst_board = 0;
guint8 dst_port = 0;
proto_tree *extra_tree = NULL;
/* add a tree for the header */
if ( tree != NULL)
{
proto_item *extra_item;
extra_item = proto_tree_add_protocol_format(tree, proto_cpfi, tvb, 0, -1, "Header");
extra_tree = proto_item_add_subtree(extra_item, ett_cpfi_header);
}
/* Extract the common header, and get the bits we need */
word1 = tvb_get_ntohl (tvb, 0);
#if 0
word2 = tvb_get_ntohl (tvb, sizeof(word1));
#endif
/* Figure out where the frame came from. dstTDA is source of frame! */
tda = (word1 & CPFI_DEST_MASK) >> CPFI_DEST_SHIFT;
if ( tda >= FIRST_TIO_CARD_ADDRESS )
{
(void) g_strlcpy(src_str, " CPFI", sizeof(src_str));
src = 0; /* Make it smallest */
}
else
{
const guint8 *srcmac;
/* Make sure this is an Ethernet address. */
DISSECTOR_ASSERT(pinfo->src.type == AT_ETHER);
srcmac = (const guint8 *)pinfo->src.data;
src_instance = srcmac[2]-1;
src_board = tda >> 4;
src_port = tda & 0x0f;
src = (1 << 24) + (src_instance << 16) + (src_board << 8) + src_port;
snprintf(src_str, sizeof(src_str), "%u.%u.%u", src_instance, src_board, src_port);
}
/* Figure out where the frame is going. srcTDA is destination of frame! */
tda = (word1 & CPFI_SOURCE_MASK) >> CPFI_SOURCE_SHIFT;
if ( tda >= FIRST_TIO_CARD_ADDRESS )
{
(void) g_strlcpy(dst_str, " CPFI", sizeof(dst_str));
dst = 0; /* Make it smallest */
}
else
{
const guint8 *dstmac;
/* Make sure this is an Ethernet address. */
DISSECTOR_ASSERT(pinfo->dst.type == AT_ETHER);
dstmac = (const guint8 *)pinfo->dst.data;
dst_instance = dstmac[2]-1;
dst_board = tda >> 4;
dst_port = tda & 0x0f;
dst = (1 << 24) + (dst_instance << 16) + (dst_board << 8) + dst_port;
snprintf(dst_str, sizeof(dst_str), "%u.%u.%u", dst_instance, dst_board, dst_port);
}
/* Set up the source and destination and arrow per user configuration. */
if ( cpfi_arrow_moves && (dst < src) )
{
left = dst_str;
arrow = r_to_l_arrow;
right = src_str;
}
else
{
left = src_str;
arrow = l_to_r_arrow;
right = dst_str;
}
if (extra_tree) {
proto_item *hidden_item;
/* For "real" TDAs (i.e. not for microTDAs), add hidden addresses to allow filtering */
if ( src != 0 )
{
hidden_item = proto_tree_add_bytes(extra_tree, hf_cpfi_t_instance, tvb, 0, 1, &src_instance);
proto_item_set_hidden(hidden_item);
hidden_item = proto_tree_add_bytes(extra_tree, hf_cpfi_t_src_instance, tvb, 0, 1, &src_instance);
proto_item_set_hidden(hidden_item);
hidden_item = proto_tree_add_bytes(extra_tree, hf_cpfi_t_board, tvb, 0, 1, &src_board);
proto_item_set_hidden(hidden_item);
hidden_item = proto_tree_add_bytes(extra_tree, hf_cpfi_t_src_board, tvb, 0, 1, &src_board);
proto_item_set_hidden(hidden_item);
hidden_item = proto_tree_add_bytes(extra_tree, hf_cpfi_t_port, tvb, 0, 1, &src_port);
proto_item_set_hidden(hidden_item);
hidden_item = proto_tree_add_bytes(extra_tree, hf_cpfi_t_src_port, tvb, 0, 1, &src_port);
proto_item_set_hidden(hidden_item);
}
if ( dst != 0 )
{
hidden_item = proto_tree_add_bytes(extra_tree, hf_cpfi_t_instance, tvb, 0, 1, &dst_instance);
proto_item_set_hidden(hidden_item);
hidden_item = proto_tree_add_bytes(extra_tree, hf_cpfi_t_dst_instance, tvb, 0, 1, &dst_instance);
proto_item_set_hidden(hidden_item);
hidden_item = proto_tree_add_bytes(extra_tree, hf_cpfi_t_board, tvb, 0, 1, &dst_board);
proto_item_set_hidden(hidden_item);
hidden_item = proto_tree_add_bytes(extra_tree, hf_cpfi_t_dst_board, tvb, 0, 1, &dst_board);
proto_item_set_hidden(hidden_item);
hidden_item = proto_tree_add_bytes(extra_tree, hf_cpfi_t_port, tvb, 0, 1, &dst_port);
proto_item_set_hidden(hidden_item);
hidden_item = proto_tree_add_bytes(extra_tree, hf_cpfi_t_dst_port, tvb, 0, 1, &dst_port);
proto_item_set_hidden(hidden_item);
}
/* add word 1 components to the protocol tree */
proto_tree_add_item(extra_tree, hf_cpfi_word_one , tvb, 0, 4, ENC_BIG_ENDIAN);
proto_tree_add_item(extra_tree, hf_cpfi_frame_type, tvb, 0, 4, ENC_BIG_ENDIAN);
proto_tree_add_item(extra_tree, hf_cpfi_source , tvb, 0, 4, ENC_BIG_ENDIAN);
proto_tree_add_item(extra_tree, hf_cpfi_dest , tvb, 0, 4, ENC_BIG_ENDIAN);
proto_tree_add_item(extra_tree, hf_cpfi_SOF_type , tvb, 0, 4, ENC_BIG_ENDIAN);
proto_tree_add_item(extra_tree, hf_cpfi_speed , tvb, 0, 4, ENC_BIG_ENDIAN);
proto_tree_add_item(extra_tree, hf_cpfi_OPM_error , tvb, 0, 4, ENC_BIG_ENDIAN);
proto_tree_add_item(extra_tree, hf_cpfi_from_LCM , tvb, 0, 4, ENC_BIG_ENDIAN);
/* add word 2 components to the protocol tree */
proto_tree_add_item(extra_tree, hf_cpfi_word_two , tvb, 4, 4, ENC_BIG_ENDIAN);
};
}
/* Footer */
static void
dissect_cpfi_footer(tvbuff_t *tvb, proto_tree *tree)
{
proto_tree *extra_tree = NULL;
/* add a tree for the footer */
if ( tree != NULL)
{
proto_item *extra_item;
extra_item = proto_tree_add_protocol_format(tree, proto_cpfi, tvb, 0, -1, "Footer");
extra_tree = proto_item_add_subtree(extra_item, ett_cpfi_footer);
}
if (extra_tree) {
proto_tree_add_item(extra_tree, hf_cpfi_CRC_32 , tvb, 0, 4, ENC_BIG_ENDIAN);
proto_tree_add_item(extra_tree, hf_cpfi_EOF_type, tvb, 4, 4, ENC_BIG_ENDIAN);
}
}
/* CPFI */
static int
dissect_cpfi(tvbuff_t *message_tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
{
tvbuff_t *header_tvb, *body_tvb, *footer_tvb;
proto_item *cpfi_item = NULL;
proto_tree *cpfi_tree = NULL;
gint length, reported_length, body_length, reported_body_length;
guint8 frame_type;
fc_data_t fc_data;
frame_type = (tvb_get_ntohl (message_tvb, 0) & CPFI_FRAME_TYPE_MASK) >> CPFI_FRAME_TYPE_SHIFT;
/* If this is not a CPFI frame, return 0 to let another dissector try to
* dissect it.
*/
if ( !((frame_type == 9) && fc_handle) )
return 0;
/* If we don't have Ethernet addresses, can't do further dissection... */
if (pinfo->dst.type != AT_ETHER || pinfo->src.type != AT_ETHER)
return 0;
length = tvb_captured_length_remaining(message_tvb, 8);
reported_length = tvb_reported_length_remaining(message_tvb, 8);
if (reported_length < 8)
{
/* We don't even have enough for the footer. */
return 0;
}
/* Length of packet, minus the footer. */
reported_body_length = reported_length - 8;
/* How much of that do we have in the tvbuff? */
body_length = length;
if (body_length > reported_body_length)
body_length = reported_body_length;
length = tvb_captured_length_remaining(message_tvb, 8+body_length);
if (length < 0)
{
/* The footer wasn't captured at all.
XXX - we'd like to throw a BoundsError if that's the case. */
return 0;
}
/* In the interest of speed, if "tree" is NULL, don't do any work not
necessary to generate protocol tree items. */
if (tree) {
/* create the protocol tree */
cpfi_item = proto_tree_add_item(tree, proto_cpfi, message_tvb, 0, -1, ENC_NA);
cpfi_tree = proto_item_add_subtree(cpfi_item, ett_cpfi);
}
/* Set up the frame controls - can we do better than this? */
fc_data.sof_eof = 0;
fc_data.sof_eof |= FC_DATA_SOF_FIRST_FRAME;
fc_data.sof_eof |= FC_DATA_EOF_LAST_FRAME;
fc_data.sof_eof |= FC_DATA_EOF_INVALID;
/* dissect the message */
/* extract and process the header */
header_tvb = tvb_new_subset_length(message_tvb, 0, 8);
dissect_cpfi_header(header_tvb, pinfo, cpfi_tree);
body_tvb = tvb_new_subset_length_caplen(message_tvb, 8, body_length, reported_body_length);
fc_data.ethertype = ETHERTYPE_UNK;
call_dissector_with_data(fc_handle, body_tvb, pinfo, tree, &fc_data);
/* add more info, now that FC added its */
proto_item_append_text(cpfi_item, direction_and_port_string, left, arrow, right);
col_prepend_fstr(pinfo->cinfo, COL_INFO, direction_and_port_string, left, arrow, right);
/* Do the footer */
footer_tvb = tvb_new_subset_length_caplen(message_tvb, 8+body_length, length, 8);
dissect_cpfi_footer(footer_tvb, cpfi_tree);
return(tvb_reported_length(message_tvb));
}
/* Register the protocol with Wireshark */
void
proto_register_cpfi(void)
{
module_t *cpfi_module;
/* Setup list of header fields */
static hf_register_info hf[] = {
{ &hf_cpfi_word_one,
{ "Word one", "cpfi.word_one",
FT_UINT32, BASE_HEX, NULL, 0x0,
NULL, HFILL}},
{ &hf_cpfi_word_two,
{ "Word two", "cpfi.word_two",
FT_UINT32, BASE_HEX, NULL, 0x0,
NULL, HFILL}},
{ &hf_cpfi_frame_type,
{ "FrmType", "cpfi.frmtype",
FT_UINT32, BASE_HEX, NULL, CPFI_FRAME_TYPE_MASK,
"Frame Type", HFILL}},
{ &hf_cpfi_source,
{ "srcTDA", "cpfi.srcTDA",
FT_UINT32, BASE_HEX, NULL, CPFI_SOURCE_MASK,
"Source TDA (10 bits)", HFILL}},
{ &hf_cpfi_dest,
{ "dstTDA", "cpfi.dstTDA",
FT_UINT32, BASE_HEX, NULL, CPFI_DEST_MASK,
"Source TDA (10 bits)", HFILL}},
{ &hf_cpfi_SOF_type,
{ "SOFtype", "cpfi.SOFtype",
FT_UINT32, BASE_HEX, VALS(sof_type_vals), CPFI_SOF_TYPE_MASK,
"SOF Type", HFILL}},
{ &hf_cpfi_speed,
{ "speed", "cpfi.speed",
FT_UINT32, BASE_HEX, VALS(speed_vals), CPFI_SPEED_MASK,
"SOF Type", HFILL}},
{ &hf_cpfi_OPM_error,
{ "OPMerror", "cpfi.OPMerror",
FT_BOOLEAN, 32, NULL, CPFI_OPM_ERROR_MASK,
"OPM Error?", HFILL}},
{ &hf_cpfi_from_LCM,
{ "fromLCM", "cpfi.fromLCM",
FT_BOOLEAN, 32, NULL, CPFI_FROM_LCM_MASK,
"from LCM?", HFILL}},
{ &hf_cpfi_CRC_32,
{ "CRC-32", "cpfi.crc-32",
FT_UINT32, BASE_HEX, NULL, 0x0,
NULL, HFILL}},
{ &hf_cpfi_EOF_type,
{ "EOFtype", "cpfi.EOFtype",
FT_UINT32, BASE_HEX, VALS(eof_type_vals), CPFI_EOF_TYPE_MASK,
"EOF Type", HFILL}},
{ &hf_cpfi_t_instance,
{ "Instance", "cpfi.instance",
FT_BYTES, BASE_NONE,
NULL, 0x0, NULL, HFILL}},
{ &hf_cpfi_t_src_instance,
{ "Source Instance", "cpfi.src_instance",
FT_BYTES, BASE_NONE,
NULL, 0x0, NULL, HFILL}},
{ &hf_cpfi_t_dst_instance,
{ "Destination Instance", "cpfi.dst_instance",
FT_BYTES, BASE_NONE,
NULL, 0x0, NULL, HFILL}},
{ &hf_cpfi_t_board,
{ "Board", "cpfi.board",
FT_BYTES, BASE_NONE,
NULL, 0x0, NULL, HFILL}},
{ &hf_cpfi_t_src_board,
{ "Source Board", "cpfi.src_board",
FT_BYTES, BASE_NONE,
NULL, 0x0, NULL, HFILL}},
{ &hf_cpfi_t_dst_board,
{ "Destination Board", "cpfi.dst_board",
FT_BYTES, BASE_NONE,
NULL, 0x0, NULL, HFILL}},
{ &hf_cpfi_t_port,
{ "Port", "cpfi.port",
FT_BYTES, BASE_NONE,
NULL, 0x0, NULL, HFILL}},
{ &hf_cpfi_t_src_port,
{ "Source Port", "cpfi.src_port",
FT_BYTES, BASE_NONE,
NULL, 0x0, NULL, HFILL}},
{ &hf_cpfi_t_dst_port,
{ "Destination Port", "cpfi.dst_port",
FT_BYTES, BASE_NONE,
NULL, 0x0, NULL, HFILL}},
};
/* Setup protocol subtree array */
static gint *ett[] = {
&ett_cpfi,
&ett_cpfi_header,
&ett_cpfi_footer
};
/* Register the protocol name and description */
proto_cpfi = proto_register_protocol("Cross Point Frame Injector", "CPFI", "cpfi");
/* Required function calls to register the header fields and subtrees used */
proto_register_field_array(proto_cpfi, hf, array_length(hf));
proto_register_subtree_array(ett, array_length(ett));
/* Register our configuration options for CPFI */
cpfi_module = prefs_register_protocol(proto_cpfi, proto_reg_handoff_cpfi);
prefs_register_uint_preference(cpfi_module, "udp.port2", "InstanceToInstance UDP Port",
"Set the port for InstanceToInstance messages (if other"
" than the default of 5001)",
10, &gbl_cpfi_ttot_udp_port);
prefs_register_bool_preference(cpfi_module, "arrow_ctl",
"Enable Active Arrow Control",
"Control the way the '-->' is displayed."
" When enabled, keeps the 'lowest valued' endpoint of the src-dest pair"
" on the left, and the arrow moves to distinguish source from dest."
" When disabled, keeps the arrow pointing right so the source of the frame"
" is always on the left.",
&cpfi_arrow_moves);
}
void
proto_reg_handoff_cpfi(void)
{
static gboolean cpfi_init_complete = FALSE;
static dissector_handle_t cpfi_handle;
static guint cpfi_ttot_udp_port;
if ( !cpfi_init_complete )
{
fc_handle = find_dissector_add_dependency("fc", proto_cpfi);
cpfi_handle = create_dissector_handle(dissect_cpfi, proto_cpfi);
dissector_add_uint_with_preference("udp.port", CPFI_DEFAULT_UDP_PORT, cpfi_handle);
cpfi_init_complete = TRUE;
}
else
{
dissector_delete_uint("udp.port", cpfi_ttot_udp_port, cpfi_handle);
}
cpfi_ttot_udp_port = gbl_cpfi_ttot_udp_port;
/* Port preference has a specific enough name to not use
the "auto" preference */
dissector_add_uint("udp.port", cpfi_ttot_udp_port, cpfi_handle);
}
/*
* Editor modelines
*
* Local Variables:
* c-basic-offset: 2
* tab-width: 8
* indent-tabs-mode: nil
* End:
*
* ex: set shiftwidth=2 tabstop=8 expandtab:
* :indentSize=2:tabSize=8:noTabs=true:
*/
View Git Blame Copy Permalink