351214282d
to prevent problems, bring the main GUI into "capture mode" right after successfully spawn/exec the capture child, without waiting for any response from it svn path=/trunk/; revision=14436
456 lines
12 KiB
C
456 lines
12 KiB
C
/* file.h
|
|
* Definitions for file structures and routines
|
|
*
|
|
* $Id$
|
|
*
|
|
* Ethereal - Network traffic analyzer
|
|
* By Gerald Combs <gerald@ethereal.com>
|
|
* Copyright 1998 Gerald Combs
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
*/
|
|
|
|
#ifndef __FILE_H__
|
|
#define __FILE_H__
|
|
|
|
#include "packet-range.h"
|
|
#include "wiretap/wtap.h"
|
|
#include <epan/dfilter/dfilter.h>
|
|
#include "print.h"
|
|
#include <errno.h>
|
|
#include <epan/epan.h>
|
|
|
|
#include "cfile.h"
|
|
|
|
|
|
/** Return values from functions that only can succeed or fail. */
|
|
typedef enum {
|
|
CF_OK, /**< operation succeeded */
|
|
CF_ERROR /**< operation got an error (function may provide err with details) */
|
|
} cf_status_t;
|
|
|
|
/** Return values from functions that read capture files. */
|
|
typedef enum {
|
|
CF_READ_OK, /**< operation succeeded */
|
|
CF_READ_ERROR, /**< operation got an error (function may provide err with details) */
|
|
CF_READ_ABORTED /**< operation aborted by user */
|
|
} cf_read_status_t;
|
|
|
|
/** Return values from functions that print sets of packets. */
|
|
typedef enum {
|
|
CF_PRINT_OK, /**< print operation succeeded */
|
|
CF_PRINT_OPEN_ERROR, /**< print operation failed while opening printer */
|
|
CF_PRINT_WRITE_ERROR /**< print operation failed while writing to the printer */
|
|
} cf_print_status_t;
|
|
|
|
typedef enum {
|
|
cf_cb_file_closed,
|
|
cf_cb_file_read_start,
|
|
cf_cb_file_read_finished,
|
|
#ifdef HAVE_LIBPCAP
|
|
cf_cb_live_capture_prepared,
|
|
cf_cb_live_capture_update_started,
|
|
cf_cb_live_capture_update_continue,
|
|
cf_cb_live_capture_update_finished,
|
|
cf_cb_live_capture_fixed_started,
|
|
cf_cb_live_capture_fixed_finished,
|
|
#endif
|
|
cf_cb_packet_selected,
|
|
cf_cb_packet_unselected,
|
|
cf_cb_field_unselected,
|
|
cf_cb_file_safe_started,
|
|
cf_cb_file_safe_finished,
|
|
cf_cb_file_safe_reload_finished,
|
|
cf_cb_file_safe_failed
|
|
} cf_cbs;
|
|
|
|
typedef void (*cf_callback_t) (gint event, gpointer data, gpointer user_data);
|
|
|
|
extern void
|
|
cf_callback_invoke(int event, gpointer data);
|
|
|
|
extern void
|
|
cf_callback_add(cf_callback_t func, gpointer user_data);
|
|
|
|
extern void
|
|
cf_callback_remove(cf_callback_t func);
|
|
|
|
/**
|
|
* Open a capture file.
|
|
*
|
|
* @param cf the capture file to be opened
|
|
* @param fname the filename to be opened
|
|
* @param is_tempfile is this a temporary file?
|
|
* @return one of cf_status_t
|
|
*/
|
|
cf_status_t cf_open(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
|
|
|
|
/**
|
|
* Close a capture file.
|
|
*
|
|
* @param cf the capture file to be closed
|
|
*/
|
|
void cf_close(capture_file *cf);
|
|
|
|
/**
|
|
* Reload a capture file.
|
|
*
|
|
* @param cf the capture file to be reloaded
|
|
*/
|
|
void cf_reload(capture_file *cf);
|
|
|
|
/**
|
|
* Read all packets of a capture file into the internal structures.
|
|
*
|
|
* @param cf the capture file to be read
|
|
* @return one of cf_read_status_t
|
|
*/
|
|
cf_read_status_t cf_read(capture_file *cf);
|
|
|
|
/**
|
|
* Start reading from the end of a capture file.
|
|
* This is used in "Update list of packets in Real-Time".
|
|
*
|
|
* @param cf the capture file to be read from
|
|
* @param fname the filename to be read from
|
|
* @param is_tempfile is this a temporary file?
|
|
* @param err the error code, if an error had occured
|
|
* @return one of cf_status_t
|
|
*/
|
|
cf_status_t cf_start_tail(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
|
|
|
|
/**
|
|
* Read packets from the "end" of a capture file.
|
|
*
|
|
* @param cf the capture file to be read from
|
|
* @param to_read the number of packets to read
|
|
* @param err the error code, if an error had occured
|
|
* @return one of cf_read_status_t
|
|
*/
|
|
cf_read_status_t cf_continue_tail(capture_file *cf, int to_read, int *err);
|
|
|
|
/**
|
|
* Finish reading from "end" of a capture file.
|
|
*
|
|
* @param cf the capture file to be read from
|
|
* @param err the error code, if an error had occured
|
|
* @return one of cf_read_status_t
|
|
*/
|
|
cf_read_status_t cf_finish_tail(capture_file *cf, int *err);
|
|
|
|
/**
|
|
* Save a capture file (or a range of it).
|
|
*
|
|
* @param cf the capture file to save to
|
|
* @param fname the filename to save to
|
|
* @param range the range of packets to save
|
|
* @param save_format the format of the file to save (libpcap, ...)
|
|
* @return one of cf_status_t
|
|
*/
|
|
cf_status_t cf_save(capture_file * cf, const char *fname, packet_range_t *range, guint save_format);
|
|
|
|
/**
|
|
* Get a displayable name of the capture file.
|
|
*
|
|
* @param cf the capture file
|
|
* @return the displayable name (don't have to be g_free'd)
|
|
*/
|
|
const gchar *cf_get_display_name(capture_file *cf);
|
|
|
|
/**
|
|
* Get the number of packets in the capture file.
|
|
*
|
|
* @param cf the capture file
|
|
* @return the number of packets in the capture file
|
|
*/
|
|
int cf_packet_count(capture_file *cf);
|
|
|
|
/**
|
|
* Is this capture file a temporary file?
|
|
*
|
|
* @param cf the capture file
|
|
* @return TRUE if it's a temporary file, FALSE otherwise
|
|
*/
|
|
gboolean cf_is_tempfile(capture_file *cf);
|
|
|
|
/**
|
|
* Set flag, that this file is a tempfile.
|
|
*/
|
|
void cf_set_tempfile(capture_file *cf, gboolean is_tempfile);
|
|
|
|
/**
|
|
* Set flag, if the number of packet drops while capturing are known or not.
|
|
*
|
|
* @param cf the capture file
|
|
* @param drops_known TRUE if the number of packet drops are known, FALSE otherwise
|
|
*/
|
|
void cf_set_drops_known(capture_file *cf, gboolean drops_known);
|
|
|
|
/**
|
|
* Set the number of packet drops while capturing.
|
|
*
|
|
* @param cf the capture file
|
|
* @param drops the number of packet drops occured while capturing
|
|
*/
|
|
void cf_set_drops(capture_file *cf, guint32 drops);
|
|
|
|
/**
|
|
* Get flag state, if the number of packet drops while capturing are known or not.
|
|
*
|
|
* @param cf the capture file
|
|
* @return TRUE if the number of packet drops are known, FALSE otherwise
|
|
*/
|
|
gboolean cf_get_drops_known(capture_file *cf);
|
|
|
|
/**
|
|
* Get the number of packet drops while capturing.
|
|
*
|
|
* @param cf the capture file
|
|
* @return the number of packet drops occured while capturing
|
|
*/
|
|
guint32 cf_get_drops(capture_file *cf);
|
|
|
|
/**
|
|
* Set the read filter.
|
|
* @todo this shouldn't be required, remove it somehow
|
|
*
|
|
* @param cf the capture file
|
|
* @param rfcode the readfilter
|
|
*/
|
|
void cf_set_rfcode(capture_file *cf, dfilter_t *rfcode);
|
|
|
|
/**
|
|
* "Display Filter" packets in the capture file.
|
|
*
|
|
* @param cf the capture file
|
|
* @param dfilter the display filter
|
|
* @param force TRUE if do in any case, FALSE only if dfilter changed
|
|
* @return one of cf_status_t
|
|
*/
|
|
cf_status_t cf_filter_packets(capture_file *cf, gchar *dfilter, gboolean force);
|
|
|
|
/**
|
|
* At least one "Refence Time" flag has changed, rescan all packets.
|
|
*
|
|
* @param cf the capture file
|
|
*/
|
|
void cf_reftime_packets(capture_file *cf);
|
|
|
|
/**
|
|
* At least one "Refence Time" flag has changed, rescan all packets.
|
|
*
|
|
* @param cf the capture file
|
|
*/
|
|
void cf_colorize_packets(capture_file *cf);
|
|
|
|
/**
|
|
* "Something" has changed, rescan all packets.
|
|
*
|
|
* @param cf the capture file
|
|
*/
|
|
void cf_redissect_packets(capture_file *cf);
|
|
|
|
/**
|
|
* Rescan all packets and just run taps - don't reconstruct the display.
|
|
*
|
|
* @param cf the capture file
|
|
* @return one of cf_read_status_t
|
|
*/
|
|
cf_read_status_t cf_retap_packets(capture_file *cf);
|
|
|
|
/**
|
|
* The time format has changed, rescan all packets.
|
|
*
|
|
* @param cf the capture file
|
|
*/
|
|
void cf_change_time_formats(capture_file *cf);
|
|
|
|
/**
|
|
* Print the capture file.
|
|
*
|
|
* @param cf the capture file
|
|
* @param print_args the arguments what and how to print
|
|
* @return one of cf_print_status_t
|
|
*/
|
|
cf_print_status_t cf_print_packets(capture_file *cf, print_args_t *print_args);
|
|
|
|
/**
|
|
* Print (export) the capture file into PDML format.
|
|
*
|
|
* @param cf the capture file
|
|
* @param print_args the arguments what and how to export
|
|
* @return one of cf_print_status_t
|
|
*/
|
|
cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_args);
|
|
|
|
/**
|
|
* Print (export) the capture file into PSML format.
|
|
*
|
|
* @param cf the capture file
|
|
* @param print_args the arguments what and how to export
|
|
* @return one of cf_print_status_t
|
|
*/
|
|
cf_print_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args);
|
|
|
|
/**
|
|
* Print (export) the capture file into CSV format.
|
|
*
|
|
* @param cf the capture file
|
|
* @param print_args the arguments what and how to export
|
|
* @return one of cf_print_status_t
|
|
*/
|
|
cf_print_status_t cf_write_csv_packets(capture_file *cf, print_args_t *print_args);
|
|
|
|
/**
|
|
* Find Packet in protocol tree.
|
|
*
|
|
* @param cf the capture file
|
|
* @param string the string to find
|
|
* @return TRUE if a packet was found, FALSE otherwise
|
|
*/
|
|
gboolean cf_find_packet_protocol_tree(capture_file *cf, const char *string);
|
|
|
|
/**
|
|
* Find Packet in summary line.
|
|
*
|
|
* @param cf the capture file
|
|
* @param string the string to find
|
|
* @return TRUE if a packet was found, FALSE otherwise
|
|
*/
|
|
gboolean cf_find_packet_summary_line(capture_file *cf, const char *string);
|
|
|
|
/**
|
|
* Find Packet in packet data.
|
|
*
|
|
* @param cf the capture file
|
|
* @param string the string to find
|
|
* @param string_size the size of the string to find
|
|
* @return TRUE if a packet was found, FALSE otherwise
|
|
*/
|
|
gboolean cf_find_packet_data(capture_file *cf, const guint8 *string,
|
|
size_t string_size);
|
|
|
|
/**
|
|
* Find Packet by display filter.
|
|
*
|
|
* @param cf the capture file
|
|
* @param sfcode the display filter to find a packet for
|
|
* @return TRUE if a packet was found, FALSE otherwise
|
|
*/
|
|
gboolean cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode);
|
|
|
|
/**
|
|
* GoTo Packet in first row.
|
|
*
|
|
* @param cf the capture file
|
|
* @return TRUE if the first row exists, FALSE otherwise
|
|
*/
|
|
gboolean cf_goto_top_frame(capture_file *cf);
|
|
|
|
/**
|
|
* GoTo Packet in last row.
|
|
*
|
|
* @param cf the capture file
|
|
* @return TRUE if last row exists, FALSE otherwise
|
|
*/
|
|
gboolean cf_goto_bottom_frame(capture_file *cf);
|
|
|
|
/**
|
|
* GoTo Packet with the given row.
|
|
*
|
|
* @param cf the capture file
|
|
* @param row the row to go to
|
|
* @return TRUE if this row exists, FALSE otherwise
|
|
*/
|
|
gboolean cf_goto_frame(capture_file *cf, guint row);
|
|
|
|
/**
|
|
* Go to frame specified by currently selected protocol tree field.
|
|
* (Go To Corresponding Packet)
|
|
* @todo this is ugly and should be improved!
|
|
*
|
|
* @param cf the capture file
|
|
* @return TRUE if this packet exists, FALSE otherwise
|
|
*/
|
|
gboolean cf_goto_framenum(capture_file *cf);
|
|
|
|
/**
|
|
* Select the packet in the given row.
|
|
*
|
|
* @param cf the capture file
|
|
* @param row the row to select
|
|
*/
|
|
void cf_select_packet(capture_file *cf, int row);
|
|
|
|
/**
|
|
* Unselect all packets, if any.
|
|
*
|
|
* @param cf the capture file
|
|
* @param row the row to select
|
|
*/
|
|
void cf_unselect_packet(capture_file *cf);
|
|
|
|
/**
|
|
* Unselect all protocol tree fields, if any.
|
|
*
|
|
* @param cf the capture file
|
|
* @param row the row to select
|
|
*/
|
|
void cf_unselect_field(capture_file *cf);
|
|
|
|
/**
|
|
* Mark a particular frame in a particular capture.
|
|
*
|
|
* @param cf the capture file
|
|
* @param frame the frame to be marked
|
|
*/
|
|
void cf_mark_frame(capture_file *cf, frame_data *frame);
|
|
|
|
/**
|
|
* Unmark a particular frame in a particular capture.
|
|
*
|
|
* @param cf the capture file
|
|
* @param frame the frame to be unmarked
|
|
*/
|
|
void cf_unmark_frame(capture_file *cf, frame_data *frame);
|
|
|
|
/**
|
|
* Convert error number and info to a complete message.
|
|
*
|
|
* @param err the error number
|
|
* @param err_info the additional info about this error (e.g. filename)
|
|
* @return statically allocated error message
|
|
*/
|
|
char *cf_read_error_message(int err, const gchar *err_info);
|
|
|
|
/**
|
|
* Merge two (or more) capture files into one.
|
|
* @todo is this the right place for this function? It doesn't have to do a lot with capture_file.
|
|
*
|
|
* @param out_filename pointer to output filename; if output filename is
|
|
* NULL, a temporary file name is generated and *out_filename is set
|
|
* to point to the generated file name
|
|
* @param in_file_count the number of input files to merge
|
|
* @param in_filnames array of input filenames
|
|
* @param file_type the output filetype
|
|
* @param do_append FALSE to merge chronologically, TRUE simply append
|
|
* @return one of cf_status_t
|
|
*/
|
|
cf_status_t
|
|
cf_merge_files(char **out_filename, int in_file_count,
|
|
char *const *in_filenames, int file_type, gboolean do_append);
|
|
|
|
#endif /* file.h */
|