pcap.h revision 17683 
1/*
2 * Copyright (c) 1993, 1994, 1995, 1996
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 the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *	This product includes software developed by the Computer Systems
16 *	Engineering Group at Lawrence Berkeley Laboratory.
17 * 4. Neither the name of the University nor of the Laboratory may be used
18 *    to endorse or promote products derived from this software without
19 *    specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 * @(#) $Header: pcap.h,v 1.20 96/07/12 19:24:15 leres Exp $ (LBL)
34 */
35
36#ifndef lib_pcap_h
37#define lib_pcap_h
38
39#include <sys/types.h>
40#include <sys/time.h>
41
42#include <net/bpf.h>
43
44#include <stdio.h>
45
46#define PCAP_VERSION_MAJOR 2
47#define PCAP_VERSION_MINOR 4
48
49#define PCAP_ERRBUF_SIZE 256
50
51/*
52 * Compatibility for systems that have a bpf.h that
53 * predates the bpf typedefs for 64-bit support.
54 */
55#if BPF_RELEASE - 0 < 199406
56typedef	int bpf_int32;
57typedef	u_int bpf_u_int32;
58#endif
59
60typedef struct pcap pcap_t;
61typedef struct pcap_dumper pcap_dumper_t;
62
63/*
64 * The first record in the file contains saved values for some
65 * of the flags used in the printout phases of tcpdump.
66 * Many fields here are 32 bit ints so compilers won't insert unwanted
67 * padding; these files need to be interchangeable across architectures.
68 */
69struct pcap_file_header {
70	bpf_u_int32 magic;
71	u_short version_major;
72	u_short version_minor;
73	bpf_int32 thiszone;	/* gmt to local correction */
74	bpf_u_int32 sigfigs;	/* accuracy of timestamps */
75	bpf_u_int32 snaplen;	/* max length saved portion of each pkt */
76	bpf_u_int32 linktype;	/* data link type (DLT_*) */
77};
78
79/*
80 * Each packet in the dump file is prepended with this generic header.
81 * This gets around the problem of different headers for different
82 * packet interfaces.
83 */
84struct pcap_pkthdr {
85	struct timeval ts;	/* time stamp */
86	bpf_u_int32 caplen;	/* length of portion present */
87	bpf_u_int32 len;	/* length this packet (off wire) */
88};
89
90/*
91 * As returned by the pcap_stats()
92 */
93struct pcap_stat {
94	u_int ps_recv;		/* number of packets received */
95	u_int ps_drop;		/* number of packets dropped */
96	u_int ps_ifdrop;	/* drops by interface XXX not yet supported */
97};
98
99typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *,
100			     const u_char *);
101
102char	*pcap_lookupdev(char *);
103int	pcap_lookupnet(char *, bpf_u_int32 *, bpf_u_int32 *, char *);
104pcap_t	*pcap_open_live(char *, int, int, int, char *);
105pcap_t	*pcap_open_offline(char *, char *);
106void	pcap_close(pcap_t *);
107int	pcap_loop(pcap_t *, int, pcap_handler, u_char *);
108int	pcap_dispatch(pcap_t *, int, pcap_handler, u_char *);
109const u_char*
110	pcap_next(pcap_t *, struct pcap_pkthdr *);
111int	pcap_stats(pcap_t *, struct pcap_stat *);
112int	pcap_setfilter(pcap_t *, struct bpf_program *);
113void	pcap_perror(pcap_t *, char *);
114char	*pcap_strerror(int);
115char	*pcap_geterr(pcap_t *);
116int	pcap_compile(pcap_t *, struct bpf_program *, char *, int,
117	    bpf_u_int32);
118/* XXX */
119int	pcap_freecode(pcap_t *, struct bpf_program *);
120int	pcap_datalink(pcap_t *);
121int	pcap_snapshot(pcap_t *);
122int	pcap_is_swapped(pcap_t *);
123int	pcap_major_version(pcap_t *);
124int	pcap_minor_version(pcap_t *);
125
126/* XXX */
127FILE	*pcap_file(pcap_t *);
128int	pcap_fileno(pcap_t *);
129
130pcap_dumper_t *pcap_dump_open(pcap_t *, char *);
131void	pcap_dump_close(pcap_dumper_t *);
132void	pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *);
133
134/* XXX this guy lives in the bpf tree */
135u_int	bpf_filter(struct bpf_insn *, u_char *, u_int, u_int);
136char	*bpf_image(struct bpf_insn *, int);
137#endif
138