pcap.h revision 75110
1/* 2 * Copyright (c) 1993, 1994, 1995, 1996, 1997 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 * $FreeBSD: head/contrib/libpcap/pcap.h 75110 2001-04-03 04:32:48Z fenner $ 34 * @(#) $Header: /tcpdump/master/libpcap/pcap.h,v 1.31 2000/10/28 00:01:31 guy Exp $ (LBL) 35 */ 36 37#ifndef lib_pcap_h 38#define lib_pcap_h 39 40#include <sys/types.h> 41#include <sys/time.h> 42 43#include <net/bpf.h> 44 45#include <stdio.h> 46 47#ifdef __cplusplus 48extern "C" { 49#endif 50 51#define PCAP_VERSION_MAJOR 2 52#define PCAP_VERSION_MINOR 4 53 54#define PCAP_ERRBUF_SIZE 256 55 56/* 57 * Compatibility for systems that have a bpf.h that 58 * predates the bpf typedefs for 64-bit support. 59 */ 60#if BPF_RELEASE - 0 < 199406 61typedef int bpf_int32; 62typedef u_int bpf_u_int32; 63#endif 64 65typedef struct pcap pcap_t; 66typedef struct pcap_dumper pcap_dumper_t; 67 68/* 69 * The first record in the file contains saved values for some 70 * of the flags used in the printout phases of tcpdump. 71 * Many fields here are 32 bit ints so compilers won't insert unwanted 72 * padding; these files need to be interchangeable across architectures. 73 * 74 * Do not change the layout of this structure, in any way (this includes 75 * changes that only affect the length of fields in this structure). 76 * 77 * Also, do not change the interpretation of any of the members of this 78 * structure, in any way (this includes using values other than 79 * LINKTYPE_ values, as defined in "savefile.c", in the "linktype" 80 * field). 81 * 82 * Instead: 83 * 84 * introduce a new structure for the new format, if the layout 85 * of the structure changed; 86 * 87 * send mail to "tcpdump-workers@tcpdump.org", requesting a new 88 * magic number for your new capture file format, and, when 89 * you get the new magic number, put it in "savefile.c"; 90 * 91 * use that magic number for save files with the changed file 92 * header; 93 * 94 * make the code in "savefile.c" capable of reading files with 95 * the old file header as well as files with the new file header 96 * (using the magic number to determine the header format). 97 * 98 * Then supply the changes to "patches@tcpdump.org", so that future 99 * versions of libpcap and programs that use it (such as tcpdump) will 100 * be able to read your new capture file format. 101 */ 102struct pcap_file_header { 103 bpf_u_int32 magic; 104 u_short version_major; 105 u_short version_minor; 106 bpf_int32 thiszone; /* gmt to local correction */ 107 bpf_u_int32 sigfigs; /* accuracy of timestamps */ 108 bpf_u_int32 snaplen; /* max length saved portion of each pkt */ 109 bpf_u_int32 linktype; /* data link type (LINKTYPE_*) */ 110}; 111 112/* 113 * Each packet in the dump file is prepended with this generic header. 114 * This gets around the problem of different headers for different 115 * packet interfaces. 116 */ 117struct pcap_pkthdr { 118 struct timeval ts; /* time stamp */ 119 bpf_u_int32 caplen; /* length of portion present */ 120 bpf_u_int32 len; /* length this packet (off wire) */ 121}; 122 123/* 124 * As returned by the pcap_stats() 125 */ 126struct pcap_stat { 127 u_int ps_recv; /* number of packets received */ 128 u_int ps_drop; /* number of packets dropped */ 129 u_int ps_ifdrop; /* drops by interface XXX not yet supported */ 130}; 131 132typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *, 133 const u_char *); 134 135char *pcap_lookupdev(char *); 136int pcap_lookupnet(char *, bpf_u_int32 *, bpf_u_int32 *, char *); 137pcap_t *pcap_open_live(char *, int, int, int, char *); 138pcap_t *pcap_open_dead(int, int); 139pcap_t *pcap_open_offline(const char *, char *); 140void pcap_close(pcap_t *); 141int pcap_loop(pcap_t *, int, pcap_handler, u_char *); 142int pcap_dispatch(pcap_t *, int, pcap_handler, u_char *); 143const u_char* 144 pcap_next(pcap_t *, struct pcap_pkthdr *); 145int pcap_stats(pcap_t *, struct pcap_stat *); 146int pcap_setfilter(pcap_t *, struct bpf_program *); 147void pcap_perror(pcap_t *, char *); 148char *pcap_strerror(int); 149char *pcap_geterr(pcap_t *); 150int pcap_compile(pcap_t *, struct bpf_program *, char *, int, 151 bpf_u_int32); 152int pcap_compile_nopcap(int, int, struct bpf_program *, 153 char *, int, bpf_u_int32); 154void pcap_freecode(struct bpf_program *); 155int pcap_datalink(pcap_t *); 156int pcap_snapshot(pcap_t *); 157int pcap_is_swapped(pcap_t *); 158int pcap_major_version(pcap_t *); 159int pcap_minor_version(pcap_t *); 160 161/* XXX */ 162FILE *pcap_file(pcap_t *); 163int pcap_fileno(pcap_t *); 164 165pcap_dumper_t *pcap_dump_open(pcap_t *, const char *); 166void pcap_dump_close(pcap_dumper_t *); 167void pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *); 168 169/* XXX this guy lives in the bpf tree */ 170u_int bpf_filter(struct bpf_insn *, u_char *, u_int, u_int); 171int bpf_validate(struct bpf_insn *f, int len); 172char *bpf_image(struct bpf_insn *, int); 173void bpf_dump(struct bpf_program *, int); 174 175#ifdef __cplusplus 176} 177#endif 178 179#endif 180