X-Git-Url: http://git.samba.org/samba.git/?a=blobdiff_plain;f=file.h;h=716ea5da99e5c45ae6f3e4f51d67f94a968d0284;hb=f3731f68b8138211b414a48cb95f0698b172ca6c;hp=20f91b12f5f3e3a49a86b72cebfabe0b4e26f238;hpb=039a59eeca21c560b7964adf0a81d1fc42d21efb;p=obnox%2Fwireshark%2Fwip.git diff --git a/file.h b/file.h index 20f91b12f5..716ea5da99 100644 --- a/file.h +++ b/file.h @@ -1,23 +1,22 @@ /* file.h * Definitions for file structures and routines * - * $Id: file.h,v 1.75 2000/08/11 13:34:30 deniel Exp $ + * $Id$ * - * Ethereal - Network traffic analyzer - * By Gerald Combs + * Wireshark - Network traffic analyzer + * By Gerald Combs * 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. @@ -26,131 +25,444 @@ #ifndef __FILE_H__ #define __FILE_H__ -#ifdef HAVE_SYS_TYPES_H -#include -#endif - +#include "packet-range.h" #include "wiretap/wtap.h" +#include +#include "print.h" +#include +#include -#ifdef HAVE_LIBPCAP -#include -#endif +#include "cfile.h" -#include "dfilter.h" -#include "gtk/colors.h" /* XXX */ -#include "print.h" -#include +/** 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; -#ifdef HAVE_LIBZ -#include "zlib.h" -#define FILE_T gzFile -#define file_open gzopen -#define filed_open gzdopen -#define file_close gzclose -#else /* No zLib */ -#define FILE_T FILE * -#define file_open fopen -#define filed_open fdopen -#define file_close fclose -#endif /* HAVE_LIBZ */ - -typedef struct bpf_program bpf_prog; - -/* Current state of file. */ +/** Return values from functions that read capture files. */ typedef enum { - FILE_CLOSED, /* No file open */ - FILE_READ_IN_PROGRESS, /* Reading a file we've opened */ - FILE_READ_ABORTED, /* Read aborted by user */ - FILE_READ_DONE /* Read completed */ -} file_state; - -typedef struct _capture_file { - file_state state; /* Current state of capture file */ - int filed; /* File descriptor of capture file */ - gchar *filename; /* Name of capture file */ - gboolean is_tempfile; /* Is capture file a temporary file? */ - gboolean user_saved;/* If capture file is temporary, has it been saved by user yet? */ - long f_len; /* Length of capture file */ - guint16 cd_t; /* File type of capture file */ - int lnk_t; /* Link-layer type with which to save capture */ - guint32 vers; /* Version. For tcpdump minor is appended to major */ - guint32 count; /* Packet count */ - guint32 drops; /* Dropped packets */ - guint32 esec; /* Elapsed seconds */ - guint32 eusec; /* Elapsed microseconds */ - guint32 snap; /* Captured packet length */ - long progbar_quantum; /* Number of bytes read per progress bar update */ - long progbar_nextstep; /* Next point at which to update progress bar */ - gchar *iface; /* Interface */ - gchar *save_file; /* File that user saved capture to */ - int save_file_fd; /* File descriptor for saved file */ - wtap *wth; /* Wiretap session */ - dfilter *rfcode; /* Compiled read filter program */ - gchar *dfilter; /* Display filter string */ - colfilter *colors; /* Colors for colorizing packet window */ - dfilter *dfcode; /* Compiled display filter program */ -#ifdef HAVE_LIBPCAP - gchar *cfilter; /* Capture filter string */ - bpf_prog fcode; /* Compiled capture filter program */ -#endif - gchar *sfilter; /* Search filter string */ - gboolean sbackward; /* TRUE if search is backward, FALSE if forward */ - union wtap_pseudo_header pseudo_header; /* Packet pseudo_header */ - guint8 pd[WTAP_MAX_PACKET_SIZE]; /* Packet data */ - GMemChunk *plist_chunk; /* Memory chunk for frame_data structures */ - frame_data *plist; /* Packet list */ - frame_data *plist_end; /* Last packet in list */ - frame_data *first_displayed; /* First frame displayed */ - frame_data *last_displayed; /* Last frame displayed */ - column_info cinfo; /* Column formatting information */ - frame_data *current_frame; /* Frame data for current frame */ - proto_tree *protocol_tree; /* Protocol tree for currently selected packet */ - FILE *print_fh; /* File we're printing to */ -} capture_file; - -/* Return values from "read_cap_file()", "continue_tail_cap_file()", - and "finish_tail_cap_file()". */ + 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 { - READ_SUCCESS, /* read succeeded */ - READ_ERROR, /* read got an error */ - READ_ABORTED /* read aborted by user */ -} read_status_t; - -int open_cap_file(char *, gboolean, capture_file *); -void close_cap_file(capture_file *, void *); -read_status_t read_cap_file(capture_file *, int *); -int start_tail_cap_file(char *, gboolean, capture_file *); -read_status_t continue_tail_cap_file(capture_file *, int, int *); -read_status_t finish_tail_cap_file(capture_file *, int *); -/* size_t read_frame_header(capture_file *); */ -int save_cap_file(char *, capture_file *, gboolean, guint); - -int filter_packets(capture_file *cf, gchar *dfilter); -void colorize_packets(capture_file *); -void redissect_packets(capture_file *cf); -int print_packets(capture_file *cf, print_args_t *print_args); -void change_time_formats(capture_file *); -gboolean find_packet(capture_file *cf, dfilter *sfcode); + 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 { - FOUND_FRAME, /* found the frame */ - NO_SUCH_FRAME, /* no frame with that number */ - FRAME_NOT_DISPLAYED /* frame with that number isn't displayed */ -} goto_result_t; -goto_result_t goto_frame(capture_file *cf, guint fnumber); + cf_cb_file_closing, + 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_continue, + cf_cb_live_capture_fixed_finished, + cf_cb_live_capture_stopping, +#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); -void select_packet(capture_file *, int); -void unselect_packet(capture_file *); +/** + * 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); -/* Moves or copies a file. Returns 0 on failure, 1 on success */ -int file_mv(char *from, char *to); +/** + * 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, ...) + * @param compressed wether to gzip compress the file + * @return one of cf_status_t + */ +cf_status_t cf_save(capture_file * cf, const char *fname, packet_range_t *range, guint save_format, gboolean compressed); -/* Copies a file. Returns 0 on failure, 1 on success */ -int file_cp(char *from, char *to); +/** + * 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_get_packet_count(capture_file *cf); + +/** + * Set the number of packets in the capture file. + * + * @param cf the capture file + * @param the number of packets in the capture file + */ +void cf_set_packet_count(capture_file *cf, int packet_count); + +/** + * 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); -char *file_open_error_message(int, gboolean); -char *file_read_error_message(int); -char *file_write_error_message(int); +/** + * 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 + * @param do_columns TRUE if columns are to be generated, FALSE otherwise + * @return one of cf_read_status_t + */ +cf_read_status_t cf_retap_packets(capture_file *cf, gboolean do_columns); + +/** + * 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 */