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