X-Git-Url: http://git.samba.org/samba.git/?p=obnox%2Fwireshark%2Fwip.git;a=blobdiff_plain;f=file.h;h=b4883cd5fd86cb1dd36e63e56873248e14a18744;hp=5c10c314f153a59731218d16eda5d8d61e853612;hb=066aa3878953d89d2a0a551b05256e648d26e82d;hpb=2a67272100db8b206dec54a1c35bb28310f6fad0 diff --git a/file.h b/file.h index 5c10c314f1..b4883cd5fd 100644 --- a/file.h +++ b/file.h @@ -3,8 +3,8 @@ * * $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 @@ -56,27 +56,28 @@ typedef enum { } cf_print_status_t; typedef enum { + cf_cb_file_closing, cf_cb_file_closed, - cf_cb_file_read_start, + cf_cb_file_read_started, cf_cb_file_read_finished, -#ifdef HAVE_LIBPCAP - cf_cb_live_capture_prepare, - cf_cb_live_capture_started, - cf_cb_live_capture_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_cb_file_save_started, + cf_cb_file_save_finished, + cf_cb_file_save_reload_finished, + cf_cb_file_save_failed } cf_cbs; typedef void (*cf_callback_t) (gint event, gpointer data, gpointer user_data); -extern void -cf_callback_invoke(int event, gpointer data); +typedef struct { + const char *string; + size_t string_len; + capture_file *cf; + gboolean frame_matched; + field_info *finfo; +} match_data; extern void cf_callback_add(cf_callback_t func, gpointer user_data); @@ -90,6 +91,7 @@ cf_callback_remove(cf_callback_t func); * @param cf the capture file to be opened * @param fname the filename to be opened * @param is_tempfile is this a temporary file? + * @param err error code * @return one of cf_status_t */ cf_status_t cf_open(capture_file *cf, const char *fname, gboolean is_tempfile, int *err); @@ -110,16 +112,42 @@ 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 + * @param from_save reread asked from cf_save * @return one of cf_read_status_t */ -cf_read_status_t cf_read(capture_file *cf); +cf_read_status_t cf_read(capture_file *cf, gboolean from_save); + +/** + * Read the pseudo-header and raw data for a packet. It will pop + * up an alert box if there's an error. + * + * @param cf the capture file from which to read the packet + * @param fdata the frame_data structure for the packet in question + * @param pseudo_header pointer to a wtap_pseudo_header union into + * which to read the packet's pseudo-header + * @param pd a guin8 array into which to read the packet's raw data + * @return TRUE if the read succeeded, FALSE if there was an error + */ +gboolean cf_read_frame_r(capture_file *cf, frame_data *fdata, + union wtap_pseudo_header *pseudo_header, guint8 *pd); + +/** + * Read the pseudo-header and raw data for a packet into a + * capture_file structure's pseudo_header and pd members. + * It will pop up an alert box if there's an error. + * + * @param cf the capture file from which to read the packet + * @param fdata the frame_data structure for the packet in question + * @return TRUE if the read succeeded, FALSE if there was an error + */ +gboolean cf_read_frame(capture_file *cf, frame_data *fdata); /** * 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? @@ -130,61 +158,108 @@ cf_status_t cf_start_tail(capture_file *cf, const char *fname, gboolean is_tempf /** * 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); +cf_read_status_t cf_continue_tail(capture_file *cf, volatile int to_read, int *err); + +/** + * Fake reading packets from the "end" of a capture file. + * + * @param cf the capture file to be read from + */ +void cf_fake_continue_tail(capture_file *cf); /** * 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); +/** + * Determine whether this capture file (or a range of it) can be saved + * (except by copying the raw file data). + * + * @param cf the capture file to check + * @return TRUE if it can be saved, FALSE if it can't + */ +gboolean cf_can_save_as(capture_file *cf); + /** * 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 whether 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); +cf_status_t cf_save(capture_file * cf, const char *fname, packet_range_t *range, guint save_format, gboolean compressed); /** * 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); +/** + * Set the source of the capture data for temporary files, e.g. + * "Interface eth0" or "Pipe from Pong" + * + * @param cf the capture file + * @param source the source description. this will be copied internally. + */ +void cf_set_tempfile_source(capture_file *cf, gchar *source); + +/** + * Get the source of the capture data for temporary files. Guaranteed to + * return a non-null value. The returned value should not be freed. + * + * @param cf the capture file + */ +const gchar *cf_get_tempfile_source(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); +int cf_get_packet_count(capture_file *cf); + +/** + * Set the number of packets in the capture file. + * + * @param cf the capture file + * @param packet_count 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); +/** + * 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 */ @@ -192,16 +267,32 @@ 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 */ @@ -209,7 +300,7 @@ 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 @@ -219,43 +310,41 @@ 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 + * Return the time it took to load the file */ -void cf_colorize_packets(capture_file *cf); +gulong cf_get_computed_elapsed(void); /** * "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. - * + * Adjust timestamp precision if auto is selected. + * * @param cf the capture file */ -void cf_change_time_formats(capture_file *cf); +void cf_timestamp_auto_precision(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 @@ -264,7 +353,7 @@ 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 @@ -273,7 +362,7 @@ cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_ar /** * 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 @@ -281,62 +370,126 @@ cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_ar cf_print_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args); /** - * Find Packet in protocol tree. - * + * 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); + +/** + * Print (export) the capture file into C Arrays 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_carrays_packets(capture_file *cf, print_args_t *print_args); + +/** + * Find packet with a protocol tree item that contains a specified text string. + * * @param cf the capture file * @param string the string to find + * @param dir direction in which to search * @return TRUE if a packet was found, FALSE otherwise */ -gboolean cf_find_packet_protocol_tree(capture_file *cf, const char *string); +gboolean cf_find_packet_protocol_tree(capture_file *cf, const char *string, + search_direction dir); /** - * Find Packet in summary line. - * + * Find field with a label that contains text string cfile->sfilter. + * + * @param cf the capture file + * @param tree the protocol tree + * @param mdata the first field (mdata->finfo) that matched the string + * @return TRUE if a packet was found, FALSE otherwise + */ +extern gboolean cf_find_string_protocol_tree(capture_file *cf, proto_tree *tree, + match_data *mdata); + +/** + * Find packet whose summary line contains a specified text string. + * * @param cf the capture file * @param string the string to find + * @param dir direction in which to search * @return TRUE if a packet was found, FALSE otherwise */ -gboolean cf_find_packet_summary_line(capture_file *cf, const char *string); +gboolean cf_find_packet_summary_line(capture_file *cf, const char *string, + search_direction dir); /** - * Find Packet in packet data. - * + * Find packet whose data contains a specified byte string. + * * @param cf the capture file * @param string the string to find * @param string_size the size of the string to find + * @param dir direction in which to search * @return TRUE if a packet was found, FALSE otherwise */ gboolean cf_find_packet_data(capture_file *cf, const guint8 *string, - size_t string_size); + size_t string_size, search_direction dir); /** - * Find Packet by display filter. - * + * Find packet that matches a compiled display filter. + * * @param cf the capture file - * @param sfcode the display filter to find a packet for + * @param sfcode the display filter to match + * @param dir direction in which to search * @return TRUE if a packet was found, FALSE otherwise */ -gboolean cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode); +gboolean cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode, + search_direction dir); /** - * GoTo Packet in first row. - * + * Find packet that matches a display filter given as a text string. + * * @param cf the capture file + * @param filter the display filter to match + * @param dir direction in which to search + * @return TRUE if a packet was found, FALSE otherwise + */ +gboolean +cf_find_packet_dfilter_string(capture_file *cf, const char *filter, + search_direction dir); + +/** + * Find marked packet. + * + * @param cf the capture file + * @param dir direction in which to search + * @return TRUE if a packet was found, FALSE otherwise + */ +gboolean cf_find_packet_marked(capture_file *cf, search_direction dir); + +/** + * Find time-reference packet. + * + * @param cf the capture file + * @param dir direction in which to search + * @return TRUE if a packet was found, FALSE otherwise + */ +gboolean cf_find_packet_time_reference(capture_file *cf, search_direction dir); + +/** + * GoTo Packet in first row. + * * @return TRUE if the first row exists, FALSE otherwise */ -gboolean cf_goto_top_frame(capture_file *cf); +gboolean cf_goto_top_frame(); /** * 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); +gboolean cf_goto_bottom_frame(); /** * 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 @@ -365,7 +518,6 @@ 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); @@ -373,7 +525,6 @@ 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); @@ -394,13 +545,20 @@ void cf_mark_frame(capture_file *cf, frame_data *frame); void cf_unmark_frame(capture_file *cf, frame_data *frame); /** - * Convert error number and info to a complete message. + * Ignore a particular frame in a particular capture. * - * @param err the error number - * @param err_info the additional info about this error (e.g. filename) - * @return statically allocated error message + * @param cf the capture file + * @param frame the frame to be ignored */ -char *cf_read_error_message(int err, const gchar *err_info); +void cf_ignore_frame(capture_file *cf, frame_data *frame); + +/** + * Unignore a particular frame in a particular capture. + * + * @param cf the capture file + * @param frame the frame to be unignored + */ +void cf_unignore_frame(capture_file *cf, frame_data *frame); /** * Merge two (or more) capture files into one. @@ -410,7 +568,7 @@ char *cf_read_error_message(int err, const gchar *err_info); * 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 in_filenames 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 @@ -419,4 +577,8 @@ cf_status_t cf_merge_files(char **out_filename, int in_file_count, char *const *in_filenames, int file_type, gboolean do_append); +#if defined(HAVE_HEIMDAL_KERBEROS) || defined(HAVE_MIT_KERBEROS) +void read_keytab_file(const char *); +#endif + #endif /* file.h */