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)
24 #include <tcpdump-stdinc.h>
30 #include "interface.h"
33 #include "addrtoname.h"
40 const char * cfm_egress_id_string(register const u_char
*);
41 int cfm_mgmt_addr_print(register const u_char
*);
43 struct cfm_common_header_t
{
44 u_int8_t mdlevel_version
;
47 u_int8_t first_tlv_offset
;
51 #define CFM_EXTRACT_VERSION(x) (((x)&0x1f))
52 #define CFM_EXTRACT_MD_LEVEL(x) (((x)&0xe0)>>5)
54 #define CFM_OPCODE_CCM 1
55 #define CFM_OPCODE_LBR 2
56 #define CFM_OPCODE_LBM 3
57 #define CFM_OPCODE_LTR 4
58 #define CFM_OPCODE_LTM 5
60 static const struct tok cfm_opcode_values
[] = {
61 { CFM_OPCODE_CCM
, "Continouity Check Message"},
62 { CFM_OPCODE_LBR
, "Loopback Reply"},
63 { CFM_OPCODE_LBM
, "Loopback Message"},
64 { CFM_OPCODE_LTR
, "Linktrace Reply"},
65 { CFM_OPCODE_LTM
, "Linktrace Message"},
75 u_int8_t md_nameformat
;
76 u_int8_t md_namelength
;
77 u_int8_t md_name
[46]; /* md name and short ma name */
78 u_int8_t reserved_itu
[16];
83 * Timer Bases for the CCM Interval field.
84 * Expressed in units of seconds.
86 const float ccm_interval_base
[8] = {0, 0.003333, 0.01, 0.1, 1, 10, 60, 600};
87 #define CCM_INTERVAL_MIN_MULTIPLIER 3.25
88 #define CCM_INTERVAL_MAX_MULTIPLIER 3.5
90 #define CFM_CCM_RDI_FLAG 0x80
91 #define CFM_EXTRACT_CCM_INTERVAL(x) (((x)&0x07))
93 #define CFM_CCM_MD_FORMAT_8021 0
94 #define CFM_CCM_MD_FORMAT_NONE 1
95 #define CFM_CCM_MD_FORMAT_DNS 2
96 #define CFM_CCM_MD_FORMAT_MAC 3
97 #define CFM_CCM_MD_FORMAT_CHAR 4
99 static const struct tok cfm_md_nameformat_values
[] = {
100 { CFM_CCM_MD_FORMAT_8021
, "IEEE 802.1"},
101 { CFM_CCM_MD_FORMAT_NONE
, "No MD Name present"},
102 { CFM_CCM_MD_FORMAT_DNS
, "DNS string"},
103 { CFM_CCM_MD_FORMAT_MAC
, "MAC + 16Bit Integer"},
104 { CFM_CCM_MD_FORMAT_CHAR
, "Character string"},
108 #define CFM_CCM_MA_FORMAT_8021 0
109 #define CFM_CCM_MA_FORMAT_VID 1
110 #define CFM_CCM_MA_FORMAT_CHAR 2
111 #define CFM_CCM_MA_FORMAT_INT 3
112 #define CFM_CCM_MA_FORMAT_VPN 4
114 static const struct tok cfm_ma_nameformat_values
[] = {
115 { CFM_CCM_MA_FORMAT_8021
, "IEEE 802.1"},
116 { CFM_CCM_MA_FORMAT_VID
, "Primary VID"},
117 { CFM_CCM_MA_FORMAT_CHAR
, "Character string"},
118 { CFM_CCM_MA_FORMAT_INT
, "16Bit Integer"},
119 { CFM_CCM_MA_FORMAT_VPN
, "RFC2685 VPN-ID"},
124 u_int8_t transaction_id
[4];
125 u_int8_t reserved
[4];
129 u_int8_t transaction_id
[4];
130 u_int8_t egress_id
[8];
132 u_int8_t original_mac
[ETHER_ADDR_LEN
];
133 u_int8_t target_mac
[ETHER_ADDR_LEN
];
134 u_int8_t reserved
[3];
137 static const struct tok cfm_ltm_flag_values
[] = {
138 { 0x80, "Use Forwarding-DB only"},
143 u_int8_t transaction_id
[4];
144 u_int8_t last_egress_id
[8];
145 u_int8_t next_egress_id
[8];
147 u_int8_t replay_action
;
148 u_int8_t reserved
[6];
151 static const struct tok cfm_ltr_flag_values
[] = {
152 { 0x80, "UseFDB Only"},
154 { 0x20, "Terminal MEP"},
158 static const struct tok cfm_ltr_replay_action_values
[] = {
160 { 2, "Filtering DB"},
166 #define CFM_TLV_END 0
167 #define CFM_TLV_SENDER_ID 1
168 #define CFM_TLV_PORT_STATUS 2
169 #define CFM_TLV_INTERFACE_STATUS 3
170 #define CFM_TLV_DATA 4
171 #define CFM_TLV_REPLY_INGRESS 5
172 #define CFM_TLV_REPLY_EGRESS 6
173 #define CFM_TLV_PRIVATE 31
175 static const struct tok cfm_tlv_values
[] = {
176 { CFM_TLV_END
, "End"},
177 { CFM_TLV_SENDER_ID
, "Sender ID"},
178 { CFM_TLV_PORT_STATUS
, "Port status"},
179 { CFM_TLV_INTERFACE_STATUS
, "Interface status"},
180 { CFM_TLV_DATA
, "Data"},
181 { CFM_TLV_REPLY_INGRESS
, "Reply Ingress"},
182 { CFM_TLV_REPLY_EGRESS
, "Reply Egress"},
183 { CFM_TLV_PRIVATE
, "Organization Specific"},
191 struct cfm_tlv_header_t
{
196 /* FIXME define TLV formats */
198 static const struct tok cfm_tlv_port_status_values
[] = {
204 static const struct tok cfm_tlv_interface_status_values
[] = {
210 { 7, "lower Layer down"},
214 #define CFM_CHASSIS_ID_CHASSIS_COMPONENT 1
215 #define CFM_CHASSIS_ID_INTERFACE_ALIAS 2
216 #define CFM_CHASSIS_ID_PORT_COMPONENT 3
217 #define CFM_CHASSIS_ID_MAC_ADDRESS 4
218 #define CFM_CHASSIS_ID_NETWORK_ADDRESS 5
219 #define CFM_CHASSIS_ID_INTERFACE_NAME 6
220 #define CFM_CHASSIS_ID_LOCAL 7
222 static const struct tok cfm_tlv_senderid_chassisid_values
[] = {
224 { CFM_CHASSIS_ID_CHASSIS_COMPONENT
, "Chassis component"},
225 { CFM_CHASSIS_ID_INTERFACE_ALIAS
, "Interface alias"},
226 { CFM_CHASSIS_ID_PORT_COMPONENT
, "Port component"},
227 { CFM_CHASSIS_ID_MAC_ADDRESS
, "MAC address"},
228 { CFM_CHASSIS_ID_NETWORK_ADDRESS
, "Network address"},
229 { CFM_CHASSIS_ID_INTERFACE_NAME
, "Interface name"},
230 { CFM_CHASSIS_ID_LOCAL
, "Locally assigned"},
236 cfm_mgmt_addr_print(register const u_char
*tptr
) {
238 u_int mgmt_addr_type
;
239 u_int hexdump
= FALSE
;
242 * Altough AFIs are tpically 2 octects wide,
243 * 802.1ab specifies that this field width
246 mgmt_addr_type
= *tptr
;
247 printf("\n\t Management Address Type %s (%u)",
248 tok2str(af_values
, "Unknown", mgmt_addr_type
),
252 * Resolve the passed in Address.
254 switch(mgmt_addr_type
) {
256 printf(", %s", ipaddr_string(tptr
+ 1));
261 printf(", %s", ip6addr_string(tptr
+ 1));
274 * The egress-ID string is a 16-Bit string plus a MAC address.
277 cfm_egress_id_string(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(tptr
+2));
285 return egress_id_buffer
;
289 cfm_print(register const u_char
*pptr
, register u_int length
) {
291 const struct cfm_common_header_t
*cfm_common_header
;
292 const struct cfm_tlv_header_t
*cfm_tlv_header
;
293 const u_int8_t
*tptr
, *tlv_ptr
, *ma_name
, *ma_nameformat
, *ma_namelength
;
294 u_int hexdump
, tlen
, cfm_tlv_len
, cfm_tlv_type
, ccm_interval
;
298 const struct cfm_ccm_t
*cfm_ccm
;
299 const struct cfm_lbm_t
*cfm_lbm
;
300 const struct cfm_ltm_t
*cfm_ltm
;
301 const struct cfm_ltr_t
*cfm_ltr
;
305 cfm_common_header
= (const struct cfm_common_header_t
*)pptr
;
306 TCHECK(*cfm_common_header
);
309 * Sanity checking of the header.
311 if (CFM_EXTRACT_VERSION(cfm_common_header
->mdlevel_version
) != CFM_VERSION
) {
312 printf("CFMv%u not supported, length %u",
313 CFM_EXTRACT_VERSION(cfm_common_header
->mdlevel_version
), length
);
317 printf("CFMv%u %s, MD Level %u, length %u",
318 CFM_EXTRACT_VERSION(cfm_common_header
->mdlevel_version
),
319 tok2str(cfm_opcode_values
, "unknown (%u)", cfm_common_header
->opcode
),
320 CFM_EXTRACT_MD_LEVEL(cfm_common_header
->mdlevel_version
),
324 * In non-verbose mode just print the opcode and md-level.
330 printf("\n\tFirst TLV offset %u", cfm_common_header
->first_tlv_offset
);
332 tptr
+= sizeof(const struct cfm_common_header_t
);
333 tlen
= length
- sizeof(struct cfm_common_header_t
);
335 switch (cfm_common_header
->opcode
) {
337 msg_ptr
.cfm_ccm
= (const struct cfm_ccm_t
*)tptr
;
339 ccm_interval
= CFM_EXTRACT_CCM_INTERVAL(cfm_common_header
->flags
);
340 printf(", Flags [CCM Interval %u%s]",
342 cfm_common_header
->flags
& CFM_CCM_RDI_FLAG
?
346 * Resolve the CCM interval field.
349 printf("\n\t CCM Interval %.3fs"
350 ", min CCM Lifetime %.3fs, max CCM Lifetime %.3fs",
351 ccm_interval_base
[ccm_interval
],
352 ccm_interval_base
[ccm_interval
] * CCM_INTERVAL_MIN_MULTIPLIER
,
353 ccm_interval_base
[ccm_interval
] * CCM_INTERVAL_MAX_MULTIPLIER
);
356 printf("\n\t Sequence Number 0x%08x, MA-End-Point-ID 0x%04x",
357 EXTRACT_32BITS(msg_ptr
.cfm_ccm
->sequence
),
358 EXTRACT_16BITS(msg_ptr
.cfm_ccm
->ma_epi
));
362 * Resolve the MD fields.
364 printf("\n\t MD Name Format %s (%u), MD Name length %u",
365 tok2str(cfm_md_nameformat_values
, "Unknown",
366 msg_ptr
.cfm_ccm
->md_nameformat
),
367 msg_ptr
.cfm_ccm
->md_nameformat
,
368 msg_ptr
.cfm_ccm
->md_namelength
);
370 if (msg_ptr
.cfm_ccm
->md_nameformat
!= CFM_CCM_MD_FORMAT_NONE
) {
371 printf("\n\t MD Name: ");
372 switch (msg_ptr
.cfm_ccm
->md_nameformat
) {
373 case CFM_CCM_MD_FORMAT_DNS
:
374 case CFM_CCM_MD_FORMAT_CHAR
:
375 safeputs(gndo
, msg_ptr
.cfm_ccm
->md_name
, msg_ptr
.cfm_ccm
->md_namelength
);
378 case CFM_CCM_MD_FORMAT_MAC
:
379 printf("\n\t MAC %s", etheraddr_string(
380 msg_ptr
.cfm_ccm
->md_name
));
383 /* FIXME add printers for those MD formats - hexdump for now */
384 case CFM_CCM_MA_FORMAT_8021
:
386 print_unknown_data(gndo
,msg_ptr
.cfm_ccm
->md_name
, "\n\t ",
387 msg_ptr
.cfm_ccm
->md_namelength
);
393 * Resolve the MA fields.
395 ma_nameformat
= msg_ptr
.cfm_ccm
->md_name
+ msg_ptr
.cfm_ccm
->md_namelength
;
396 ma_namelength
= msg_ptr
.cfm_ccm
->md_name
+ msg_ptr
.cfm_ccm
->md_namelength
+ 1;
397 ma_name
= msg_ptr
.cfm_ccm
->md_name
+ msg_ptr
.cfm_ccm
->md_namelength
+ 2;
399 printf("\n\t MA Name-Format %s (%u), MA name length %u",
400 tok2str(cfm_ma_nameformat_values
, "Unknown",
405 printf("\n\t MA Name: ");
406 switch (*ma_nameformat
) {
407 case CFM_CCM_MA_FORMAT_CHAR
:
408 safeputs(gndo
, ma_name
, *ma_namelength
);
411 /* FIXME add printers for those MA formats - hexdump for now */
412 case CFM_CCM_MA_FORMAT_8021
:
413 case CFM_CCM_MA_FORMAT_VID
:
414 case CFM_CCM_MA_FORMAT_INT
:
415 case CFM_CCM_MA_FORMAT_VPN
:
417 print_unknown_data(gndo
,ma_name
, "\n\t ", *ma_namelength
);
422 msg_ptr
.cfm_ltm
= (const struct cfm_ltm_t
*)tptr
;
424 printf(", Flags [%s]",
425 bittok2str(cfm_ltm_flag_values
, "none", cfm_common_header
->flags
));
427 printf("\n\t Transaction-ID 0x%08x, Egress-ID %s, ttl %u",
428 EXTRACT_32BITS(msg_ptr
.cfm_ltm
->transaction_id
),
429 cfm_egress_id_string(msg_ptr
.cfm_ltm
->egress_id
),
430 msg_ptr
.cfm_ltm
->ttl
);
432 printf("\n\t Original-MAC %s, Target-MAC %s",
433 etheraddr_string(msg_ptr
.cfm_ltm
->original_mac
),
434 etheraddr_string(msg_ptr
.cfm_ltm
->target_mac
));
438 msg_ptr
.cfm_ltr
= (const struct cfm_ltr_t
*)tptr
;
440 printf(", Flags [%s]",
441 bittok2str(cfm_ltr_flag_values
, "none", cfm_common_header
->flags
));
443 printf("\n\t Transaction-ID 0x%08x, Last-Egress-ID %s",
444 EXTRACT_32BITS(msg_ptr
.cfm_ltr
->transaction_id
),
445 cfm_egress_id_string(msg_ptr
.cfm_ltr
->last_egress_id
));
447 printf("\n\t Next-Egress-ID %s, ttl %u",
448 cfm_egress_id_string(msg_ptr
.cfm_ltr
->next_egress_id
),
449 msg_ptr
.cfm_ltr
->ttl
);
451 printf("\n\t Replay-Action %s (%u)",
452 tok2str(cfm_ltr_replay_action_values
,
454 msg_ptr
.cfm_ltr
->replay_action
),
455 msg_ptr
.cfm_ltr
->replay_action
);
459 * No message decoder yet.
460 * Hexdump everything up until the start of the TLVs
465 if (tlen
> cfm_common_header
->first_tlv_offset
) {
466 print_unknown_data(gndo
,tptr
, "\n\t ",
467 tlen
- cfm_common_header
->first_tlv_offset
);
473 * Sanity check for not walking off.
475 if (tlen
<= cfm_common_header
->first_tlv_offset
) {
479 tptr
+= cfm_common_header
->first_tlv_offset
;
480 tlen
-= cfm_common_header
->first_tlv_offset
;
483 cfm_tlv_header
= (const struct cfm_tlv_header_t
*)tptr
;
485 /* Enough to read the tlv type ? */
487 cfm_tlv_type
=cfm_tlv_header
->type
;
489 if (cfm_tlv_type
!= CFM_TLV_END
) {
490 /* did we capture enough for fully decoding the object header ? */
491 TCHECK2(*tptr
, sizeof(struct cfm_tlv_header_t
));
492 cfm_tlv_len
=EXTRACT_16BITS(&cfm_tlv_header
->length
);
497 printf("\n\t%s TLV (0x%02x), length %u",
498 tok2str(cfm_tlv_values
, "Unknown", cfm_tlv_type
),
502 /* sanity check for not walking off and infinite loop check. */
503 if ((cfm_tlv_type
!= CFM_TLV_END
) &&
504 ((cfm_tlv_len
+ sizeof(struct cfm_tlv_header_t
) > tlen
) ||
506 print_unknown_data(gndo
,tptr
,"\n\t ",tlen
);
510 tptr
+= sizeof(struct cfm_tlv_header_t
);
511 tlen
-= sizeof(struct cfm_tlv_header_t
);
514 /* did we capture enough for fully decoding the object ? */
515 if (cfm_tlv_type
!= CFM_TLV_END
) {
516 TCHECK2(*tptr
, cfm_tlv_len
);
520 switch(cfm_tlv_type
) {
522 /* we are done - bail out */
525 case CFM_TLV_PORT_STATUS
:
526 printf(", Status: %s (%u)",
527 tok2str(cfm_tlv_port_status_values
, "Unknown", *tptr
),
531 case CFM_TLV_INTERFACE_STATUS
:
532 printf(", Status: %s (%u)",
533 tok2str(cfm_tlv_interface_status_values
, "Unknown", *tptr
),
537 case CFM_TLV_PRIVATE
:
538 printf(", Vendor: %s (%u), Sub-Type %u",
539 tok2str(oui_values
,"Unknown", EXTRACT_24BITS(tptr
)),
540 EXTRACT_24BITS(tptr
),
545 case CFM_TLV_SENDER_ID
:
547 u_int chassis_id_type
, chassis_id_length
;
548 u_int mgmt_addr_length
;
551 * Check if there is a Chassis-ID.
553 chassis_id_length
= *tptr
;
554 if (chassis_id_length
> tlen
) {
562 if (chassis_id_length
) {
563 chassis_id_type
= *tptr
;
564 printf("\n\t Chassis-ID Type %s (%u), Chassis-ID length %u",
565 tok2str(cfm_tlv_senderid_chassisid_values
,
571 switch (chassis_id_type
) {
572 case CFM_CHASSIS_ID_MAC_ADDRESS
:
573 printf("\n\t MAC %s", etheraddr_string(tptr
+1));
576 case CFM_CHASSIS_ID_NETWORK_ADDRESS
:
577 hexdump
|= cfm_mgmt_addr_print(tptr
);
580 case CFM_CHASSIS_ID_INTERFACE_NAME
: /* fall through */
581 case CFM_CHASSIS_ID_INTERFACE_ALIAS
:
582 case CFM_CHASSIS_ID_LOCAL
:
583 case CFM_CHASSIS_ID_CHASSIS_COMPONENT
:
584 case CFM_CHASSIS_ID_PORT_COMPONENT
:
585 safeputs(gndo
, tptr
+ 1, chassis_id_length
);
594 tptr
+= chassis_id_length
;
595 tlen
-= chassis_id_length
;
598 * Check if there is a Management Address.
600 mgmt_addr_length
= *tptr
;
601 if (mgmt_addr_length
> tlen
) {
609 if (mgmt_addr_length
) {
610 hexdump
|= cfm_mgmt_addr_print(tptr
);
613 tptr
+= mgmt_addr_length
;
614 tlen
-= mgmt_addr_length
;
620 * FIXME those are the defined TLVs that lack a decoder
621 * you are welcome to contribute code ;-)
625 case CFM_TLV_REPLY_INGRESS
:
626 case CFM_TLV_REPLY_EGRESS
:
631 /* do we want to see an additional hexdump ? */
632 if (hexdump
|| vflag
> 1)
633 print_unknown_data(gndo
,tlv_ptr
, "\n\t ", cfm_tlv_len
);
640 printf("\n\t\t packet exceeded snapshot");