From Tom Brezinski:
[obnox/wireshark/wip.git] / capture_ifinfo.h
1 /* capture_ifinfo.h
2  * Definitions for routines to get information about capture interfaces
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 __CAPTURE_IFINFO_H__
26 #define __CAPTURE_IFINFO_H__
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif /* __cplusplus */
31
32 /*
33  * The list of interfaces returned by "get_interface_list()" is
34  * a list of these structures.
35  */
36 typedef struct {
37         char    *name;          /* e.g. "eth0" */
38         char    *description;   /* from OS, e.g. "Local Area Connection" or NULL */
39         GSList  *addrs;         /* containing address values of if_addr_t */
40         gboolean loopback;      /* TRUE if loopback, FALSE otherwise */
41 } if_info_t;
42
43 /*
44  * An address in the "addrs" list.
45  */
46 typedef enum {
47         IF_AT_IPv4,
48         IF_AT_IPv6
49 } if_address_type;
50
51 typedef struct {
52         if_address_type ifat_type;
53         union {
54                 guint32 ip4_addr;   /*  4 byte IP V4 address, or */
55                 guint8 ip6_addr[16];/* 16 byte IP V6 address */
56         } addr;
57 } if_addr_t;
58
59 /**
60  * Fetch the interface list from a child process.
61  */
62 extern GList *capture_interface_list(int *err, char **err_str);
63
64 /* Error values from "get_interface_list()/capture_interface_list()". */
65 #define CANT_GET_INTERFACE_LIST 1       /* error getting list */
66 #define NO_INTERFACES_FOUND     2       /* list is empty */
67 #define DONT_HAVE_PCAP          3       /* couldn't load WinPcap */
68
69 void free_interface_list(GList *if_list);
70
71 /*
72  * "get_if_capabilities()" and "capture_if_capabilities()" return a pointer
73  * to an allocated instance of this structure.  "free_if_capabilities()"
74  * frees the returned instance.
75  */
76 typedef struct {
77         gboolean        can_set_rfmon;  /* TRUE if can be put into monitor mode */
78         GList           *data_link_types;       /* GList of data_link_info_t's */
79 } if_capabilities_t;
80
81 /*
82  * Information about data link types.
83  */
84 typedef struct {
85         int     dlt;            /* e.g. DLT_EN10MB (which is 1) */
86         char    *name;          /* e.g. "EN10MB" or "DLT 1" */
87         char    *description;   /* descriptive name from wiretap e.g. "Ethernet", NULL if unknown */
88 } data_link_info_t;
89
90 /**
91  * Fetch the linktype list for the specified interface from a child process.
92  */
93 extern if_capabilities_t *
94 capture_get_if_capabilities(const char *devname, gboolean monitor_mode,
95                             char **err_str);
96
97 void free_if_capabilities(if_capabilities_t *caps);
98
99 void add_interface_to_remote_list(if_info_t *if_info);
100
101 #ifdef __cplusplus
102 }
103 #endif /* __cplusplus */
104
105 #endif /* __CAPTURE_IFINFO_H__ */