X-Git-Url: https://git.tcpdump.org/tcpdump/blobdiff_plain/a08e63fd7a8f5bfeb6b6f47adf580cd7f9af3dec..a8abce5c5e2dce2ba6dbccd5d3829da104b80f9c:/netdissect.h diff --git a/netdissect.h b/netdissect.h index 212ee15b..93fa8be6 100644 --- a/netdissect.h +++ b/netdissect.h @@ -29,10 +29,7 @@ #include "os-proto.h" #endif #include - -#ifndef HAVE___ATTRIBUTE__ -#define __attribute__(x) -#endif +#include "status-exit-codes.h" /* * Data types corresponding to multi-byte integral values within data @@ -56,36 +53,45 @@ typedef unsigned char nd_uint64_t[8]; typedef signed char nd_int8_t[1]; +/* + * "unsigned char" so that sign extension isn't done on the + * individual bytes while they're being assembled. + */ +typedef unsigned char nd_int32_t[4]; +typedef unsigned char nd_int64_t[8]; + /* * Use this for IPv4 addresses and netmasks. * * It's defined as an array of octets, so that it's not guaranteed to * be aligned on its "natural" boundary (in some packet formats, it - * *isn't* so aligned), and it's defined as a structure in the hopes - * that this makes it harder to naively use EXTRACT_BE_U_4() to extract - * the value - in many cases you just want to use UNALIGNED_MEMCPY() to - * copy its value, so that it remains in network byte order. + * *isn't* so aligned). We have separate EXTRACT_ calls for them; + * sometimes you want the host-byte-order value, other times you want + * the network-byte-order value. + * + * Don't use EXTRACT_BE_U_4() on them, use EXTRACT_IPV4_TO_HOST_ORDER() + * if you want them in host byte order and EXTRACT_IPV4_TO_NETWORK_ORDER() + * if you want them in network byte order (which you want with system APIs + * that expect network-order IPv4 addresses, such as inet_ntop()). * - * (Among other things, we don't want somebody thinking "IPv4 addresses, - * they're in network byte order, so we want EXTRACT_BE_U_4(), right?" - * and then handing the result to system APIs that expect network-order - * IPv4 addresses, such as inet_ntop(), on their little-endian PCs, getting - * the wrong behavior, and concluding "oh, it must be in *little*-endian - * order" and "fixing" it to use EXTRACT_LE_U_4(). Yes, people do this; - * that's why Wireshark has tvb_get_ipv4(), to extract an IPv4 address from - * a packet data buffer; it was introduced in reaction to somebody who - * *had* done that.) + * If, on your little-endian machine (e.g., an "IBM-compatible PC", no matter + * what the OS, or an Intel Mac, no matter what the OS), you get the wrong + * answer, and you've used EXTRACT_BE_U_4(), do *N*O*T* "fix" this by using + * EXTRACT_LE_U_4(), fix it by using EXTRACT_IPV4_TO_NETWORK_ORDER(), + * otherwise you're breaking the result on big-endian machines (e.g., + * most PowerPC/Power ISA machines, System/390 and z/Architecture, SPARC, + * etc.). + * + * Yes, people do this; that's why Wireshark has tvb_get_ipv4(), to extract + * an IPv4 address from a packet data buffer; it was introduced in reaction + * to somebody who *had* done that. */ -typedef struct { - unsigned char bytes[4]; -} nd_ipv4; +typedef unsigned char nd_ipv4[4]; /* * Use this for IPv6 addresses and netmasks. */ -typedef struct { - unsigned char bytes[16]; -} nd_ipv6; +typedef unsigned char nd_ipv6[16]; /* * Use this for MAC addresses. @@ -98,7 +104,14 @@ typedef unsigned char nd_mac_addr[MAC_ADDR_LEN]; */ typedef unsigned char nd_byte; -/* snprintf et al */ +/* + * Round up x to a multiple of y; y must be a power of 2. + */ +#ifndef roundup2 +#define roundup2(x, y) (((x)+((y)-1))&(~((y)-1))) +#endif + +/* nd_snprintf et al */ #include #include @@ -110,16 +123,6 @@ extern int32_t thiszone; /* seconds offset from gmt to local time */ /* invalid string to print '(invalid)' for malformed or corrupted packets */ extern const char istr[]; -#if !defined(HAVE_SNPRINTF) -int snprintf (char *str, size_t sz, FORMAT_STRING(const char *format), ...) - PRINTFLIKE(3, 4); -#endif /* !defined(HAVE_SNPRINTF) */ - -#if !defined(HAVE_VSNPRINTF) -int vsnprintf (char *str, size_t sz, FORMAT_STRING(const char *format), - va_list ap) PRINTFLIKE(3, 0); -#endif /* !defined(HAVE_VSNPRINTF) */ - #ifndef HAVE_STRLCAT extern size_t strlcat (char *, const char *, size_t); #endif @@ -186,6 +189,8 @@ struct netdissect_options { * LF, CR and SPACE as graphical chars */ int ndo_Hflag; /* dissect 802.11s draft mesh standard */ + const char *ndo_protocol; /* protocol */ + void *ndo_last_mem_p; /* pointer to the last allocated memory chunk */ int ndo_packet_number; /* print a packet number in the beginning of line */ int ndo_suppress_default_print; /* don't use default_print() for unknown packet types */ int ndo_tstamp_precision; /* requested time stamp precision */ @@ -218,8 +223,9 @@ struct netdissect_options { PRINTFLIKE_FUNCPTR(2, 3); /* pointer to function to output errors */ void NORETURN_FUNCPTR (*ndo_error)(netdissect_options *, + status_exit_codes_t status, const char *fmt, ...) - PRINTFLIKE_FUNCPTR(2, 3); + PRINTFLIKE_FUNCPTR(3, 4); /* pointer to function to output warnings */ void (*ndo_warning)(netdissect_options *, const char *fmt, ...) @@ -283,9 +289,6 @@ struct netdissect_options { */ #define MAXIMUM_SNAPLEN 262144 -#define ESRC(ep) ((ep)->ether_shost) -#define EDST(ep) ((ep)->ether_dhost) - /* * True if "l" bytes of "var" were captured. * @@ -313,28 +316,21 @@ struct netdissect_options { */ #define IS_NOT_NEGATIVE(x) (((x) > 0) || ((x) == 0)) -#define ND_TTEST2(var, l) \ - (IS_NOT_NEGATIVE(l) && \ - ((uintptr_t)ndo->ndo_snapend - (l) <= (uintptr_t)ndo->ndo_snapend && \ - (uintptr_t)&(var) <= (uintptr_t)ndo->ndo_snapend - (l))) - #define ND_TTEST_LEN(p, l) \ (IS_NOT_NEGATIVE(l) && \ ((uintptr_t)ndo->ndo_snapend - (l) <= (uintptr_t)ndo->ndo_snapend && \ (uintptr_t)(p) <= (uintptr_t)ndo->ndo_snapend - (l))) -/* True if "var" was captured */ -#define ND_TTEST(var) ND_TTEST2(var, sizeof(var)) - -/* Bail if "l" bytes of "var" were not captured */ -#define ND_TCHECK2(var, l) if (!ND_TTEST2(var, l)) goto trunc +/* True if "*(p)" was captured */ +#define ND_TTEST_SIZE(p) ND_TTEST_LEN(p, sizeof(*(p))) +/* Bail out if "l" bytes from "p" were not captured */ #define ND_TCHECK_LEN(p, l) if (!ND_TTEST_LEN(p, l)) goto trunc -/* Bail if "var" was not captured */ -#define ND_TCHECK(var) ND_TCHECK2(var, sizeof(var)) +/* Bail out if "*(p)" was not captured */ +#define ND_TCHECK_SIZE(p) ND_TCHECK_LEN(p, sizeof(*(p))) -#define ND_PRINT(STUFF) (ndo->ndo_printf)STUFF +#define ND_PRINT(...) (ndo->ndo_printf)(ndo, __VA_ARGS__) #define ND_DEFAULTPRINT(ap, length) (*ndo->ndo_default_print)(ndo, ap, length) extern void ts_print(netdissect_options *, const struct timeval *); @@ -342,10 +338,11 @@ extern void signed_relts_print(netdissect_options *, int32_t); extern void unsigned_relts_print(netdissect_options *, uint32_t); extern void fn_print_char(netdissect_options *, u_char); -extern int fn_print(netdissect_options *, const u_char *, const u_char *); -extern u_int fn_printztn(netdissect_options *ndo, const u_char *, u_int, const u_char *); -extern int fn_printn(netdissect_options *, const u_char *, u_int, const u_char *); -extern int fn_printzp(netdissect_options *, const u_char *, u_int, const u_char *); +extern void fn_print_str(netdissect_options *, const u_char *); +extern int nd_print(netdissect_options *, const u_char *, const u_char *); +extern u_int nd_printztn(netdissect_options *ndo, const u_char *, u_int, const u_char *); +extern int nd_printn(netdissect_options *, const u_char *, u_int, const u_char *); +extern int nd_printzp(netdissect_options *, const u_char *, u_int, const u_char *); /* * Flags for txtproto_print(). @@ -366,9 +363,6 @@ extern void txtproto_print(netdissect_options *, const u_char *, u_int, #define ND_ISGRAPH(c) ((c) > 0x20 && (c) <= 0x7E) #define ND_TOASCII(c) ((c) & 0x7F) -extern void safeputchar(netdissect_options *, const u_char); -extern void safeputs(netdissect_options *, const u_char *, const u_int); - #if (defined(__i386__) || defined(_M_IX86) || defined(__X86__) || defined(__x86_64__) || defined(_M_X64)) || \ (defined(__arm__) || defined(_M_ARM) || defined(__aarch64__)) || \ (defined(__m68k__) && (!defined(__mc68000__) && !defined(__mc68010__))) || \ @@ -471,6 +465,7 @@ extern u_int raw_if_print IF_PRINTER_ARGS; extern u_int sl_bsdos_if_print IF_PRINTER_ARGS; extern u_int sl_if_print IF_PRINTER_ARGS; extern u_int sll_if_print IF_PRINTER_ARGS; +extern u_int sll2_if_print IF_PRINTER_ARGS; extern u_int sunatm_if_print IF_PRINTER_ARGS; extern u_int symantec_if_print IF_PRINTER_ARGS; extern u_int token_if_print IF_PRINTER_ARGS; @@ -507,10 +502,10 @@ extern void babel_print(netdissect_options *, const u_char *, u_int); extern void beep_print(netdissect_options *, const u_char *, u_int); extern void bfd_print(netdissect_options *, const u_char *, u_int, u_int); extern void bgp_print(netdissect_options *, const u_char *, u_int); -extern char *bgp_vpn_rd_print (netdissect_options *, const u_char *); +extern const char *bgp_vpn_rd_print(netdissect_options *, const u_char *); extern void bootp_print(netdissect_options *, const u_char *, u_int); extern void calm_fast_print(netdissect_options *, const u_char *, u_int, const struct lladdr_info *); -extern void carp_print(netdissect_options *, const u_char *, u_int, int); +extern void carp_print(netdissect_options *, const u_char *, u_int, u_int); extern void cdp_print(netdissect_options *, const u_char *, u_int, u_int); extern void cfm_print(netdissect_options *, const u_char *, u_int); extern u_int chdlc_print(netdissect_options *, const u_char *, u_int); @@ -538,7 +533,6 @@ extern void geonet_print(netdissect_options *, const u_char *, u_int, const stru extern void gre_print(netdissect_options *, const u_char *, u_int); extern int hbhopt_print(netdissect_options *, const u_char *); extern void hex_and_ascii_print(netdissect_options *, const char *, const u_char *, u_int); -extern void hex_and_ascii_print_with_offset(netdissect_options *, const char *, const u_char *, u_int, u_int); extern void hex_print(netdissect_options *, const char *ident, const u_char *cp, u_int); extern void hex_print_with_offset(netdissect_options *, const char *ident, const u_char *cp, u_int, u_int); extern void hncp_print(netdissect_options *, const u_char *, u_int); @@ -551,7 +545,7 @@ extern void igrp_print(netdissect_options *, const u_char *, u_int); extern void ip6_print(netdissect_options *, const u_char *, u_int); extern void ipN_print(netdissect_options *, const u_char *, u_int); extern void ip_print(netdissect_options *, const u_char *, u_int); -extern void ip_print_inner(netdissect_options *, const u_char *, u_int, u_int nh, const u_char *); +extern void ip_inner_print(netdissect_options *, const u_char *, u_int, u_int nh, const u_char *); extern void ipcomp_print(netdissect_options *, const u_char *); extern void ipx_netbios_print(netdissect_options *, const u_char *, u_int); extern void ipx_print(netdissect_options *, const u_char *, u_int); @@ -582,14 +576,14 @@ extern void mpls_print(netdissect_options *, const u_char *, u_int); extern int mptcp_print(netdissect_options *, const u_char *, u_int, u_char); extern void msdp_print(netdissect_options *, const u_char *, u_int); extern void msnlb_print(netdissect_options *, const u_char *); -extern void nbt_tcp_print(netdissect_options *, const u_char *, int); -extern void nbt_udp137_print(netdissect_options *, const u_char *, int); -extern void nbt_udp138_print(netdissect_options *, const u_char *, int); -extern void netbeui_print(netdissect_options *, u_short, const u_char *, int); +extern void nbt_tcp_print(netdissect_options *, const u_char *, u_int); +extern void nbt_udp137_print(netdissect_options *, const u_char *, u_int); +extern void nbt_udp138_print(netdissect_options *, const u_char *, u_int); +extern void netbeui_print(netdissect_options *, u_short, const u_char *, u_int); extern void nfsreply_print(netdissect_options *, const u_char *, u_int, const u_char *); extern void nfsreply_noaddr_print(netdissect_options *, const u_char *, u_int, const u_char *); extern void nfsreq_noaddr_print(netdissect_options *, const u_char *, u_int, const u_char *); -extern const u_char * ns_nprint (netdissect_options *, const u_char *, const u_char *); +extern const u_char * ns_nprint(netdissect_options *, const u_char *, const u_char *); extern void domain_print(netdissect_options *, const u_char *, u_int, int); extern void nsh_print(netdissect_options *ndo, const u_char *bp, u_int len); extern void ntp_print(netdissect_options *, const u_char *, u_int); @@ -598,8 +592,8 @@ extern void olsr_print(netdissect_options *, const u_char *, u_int, int); extern void openflow_print(netdissect_options *, const u_char *, const u_int); extern void ospf6_print(netdissect_options *, const u_char *, u_int); extern void ospf_print(netdissect_options *, const u_char *, u_int, const u_char *); -extern int ospf_print_grace_lsa(netdissect_options *, const uint8_t *, u_int); -extern int ospf_print_te_lsa(netdissect_options *, const uint8_t *, u_int); +extern int ospf_grace_lsa_print(netdissect_options *, const u_char *, u_int); +extern int ospf_te_lsa_print(netdissect_options *, const u_char *, u_int); extern void otv_print(netdissect_options *, const u_char *, u_int); extern void pgm_print(netdissect_options *, const u_char *, u_int, const u_char *); extern void pim_print(netdissect_options *, const u_char *, u_int, const u_char *); @@ -608,7 +602,7 @@ extern u_int ppp_print(netdissect_options *, const u_char *, u_int); extern u_int pppoe_print(netdissect_options *, const u_char *, u_int); extern void pptp_print(netdissect_options *, const u_char *); extern int print_unknown_data(netdissect_options *, const u_char *, const char *, int); -extern char *q922_string(netdissect_options *, const u_char *, u_int); +extern const char *q922_string(netdissect_options *, const u_char *, u_int); extern void q933_print(netdissect_options *, const u_char *, u_int); extern void radius_print(netdissect_options *, const u_char *, u_int); extern void resp_print(netdissect_options *, const u_char *, u_int); @@ -624,8 +618,8 @@ extern void sctp_print(netdissect_options *, const u_char *, const u_char *, u_i extern void sflow_print(netdissect_options *, const u_char *, u_int); extern void sip_print(netdissect_options *, const u_char *, u_int); extern void slow_print(netdissect_options *, const u_char *, u_int); -extern void smb_print_data(netdissect_options *, const unsigned char *, int); -extern void smb_tcp_print(netdissect_options *, const u_char *, int); +extern void smb_data_print(netdissect_options *, const u_char *, u_int); +extern void smb_tcp_print(netdissect_options *, const u_char *, u_int); extern void smtp_print(netdissect_options *, const u_char *, u_int); extern int snap_print(netdissect_options *, const u_char *, u_int, u_int, const struct lladdr_info *, const struct lladdr_info *, u_int); extern void snmp_print(netdissect_options *, const u_char *, u_int); @@ -646,7 +640,7 @@ extern void vrrp_print(netdissect_options *, const u_char *, u_int, const u_char extern void vtp_print(netdissect_options *, const u_char *, u_int); extern void vxlan_gpe_print(netdissect_options *ndo, const u_char *bp, u_int len); extern void vxlan_print(netdissect_options *, const u_char *, u_int); -extern void wb_print(netdissect_options *, const void *, u_int); +extern void wb_print(netdissect_options *, const u_char *, u_int); extern void zephyr_print(netdissect_options *, const u_char *, int); extern void zmtp1_print(netdissect_options *, const u_char *, u_int); extern void zmtp1_datagram_print(netdissect_options *, const u_char *, const u_int); @@ -669,21 +663,21 @@ extern int nextproto4_cksum(netdissect_options *, const struct ip *, const uint8 extern int nextproto6_cksum(netdissect_options *, const struct ip6_hdr *, const uint8_t *, u_int, u_int, u_int); /* Utilities */ +extern void nd_print_trunc(netdissect_options *); + extern int mask2plen(uint32_t); extern int mask62plen(const u_char *); extern const char *dnname_string(netdissect_options *, u_short); extern const char *dnnum_string(netdissect_options *, u_short); -extern char *smb_errstr(int, int); -extern const char *nt_errstr(uint32_t); - extern int decode_prefix4(netdissect_options *, const u_char *, u_int, char *, u_int); extern int decode_prefix6(netdissect_options *, const u_char *, u_int, char *, u_int); extern void esp_print_decodesecret(netdissect_options *); extern int esp_print_decrypt_buffer_by_ikev2(netdissect_options *, int, - u_char spii[8], u_char spir[8], + const u_char spii[8], + const u_char spir[8], const u_char *, const u_char *); #endif /* netdissect_h */