pcap.h revision 127667
1/* -*- Mode: c; tab-width: 8; indent-tabs-mode: 1; c-basic-offset: 8; -*- */ 2/* 3 * Copyright (c) 1993, 1994, 1995, 1996, 1997 4 * The Regents of the University of California. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. All advertising materials mentioning features or use of this software 15 * must display the following acknowledgement: 16 * This product includes software developed by the Computer Systems 17 * Engineering Group at Lawrence Berkeley Laboratory. 18 * 4. Neither the name of the University nor of the Laboratory may be used 19 * to endorse or promote products derived from this software without 20 * specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 * 34 * $FreeBSD: head/contrib/libpcap/pcap.h 127667 2004-03-31 09:15:09Z bms $ 35 * @(#) $Header: /tcpdump/master/libpcap/pcap.h,v 1.45.2.4 2004/01/27 22:56:20 guy Exp $ (LBL) 36 */ 37 38#ifndef lib_pcap_h 39#define lib_pcap_h 40 41#ifdef WIN32 42#include <pcap-stdinc.h> 43#else /* WIN32 */ 44#include <sys/types.h> 45#include <sys/time.h> 46#endif /* WIN32 */ 47 48#ifndef PCAP_DONT_INCLUDE_PCAP_BPF_H 49#include <pcap-bpf.h> 50#endif 51 52#include <stdio.h> 53 54#ifdef __cplusplus 55extern "C" { 56#endif 57 58#define PCAP_VERSION_MAJOR 2 59#define PCAP_VERSION_MINOR 4 60 61#define PCAP_ERRBUF_SIZE 256 62 63/* 64 * Compatibility for systems that have a bpf.h that 65 * predates the bpf typedefs for 64-bit support. 66 */ 67#if BPF_RELEASE - 0 < 199406 68typedef int bpf_int32; 69typedef u_int bpf_u_int32; 70#endif 71 72typedef struct pcap pcap_t; 73typedef struct pcap_dumper pcap_dumper_t; 74typedef struct pcap_if pcap_if_t; 75typedef struct pcap_addr pcap_addr_t; 76 77/* 78 * The first record in the file contains saved values for some 79 * of the flags used in the printout phases of tcpdump. 80 * Many fields here are 32 bit ints so compilers won't insert unwanted 81 * padding; these files need to be interchangeable across architectures. 82 * 83 * Do not change the layout of this structure, in any way (this includes 84 * changes that only affect the length of fields in this structure). 85 * 86 * Also, do not change the interpretation of any of the members of this 87 * structure, in any way (this includes using values other than 88 * LINKTYPE_ values, as defined in "savefile.c", in the "linktype" 89 * field). 90 * 91 * Instead: 92 * 93 * introduce a new structure for the new format, if the layout 94 * of the structure changed; 95 * 96 * send mail to "tcpdump-workers@tcpdump.org", requesting a new 97 * magic number for your new capture file format, and, when 98 * you get the new magic number, put it in "savefile.c"; 99 * 100 * use that magic number for save files with the changed file 101 * header; 102 * 103 * make the code in "savefile.c" capable of reading files with 104 * the old file header as well as files with the new file header 105 * (using the magic number to determine the header format). 106 * 107 * Then supply the changes to "patches@tcpdump.org", so that future 108 * versions of libpcap and programs that use it (such as tcpdump) will 109 * be able to read your new capture file format. 110 */ 111struct pcap_file_header { 112 bpf_u_int32 magic; 113 u_short version_major; 114 u_short version_minor; 115 bpf_int32 thiszone; /* gmt to local correction */ 116 bpf_u_int32 sigfigs; /* accuracy of timestamps */ 117 bpf_u_int32 snaplen; /* max length saved portion of each pkt */ 118 bpf_u_int32 linktype; /* data link type (LINKTYPE_*) */ 119}; 120 121/* 122 * Each packet in the dump file is prepended with this generic header. 123 * This gets around the problem of different headers for different 124 * packet interfaces. 125 */ 126struct pcap_pkthdr { 127 struct timeval ts; /* time stamp */ 128 bpf_u_int32 caplen; /* length of portion present */ 129 bpf_u_int32 len; /* length this packet (off wire) */ 130}; 131 132/* 133 * As returned by the pcap_stats() 134 */ 135struct pcap_stat { 136 u_int ps_recv; /* number of packets received */ 137 u_int ps_drop; /* number of packets dropped */ 138 u_int ps_ifdrop; /* drops by interface XXX not yet supported */ 139#ifdef WIN32 140 u_int bs_capt; /* number of packets that reach the application */ 141#endif /* WIN32 */ 142}; 143 144/* 145 * Item in a list of interfaces. 146 */ 147struct pcap_if { 148 struct pcap_if *next; 149 char *name; /* name to hand to "pcap_open_live()" */ 150 char *description; /* textual description of interface, or NULL */ 151 struct pcap_addr *addresses; 152 bpf_u_int32 flags; /* PCAP_IF_ interface flags */ 153}; 154 155#define PCAP_IF_LOOPBACK 0x00000001 /* interface is loopback */ 156 157/* 158 * Representation of an interface address. 159 */ 160struct pcap_addr { 161 struct pcap_addr *next; 162 struct sockaddr *addr; /* address */ 163 struct sockaddr *netmask; /* netmask for that address */ 164 struct sockaddr *broadaddr; /* broadcast address for that address */ 165 struct sockaddr *dstaddr; /* P2P destination address for that address */ 166}; 167 168typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *, 169 const u_char *); 170 171char *pcap_lookupdev(char *); 172int pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *); 173pcap_t *pcap_open_live(const char *, int, int, int, char *); 174pcap_t *pcap_open_dead(int, int); 175pcap_t *pcap_open_offline(const char *, char *); 176void pcap_close(pcap_t *); 177int pcap_loop(pcap_t *, int, pcap_handler, u_char *); 178int pcap_dispatch(pcap_t *, int, pcap_handler, u_char *); 179const u_char* 180 pcap_next(pcap_t *, struct pcap_pkthdr *); 181int pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **); 182void pcap_breakloop(pcap_t *); 183int pcap_stats(pcap_t *, struct pcap_stat *); 184int pcap_setfilter(pcap_t *, struct bpf_program *); 185int pcap_getnonblock(pcap_t *, char *); 186int pcap_setnonblock(pcap_t *, int, char *); 187void pcap_perror(pcap_t *, char *); 188char *pcap_strerror(int); 189char *pcap_geterr(pcap_t *); 190int pcap_compile(pcap_t *, struct bpf_program *, char *, int, 191 bpf_u_int32); 192int pcap_compile_nopcap(int, int, struct bpf_program *, 193 char *, int, bpf_u_int32); 194void pcap_freecode(struct bpf_program *); 195int pcap_datalink(pcap_t *); 196int pcap_list_datalinks(pcap_t *, int **); 197int pcap_set_datalink(pcap_t *, int); 198int pcap_datalink_name_to_val(const char *); 199const char *pcap_datalink_val_to_name(int); 200const char *pcap_datalink_val_to_description(int); 201int pcap_snapshot(pcap_t *); 202int pcap_is_swapped(pcap_t *); 203int pcap_major_version(pcap_t *); 204int pcap_minor_version(pcap_t *); 205 206/* XXX */ 207FILE *pcap_file(pcap_t *); 208int pcap_fileno(pcap_t *); 209 210pcap_dumper_t *pcap_dump_open(pcap_t *, const char *); 211int pcap_dump_flush(pcap_dumper_t *); 212void pcap_dump_close(pcap_dumper_t *); 213void pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *); 214FILE *pcap_dump_file(pcap_dumper_t *); 215 216int pcap_findalldevs(pcap_if_t **, char *); 217void pcap_freealldevs(pcap_if_t *); 218 219const char *pcap_lib_version(void); 220 221/* XXX this guy lives in the bpf tree */ 222u_int bpf_filter(struct bpf_insn *, u_char *, u_int, u_int); 223int bpf_validate(struct bpf_insn *f, int len); 224char *bpf_image(struct bpf_insn *, int); 225void bpf_dump(struct bpf_program *, int); 226 227#ifdef WIN32 228/* 229 * Win32 definitions 230 */ 231 232int pcap_setbuff(pcap_t *p, int dim); 233int pcap_setmode(pcap_t *p, int mode); 234int pcap_sendpacket(pcap_t *p, u_char *buf, int size); 235int pcap_setmintocopy(pcap_t *p, int size); 236 237#ifdef WPCAP 238/* Include file with the wpcap-specific extensions */ 239#include <Win32-Extensions.h> 240#endif 241 242#define MODE_CAPT 0 243#define MODE_STAT 1 244#define MODE_MON 2 245 246#else 247/* 248 * UN*X definitions 249 */ 250 251int pcap_get_selectable_fd(pcap_t *); 252 253#endif /* WIN32 */ 254 255#ifdef __cplusplus 256} 257#endif 258 259#endif 260