2 * Copyright (c) 1998-2006 The TCPDUMP project
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that: (1) source code
6 * distributions retain the above copyright notice and this paragraph
7 * in its entirety, and (2) distributions including binary code include
8 * the above copyright notice and this paragraph in its entirety in
9 * the documentation or other materials provided with the distribution.
10 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND
11 * WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
12 * LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
13 * FOR A PARTICULAR PURPOSE.
15 * Support for the IEEE Connectivity Fault Management Protocols as per 802.1ag.
17 * Original code by Hannes Gredler (hannes@juniper.net)
20 #include <sys/cdefs.h>
22 __RCSID("$NetBSD: print-cfm.c,v 1.6 2015/03/31 21:59:35 christos Exp $");
25 #define NETDISSECT_REWORKED
30 #include <tcpdump-stdinc.h>
34 #include "interface.h"
37 #include "addrtoname.h"
41 struct cfm_common_header_t
{
42 uint8_t mdlevel_version
;
45 uint8_t first_tlv_offset
;
49 #define CFM_EXTRACT_VERSION(x) (((x)&0x1f))
50 #define CFM_EXTRACT_MD_LEVEL(x) (((x)&0xe0)>>5)
52 #define CFM_OPCODE_CCM 1
53 #define CFM_OPCODE_LBR 2
54 #define CFM_OPCODE_LBM 3
55 #define CFM_OPCODE_LTR 4
56 #define CFM_OPCODE_LTM 5
58 static const struct tok cfm_opcode_values
[] = {
59 { CFM_OPCODE_CCM
, "Continouity Check Message"},
60 { CFM_OPCODE_LBR
, "Loopback Reply"},
61 { CFM_OPCODE_LBM
, "Loopback Message"},
62 { CFM_OPCODE_LTR
, "Linktrace Reply"},
63 { CFM_OPCODE_LTM
, "Linktrace Message"},
73 uint8_t md_nameformat
;
74 uint8_t md_namelength
;
75 uint8_t md_name
[46]; /* md name and short ma name */
76 uint8_t reserved_itu
[16];
81 * Timer Bases for the CCM Interval field.
82 * Expressed in units of seconds.
84 const float ccm_interval_base
[8] = {0, 0.003333, 0.01, 0.1, 1, 10, 60, 600};
85 #define CCM_INTERVAL_MIN_MULTIPLIER 3.25
86 #define CCM_INTERVAL_MAX_MULTIPLIER 3.5
88 #define CFM_CCM_RDI_FLAG 0x80
89 #define CFM_EXTRACT_CCM_INTERVAL(x) (((x)&0x07))
91 #define CFM_CCM_MD_FORMAT_8021 0
92 #define CFM_CCM_MD_FORMAT_NONE 1
93 #define CFM_CCM_MD_FORMAT_DNS 2
94 #define CFM_CCM_MD_FORMAT_MAC 3
95 #define CFM_CCM_MD_FORMAT_CHAR 4
97 static const struct tok cfm_md_nameformat_values
[] = {
98 { CFM_CCM_MD_FORMAT_8021
, "IEEE 802.1"},
99 { CFM_CCM_MD_FORMAT_NONE
, "No MD Name present"},
100 { CFM_CCM_MD_FORMAT_DNS
, "DNS string"},
101 { CFM_CCM_MD_FORMAT_MAC
, "MAC + 16Bit Integer"},
102 { CFM_CCM_MD_FORMAT_CHAR
, "Character string"},
106 #define CFM_CCM_MA_FORMAT_8021 0
107 #define CFM_CCM_MA_FORMAT_VID 1
108 #define CFM_CCM_MA_FORMAT_CHAR 2
109 #define CFM_CCM_MA_FORMAT_INT 3
110 #define CFM_CCM_MA_FORMAT_VPN 4
112 static const struct tok cfm_ma_nameformat_values
[] = {
113 { CFM_CCM_MA_FORMAT_8021
, "IEEE 802.1"},
114 { CFM_CCM_MA_FORMAT_VID
, "Primary VID"},
115 { CFM_CCM_MA_FORMAT_CHAR
, "Character string"},
116 { CFM_CCM_MA_FORMAT_INT
, "16Bit Integer"},
117 { CFM_CCM_MA_FORMAT_VPN
, "RFC2685 VPN-ID"},
122 uint8_t transaction_id
[4];
127 uint8_t transaction_id
[4];
128 uint8_t egress_id
[8];
130 uint8_t original_mac
[ETHER_ADDR_LEN
];
131 uint8_t target_mac
[ETHER_ADDR_LEN
];
135 static const struct tok cfm_ltm_flag_values
[] = {
136 { 0x80, "Use Forwarding-DB only"},
141 uint8_t transaction_id
[4];
142 uint8_t last_egress_id
[8];
143 uint8_t next_egress_id
[8];
145 uint8_t replay_action
;
149 static const struct tok cfm_ltr_flag_values
[] = {
150 { 0x80, "UseFDB Only"},
152 { 0x20, "Terminal MEP"},
156 static const struct tok cfm_ltr_replay_action_values
[] = {
158 { 2, "Filtering DB"},
164 #define CFM_TLV_END 0
165 #define CFM_TLV_SENDER_ID 1
166 #define CFM_TLV_PORT_STATUS 2
167 #define CFM_TLV_INTERFACE_STATUS 3
168 #define CFM_TLV_DATA 4
169 #define CFM_TLV_REPLY_INGRESS 5
170 #define CFM_TLV_REPLY_EGRESS 6
171 #define CFM_TLV_PRIVATE 31
173 static const struct tok cfm_tlv_values
[] = {
174 { CFM_TLV_END
, "End"},
175 { CFM_TLV_SENDER_ID
, "Sender ID"},
176 { CFM_TLV_PORT_STATUS
, "Port status"},
177 { CFM_TLV_INTERFACE_STATUS
, "Interface status"},
178 { CFM_TLV_DATA
, "Data"},
179 { CFM_TLV_REPLY_INGRESS
, "Reply Ingress"},
180 { CFM_TLV_REPLY_EGRESS
, "Reply Egress"},
181 { CFM_TLV_PRIVATE
, "Organization Specific"},
189 struct cfm_tlv_header_t
{
194 /* FIXME define TLV formats */
196 static const struct tok cfm_tlv_port_status_values
[] = {
202 static const struct tok cfm_tlv_interface_status_values
[] = {
208 { 7, "lower Layer down"},
212 #define CFM_CHASSIS_ID_CHASSIS_COMPONENT 1
213 #define CFM_CHASSIS_ID_INTERFACE_ALIAS 2
214 #define CFM_CHASSIS_ID_PORT_COMPONENT 3
215 #define CFM_CHASSIS_ID_MAC_ADDRESS 4
216 #define CFM_CHASSIS_ID_NETWORK_ADDRESS 5
217 #define CFM_CHASSIS_ID_INTERFACE_NAME 6
218 #define CFM_CHASSIS_ID_LOCAL 7
220 static const struct tok cfm_tlv_senderid_chassisid_values
[] = {
222 { CFM_CHASSIS_ID_CHASSIS_COMPONENT
, "Chassis component"},
223 { CFM_CHASSIS_ID_INTERFACE_ALIAS
, "Interface alias"},
224 { CFM_CHASSIS_ID_PORT_COMPONENT
, "Port component"},
225 { CFM_CHASSIS_ID_MAC_ADDRESS
, "MAC address"},
226 { CFM_CHASSIS_ID_NETWORK_ADDRESS
, "Network address"},
227 { CFM_CHASSIS_ID_INTERFACE_NAME
, "Interface name"},
228 { CFM_CHASSIS_ID_LOCAL
, "Locally assigned"},
234 cfm_mgmt_addr_print(netdissect_options
*ndo
,
235 register const u_char
*tptr
)
237 u_int mgmt_addr_type
;
238 u_int hexdump
= FALSE
;
241 * Altough AFIs are tpically 2 octects wide,
242 * 802.1ab specifies that this field width
245 mgmt_addr_type
= *tptr
;
246 ND_PRINT((ndo
, "\n\t Management Address Type %s (%u)",
247 tok2str(af_values
, "Unknown", mgmt_addr_type
),
251 * Resolve the passed in Address.
253 switch(mgmt_addr_type
) {
255 ND_PRINT((ndo
, ", %s", ipaddr_string(ndo
, tptr
+ 1)));
260 ND_PRINT((ndo
, ", %s", ip6addr_string(ndo
, tptr
+ 1)));
273 * The egress-ID string is a 16-Bit string plus a MAC address.
276 cfm_egress_id_string(netdissect_options
*ndo
, register const u_char
*tptr
)
278 static char egress_id_buffer
[80];
280 snprintf(egress_id_buffer
, sizeof(egress_id_buffer
),
282 EXTRACT_16BITS(tptr
),
283 etheraddr_string(ndo
, tptr
+2));
285 return egress_id_buffer
;
289 cfm_print(netdissect_options
*ndo
,
290 register const u_char
*pptr
, register u_int length
)
292 const struct cfm_common_header_t
*cfm_common_header
;
293 const struct cfm_tlv_header_t
*cfm_tlv_header
;
294 const uint8_t *tptr
, *tlv_ptr
, *ma_name
, *ma_nameformat
, *ma_namelength
;
295 u_int hexdump
, tlen
, cfm_tlv_len
, cfm_tlv_type
, ccm_interval
;
299 const struct cfm_ccm_t
*cfm_ccm
;
300 const struct cfm_lbm_t
*cfm_lbm
;
301 const struct cfm_ltm_t
*cfm_ltm
;
302 const struct cfm_ltr_t
*cfm_ltr
;
306 cfm_common_header
= (const struct cfm_common_header_t
*)pptr
;
307 ND_TCHECK(*cfm_common_header
);
310 * Sanity checking of the header.
312 if (CFM_EXTRACT_VERSION(cfm_common_header
->mdlevel_version
) != CFM_VERSION
) {
313 ND_PRINT((ndo
, "CFMv%u not supported, length %u",
314 CFM_EXTRACT_VERSION(cfm_common_header
->mdlevel_version
), length
));
318 ND_PRINT((ndo
, "CFMv%u %s, MD Level %u, length %u",
319 CFM_EXTRACT_VERSION(cfm_common_header
->mdlevel_version
),
320 tok2str(cfm_opcode_values
, "unknown (%u)", cfm_common_header
->opcode
),
321 CFM_EXTRACT_MD_LEVEL(cfm_common_header
->mdlevel_version
),
325 * In non-verbose mode just print the opcode and md-level.
327 if (ndo
->ndo_vflag
< 1) {
331 ND_PRINT((ndo
, "\n\tFirst TLV offset %u", cfm_common_header
->first_tlv_offset
));
333 tptr
+= sizeof(const struct cfm_common_header_t
);
334 tlen
= length
- sizeof(struct cfm_common_header_t
);
336 switch (cfm_common_header
->opcode
) {
338 msg_ptr
.cfm_ccm
= (const struct cfm_ccm_t
*)tptr
;
340 ccm_interval
= CFM_EXTRACT_CCM_INTERVAL(cfm_common_header
->flags
);
341 ND_PRINT((ndo
, ", Flags [CCM Interval %u%s]",
343 cfm_common_header
->flags
& CFM_CCM_RDI_FLAG
?
347 * Resolve the CCM interval field.
350 ND_PRINT((ndo
, "\n\t CCM Interval %.3fs"
351 ", min CCM Lifetime %.3fs, max CCM Lifetime %.3fs",
352 ccm_interval_base
[ccm_interval
],
353 ccm_interval_base
[ccm_interval
] * CCM_INTERVAL_MIN_MULTIPLIER
,
354 ccm_interval_base
[ccm_interval
] * CCM_INTERVAL_MAX_MULTIPLIER
));
357 ND_PRINT((ndo
, "\n\t Sequence Number 0x%08x, MA-End-Point-ID 0x%04x",
358 EXTRACT_32BITS(msg_ptr
.cfm_ccm
->sequence
),
359 EXTRACT_16BITS(msg_ptr
.cfm_ccm
->ma_epi
)));
363 * Resolve the MD fields.
365 ND_PRINT((ndo
, "\n\t MD Name Format %s (%u), MD Name length %u",
366 tok2str(cfm_md_nameformat_values
, "Unknown",
367 msg_ptr
.cfm_ccm
->md_nameformat
),
368 msg_ptr
.cfm_ccm
->md_nameformat
,
369 msg_ptr
.cfm_ccm
->md_namelength
));
371 if (msg_ptr
.cfm_ccm
->md_nameformat
!= CFM_CCM_MD_FORMAT_NONE
) {
372 ND_PRINT((ndo
, "\n\t MD Name: "));
373 switch (msg_ptr
.cfm_ccm
->md_nameformat
) {
374 case CFM_CCM_MD_FORMAT_DNS
:
375 case CFM_CCM_MD_FORMAT_CHAR
:
376 safeputs(ndo
, msg_ptr
.cfm_ccm
->md_name
, msg_ptr
.cfm_ccm
->md_namelength
);
379 case CFM_CCM_MD_FORMAT_MAC
:
380 ND_PRINT((ndo
, "\n\t MAC %s", etheraddr_string(ndo
,
381 msg_ptr
.cfm_ccm
->md_name
)));
384 /* FIXME add printers for those MD formats - hexdump for now */
385 case CFM_CCM_MA_FORMAT_8021
:
387 print_unknown_data(ndo
, msg_ptr
.cfm_ccm
->md_name
, "\n\t ",
388 msg_ptr
.cfm_ccm
->md_namelength
);
394 * Resolve the MA fields.
396 ma_nameformat
= msg_ptr
.cfm_ccm
->md_name
+ msg_ptr
.cfm_ccm
->md_namelength
;
397 ma_namelength
= msg_ptr
.cfm_ccm
->md_name
+ msg_ptr
.cfm_ccm
->md_namelength
+ 1;
398 ma_name
= msg_ptr
.cfm_ccm
->md_name
+ msg_ptr
.cfm_ccm
->md_namelength
+ 2;
400 ND_PRINT((ndo
, "\n\t MA Name-Format %s (%u), MA name length %u",
401 tok2str(cfm_ma_nameformat_values
, "Unknown",
406 ND_PRINT((ndo
, "\n\t MA Name: "));
407 switch (*ma_nameformat
) {
408 case CFM_CCM_MA_FORMAT_CHAR
:
409 safeputs(ndo
, ma_name
, *ma_namelength
);
412 /* FIXME add printers for those MA formats - hexdump for now */
413 case CFM_CCM_MA_FORMAT_8021
:
414 case CFM_CCM_MA_FORMAT_VID
:
415 case CFM_CCM_MA_FORMAT_INT
:
416 case CFM_CCM_MA_FORMAT_VPN
:
418 print_unknown_data(ndo
, ma_name
, "\n\t ", *ma_namelength
);
423 msg_ptr
.cfm_ltm
= (const struct cfm_ltm_t
*)tptr
;
425 ND_PRINT((ndo
, ", Flags [%s]",
426 bittok2str(cfm_ltm_flag_values
, "none", cfm_common_header
->flags
)));
428 ND_PRINT((ndo
, "\n\t Transaction-ID 0x%08x, Egress-ID %s, ttl %u",
429 EXTRACT_32BITS(msg_ptr
.cfm_ltm
->transaction_id
),
430 cfm_egress_id_string(ndo
, msg_ptr
.cfm_ltm
->egress_id
),
431 msg_ptr
.cfm_ltm
->ttl
));
433 ND_PRINT((ndo
, "\n\t Original-MAC %s, Target-MAC %s",
434 etheraddr_string(ndo
, msg_ptr
.cfm_ltm
->original_mac
),
435 etheraddr_string(ndo
, msg_ptr
.cfm_ltm
->target_mac
)));
439 msg_ptr
.cfm_ltr
= (const struct cfm_ltr_t
*)tptr
;
441 ND_PRINT((ndo
, ", Flags [%s]",
442 bittok2str(cfm_ltr_flag_values
, "none", cfm_common_header
->flags
)));
444 ND_PRINT((ndo
, "\n\t Transaction-ID 0x%08x, Last-Egress-ID %s",
445 EXTRACT_32BITS(msg_ptr
.cfm_ltr
->transaction_id
),
446 cfm_egress_id_string(ndo
, msg_ptr
.cfm_ltr
->last_egress_id
)));
448 ND_PRINT((ndo
, "\n\t Next-Egress-ID %s, ttl %u",
449 cfm_egress_id_string(ndo
, msg_ptr
.cfm_ltr
->next_egress_id
),
450 msg_ptr
.cfm_ltr
->ttl
));
452 ND_PRINT((ndo
, "\n\t Replay-Action %s (%u)",
453 tok2str(cfm_ltr_replay_action_values
,
455 msg_ptr
.cfm_ltr
->replay_action
),
456 msg_ptr
.cfm_ltr
->replay_action
));
460 * No message decoder yet.
461 * Hexdump everything up until the start of the TLVs
466 if (tlen
> cfm_common_header
->first_tlv_offset
) {
467 print_unknown_data(ndo
, tptr
, "\n\t ",
468 tlen
- cfm_common_header
->first_tlv_offset
);
474 * Sanity check for not walking off.
476 if (tlen
<= cfm_common_header
->first_tlv_offset
) {
480 tptr
+= cfm_common_header
->first_tlv_offset
;
481 tlen
-= cfm_common_header
->first_tlv_offset
;
484 cfm_tlv_header
= (const struct cfm_tlv_header_t
*)tptr
;
486 /* Enough to read the tlv type ? */
487 ND_TCHECK2(*tptr
, 1);
488 cfm_tlv_type
=cfm_tlv_header
->type
;
490 if (cfm_tlv_type
!= CFM_TLV_END
) {
491 /* did we capture enough for fully decoding the object header ? */
492 ND_TCHECK2(*tptr
, sizeof(struct cfm_tlv_header_t
));
493 cfm_tlv_len
=EXTRACT_16BITS(&cfm_tlv_header
->length
);
498 ND_PRINT((ndo
, "\n\t%s TLV (0x%02x), length %u",
499 tok2str(cfm_tlv_values
, "Unknown", cfm_tlv_type
),
503 /* sanity check for not walking off and infinite loop check. */
504 if ((cfm_tlv_type
!= CFM_TLV_END
) &&
505 ((cfm_tlv_len
+ sizeof(struct cfm_tlv_header_t
) > tlen
) ||
507 print_unknown_data(ndo
, tptr
, "\n\t ", tlen
);
511 tptr
+= sizeof(struct cfm_tlv_header_t
);
512 tlen
-= sizeof(struct cfm_tlv_header_t
);
515 /* did we capture enough for fully decoding the object ? */
516 if (cfm_tlv_type
!= CFM_TLV_END
) {
517 ND_TCHECK2(*tptr
, cfm_tlv_len
);
521 switch(cfm_tlv_type
) {
523 /* we are done - bail out */
526 case CFM_TLV_PORT_STATUS
:
527 ND_PRINT((ndo
, ", Status: %s (%u)",
528 tok2str(cfm_tlv_port_status_values
, "Unknown", *tptr
),
532 case CFM_TLV_INTERFACE_STATUS
:
533 ND_PRINT((ndo
, ", Status: %s (%u)",
534 tok2str(cfm_tlv_interface_status_values
, "Unknown", *tptr
),
538 case CFM_TLV_PRIVATE
:
539 ND_PRINT((ndo
, ", Vendor: %s (%u), Sub-Type %u",
540 tok2str(oui_values
,"Unknown", EXTRACT_24BITS(tptr
)),
541 EXTRACT_24BITS(tptr
),
546 case CFM_TLV_SENDER_ID
:
548 u_int chassis_id_type
, chassis_id_length
;
549 u_int mgmt_addr_length
;
552 * Check if there is a Chassis-ID.
554 chassis_id_length
= *tptr
;
555 if (chassis_id_length
> tlen
) {
563 if (chassis_id_length
) {
564 chassis_id_type
= *tptr
;
565 ND_PRINT((ndo
, "\n\t Chassis-ID Type %s (%u), Chassis-ID length %u",
566 tok2str(cfm_tlv_senderid_chassisid_values
,
572 switch (chassis_id_type
) {
573 case CFM_CHASSIS_ID_MAC_ADDRESS
:
574 ND_PRINT((ndo
, "\n\t MAC %s", etheraddr_string(ndo
, tptr
+ 1)));
577 case CFM_CHASSIS_ID_NETWORK_ADDRESS
:
578 hexdump
|= cfm_mgmt_addr_print(ndo
, tptr
);
581 case CFM_CHASSIS_ID_INTERFACE_NAME
: /* fall through */
582 case CFM_CHASSIS_ID_INTERFACE_ALIAS
:
583 case CFM_CHASSIS_ID_LOCAL
:
584 case CFM_CHASSIS_ID_CHASSIS_COMPONENT
:
585 case CFM_CHASSIS_ID_PORT_COMPONENT
:
586 safeputs(ndo
, tptr
+ 1, chassis_id_length
);
595 tptr
+= chassis_id_length
;
596 tlen
-= chassis_id_length
;
599 * Check if there is a Management Address.
601 mgmt_addr_length
= *tptr
;
602 if (mgmt_addr_length
> tlen
) {
610 if (mgmt_addr_length
) {
611 hexdump
|= cfm_mgmt_addr_print(ndo
, tptr
);
614 tptr
+= mgmt_addr_length
;
615 tlen
-= mgmt_addr_length
;
621 * FIXME those are the defined TLVs that lack a decoder
622 * you are welcome to contribute code ;-)
626 case CFM_TLV_REPLY_INGRESS
:
627 case CFM_TLV_REPLY_EGRESS
:
632 /* do we want to see an additional hexdump ? */
633 if (hexdump
|| ndo
->ndo_vflag
> 1)
634 print_unknown_data(ndo
, tlv_ptr
, "\n\t ", cfm_tlv_len
);
641 ND_PRINT((ndo
, "\n\t\t packet exceeded snapshot"));