capture_loop.h

   1 /* capture_loop.h
   2  * Do the low-level work of a 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
  26 /** @file
  27  *
  28  *  Do the low-level work of a capture.
  29  *
  30  */
  31
  32 #ifndef __CAPTURE_LOOP_H__
  33 #define __CAPTURE_LOOP_H__
  34
  35 /*
  36  * Get information about libpcap format from "wiretap/libpcap.h".
  37  * XXX - can we just use pcap_open_offline() to read the pipe?
  38  */
  39 #include "wiretap/libpcap.h"
  40
  41 /** Do the low-level work of a capture.
  42  *  Returns TRUE if it succeeds, FALSE otherwise. */
  43 extern int  capture_loop_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats);
  44
  45 /** Stop a low-level capture (stops the capture child). */
  46 extern void capture_loop_stop(void);
  47
  48
  49 /*** the following is internal only (should be moved to capture_loop_int.h) ***/
  50
  51
  52 #ifndef HAVE_PCAP_BREAKLOOP
  53 /*
  54  * We don't have pcap_breakloop(), which is the only way to ensure that
  55  * pcap_dispatch(), pcap_loop(), or even pcap_next() or pcap_next_ex()
  56  * won't, if the call to read the next packet or batch of packets is
  57  * is interrupted by a signal on UN*X, just go back and try again to
  58  * read again.
  59  *
  60  * On UN*X, we catch SIGUSR1 as a "stop capturing" signal, and, in
  61  * the signal handler, set a flag to stop capturing; however, without
  62  * a guarantee of that sort, we can't guarantee that we'll stop capturing
  63  * if the read will be retried and won't time out if no packets arrive.
  64  *
  65  * Therefore, on at least some platforms, we work around the lack of
  66  * pcap_breakloop() by doing a select() on the pcap_t's file descriptor
  67  * to wait for packets to arrive, so that we're probably going to be
  68  * blocked in the select() when the signal arrives, and can just bail
  69  * out of the loop at that point.
  70  *
  71  * However, we don't want to that on BSD (because "select()" doesn't work
  72  * correctly on BPF devices on at least some releases of some flavors of
  73  * BSD), and we don't want to do it on Windows (because "select()" is
  74  * something for sockets, not for arbitrary handles).  (Note that "Windows"
  75  * here includes Cygwin; even in its pretend-it's-UNIX environment, we're
  76  * using WinPcap, not a UNIX libpcap.)
  77  *
  78  * Fortunately, we don't need to do it on BSD, because the libpcap timeout
  79  * on BSD times out even if no packets have arrived, so we'll eventually
  80  * exit pcap_dispatch() with an indication that no packets have arrived,
  81  * and will break out of the capture loop at that point.
  82  *
  83  * On Windows, we can't send a SIGUSR1 to stop capturing, so none of this
  84  * applies in any case.
  85  *
  86  * XXX - the various BSDs appear to define BSD in <sys/param.h>; we don't
  87  * want to include it if it's not present on this platform, however.
  88  */
  89 # if !defined(__FreeBSD__) && !defined(__NetBSD__) && !defined(__OpenBSD__) && \
  90     !defined(__bsdi__) && !defined(__APPLE__) && !defined(_WIN32) && \
  91     !defined(__CYGWIN__)
  92 #  define MUST_DO_SELECT
  93 # endif /* avoid select */
  94 #endif /* HAVE_PCAP_BREAKLOOP */
  95
  96 typedef void (*capture_packet_cb_fct)(u_char *, const struct pcap_pkthdr *, const u_char *);
  97
  98
  99 /* moved from capture_loop.c here, so we can combine it (and the related functions) with tshark */
 100 /* XXX - should be moved back to capture_loop.c */
 101 /* E: capture_loop.c only (Wireshark/dumpcap) T: tshark only */
 102 typedef struct _loop_data {
 103   /* common */
 104   gboolean       go;                    /* TRUE as long as we're supposed to keep capturing */
 105   int            err;                   /* E: if non-zero, error seen while capturing */
 106   gint           packet_count;          /* Number of packets we have already captured */
 107   gint           packet_max;            /* E: Number of packets we're supposed to capture - 0 means infinite */
 108
 109   jmp_buf        stopenv;               /* T: starting point of loop (jump back this point on SIG...) */
 110
 111   char          *save_file;             /* T: Name of file to which we're writing */
 112   capture_packet_cb_fct  packet_cb;     /* callback for a single captured packet */
 113
 114   /* pcap "input file" */
 115   pcap_t        *pcap_h;                /* pcap handle */
 116   gboolean       pcap_err;              /* E: TRUE if error from pcap */
 117 #ifdef MUST_DO_SELECT
 118   int            pcap_fd;               /* pcap file descriptor */
 119 #endif
 120
 121   /* capture pipe (unix only "input file") */
 122   gboolean       from_cap_pipe;         /* TRUE if we are capturing data from a capture pipe */
 123   struct pcap_hdr cap_pipe_hdr;         /* ? */
 124   struct pcaprec_modified_hdr cap_pipe_rechdr;  /* ? */
 125   int            cap_pipe_fd;           /* the file descriptor of the capture pipe */
 126   gboolean       cap_pipe_modified;     /* TRUE if data in the pipe uses modified pcap headers */
 127   gboolean       cap_pipe_byte_swapped; /* TRUE if data in the pipe is byte swapped */
 128   unsigned int   cap_pipe_bytes_to_read;/* Used by cap_pipe_dispatch */
 129   unsigned int   cap_pipe_bytes_read;   /* Used by cap_pipe_dispatch */
 130   enum {
 131          STATE_EXPECT_REC_HDR,
 132          STATE_READ_REC_HDR,
 133          STATE_EXPECT_DATA,
 134          STATE_READ_DATA
 135        } cap_pipe_state;
 136   enum { PIPOK, PIPEOF, PIPERR, PIPNEXIST } cap_pipe_err;
 137
 138   /* output file */
 139   FILE          *pdh;
 140   int            linktype;
 141   gint           wtap_linktype;
 142   long           bytes_written;
 143
 144 } loop_data;
 145
 146
 147
 148 /** init the capture filter */
 149 typedef enum {
 150   INITFILTER_NO_ERROR,
 151   INITFILTER_BAD_FILTER,
 152   INITFILTER_OTHER_ERROR
 153 } initfilter_status_t;
 154
 155 extern initfilter_status_t
 156 capture_loop_init_filter(pcap_t *pcap_h, gboolean from_cap_pipe, const gchar * iface, gchar * cfilter);
 157
 158 int
 159 capture_loop_dispatch(capture_options *capture_opts _U_, loop_data *ld,
 160                       char *errmsg, int errmsg_len);
 161
 162 extern gboolean
 163 capture_loop_open_input(capture_options *capture_opts, loop_data *ld,
 164                         char *errmsg, size_t errmsg_len,
 165                         char *secondary_errmsg, size_t secondary_errmsg_len);
 166
 167 extern gboolean
 168 capture_loop_open_output(capture_options *capture_opts, int *save_file_fd, char *errmsg, int errmsg_len);
 169
 170 extern gboolean
 171 capture_loop_init_output(capture_options *capture_opts, int save_file_fd, loop_data *ld, char *errmsg, int errmsg_len);
 172
 173 extern gboolean
 174 capture_loop_close_output(capture_options *capture_opts, loop_data *ld, int *err_close);
 175
 176 /*
 177  * Routines called by the capture loop code to report things.
 178  */
 179
 180 /** Report a new capture file having been opened. */
 181 extern void
 182 report_new_capture_file(const char *filename);
 183
 184 /** Report a number of new packets captured. */
 185 extern void
 186 report_packet_count(int packet_count);
 187
 188 /** Report the packet drops once the capture finishes. */
 189 extern void
 190 report_packet_drops(int drops);
 191
 192 /** Report an error in the capture. */
 193 extern void
 194 report_capture_error(const char *error_msg, const char *secondary_error_msg);
 195
 196 /** Report an error with a capture filter. */
 197 extern void
 198 report_cfilter_error(const char *cfilter, const char *errmsg);
 199
 200
 201 #endif /* capture_loop.h */