From Martin Mathieson:
[obnox/wireshark/wip.git] / epan / dissectors / packet-catapult-dct2000.c
1 /* packet-catapult-dct2000.c\r
2  * Routines for Catapult DCT2000 packet stub header disassembly\r
3  *\r
4  * $Id: packet-sipfrag.c 15270 2005-08-10 13:41:13Z sahlberg $\r
5  *\r
6  * Ethereal - Network traffic analyzer\r
7  * By Gerald Combs <gerald@ethereal.com>\r
8  * Copyright 1998 Gerald Combs\r
9  *\r
10  * This program is free software; you can redistribute it and/or\r
11  * modify it under the terms of the GNU General Public License\r
12  * as published by the Free Software Foundation; either version 2\r
13  * of the License, or (at your option) any later version.\r
14  *\r
15  * This program is distributed in the hope that it will be useful,\r
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
18  * GNU General Public License for more details.\r
19  *\r
20  * You should have received a copy of the GNU General Public License\r
21  * along with this program; if not, write to the Free Software\r
22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.\r
23  */\r
24 \r
25 #ifdef HAVE_CONFIG_H\r
26 # include "config.h"\r
27 #endif\r
28 \r
29 #include <string.h>\r
30 #include <epan/packet.h>\r
31 #include <epan/emem.h>\r
32 #include <epan/proto.h>\r
33 #include <epan/prefs.h>\r
34 \r
35 #include "../wiretap/catapult_dct2000.h"\r
36 \r
37 /* Protocol and registered fields. */\r
38 static int proto_catapult_dct2000 = -1;\r
39 \r
40 static int hf_catapult_dct2000_context = -1;\r
41 static int hf_catapult_dct2000_port_number = -1;\r
42 static int hf_catapult_dct2000_timestamp = -1;\r
43 static int hf_catapult_dct2000_protocol = -1;\r
44 static int hf_catapult_dct2000_direction = -1;\r
45 static int hf_catapult_dct2000_encap = -1;\r
46 static int hf_catapult_dct2000_unparsed_data = -1;\r
47 \r
48 gboolean catapult_dct2000_board_ports_only;\r
49 \r
50 /* Protocol subtree. */\r
51 static int ett_catapult_dct2000 = -1;\r
52 \r
53 static const value_string direction_vals[] = {\r
54         { 0,   "Sent" },\r
55         { 1,   "Received" },\r
56     { 0,   NULL },\r
57 };\r
58 \r
59 static const value_string encap_vals[] = {\r
60     { WTAP_ENCAP_RAW_IP,                 "Raw IP" },\r
61     { WTAP_ENCAP_ETHERNET,               "Ethernet" },\r
62     { WTAP_ENCAP_ISDN,                   "LAPD" },\r
63     { WTAP_ENCAP_ATM_PDUS_UNTRUNCATED,   "ATM (PDUs untruncated)" },\r
64     { WTAP_ENCAP_PPP,                    "PPP" },\r
65     { DCT2000_ENCAP_SSCOP,               "SSCOP" },\r
66     { WTAP_ENCAP_FRELAY,                 "Frame Relay" },\r
67     { WTAP_ENCAP_MTP2,                   "MTP2" },\r
68     { DCT2000_ENCAP_UNHANDLED,           "Unhandled Protocol" },\r
69     { 0,                                 NULL },\r
70 };\r
71 \r
72 \r
73 /*****************************************/\r
74 /* Main dissection function.             */\r
75 /*****************************************/\r
76 static void\r
77 dissect_catapult_dct2000(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)\r
78 {\r
79     proto_tree  *dct2000_tree;\r
80     proto_item  *ti;\r
81     gint        offset = 0;\r
82     gint        context_length;\r
83     guint8      port_number;\r
84     gint        protocol_start;\r
85     gint        protocol_length;\r
86     gint        timestamp_start;\r
87     gint        timestamp_length;\r
88     guint8      direction;\r
89     tvbuff_t    *next_tvb;\r
90     int         encap;\r
91     union wtap_pseudo_header temp_pseudo_header;\r
92     dissector_handle_t protocol_handle = 0;\r
93     int sub_dissector_result = 0;\r
94 \r
95     /* Protocol name */\r
96     if (check_col(pinfo->cinfo, COL_PROTOCOL))\r
97     {\r
98         col_add_str(pinfo->cinfo, COL_PROTOCOL, "DCT2000");\r
99     }\r
100 \r
101     /* Info column */\r
102     if (check_col(pinfo->cinfo, COL_INFO))\r
103     {\r
104         col_clear(pinfo->cinfo, COL_INFO);\r
105     }\r
106 \r
107     /* Create protocol tree. */\r
108     ti = proto_tree_add_item(tree, proto_catapult_dct2000, tvb, offset, -1, FALSE);\r
109     dct2000_tree = proto_item_add_subtree(ti, ett_catapult_dct2000);\r
110 \r
111     /* Context Name */\r
112     context_length = tvb_strsize(tvb, offset);\r
113     proto_tree_add_item(dct2000_tree, hf_catapult_dct2000_context, tvb,\r
114                         offset, context_length, FALSE);\r
115     offset += context_length;\r
116 \r
117     /* Context port number */\r
118     proto_tree_add_item(dct2000_tree, hf_catapult_dct2000_port_number, tvb,\r
119                         offset, 1, FALSE);\r
120     port_number = tvb_get_guint8(tvb, offset);\r
121     offset++;\r
122 \r
123     /* Timestamp in file */\r
124     timestamp_start = offset;\r
125     timestamp_length = tvb_strsize(tvb, offset);\r
126     proto_tree_add_item(dct2000_tree, hf_catapult_dct2000_timestamp, tvb,\r
127                         offset, timestamp_length, FALSE);\r
128     offset += timestamp_length;\r
129 \r
130 \r
131     /* Original protocol name */\r
132     protocol_start = offset;\r
133     protocol_length = tvb_strsize(tvb, offset);\r
134     proto_tree_add_item(dct2000_tree, hf_catapult_dct2000_protocol, tvb,\r
135                         offset, protocol_length, FALSE);\r
136     offset += protocol_length;\r
137 \r
138     /* Direction */\r
139     direction = tvb_get_guint8(tvb, offset);\r
140     proto_tree_add_item(dct2000_tree, hf_catapult_dct2000_direction, tvb,\r
141                         offset, 1, FALSE);\r
142     offset++;\r
143 \r
144     /* Read file encap */\r
145     proto_tree_add_item(dct2000_tree, hf_catapult_dct2000_encap, tvb, offset, 1, FALSE);\r
146     encap = tvb_get_guint8(tvb, offset);\r
147     offset++;\r
148 \r
149     /* Set selection length of dct2000 tree */\r
150     proto_item_set_len(dct2000_tree, offset);\r
151 \r
152     /* Add useful details to protocol tree label */\r
153     proto_item_append_text(ti, "   context=%s.%u   t=%s   %c   prot=%s",\r
154                            tvb_get_ephemeral_string(tvb, 0, context_length),\r
155                            port_number,\r
156                            tvb_get_ephemeral_string(tvb, timestamp_start, timestamp_length),\r
157                            (direction == 0) ? 'S' : 'R',\r
158                            tvb_get_ephemeral_string(tvb, protocol_start, protocol_length));\r
159 \r
160 \r
161 \r
162     /* Copy pseudo header info stored in dct2000 entry back up to start\r
163        of structure. Use a temp buffer as address ranges will overlap!\r
164     */\r
165     memcpy(&temp_pseudo_header, &(pinfo->pseudo_header->dct2000.inner_pseudo_header),\r
166            sizeof(pinfo->pseudo_header->dct2000.inner_pseudo_header));\r
167     memcpy((pinfo->pseudo_header), &temp_pseudo_header,\r
168            sizeof(pinfo->pseudo_header->dct2000.inner_pseudo_header));\r
169 \r
170 \r
171     /***********************************************************************/\r
172     /* Now hand off to the dissector of intended packet encapsulation type */\r
173 \r
174     /* Get protocol handle, and set p2p_dir where necessary.\r
175        (packet-frame.c won't copy it from pseudo-header because it doesn't\r
176        know about Catapult DCT2000 encap type...)\r
177     */\r
178     switch (encap)\r
179     {\r
180         case WTAP_ENCAP_RAW_IP:\r
181             protocol_handle = find_dissector("ip");\r
182             break;\r
183         case WTAP_ENCAP_ETHERNET:\r
184             protocol_handle = find_dissector("eth_withoutfcs");\r
185             break;\r
186         case WTAP_ENCAP_ISDN:\r
187             protocol_handle = find_dissector("lapd");\r
188             pinfo->p2p_dir = pinfo->pseudo_header->isdn.uton;\r
189             break;\r
190         case WTAP_ENCAP_ATM_PDUS_UNTRUNCATED:\r
191             protocol_handle = find_dissector("atm_untruncated");\r
192             break;\r
193         case WTAP_ENCAP_PPP:\r
194             protocol_handle = find_dissector("ppp_hdlc");\r
195             pinfo->p2p_dir = pinfo->pseudo_header->p2p.sent;\r
196             break;\r
197         case DCT2000_ENCAP_SSCOP:\r
198             protocol_handle = find_dissector("sscop");\r
199             break;\r
200         case WTAP_ENCAP_FRELAY:\r
201             protocol_handle = find_dissector("fr");\r
202             break;\r
203         case DCT2000_ENCAP_MTP2:\r
204             protocol_handle = find_dissector("mtp2");\r
205             break;\r
206         case DCT2000_ENCAP_UNHANDLED:\r
207             protocol_handle = 0;\r
208             break;\r
209 \r
210         default:\r
211             /* !! If get here, there is a mismatch between\r
212                this dissector and the wiretap module catapult_dct2000.c !!\r
213             */\r
214             DISSECTOR_ASSERT_NOT_REACHED();\r
215                 return;\r
216     }\r
217 \r
218 \r
219     /* Try appropriate dissector, if selected */\r
220     if (protocol_handle != 0)\r
221     {\r
222         /* Dissect the remainder of the frame using chosen protocol handle */\r
223         next_tvb = tvb_new_subset(tvb, offset, -1, tvb_reported_length(tvb)-offset);\r
224         sub_dissector_result = call_dissector_only(protocol_handle, next_tvb, pinfo, tree);\r
225     }\r
226 \r
227 \r
228     if (protocol_handle == 0 || sub_dissector_result == 0)\r
229     {\r
230         /* Could get here because:\r
231            - encap is DCT2000_ENCAP_UNHANDLED, OR\r
232            - desired protocol is unavailable (probably disabled), OR\r
233            - protocol rejected our data\r
234            Show remaining bytes as unparsed data */\r
235         proto_tree_add_item(dct2000_tree, hf_catapult_dct2000_unparsed_data,\r
236                             tvb, offset, -1, FALSE);\r
237         if (check_col(pinfo->cinfo, COL_INFO))\r
238         {\r
239             col_add_fstr(pinfo->cinfo, COL_INFO,\r
240                          "Unparsed protocol data (context=%s.%u   t=%s   %c   prot=%s)",\r
241                          tvb_get_ephemeral_string(tvb, 0, context_length),\r
242                          port_number,\r
243                          tvb_get_ephemeral_string(tvb, timestamp_start, timestamp_length),\r
244                          (direction == 0) ? 'S' : 'R',\r
245                          tvb_get_ephemeral_string(tvb, protocol_start, protocol_length));\r
246         }\r
247     }\r
248 }\r
249 \r
250 \r
251 \r
252 /******************************************************************************/\r
253 /* Associate this protocol with the Catapult DCT2000 file encapsulation type. */\r
254 /******************************************************************************/\r
255 void proto_reg_handoff_catapult_dct2000(void)\r
256 {\r
257     dissector_handle_t catapult_dct2000_handle = find_dissector("dct2000");\r
258     dissector_add("wtap_encap", WTAP_ENCAP_CATAPULT_DCT2000,\r
259                   catapult_dct2000_handle);\r
260 }\r
261 \r
262 /****************************************/\r
263 /* Register the protocol                */\r
264 /****************************************/\r
265 void proto_register_catapult_dct2000(void)\r
266 {\r
267     static hf_register_info hf[] =\r
268     {\r
269         { &hf_catapult_dct2000_context,\r
270             { "Context",\r
271               "dct2000.context", FT_STRING, BASE_NONE, NULL, 0x0,\r
272               "Context name", HFILL\r
273             }\r
274         },\r
275         { &hf_catapult_dct2000_port_number,\r
276             { "Context Port number",\r
277               "dct2000.context_port", FT_UINT8, BASE_DEC, NULL, 0x0,\r
278               "Context port number", HFILL\r
279             }\r
280         },\r
281         { &hf_catapult_dct2000_timestamp,\r
282             { "Timestamp",\r
283               "dct2000.timestamp", FT_STRING, BASE_NONE, NULL, 0x0,\r
284               "File timestamp", HFILL\r
285             }\r
286         },\r
287         { &hf_catapult_dct2000_protocol,\r
288             { "DCT2000 protocol",\r
289               "dct2000.protocol", FT_STRING, BASE_NONE, NULL, 0x0,\r
290               "Original (DCT2000) protocol name", HFILL\r
291             }\r
292         },\r
293         { &hf_catapult_dct2000_direction,\r
294             { "Direction",\r
295               "dct2000.direction", FT_UINT8, BASE_DEC, VALS(direction_vals), 0x0,\r
296               "Frame direction (Sent or Received)", HFILL\r
297             }\r
298         },\r
299         { &hf_catapult_dct2000_encap,\r
300             { "Ethereal encapsulation",\r
301               "dct2000.encapsulation", FT_UINT8, BASE_DEC, VALS(encap_vals), 0x0,\r
302               "Ethereal encapsulation used", HFILL\r
303             }\r
304         },\r
305         { &hf_catapult_dct2000_unparsed_data,\r
306             { "Unparsed protocol data",\r
307               "dct2000.unparsed_data", FT_BYTES, BASE_NONE, NULL, 0x0,\r
308               "Unparsed DCT2000 protocol data", HFILL\r
309             }\r
310         },\r
311 \r
312     };\r
313 \r
314     static gint *ett[] =\r
315     {\r
316         &ett_catapult_dct2000\r
317     };\r
318 \r
319     module_t *catapult_dct2000_module;\r
320     \r
321     /* Register protocol. */\r
322     proto_catapult_dct2000 = proto_register_protocol("DCT2000", "DCT2000", "dct2000");\r
323     proto_register_field_array(proto_catapult_dct2000, hf, array_length(hf));\r
324     proto_register_subtree_array(ett, array_length(ett));\r
325 \r
326     /* Allow dissector to find be found by name. */\r
327     register_dissector("dct2000", dissect_catapult_dct2000, proto_catapult_dct2000);\r
328 \r
329     /* Preferences */\r
330         catapult_dct2000_module = prefs_register_protocol(proto_catapult_dct2000,\r
331                                                                                                   proto_reg_handoff_catapult_dct2000);\r
332 \r
333     /* Determines whether non-supported protocols should be shown anyway */\r
334         prefs_register_bool_preference(catapult_dct2000_module, "board_ports_only",\r
335                                        "Only show known 'board-port' protocols",\r
336                                        "Don't show other protocols, i.e. unknown board-port "\r
337                                    "protocols and non-standard primitives between "\r
338                                    "contexts on the same card.  The capture file "\r
339                                    "needs to be (re)-loaded before effect will be seen",\r
340                                        &catapult_dct2000_board_ports_only);\r
341 }\r
342 \r