xref: /freebsd/contrib/tcpdump/print-atm.c (revision 4232f826683298e85d469c0ef17259cecd13b2c7)
1 /*
2  * Copyright (c) 1994, 1995, 1996, 1997
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that: (1) source code distributions
7  * retain the above copyright notice and this paragraph in its entirety, (2)
8  * distributions including binary code include the above copyright notice and
9  * this paragraph in its entirety in the documentation or other materials
10  * provided with the distribution, and (3) all advertising materials mentioning
11  * features or use of this software display the following acknowledgement:
12  * ``This product includes software developed by the University of California,
13  * Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
14  * the University nor the names of its contributors may be used to endorse
15  * or promote products derived from this software without specific prior
16  * written permission.
17  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
18  * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
20  *
21  * $FreeBSD$
22  */
23 
24 #define NETDISSECT_REWORKED
25 #ifdef HAVE_CONFIG_H
26 #include "config.h"
27 #endif
28 
29 #include <tcpdump-stdinc.h>
30 
31 #include "interface.h"
32 #include "extract.h"
33 #include "addrtoname.h"
34 #include "atm.h"
35 #include "atmuni31.h"
36 #include "llc.h"
37 
38 static const char tstr[] = "[|atm]";
39 
40 #define OAM_CRC10_MASK 0x3ff
41 #define OAM_PAYLOAD_LEN 48
42 #define OAM_FUNCTION_SPECIFIC_LEN 45 /* this excludes crc10 and cell-type/function-type */
43 #define OAM_CELLTYPE_FUNCTYPE_LEN 1
44 
45 static const struct tok oam_f_values[] = {
46     { VCI_OAMF4SC, "OAM F4 (segment)" },
47     { VCI_OAMF4EC, "OAM F4 (end)" },
48     { 0, NULL }
49 };
50 
51 static const struct tok atm_pty_values[] = {
52     { 0x0, "user data, uncongested, SDU 0" },
53     { 0x1, "user data, uncongested, SDU 1" },
54     { 0x2, "user data, congested, SDU 0" },
55     { 0x3, "user data, congested, SDU 1" },
56     { 0x4, "VCC OAM F5 flow segment" },
57     { 0x5, "VCC OAM F5 flow end-to-end" },
58     { 0x6, "Traffic Control and resource Mgmt" },
59     { 0, NULL }
60 };
61 
62 #define OAM_CELLTYPE_FM 0x1
63 #define OAM_CELLTYPE_PM 0x2
64 #define OAM_CELLTYPE_AD 0x8
65 #define OAM_CELLTYPE_SM 0xf
66 
67 static const struct tok oam_celltype_values[] = {
68     { OAM_CELLTYPE_FM, "Fault Management" },
69     { OAM_CELLTYPE_PM, "Performance Management" },
70     { OAM_CELLTYPE_AD, "activate/deactivate" },
71     { OAM_CELLTYPE_SM, "System Management" },
72     { 0, NULL }
73 };
74 
75 #define OAM_FM_FUNCTYPE_AIS       0x0
76 #define OAM_FM_FUNCTYPE_RDI       0x1
77 #define OAM_FM_FUNCTYPE_CONTCHECK 0x4
78 #define OAM_FM_FUNCTYPE_LOOPBACK  0x8
79 
80 static const struct tok oam_fm_functype_values[] = {
81     { OAM_FM_FUNCTYPE_AIS, "AIS" },
82     { OAM_FM_FUNCTYPE_RDI, "RDI" },
83     { OAM_FM_FUNCTYPE_CONTCHECK, "Continuity Check" },
84     { OAM_FM_FUNCTYPE_LOOPBACK, "Loopback" },
85     { 0, NULL }
86 };
87 
88 static const struct tok oam_pm_functype_values[] = {
89     { 0x0, "Forward Monitoring" },
90     { 0x1, "Backward Reporting" },
91     { 0x2, "Monitoring and Reporting" },
92     { 0, NULL }
93 };
94 
95 static const struct tok oam_ad_functype_values[] = {
96     { 0x0, "Performance Monitoring" },
97     { 0x1, "Continuity Check" },
98     { 0, NULL }
99 };
100 
101 #define OAM_FM_LOOPBACK_INDICATOR_MASK 0x1
102 
103 static const struct tok oam_fm_loopback_indicator_values[] = {
104     { 0x0, "Reply" },
105     { 0x1, "Request" },
106     { 0, NULL }
107 };
108 
109 static const struct tok *oam_functype_values[16] = {
110     NULL,
111     oam_fm_functype_values, /* 1 */
112     oam_pm_functype_values, /* 2 */
113     NULL,
114     NULL,
115     NULL,
116     NULL,
117     NULL,
118     oam_ad_functype_values, /* 8 */
119     NULL,
120     NULL,
121     NULL,
122     NULL,
123     NULL,
124     NULL,
125     NULL
126 };
127 
128 /*
129  * Print an RFC 1483 LLC-encapsulated ATM frame.
130  */
131 static void
132 atm_llc_print(netdissect_options *ndo,
133               const u_char *p, int length, int caplen)
134 {
135 	u_short extracted_ethertype;
136 
137 	if (!llc_print(ndo, p, length, caplen, NULL, NULL,
138 	    &extracted_ethertype)) {
139 		/* ether_type not known, print raw packet */
140 		if (extracted_ethertype) {
141 			ND_PRINT((ndo, "(LLC %s) ",
142 		etherproto_string(htons(extracted_ethertype))));
143 		}
144 		if (!ndo->ndo_suppress_default_print)
145 			ND_DEFAULTPRINT(p, caplen);
146 	}
147 }
148 
149 /*
150  * Given a SAP value, generate the LLC header value for a UI packet
151  * with that SAP as the source and destination SAP.
152  */
153 #define LLC_UI_HDR(sap)	((sap)<<16 | (sap<<8) | 0x03)
154 
155 /*
156  * This is the top level routine of the printer.  'p' points
157  * to the LLC/SNAP header of the packet, 'h->ts' is the timestamp,
158  * 'h->len' is the length of the packet off the wire, and 'h->caplen'
159  * is the number of bytes actually captured.
160  */
161 u_int
162 atm_if_print(netdissect_options *ndo,
163              const struct pcap_pkthdr *h, const u_char *p)
164 {
165 	u_int caplen = h->caplen;
166 	u_int length = h->len;
167 	uint32_t llchdr;
168 	u_int hdrlen = 0;
169 
170 	if (caplen < 1 || length < 1) {
171 		ND_PRINT((ndo, "%s", tstr));
172 		return (caplen);
173 	}
174 
175         /* Cisco Style NLPID ? */
176         if (*p == LLC_UI) {
177             if (ndo->ndo_eflag)
178                 ND_PRINT((ndo, "CNLPID "));
179             isoclns_print(ndo, p + 1, length - 1, caplen - 1);
180             return hdrlen;
181         }
182 
183 	/*
184 	 * Must have at least a DSAP, an SSAP, and the first byte of the
185 	 * control field.
186 	 */
187 	if (caplen < 3 || length < 3) {
188 		ND_PRINT((ndo, "%s", tstr));
189 		return (caplen);
190 	}
191 
192 	/*
193 	 * Extract the presumed LLC header into a variable, for quick
194 	 * testing.
195 	 * Then check for a header that's neither a header for a SNAP
196 	 * packet nor an RFC 2684 routed NLPID-formatted PDU nor
197 	 * an 802.2-but-no-SNAP IP packet.
198 	 */
199 	llchdr = EXTRACT_24BITS(p);
200 	if (llchdr != LLC_UI_HDR(LLCSAP_SNAP) &&
201 	    llchdr != LLC_UI_HDR(LLCSAP_ISONS) &&
202 	    llchdr != LLC_UI_HDR(LLCSAP_IP)) {
203 		/*
204 		 * XXX - assume 802.6 MAC header from Fore driver.
205 		 *
206 		 * Unfortunately, the above list doesn't check for
207 		 * all known SAPs, doesn't check for headers where
208 		 * the source and destination SAP aren't the same,
209 		 * and doesn't check for non-UI frames.  It also
210 		 * runs the risk of an 802.6 MAC header that happens
211 		 * to begin with one of those values being
212 		 * incorrectly treated as an 802.2 header.
213 		 *
214 		 * So is that Fore driver still around?  And, if so,
215 		 * is it still putting 802.6 MAC headers on ATM
216 		 * packets?  If so, could it be changed to use a
217 		 * new DLT_IEEE802_6 value if we added it?
218 		 */
219 		if (caplen < 20 || length < 20) {
220 			ND_PRINT((ndo, "%s", tstr));
221 			return (caplen);
222 		}
223 		if (ndo->ndo_eflag)
224 			ND_PRINT((ndo, "%08x%08x %08x%08x ",
225 			       EXTRACT_32BITS(p),
226 			       EXTRACT_32BITS(p+4),
227 			       EXTRACT_32BITS(p+8),
228 			       EXTRACT_32BITS(p+12)));
229 		p += 20;
230 		length -= 20;
231 		caplen -= 20;
232 		hdrlen += 20;
233 	}
234 	atm_llc_print(ndo, p, length, caplen);
235 	return (hdrlen);
236 }
237 
238 /*
239  * ATM signalling.
240  */
241 static const struct tok msgtype2str[] = {
242 	{ CALL_PROCEED,		"Call_proceeding" },
243 	{ CONNECT,		"Connect" },
244 	{ CONNECT_ACK,		"Connect_ack" },
245 	{ SETUP,		"Setup" },
246 	{ RELEASE,		"Release" },
247 	{ RELEASE_DONE,		"Release_complete" },
248 	{ RESTART,		"Restart" },
249 	{ RESTART_ACK,		"Restart_ack" },
250 	{ STATUS,		"Status" },
251 	{ STATUS_ENQ,		"Status_enquiry" },
252 	{ ADD_PARTY,		"Add_party" },
253 	{ ADD_PARTY_ACK,	"Add_party_ack" },
254 	{ ADD_PARTY_REJ,	"Add_party_reject" },
255 	{ DROP_PARTY,		"Drop_party" },
256 	{ DROP_PARTY_ACK,	"Drop_party_ack" },
257 	{ 0,			NULL }
258 };
259 
260 static void
261 sig_print(netdissect_options *ndo,
262           const u_char *p, int caplen)
263 {
264 	uint32_t call_ref;
265 
266 	if (caplen < PROTO_POS) {
267 		ND_PRINT((ndo, "%s", tstr));
268 		return;
269 	}
270 	if (p[PROTO_POS] == Q2931) {
271 		/*
272 		 * protocol:Q.2931 for User to Network Interface
273 		 * (UNI 3.1) signalling
274 		 */
275 		ND_PRINT((ndo, "Q.2931"));
276 		if (caplen < MSG_TYPE_POS) {
277 			ND_PRINT((ndo, " %s", tstr));
278 			return;
279 		}
280 		ND_PRINT((ndo, ":%s ",
281 		    tok2str(msgtype2str, "msgtype#%d", p[MSG_TYPE_POS])));
282 
283 		/*
284 		 * The call reference comes before the message type,
285 		 * so if we know we have the message type, which we
286 		 * do from the caplen test above, we also know we have
287 		 * the call reference.
288 		 */
289 		call_ref = EXTRACT_24BITS(&p[CALL_REF_POS]);
290 		ND_PRINT((ndo, "CALL_REF:0x%06x", call_ref));
291 	} else {
292 		/* SCCOP with some unknown protocol atop it */
293 		ND_PRINT((ndo, "SSCOP, proto %d ", p[PROTO_POS]));
294 	}
295 }
296 
297 /*
298  * Print an ATM PDU (such as an AAL5 PDU).
299  */
300 void
301 atm_print(netdissect_options *ndo,
302           u_int vpi, u_int vci, u_int traftype, const u_char *p, u_int length,
303           u_int caplen)
304 {
305 	if (ndo->ndo_eflag)
306 		ND_PRINT((ndo, "VPI:%u VCI:%u ", vpi, vci));
307 
308 	if (vpi == 0) {
309 		switch (vci) {
310 
311 		case VCI_PPC:
312 			sig_print(ndo, p, caplen);
313 			return;
314 
315 		case VCI_BCC:
316 			ND_PRINT((ndo, "broadcast sig: "));
317 			return;
318 
319 		case VCI_OAMF4SC: /* fall through */
320 		case VCI_OAMF4EC:
321 			oam_print(ndo, p, length, ATM_OAM_HEC);
322 			return;
323 
324 		case VCI_METAC:
325 			ND_PRINT((ndo, "meta: "));
326 			return;
327 
328 		case VCI_ILMIC:
329 			ND_PRINT((ndo, "ilmi: "));
330 			snmp_print(ndo, p, length);
331 			return;
332 		}
333 	}
334 
335 	switch (traftype) {
336 
337 	case ATM_LLC:
338 	default:
339 		/*
340 		 * Assumes traffic is LLC if unknown.
341 		 */
342 		atm_llc_print(ndo, p, length, caplen);
343 		break;
344 
345 	case ATM_LANE:
346 		lane_print(ndo, p, length, caplen);
347 		break;
348 	}
349 }
350 
351 struct oam_fm_loopback_t {
352     uint8_t loopback_indicator;
353     uint8_t correlation_tag[4];
354     uint8_t loopback_id[12];
355     uint8_t source_id[12];
356     uint8_t unused[16];
357 };
358 
359 struct oam_fm_ais_rdi_t {
360     uint8_t failure_type;
361     uint8_t failure_location[16];
362     uint8_t unused[28];
363 };
364 
365 int
366 oam_print (netdissect_options *ndo,
367            const u_char *p, u_int length, u_int hec) {
368 
369     uint32_t cell_header;
370     uint16_t vpi, vci, cksum, cksum_shouldbe, idx;
371     uint8_t  cell_type, func_type, payload, clp;
372 
373     union {
374         const struct oam_fm_loopback_t *oam_fm_loopback;
375         const struct oam_fm_ais_rdi_t *oam_fm_ais_rdi;
376     } oam_ptr;
377 
378 
379     cell_header = EXTRACT_32BITS(p+hec);
380     cell_type = ((*(p+ATM_HDR_LEN_NOHEC+hec))>>4) & 0x0f;
381     func_type = (*(p+ATM_HDR_LEN_NOHEC+hec)) & 0x0f;
382 
383     vpi = (cell_header>>20)&0xff;
384     vci = (cell_header>>4)&0xffff;
385     payload = (cell_header>>1)&0x7;
386     clp = cell_header&0x1;
387 
388     ND_PRINT((ndo, "%s, vpi %u, vci %u, payload [ %s ], clp %u, length %u",
389            tok2str(oam_f_values, "OAM F5", vci),
390            vpi, vci,
391            tok2str(atm_pty_values, "Unknown", payload),
392            clp, length));
393 
394     if (!ndo->ndo_vflag) {
395         return 1;
396     }
397 
398     ND_PRINT((ndo, "\n\tcell-type %s (%u)",
399            tok2str(oam_celltype_values, "unknown", cell_type),
400            cell_type));
401 
402     if (oam_functype_values[cell_type] == NULL)
403         ND_PRINT((ndo, ", func-type unknown (%u)", func_type));
404     else
405         ND_PRINT((ndo, ", func-type %s (%u)",
406                tok2str(oam_functype_values[cell_type],"none",func_type),
407                func_type));
408 
409     p += ATM_HDR_LEN_NOHEC + hec;
410 
411     switch (cell_type << 4 | func_type) {
412     case (OAM_CELLTYPE_FM << 4 | OAM_FM_FUNCTYPE_LOOPBACK):
413         oam_ptr.oam_fm_loopback = (const struct oam_fm_loopback_t *)(p + OAM_CELLTYPE_FUNCTYPE_LEN);
414         ND_PRINT((ndo, "\n\tLoopback-Indicator %s, Correlation-Tag 0x%08x",
415                tok2str(oam_fm_loopback_indicator_values,
416                        "Unknown",
417                        oam_ptr.oam_fm_loopback->loopback_indicator & OAM_FM_LOOPBACK_INDICATOR_MASK),
418                EXTRACT_32BITS(&oam_ptr.oam_fm_loopback->correlation_tag)));
419         ND_PRINT((ndo, "\n\tLocation-ID "));
420         for (idx = 0; idx < sizeof(oam_ptr.oam_fm_loopback->loopback_id); idx++) {
421             if (idx % 2) {
422                 ND_PRINT((ndo, "%04x ", EXTRACT_16BITS(&oam_ptr.oam_fm_loopback->loopback_id[idx])));
423             }
424         }
425         ND_PRINT((ndo, "\n\tSource-ID   "));
426         for (idx = 0; idx < sizeof(oam_ptr.oam_fm_loopback->source_id); idx++) {
427             if (idx % 2) {
428                 ND_PRINT((ndo, "%04x ", EXTRACT_16BITS(&oam_ptr.oam_fm_loopback->source_id[idx])));
429             }
430         }
431         break;
432 
433     case (OAM_CELLTYPE_FM << 4 | OAM_FM_FUNCTYPE_AIS):
434     case (OAM_CELLTYPE_FM << 4 | OAM_FM_FUNCTYPE_RDI):
435         oam_ptr.oam_fm_ais_rdi = (const struct oam_fm_ais_rdi_t *)(p + OAM_CELLTYPE_FUNCTYPE_LEN);
436         ND_PRINT((ndo, "\n\tFailure-type 0x%02x", oam_ptr.oam_fm_ais_rdi->failure_type));
437         ND_PRINT((ndo, "\n\tLocation-ID "));
438         for (idx = 0; idx < sizeof(oam_ptr.oam_fm_ais_rdi->failure_location); idx++) {
439             if (idx % 2) {
440                 ND_PRINT((ndo, "%04x ", EXTRACT_16BITS(&oam_ptr.oam_fm_ais_rdi->failure_location[idx])));
441             }
442         }
443         break;
444 
445     case (OAM_CELLTYPE_FM << 4 | OAM_FM_FUNCTYPE_CONTCHECK):
446         /* FIXME */
447         break;
448 
449     default:
450         break;
451     }
452 
453     /* crc10 checksum verification */
454     cksum = EXTRACT_16BITS(p + OAM_CELLTYPE_FUNCTYPE_LEN + OAM_FUNCTION_SPECIFIC_LEN)
455         & OAM_CRC10_MASK;
456     cksum_shouldbe = verify_crc10_cksum(0, p, OAM_PAYLOAD_LEN);
457 
458     ND_PRINT((ndo, "\n\tcksum 0x%03x (%scorrect)",
459            cksum,
460            cksum_shouldbe == 0 ? "" : "in"));
461 
462     return 1;
463 }
464