xref: /freebsd/contrib/tcpdump/netdissect.h (revision 1ad8d2ee)
1 /*
2  * Copyright (c) 1988-1997
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Copyright (c) 1998-2012  Michael Richardson <mcr@tcpdump.org>
6  *      The TCPDUMP project
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that: (1) source code distributions
10  * retain the above copyright notice and this paragraph in its entirety, (2)
11  * distributions including binary code include the above copyright notice and
12  * this paragraph in its entirety in the documentation or other materials
13  * provided with the distribution, and (3) all advertising materials mentioning
14  * features or use of this software display the following acknowledgement:
15  * ``This product includes software developed by the University of California,
16  * Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
17  * the University nor the names of its contributors may be used to endorse
18  * or promote products derived from this software without specific prior
19  * written permission.
20  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
21  * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
22  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
23  */
24 
25 #ifndef netdissect_h
26 #define netdissect_h
27 
28 #ifdef HAVE_OS_PROTO_H
29 #include "os-proto.h"
30 #endif
31 #include <sys/types.h>
32 #include <setjmp.h>
33 #include "status-exit-codes.h"
34 #include "funcattrs.h" /* for PRINTFLIKE_FUNCPTR() */
35 #include "diag-control.h" /* for ND_UNREACHABLE */
36 
37 /*
38  * Data types corresponding to multi-byte integral values within data
39  * structures.  These are defined as arrays of octets, so that they're
40  * not aligned on their "natural" boundaries, and so that you *must*
41  * use the EXTRACT_ macros to extract them (which you should be doing
42  * *anyway*, so as not to assume a particular byte order or alignment
43  * in your code).
44  *
45  * We even want EXTRACT_U_1 used for 8-bit integral values, so we
46  * define nd_uint8_t and nd_int8_t as arrays as well.
47  */
48 typedef unsigned char nd_uint8_t[1];
49 typedef unsigned char nd_uint16_t[2];
50 typedef unsigned char nd_uint24_t[3];
51 typedef unsigned char nd_uint32_t[4];
52 typedef unsigned char nd_uint40_t[5];
53 typedef unsigned char nd_uint48_t[6];
54 typedef unsigned char nd_uint56_t[7];
55 typedef unsigned char nd_uint64_t[8];
56 
57 typedef signed char nd_int8_t[1];
58 
59 /*
60  * "unsigned char" so that sign extension isn't done on the
61  * individual bytes while they're being assembled.
62  */
63 typedef unsigned char nd_int32_t[4];
64 typedef unsigned char nd_int64_t[8];
65 
66 #define	FMAXINT	(4294967296.0)	/* floating point rep. of MAXINT */
67 
68 /*
69  * Use this for IPv4 addresses and netmasks.
70  *
71  * It's defined as an array of octets, so that it's not guaranteed to
72  * be aligned on its "natural" boundary (in some packet formats, it
73  * *isn't* so aligned).  We have separate EXTRACT_ calls for them;
74  * sometimes you want the host-byte-order value, other times you want
75  * the network-byte-order value.
76  *
77  * Don't use EXTRACT_BE_U_4() on them, use EXTRACT_IPV4_TO_HOST_ORDER()
78  * if you want them in host byte order and EXTRACT_IPV4_TO_NETWORK_ORDER()
79  * if you want them in network byte order (which you want with system APIs
80  * that expect network-order IPv4 addresses, such as inet_ntop()).
81  *
82  * If, on your little-endian machine (e.g., an "IBM-compatible PC", no matter
83  * what the OS, or an Intel Mac, no matter what the OS), you get the wrong
84  * answer, and you've used EXTRACT_BE_U_4(), do *N*O*T* "fix" this by using
85  * EXTRACT_LE_U_4(), fix it by using EXTRACT_IPV4_TO_NETWORK_ORDER(),
86  * otherwise you're breaking the result on big-endian machines (e.g.,
87  * most PowerPC/Power ISA machines, System/390 and z/Architecture, SPARC,
88  * etc.).
89  *
90  * Yes, people do this; that's why Wireshark has tvb_get_ipv4(), to extract
91  * an IPv4 address from a packet data buffer; it was introduced in reaction
92  * to somebody who *had* done that.
93  */
94 typedef unsigned char nd_ipv4[4];
95 
96 /*
97  * Use this for IPv6 addresses and netmasks.
98  */
99 typedef unsigned char nd_ipv6[16];
100 
101 /*
102  * Use this for MAC addresses.
103  */
104 #define MAC_ADDR_LEN	6U		/* length of MAC addresses */
105 typedef unsigned char nd_mac_addr[MAC_ADDR_LEN];
106 
107 /*
108  * Use this for blobs of bytes; make them arrays of nd_byte.
109  */
110 typedef unsigned char nd_byte;
111 
112 /*
113  * Round up x to a multiple of y; y must be a power of 2.
114  */
115 #ifndef roundup2
116 #define	roundup2(x, y)	(((x)+((u_int)((y)-1)))&(~((u_int)((y)-1))))
117 #endif
118 
119 #include <stdarg.h>
120 #include <pcap.h>
121 
122 #include "ip.h" /* struct ip for nextproto4_cksum() */
123 #include "ip6.h" /* struct ip6 for nextproto6_cksum() */
124 
125 #ifndef HAVE_STRLCAT
126 extern size_t strlcat (char *, const char *, size_t);
127 #endif
128 #ifndef HAVE_STRLCPY
129 extern size_t strlcpy (char *, const char *, size_t);
130 #endif
131 
132 #ifndef HAVE_STRDUP
133 extern char *strdup (const char *str);
134 #endif
135 
136 #ifndef HAVE_STRSEP
137 extern char *strsep(char **, const char *);
138 #endif
139 
140 struct tok {
141 	u_int v;		/* value */
142 	const char *s;		/* string */
143 };
144 
145 /* tok2str is deprecated */
146 extern const char *tok2str(const struct tok *, const char *, u_int);
147 extern char *bittok2str(const struct tok *, const char *, u_int);
148 extern char *bittok2str_nosep(const struct tok *, const char *, u_int);
149 
150 /* Initialize netdissect. */
151 extern int nd_init(char *, size_t);
152 /* Clean up netdissect. */
153 extern void nd_cleanup(void);
154 
155 /* Do we have libsmi support? */
156 extern int nd_have_smi_support(void);
157 /* Load an SMI module. */
158 extern int nd_load_smi_module(const char *, char *, size_t);
159 /* Flag indicating whether an SMI module has been loaded. */
160 extern int nd_smi_module_loaded;
161 /* Version number of the SMI library, or NULL if we don't have libsmi support. */
162 extern const char *nd_smi_version_string(void);
163 
164 typedef struct netdissect_options netdissect_options;
165 
166 #define IF_PRINTER_ARGS (netdissect_options *, const struct pcap_pkthdr *, const u_char *)
167 
168 typedef void (*if_printer) IF_PRINTER_ARGS;
169 
170 /*
171  * In case the data in a buffer needs to be processed by being decrypted,
172  * decompressed, etc. before it's dissected, we can't process it in place,
173  * we have to allocate a new buffer for the processed data.
174  *
175  * We keep a stack of those buffers; when we allocate a new buffer, we
176  * push the current one onto a stack, and when we're done with the new
177  * buffer, we free the current buffer and pop the previous one off the
178  * stack.
179  *
180  * A buffer has a beginning and end pointer, and a link to the previous
181  * buffer on the stack.
182  *
183  * In other cases, we temporarily adjust the snapshot end to reflect a
184  * packet-length field in the packet data and, when finished dissecting
185  * that part of the packet, restore the old snapshot end.  We keep that
186  * on the stack with null buffer pointer, meaning there's nothing to
187  * free.
188  */
189 struct netdissect_saved_packet_info {
190   u_char *ndspi_buffer;					/* pointer to allocated buffer data */
191   const u_char *ndspi_packetp;				/* saved beginning of data */
192   const u_char *ndspi_snapend;				/* saved end of data */
193   struct netdissect_saved_packet_info *ndspi_prev;	/* previous buffer on the stack */
194 };
195 
196 /* 'val' value(s) for longjmp */
197 #define ND_TRUNCATED 1
198 
199 struct netdissect_options {
200   int ndo_bflag;		/* print 4 byte ASes in ASDOT notation */
201   int ndo_eflag;		/* print ethernet header */
202   int ndo_fflag;		/* don't translate "foreign" IP address */
203   int ndo_Kflag;		/* don't check IP, TCP or UDP checksums */
204   int ndo_nflag;		/* leave addresses as numbers */
205   int ndo_Nflag;		/* remove domains from printed host names */
206   int ndo_qflag;		/* quick (shorter) output */
207   int ndo_Sflag;		/* print raw TCP sequence numbers */
208   int ndo_tflag;		/* print packet arrival time */
209   int ndo_uflag;		/* Print undecoded NFS handles */
210   int ndo_vflag;		/* verbosity level */
211   int ndo_xflag;		/* print packet in hex */
212   int ndo_Xflag;		/* print packet in hex/ASCII */
213   int ndo_Aflag;		/* print packet only in ASCII observing TAB,
214 				 * LF, CR and SPACE as graphical chars
215 				 */
216   int ndo_Hflag;		/* dissect 802.11s draft mesh standard */
217   const char *ndo_protocol;	/* protocol */
218   jmp_buf ndo_early_end;	/* jmp_buf for setjmp()/longjmp() */
219   void *ndo_last_mem_p;		/* pointer to the last allocated memory chunk */
220   int ndo_packet_number;	/* print a packet number in the beginning of line */
221   int ndo_suppress_default_print; /* don't use default_print() for unknown packet types */
222   int ndo_tstamp_precision;	/* requested time stamp precision */
223   const char *program_name;	/* Name of the program using the library */
224 
225   char *ndo_espsecret;
226   struct sa_list *ndo_sa_list_head;  /* used by print-esp.c */
227   struct sa_list *ndo_sa_default;
228 
229   char *ndo_sigsecret;		/* Signature verification secret key */
230 
231   int   ndo_packettype;	/* as specified by -T */
232 
233   int   ndo_snaplen;
234   int   ndo_ll_hdr_len;	/* link-layer header length */
235 
236   /*global pointers to beginning and end of current packet (during printing) */
237   const u_char *ndo_packetp;
238   const u_char *ndo_snapend;
239 
240   /* stack of saved packet boundary and buffer information */
241   struct netdissect_saved_packet_info *ndo_packet_info_stack;
242 
243   /* pointer to the if_printer function */
244   if_printer ndo_if_printer;
245 
246   /* pointer to void function to output stuff */
247   void (*ndo_default_print)(netdissect_options *,
248 			    const u_char *bp, u_int length);
249 
250   /* pointer to function to do regular output */
251   int  (*ndo_printf)(netdissect_options *,
252 		     const char *fmt, ...)
253 		     PRINTFLIKE_FUNCPTR(2, 3);
254   /* pointer to function to output errors */
255   void NORETURN_FUNCPTR (*ndo_error)(netdissect_options *,
256 				     status_exit_codes_t status,
257 				     const char *fmt, ...)
258 				     PRINTFLIKE_FUNCPTR(3, 4);
259   /* pointer to function to output warnings */
260   void (*ndo_warning)(netdissect_options *,
261 		      const char *fmt, ...)
262 		      PRINTFLIKE_FUNCPTR(2, 3);
263 };
264 
265 extern WARN_UNUSED_RESULT int nd_push_buffer(netdissect_options *, u_char *, const u_char *, const u_int);
266 extern WARN_UNUSED_RESULT int nd_push_snaplen(netdissect_options *, const u_char *, const u_int);
267 extern void nd_change_snaplen(netdissect_options *, const u_char *, const u_int);
268 extern void nd_pop_packet_info(netdissect_options *);
269 extern void nd_pop_all_packet_info(netdissect_options *);
270 
271 static inline NORETURN void
nd_trunc_longjmp(netdissect_options * ndo)272 nd_trunc_longjmp(netdissect_options *ndo)
273 {
274 	longjmp(ndo->ndo_early_end, ND_TRUNCATED);
275 #ifdef _AIX
276 	/*
277 	 * In AIX <setjmp.h> decorates longjmp() with "#pragma leaves", which tells
278 	 * XL C that the function is noreturn, but GCC remains unaware of that and
279 	 * yields a "'noreturn' function does return" warning.
280 	 */
281 	ND_UNREACHABLE
282 #endif /* _AIX */
283 }
284 
285 #define PT_VAT		1	/* Visual Audio Tool */
286 #define PT_WB		2	/* distributed White Board */
287 #define PT_RPC		3	/* Remote Procedure Call */
288 #define PT_RTP		4	/* Real-Time Applications protocol */
289 #define PT_RTCP		5	/* Real-Time Applications control protocol */
290 #define PT_SNMP		6	/* Simple Network Management Protocol */
291 #define PT_CNFP		7	/* Cisco NetFlow protocol */
292 #define PT_TFTP		8	/* trivial file transfer protocol */
293 #define PT_AODV		9	/* Ad-hoc On-demand Distance Vector Protocol */
294 #define PT_CARP		10	/* Common Address Redundancy Protocol */
295 #define PT_RADIUS	11	/* RADIUS authentication Protocol */
296 #define PT_ZMTP1	12	/* ZeroMQ Message Transport Protocol 1.0 */
297 #define PT_VXLAN	13	/* Virtual eXtensible Local Area Network */
298 #define PT_PGM		14	/* [UDP-encapsulated] Pragmatic General Multicast */
299 #define PT_PGM_ZMTP1	15	/* ZMTP/1.0 inside PGM (native or UDP-encapsulated) */
300 #define PT_LMP		16	/* Link Management Protocol */
301 #define PT_RESP		17	/* RESP */
302 #define PT_PTP		18	/* PTP */
303 #define PT_SOMEIP	19	/* Autosar SOME/IP Protocol */
304 #define PT_DOMAIN	20	/* Domain Name System (DNS) */
305 
306 #define ND_MIN(a,b) ((a)>(b)?(b):(a))
307 #define ND_MAX(a,b) ((b)>(a)?(b):(a))
308 
309 /* For source or destination ports tests (UDP, TCP, ...) */
310 #define IS_SRC_OR_DST_PORT(p) (sport == (p) || dport == (p))
311 
312 /*
313  * Maximum snapshot length.  This should be enough to capture the full
314  * packet on most network interfaces.
315  *
316  *
317  * Somewhat arbitrary, but chosen to be:
318  *
319  *    1) big enough for maximum-size Linux loopback packets (65549)
320  *       and some USB packets captured with USBPcap:
321  *
322  *           https://desowin.org/usbpcap/
323  *
324  *       (> 131072, < 262144)
325  *
326  * and
327  *
328  *    2) small enough not to cause attempts to allocate huge amounts of
329  *       memory; some applications might use the snapshot length in a
330  *       savefile header to control the size of the buffer they allocate,
331  *       so a size of, say, 2^31-1 might not work well.
332  *
333  * XXX - does it need to be bigger still?  Note that, for versions of
334  * libpcap with pcap_create()/pcap_activate(), if no -s flag is specified
335  * or -s 0 is specified, we won't set the snapshot length at all, and will
336  * let libpcap choose a snapshot length; newer versions may choose a bigger
337  * value than 262144 for D-Bus, for example.
338  */
339 #define MAXIMUM_SNAPLEN	262144
340 
341 /*
342  * True if "l" bytes from "p" were captured.
343  *
344  * The "ndo->ndo_snapend - (l) <= ndo->ndo_snapend" checks to make sure
345  * "l" isn't so large that "ndo->ndo_snapend - (l)" underflows.
346  *
347  * The check is for <= rather than < because "l" might be 0.
348  *
349  * We cast the pointers to uintptr_t to make sure that the compiler
350  * doesn't optimize away any of these tests (which it is allowed to
351  * do, as adding an integer to, or subtracting an integer from, a
352  * pointer assumes that the pointer is a pointer to an element of an
353  * array and that the result of the addition or subtraction yields a
354  * pointer to another member of the array, so that, for example, if
355  * you subtract a positive integer from a pointer, the result is
356  * guaranteed to be less than the original pointer value). See
357  *
358  *	https://www.kb.cert.org/vuls/id/162289
359  */
360 
361 /*
362  * Test in two parts to avoid these warnings:
363  * comparison of unsigned expression >= 0 is always true [-Wtype-limits],
364  * comparison is always true due to limited range of data type [-Wtype-limits].
365  */
366 #define IS_NOT_NEGATIVE(x) (((x) > 0) || ((x) == 0))
367 
368 #define ND_TTEST_LEN(p, l) \
369   (IS_NOT_NEGATIVE(l) && \
370 	((uintptr_t)ndo->ndo_snapend - (l) <= (uintptr_t)ndo->ndo_snapend && \
371          (uintptr_t)(p) <= (uintptr_t)ndo->ndo_snapend - (l)))
372 
373 /* True if "*(p)" was captured */
374 #define ND_TTEST_SIZE(p) ND_TTEST_LEN(p, sizeof(*(p)))
375 
376 /* Bail out if "l" bytes from "p" were not captured */
377 #ifdef ND_LONGJMP_FROM_TCHECK
378 #define ND_TCHECK_LEN(p, l) if (!ND_TTEST_LEN(p, l)) nd_trunc_longjmp(ndo)
379 #else
380 #define ND_TCHECK_LEN(p, l) if (!ND_TTEST_LEN(p, l)) goto trunc
381 #endif
382 
383 /* Bail out if "*(p)" was not captured */
384 #define ND_TCHECK_SIZE(p) ND_TCHECK_LEN(p, sizeof(*(p)))
385 
386 /*
387  * Number of bytes between two pointers.
388  */
389 #define ND_BYTES_BETWEEN(p1, p2) ((u_int)(((const uint8_t *)(p1)) - (const uint8_t *)(p2)))
390 
391 /*
392  * Number of bytes remaining in the captured data, starting at the
393  * byte pointed to by the argument.
394  */
395 #define ND_BYTES_AVAILABLE_AFTER(p) ND_BYTES_BETWEEN(ndo->ndo_snapend, (p))
396 
397 /* Check length < minimum for invalid packet with a custom message, format %u */
398 #define ND_LCHECKMSG_U(length, minimum, what) \
399 if ((length) < (minimum)) { \
400 ND_PRINT(" [%s %u < %u]", (what), (length), (minimum)); \
401 goto invalid; \
402 }
403 
404 /* Check length < minimum for invalid packet with #length message, format %u */
405 #define ND_LCHECK_U(length, minimum) \
406 ND_LCHECKMSG_U((length), (minimum), (#length))
407 
408 /* Check length < minimum for invalid packet with a custom message, format %zu */
409 #define ND_LCHECKMSG_ZU(length, minimum, what) \
410 if ((length) < (minimum)) { \
411 ND_PRINT(" [%s %u < %zu]", (what), (length), (minimum)); \
412 goto invalid; \
413 }
414 
415 /* Check length < minimum for invalid packet with #length message, format %zu */
416 #define ND_LCHECK_ZU(length, minimum) \
417 ND_LCHECKMSG_ZU((length), (minimum), (#length))
418 
419 #define ND_PRINT(...) (ndo->ndo_printf)(ndo, __VA_ARGS__)
420 #define ND_DEFAULTPRINT(ap, length) (*ndo->ndo_default_print)(ndo, ap, length)
421 
422 extern void ts_print(netdissect_options *, const struct timeval *);
423 extern void signed_relts_print(netdissect_options *, int32_t);
424 extern void unsigned_relts_print(netdissect_options *, uint32_t);
425 
426 extern const char *nd_format_time(char *buf, size_t bufsize,
427     const char *format, const struct tm *timeptr);
428 
429 extern void fn_print_char(netdissect_options *, u_char);
430 extern void fn_print_str(netdissect_options *, const u_char *);
431 extern u_int nd_printztn(netdissect_options *, const u_char *, u_int, const u_char *);
432 extern int nd_printn(netdissect_options *, const u_char *, u_int, const u_char *);
433 extern void nd_printjnp(netdissect_options *, const u_char *, u_int);
434 
435 /*
436  * Flags for txtproto_print().
437  */
438 #define RESP_CODE_SECOND_TOKEN	0x00000001	/* response code is second token in response line */
439 
440 extern void txtproto_print(netdissect_options *, const u_char *, u_int,
441 			   const char **, u_int);
442 
443 #if (defined(__i386__) || defined(_M_IX86) || defined(__X86__) || defined(__x86_64__) || defined(_M_X64)) || \
444     (defined(__arm__) || defined(_M_ARM) || defined(__aarch64__)) || \
445     (defined(__m68k__) && (!defined(__mc68000__) && !defined(__mc68010__))) || \
446     (defined(__ppc__) || defined(__ppc64__) || defined(_M_PPC) || defined(_ARCH_PPC) || defined(_ARCH_PPC64)) || \
447     (defined(__s390__) || defined(__s390x__) || defined(__zarch__)) || \
448     defined(__vax__)
449 /*
450  * The processor natively handles unaligned loads, so just use memcpy()
451  * and memcmp(), to enable those optimizations.
452  *
453  * XXX - are those all the x86 tests we need?
454  * XXX - do we need to worry about ARMv1 through ARMv5, which didn't
455  * support unaligned loads, and, if so, do we need to worry about all
456  * of them, or just some of them, e.g. ARMv5?
457  * XXX - are those the only 68k tests we need not to generated
458  * unaligned accesses if the target is the 68000 or 68010?
459  * XXX - are there any tests we don't need, because some definitions are for
460  * compilers that also predefine the GCC symbols?
461  * XXX - do we need to test for both 32-bit and 64-bit versions of those
462  * architectures in all cases?
463  */
464 #define UNALIGNED_MEMCPY(p, q, l)	memcpy((p), (q), (l))
465 #define UNALIGNED_MEMCMP(p, q, l)	memcmp((p), (q), (l))
466 #else
467 /*
468  * The processor doesn't natively handle unaligned loads,
469  * and the compiler might "helpfully" optimize memcpy()
470  * and memcmp(), when handed pointers that would normally
471  * be properly aligned, into sequences that assume proper
472  * alignment.
473  *
474  * Do copies and compares of possibly-unaligned data by
475  * calling routines that wrap memcpy() and memcmp(), to
476  * prevent that optimization.
477  */
478 extern void unaligned_memcpy(void *, const void *, size_t);
479 extern int unaligned_memcmp(const void *, const void *, size_t);
480 #define UNALIGNED_MEMCPY(p, q, l)	unaligned_memcpy((p), (q), (l))
481 #define UNALIGNED_MEMCMP(p, q, l)	unaligned_memcmp((p), (q), (l))
482 #endif
483 
484 #define PLURAL_SUFFIX(n) \
485 	(((n) != 1) ? "s" : "")
486 
487 extern const char *tok2strary_internal(const char **, int, const char *, int);
488 #define	tok2strary(a,f,i) tok2strary_internal(a, sizeof(a)/sizeof(a[0]),f,i)
489 
490 struct uint_tokary
491 {
492 	u_int uintval;
493 	const struct tok *tokary;
494 };
495 
496 extern const struct tok *uint2tokary_internal(const struct uint_tokary[], const size_t, const u_int);
497 #define uint2tokary(a, i) uint2tokary_internal(a, sizeof(a)/sizeof(a[0]), i)
498 
499 extern if_printer lookup_printer(int);
500 
501 #define ND_DEBUG {printf(" [%s:%d %s] ", __FILE__, __LINE__, __func__); fflush(stdout);}
502 
503 /* The DLT printer routines */
504 
505 extern void ap1394_if_print IF_PRINTER_ARGS;
506 extern void arcnet_if_print IF_PRINTER_ARGS;
507 extern void arcnet_linux_if_print IF_PRINTER_ARGS;
508 extern void atm_if_print IF_PRINTER_ARGS;
509 extern void brcm_tag_if_print IF_PRINTER_ARGS;
510 extern void brcm_tag_prepend_if_print IF_PRINTER_ARGS;
511 extern void bt_if_print IF_PRINTER_ARGS;
512 extern void chdlc_if_print IF_PRINTER_ARGS;
513 extern void cip_if_print IF_PRINTER_ARGS;
514 extern void dsa_if_print IF_PRINTER_ARGS;
515 extern void edsa_if_print IF_PRINTER_ARGS;
516 extern void enc_if_print IF_PRINTER_ARGS;
517 extern void ether_if_print IF_PRINTER_ARGS;
518 extern void fddi_if_print IF_PRINTER_ARGS;
519 extern void fr_if_print IF_PRINTER_ARGS;
520 extern void ieee802_11_if_print IF_PRINTER_ARGS;
521 extern void ieee802_11_radio_avs_if_print IF_PRINTER_ARGS;
522 extern void ieee802_11_radio_if_print IF_PRINTER_ARGS;
523 extern void ieee802_15_4_if_print IF_PRINTER_ARGS;
524 extern void ieee802_15_4_tap_if_print IF_PRINTER_ARGS;
525 extern void ipfc_if_print IF_PRINTER_ARGS;
526 extern void ipnet_if_print IF_PRINTER_ARGS;
527 extern void ipoib_if_print IF_PRINTER_ARGS;
528 extern void juniper_atm1_if_print IF_PRINTER_ARGS;
529 extern void juniper_atm2_if_print IF_PRINTER_ARGS;
530 extern void juniper_chdlc_if_print IF_PRINTER_ARGS;
531 extern void juniper_es_if_print IF_PRINTER_ARGS;
532 extern void juniper_ether_if_print IF_PRINTER_ARGS;
533 extern void juniper_frelay_if_print IF_PRINTER_ARGS;
534 extern void juniper_ggsn_if_print IF_PRINTER_ARGS;
535 extern void juniper_mfr_if_print IF_PRINTER_ARGS;
536 extern void juniper_mlfr_if_print IF_PRINTER_ARGS;
537 extern void juniper_mlppp_if_print IF_PRINTER_ARGS;
538 extern void juniper_monitor_if_print IF_PRINTER_ARGS;
539 extern void juniper_ppp_if_print IF_PRINTER_ARGS;
540 extern void juniper_pppoe_atm_if_print IF_PRINTER_ARGS;
541 extern void juniper_pppoe_if_print IF_PRINTER_ARGS;
542 extern void juniper_services_if_print IF_PRINTER_ARGS;
543 extern void ltalk_if_print IF_PRINTER_ARGS;
544 extern void mfr_if_print IF_PRINTER_ARGS;
545 extern void netanalyzer_if_print IF_PRINTER_ARGS;
546 extern void netanalyzer_transparent_if_print IF_PRINTER_ARGS;
547 extern void nflog_if_print IF_PRINTER_ARGS;
548 extern void null_if_print IF_PRINTER_ARGS;
549 extern void pflog_if_print IF_PRINTER_ARGS;
550 extern void pktap_if_print IF_PRINTER_ARGS;
551 extern void ppi_if_print IF_PRINTER_ARGS;
552 extern void ppp_bsdos_if_print IF_PRINTER_ARGS;
553 extern void ppp_hdlc_if_print IF_PRINTER_ARGS;
554 extern void ppp_if_print IF_PRINTER_ARGS;
555 extern void pppoe_if_print IF_PRINTER_ARGS;
556 extern void prism_if_print IF_PRINTER_ARGS;
557 extern void raw_if_print IF_PRINTER_ARGS;
558 extern void sl_bsdos_if_print IF_PRINTER_ARGS;
559 extern void sl_if_print IF_PRINTER_ARGS;
560 extern void sll2_if_print IF_PRINTER_ARGS;
561 extern void sll_if_print IF_PRINTER_ARGS;
562 extern void sunatm_if_print IF_PRINTER_ARGS;
563 extern void symantec_if_print IF_PRINTER_ARGS;
564 extern void token_if_print IF_PRINTER_ARGS;
565 extern void unsupported_if_print IF_PRINTER_ARGS;
566 extern void usb_linux_48_byte_if_print IF_PRINTER_ARGS;
567 extern void usb_linux_64_byte_if_print IF_PRINTER_ARGS;
568 extern void vsock_if_print IF_PRINTER_ARGS;
569 
570 /*
571  * Structure passed to some printers to allow them to print
572  * link-layer address information if ndo_eflag isn't set
573  * (because they are for protocols that don't have their
574  * own addresses, so that we'd want to report link-layer
575  * address information).
576  *
577  * This contains a pointer to an address and a pointer to a routine
578  * to which we pass that pointer in order to get a string.
579  */
580 struct lladdr_info {
581 	const char *(*addr_string)(netdissect_options *, const u_char *);
582 	const u_char *addr;
583 };
584 
585 /* The printer routines. */
586 
587 extern void aarp_print(netdissect_options *, const u_char *, u_int);
588 extern int ah_print(netdissect_options *, const u_char *);
589 extern void ahcp_print(netdissect_options *, const u_char *, u_int);
590 extern void aodv_print(netdissect_options *, const u_char *, u_int, int);
591 extern void aoe_print(netdissect_options *, const u_char *, const u_int);
592 extern int  arista_ethertype_print(netdissect_options *,const u_char *, u_int);
593 extern void arp_print(netdissect_options *, const u_char *, u_int, u_int);
594 extern void ascii_print(netdissect_options *, const u_char *, u_int);
595 extern void atalk_print(netdissect_options *, const u_char *, u_int);
596 extern void atm_print(netdissect_options *, u_int, u_int, u_int, const u_char *, u_int, u_int);
597 extern void babel_print(netdissect_options *, const u_char *, u_int);
598 extern void bcm_li_print(netdissect_options *, const u_char *, u_int);
599 extern void beep_print(netdissect_options *, const u_char *, u_int);
600 extern void bfd_print(netdissect_options *, const u_char *, u_int, u_int);
601 extern void bgp_print(netdissect_options *, const u_char *, u_int);
602 extern const char *bgp_vpn_rd_print(netdissect_options *, const u_char *);
603 extern void bootp_print(netdissect_options *, const u_char *, u_int);
604 extern void calm_fast_print(netdissect_options *, const u_char *, u_int, const struct lladdr_info *);
605 extern void carp_print(netdissect_options *, const u_char *, u_int, u_int);
606 extern void cdp_print(netdissect_options *, const u_char *, u_int);
607 extern void cfm_print(netdissect_options *, const u_char *, u_int);
608 extern u_int chdlc_print(netdissect_options *, const u_char *, u_int);
609 extern void cisco_autorp_print(netdissect_options *, const u_char *, u_int);
610 extern void cnfp_print(netdissect_options *, const u_char *);
611 extern void dccp_print(netdissect_options *, const u_char *, const u_char *, u_int);
612 extern void decnet_print(netdissect_options *, const u_char *, u_int, u_int);
613 extern void dhcp6_print(netdissect_options *, const u_char *, u_int);
614 extern int dstopt_process(netdissect_options *, const u_char *);
615 extern void dtp_print(netdissect_options *, const u_char *, u_int);
616 extern void dvmrp_print(netdissect_options *, const u_char *, u_int);
617 extern void eap_print(netdissect_options *, const u_char *, u_int);
618 extern void eapol_print(netdissect_options *, const u_char *);
619 extern void egp_print(netdissect_options *, const u_char *, u_int);
620 extern void eigrp_print(netdissect_options *, const u_char *, u_int);
621 extern void esp_print(netdissect_options *, const u_char *, u_int, const u_char *, u_int, int, u_int);
622 extern u_int ether_print(netdissect_options *, const u_char *, u_int, u_int, void (*)(netdissect_options *, const u_char *), const u_char *);
623 extern u_int ether_switch_tag_print(netdissect_options *, const u_char *, u_int, u_int, void (*)(netdissect_options *, const u_char *), u_int);
624 extern int ethertype_print(netdissect_options *, u_short, const u_char *, u_int, u_int, const struct lladdr_info *, const struct lladdr_info *);
625 extern u_int fddi_print(netdissect_options *, const u_char *, u_int, u_int);
626 extern void forces_print(netdissect_options *, const u_char *, u_int);
627 extern u_int fr_print(netdissect_options *, const u_char *, u_int);
628 extern int frag6_print(netdissect_options *, const u_char *, const u_char *);
629 extern void ftp_print(netdissect_options *, const u_char *, u_int);
630 extern void geneve_print(netdissect_options *, const u_char *, u_int);
631 extern void geonet_print(netdissect_options *, const u_char *, u_int, const struct lladdr_info *);
632 extern void gre_print(netdissect_options *, const u_char *, u_int);
633 extern int hbhopt_process(netdissect_options *, const u_char *, int *, uint32_t *);
634 extern void hex_and_ascii_print(netdissect_options *, const char *, const u_char *, u_int);
635 extern void hex_print(netdissect_options *, const char *ident, const u_char *cp, u_int);
636 extern void hex_print_with_offset(netdissect_options *, const char *ident, const u_char *cp, u_int, u_int);
637 extern void hncp_print(netdissect_options *, const u_char *, u_int);
638 extern void hsrp_print(netdissect_options *, const u_char *, u_int);
639 extern void http_print(netdissect_options *, const u_char *, u_int);
640 extern void icmp6_print(netdissect_options *, const u_char *, u_int, const u_char *, int);
641 extern void icmp_print(netdissect_options *, const u_char *, u_int, const u_char *, int);
642 extern u_int ieee802_15_4_print(netdissect_options *, const u_char *, u_int);
643 extern u_int ieee802_11_radio_print(netdissect_options *, const u_char *, u_int, u_int);
644 extern void igmp_print(netdissect_options *, const u_char *, u_int);
645 extern void igrp_print(netdissect_options *, const u_char *, u_int);
646 extern void ip6_print(netdissect_options *, const u_char *, u_int);
647 extern void ipN_print(netdissect_options *, const u_char *, u_int);
648 extern void ip_print(netdissect_options *, const u_char *, u_int);
649 extern void ipcomp_print(netdissect_options *, const u_char *);
650 extern void ipx_netbios_print(netdissect_options *, const u_char *, u_int);
651 extern void ipx_print(netdissect_options *, const u_char *, u_int);
652 extern void isakmp_print(netdissect_options *, const u_char *, u_int, const u_char *);
653 extern void isakmp_rfc3948_print(netdissect_options *, const u_char *, u_int, const u_char *, int, int, u_int);
654 extern void isoclns_print(netdissect_options *, const u_char *, u_int);
655 extern void krb_print(netdissect_options *, const u_char *);
656 extern void l2tp_print(netdissect_options *, const u_char *, u_int);
657 extern void lane_print(netdissect_options *, const u_char *, u_int, u_int);
658 extern void ldp_print(netdissect_options *, const u_char *, u_int);
659 extern void lisp_print(netdissect_options *, const u_char *, u_int);
660 extern u_int llap_print(netdissect_options *, const u_char *, u_int);
661 extern int llc_print(netdissect_options *, const u_char *, u_int, u_int, const struct lladdr_info *, const struct lladdr_info *);
662 extern void lldp_print(netdissect_options *, const u_char *, u_int);
663 extern void lmp_print(netdissect_options *, const u_char *, u_int);
664 extern void loopback_print(netdissect_options *, const u_char *, u_int);
665 extern void lspping_print(netdissect_options *, const u_char *, u_int);
666 extern void lwapp_control_print(netdissect_options *, const u_char *, u_int, int);
667 extern void lwapp_data_print(netdissect_options *, const u_char *, u_int);
668 extern void lwres_print(netdissect_options *, const u_char *, u_int);
669 extern void m3ua_print(netdissect_options *, const u_char *, const u_int);
670 extern int macsec_print(netdissect_options *, const u_char **,
671 			 u_int *, u_int *, u_int *, const struct lladdr_info *,
672 			 const struct lladdr_info *);
673 extern u_int mfr_print(netdissect_options *, const u_char *, u_int);
674 extern void mobile_print(netdissect_options *, const u_char *, u_int);
675 extern int mobility_print(netdissect_options *, const u_char *, const u_char *);
676 extern void mpcp_print(netdissect_options *, const u_char *, u_int);
677 extern void mpls_print(netdissect_options *, const u_char *, u_int);
678 extern int mptcp_print(netdissect_options *, const u_char *, u_int, u_char);
679 extern void msdp_print(netdissect_options *, const u_char *, u_int);
680 extern void msnlb_print(netdissect_options *, const u_char *);
681 extern void nbt_tcp_print(netdissect_options *, const u_char *, u_int);
682 extern void nbt_udp137_print(netdissect_options *, const u_char *, u_int);
683 extern void nbt_udp138_print(netdissect_options *, const u_char *, u_int);
684 extern void netbeui_print(netdissect_options *, u_short, const u_char *, u_int);
685 extern void nfsreply_print(netdissect_options *, const u_char *, u_int, const u_char *);
686 extern void nfsreply_noaddr_print(netdissect_options *, const u_char *, u_int, const u_char *);
687 extern void nfsreq_noaddr_print(netdissect_options *, const u_char *, u_int, const u_char *);
688 extern const u_char *fqdn_print(netdissect_options *, const u_char *, const u_char *);
689 extern void domain_print(netdissect_options *, const u_char *, u_int, int, int);
690 extern void nsh_print(netdissect_options *, const u_char *, u_int);
691 extern void ntp_print(netdissect_options *, const u_char *, u_int);
692 extern void oam_print(netdissect_options *, const u_char *, u_int, u_int);
693 extern void olsr_print(netdissect_options *, const u_char *, u_int, int);
694 extern void openflow_print(netdissect_options *, const u_char *, u_int);
695 extern void ospf6_print(netdissect_options *, const u_char *, u_int);
696 extern void ospf_print(netdissect_options *, const u_char *, u_int, const u_char *);
697 extern int ospf_grace_lsa_print(netdissect_options *, const u_char *, u_int);
698 extern int ospf_te_lsa_print(netdissect_options *, const u_char *, u_int);
699 extern void otv_print(netdissect_options *, const u_char *, u_int);
700 extern void pfsync_ip_print(netdissect_options *, const u_char *, u_int);
701 extern void pfsync_if_print(netdissect_options *, const struct pcap_pkthdr *, const u_char *);
702 extern void pgm_print(netdissect_options *, const u_char *, u_int, const u_char *);
703 extern void pim_print(netdissect_options *, const u_char *, u_int, const u_char *);
704 extern void pimv1_print(netdissect_options *, const u_char *, u_int);
705 extern u_int ppp_print(netdissect_options *, const u_char *, u_int);
706 extern u_int pppoe_print(netdissect_options *, const u_char *, u_int);
707 extern void pptp_print(netdissect_options *, const u_char *);
708 extern void ptp_print(netdissect_options *, const u_char *, u_int);
709 extern int print_unknown_data(netdissect_options *, const u_char *, const char *, u_int);
710 extern const char *q922_string(netdissect_options *, const u_char *, u_int);
711 extern void q933_print(netdissect_options *, const u_char *, u_int);
712 extern void radius_print(netdissect_options *, const u_char *, u_int);
713 extern void resp_print(netdissect_options *, const u_char *, u_int);
714 extern void rip_print(netdissect_options *, const u_char *, u_int);
715 extern void ripng_print(netdissect_options *, const u_char *, unsigned int);
716 extern void rpki_rtr_print(netdissect_options *, const u_char *, u_int);
717 extern void rsvp_print(netdissect_options *, const u_char *, u_int);
718 extern int rt6_print(netdissect_options *, const u_char *, const u_char *);
719 extern void rtl_print(netdissect_options *, const u_char *, u_int, const struct lladdr_info *, const struct lladdr_info *);
720 extern void rtsp_print(netdissect_options *, const u_char *, u_int);
721 extern void rx_print(netdissect_options *, const u_char *, u_int, uint16_t, uint16_t, const u_char *);
722 extern void sctp_print(netdissect_options *, const u_char *, const u_char *, u_int);
723 extern void sflow_print(netdissect_options *, const u_char *, u_int);
724 extern void ssh_print(netdissect_options *, const u_char *, u_int);
725 extern void sip_print(netdissect_options *, const u_char *, u_int);
726 extern void slow_print(netdissect_options *, const u_char *, u_int);
727 extern void smb_tcp_print(netdissect_options *, const u_char *, u_int);
728 extern void smtp_print(netdissect_options *, const u_char *, u_int);
729 extern int snap_print(netdissect_options *, const u_char *, u_int, u_int, const struct lladdr_info *, const struct lladdr_info *, u_int);
730 extern void snmp_print(netdissect_options *, const u_char *, u_int);
731 extern void stp_print(netdissect_options *, const u_char *, u_int);
732 extern void sunrpc_print(netdissect_options *, const u_char *, u_int, const u_char *);
733 extern void syslog_print(netdissect_options *, const u_char *, u_int);
734 extern void tcp_print(netdissect_options *, const u_char *, u_int, const u_char *, int);
735 extern void telnet_print(netdissect_options *, const u_char *, u_int);
736 extern void tftp_print(netdissect_options *, const u_char *, u_int);
737 extern void timed_print(netdissect_options *, const u_char *);
738 extern void tipc_print(netdissect_options *, const u_char *, u_int, u_int);
739 extern u_int token_print(netdissect_options *, const u_char *, u_int, u_int);
740 extern void udld_print(netdissect_options *, const u_char *, u_int);
741 extern void udp_print(netdissect_options *, const u_char *, u_int, const u_char *, int, u_int);
742 extern int vjc_print(netdissect_options *, const u_char *, u_short);
743 extern void vqp_print(netdissect_options *, const u_char *, u_int);
744 extern void vrrp_print(netdissect_options *, const u_char *, u_int, const u_char *, int, int);
745 extern void vtp_print(netdissect_options *, const u_char *, const u_int);
746 extern void vxlan_gpe_print(netdissect_options *, const u_char *, u_int);
747 extern void vxlan_print(netdissect_options *, const u_char *, u_int);
748 extern void wb_print(netdissect_options *, const u_char *, u_int);
749 extern void whois_print(netdissect_options *, const u_char *, u_int);
750 extern void zep_print(netdissect_options *, const u_char *, u_int);
751 extern void zephyr_print(netdissect_options *, const u_char *, u_int);
752 extern void zmtp1_print(netdissect_options *, const u_char *, u_int);
753 extern void zmtp1_datagram_print(netdissect_options *, const u_char *, const u_int);
754 extern void someip_print(netdissect_options *, const u_char *, const u_int);
755 
756 /* checksum routines */
757 extern void init_checksum(void);
758 extern uint16_t verify_crc10_cksum(uint16_t, const u_char *, int);
759 extern uint16_t create_osi_cksum(const uint8_t *, int, int);
760 
761 struct cksum_vec {
762 	const uint8_t	*ptr;
763 	int		len;
764 };
765 extern uint16_t in_cksum(const struct cksum_vec *, int);
766 extern uint16_t in_cksum_shouldbe(uint16_t, uint16_t);
767 
768 /* IP protocol demuxing routines */
769 extern void ip_demux_print(netdissect_options *, const u_char *, u_int, u_int, int, u_int, uint8_t, const u_char *);
770 
771 extern uint16_t nextproto4_cksum(netdissect_options *, const struct ip *, const uint8_t *, u_int, u_int, uint8_t);
772 
773 /* in print-ip6.c */
774 extern uint16_t nextproto6_cksum(netdissect_options *, const struct ip6_hdr *, const uint8_t *, u_int, u_int, uint8_t);
775 
776 /* Utilities */
777 extern void nd_print_trunc(netdissect_options *);
778 extern void nd_print_protocol(netdissect_options *);
779 extern void nd_print_protocol_caps(netdissect_options *);
780 extern void nd_print_invalid(netdissect_options *);
781 
782 extern int mask2plen(uint32_t);
783 extern int mask62plen(const u_char *);
784 
785 extern const char *dnnum_string(netdissect_options *, u_short);
786 
787 extern int decode_prefix4(netdissect_options *, const u_char *, u_int, char *, size_t);
788 extern int decode_prefix6(netdissect_options *, const u_char *, u_int, char *, size_t);
789 
790 extern void esp_decodesecret_print(netdissect_options *);
791 extern int esp_decrypt_buffer_by_ikev2_print(netdissect_options *, int,
792 					     const u_char spii[8],
793 					     const u_char spir[8],
794 					     const u_char *, const u_char *);
795 
796 #endif  /* netdissect_h */
797