2 * Routines for MTP3 User Adaptation Layer dissection
3 * It is hopefully (needs testing) compilant to
4 * http://www.ietf.org/internet-drafts/draft-ietf-sigtran-m3ua-05.txt
5 * To do: - clean up the code
6 * - provide better handling of length parameters
7 * - provide good information in summary window
9 * Copyright 2000, Michael Tüxen <Michael.Tuexen@icn.siemens.de>
11 * $Id: packet-m3ua.c,v 1.9 2001/12/03 03:59:37 guy Exp $
13 * Ethereal - Network traffic analyzer
14 * By Gerald Combs <gerald@ethereal.com>
15 * Copyright 1998 Gerald Combs
17 * Copied from README.developer
19 * This program is free software; you can redistribute it and/or
20 * modify it under the terms of the GNU General Public License
21 * as published by the Free Software Foundation; either version 2
22 * of the License, or (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program; if not, write to the Free Software
31 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
42 #ifdef HAVE_SYS_TYPES_H
43 # include <sys/types.h>
46 #ifdef HAVE_NETINET_IN_H
47 # include <netinet/in.h>
53 #ifdef NEED_SNPRINTF_H
54 # include "snprintf.h"
59 #define SCTP_PORT_M3UA 2905
60 #define M3UA_PAYLOAD_PROTO_ID 3
62 #define VERSION_LENGTH 1
63 #define RESERVED_LENGTH 1
64 #define MESSAGE_CLASS_LENGTH 1
65 #define MESSAGE_TYPE_LENGTH 1
66 #define MESSAGE_LENGTH_LENGTH 4
67 #define COMMON_HEADER_LENGTH (VERSION_LENGTH + RESERVED_LENGTH + MESSAGE_CLASS_LENGTH + \
68 MESSAGE_TYPE_LENGTH + MESSAGE_LENGTH_LENGTH)
70 #define VERSION_OFFSET 0
71 #define RESERVED_OFFSET (VERSION_OFFSET + VERSION_LENGTH)
72 #define MESSAGE_CLASS_OFFSET (RESERVED_OFFSET + RESERVED_LENGTH)
73 #define MESSAGE_TYPE_OFFSET (MESSAGE_CLASS_OFFSET + MESSAGE_CLASS_LENGTH)
74 #define MESSAGE_LENGTH_OFFSET (MESSAGE_TYPE_OFFSET + MESSAGE_TYPE_LENGTH)
76 #define PARAMETER_TAG_LENGTH 2
77 #define PARAMETER_LENGTH_LENGTH 2
78 #define PARAMETER_HEADER_LENGTH (PARAMETER_TAG_LENGTH + PARAMETER_LENGTH_LENGTH)
80 #define PARAMETER_TAG_OFFSET 0
81 #define PARAMETER_LENGTH_OFFSET (PARAMETER_TAG_OFFSET + PARAMETER_TAG_LENGTH)
82 #define PARAMETER_VALUE_OFFSET (PARAMETER_LENGTH_OFFSET + PARAMETER_LENGTH_LENGTH)
83 #define PARAMETER_HEADER_OFFSET PARAMETER_TAG_OFFSET
85 #define NETWORK_APPEARANCE_PARAMETER_TAG 1
86 #define PROTOCOL_DATA_PARAMETER_TAG 3
87 #define INFO_PARAMETER_TAG 4
88 #define AFFECTED_DESTINATIONS_PARAMETER_TAG 5
89 #define ROUTING_CONTEXT_PARAMETER_TAG 6
90 #define DIAGNOSTIC_INFORMATION_PARAMETER_TAG 7
91 #define HEARTBEAT_DATA_PARAMETER_TAG 8
92 #define USER_CAUSE_PARAMETER_TAG 9
93 #define REASON_PARAMETER_TAG 10
94 #define TRAFFIC_MODE_TYPE_PARAMETER_TAG 11
95 #define ERROR_CODE_PARAMETER_TAG 12
96 #define STATUS_TYPE_PARAMETER_TAG 13
97 #define CONGESTION_INDICATION_PARAMETER_TAG 14
100 static const value_string m3ua_parameter_tag_values[] = {
101 { NETWORK_APPEARANCE_PARAMETER_TAG, "Network appearance" },
102 { PROTOCOL_DATA_PARAMETER_TAG, "Protocol data" },
103 { INFO_PARAMETER_TAG, "Info" },
104 { AFFECTED_DESTINATIONS_PARAMETER_TAG, "Affected destinations" },
105 { ROUTING_CONTEXT_PARAMETER_TAG, "Routing context" },
106 { DIAGNOSTIC_INFORMATION_PARAMETER_TAG, "Diagnostic information" },
107 { HEARTBEAT_DATA_PARAMETER_TAG, "Heartbeat data" },
108 { USER_CAUSE_PARAMETER_TAG, "User / Cause" },
109 { REASON_PARAMETER_TAG, "Reason" },
110 { TRAFFIC_MODE_TYPE_PARAMETER_TAG, "Traffic mode type" },
111 { ERROR_CODE_PARAMETER_TAG, "Error code" },
112 { STATUS_TYPE_PARAMETER_TAG, "Status type" },
113 { CONGESTION_INDICATION_PARAMETER_TAG, "Congestion Indication" },
116 #define PROTOCOL_VERSION_RELEASE_1 1
118 static const value_string m3ua_protocol_version_values[] = {
119 { PROTOCOL_VERSION_RELEASE_1, "Release 1" },
122 #define MESSAGE_CLASS_MGMT_MESSAGE 0
123 #define MESSAGE_CLASS_TFER_MESSAGE 1
124 #define MESSAGE_CLASS_SSNM_MESSAGE 2
125 #define MESSAGE_CLASS_ASPSM_MESSAGE 3
126 #define MESSAGE_CLASS_ASPTM_MESSAGE 4
128 static const value_string m3ua_message_class_values[] = {
129 { MESSAGE_CLASS_MGMT_MESSAGE, "Management messages" },
130 { MESSAGE_CLASS_TFER_MESSAGE, "Transfer messages" },
131 { MESSAGE_CLASS_SSNM_MESSAGE, "SS7 signalling network management messages" },
132 { MESSAGE_CLASS_ASPSM_MESSAGE, "ASP state maintenance messages" },
133 { MESSAGE_CLASS_ASPTM_MESSAGE, "ASP traffic maintenance messages" },
136 #define MESSAGE_TYPE_ERR 0
137 #define MESSAGE_TYPE_NTFY 1
139 #define MESSAGE_TYPE_DATA 1
141 #define MESSAGE_TYPE_DUNA 1
142 #define MESSAGE_TYPE_DAVA 2
143 #define MESSAGE_TYPE_DAUD 3
144 #define MESSAGE_TYPE_SCON 4
145 #define MESSAGE_TYPE_DUPU 5
147 #define MESSAGE_TYPE_UP 1
148 #define MESSAGE_TYPE_DOWN 2
149 #define MESSAGE_TYPE_BEAT 3
150 #define MESSAGE_TYPE_UP_ACK 4
151 #define MESSAGE_TYPE_DOWN_ACK 5
152 #define MESSAGE_TYPE_BEAT_ACK 6
154 #define MESSAGE_TYPE_ACTIVE 1
155 #define MESSAGE_TYPE_INACTIVE 2
156 #define MESSAGE_TYPE_ACTIVE_ACK 3
157 #define MESSAGE_TYPE_INACTIVE_ACK 4
159 static const value_string m3ua_message_class_type_values[] = {
160 { MESSAGE_CLASS_MGMT_MESSAGE * 256 + MESSAGE_TYPE_ERR, "Error (ERR)" },
161 { MESSAGE_CLASS_MGMT_MESSAGE * 256 + MESSAGE_TYPE_NTFY, "Notify (NTFY)" },
162 { MESSAGE_CLASS_TFER_MESSAGE * 256 + MESSAGE_TYPE_DATA, "Payload data (DATA)" },
163 { MESSAGE_CLASS_SSNM_MESSAGE * 256 + MESSAGE_TYPE_DUNA, "Destination unavailable (DUNA)" },
164 { MESSAGE_CLASS_SSNM_MESSAGE * 256 + MESSAGE_TYPE_DAVA, "Destination available (DAVA)" },
165 { MESSAGE_CLASS_SSNM_MESSAGE * 256 + MESSAGE_TYPE_DAUD, "Destination state audit (DAUD)" },
166 { MESSAGE_CLASS_SSNM_MESSAGE * 256 + MESSAGE_TYPE_SCON, "SS7 Network congestion state (SCON)" },
167 { MESSAGE_CLASS_SSNM_MESSAGE * 256 + MESSAGE_TYPE_DUPU, "Destination userpart unavailable (DUPU)" },
168 { MESSAGE_CLASS_ASPSM_MESSAGE * 256 + MESSAGE_TYPE_UP, "ASP up (UP)" },
169 { MESSAGE_CLASS_ASPSM_MESSAGE * 256 + MESSAGE_TYPE_DOWN, "ASP down (DOWN)" },
170 { MESSAGE_CLASS_ASPSM_MESSAGE * 256 + MESSAGE_TYPE_BEAT, "Heartbeat (BEAT)" },
171 { MESSAGE_CLASS_ASPSM_MESSAGE * 256 + MESSAGE_TYPE_UP_ACK, "ASP up ack (UP ACK)" },
172 { MESSAGE_CLASS_ASPSM_MESSAGE * 256 + MESSAGE_TYPE_DOWN_ACK, "ASP down ack (DOWN ACK)" },
173 { MESSAGE_CLASS_ASPSM_MESSAGE * 256 + MESSAGE_TYPE_BEAT_ACK, "Heartbeat ack (BEAT ACK)" },
174 { MESSAGE_CLASS_ASPTM_MESSAGE * 256 + MESSAGE_TYPE_ACTIVE , "ASP active (ACTIVE)" },
175 { MESSAGE_CLASS_ASPTM_MESSAGE * 256 + MESSAGE_TYPE_INACTIVE , "ASP inactive (INACTIVE)" },
176 { MESSAGE_CLASS_ASPTM_MESSAGE * 256 + MESSAGE_TYPE_ACTIVE_ACK , "ASP active ack (ACTIVE ACK)" },
177 { MESSAGE_CLASS_ASPTM_MESSAGE * 256 + MESSAGE_TYPE_INACTIVE_ACK , "ASP inactive ack (INACTIVE ACK)" },
180 static const value_string m3ua_message_class_type_acro_values[] = {
181 { MESSAGE_CLASS_MGMT_MESSAGE * 256 + MESSAGE_TYPE_ERR, "ERR" },
182 { MESSAGE_CLASS_MGMT_MESSAGE * 256 + MESSAGE_TYPE_NTFY, "NTFY" },
183 { MESSAGE_CLASS_TFER_MESSAGE * 256 + MESSAGE_TYPE_DATA, "DATA" },
184 { MESSAGE_CLASS_SSNM_MESSAGE * 256 + MESSAGE_TYPE_DUNA, "DUNA" },
185 { MESSAGE_CLASS_SSNM_MESSAGE * 256 + MESSAGE_TYPE_DAVA, "DAVA" },
186 { MESSAGE_CLASS_SSNM_MESSAGE * 256 + MESSAGE_TYPE_DAUD, "DAUD" },
187 { MESSAGE_CLASS_SSNM_MESSAGE * 256 + MESSAGE_TYPE_SCON, "SCON" },
188 { MESSAGE_CLASS_SSNM_MESSAGE * 256 + MESSAGE_TYPE_DUPU, "DUPU" },
189 { MESSAGE_CLASS_ASPSM_MESSAGE * 256 + MESSAGE_TYPE_UP, "ASP_UP" },
190 { MESSAGE_CLASS_ASPSM_MESSAGE * 256 + MESSAGE_TYPE_DOWN, "ASP_DOWN" },
191 { MESSAGE_CLASS_ASPSM_MESSAGE * 256 + MESSAGE_TYPE_BEAT, "BEAT" },
192 { MESSAGE_CLASS_ASPSM_MESSAGE * 256 + MESSAGE_TYPE_UP_ACK, "ASP_UP_ACK" },
193 { MESSAGE_CLASS_ASPSM_MESSAGE * 256 + MESSAGE_TYPE_DOWN_ACK, "ASP_DOWN_ACK" },
194 { MESSAGE_CLASS_ASPSM_MESSAGE * 256 + MESSAGE_TYPE_BEAT_ACK, "BEAT_ACK" },
195 { MESSAGE_CLASS_ASPTM_MESSAGE * 256 + MESSAGE_TYPE_ACTIVE , "ASP_ACTIVE" },
196 { MESSAGE_CLASS_ASPTM_MESSAGE * 256 + MESSAGE_TYPE_INACTIVE , "ASP_INACTIVE" },
197 { MESSAGE_CLASS_ASPTM_MESSAGE * 256 + MESSAGE_TYPE_ACTIVE_ACK , "ASP_ACTIVE_ACK" },
198 { MESSAGE_CLASS_ASPTM_MESSAGE * 256 + MESSAGE_TYPE_INACTIVE_ACK , "ASP_INACTIVE_ACK" },
204 #define NETWORK_APPEARANCE_LENGTH 4
205 #define NETWORK_APPEARANCE_OFFSET PARAMETER_VALUE_OFFSET
207 #define PROTOCOL_DATA_OFFSET PARAMETER_VALUE_OFFSET
209 #define INFO_STRING_OFFSET PARAMETER_VALUE_OFFSET
212 #define INVALID_VERSION_ERROR_CODE 1
213 #define INVALID_NETWORK_APPEARANCE_ERROR_CODE 2
214 #define UNSUPPORTED_MESSAGE_TYPE_ERROR_CODE 3
215 #define INVALID_MESSAGE_TYPE_ERROR_CODE 4
216 #define INVALID_TRAFFIC_HANDLING_MODE_ERROR_CODE 5
217 #define UNEXPECTED_MESSAGE_ERROR_CODE 6
218 #define PROTOCOL_ERROR_ERROR_CODE 7
219 #define INVALID_ROUTING_CONTEXT_ERROR_CODE 8
221 static const value_string m3ua_error_code_values[] = {
222 { INVALID_VERSION_ERROR_CODE, "Invalid version" },
223 { INVALID_NETWORK_APPEARANCE_ERROR_CODE, "Invalid network appearance" },
224 { UNSUPPORTED_MESSAGE_TYPE_ERROR_CODE, "Unsupported message type" },
225 { INVALID_MESSAGE_TYPE_ERROR_CODE, "Invalid message type" },
226 { INVALID_TRAFFIC_HANDLING_MODE_ERROR_CODE, "Invalid traffic handling mode" },
227 { UNEXPECTED_MESSAGE_ERROR_CODE, "Unexpected message" },
228 { PROTOCOL_ERROR_ERROR_CODE, "Protocol error" },
229 { INVALID_ROUTING_CONTEXT_ERROR_CODE, "Invalid routing contexted" },
232 #define ERROR_CODE_LENGTH 4
233 #define ERROR_CODE_OFFSET PARAMETER_VALUE_OFFSET
235 #define AS_STATE_CHANGE_TYPE 1
238 static const value_string m3ua_status_type_values[] = {
239 { AS_STATE_CHANGE_TYPE, "Application server state change" },
240 { OTHER_TYPE, "Other" },
243 #define RESERVED_INFO 1
244 #define AS_INACTIVE_INFO 2
245 #define AS_ACTIVE_INFO 3
246 #define AS_PENDING_INFO 4
248 #define INSUFFICIENT_ASP_RES_INFO 1
249 #define ALTERNATE_ASP_ACTIVE_INFO 2
251 static const value_string m3ua_status_type_info_values[] = {
252 { AS_STATE_CHANGE_TYPE * 256 * 256 + RESERVED_INFO, "Reserved" },
253 { AS_STATE_CHANGE_TYPE * 256 * 256 + AS_INACTIVE_INFO, "Application server inactive" },
254 { AS_STATE_CHANGE_TYPE * 256 * 256 + AS_ACTIVE_INFO, "Application server active" },
255 { AS_STATE_CHANGE_TYPE * 256 * 256 + AS_PENDING_INFO, "Application server pending" },
256 { OTHER_TYPE * 256 * 256 + INSUFFICIENT_ASP_RES_INFO, "Insufficient ASP resources active in AS" },
257 { OTHER_TYPE * 256 * 256 + ALTERNATE_ASP_ACTIVE_INFO, "Alternate ASP active" },
260 #define STATUS_TYPE_LENGTH 2
261 #define STATUS_INFO_LENGTH 2
263 #define STATUS_TYPE_OFFSET PARAMETER_VALUE_OFFSET
264 #define STATUS_INFO_OFFSET (STATUS_TYPE_OFFSET + STATUS_TYPE_LENGTH)
266 #define UNKNOWN_UNAVAIL_CAUSE 0
267 #define UNEQUIPPED_REMOTE_USER_UNAVAIL_CAUSE 1
268 #define INACCESSABLE_REMOTE_USER_UNAVAIL_CAUSE 2
270 static const value_string m3ua_unavailability_cause_values[] = {
271 { UNKNOWN_UNAVAIL_CAUSE, "Unknown" },
272 { UNEQUIPPED_REMOTE_USER_UNAVAIL_CAUSE, "Unequipped remote user" },
273 { INACCESSABLE_REMOTE_USER_UNAVAIL_CAUSE, "Inaccessable remote user" },
276 #define RESERVED_0_USER_ID 0
277 #define RESERVED_1_USER_ID 1
278 #define RESERVED_2_USER_ID 2
279 #define SCCP_USER_ID 3
280 #define TUP_USER_ID 4
281 #define ISUP_USER_ID 5
282 #define RESERVED_6_USER_ID 6
283 #define RESERVED_7_USER_ID 7
284 #define RESERVED_8_USER_ID 8
285 #define BROADBAND_ISUP_USER_ID 9
286 #define SATELLITE_ISUP_USER_ID 10
288 static const value_string m3ua_user_identity_values[] = {
289 { RESERVED_0_USER_ID, "Reserved" },
290 { RESERVED_1_USER_ID, "Reserved" },
291 { RESERVED_2_USER_ID, "Reserved" },
292 { SCCP_USER_ID, "SCCP" },
293 { TUP_USER_ID, "TUP" },
294 { ISUP_USER_ID, "ISUP" },
295 { RESERVED_6_USER_ID, "Reserved" },
296 { RESERVED_7_USER_ID, "Reserved" },
297 { RESERVED_8_USER_ID, "Reserved" },
298 { BROADBAND_ISUP_USER_ID, "Broadband ISUP" },
299 { SATELLITE_ISUP_USER_ID, "Satellite ISUP" },
302 #define CAUSE_LENGTH 2
303 #define USER_LENGTH 2
305 #define CAUSE_OFFSET PARAMETER_VALUE_OFFSET
306 #define USER_OFFSET (CAUSE_OFFSET + CAUSE_LENGTH)
308 #define UNSPECIFIED_REASON 0
309 #define USER_UNAVAILABLE_REASON 1
310 #define MANAGEMENT_BLOCKING_REASON 2
312 static const value_string m3ua_reason_values[] = {
313 { UNSPECIFIED_REASON, "Unspecified" },
314 { USER_UNAVAILABLE_REASON, "User unavailable" },
315 { MANAGEMENT_BLOCKING_REASON, "Management blocking" },
318 #define REASON_LENGTH 4
319 #define REASON_OFFSET PARAMETER_VALUE_OFFSET
322 #define OVER_RIDE_TYPE 1
323 #define LOAD_SHARE_TYPE 2
324 #define OVER_RIDE_STANDBY_TYPE 3
325 #define LOAD_SHARE_STANDBY_TYPE 4
327 static const value_string m3ua_traffic_mode_type_values[] = {
328 { OVER_RIDE_TYPE , "Over-ride" },
329 { LOAD_SHARE_TYPE, "Load-share" },
330 { OVER_RIDE_STANDBY_TYPE, "Over-ride (standby)" },
331 { LOAD_SHARE_STANDBY_TYPE, "Load-share (standby)" },
334 #define TRAFFIC_MODE_TYPE_LENGTH 4
335 #define TRAFFIC_MODE_TYPE_OFFSET PARAMETER_VALUE_OFFSET
337 #define ROUTING_CONTEXT_LENGTH 4
339 #define AFFECTED_DESTINATION_LENGTH 4
340 #define AFFECTED_MASK_LENGTH 1
341 #define AFFECTED_DPC_LENGTH 3
343 #define AFFECTED_MASK_OFFSET 0
344 #define AFFECTED_DPC_OFFSET (AFFECTED_MASK_OFFSET + AFFECTED_MASK_LENGTH)
346 #define NO_CONGESTION_LEVEL 0
347 #define CONGESTION_LEVEL_1_LEVEL 1
348 #define CONGESTION_LEVEL_2_LEVEL 2
349 #define CONGESTION_LEVEL_3_LEVEL 3
351 static const value_string m3ua_congestion_level_values[] = {
352 { NO_CONGESTION_LEVEL, "No congestion or undefined" },
353 { CONGESTION_LEVEL_1_LEVEL, "Congestion level 1" },
354 { CONGESTION_LEVEL_2_LEVEL, "Congestion level 2" },
355 { CONGESTION_LEVEL_3_LEVEL, "Congestion level 3" },
358 #define CONG_IND_RESERVED_LENGTH 3
359 #define CONG_IND_LEVEL_LENGTH 1
361 #define CONG_IND_RESERVED_OFFSET PARAMETER_VALUE_OFFSET
362 #define CONG_IND_LEVEL_OFFSET (CONG_IND_RESERVED_OFFSET + CONG_IND_RESERVED_LENGTH)
364 /* Initialize the protocol and registered fields */
365 static int proto_m3ua = -1;
366 static int hf_m3ua_version = -1;
367 static int hf_m3ua_reserved = -1;
368 static int hf_m3ua_message_class = -1;
369 static int hf_m3ua_message_type = -1;
370 static int hf_m3ua_message_length = -1;
371 static int hf_m3ua_parameter_tag = -1;
372 static int hf_m3ua_parameter_length = -1;
373 static int hf_m3ua_network_appearance = -1;
374 static int hf_m3ua_info_string = -1;
375 static int hf_m3ua_error_code = -1;
376 static int hf_m3ua_status_type = -1;
377 static int hf_m3ua_status_info = -1;
378 static int hf_m3ua_unavailability_cause = -1;
379 static int hf_m3ua_user_identity = -1;
380 static int hf_m3ua_reason = -1;
381 static int hf_m3ua_traffic_mode_type = -1;
382 static int hf_m3ua_routing_context = -1;
383 static int hf_m3ua_mask = -1;
384 static int hf_m3ua_dpc = -1;
385 static int hf_m3ua_congestion_level = -1;
387 /* Initialize the subtree pointers */
388 static gint ett_m3ua = -1;
389 static gint ett_m3ua_parameter = -1;
390 static gint ett_m3ua_affected_destination = -1;
392 static dissector_handle_t mtp3_handle;
395 nr_of_padding_bytes (guint length)
399 remainder = length % 4;
404 return 4 - remainder;
408 dissect_m3ua_common_header(tvbuff_t *common_header_tvb, packet_info *pinfo, proto_tree *m3ua_tree)
410 guint8 version, reserved, message_class, message_type;
411 guint32 message_length;
412 /* Extract the common header */
413 version = tvb_get_guint8(common_header_tvb, VERSION_OFFSET);
414 reserved = tvb_get_guint8(common_header_tvb, RESERVED_OFFSET);
415 message_class = tvb_get_guint8(common_header_tvb, MESSAGE_CLASS_OFFSET);
416 message_type = tvb_get_guint8(common_header_tvb, MESSAGE_TYPE_OFFSET);
417 message_length = tvb_get_ntohl (common_header_tvb, MESSAGE_LENGTH_OFFSET);
419 if (check_col(pinfo->fd, COL_INFO)) {
420 col_append_str(pinfo->fd, COL_INFO, val_to_str(message_class * 256 + message_type, m3ua_message_class_type_acro_values, "reserved"));
421 col_append_str(pinfo->fd, COL_INFO, " ");
425 /* add the components of the common header to the protocol tree */
426 proto_tree_add_uint_format(m3ua_tree, hf_m3ua_version,
427 common_header_tvb, VERSION_OFFSET, VERSION_LENGTH,
428 version, "Version: %u (%s)",
429 version, val_to_str(version, m3ua_protocol_version_values, "unknown"));
430 proto_tree_add_uint(m3ua_tree, hf_m3ua_reserved,
431 common_header_tvb, RESERVED_OFFSET, RESERVED_LENGTH,
433 proto_tree_add_uint_format(m3ua_tree, hf_m3ua_message_class,
434 common_header_tvb, MESSAGE_CLASS_OFFSET, MESSAGE_CLASS_LENGTH,
435 message_class, "Message class: %u (%s)",
436 message_class, val_to_str(message_class, m3ua_message_class_values, "reserved"));
437 proto_tree_add_uint_format(m3ua_tree, hf_m3ua_message_type,
438 common_header_tvb, MESSAGE_TYPE_OFFSET, MESSAGE_TYPE_LENGTH,
439 message_type, "Message type: %u (%s)",
440 message_type, val_to_str(message_class * 256 + message_type, m3ua_message_class_type_values, "reserved"));
441 proto_tree_add_uint(m3ua_tree, hf_m3ua_message_length,
442 common_header_tvb, MESSAGE_LENGTH_OFFSET, MESSAGE_LENGTH_LENGTH,
448 dissect_m3ua_network_appearance_parameter(tvbuff_t *parameter_tvb, proto_tree *parameter_tree, proto_item *parameter_item)
450 guint32 network_appearance;
452 network_appearance = tvb_get_ntohl(parameter_tvb, NETWORK_APPEARANCE_OFFSET);
454 proto_tree_add_uint(parameter_tree, hf_m3ua_network_appearance,
455 parameter_tvb, NETWORK_APPEARANCE_OFFSET, NETWORK_APPEARANCE_LENGTH,
458 proto_item_set_text(parameter_item, "Network appearance: %u", network_appearance);
462 dissect_m3ua_protocol_data_parameter(tvbuff_t *parameter_tvb, packet_info *pinfo, proto_tree *tree, proto_tree *parameter_tree, proto_item *parameter_item)
464 guint16 length, protocol_data_length;
465 tvbuff_t *payload_tvb;
467 length = tvb_get_ntohs(parameter_tvb, PARAMETER_LENGTH_OFFSET);
468 protocol_data_length = length - PARAMETER_HEADER_LENGTH;
469 payload_tvb = tvb_new_subset(parameter_tvb, PROTOCOL_DATA_OFFSET,
470 protocol_data_length, protocol_data_length);
472 call_dissector(mtp3_handle, payload_tvb, pinfo, tree);
474 proto_item_set_text(parameter_item, "Protocol data (SS7 message of %u byte%s)",
475 protocol_data_length, plurality(protocol_data_length, "", "s"));
479 dissect_m3ua_info_parameter(tvbuff_t *parameter_tvb, proto_tree *parameter_tree, proto_item *parameter_item)
481 guint16 length, info_string_length;
484 length = tvb_get_ntohs(parameter_tvb, PARAMETER_LENGTH_OFFSET);
486 info_string_length = length - PARAMETER_HEADER_LENGTH;
487 info_string = (char *)tvb_get_ptr(parameter_tvb, INFO_STRING_OFFSET, info_string_length);
489 proto_tree_add_string(parameter_tree, hf_m3ua_info_string,
490 parameter_tvb, INFO_STRING_OFFSET, info_string_length ,
493 proto_item_set_text(parameter_item, "Info String (%s)", info_string);
497 dissect_m3ua_affected_destinations_parameter(tvbuff_t *parameter_tvb, proto_tree *parameter_tree, proto_item *parameter_item)
500 guint16 length, number_of_destinations, destination_number;
502 gint destination_offset;
503 proto_item *destination_item;
504 proto_tree *destination_tree;
506 length = tvb_get_ntohs(parameter_tvb, PARAMETER_LENGTH_OFFSET);
507 number_of_destinations= (length - PARAMETER_HEADER_LENGTH) / 4;
509 destination_offset = PARAMETER_VALUE_OFFSET;
510 for(destination_number=1; destination_number <= number_of_destinations; destination_number++) {
511 mask = tvb_get_guint8(parameter_tvb, destination_offset + AFFECTED_MASK_OFFSET);
512 dpc = tvb_get_ntoh24(parameter_tvb, destination_offset + AFFECTED_DPC_OFFSET);
513 destination_item = proto_tree_add_text(parameter_tree, parameter_tvb, destination_offset, AFFECTED_DESTINATION_LENGTH,
514 "Affected destination");
515 destination_tree = proto_item_add_subtree(destination_item, ett_m3ua_affected_destination);
517 proto_tree_add_uint(destination_tree, hf_m3ua_mask,
518 parameter_tvb, destination_offset + AFFECTED_MASK_OFFSET, AFFECTED_MASK_LENGTH,
520 proto_tree_add_uint(destination_tree, hf_m3ua_dpc,
521 parameter_tvb, destination_offset + AFFECTED_DPC_OFFSET, AFFECTED_DPC_LENGTH,
523 destination_offset += AFFECTED_DESTINATION_LENGTH;
525 proto_item_set_text(parameter_item, "Affected destinations parameter (%u destination%s)",
526 number_of_destinations, plurality(number_of_destinations, "", "s"));
531 dissect_m3ua_routing_context_parameter(tvbuff_t *parameter_tvb, proto_tree *parameter_tree, proto_item *parameter_item)
533 guint16 length, number_of_contexts, context_number;
537 length = tvb_get_ntohs(parameter_tvb, PARAMETER_LENGTH_OFFSET);
538 number_of_contexts = (length - PARAMETER_HEADER_LENGTH) / 4;
540 context_offset = PARAMETER_VALUE_OFFSET;
541 for(context_number=1; context_number <= number_of_contexts; context_number++) {
542 context = tvb_get_ntohl(parameter_tvb, context_offset);
543 proto_tree_add_uint(parameter_tree, hf_m3ua_routing_context,
544 parameter_tvb, context_offset, ROUTING_CONTEXT_LENGTH,
546 context_offset += ROUTING_CONTEXT_LENGTH;
548 proto_item_set_text(parameter_item, "Routing context parameter (%u context%s)",
549 number_of_contexts, plurality(number_of_contexts, "", "s"));
553 dissect_m3ua_diagnostic_information_parameter(tvbuff_t *parameter_tvb, proto_tree *parameter_tree, proto_item *parameter_item)
555 guint16 length, diagnostic_info_length;
557 length = tvb_get_ntohs(parameter_tvb, PARAMETER_LENGTH_OFFSET);
559 diagnostic_info_length = length - PARAMETER_HEADER_LENGTH;
561 proto_tree_add_text(parameter_tree, parameter_tvb, PARAMETER_VALUE_OFFSET, diagnostic_info_length,
562 "Diagnostic information (%u byte%s)",
563 diagnostic_info_length, plurality(diagnostic_info_length, "", "s"));
565 proto_item_set_text(parameter_item, "Diagnostic information (%u byte%s)",
566 diagnostic_info_length, plurality(diagnostic_info_length, "", "s"));
570 dissect_m3ua_heartbeat_data_parameter(tvbuff_t *parameter_tvb, proto_tree *parameter_tree, proto_item *parameter_item)
572 guint16 length, heartbeat_data_length;
574 length = tvb_get_ntohs(parameter_tvb, PARAMETER_LENGTH_OFFSET);
576 heartbeat_data_length = length - PARAMETER_HEADER_LENGTH;
578 proto_tree_add_text(parameter_tree, parameter_tvb, PARAMETER_VALUE_OFFSET, heartbeat_data_length,
579 "Heartbeat data (%u byte%s)",
580 heartbeat_data_length, plurality(heartbeat_data_length, "", "s"));
582 proto_item_set_text(parameter_item, "Heartbeat data (%u byte%s)",
583 heartbeat_data_length, plurality(heartbeat_data_length, "", "s"));
587 dissect_m3ua_user_cause_parameter(tvbuff_t *parameter_tvb, proto_tree *parameter_tree, proto_item *parameter_item)
591 cause = tvb_get_ntohs(parameter_tvb, CAUSE_OFFSET);
592 user = tvb_get_ntohs(parameter_tvb, USER_OFFSET);
594 proto_tree_add_uint_format(parameter_tree, hf_m3ua_unavailability_cause,
595 parameter_tvb, CAUSE_OFFSET, CAUSE_LENGTH,
596 cause, "Unavailability cause: %u (%s)",
597 cause, val_to_str(cause, m3ua_unavailability_cause_values, "unknown"));
598 proto_tree_add_uint_format(parameter_tree, hf_m3ua_user_identity,
599 parameter_tvb, USER_OFFSET, USER_LENGTH,
600 user, "User identity: %u (%s)",
601 user, val_to_str(user, m3ua_user_identity_values, "unknown"));
602 proto_item_set_text(parameter_item, "User / Cause parameter (%s: %s)",
603 val_to_str(user, m3ua_user_identity_values, "Unknown user"),
604 val_to_str(cause, m3ua_unavailability_cause_values, "unknown cause"));
608 dissect_m3ua_reason_parameter(tvbuff_t *parameter_tvb, proto_tree *parameter_tree, proto_item *parameter_item)
612 reason = tvb_get_ntohl(parameter_tvb, REASON_OFFSET);
614 proto_tree_add_uint_format(parameter_tree, hf_m3ua_reason,
615 parameter_tvb, REASON_OFFSET, REASON_LENGTH,
616 reason, "Reason: %u (%s)",
617 reason, val_to_str(reason, m3ua_reason_values, "unknown"));
618 proto_item_set_text(parameter_item, "Reason parameter (%s)",
619 val_to_str(reason, m3ua_reason_values, "unknown"));
623 dissect_m3ua_traffic_mode_type_parameter(tvbuff_t *parameter_tvb, proto_tree *parameter_tree, proto_item *parameter_item)
625 guint32 traffic_mode_type;
627 traffic_mode_type = tvb_get_ntohl(parameter_tvb, TRAFFIC_MODE_TYPE_OFFSET);
629 proto_tree_add_uint_format(parameter_tree, hf_m3ua_traffic_mode_type,
630 parameter_tvb, TRAFFIC_MODE_TYPE_OFFSET, TRAFFIC_MODE_TYPE_LENGTH,
631 traffic_mode_type, "Traffic mode type: %u (%s)",
632 traffic_mode_type, val_to_str(traffic_mode_type, m3ua_traffic_mode_type_values, "unknown"));
633 proto_item_set_text(parameter_item, "Traffic mode type parameter (%s)",
634 val_to_str(traffic_mode_type, m3ua_traffic_mode_type_values, "unknown"));
638 dissect_m3ua_error_code_parameter(tvbuff_t *parameter_tvb, proto_tree *parameter_tree, proto_item *parameter_item)
642 error_code = tvb_get_ntohl(parameter_tvb, ERROR_CODE_OFFSET);
643 proto_tree_add_uint_format(parameter_tree, hf_m3ua_error_code,
644 parameter_tvb, ERROR_CODE_OFFSET, ERROR_CODE_LENGTH,
645 error_code, "Error code: %u (%s)",
646 error_code, val_to_str(error_code, m3ua_error_code_values, "unknown"));
647 proto_item_set_text(parameter_item, "Error code parameter (%s)",
648 val_to_str(error_code, m3ua_error_code_values, "unknown"));
652 dissect_m3ua_status_type_parameter(tvbuff_t *parameter_tvb, proto_tree *parameter_tree, proto_item *parameter_item)
654 guint16 status_type, status_info;
656 status_type = tvb_get_ntohs(parameter_tvb, STATUS_TYPE_OFFSET);
657 status_info = tvb_get_ntohs(parameter_tvb, STATUS_INFO_OFFSET);
659 proto_tree_add_uint_format(parameter_tree, hf_m3ua_status_type,
660 parameter_tvb, STATUS_TYPE_OFFSET, STATUS_TYPE_LENGTH,
661 status_type, "Status type: %u (%s)",
662 status_type, val_to_str(status_type, m3ua_status_type_values, "unknown"));
663 proto_tree_add_uint_format(parameter_tree, hf_m3ua_status_info,
664 parameter_tvb, STATUS_INFO_OFFSET, STATUS_INFO_LENGTH,
665 status_info, "Status info: %u (%s)",
666 status_info, val_to_str(status_type * 256 * 256 +
667 status_info, m3ua_status_type_info_values, "unknown"));
669 proto_item_set_text(parameter_item, "Status type / ID (%s)",
670 val_to_str(status_type * 256 * 256 +
671 status_info, m3ua_status_type_info_values, "unknown status information"));
675 dissect_m3ua_congestion_indication_parameter(tvbuff_t *parameter_tvb, proto_tree *parameter_tree, proto_item *parameter_item)
679 level = tvb_get_guint8(parameter_tvb, CONG_IND_LEVEL_OFFSET);
681 proto_tree_add_text(parameter_tree, parameter_tvb, CONG_IND_RESERVED_OFFSET, CONG_IND_RESERVED_LENGTH,
682 "Reserved: %u byte%s",
683 CONG_IND_RESERVED_LENGTH, plurality(CONG_IND_RESERVED_LENGTH, "", "s"));
684 proto_tree_add_uint_format(parameter_tree, hf_m3ua_congestion_level,
685 parameter_tvb, CONG_IND_LEVEL_OFFSET, CONG_IND_LEVEL_LENGTH,
686 level, "Congestion level: %u (%s)",
687 level, val_to_str(level, m3ua_congestion_level_values, "unknown"));
688 proto_item_set_text(parameter_item, "Congestion indication (%s)",
689 val_to_str(level, m3ua_congestion_level_values, "unknown"));
693 dissect_m3ua_unknown_parameter(tvbuff_t *parameter_tvb, proto_tree *parameter_tree, proto_item *parameter_item)
695 guint16 tag, length, parameter_value_length;
697 tag = tvb_get_ntohs(parameter_tvb, PARAMETER_TAG_OFFSET);
698 length = tvb_get_ntohs(parameter_tvb, PARAMETER_LENGTH_OFFSET);
700 parameter_value_length = length - PARAMETER_HEADER_LENGTH;
702 proto_tree_add_text(parameter_tree, parameter_tvb, PARAMETER_VALUE_OFFSET, parameter_value_length,
703 "Parameter value (%u byte%s)",
704 parameter_value_length, plurality(parameter_value_length, "", "s"));
706 proto_item_set_text(parameter_item, "Parameter with tag %u and %u byte%s value",
707 tag, parameter_value_length, plurality(parameter_value_length, "", "s"));
711 dissect_m3ua_parameter(tvbuff_t *parameter_tvb, packet_info *pinfo, proto_tree *tree, proto_tree *m3ua_tree)
713 guint16 tag, length, padding_length, total_length;
714 proto_item *parameter_item;
715 proto_tree *parameter_tree;
717 /* extract tag and length from the parameter */
718 tag = tvb_get_ntohs(parameter_tvb, PARAMETER_TAG_OFFSET);
719 length = tvb_get_ntohs(parameter_tvb, PARAMETER_LENGTH_OFFSET);
721 /* calculate padding and total length */
722 padding_length = nr_of_padding_bytes(length);
723 total_length = length + padding_length;
725 /* create proto_tree stuff */
726 parameter_item = proto_tree_add_text(m3ua_tree, parameter_tvb,
727 PARAMETER_HEADER_OFFSET, total_length, "Incomplete parameter");
728 parameter_tree = proto_item_add_subtree(parameter_item, ett_m3ua_parameter);
730 /* add tag and length to the m3ua tree */
731 proto_tree_add_uint_format(parameter_tree, hf_m3ua_parameter_tag,
732 parameter_tvb, PARAMETER_TAG_OFFSET, PARAMETER_TAG_LENGTH,
733 tag, "Identifier: %u (%s)",
734 tag, val_to_str(tag, m3ua_parameter_tag_values, "unknown"));
735 proto_tree_add_uint(parameter_tree, hf_m3ua_parameter_length,
736 parameter_tvb, PARAMETER_LENGTH_OFFSET, PARAMETER_LENGTH_LENGTH,
740 case NETWORK_APPEARANCE_PARAMETER_TAG:
741 dissect_m3ua_network_appearance_parameter(parameter_tvb, parameter_tree, parameter_item);
743 case PROTOCOL_DATA_PARAMETER_TAG:
744 dissect_m3ua_protocol_data_parameter(parameter_tvb, pinfo, tree, parameter_tree, parameter_item);
746 case INFO_PARAMETER_TAG:
747 dissect_m3ua_info_parameter(parameter_tvb, parameter_tree, parameter_item);
749 case AFFECTED_DESTINATIONS_PARAMETER_TAG:
750 dissect_m3ua_affected_destinations_parameter(parameter_tvb, parameter_tree, parameter_item);
752 case ROUTING_CONTEXT_PARAMETER_TAG:
753 dissect_m3ua_routing_context_parameter(parameter_tvb, parameter_tree, parameter_item);
755 case DIAGNOSTIC_INFORMATION_PARAMETER_TAG:
756 dissect_m3ua_diagnostic_information_parameter(parameter_tvb, parameter_tree, parameter_item);
758 case HEARTBEAT_DATA_PARAMETER_TAG:
759 dissect_m3ua_heartbeat_data_parameter(parameter_tvb, parameter_tree, parameter_item);
761 case USER_CAUSE_PARAMETER_TAG:
762 dissect_m3ua_user_cause_parameter(parameter_tvb, parameter_tree, parameter_item);
764 case REASON_PARAMETER_TAG:
765 dissect_m3ua_reason_parameter(parameter_tvb, parameter_tree, parameter_item);
767 case TRAFFIC_MODE_TYPE_PARAMETER_TAG:
768 dissect_m3ua_traffic_mode_type_parameter(parameter_tvb, parameter_tree, parameter_item);
770 case ERROR_CODE_PARAMETER_TAG:
771 dissect_m3ua_error_code_parameter(parameter_tvb, parameter_tree, parameter_item);
773 case STATUS_TYPE_PARAMETER_TAG:
774 dissect_m3ua_status_type_parameter(parameter_tvb, parameter_tree, parameter_item);
776 case CONGESTION_INDICATION_PARAMETER_TAG:
777 dissect_m3ua_congestion_indication_parameter(parameter_tvb, parameter_tree, parameter_item);
780 dissect_m3ua_unknown_parameter(parameter_tvb, parameter_tree, parameter_item);
784 if (padding_length > 0)
785 proto_tree_add_text(parameter_tree, parameter_tvb, PARAMETER_HEADER_OFFSET + length, padding_length,
786 "Padding: %u byte%s",
787 padding_length, plurality(padding_length, "", "s"));
791 dissect_m3ua_message(tvbuff_t *message_tvb, packet_info *pinfo, proto_tree *tree, proto_tree *m3ua_tree)
793 gint offset, length, padding_length, total_length;
794 tvbuff_t *common_header_tvb, *parameter_tvb;
798 /* extract and process the common header */
799 common_header_tvb = tvb_new_subset(message_tvb, offset, COMMON_HEADER_LENGTH, COMMON_HEADER_LENGTH);
800 dissect_m3ua_common_header(common_header_tvb, pinfo, m3ua_tree);
801 offset += COMMON_HEADER_LENGTH;
804 /* extract zero or more parameters and process them individually */
805 while(tvb_length_remaining(message_tvb, offset)) {
806 length = tvb_get_ntohs(message_tvb, offset + PARAMETER_LENGTH_OFFSET);
807 padding_length = nr_of_padding_bytes(length);
808 total_length = length + padding_length;
809 /* create a tvb for the parameter including the padding bytes */
810 parameter_tvb = tvb_new_subset(message_tvb, offset, total_length, total_length);
811 dissect_m3ua_parameter(parameter_tvb, pinfo, tree, m3ua_tree);
812 /* get rid of the handled parameter */
813 offset += total_length;
819 dissect_m3ua(tvbuff_t *message_tvb, packet_info *pinfo, proto_tree *tree)
821 proto_item *m3ua_item;
822 proto_tree *m3ua_tree;
824 /* make entry in the Protocol column on summary display */
825 if (check_col(pinfo->fd, COL_PROTOCOL))
826 col_set_str(pinfo->fd, COL_PROTOCOL, "M3UA");
828 /* In the interest of speed, if "tree" is NULL, don't do any work not
829 necessary to generate protocol tree items. */
831 /* create the m3ua protocol tree */
832 m3ua_item = proto_tree_add_item(tree, proto_m3ua, message_tvb, 0, tvb_length(message_tvb), FALSE);
833 m3ua_tree = proto_item_add_subtree(m3ua_item, ett_m3ua);
837 /* dissect the message */
838 dissect_m3ua_message(message_tvb, pinfo, tree, m3ua_tree);
841 /* Register the protocol with Ethereal */
843 proto_register_m3ua(void)
846 /* Setup list of header fields */
847 static hf_register_info hf[] = {
849 { "Version", "m3ua.version",
850 FT_UINT8, BASE_DEC, NULL, 0x0,
854 { "Reserved", "m3ua.reserved",
855 FT_UINT8, BASE_HEX, NULL, 0x0,
858 { &hf_m3ua_message_class,
859 { "Message class", "m3ua.message_class",
860 FT_UINT8, BASE_DEC, NULL, 0x0,
863 { &hf_m3ua_message_type,
864 { "Message Type", "m3ua.message_type",
865 FT_UINT8, BASE_DEC, NULL, 0x0,
868 { &hf_m3ua_message_length,
869 { "Message length", "m3ua.message_length",
870 FT_UINT32, BASE_DEC, NULL, 0x0,
873 { &hf_m3ua_parameter_tag,
874 { "Parameter Tag", "m3ua.parameter_tag",
875 FT_UINT16, BASE_DEC, NULL, 0x0,
878 { &hf_m3ua_parameter_length,
879 { "Parameter length", "m3ua.parameter_length",
880 FT_UINT16, BASE_DEC, NULL, 0x0,
883 { &hf_m3ua_network_appearance,
884 { "Network appearance", "m3ua.network_appearance",
885 FT_UINT32, BASE_DEC, NULL, 0x0,
888 { &hf_m3ua_info_string,
889 { "Info string", "m3ua.info_string",
890 FT_STRING, BASE_DEC, NULL, 0x0,
893 { &hf_m3ua_error_code,
894 { "Error code", "m3ua.error_code",
895 FT_UINT32, BASE_DEC, NULL, 0x0,
898 { &hf_m3ua_status_type,
899 { "Status type", "m3ua.status_type",
900 FT_UINT16, BASE_DEC, NULL, 0x0,
903 { &hf_m3ua_status_info,
904 { "Status info", "m3ua.status_info",
905 FT_UINT16, BASE_DEC, NULL, 0x0,
908 { &hf_m3ua_unavailability_cause,
909 { "Unavailability cause", "m3ua.unavailability_cause",
910 FT_UINT16, BASE_DEC, NULL, 0x0,
913 { &hf_m3ua_user_identity,
914 { "User Identity", "m3ua.user_identity",
915 FT_UINT16, BASE_DEC, NULL, 0x0,
919 { "Reason", "m3ua.reason",
920 FT_UINT32, BASE_DEC, NULL, 0x0,
923 { &hf_m3ua_traffic_mode_type,
924 { "Traffic mode Type", "m3ua.traffic_mode_type",
925 FT_UINT32, BASE_DEC, NULL, 0x0,
928 { &hf_m3ua_routing_context,
929 { "Routing context", "m3ua.routing_context",
930 FT_UINT32, BASE_DEC, NULL, 0x0,
934 { "Mask", "m3ua.mask",
935 FT_UINT8, BASE_DEC, NULL, 0x0,
939 { "Affected DPC", "m3ua.affected_dpc",
940 FT_UINT24, BASE_DEC, NULL, 0x0,
943 { &hf_m3ua_congestion_level,
944 { "Congestion level", "m3ua.congestion_level",
945 FT_UINT8, BASE_DEC, NULL, 0x0,
950 /* Setup protocol subtree array */
951 static gint *ett[] = {
954 &ett_m3ua_affected_destination,
957 /* Register the protocol name and description */
958 proto_m3ua = proto_register_protocol("MTP 3 User Adaptation Layer",
961 /* Required function calls to register the header fields and subtrees used */
962 proto_register_field_array(proto_m3ua, hf, array_length(hf));
963 proto_register_subtree_array(ett, array_length(ett));
967 proto_reg_handoff_m3ua(void)
969 dissector_handle_t m3ua_handle;
972 * Get a handle for the MTP3 dissector.
974 mtp3_handle = find_dissector("mtp3");
976 m3ua_handle = create_dissector_handle(dissect_m3ua, proto_m3ua);
977 dissector_add("sctp.ppi", M3UA_PAYLOAD_PROTO_ID, m3ua_handle);
978 dissector_add("sctp.port", SCTP_PORT_M3UA, m3ua_handle);