xref: /netbsd-src/external/bsd/tcpdump/dist/print-token.c (revision 3117ece4fc4a4ca4489ba793710b60b0d26bab6c)
1 /*
2  * Copyright (c) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996
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  * Hacked version of print-ether.c  Larry Lile <lile@stdio.com>
22  *
23  * Further tweaked to more closely resemble print-fddi.c
24  *	Guy Harris <guy@alum.mit.edu>
25  */
26 
27 #include <sys/cdefs.h>
28 #ifndef lint
29 __RCSID("$NetBSD: print-token.c,v 1.8 2024/09/02 16:15:33 christos Exp $");
30 #endif
31 
32 /* \summary: Token Ring printer */
33 
34 #include <config.h>
35 
36 #include "netdissect-stdinc.h"
37 
38 #include <string.h>
39 
40 #include "netdissect.h"
41 #include "extract.h"
42 #include "addrtoname.h"
43 
44 /*
45  * Copyright (c) 1998, Larry Lile
46  * All rights reserved.
47  *
48  * Redistribution and use in source and binary forms, with or without
49  * modification, are permitted provided that the following conditions
50  * are met:
51  * 1. Redistributions of source code must retain the above copyright
52  *    notice unmodified, this list of conditions, and the following
53  *    disclaimer.
54  * 2. Redistributions in binary form must reproduce the above copyright
55  *    notice, this list of conditions and the following disclaimer in the
56  *    documentation and/or other materials provided with the distribution.
57  *
58  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
59  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
60  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
61  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
62  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
63  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
64  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
65  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
66  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
67  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
68  * SUCH DAMAGE.
69  *
70  */
71 
72 #define TOKEN_HDRLEN		14
73 #define ROUTING_SEGMENT_MAX	16
74 #define IS_SOURCE_ROUTED(trp)	((trp)->token_shost[0] & 0x80)
75 #define FRAME_TYPE(trp)		((GET_U_1((trp)->token_fc) & 0xC0) >> 6)
76 #define TOKEN_FC_LLC		1
77 
78 #define BROADCAST(trp)		((GET_BE_U_2((trp)->token_rcf) & 0xE000) >> 13)
79 #define RIF_LENGTH(trp)		((GET_BE_U_2((trp)->token_rcf) & 0x1f00) >> 8)
80 #define DIRECTION(trp)		((GET_BE_U_2((trp)->token_rcf) & 0x0080) >> 7)
81 #define LARGEST_FRAME(trp)	((GET_BE_U_2((trp)->token_rcf) & 0x0070) >> 4)
82 #define RING_NUMBER(trp, x)	((GET_BE_U_2((trp)->token_rseg[x]) & 0xfff0) >> 4)
83 #define BRIDGE_NUMBER(trp, x)	(GET_BE_U_2((trp)->token_rseg[x]) & 0x000f)
84 #define SEGMENT_COUNT(trp)	((int)((RIF_LENGTH(trp) - 2) / 2))
85 
86 struct token_header {
87 	nd_uint8_t   token_ac;
88 	nd_uint8_t   token_fc;
89 	nd_mac_addr  token_dhost;
90 	nd_mac_addr  token_shost;
91 	nd_uint16_t  token_rcf;
92 	nd_uint16_t  token_rseg[ROUTING_SEGMENT_MAX];
93 };
94 
95 
96 /* Extract src, dst addresses */
97 static void
98 extract_token_addrs(const struct token_header *trp, char *fsrc, char *fdst)
99 {
100 	memcpy(fdst, (const char *)trp->token_dhost, 6);
101 	memcpy(fsrc, (const char *)trp->token_shost, 6);
102 }
103 
104 /*
105  * Print the TR MAC header
106  */
107 static void
108 token_hdr_print(netdissect_options *ndo,
109                 const struct token_header *trp, u_int length,
110                 const u_char *fsrc, const u_char *fdst)
111 {
112 	const char *srcname, *dstname;
113 
114 	srcname = etheraddr_string(ndo, fsrc);
115 	dstname = etheraddr_string(ndo, fdst);
116 
117 	if (!ndo->ndo_qflag)
118 		ND_PRINT("%02x %02x ",
119 		       GET_U_1(trp->token_ac),
120 		       GET_U_1(trp->token_fc));
121 	ND_PRINT("%s > %s, length %u: ",
122 	       srcname, dstname,
123 	       length);
124 }
125 
126 static const char *broadcast_indicator[] = {
127 	"Non-Broadcast", "Non-Broadcast",
128 	"Non-Broadcast", "Non-Broadcast",
129 	"All-routes",    "All-routes",
130 	"Single-route",  "Single-route"
131 };
132 
133 static const char *direction[] = {
134 	"Forward", "Backward"
135 };
136 
137 static const char *largest_frame[] = {
138 	"516",
139 	"1500",
140 	"2052",
141 	"4472",
142 	"8144",
143 	"11407",
144 	"17800",
145 	"??"
146 };
147 
148 u_int
149 token_print(netdissect_options *ndo, const u_char *p, u_int length, u_int caplen)
150 {
151 	const struct token_header *trp;
152 	int llc_hdrlen;
153 	nd_mac_addr srcmac, dstmac;
154 	struct lladdr_info src, dst;
155 	u_int route_len = 0, hdr_len = TOKEN_HDRLEN;
156 	int seg;
157 
158 	ndo->ndo_protocol = "token-ring";
159 	trp = (const struct token_header *)p;
160 
161 	if (caplen < TOKEN_HDRLEN) {
162 		nd_print_trunc(ndo);
163 		return hdr_len;
164 	}
165 
166 	/*
167 	 * Get the TR addresses into a canonical form
168 	 */
169 	extract_token_addrs(trp, (char*)srcmac, (char*)dstmac);
170 
171 	/* Adjust for source routing information in the MAC header */
172 	if (IS_SOURCE_ROUTED(trp)) {
173 		/* Clear source-routed bit */
174 		srcmac[0] &= 0x7f;
175 
176 		if (ndo->ndo_eflag)
177 			token_hdr_print(ndo, trp, length, srcmac, dstmac);
178 
179 		if (caplen < TOKEN_HDRLEN + 2) {
180 			nd_print_trunc(ndo);
181 			return hdr_len;
182 		}
183 		route_len = RIF_LENGTH(trp);
184 		hdr_len += route_len;
185 		if (caplen < hdr_len) {
186 			nd_print_trunc(ndo);
187 			return hdr_len;
188 		}
189 		if (ndo->ndo_vflag) {
190 			ND_PRINT("%s ", broadcast_indicator[BROADCAST(trp)]);
191 			ND_PRINT("%s", direction[DIRECTION(trp)]);
192 
193 			for (seg = 0; seg < SEGMENT_COUNT(trp); seg++)
194 				ND_PRINT(" [%u:%u]", RING_NUMBER(trp, seg),
195 				    BRIDGE_NUMBER(trp, seg));
196 		} else {
197 			ND_PRINT("rt = %x", GET_BE_U_2(trp->token_rcf));
198 
199 			for (seg = 0; seg < SEGMENT_COUNT(trp); seg++)
200 				ND_PRINT(":%x",
201 					 GET_BE_U_2(trp->token_rseg[seg]));
202 		}
203 		ND_PRINT(" (%s) ", largest_frame[LARGEST_FRAME(trp)]);
204 	} else {
205 		if (ndo->ndo_eflag)
206 			token_hdr_print(ndo, trp, length, srcmac, dstmac);
207 	}
208 
209 	src.addr = srcmac;
210 	src.addr_string = etheraddr_string;
211 	dst.addr = dstmac;
212 	dst.addr_string = etheraddr_string;
213 
214 	/* Skip over token ring MAC header and routing information */
215 	length -= hdr_len;
216 	p += hdr_len;
217 	caplen -= hdr_len;
218 
219 	/* Frame Control field determines interpretation of packet */
220 	if (FRAME_TYPE(trp) == TOKEN_FC_LLC) {
221 		/* Try to print the LLC-layer header & higher layers */
222 		llc_hdrlen = llc_print(ndo, p, length, caplen, &src, &dst);
223 		if (llc_hdrlen < 0) {
224 			/* packet type not known, print raw packet */
225 			if (!ndo->ndo_suppress_default_print)
226 				ND_DEFAULTPRINT(p, caplen);
227 			llc_hdrlen = -llc_hdrlen;
228 		}
229 		hdr_len += llc_hdrlen;
230 	} else {
231 		/* Some kinds of TR packet we cannot handle intelligently */
232 		/* XXX - dissect MAC packets if frame type is 0 */
233 		if (!ndo->ndo_eflag)
234 			token_hdr_print(ndo, trp, length + TOKEN_HDRLEN + route_len,
235 			    srcmac, dstmac);
236 		if (!ndo->ndo_suppress_default_print)
237 			ND_DEFAULTPRINT(p, caplen);
238 	}
239 	return (hdr_len);
240 }
241 
242 /*
243  * This is the top level routine of the printer.  'p' points
244  * to the TR header of the packet, 'h->ts' is the timestamp,
245  * 'h->len' is the length of the packet off the wire, and 'h->caplen'
246  * is the number of bytes actually captured.
247  */
248 void
249 token_if_print(netdissect_options *ndo, const struct pcap_pkthdr *h, const u_char *p)
250 {
251 	ndo->ndo_protocol = "token-ring";
252 	ndo->ndo_ll_hdr_len += token_print(ndo, p, h->len, h->caplen);
253 }
254