/builds/wireshark/wireshark/file.h

Go to the documentation of this file.

 
#ifndef __FILE_H__
#define __FILE_H__
 
#include <wiretap/wtap.h>
#include <epan/epan.h>
#include <epan/print.h>
#include <epan/fifo_string_cache.h>
#include <ui/packet_range.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
typedef enum {
    CF_OK,      
    CF_ERROR    
} cf_status_t;
 
typedef enum {
    CF_READ_OK,      
    CF_READ_ERROR,   
    CF_READ_ABORTED  
} cf_read_status_t;
 
typedef enum {
    CF_WRITE_OK,      
    CF_WRITE_ERROR,   
    CF_WRITE_ABORTED  
} cf_write_status_t;
 
typedef enum {
    CF_PRINT_OK,            
    CF_PRINT_OPEN_ERROR,    
    CF_PRINT_WRITE_ERROR    
} cf_print_status_t;
 
typedef enum {
    cf_cb_file_opened,
    cf_cb_file_closing,
    cf_cb_file_closed,
    cf_cb_file_read_started,
    cf_cb_file_read_finished,
    cf_cb_file_reload_started,
    cf_cb_file_reload_finished,
    cf_cb_file_rescan_started,
    cf_cb_file_rescan_finished,
    cf_cb_file_retap_started,
    cf_cb_file_retap_finished,
    cf_cb_file_merge_started, /* Qt only */
    cf_cb_file_merge_finished, /* Qt only */
    cf_cb_file_fast_save_finished,
    cf_cb_file_save_started,
    cf_cb_file_save_finished,
    cf_cb_file_save_failed,
    cf_cb_file_save_stopped
} cf_cbs;
 
typedef void (*cf_callback_t) (int event, void *data, void *user_data);
 
typedef struct {
    const char    *string;
    size_t         string_len;
    capture_file  *cf;
    field_info    *finfo;
    field_info    *prev_finfo;
    bool           frame_matched;
    bool           halt;
} match_data;
 
extern void
cf_set_max_records(unsigned max_records);
 
extern void
cf_callback_add(cf_callback_t func, void *user_data);
 
extern void
cf_callback_remove(cf_callback_t func, void *user_data);
 
cf_status_t cf_open(capture_file *cf, const char *fname, unsigned int type, bool is_tempfile, int *err);
 
void cf_close(capture_file *cf);
 
cf_status_t cf_reload(capture_file *cf);
 
cf_read_status_t cf_read(capture_file *cf, bool reloading);
 
bool cf_read_record(capture_file *cf, const frame_data *fdata,
                    wtap_rec *rec);
 
bool cf_read_record_no_alert(capture_file *cf, const frame_data *fdata,
                             wtap_rec *rec);
 
 
bool cf_read_current_record(capture_file *cf);
 
cf_read_status_t cf_continue_tail(capture_file *cf, volatile int to_read,
                                  wtap_rec *rec, int *err,
                                  fifo_string_cache_t *frame_dup_cache, GChecksum *frame_cksum);
 
void cf_fake_continue_tail(capture_file *cf);
 
cf_read_status_t cf_finish_tail(capture_file *cf, wtap_rec *rec,
                                int *err,
                                fifo_string_cache_t *frame_dup_cache, GChecksum *frame_cksum);
 
bool cf_can_write_with_wiretap(capture_file *cf);
 
bool cf_can_save(capture_file *cf);
 
bool cf_can_save_as(capture_file *cf);
 
bool cf_has_unsaved_data(capture_file *cf);
 
cf_write_status_t cf_save_records(capture_file * cf, const char *fname,
                                  unsigned save_format,
                                  wtap_compression_type compression_type,
                                  bool discard_comments,
                                  bool dont_reopen);
 
cf_write_status_t cf_export_specified_packets(capture_file *cf,
                                              const char *fname,
                                              packet_range_t *range,
                                              unsigned save_format,
                                              wtap_compression_type compression_type);
 
char *cf_get_display_name(capture_file *cf);
 
char *cf_get_basename(capture_file *cf);
 
void cf_set_tempfile_source(capture_file *cf, char *source);
 
const char *cf_get_tempfile_source(capture_file *cf);
 
int cf_get_packet_count(capture_file *cf);
 
bool cf_is_tempfile(capture_file *cf);
 
void cf_set_tempfile(capture_file *cf, bool is_tempfile);
 
void cf_set_drops_known(capture_file *cf, bool drops_known);
 
void cf_set_drops(capture_file *cf, uint32_t drops);
 
bool cf_get_drops_known(capture_file *cf);
 
