Added svn:ignore targets.
[obnox/wireshark/wip.git] / capture-pcap-util.h
1 /* capture-pcap-util.h
2  * Utility definitions for packet capture
3  *
4  * $Id$
5  *
6  * Wireshark - Network traffic analyzer
7  * By Gerald Combs <gerald@wireshark.org>
8  * Copyright 1998 Gerald Combs
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23  */
24
25 #ifndef __PCAP_UTIL_H__
26 #define __PCAP_UTIL_H__
27
28 #ifdef HAVE_LIBPCAP
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif /* __cplusplus */
33
34 #include <epan/address.h>
35
36 #include <pcap.h>
37
38 /*
39  * A snapshot length of 0 is useless - and libpcap/WinPcap don't guarantee
40  * that a snapshot length of 0 will work, and, on some platforms, it won't
41  * (with BPF, for example, the kernel is told the snapshot length via the
42  * return value of the BPF program, and a return value of 0 means "drop
43  * the packet"), so the minimum packet size is 1 byte.
44  */
45 #define MIN_PACKET_SIZE 1       /* minimum amount of packet data we can read */
46
47 /*
48  * The list of interfaces returned by "get_interface_list()" is
49  * a list of these structures.
50  */
51 typedef struct {
52         char    *name;          /* e.g. "eth0" */
53         char    *description;   /* from OS, e.g. "Local Area Connection" or NULL */
54         GSList  *ip_addr;       /* containing address values of if_addr_t */
55         gboolean loopback;      /* TRUE if loopback, FALSE otherwise */
56 } if_info_t;
57
58 /*
59  * An address in the "ip_addr" list.
60  */
61 typedef struct {
62         address_type type;      /* AT_IPv4 or AT_IPv6 */
63         union {
64                 guint32 ip4_addr;   /*  4 byte IP V4 address, or */
65                 guint8 ip6_addr[16];/* 16 byte IP V6 address */
66         } ip_addr;
67 } if_addr_t;
68
69 GList *get_interface_list(int *err, char **err_str);
70 #ifdef HAVE_PCAP_REMOTE
71 GList *get_remote_interface_list(const char *hostname, const char *port,
72                                  int auth_type, const char *username,
73                                  const char *passwd, int *err, char **err_str);
74 #endif
75
76 /* Error values from "get_interface_list()/capture_interface_list()". */
77 #define CANT_GET_INTERFACE_LIST 1       /* error getting list */
78 #define NO_INTERFACES_FOUND     2       /* list is empty */
79 #define CANT_RUN_DUMPCAP        3       /* problem running dumpcap */
80
81 void free_interface_list(GList *if_list);
82
83 /*
84  * The list of data link types returned by "get_pcap_linktype_list()" is
85  * a list of these structures.
86  */
87 typedef struct {
88         int     dlt;                /* e.g. DLT_EN10MB (which is 1) */
89         char    *name;          /* e.g. "EN10MB" or "DLT 1" */
90         char    *description;   /* descriptive name from wiretap e.g. "Ethernet", NULL if unknown */
91 } data_link_info_t;
92
93 GList *get_pcap_linktype_list(const char *devname, char **err_str);
94 void free_pcap_linktype_list(GList *linktype_list);
95
96 /* get/set the link type of an interface */
97 /* (only used in capture_loop.c / capture-pcap-util.c) */
98 int get_pcap_linktype(pcap_t *pch, const char *devname);
99
100
101 const char *linktype_val_to_name(int dlt);
102 int linktype_name_to_val(const char *linktype);
103
104 #ifdef __cplusplus
105 }
106 #endif /* __cplusplus */
107
108 #endif /* HAVE_LIBPCAP */
109
110 /*
111  * Append to a GString an indication of the version of libpcap/WinPcap
112  * with which we were compiled, if we were, or an indication that we
113  * weren't compiled with libpcap/WinPcap, if we weren't.
114  */
115 extern void get_compiled_pcap_version(GString *str);
116
117 /*
118  * Append to a GString an indication of the version of libpcap/WinPcap
119  * with which we're running, or an indication that we're not running
120  * with libpcap/WinPcap, if we were compiled with libpcap/WinPcap,
121  * or nothing, if we weren't compiled with libpcap/WinPcap.
122  */
123 extern void get_runtime_pcap_version(GString *str);
124
125 #endif /* __PCAP_UTIL_H__ */