Home | History | Annotate | Line # | Download | only in dist
      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 (at) 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 <time.h>
     34 #include "status-exit-codes.h"
     35 #include "funcattrs.h" /* for PRINTFLIKE_FUNCPTR() */
     36 #include "diag-control.h" /* for ND_UNREACHABLE */
     37 
     38 /*
     39  * Data types corresponding to multi-byte integral values within data
     40  * structures.  These are defined as arrays of octets, so that they're
     41  * not aligned on their "natural" boundaries, and so that you *must*
     42  * use the EXTRACT_ macros to extract them (which you should be doing
     43  * *anyway*, so as not to assume a particular byte order or alignment
     44  * in your code).
     45  *
     46  * We even want EXTRACT_U_1 used for 8-bit integral values, so we
     47  * define nd_uint8_t and nd_int8_t as arrays as well.
     48  */
     49 typedef unsigned char nd_uint8_t[1];
     50 typedef unsigned char nd_uint16_t[2];
     51 typedef unsigned char nd_uint24_t[3];
     52 typedef unsigned char nd_uint32_t[4];
     53 typedef unsigned char nd_uint40_t[5];
     54 typedef unsigned char nd_uint48_t[6];
     55 typedef unsigned char nd_uint56_t[7];
     56 typedef unsigned char nd_uint64_t[8];
     57 
     58 typedef signed char nd_int8_t[1];
     59 
     60 /*
     61  * "unsigned char" so that sign extension isn't done on the
     62  * individual bytes while they're being assembled.  Use
     63  * GET_S_BE_n() and GET_S_LE_n() macros to extract the value
     64  * as a signed integer.
     65  */
     66 typedef unsigned char nd_int16_t[2];
     67 typedef unsigned char nd_int24_t[3];
     68 typedef unsigned char nd_int32_t[4];
     69 typedef unsigned char nd_int40_t[5];
     70 typedef unsigned char nd_int48_t[6];
     71 typedef unsigned char nd_int56_t[7];
     72 typedef unsigned char nd_int64_t[8];
     73 
     74 #define	FMAXINT	(4294967296.0)	/* floating point rep. of MAXINT */
     75 
     76 /*
     77  * Use this for IPv4 addresses and netmasks.
     78  *
     79  * It's defined as an array of octets, so that it's not guaranteed to
     80  * be aligned on its "natural" boundary (in some packet formats, it
     81  * *isn't* so aligned).  We have separate EXTRACT_ calls for them;
     82  * sometimes you want the host-byte-order value, other times you want
     83  * the network-byte-order value.
     84  *
     85  * Don't use EXTRACT_BE_U_4() on them, use EXTRACT_IPV4_TO_HOST_ORDER()
     86  * if you want them in host byte order and EXTRACT_IPV4_TO_NETWORK_ORDER()
     87  * if you want them in network byte order (which you want with system APIs
     88  * that expect network-order IPv4 addresses, such as inet_ntop()).
     89  *
     90  * If, on your little-endian machine (e.g., an "IBM-compatible PC", no matter
     91  * what the OS, or an Intel Mac, no matter what the OS), you get the wrong
     92  * answer, and you've used EXTRACT_BE_U_4(), do *N*O*T* "fix" this by using
     93  * EXTRACT_LE_U_4(), fix it by using EXTRACT_IPV4_TO_NETWORK_ORDER(),
     94  * otherwise you're breaking the result on big-endian machines (e.g.,
     95  * most PowerPC/Power ISA machines, System/390 and z/Architecture, SPARC,
     96  * etc.).
     97  *
     98  * Yes, people do this; that's why Wireshark has tvb_get_ipv4(), to extract
     99  * an IPv4 address from a packet data buffer; it was introduced in reaction
    100  * to somebody who *had* done that.
    101  */
    102 typedef unsigned char nd_ipv4[4];
    103 
    104 /*
    105  * Use this for IPv6 addresses and netmasks.
    106  */
    107 typedef unsigned char nd_ipv6[16];
    108 
    109 /*
    110  * Use this for MAC addresses.
    111  */
    112 #define MAC_ADDR_LEN	6U		/* length of MAC addresses */
    113 typedef unsigned char nd_mac_addr[MAC_ADDR_LEN];
    114 
    115 /*
    116  * Use this for blobs of bytes; make them arrays of nd_byte.
    117  */
    118 typedef unsigned char nd_byte;
    119 
    120 /*
    121  * Round up x to a multiple of y; y must be a power of 2.
    122  */
    123 #ifndef roundup2
    124 #define	roundup2(x, y)	(((x)+((u_int)((y)-1)))&(~((u_int)((y)-1))))
    125 #endif
    126 
    127 #include <stdarg.h>
    128 #include <pcap.h>
    129 
    130 #include "ip.h" /* struct ip for nextproto4_cksum() */
    131 #include "ip6.h" /* struct ip6 for nextproto6_cksum() */
    132 
    133 #ifndef HAVE_STRLCAT
    134 extern size_t strlcat (char *, const char *, size_t);
    135 #endif
    136 #ifndef HAVE_STRLCPY
    137 extern size_t strlcpy (char *, const char *, size_t);
    138 #endif
    139 
    140 #ifndef HAVE_STRDUP
    141 extern char *strdup (const char *str);
    142 #endif
    143 
    144 #ifndef HAVE_STRSEP
    145 extern char *strsep(char **, const char *);
    146 #endif
    147 
    148 struct tok {
    149 	u_int v;		/* value */
    150 	const char *s;		/* string */
    151 };
    152 
    153 /* tok2str is deprecated */
    154 extern const char *tok2str(const struct tok *, const char *, u_int);
    155 extern char *bittok2str(const struct tok *, const char *, u_int);
    156 extern char *bittok2str_nosep(const struct tok *, const char *, u_int);
    157 
    158 /* Initialize netdissect. */
    159 extern int nd_init(char *, size_t);
    160 /* Clean up netdissect. */
    161 extern void nd_cleanup(void);
    162 
    163 /* Do we have libsmi support? */
    164 extern int nd_have_smi_support(void);
    165 /* Load an SMI module. */
    166 extern int nd_load_smi_module(const char *, char *, size_t);
    167 /* Flag indicating whether an SMI module has been loaded. */
    168 extern int nd_smi_module_loaded;
    169 /* Version number of the SMI library, or NULL if we don't have libsmi support. */
    170 extern const char *nd_smi_version_string(void);
    171 
    172 typedef struct netdissect_options netdissect_options;
    173 
    174 #define IF_PRINTER_ARGS (netdissect_options *, const struct pcap_pkthdr *, const u_char *)
    175 
    176 typedef void (*if_printer) IF_PRINTER_ARGS;
    177 
    178 /*
    179  * In case the data in a buffer needs to be processed by being decrypted,
    180  * decompressed, etc. before it's dissected, we can't process it in place,
    181  * we have to allocate a new buffer for the processed data.
    182  *
    183  * We keep a stack of those buffers; when we allocate a new buffer, we
    184  * push the current one onto a stack, and when we're done with the new
    185  * buffer, we free the current buffer and pop the previous one off the
    186  * stack.
    187  *
    188  * A buffer has a beginning and end pointer, and a link to the previous
    189  * buffer on the stack.
    190  *
    191  * In other cases, we temporarily adjust the snapshot end to reflect a
    192  * packet-length field in the packet data and, when finished dissecting
    193  * that part of the packet, restore the old snapshot end.  We keep that
    194  * on the stack with null buffer pointer, meaning there's nothing to
    195  * free.
    196  */
    197 struct netdissect_saved_packet_info {
    198   u_char *ndspi_buffer;					/* pointer to allocated buffer data */
    199   const u_char *ndspi_packetp;				/* saved beginning of data */
    200   const u_char *ndspi_snapend;				/* saved end of data */
    201   struct netdissect_saved_packet_info *ndspi_prev;	/* previous buffer on the stack */
    202 };
    203 
    204 /* 'val' value(s) for longjmp */
    205 #define ND_TRUNCATED 1
    206 
    207 struct netdissect_options {
    208   int ndo_bflag;		/* print 4 byte ASes in ASDOT notation */
    209   int ndo_eflag;		/* print ethernet header */
    210   int ndo_fflag;		/* don't translate "foreign" IP address */
    211   int ndo_gflag;		/* don't split IP output into two lines in verbose mode */
    212   int ndo_Kflag;		/* don't check IP, TCP or UDP checksums */
    213   int ndo_nflag;		/* leave addresses as numbers */
    214   int ndo_Nflag;		/* remove domains from printed host names */
    215   int ndo_qflag;		/* quick (shorter) output */
    216   int ndo_Sflag;		/* print raw TCP sequence numbers */
    217   int ndo_tflag;		/* print packet arrival time */
    218   int ndo_uflag;		/* Print undecoded NFS handles */
    219   int ndo_vflag;		/* verbosity level */
    220   int ndo_xflag;		/* print packet in hex */
    221   int ndo_Xflag;		/* print packet in hex/ASCII */
    222   int ndo_Aflag;		/* print packet only in ASCII observing TAB,
    223 				 * LF, CR and SPACE as graphical chars
    224 				 */
    225   int ndo_Hflag;		/* dissect 802.11s draft mesh standard */
    226   const char *ndo_protocol;	/* protocol */
    227   jmp_buf ndo_early_end;	/* jmp_buf for setjmp()/longjmp() */
    228   void *ndo_last_mem_p;		/* pointer to the last allocated memory chunk */
    229   int ndo_packet_number;	/* print a packet number in the beginning of line */
    230   int ndo_suppress_default_print; /* don't use default_print() for unknown packet types */
    231   int ndo_tstamp_precision;	/* requested time stamp precision */
    232   const char *program_name;	/* Name of the program using the library */
    233 
    234   char *ndo_espsecret;
    235   struct sa_list *ndo_sa_list_head;  /* used by print-esp.c */
    236   struct sa_list *ndo_sa_default;
    237 
    238   char *ndo_sigsecret;		/* Signature verification secret key */
    239 
    240   int   ndo_packettype;	/* as specified by -T */
    241 
    242   int   ndo_snaplen;
    243   int   ndo_ll_hdr_len;	/* link-layer header length */
    244 
    245   /*global pointers to beginning and end of current packet (during printing) */
    246   const u_char *ndo_packetp;
    247   const u_char *ndo_snapend;
    248 
    249   /* stack of saved packet boundary and buffer information */
    250   struct netdissect_saved_packet_info *ndo_packet_info_stack;
    251 
    252   /* pointer to the if_printer function */
    253   if_printer ndo_if_printer;
    254 
    255   /* pointer to void function to output stuff */
    256   void (*ndo_default_print)(netdissect_options *,
    257 			    const u_char *bp, u_int length);
    258 
    259   /* pointer to function to do regular output */
    260   int  (*ndo_printf)(netdissect_options *,
    261 		     const char *fmt, ...)
    262 		     PRINTFLIKE_FUNCPTR(2, 3);
    263   /* pointer to function to output errors */
    264   void NORETURN_FUNCPTR (*ndo_error)(netdissect_options *,
    265 				     status_exit_codes_t status,
    266 				     const char *fmt, ...)
    267 				     PRINTFLIKE_FUNCPTR(3, 4);
    268   /* pointer to function to output warnings */
    269   void (*ndo_warning)(netdissect_options *,
    270 		      const char *fmt, ...)
    271 		      PRINTFLIKE_FUNCPTR(2, 3);
    272 };
    273 
    274 extern WARN_UNUSED_RESULT int nd_push_buffer(netdissect_options *, u_char *, const u_char *, const u_int);
    275 extern WARN_UNUSED_RESULT int nd_push_snaplen(netdissect_options *, const u_char *, const u_int);
    276 extern void nd_change_snaplen(netdissect_options *, const u_char *, const u_int);
    277 extern void nd_pop_packet_info(netdissect_options *);
    278 extern void nd_pop_all_packet_info(netdissect_options *);
    279 
    280 /*
    281  * Report a packet truncation with a longjmp().
    282  */
    283 NORETURN void nd_trunc_longjmp(netdissect_options *ndo);
    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) \
    379 do { \
    380 if (!ND_TTEST_LEN(p, l)) nd_trunc_longjmp(ndo); \
    381 } while (0)
    382 #else
    383 #define ND_TCHECK_LEN(p, l) \
    384 do { \
    385 if (!ND_TTEST_LEN(p, l)) goto trunc; \
    386 } while (0)
    387 #endif
    388 
    389 /* Bail out if "*(p)" was not captured */
    390 #define ND_TCHECK_SIZE(p) ND_TCHECK_LEN(p, sizeof(*(p)))
    391 
    392 /*
    393  * Number of bytes between two pointers.
    394  */
    395 #define ND_BYTES_BETWEEN(p1, p2) ((const u_char *)(p1) >= (const u_char *)(p2) ? 0 : ((u_int)(((const u_char *)(p2)) - (const u_char *)(p1))))
    396 
    397 /*
    398  * Number of bytes remaining in the captured data, starting at the
    399  * byte pointed to by the argument.
    400  */
    401 #define ND_BYTES_AVAILABLE_AFTER(p) ((const u_char *)(p) < ndo->ndo_packetp ? 0 : ND_BYTES_BETWEEN((p), ndo->ndo_snapend))
    402 
    403 /*
    404  * Check (expression_1 operator expression_2) for invalid packet with
    405  * a custom message, format %u
    406  */
    407 #define ND_ICHECKMSG_U(message, expression_1, operator, expression_2) \
    408 do { \
    409 if ((expression_1) operator (expression_2)) { \
    410 ND_PRINT(" [%s %u %s %u]", (message), (expression_1), (#operator), (expression_2)); \
    411 goto invalid; \
    412 } \
    413 } while (0)
    414 
    415 /*
    416  * Check (expression_1 operator expression_2) for invalid packet with
    417  * "expression_1" message, format %u
    418  */
    419 #define ND_ICHECK_U(expression_1, operator, expression_2) \
    420 ND_ICHECKMSG_U((#expression_1), (expression_1), operator, (expression_2))
    421 
    422 /*
    423  * Check (expression_1 operator expression_2) for invalid packet with
    424  * a custom message, format %zu
    425  */
    426 #define ND_ICHECKMSG_ZU(message, expression_1, operator, expression_2) \
    427 do { \
    428 if ((expression_1) operator (expression_2)) { \
    429 ND_PRINT(" [%s %u %s %zu]", (message), (expression_1), (#operator), (expression_2)); \
    430 goto invalid; \
    431 } \
    432 } while (0)
    433 
    434 /*
    435  * Check (expression_1 operator expression_2) for invalid packet with
    436  * "expression_1" message, format %zu
    437  */
    438 #define ND_ICHECK_ZU(expression_1, operator, expression_2) \
    439 ND_ICHECKMSG_ZU((#expression_1), (expression_1), operator, (expression_2))
    440 
    441 #define ND_PRINT(...) (ndo->ndo_printf)(ndo, __VA_ARGS__)
    442 #define ND_DEFAULTPRINT(ap, length) (*ndo->ndo_default_print)(ndo, ap, length)
    443 
    444 extern void ts_print(netdissect_options *, const struct timeval *);
    445 extern void signed_relts_print(netdissect_options *, int32_t);
    446 extern void unsigned_relts_print(netdissect_options *, uint32_t);
    447 
    448 extern const char *nd_format_time(char *buf, size_t bufsize,
    449     const char *format, const struct tm *timeptr);
    450 
    451 extern void fn_print_char(netdissect_options *, u_char);
    452 extern void fn_print_str(netdissect_options *, const u_char *);
    453 extern u_int nd_printztn(netdissect_options *, const u_char *, u_int, const u_char *);
    454 extern int nd_printn(netdissect_options *, const u_char *, u_int, const u_char *);
    455 extern void nd_printjn(netdissect_options *, const u_char *, u_int);
    456 extern void nd_printjnp(netdissect_options *, const u_char *, u_int);
    457 
    458 /*
    459  * Flags for txtproto_print().
    460  */
    461 #define RESP_CODE_SECOND_TOKEN	0x00000001	/* response code is second token in response line */
    462 
    463 extern void txtproto_print(netdissect_options *, const u_char *, u_int,
    464 			   const char **, u_int);
    465 
    466 #if (defined(__i386__) || defined(_M_IX86) || defined(__X86__) || defined(__x86_64__) || defined(_M_X64)) || \
    467     (defined(__arm__) || defined(_M_ARM) || defined(__aarch64__)) || \
    468     (defined(__m68k__) && (!defined(__mc68000__) && !defined(__mc68010__))) || \
    469     (defined(__ppc__) || defined(__ppc64__) || defined(_M_PPC) || defined(_ARCH_PPC) || defined(_ARCH_PPC64)) || \
    470     (defined(__s390__) || defined(__s390x__) || defined(__zarch__)) || \
    471     defined(__vax__)
    472 /*
    473  * The processor natively handles unaligned loads, so just use memcpy()
    474  * and memcmp(), to enable those optimizations.
    475  *
    476  * XXX - are those all the x86 tests we need?
    477  * XXX - do we need to worry about ARMv1 through ARMv5, which didn't
    478  * support unaligned loads, and, if so, do we need to worry about all
    479  * of them, or just some of them, e.g. ARMv5?
    480  * XXX - are those the only 68k tests we need not to generated
    481  * unaligned accesses if the target is the 68000 or 68010?
    482  * XXX - are there any tests we don't need, because some definitions are for
    483  * compilers that also predefine the GCC symbols?
    484  * XXX - do we need to test for both 32-bit and 64-bit versions of those
    485  * architectures in all cases?
    486  */
    487 #define UNALIGNED_MEMCPY(p, q, l)	memcpy((p), (q), (l))
    488 #define UNALIGNED_MEMCMP(p, q, l)	memcmp((p), (q), (l))
    489 #else
    490 /*
    491  * The processor doesn't natively handle unaligned loads,
    492  * and the compiler might "helpfully" optimize memcpy()
    493  * and memcmp(), when handed pointers that would normally
    494  * be properly aligned, into sequences that assume proper
    495  * alignment.
    496  *
    497  * Do copies and compares of possibly-unaligned data by
    498  * calling routines that wrap memcpy() and memcmp(), to
    499  * prevent that optimization.
    500  */
    501 extern void unaligned_memcpy(void *, const void *, size_t);
    502 extern int unaligned_memcmp(const void *, const void *, size_t);
    503 #define UNALIGNED_MEMCPY(p, q, l)	unaligned_memcpy((p), (q), (l))
    504 #define UNALIGNED_MEMCMP(p, q, l)	unaligned_memcmp((p), (q), (l))
    505 #endif
    506 
    507 #define PLURAL_SUFFIX(n) \
    508 	(((n) != 1) ? "s" : "")
    509 
    510 extern const char *tok2strary_internal(const char **, int, const char *, int);
    511 #define	tok2strary(a,f,i) tok2strary_internal(a, sizeof(a)/sizeof(a[0]),f,i)
    512 
    513 struct uint_tokary
    514 {
    515 	u_int uintval;
    516 	const struct tok *tokary;
    517 };
    518 
    519 extern const struct tok *uint2tokary_internal(const struct uint_tokary[], const size_t, const u_int);
    520 #define uint2tokary(a, i) uint2tokary_internal(a, sizeof(a)/sizeof(a[0]), i)
    521 
    522 extern if_printer lookup_printer(int);
    523 
    524 #define ND_DEBUG {printf(" [%s:%d %s] ", __FILE__, __LINE__, __func__); fflush(stdout);}
    525 
    526 /* The DLT printer routines */
    527 
    528 extern void ap1394_if_print IF_PRINTER_ARGS;
    529 extern void arcnet_if_print IF_PRINTER_ARGS;
    530 extern void arcnet_linux_if_print IF_PRINTER_ARGS;
    531 extern void atm_if_print IF_PRINTER_ARGS;
    532 extern void brcm_tag_if_print IF_PRINTER_ARGS;
    533 extern void brcm_tag_prepend_if_print IF_PRINTER_ARGS;
    534 extern void bt_if_print IF_PRINTER_ARGS;
    535 extern void chdlc_if_print IF_PRINTER_ARGS;
    536 extern void cip_if_print IF_PRINTER_ARGS;
    537 extern void dsa_if_print IF_PRINTER_ARGS;
    538 extern void edsa_if_print IF_PRINTER_ARGS;
    539 extern void enc_if_print IF_PRINTER_ARGS;
    540 extern void ether_if_print IF_PRINTER_ARGS;
    541 extern void fddi_if_print IF_PRINTER_ARGS;
    542 extern void fr_if_print IF_PRINTER_ARGS;
    543 extern void ieee802_11_if_print IF_PRINTER_ARGS;
    544 extern void ieee802_11_radio_avs_if_print IF_PRINTER_ARGS;
    545 extern void ieee802_11_radio_if_print IF_PRINTER_ARGS;
    546 extern void ieee802_15_4_if_print IF_PRINTER_ARGS;
    547 extern void ieee802_15_4_tap_if_print IF_PRINTER_ARGS;
    548 extern void ipfc_if_print IF_PRINTER_ARGS;
    549 extern void ipnet_if_print IF_PRINTER_ARGS;
    550 extern void ipoib_if_print IF_PRINTER_ARGS;
    551 extern void juniper_atm1_if_print IF_PRINTER_ARGS;
    552 extern void juniper_atm2_if_print IF_PRINTER_ARGS;
    553 extern void juniper_chdlc_if_print IF_PRINTER_ARGS;
    554 extern void juniper_es_if_print IF_PRINTER_ARGS;
    555 extern void juniper_ether_if_print IF_PRINTER_ARGS;
    556 extern void juniper_frelay_if_print IF_PRINTER_ARGS;
    557 extern void juniper_ggsn_if_print IF_PRINTER_ARGS;
    558 extern void juniper_mfr_if_print IF_PRINTER_ARGS;
    559 extern void juniper_mlfr_if_print IF_PRINTER_ARGS;
    560 extern void juniper_mlppp_if_print IF_PRINTER_ARGS;
    561 extern void juniper_monitor_if_print IF_PRINTER_ARGS;
    562 extern void juniper_ppp_if_print IF_PRINTER_ARGS;
    563 extern void juniper_pppoe_atm_if_print IF_PRINTER_ARGS;
    564 extern void juniper_pppoe_if_print IF_PRINTER_ARGS;
    565 extern void juniper_services_if_print IF_PRINTER_ARGS;
    566 extern void ltalk_if_print IF_PRINTER_ARGS;
    567 extern void mfr_if_print IF_PRINTER_ARGS;
    568 extern void netanalyzer_if_print IF_PRINTER_ARGS;
    569 extern void netanalyzer_transparent_if_print IF_PRINTER_ARGS;
    570 extern void nflog_if_print IF_PRINTER_ARGS;
    571 extern void null_if_print IF_PRINTER_ARGS;
    572 extern void pflog_if_print IF_PRINTER_ARGS;
    573 extern void pktap_if_print IF_PRINTER_ARGS;
    574 extern void ppi_if_print IF_PRINTER_ARGS;
    575 extern void ppp_bsdos_if_print IF_PRINTER_ARGS;
    576 extern void ppp_hdlc_if_print IF_PRINTER_ARGS;
    577 extern void ppp_if_print IF_PRINTER_ARGS;
    578 extern void pppoe_if_print IF_PRINTER_ARGS;
    579 extern void prism_if_print IF_PRINTER_ARGS;
    580 extern void raw_if_print IF_PRINTER_ARGS;
    581 extern void sl_bsdos_if_print IF_PRINTER_ARGS;
    582 extern void sl_if_print IF_PRINTER_ARGS;
    583 extern void sll2_if_print IF_PRINTER_ARGS;
    584 extern void sll_if_print IF_PRINTER_ARGS;
    585 extern void sunatm_if_print IF_PRINTER_ARGS;
    586 extern void symantec_if_print IF_PRINTER_ARGS;
    587 extern void token_if_print IF_PRINTER_ARGS;
    588 extern void unsupported_if_print IF_PRINTER_ARGS;
    589 extern void usb_linux_48_byte_if_print IF_PRINTER_ARGS;
    590 extern void usb_linux_64_byte_if_print IF_PRINTER_ARGS;
    591 extern void vsock_if_print IF_PRINTER_ARGS;
    592 
    593 /*
    594  * Structure passed to some printers to allow them to print
    595  * link-layer address information if ndo_eflag isn't set
    596  * (because they are for protocols that don't have their
    597  * own addresses, so that we'd want to report link-layer
    598  * address information).
    599  *
    600  * This contains a pointer to an address and a pointer to a routine
    601  * to which we pass that pointer in order to get a string.
    602  */
    603 struct lladdr_info {
    604 	const char *(*addr_string)(netdissect_options *, const u_char *);
    605 	const u_char *addr;
    606 };
    607 
    608 /* The printer routines. */
    609 
    610 extern void aarp_print(netdissect_options *, const u_char *, u_int);
    611 extern int ah_print(netdissect_options *, const u_char *);
    612 extern void ahcp_print(netdissect_options *, const u_char *, u_int);
    613 extern void aodv_print(netdissect_options *, const u_char *, u_int, int);
    614 extern void aoe_print(netdissect_options *, const u_char *, const u_int);
    615 extern int  arista_ethertype_print(netdissect_options *,const u_char *, u_int);
    616 extern void arp_print(netdissect_options *, const u_char *, u_int, u_int);
    617 extern void ascii_print(netdissect_options *, const u_char *, u_int);
    618 extern void atalk_print(netdissect_options *, const u_char *, u_int);
    619 extern void atm_print(netdissect_options *, u_int, u_int, u_int, const u_char *, u_int, u_int);
    620 extern void babel_print(netdissect_options *, const u_char *, u_int);
    621 extern void bcm_li_print(netdissect_options *, const u_char *, u_int);
    622 extern void beep_print(netdissect_options *, const u_char *, u_int);
    623 extern void bfd_print(netdissect_options *, const u_char *, u_int, u_int);
    624 extern void bgp_print(netdissect_options *, const u_char *, u_int);
    625 extern const char *bgp_vpn_rd_print(netdissect_options *, const u_char *);
    626 extern void bootp_print(netdissect_options *, const u_char *, u_int);
    627 extern void calm_fast_print(netdissect_options *, const u_char *, u_int, const struct lladdr_info *);
    628 extern void carp_print(netdissect_options *, const u_char *, u_int, u_int);
    629 extern void cdp_print(netdissect_options *, const u_char *, u_int);
    630 extern void cfm_print(netdissect_options *, const u_char *, u_int);
    631 extern u_int chdlc_print(netdissect_options *, const u_char *, u_int);
    632 extern void cisco_autorp_print(netdissect_options *, const u_char *, u_int);
    633 extern void cnfp_print(netdissect_options *, const u_char *);
    634 extern void dccp_print(netdissect_options *, const u_char *, const u_char *, u_int);
    635 extern void decnet_print(netdissect_options *, const u_char *, u_int, u_int);
    636 extern void dhcp6_print(netdissect_options *, const u_char *, u_int);
    637 extern int dstopt_process(netdissect_options *, const u_char *);
    638 extern void dtp_print(netdissect_options *, const u_char *, u_int);
    639 extern void dvmrp_print(netdissect_options *, const u_char *, u_int);
    640 extern void eap_print(netdissect_options *, const u_char *, u_int);
    641 extern void eapol_print(netdissect_options *, const u_char *);
    642 extern void egp_print(netdissect_options *, const u_char *, u_int);
    643 extern void eigrp_print(netdissect_options *, const u_char *, u_int);
    644 extern void esp_print(netdissect_options *, const u_char *, u_int, const u_char *, u_int, int, u_int);
    645 extern u_int ether_print(netdissect_options *, const u_char *, u_int, u_int, void (*)(netdissect_options *, const u_char *), const u_char *);
    646 extern u_int ether_switch_tag_print(netdissect_options *, const u_char *, u_int, u_int, void (*)(netdissect_options *, const u_char *), u_int);
    647 extern int ethertype_print(netdissect_options *, u_short, const u_char *, u_int, u_int, const struct lladdr_info *, const struct lladdr_info *);
    648 extern u_int fddi_print(netdissect_options *, const u_char *, u_int, u_int);
    649 extern void forces_print(netdissect_options *, const u_char *, u_int);
    650 extern u_int fr_print(netdissect_options *, const u_char *, u_int);
    651 extern int frag6_print(netdissect_options *, const u_char *, const u_char *);
    652 extern void ftp_print(netdissect_options *, const u_char *, u_int);
    653 extern void geneve_print(netdissect_options *, const u_char *, u_int);
    654 extern void geonet_print(netdissect_options *, const u_char *, u_int, const struct lladdr_info *);
    655 extern void gre_print(netdissect_options *, const u_char *, u_int);
    656 extern int hbhopt_process(netdissect_options *, const u_char *, int *, uint32_t *);
    657 extern void hex_and_ascii_print(netdissect_options *, const char *, const u_char *, u_int);
    658 extern void hex_print(netdissect_options *, const char *indent, const u_char *cp, u_int);
    659 extern void hex_print_with_offset(netdissect_options *, const char *indent, const u_char *cp, u_int, u_int);
    660 extern void hncp_print(netdissect_options *, const u_char *, u_int);
    661 extern void hsrp_print(netdissect_options *, const u_char *, u_int);
    662 extern void http_print(netdissect_options *, const u_char *, u_int);
    663 extern void icmp6_print(netdissect_options *, const u_char *, u_int, const u_char *, int);
    664 extern void icmp_print(netdissect_options *, const u_char *, u_int, const u_char *, int);
    665 extern u_int ieee802_15_4_print(netdissect_options *, const u_char *, u_int);
    666 extern u_int ieee802_11_radio_print(netdissect_options *, const u_char *, u_int, u_int);
    667 extern void igmp_print(netdissect_options *, const u_char *, u_int);
    668 extern void igrp_print(netdissect_options *, const u_char *, u_int);
    669 extern void ip6_print(netdissect_options *, const u_char *, u_int);
    670 extern void ipN_print(netdissect_options *, const u_char *, u_int);
    671 extern void ip_print(netdissect_options *, const u_char *, const u_int);
    672 extern void ipcomp_print(netdissect_options *, const u_char *);
    673 extern void ipx_netbios_print(netdissect_options *, const u_char *, u_int);
    674 extern void ipx_print(netdissect_options *, const u_char *, u_int);
    675 extern void isakmp_print(netdissect_options *, const u_char *, u_int, const u_char *);
    676 extern void isakmp_rfc3948_print(netdissect_options *, const u_char *, u_int, const u_char *, int, int, u_int);
    677 extern void isoclns_print(netdissect_options *, const u_char *, u_int);
    678 extern void krb_print(netdissect_options *, const u_char *);
    679 extern void l2tp_print(netdissect_options *, const u_char *, u_int);
    680 extern void lane_print(netdissect_options *, const u_char *, u_int, u_int);
    681 extern void ldp_print(netdissect_options *, const u_char *, u_int);
    682 extern void lisp_print(netdissect_options *, const u_char *, u_int);
    683 extern u_int llap_print(netdissect_options *, const u_char *, u_int);
    684 extern int llc_print(netdissect_options *, const u_char *, u_int, u_int, const struct lladdr_info *, const struct lladdr_info *);
    685 extern void lldp_print(netdissect_options *, const u_char *, u_int);
    686 extern void lmp_print(netdissect_options *, const u_char *, u_int);
    687 extern void loopback_print(netdissect_options *, const u_char *, u_int);
    688 extern void lspping_print(netdissect_options *, const u_char *, u_int);
    689 extern void lwapp_control_print(netdissect_options *, const u_char *, u_int, int);
    690 extern void lwapp_data_print(netdissect_options *, const u_char *, u_int);
    691 extern void lwres_print(netdissect_options *, const u_char *, u_int);
    692 extern void m3ua_print(netdissect_options *, const u_char *, const u_int);
    693 extern int macsec_print(netdissect_options *, const u_char **,
    694 			 u_int *, u_int *, u_int *, const struct lladdr_info *,
    695 			 const struct lladdr_info *);
    696 extern u_int mfr_print(netdissect_options *, const u_char *, u_int);
    697 extern void mobile_print(netdissect_options *, const u_char *, u_int);
    698 extern int mobility_print(netdissect_options *, const u_char *, const u_char *);
    699 extern void mpcp_print(netdissect_options *, const u_char *, u_int);
    700 extern void mpls_print(netdissect_options *, const u_char *, u_int);
    701 extern int mptcp_print(netdissect_options *, const u_char *, u_int, u_char);
    702 extern void msdp_print(netdissect_options *, const u_char *, u_int);
    703 extern void msnlb_print(netdissect_options *, const u_char *);
    704 extern void nbt_tcp_print(netdissect_options *, const u_char *, u_int);
    705 extern void nbt_udp137_print(netdissect_options *, const u_char *, u_int);
    706 extern void nbt_udp138_print(netdissect_options *, const u_char *, u_int);
    707 extern void netbeui_print(netdissect_options *, u_short, const u_char *, u_int);
    708 extern void nfsreply_print(netdissect_options *, const u_char *, u_int, const u_char *);
    709 extern void nfsreply_noaddr_print(netdissect_options *, const u_char *, u_int, const u_char *);
    710 extern void nfsreq_noaddr_print(netdissect_options *, const u_char *, u_int, const u_char *);
    711 extern const u_char *fqdn_print(netdissect_options *, const u_char *, const u_char *);
    712 extern void domain_print(netdissect_options *, const u_char *, u_int, int, int);
    713 extern void nsh_print(netdissect_options *, const u_char *, u_int);
    714 extern void ntp_print(netdissect_options *, const u_char *, u_int);
    715 extern void oam_print(netdissect_options *, const u_char *, u_int, u_int);
    716 extern void olsr_print(netdissect_options *, const u_char *, u_int, int);
    717 extern void openflow_print(netdissect_options *, const u_char *, u_int);
    718 extern void ospf6_print(netdissect_options *, const u_char *, u_int);
    719 extern void ospf_print(netdissect_options *, const u_char *, u_int, const u_char *);
    720 extern int ospf_grace_lsa_print(netdissect_options *, const u_char *, u_int);
    721 extern int ospf_te_lsa_print(netdissect_options *, const u_char *, u_int);
    722 extern void pgm_print(netdissect_options *, const u_char *, u_int, const u_char *);
    723 extern void pim_print(netdissect_options *, const u_char *, u_int, const u_char *);
    724 extern void pimv1_print(netdissect_options *, const u_char *, u_int);
    725 extern u_int ppp_print(netdissect_options *, const u_char *, u_int);
    726 extern u_int pppoe_print(netdissect_options *, const u_char *, u_int);
    727 extern void pptp_print(netdissect_options *, const u_char *);
    728 extern void ptp_print(netdissect_options *, const u_char *, u_int);
    729 extern int print_unknown_data(netdissect_options *, const u_char *, const char *, u_int);
    730 extern const char *q922_string(netdissect_options *, const u_char *, u_int);
    731 extern void q933_print(netdissect_options *, const u_char *, u_int);
    732 extern void radius_print(netdissect_options *, const u_char *, u_int);
    733 extern void resp_print(netdissect_options *, const u_char *, u_int);
    734 extern void rip_print(netdissect_options *, const u_char *, u_int);
    735 extern void ripng_print(netdissect_options *, const u_char *, unsigned int);
    736 extern void rpki_rtr_print(netdissect_options *, const u_char *, u_int);
    737 extern void rsvp_print(netdissect_options *, const u_char *, u_int);
    738 extern int rt6_print(netdissect_options *, const u_char *, const u_char *);
    739 extern void rtl_print(netdissect_options *, const u_char *, u_int, const struct lladdr_info *, const struct lladdr_info *);
    740 extern void rtsp_print(netdissect_options *, const u_char *, u_int);
    741 extern void rx_print(netdissect_options *, const u_char *, u_int, uint16_t, uint16_t, const u_char *);
    742 extern void sctp_print(netdissect_options *, const u_char *, const u_char *, u_int);
    743 extern void sflow_print(netdissect_options *, const u_char *, u_int);
    744 extern void ssh_print(netdissect_options *, const u_char *, u_int);
    745 extern void sip_print(netdissect_options *, const u_char *, u_int);
    746 extern void slow_print(netdissect_options *, const u_char *, u_int);
    747 extern void smb_tcp_print(netdissect_options *, const u_char *, u_int);
    748 extern void smtp_print(netdissect_options *, const u_char *, u_int);
    749 extern int snap_print(netdissect_options *, const u_char *, u_int, u_int, const struct lladdr_info *, const struct lladdr_info *, u_int);
    750 extern void snmp_print(netdissect_options *, const u_char *, u_int);
    751 extern void stp_print(netdissect_options *, const u_char *, u_int);
    752 extern void sunrpc_print(netdissect_options *, const u_char *, u_int, const u_char *);
    753 extern void syslog_print(netdissect_options *, const u_char *, u_int);
    754 extern void tcp_print(netdissect_options *, const u_char *, u_int, const u_char *, int);
    755 extern void telnet_print(netdissect_options *, const u_char *, u_int);
    756 extern void tftp_print(netdissect_options *, const u_char *, u_int);
    757 extern void timed_print(netdissect_options *, const u_char *);
    758 extern void tipc_print(netdissect_options *, const u_char *, u_int, u_int);
    759 extern u_int token_print(netdissect_options *, const u_char *, u_int, u_int);
    760 extern void udld_print(netdissect_options *, const u_char *, u_int);
    761 extern void udp_print(netdissect_options *, const u_char *, u_int, const u_char *, int, u_int);
    762 extern int vjc_print(netdissect_options *, const u_char *, u_short);
    763 extern void vqp_print(netdissect_options *, const u_char *, u_int);
    764 extern void vrrp_print(netdissect_options *, const u_char *, u_int, const u_char *, int, int);
    765 extern void vtp_print(netdissect_options *, const u_char *, const u_int);
    766 extern void vxlan_gpe_print(netdissect_options *, const u_char *, u_int);
    767 extern void vxlan_print(netdissect_options *, const u_char *, u_int);
    768 extern void wb_print(netdissect_options *, const u_char *, u_int);
    769 extern void whois_print(netdissect_options *, const u_char *, u_int);
    770 extern void zep_print(netdissect_options *, const u_char *, u_int);
    771 extern void zephyr_print(netdissect_options *, const u_char *, u_int);
    772 extern void zmtp1_print(netdissect_options *, const u_char *, u_int);
    773 extern void zmtp1_datagram_print(netdissect_options *, const u_char *, const u_int);
    774 extern void someip_print(netdissect_options *, const u_char *, const u_int);
    775 
    776 /* checksum routines */
    777 extern uint16_t verify_crc10_cksum(uint16_t, const u_char *, int);
    778 extern uint16_t create_osi_cksum(const uint8_t *, int, int);
    779 
    780 struct cksum_vec {
    781 	const uint8_t	*ptr;
    782 	int		len;
    783 };
    784 extern uint16_t in_cksum(const struct cksum_vec *, int);
    785 extern uint16_t in_cksum_shouldbe(uint16_t, uint16_t);
    786 
    787 /* IP protocol demuxing routines */
    788 extern void ip_demux_print(netdissect_options *, const u_char *, u_int, u_int, int, u_int, uint8_t, const u_char *);
    789 
    790 extern uint16_t nextproto4_cksum(netdissect_options *, const struct ip *, const uint8_t *, u_int, u_int, uint8_t);
    791 
    792 /* in print-ip6.c */
    793 extern uint16_t nextproto6_cksum(netdissect_options *, const struct ip6_hdr *, const uint8_t *, u_int, u_int, uint8_t);
    794 
    795 /* Utilities */
    796 extern void nd_print_trunc(netdissect_options *);
    797 extern void nd_print_protocol(netdissect_options *);
    798 extern void nd_print_protocol_caps(netdissect_options *);
    799 extern void nd_print_invalid(netdissect_options *);
    800 
    801 extern int mask2plen(uint32_t);
    802 extern int mask62plen(const u_char *);
    803 
    804 extern const char *dnnum_string(netdissect_options *, u_short);
    805 
    806 extern int decode_prefix4(netdissect_options *, const u_char *, u_int, char *, size_t);
    807 extern int decode_prefix6(netdissect_options *, const u_char *, u_int, char *, size_t);
    808 
    809 extern void esp_decodesecret_print(netdissect_options *);
    810 extern int esp_decrypt_buffer_by_ikev2_print(netdissect_options *, int,
    811 					     const u_char spii[8],
    812 					     const u_char spir[8],
    813 					     const u_char *, const u_char *);
    814 
    815 extern void pfsync_if_print IF_PRINTER_ARGS;
    816 extern void pfsync_ip_print(netdissect_options *, const u_char *, u_int, const u_char * __unused);
    817 
    818 #endif  /* netdissect_h */
    819