uint32_t cf_get_drops(capture_file *cf);
 
void cf_set_rfcode(capture_file *cf, dfilter_t *rfcode);
 
cf_status_t cf_filter_packets(capture_file *cf, char *dfilter, bool force);
 
void cf_reftime_packets(capture_file *cf);
 
unsigned long cf_get_computed_elapsed(capture_file *cf);
 
void cf_redissect_packets(capture_file *cf);
 
cf_read_status_t cf_retap_packets(capture_file *cf);
 
void cf_retap_aggregation_packets(capture_file* cf, bool enable);
 
/* print_range, enum which frames should be printed */
typedef enum {
    print_range_selected_only,    /* selected frame(s) only (currently only one) */
    print_range_marked_only,      /* marked frames only */
    print_range_all_displayed,    /* all frames currently displayed */
    print_range_all_captured      /* all frames in capture */
} print_range_e;
 
typedef struct {
    print_stream_t *stream;       /* the stream to which we're printing */
    print_format_e format;        /* plain text or PostScript */
    bool to_file;             /* true if we're printing to a file */
    char *file;                   /* file output pathname */
    char *cmd;                    /* print command string (not win32) */
    packet_range_t range;
 
    bool print_summary;       /* true if we should print summary line. */
    bool print_col_headings;  /* true if we should print column headings */
    print_dissections_e print_dissections;
    bool print_hex;           /* true if we should print hex data;
                                   * false if we should print only if not dissected. */
    unsigned hexdump_options;        /* Hexdump options if print_hex is true. */
    bool print_formfeed;      /* true if a formfeed should be printed before
                                   * each new packet */
 
    /* JSON related option */
    bool no_duplicate_keys;
} print_args_t;
 
cf_print_status_t cf_print_packets(capture_file *cf, print_args_t *print_args,
                                   bool show_progress_bar);
 
cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_args);
 
cf_print_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args);
 
cf_print_status_t cf_write_csv_packets(capture_file *cf, print_args_t *print_args);
 
cf_print_status_t cf_write_carrays_packets(capture_file *cf, print_args_t *print_args);
 
cf_print_status_t cf_write_json_packets(capture_file *cf, print_args_t *print_args);
 
bool cf_find_packet_protocol_tree(capture_file *cf, const char *string,
                                      search_direction dir, bool multiple);
 
extern field_info* cf_find_string_protocol_tree(capture_file *cf, proto_tree *tree);
 
bool cf_find_packet_summary_line(capture_file *cf, const char *string,
                                     search_direction dir);
 
bool cf_find_packet_data(capture_file *cf, const uint8_t *string,
                             size_t string_size, search_direction dir,
                             bool multiple);
 
bool cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode,
                                search_direction dir, bool start_current);
 
bool
cf_find_packet_dfilter_string(capture_file *cf, const char *filter,
                              search_direction dir);
 
bool cf_find_packet_marked(capture_file *cf, search_direction dir);
 
bool cf_find_packet_time_reference(capture_file *cf, search_direction dir);
 
bool cf_goto_frame(capture_file *cf, unsigned row, bool exact);
 
bool cf_goto_framenum(capture_file *cf);
 
void cf_select_packet(capture_file *cf, frame_data *frame);
 
void cf_unselect_packet(capture_file *cf);
 
void cf_mark_frame(capture_file *cf, frame_data *frame);
 
void cf_unmark_frame(capture_file *cf, frame_data *frame);
 
void cf_ignore_frame(capture_file *cf, frame_data *frame);
 
void cf_unignore_frame(capture_file *cf, frame_data *frame);
 
cf_status_t
cf_merge_files_to_tempfile(void *pd_window, const char *temp_dir, char **out_filenamep,
                           int in_file_count, const char *const *in_filenames,
                           int file_type, bool do_append);
 
void cf_update_section_comment(capture_file *cf, char *comment);
 
void cf_update_section_comments(capture_file *cf, unsigned shb_idx, char **comments);
 
/*
 * Get the packet block for a packet (record).
 * If the block has been edited, it returns the result of the edit,
 * otherwise it returns the block from the file.
 *
 * @param cf the capture file
 * @param fd the frame_data structure for the frame
 * @returns A block (use wtap_block_unref to free) or NULL if there is none.
 */
wtap_block_t cf_get_packet_block(capture_file *cf, const frame_data *fd);
 
bool cf_set_modified_block(capture_file *cf, frame_data *fd, const wtap_block_t new_block);
 
uint32_t cf_comment_types(capture_file *cf);
 
bool cf_add_ip_name_from_string(capture_file *cf, const char *addr, const char *name);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* file.h */