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