xref: /freebsd/contrib/tcpdump/interface.h (revision 6b3455a7665208c366849f0b2b3bc916fb97516e)
1 /*
2  * Copyright (c) 1988-2002
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that: (1) source code distributions
7  * retain the above copyright notice and this paragraph in its entirety, (2)
8  * distributions including binary code include the above copyright notice and
9  * this paragraph in its entirety in the documentation or other materials
10  * provided with the distribution, and (3) all advertising materials mentioning
11  * features or use of this software display the following acknowledgement:
12  * ``This product includes software developed by the University of California,
13  * Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
14  * the University nor the names of its contributors may be used to endorse
15  * or promote products derived from this software without specific prior
16  * written permission.
17  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
18  * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
20  *
21  * @(#) $Header: /tcpdump/master/tcpdump/interface.h,v 1.217.2.5 2004/03/17 19:47:48 guy Exp $ (LBL)
22  *
23  * $FreeBSD$
24  */
25 
26 #ifndef tcpdump_interface_h
27 #define tcpdump_interface_h
28 
29 #ifdef HAVE_OS_PROTO_H
30 #include "os-proto.h"
31 #endif
32 
33 #ifndef HAVE___ATTRIBUTE__
34 #define __attribute__(x)
35 #endif
36 
37 /* snprintf et al */
38 
39 #include <stdarg.h>
40 
41 #if !defined(HAVE_SNPRINTF)
42 int snprintf(char *, size_t, const char *, ...)
43      __attribute__((format(printf, 3, 4)));
44 #endif
45 
46 #if !defined(HAVE_VSNPRINTF)
47 int vsnprintf(char *, size_t, const char *, va_list)
48      __attribute__((format(printf, 3, 0)));
49 #endif
50 
51 #ifndef HAVE_STRLCAT
52 extern size_t strlcat(char *, const char *, size_t);
53 #endif
54 #ifndef HAVE_STRLCPY
55 extern size_t strlcpy(char *, const char *, size_t);
56 #endif
57 
58 #ifndef HAVE_STRDUP
59 extern char *strdup(const char *);
60 #endif
61 
62 #ifndef HAVE_STRSEP
63 extern char *strsep(char **, const char *);
64 #endif
65 
66 struct tok {
67 	int v;			/* value */
68 	const char *s;		/* string */
69 };
70 
71 extern int aflag;		/* translate network and broadcast addresses */
72 extern int dflag;		/* print filter code */
73 extern int eflag;		/* print ethernet header */
74 extern int fflag;		/* don't translate "foreign" IP address */
75 extern int nflag;		/* leave addresses as numbers */
76 extern int Nflag;		/* remove domains from printed host names */
77 extern int qflag;		/* quick (shorter) output */
78 extern int Rflag;		/* print sequence # field in AH/ESP*/
79 extern int sflag;		/* use the libsmi to translate OIDs */
80 extern int Sflag;		/* print raw TCP sequence numbers */
81 extern int tflag;		/* print packet arrival time */
82 extern int uflag;		/* Print undecoded NFS handles */
83 extern int vflag;		/* verbose */
84 extern int xflag;		/* print packet in hex */
85 extern int Xflag;		/* print packet in hex/ascii */
86 extern int Aflag;		/* print packet only in ascii observing TAB, LF, CR and SPACE as graphical chars */
87 extern char *espsecret;
88 
89 extern int packettype;		/* as specified by -T */
90 #define PT_VAT		1	/* Visual Audio Tool */
91 #define PT_WB		2	/* distributed White Board */
92 #define PT_RPC		3	/* Remote Procedure Call */
93 #define PT_RTP		4	/* Real-Time Applications protocol */
94 #define PT_RTCP		5	/* Real-Time Applications control protocol */
95 #define PT_SNMP		6	/* Simple Network Management Protocol */
96 #define PT_CNFP		7	/* Cisco NetFlow protocol */
97 #define PT_TFTP		8	/* trivial file transfer protocol */
98 #define PT_AODV		9	/* Ad-hoc On-demand Distance Vector Protocol */
99 
100 #ifndef min
101 #define min(a,b) ((a)>(b)?(b):(a))
102 #endif
103 #ifndef max
104 #define max(a,b) ((b)>(a)?(b):(a))
105 #endif
106 
107 /*
108  * The default snapshot length.  This value allows most printers to print
109  * useful information while keeping the amount of unwanted data down.
110  */
111 #ifndef INET6
112 #define DEFAULT_SNAPLEN 68	/* ether + IPv4 + TCP + 14 */
113 #else
114 #define DEFAULT_SNAPLEN 96	/* ether + IPv6 + TCP + 22 */
115 #endif
116 
117 #ifndef BIG_ENDIAN
118 #define BIG_ENDIAN 4321
119 #define LITTLE_ENDIAN 1234
120 #endif
121 
122 #define ESRC(ep) ((ep)->ether_shost)
123 #define EDST(ep) ((ep)->ether_dhost)
124 
125 #ifndef NTOHL
126 #define NTOHL(x)	(x) = ntohl(x)
127 #define NTOHS(x)	(x) = ntohs(x)
128 #define HTONL(x)	(x) = htonl(x)
129 #define HTONS(x)	(x) = htons(x)
130 #endif
131 #endif
132 
133 extern char *program_name;	/* used to generate self-identifying messages */
134 
135 extern int32_t thiszone;	/* seconds offset from gmt to local time */
136 
137 extern int snaplen;
138 /* global pointer to end of current packet (during printing) */
139 extern const u_char *snapend;
140 
141 /*
142  * True if  "l" bytes of "var" were captured.
143  *
144  * The "snapend - (l) <= snapend" checks to make sure "l" isn't so large
145  * that "snapend - (l)" underflows.
146  *
147  * The check is for <= rather than < because "l" might be 0.
148  */
149 #define TTEST2(var, l) (snapend - (l) <= snapend && \
150 			(const u_char *)&(var) <= snapend - (l))
151 
152 /* True if "var" was captured */
153 #define TTEST(var) TTEST2(var, sizeof(var))
154 
155 /* Bail if "l" bytes of "var" were not captured */
156 #define TCHECK2(var, l) if (!TTEST2(var, l)) goto trunc
157 
158 /* Bail if "var" was not captured */
159 #define TCHECK(var) TCHECK2(var, sizeof(var))
160 
161 extern void ts_print(const struct timeval *);
162 extern void relts_print(int);
163 
164 extern int fn_print(const u_char *, const u_char *);
165 extern int fn_printn(const u_char *, u_int, const u_char *);
166 extern const char *tok2str(const struct tok *, const char *, int);
167 extern int mask2plen(u_int32_t);
168 extern char *bittok2str(const struct tok *, const char *, int);
169 extern const char *tok2strary_internal(const char **, int, const char *, int);
170 #define	tok2strary(a,f,i) tok2strary_internal(a, sizeof(a)/sizeof(a[0]),f,i)
171 
172 extern const char *dnaddr_string(u_short);
173 
174 extern void error(const char *, ...)
175     __attribute__((noreturn, format (printf, 1, 2)));
176 extern void warning(const char *, ...) __attribute__ ((format (printf, 1, 2)));
177 
178 extern char *read_infile(char *);
179 extern char *copy_argv(char **);
180 
181 extern void safeputchar(int);
182 extern void safeputs(const char *);
183 
184 extern const char *isonsap_string(const u_char *);
185 extern const char *llcsap_string(u_char);
186 extern const char *protoid_string(const u_char *);
187 extern const char *ipxsap_string(u_short);
188 extern const char *dnname_string(u_short);
189 extern const char *dnnum_string(u_short);
190 
191 /* The printer routines. */
192 
193 #include <pcap.h>
194 
195 extern int print_unknown_data(const u_char *, const char *,int);
196 extern void ascii_print_with_offset(const u_char *, const u_char *, u_int, u_int);
197 extern void ascii_print(const u_char *, const u_char *, u_int);
198 extern void hex_print_with_offset(const u_char *, const u_char *, u_int, u_int);
199 extern void telnet_print(const u_char *, u_int);
200 extern void hex_print(const u_char *, const u_char *, u_int);
201 extern int ether_encap_print(u_short, const u_char *, u_int, u_int, u_short *);
202 extern int llc_print(const u_char *, u_int, u_int, const u_char *,
203 	const u_char *, u_short *);
204 extern int snap_print(const u_char *, u_int, u_int, u_short *, u_int32_t,
205 	u_short, u_int);
206 extern void aarp_print(const u_char *, u_int);
207 extern void aodv_print(const u_char *, u_int, int);
208 extern void arp_print(const u_char *, u_int, u_int);
209 extern void atalk_print(const u_char *, u_int);
210 extern void atm_print(u_int, u_int, u_int, const u_char *, u_int, u_int);
211 extern u_int atm_if_print(const struct pcap_pkthdr *, const u_char *);
212 extern u_int sunatm_if_print(const struct pcap_pkthdr *, const u_char *);
213 extern void bootp_print(const u_char *, u_int);
214 extern void bgp_print(const u_char *, int);
215 extern void beep_print(const u_char *, u_int);
216 extern void cnfp_print(const u_char *, const u_char *);
217 extern void decnet_print(const u_char *, u_int, u_int);
218 extern void default_print(const u_char *, u_int);
219 extern void default_print_unaligned(const u_char *, u_int);
220 extern void dvmrp_print(const u_char *, u_int);
221 extern void egp_print(const u_char *);
222 extern u_int enc_if_print(const struct pcap_pkthdr *, const u_char *);
223 extern u_int pflog_if_print(const struct pcap_pkthdr *, const u_char *);
224 extern u_int arcnet_if_print(const struct pcap_pkthdr *, const u_char *);
225 extern u_int arcnet_linux_if_print(const struct pcap_pkthdr *, const u_char *);
226 extern void ether_print(const u_char *, u_int, u_int);
227 extern u_int ether_if_print(const struct pcap_pkthdr *, const u_char *);
228 extern u_int token_print(const u_char *, u_int, u_int);
229 extern u_int token_if_print(const struct pcap_pkthdr *, const u_char *);
230 extern void fddi_print(const u_char *, u_int, u_int);
231 extern u_int fddi_if_print(const struct pcap_pkthdr *, const u_char *);
232 extern u_int fr_if_print(const struct pcap_pkthdr *, const u_char *);
233 extern u_int ieee802_11_if_print(const struct pcap_pkthdr *, const u_char *);
234 extern u_int ieee802_11_radio_if_print(const struct pcap_pkthdr *,
235 	const u_char *);
236 extern u_int ap1394_if_print(const struct pcap_pkthdr *, const u_char *);
237 extern void gre_print(const u_char *, u_int);
238 extern void icmp_print(const u_char *, u_int, const u_char *, int);
239 extern void igmp_print(const u_char *, u_int);
240 extern void igrp_print(const u_char *, u_int, const u_char *);
241 extern void ip_print(const u_char *, u_int);
242 extern void ipN_print(const u_char *, u_int);
243 extern u_int ipfc_if_print(const struct pcap_pkthdr *, const u_char *);
244 extern void ipx_print(const u_char *, u_int);
245 extern void isoclns_print(const u_char *, u_int, u_int);
246 extern void krb_print(const u_char *);
247 extern u_int llap_print(const u_char *, u_int);
248 extern u_int ltalk_if_print(const struct pcap_pkthdr *, const u_char *);
249 extern void msdp_print(const unsigned char *, u_int);
250 extern void nfsreply_print(const u_char *, u_int, const u_char *);
251 extern void nfsreq_print(const u_char *, u_int, const u_char *);
252 extern void ns_print(const u_char *, u_int, int);
253 extern void ntp_print(const u_char *, u_int);
254 extern u_int null_if_print(const struct pcap_pkthdr *, const u_char *);
255 extern void ospf_print(const u_char *, u_int, const u_char *);
256 extern void pimv1_print(const u_char *, u_int);
257 extern void cisco_autorp_print(const u_char *, u_int);
258 extern void rsvp_print(const u_char *, u_int);
259 extern void ldp_print(const u_char *, u_int);
260 extern void mobile_print(const u_char *, u_int);
261 extern void pim_print(const u_char *, u_int);
262 extern u_int pppoe_print(const u_char *, u_int);
263 extern u_int ppp_print(register const u_char *, u_int);
264 extern u_int ppp_if_print(const struct pcap_pkthdr *, const u_char *);
265 extern u_int ppp_hdlc_if_print(const struct pcap_pkthdr *, const u_char *);
266 extern u_int ppp_bsdos_if_print(const struct pcap_pkthdr *, const u_char *);
267 extern u_int pppoe_if_print(const struct pcap_pkthdr *, const u_char *);
268 extern u_int prism_if_print(const struct pcap_pkthdr *, const u_char *);
269 extern int vjc_print(register const char *, u_short);
270 extern u_int raw_if_print(const struct pcap_pkthdr *, const u_char *);
271 extern void rip_print(const u_char *, u_int);
272 extern u_int sl_if_print(const struct pcap_pkthdr *, const u_char *);
273 extern void lane_print(const u_char *, u_int, u_int);
274 extern u_int lane_if_print(const struct pcap_pkthdr *, const u_char *);
275 extern u_int cip_if_print(const struct pcap_pkthdr *, const u_char *);
276 extern u_int sl_bsdos_if_print(const struct pcap_pkthdr *, const u_char *);
277 extern u_int chdlc_if_print(const struct pcap_pkthdr *, const u_char *);
278 extern u_int sll_if_print(const struct pcap_pkthdr *, const u_char *);
279 extern void snmp_print(const u_char *, u_int);
280 extern void sunrpcrequest_print(const u_char *, u_int, const u_char *);
281 extern void tcp_print(const u_char *, u_int, const u_char *, int);
282 extern void tftp_print(const u_char *, u_int);
283 extern void timed_print(const u_char *);
284 extern void udp_print(const u_char *, u_int, const u_char *, int);
285 extern void wb_print(const void *, u_int);
286 extern int ah_print(register const u_char *);
287 extern int esp_print(register const u_char *, register const u_char *, int *, int *);
288 extern void isakmp_print(const u_char *, u_int, const u_char *);
289 extern int ipcomp_print(register const u_char *, int *);
290 extern void rx_print(register const u_char *, int, int, int, u_char *);
291 extern void netbeui_print(u_short, const u_char *, int);
292 extern void ipx_netbios_print(const u_char *, u_int);
293 extern void nbt_tcp_print(const u_char *, int);
294 extern void nbt_udp137_print(const u_char *, int);
295 extern void nbt_udp138_print(const u_char *, int);
296 extern char *smb_errstr(int, int);
297 extern void print_data(const unsigned char *, int);
298 extern void l2tp_print(const u_char *, u_int);
299 extern void vrrp_print(const u_char *, u_int, int);
300 extern void cdp_print(const u_char *, u_int, u_int);
301 extern void stp_print(const u_char *, u_int);
302 extern void radius_print(const u_char *, u_int);
303 extern void lwres_print(const u_char *, u_int);
304 extern void pptp_print(const u_char *);
305 extern void sctp_print(const u_char *, const u_char *, u_int);
306 extern void mpls_print(const u_char *, u_int);
307 extern void mpls_lsp_ping_print(const u_char *, u_int);
308 extern void zephyr_print(const u_char *, int);
309 extern void hsrp_print(const u_char *, u_int);
310 extern void bfd_print(const u_char *, u_int, u_int);
311 
312 #ifdef INET6
313 extern void ip6_print(const u_char *, u_int);
314 extern void ip6_opt_print(const u_char *, int);
315 extern int hbhopt_print(const u_char *);
316 extern int dstopt_print(const u_char *);
317 extern int frag6_print(const u_char *, const u_char *);
318 extern int mobility_print(const u_char *, const u_char *);
319 extern void icmp6_print(const u_char *, u_int, const u_char *, int);
320 extern void ripng_print(const u_char *, unsigned int);
321 extern int rt6_print(const u_char *, const u_char *);
322 extern void ospf6_print(const u_char *, u_int);
323 extern void dhcp6_print(const u_char *, u_int);
324 #endif /*INET6*/
325 extern u_short in_cksum(const u_short *, register u_int, int);
326 extern u_int16_t in_cksum_shouldbe(u_int16_t, u_int16_t);
327 
328 #ifndef HAVE_BPF_DUMP
329 struct bpf_program;
330 
331 extern void bpf_dump(struct bpf_program *, int);
332 #endif
333