1/* 2 * Copyright (c) 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: /tcpdump/master/libpcap/pcap-int.h,v 1.94 2008-09-16 00:20:23 guy Exp $ (LBL) 34 */ 35 36#ifndef pcap_int_h 37#define pcap_int_h 38 39#include <pcap/pcap.h> 40#include "pcap-ng.h" 41 42#ifdef __cplusplus 43extern "C" { 44#endif 45 46#ifdef WIN32 47#include <Packet32.h> 48extern CRITICAL_SECTION g_PcapCompileCriticalSection; 49#endif /* WIN32 */ 50 51#ifdef MSDOS 52#include <fcntl.h> 53#include <io.h> 54#endif 55 56#if (defined(_MSC_VER) && (_MSC_VER <= 1200)) /* we are compiling with Visual Studio 6, that doesn't support the LL suffix*/ 57 58/* 59 * Swap byte ordering of unsigned long long timestamp on a big endian 60 * machine. 61 */ 62#define SWAPLL(ull) ((ull & 0xff00000000000000) >> 56) | \ 63 ((ull & 0x00ff000000000000) >> 40) | \ 64 ((ull & 0x0000ff0000000000) >> 24) | \ 65 ((ull & 0x000000ff00000000) >> 8) | \ 66 ((ull & 0x00000000ff000000) << 8) | \ 67 ((ull & 0x0000000000ff0000) << 24) | \ 68 ((ull & 0x000000000000ff00) << 40) | \ 69 ((ull & 0x00000000000000ff) << 56) 70 71#else /* A recent Visual studio compiler or not VC */ 72 73/* 74 * Swap byte ordering of unsigned long long timestamp on a big endian 75 * machine. 76 */ 77#define SWAPLL(ull) ((ull & 0xff00000000000000LL) >> 56) | \ 78 ((ull & 0x00ff000000000000LL) >> 40) | \ 79 ((ull & 0x0000ff0000000000LL) >> 24) | \ 80 ((ull & 0x000000ff00000000LL) >> 8) | \ 81 ((ull & 0x00000000ff000000LL) << 8) | \ 82 ((ull & 0x0000000000ff0000LL) << 24) | \ 83 ((ull & 0x000000000000ff00LL) << 40) | \ 84 ((ull & 0x00000000000000ffLL) << 56) 85 86#endif /* _MSC_VER */ 87 88struct pcap_opt { 89 char *source; 90 int timeout; /* timeout for buffering */ 91 int buffer_size; 92 int promisc; 93 int rfmon; /* monitor mode */ 94 int immediate; /* immediate mode - deliver packets as soon as they arrive */ 95 int tstamp_type; 96 int tstamp_precision; 97}; 98 99typedef int (*activate_op_t)(pcap_t *); 100typedef int (*can_set_rfmon_op_t)(pcap_t *); 101typedef int (*read_op_t)(pcap_t *, int cnt, pcap_handler, u_char *); 102typedef int (*inject_op_t)(pcap_t *, const void *, size_t); 103typedef int (*setfilter_op_t)(pcap_t *, struct bpf_program *); 104typedef int (*setdirection_op_t)(pcap_t *, pcap_direction_t); 105typedef int (*set_datalink_op_t)(pcap_t *, int); 106typedef int (*getnonblock_op_t)(pcap_t *, char *); 107typedef int (*setnonblock_op_t)(pcap_t *, int, char *); 108typedef int (*stats_op_t)(pcap_t *, struct pcap_stat *); 109#ifdef WIN32 110typedef int (*setbuff_op_t)(pcap_t *, int); 111typedef int (*setmode_op_t)(pcap_t *, int); 112typedef int (*setmintocopy_op_t)(pcap_t *, int); 113typedef Adapter *(*getadapter_op_t)(pcap_t *); 114#endif 115typedef void (*cleanup_op_t)(pcap_t *); 116typedef void (*cleanup_interface_op_t)(const char *); 117 118struct pcap_if_info; 119struct pcap_proc_info; 120 121/* 122 * We put all the stuff used in the read code path at the beginning, 123 * to try to keep it together in the same cache line or lines. 124 */ 125struct pcap { 126 /* 127 * Method to call to read packets on a live capture. 128 */ 129 read_op_t read_op; 130 131 /* 132 * Method to call to read to read packets from a savefile. 133 */ 134 int (*next_packet_op)(pcap_t *, struct pcap_pkthdr *, u_char **); 135 136#ifdef WIN32 137 ADAPTER *adapter; 138 LPPACKET Packet; 139 int nonblock; 140#else 141 int fd; 142 int selectable_fd; 143#endif /* WIN32 */ 144 145 /* 146 * Read buffer. 147 */ 148 int bufsize; 149 u_char *buffer; 150 u_char *bp; 151 int cc; 152 153 int break_loop; /* flag set to force break from packet-reading loop */ 154 155 void *priv; /* private data for methods */ 156 157 int swapped; 158 FILE *rfile; /* null if live capture, non-null if savefile */ 159 int fddipad; 160 struct pcap *next; /* list of open pcaps that need stuff cleared on close */ 161 162 /* 163 * File version number; meaningful only for a savefile, but we 164 * keep it here so that apps that (mistakenly) ask for the 165 * version numbers will get the same zero values that they 166 * always did. 167 */ 168 int version_major; 169 int version_minor; 170 171 int snapshot; 172 int linktype; /* Network linktype */ 173 int linktype_ext; /* Extended information stored in the linktype field of a file */ 174 int tzoff; /* timezone offset */ 175 int offset; /* offset for proper alignment */ 176 int activated; /* true if the capture is really started */ 177 int oldstyle; /* if we're opening with pcap_open_live() */ 178 179 struct pcap_opt opt; 180 181 /* 182 * Place holder for pcap_next(). 183 */ 184 u_char *pkt; 185 186 /* We're accepting only packets in this direction/these directions. */ 187 pcap_direction_t direction; 188 189 /* 190 * Placeholder for filter code if bpf not in kernel. 191 */ 192 struct bpf_program fcode; 193 194 char errbuf[PCAP_ERRBUF_SIZE + 1]; 195 int dlt_count; 196 u_int *dlt_list; 197 int tstamp_type_count; 198 u_int *tstamp_type_list; 199 int tstamp_precision_count; 200 u_int *tstamp_precision_list; 201 202 struct pcap_pkthdr pcap_header; /* This is needed for the pcap_next_ex() to work */ 203 204 /* 205 * More methods. 206 */ 207 activate_op_t activate_op; 208 can_set_rfmon_op_t can_set_rfmon_op; 209 inject_op_t inject_op; 210 setfilter_op_t setfilter_op; 211 setdirection_op_t setdirection_op; 212 set_datalink_op_t set_datalink_op; 213 getnonblock_op_t getnonblock_op; 214 setnonblock_op_t setnonblock_op; 215 stats_op_t stats_op; 216 217 /* 218 * Routine to use as callback for pcap_next()/pcap_next_ex(). 219 */ 220 pcap_handler oneshot_callback; 221 222#ifdef WIN32 223 /* 224 * These are, at least currently, specific to the Win32 NPF 225 * driver. 226 */ 227 setbuff_op_t setbuff_op; 228 setmode_op_t setmode_op; 229 setmintocopy_op_t setmintocopy_op; 230 getadapter_op_t getadapter_op; 231#endif 232 cleanup_op_t cleanup_op; 233 234 /* 235 * Apple additions below 236 */ 237 int extendedhdr; 238 int wantpktap; 239 240 cleanup_interface_op_t cleanup_interface_op; 241 242 char *filter_str; 243 244 int shb_added; 245 246 int if_info_count; 247 struct pcap_if_info **if_infos; 248 249 int proc_info_count; 250 struct pcap_proc_info **proc_infos; 251 252 cleanup_op_t cleanup_extra_op; 253}; 254 255/* 256 * This is a timeval as stored in a savefile. 257 * It has to use the same types everywhere, independent of the actual 258 * `struct timeval'; `struct timeval' has 32-bit tv_sec values on some 259 * platforms and 64-bit tv_sec values on other platforms, and writing 260 * out native `struct timeval' values would mean files could only be 261 * read on systems with the same tv_sec size as the system on which 262 * the file was written. 263 */ 264 265struct pcap_timeval { 266 bpf_int32 tv_sec; /* seconds */ 267 bpf_int32 tv_usec; /* microseconds */ 268}; 269 270/* 271 * This is a `pcap_pkthdr' as actually stored in a savefile. 272 * 273 * Do not change the format of this structure, in any way (this includes 274 * changes that only affect the length of fields in this structure), 275 * and do not make the time stamp anything other than seconds and 276 * microseconds (e.g., seconds and nanoseconds). Instead: 277 * 278 * introduce a new structure for the new format; 279 * 280 * send mail to "tcpdump-workers@lists.tcpdump.org", requesting 281 * a new magic number for your new capture file format, and, when 282 * you get the new magic number, put it in "savefile.c"; 283 * 284 * use that magic number for save files with the changed record 285 * header; 286 * 287 * make the code in "savefile.c" capable of reading files with 288 * the old record header as well as files with the new record header 289 * (using the magic number to determine the header format). 290 * 291 * Then supply the changes by forking the branch at 292 * 293 * https://github.com/the-tcpdump-group/libpcap/issues 294 * 295 * and issuing a pull request, so that future versions of libpcap and 296 * programs that use it (such as tcpdump) will be able to read your new 297 * capture file format. 298 */ 299 300struct pcap_sf_pkthdr { 301 struct pcap_timeval ts; /* time stamp */ 302 bpf_u_int32 caplen; /* length of portion present */ 303 bpf_u_int32 len; /* length this packet (off wire) */ 304}; 305 306/* 307 * How a `pcap_pkthdr' is actually stored in savefiles written 308 * by some patched versions of libpcap (e.g. the ones in Red 309 * Hat Linux 6.1 and 6.2). 310 * 311 * Do not change the format of this structure, in any way (this includes 312 * changes that only affect the length of fields in this structure). 313 * Instead, introduce a new structure, as per the above. 314 */ 315 316struct pcap_sf_patched_pkthdr { 317 struct pcap_timeval ts; /* time stamp */ 318 bpf_u_int32 caplen; /* length of portion present */ 319 bpf_u_int32 len; /* length this packet (off wire) */ 320 int index; 321 unsigned short protocol; 322 unsigned char pkt_type; 323}; 324 325/* 326 * User data structure for the one-shot callback used for pcap_next() 327 * and pcap_next_ex(). 328 */ 329struct oneshot_userdata { 330 struct pcap_pkthdr *hdr; 331 const u_char **pkt; 332 pcap_t *pd; 333}; 334 335int yylex(void); 336 337#ifndef min 338#define min(a, b) ((a) > (b) ? (b) : (a)) 339#endif 340 341/* XXX should these be in pcap.h? */ 342int pcap_offline_read(pcap_t *, int, pcap_handler, u_char *); 343int pcap_read(pcap_t *, int cnt, pcap_handler, u_char *); 344 345int pcap_ng_offline_read(pcap_t *, int , pcap_handler , u_char *); 346 347#ifndef HAVE_STRLCPY 348#define strlcpy(x, y, z) \ 349 (strncpy((x), (y), (z)), \ 350 ((z) <= 0 ? 0 : ((x)[(z) - 1] = '\0')), \ 351 strlen((y))) 352#endif 353 354#include <stdarg.h> 355 356#if !defined(HAVE_SNPRINTF) 357#define snprintf pcap_snprintf 358extern int snprintf (char *, size_t, const char *, ...); 359#endif 360 361#if !defined(HAVE_VSNPRINTF) 362#define vsnprintf pcap_vsnprintf 363extern int vsnprintf (char *, size_t, const char *, va_list ap); 364#endif 365 366/* 367 * Does the packet count argument to a module's read routine say 368 * "supply packets until you run out of packets"? 369 */ 370#define PACKET_COUNT_IS_UNLIMITED(count) ((count) <= 0) 371 372/* 373 * Routines that most pcap implementations can use for non-blocking mode. 374 */ 375#if !defined(WIN32) && !defined(MSDOS) 376int pcap_getnonblock_fd(pcap_t *, char *); 377int pcap_setnonblock_fd(pcap_t *p, int, char *); 378#endif 379 380/* 381 * Internal interfaces for "pcap_create()". 382 * 383 * "pcap_create_interface()" is the routine to do a pcap_create on 384 * a regular network interface. There are multiple implementations 385 * of this, one for each platform type (Linux, BPF, DLPI, etc.), 386 * with the one used chosen by the configure script. 387 * 388 * "pcap_create_common()" allocates and fills in a pcap_t, for use 389 * by pcap_create routines. 390 */ 391pcap_t *pcap_create_interface(const char *, char *); 392pcap_t *pcap_create_common(const char *, char *, size_t); 393int pcap_do_addexit(pcap_t *); 394void pcap_add_to_pcaps_to_close(pcap_t *); 395void pcap_remove_from_pcaps_to_close(pcap_t *); 396void pcap_cleanup_live_common(pcap_t *); 397int pcap_not_initialized(pcap_t *); 398int pcap_check_activated(pcap_t *); 399 400/* 401 * Internal interfaces for "pcap_findalldevs()". 402 * 403 * "pcap_findalldevs_interfaces()" finds interfaces using the 404 * "standard" mechanisms (SIOCGIFCONF, "getifaddrs()", etc.). 405 * 406 * "pcap_platform_finddevs()" is a platform-dependent routine to 407 * add devices not found by the "standard" mechanisms. 408 * 409 * "pcap_add_if()" adds an interface to the list of interfaces, for 410 * use by various "find interfaces" routines. 411 */ 412int pcap_findalldevs_interfaces(pcap_if_t **, char *); 413int pcap_platform_finddevs(pcap_if_t **, char *); 414int add_addr_to_iflist(pcap_if_t **, const char *, u_int, struct sockaddr *, 415 size_t, struct sockaddr *, size_t, struct sockaddr *, size_t, 416 struct sockaddr *, size_t, char *); 417int pcap_add_if(pcap_if_t **, const char *, u_int, const char *, char *); 418struct sockaddr *dup_sockaddr(struct sockaddr *, size_t); 419int add_or_find_if(pcap_if_t **, pcap_if_t **, const char *, u_int, 420 const char *, char *); 421 422/* 423 * Internal interfaces for "pcap_open_offline()". 424 * 425 * "pcap_open_offline_common()" allocates and fills in a pcap_t, for use 426 * by pcap_open_offline routines. 427 * 428 * "sf_cleanup()" closes the file handle associated with a pcap_t, if 429 * appropriate, and frees all data common to all modules for handling 430 * savefile types. 431 */ 432pcap_t *pcap_open_offline_common(char *ebuf, size_t size); 433void sf_cleanup(pcap_t *p); 434 435/* 436 * Internal interfaces for both "pcap_create()" and routines that 437 * open savefiles. 438 * 439 * "pcap_oneshot()" is the standard one-shot callback for "pcap_next()" 440 * and "pcap_next_ex()". 441 */ 442void pcap_oneshot(u_char *, const struct pcap_pkthdr *, const u_char *); 443 444#ifdef WIN32 445char *pcap_win32strerror(void); 446#endif 447 448int install_bpf_program(pcap_t *, struct bpf_program *); 449 450int pcap_strcasecmp(const char *, const char *); 451 452#ifdef __cplusplus 453} 454#endif 455 456#endif 457