Sync usage with man page.
[netbsd-mini2440.git] / dist / tcpdump / netdissect.h
blobd247420437bd0490fa4d422154f99e07aaaabe9d
1 /* $NetBSD$ */
3 /*
4 * Copyright (c) 1988-1997
5 * The Regents of the University of California. All rights reserved.
7 * Copyright (c) 1998-2004 Michael Richardson <mcr@tcpdump.org>
8 * The TCPDUMP project
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that: (1) source code distributions
12 * retain the above copyright notice and this paragraph in its entirety, (2)
13 * distributions including binary code include the above copyright notice and
14 * this paragraph in its entirety in the documentation or other materials
15 * provided with the distribution, and (3) all advertising materials mentioning
16 * features or use of this software display the following acknowledgement:
17 * ``This product includes software developed by the University of California,
18 * Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
19 * the University nor the names of its contributors may be used to endorse
20 * or promote products derived from this software without specific prior
21 * written permission.
22 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
23 * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
24 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
26 * @(#) Header: /tcpdump/master/tcpdump/netdissect.h,v 1.16.2.4 2006/02/08 01:40:09 hannes Exp (LBL)
29 #ifndef netdissect_h
30 #define netdissect_h
32 #ifdef HAVE_OS_PROTO_H
33 #include "os-proto.h"
34 #endif
35 #include <sys/types.h>
37 #ifndef HAVE___ATTRIBUTE__
38 #define __attribute__(x)
39 #endif
41 /* snprintf et al */
43 #include <stdarg.h>
45 #if !defined(HAVE_SNPRINTF)
46 int snprintf (char *str, size_t sz, const char *format, ...)
47 __attribute__ ((format (printf, 3, 4)));
48 #endif
50 #if !defined(HAVE_VSNPRINTF)
51 int vsnprintf (char *str, size_t sz, const char *format, va_list ap)
52 __attribute__((format (printf, 3, 0)));
53 #endif
55 #ifndef HAVE_STRLCAT
56 extern size_t strlcat (char *, const char *, size_t);
57 #endif
58 #ifndef HAVE_STRLCPY
59 extern size_t strlcpy (char *, const char *, size_t);
60 #endif
62 #ifndef HAVE_STRDUP
63 extern char *strdup (const char *str);
64 #endif
66 #ifndef HAVE_STRSEP
67 extern char *strsep(char **, const char *);
68 #endif
70 struct tok {
71 int v; /* value */
72 const char *s; /* string */
75 #define TOKBUFSIZE 128
76 extern const char *tok2strbuf(const struct tok *, const char *, int,
77 char *buf, size_t bufsize);
79 /* tok2str is deprecated */
80 extern const char *tok2str(const struct tok *, const char *, int);
81 extern char *bittok2str(const struct tok *, const char *, int);
84 typedef struct netdissect_options netdissect_options;
86 struct netdissect_options {
87 int ndo_aflag; /* translate network and broadcast addresses */
88 int ndo_eflag; /* print ethernet header */
89 int ndo_fflag; /* don't translate "foreign" IP address */
90 int ndo_nflag; /* leave addresses as numbers */
91 int ndo_Nflag; /* remove domains from printed host names */
92 int ndo_qflag; /* quick (shorter) output */
93 int ndo_Rflag; /* print sequence # field in AH/ESP*/
94 int ndo_sflag; /* use the libsmi to translate OIDs */
95 int ndo_Sflag; /* print raw TCP sequence numbers */
96 int ndo_tflag; /* print packet arrival time */
97 int ndo_Uflag; /* "unbuffered" output of dump files */
98 int ndo_uflag; /* Print undecoded NFS handles */
99 int ndo_vflag; /* verbose */
100 int ndo_xflag; /* print packet in hex */
101 int ndo_Xflag; /* print packet in hex/ascii */
102 int ndo_Aflag; /* print packet only in ascii observing TAB,
103 * LF, CR and SPACE as graphical chars
105 int ndo_Oflag; /* run filter code optimizer */
106 int ndo_dlt; /* if != -1, ask libpcap for the DLT it names*/
107 int ndo_pflag; /* don't go promiscuous */
109 int ndo_Cflag; /* rotate dump files after this many bytes */
110 int ndo_Cflag_count; /* Keep track of which file number we're writing */
111 int ndo_Wflag; /* recycle output files after this number of files */
112 int ndo_WflagChars;
113 int ndo_suppress_default_print; /* don't use default_print() for unknown packet types */
114 const char *ndo_dltname;
116 char *ndo_espsecret;
117 struct sa_list *ndo_sa_list_head; /* used by print-esp.c */
118 struct sa_list *ndo_sa_default;
120 char *ndo_tcpmd5secret; /* TCP-MD5 secret key */
122 struct esp_algorithm *ndo_espsecret_xform; /* cache of decoded */
123 char *ndo_espsecret_key;
125 int ndo_packettype; /* as specified by -T */
127 char *ndo_program_name; /*used to generate self-identifying messages */
129 int32_t ndo_thiszone; /* seconds offset from gmt to local time */
131 int ndo_snaplen;
133 /*global pointers to beginning and end of current packet (during printing) */
134 const u_char *ndo_packetp;
135 const u_char *ndo_snapend;
137 /* bookkeeping for ^T output */
138 int ndo_infodelay;
140 /* pointer to void function to output stuff */
141 void (*ndo_default_print)(netdissect_options *,
142 register const u_char *bp, register u_int length);
143 void (*ndo_info)(netdissect_options *, int verbose);
145 int (*ndo_printf)(netdissect_options *,
146 const char *fmt, ...);
147 void (*ndo_error)(netdissect_options *,
148 const char *fmt, ...);
149 void (*ndo_warning)(netdissect_options *,
150 const char *fmt, ...);
153 #define PT_VAT 1 /* Visual Audio Tool */
154 #define PT_WB 2 /* distributed White Board */
155 #define PT_RPC 3 /* Remote Procedure Call */
156 #define PT_RTP 4 /* Real-Time Applications protocol */
157 #define PT_RTCP 5 /* Real-Time Applications control protocol */
158 #define PT_SNMP 6 /* Simple Network Management Protocol */
159 #define PT_CNFP 7 /* Cisco NetFlow protocol */
161 #ifndef min
162 #define min(a,b) ((a)>(b)?(b):(a))
163 #endif
164 #ifndef max
165 #define max(a,b) ((b)>(a)?(b):(a))
166 #endif
168 #ifndef INET6
170 * The default snapshot length. This value allows most printers to print
171 * useful information while keeping the amount of unwanted data down.
172 * In particular, it allows for an ethernet header, tcp/ip header, and
173 * 14 bytes of data (assuming no ip options).
175 #define DEFAULT_SNAPLEN 68
176 #else
177 #define DEFAULT_SNAPLEN 96
178 #endif
180 #ifndef BIG_ENDIAN
181 #define BIG_ENDIAN 4321
182 #define LITTLE_ENDIAN 1234
183 #endif
185 #define ESRC(ep) ((ep)->ether_shost)
186 #define EDST(ep) ((ep)->ether_dhost)
188 #ifndef NTOHL
189 #define NTOHL(x) (x) = ntohl(x)
190 #define NTOHS(x) (x) = ntohs(x)
191 #define HTONL(x) (x) = htonl(x)
192 #define HTONS(x) (x) = htons(x)
193 #endif
196 * True if "l" bytes of "var" were captured.
198 * The "ndo->ndo_snapend - (l) <= ndo->ndo_snapend" checks to make sure
199 * "l" isn't so large that "ndo->ndo_snapend - (l)" underflows.
201 * The check is for <= rather than < because "l" might be 0.
203 #define ND_TTEST2(var, l) (ndo->ndo_snapend - (l) <= ndo->ndo_snapend && \
204 (const u_char *)&(var) <= ndo->ndo_snapend - (l))
206 /* True if "var" was captured */
207 #define ND_TTEST(var) ND_TTEST2(var, sizeof(var))
209 /* Bail if "l" bytes of "var" were not captured */
210 #define ND_TCHECK2(var, l) if (!ND_TTEST2(var, l)) goto trunc
212 /* Bail if "var" was not captured */
213 #define ND_TCHECK(var) ND_TCHECK2(var, sizeof(var))
215 #define ND_PRINT(STUFF) (*ndo->ndo_printf)STUFF
216 #define ND_DEFAULTPRINT(ap, length) (*ndo->ndo_default_print)(ndo, ap, length)
218 #if 0
219 extern void ts_print(netdissect_options *ipdo,
220 const struct timeval *);
221 extern void relts_print(int);
222 #endif
224 extern int fn_print(const u_char *, const u_char *);
225 extern int fn_printn(const u_char *, u_int, const u_char *);
226 extern const char *tok2str(const struct tok *, const char *, int);
228 extern void wrapup(int);
230 #if 0
231 extern char *read_infile(netdissect_options *, char *);
232 extern char *copy_argv(netdissect_options *, char **);
233 #endif
235 extern void safeputchar(int);
236 extern void safeputs(const char *, int);
238 #if 0
239 extern const char *isonsap_string(netdissect_options *, const u_char *);
240 extern const char *protoid_string(netdissect_options *, const u_char *);
241 extern const char *dnname_string(netdissect_options *, u_short);
242 extern const char *dnnum_string(netdissect_options *, u_short);
243 #endif
245 /* The printer routines. */
247 #include <pcap.h>
250 extern void eap_print(netdissect_options *,const u_char *, u_int);
251 extern int esp_print(netdissect_options *,
252 register const u_char *bp, int len, register const u_char *bp2,
253 int *nhdr, int *padlen);
254 extern void arp_print(netdissect_options *,const u_char *, u_int, u_int);
255 extern void isakmp_print(netdissect_options *,const u_char *,
256 u_int, const u_char *);
257 extern void isakmp_rfc3948_print(netdissect_options *,const u_char *,
258 u_int, const u_char *);
259 extern void ip_print(netdissect_options *,const u_char *, u_int);
260 extern void ip_print_inner(netdissect_options *ndo,
261 const u_char *bp, u_int length, u_int nh,
262 const u_char *bp2);
264 /* stuff that has not yet been rototiled */
265 #if 0
266 extern void ascii_print(netdissect_options *,u_int);
267 extern void hex_and_ascii_print_with_offset(netdissect_options *,const char *,
268 u_int, u_int);
269 extern void hex_and_ascii_print(netdissect_options *,const char *, u_int);
270 extern void hex_print_with_offset(netdissect_options *,const char *,
271 u_int, u_int);
272 extern void hex_print(netdissect_options *,const char *, u_int);
273 extern void telnet_print(netdissect_options *,const u_char *, u_int);
274 extern int ether_encap_print(netdissect_options *,u_short, const u_char *,
275 u_int, u_int, u_short *);
276 extern int llc_print(netdissect_options *,
277 const u_char *, u_int, u_int, const u_char *,
278 const u_char *, u_short *);
279 extern void aarp_print(netdissect_options *,const u_char *, u_int);
280 extern void atalk_print(netdissect_options *,const u_char *, u_int);
281 extern void atm_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
282 extern void bootp_print(netdissect_options *,const u_char *,
283 u_int, u_short, u_short);
284 extern void bgp_print(netdissect_options *,const u_char *, int);
285 extern void bxxp_print(netdissect_options *,const u_char *, u_int);
286 extern void chdlc_if_print(u_char *user, const struct pcap_pkthdr *h,
287 register const u_char *p);
288 extern void chdlc_print(netdissect_options *ndo,
289 register const u_char *p, u_int length, u_int caplen);
290 extern void cisco_autorp_print(netdissect_options *,
291 const u_char *, u_int);
292 extern void cnfp_print(netdissect_options *,const u_char *cp,
293 u_int len, const u_char *bp);
294 extern void decnet_print(netdissect_options *,const u_char *,
295 u_int, u_int);
296 extern void default_print(netdissect_options *,const u_char *, u_int);
297 extern void dvmrp_print(netdissect_options *,const u_char *, u_int);
298 extern void egp_print(netdissect_options *,const u_char *, u_int,
299 const u_char *);
301 extern void arcnet_if_print(u_char*,const struct pcap_pkthdr *,const u_char *);
302 extern void ether_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
303 extern void token_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
304 extern void fddi_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
306 extern void gre_print(netdissect_options *,const u_char *, u_int);
307 extern void icmp_print(netdissect_options *,const u_char *, u_int,
308 const u_char *);
309 extern void hsrp_print(netdissect_options *ndo,
310 register const u_char *bp, register u_int len);
311 extern void ieee802_11_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
312 extern void igmp_print(netdissect_options *,
313 register const u_char *, u_int);
314 extern void igrp_print(netdissect_options *,const u_char *, u_int,
315 const u_char *);
316 extern void ipN_print(netdissect_options *,const u_char *, u_int);
317 extern void ipx_print(netdissect_options *,const u_char *, u_int);
318 extern void isoclns_print(netdissect_options *,const u_char *,
319 u_int, u_int, const u_char *, const u_char *);
320 extern void krb_print(netdissect_options *,const u_char *, u_int);
321 extern void llap_print(netdissect_options *,const u_char *, u_int);
322 extern const char *linkaddr_string(netdissect_options *ndo,
323 const u_char *ep, const unsigned int len);
324 extern void ltalk_if_print(netdissect_options *ndo,
325 u_char *user, const struct pcap_pkthdr *h,
326 const u_char *p);
327 extern void mpls_print(netdissect_options *ndo,
328 const u_char *bp, u_int length);
329 extern void msdp_print(netdissect_options *ndo,
330 const unsigned char *sp, u_int length);
331 extern void nfsreply_print(netdissect_options *,const u_char *,
332 u_int, const u_char *);
333 extern void nfsreq_print(netdissect_options *,const u_char *,
334 u_int, const u_char *);
335 extern void ns_print(netdissect_options *,const u_char *, u_int);
336 extern void ntp_print(netdissect_options *,const u_char *, u_int);
337 extern void null_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
338 extern void ospf_print(netdissect_options *,const u_char *,
339 u_int, const u_char *);
340 extern void pimv1_print(netdissect_options *,const u_char *, u_int);
341 extern void mobile_print(netdissect_options *,const u_char *, u_int);
342 extern void pim_print(netdissect_options *,const u_char *, u_int);
343 extern void pppoe_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
344 extern void pppoe_print(netdissect_options *,const u_char *, u_int);
345 extern void ppp_print(netdissect_options *,
346 register const u_char *, u_int);
348 extern void ppp_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
349 extern void ppp_hdlc_if_print(u_char *,
350 const struct pcap_pkthdr *, const u_char *);
351 extern void ppp_bsdos_if_print(u_char *,
352 const struct pcap_pkthdr *, const u_char *);
354 extern int vjc_print(netdissect_options *,register const char *,
355 register u_int, u_short);
357 extern void raw_if_print(u_char *,
358 const struct pcap_pkthdr *, const u_char *);
360 extern void rip_print(netdissect_options *,const u_char *, u_int);
362 extern void sctp_print(netdissect_options *ndo,
363 const u_char *bp, const u_char *bp2,
364 u_int sctpPacketLength);
366 extern void sl_if_print(u_char *,const struct pcap_pkthdr *, const u_char *);
368 extern void lane_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
369 extern void cip_if_print(u_char *,const struct pcap_pkthdr *,const u_char *);
370 extern void sl_bsdos_if_print(u_char *,
371 const struct pcap_pkthdr *, const u_char *);
372 extern void sll_if_print(u_char *,
373 const struct pcap_pkthdr *, const u_char *);
375 extern void snmp_print(netdissect_options *,const u_char *, u_int);
376 extern void sunrpcrequest_print(netdissect_options *,const u_char *,
377 u_int, const u_char *);
378 extern void tcp_print(netdissect_options *,const u_char *, u_int,
379 const u_char *, int);
380 extern void tftp_print(netdissect_options *,const u_char *, u_int);
381 extern void timed_print(netdissect_options *,const u_char *, u_int);
382 extern void udp_print(netdissect_options *,const u_char *, u_int,
383 const u_char *, int);
384 extern void wb_print(netdissect_options *,const void *, u_int);
385 extern int ah_print(netdissect_options *,register const u_char *,
386 register const u_char *);
387 extern void esp_print_decodesecret(netdissect_options *ndo);
388 extern int ipcomp_print(netdissect_options *,register const u_char *,
389 register const u_char *, int *);
390 extern void rx_print(netdissect_options *,register const u_char *,
391 int, int, int, u_char *);
392 extern void netbeui_print(netdissect_options *,u_short,
393 const u_char *, int);
394 extern void ipx_netbios_print(netdissect_options *,const u_char *, u_int);
395 extern void nbt_tcp_print(netdissect_options *,const u_char *, int);
396 extern void nbt_udp137_print(netdissect_options *,
397 const u_char *data, int);
398 extern void nbt_udp138_print(netdissect_options *,
399 const u_char *data, int);
400 extern char *smb_errstr(netdissect_options *,int, int);
401 extern const char *nt_errstr(netdissect_options *, u_int32_t);
402 extern void print_data(netdissect_options *,const unsigned char *, int);
403 extern void l2tp_print(netdissect_options *,const u_char *, u_int);
404 extern void lcp_print(netdissect_options *,const u_char *, u_int);
405 extern void vrrp_print(netdissect_options *,const u_char *bp,
406 u_int len, int ttl);
407 extern void cdp_print(netdissect_options *,const u_char *,
408 u_int, u_int, const u_char *, const u_char *);
409 extern void stp_print(netdissect_options *,const u_char *p, u_int length);
410 extern void radius_print(netdissect_options *,const u_char *, u_int);
411 extern void lwres_print(netdissect_options *,const u_char *, u_int);
412 extern void pptp_print(netdissect_options *,const u_char *, u_int);
414 #ifdef INET6
415 extern void ip6_print(netdissect_options *,const u_char *, u_int);
416 extern void ip6_opt_print(netdissect_options *,const u_char *, int);
417 extern int hbhopt_print(netdissect_options *,const u_char *);
418 extern int dstopt_print(netdissect_options *,const u_char *);
419 extern int frag6_print(netdissect_options *,const u_char *,
420 const u_char *);
421 extern void icmp6_print(netdissect_options *,const u_char *,
422 const u_char *);
423 extern void ripng_print(netdissect_options *,const u_char *, int);
424 extern int rt6_print(netdissect_options *,const u_char *, const u_char *);
425 extern void ospf6_print(netdissect_options *,const u_char *, u_int);
426 extern void dhcp6_print(netdissect_options *,const u_char *,
427 u_int, u_int16_t, u_int16_t);
429 extern void zephyr_print(netdissect_options * ndo,
430 const u_char *cp, int length);
432 #endif /*INET6*/
433 extern u_short in_cksum(const u_short *,
434 register u_int, int);
436 #endif
438 #endif /* netdissect_h */