Wireshark  4.3.0
The Wireshark network protocol analyzer
/builds/wireshark/wireshark/file.h
Go to the documentation of this file.
1 
12 #ifndef __FILE_H__
13 #define __FILE_H__
14 
15 #include <wiretap/wtap.h>
16 #include <epan/epan.h>
17 #include <epan/print.h>
18 #include <epan/fifo_string_cache.h>
19 #include <ui/packet_range.h>
20 
21 #ifdef __cplusplus
22 extern "C" {
23 #endif /* __cplusplus */
24 
26 typedef enum {
28  CF_ERROR
30 
32 typedef enum {
37 
39 typedef enum {
44 
46 typedef enum {
51 
52 typedef enum {
53  cf_cb_file_opened,
54  cf_cb_file_closing,
55  cf_cb_file_closed,
56  cf_cb_file_read_started,
57  cf_cb_file_read_finished,
58  cf_cb_file_reload_started,
59  cf_cb_file_reload_finished,
60  cf_cb_file_rescan_started,
61  cf_cb_file_rescan_finished,
62  cf_cb_file_retap_started,
63  cf_cb_file_retap_finished,
64  cf_cb_file_merge_started, /* Qt only */
65  cf_cb_file_merge_finished, /* Qt only */
66  cf_cb_file_fast_save_finished,
67  cf_cb_file_save_started,
68  cf_cb_file_save_finished,
69  cf_cb_file_save_failed,
70  cf_cb_file_save_stopped
71 } cf_cbs;
72 
73 typedef void (*cf_callback_t) (gint event, gpointer data, gpointer user_data);
74 
75 typedef struct {
76  const char *string;
77  size_t string_len;
78  capture_file *cf;
79  field_info *finfo;
80  field_info *prev_finfo;
81  gboolean frame_matched;
82  gboolean halt;
83 } match_data;
84 
90 extern void
91 cf_set_max_records(guint max_records);
92 
104 extern void
105 cf_callback_add(cf_callback_t func, gpointer user_data);
106 
114 extern void
115 cf_callback_remove(cf_callback_t func, gpointer user_data);
116 
127 cf_status_t cf_open(capture_file *cf, const char *fname, unsigned int type, gboolean is_tempfile, int *err);
128 
134 void cf_close(capture_file *cf);
135 
143 
151 cf_read_status_t cf_read(capture_file *cf, gboolean reloading);
152 
164 gboolean cf_read_record(capture_file *cf, const frame_data *fdata,
165  wtap_rec *rec, Buffer *buf);
166 
168 gboolean cf_read_record_no_alert(capture_file *cf, const frame_data *fdata,
169  wtap_rec *rec, Buffer *buf);
170 
171 
181 
193  wtap_rec *rec, Buffer *buf, int *err,
194  fifo_string_cache_t *frame_dup_cache, GChecksum *frame_cksum);
195 
202 
213  Buffer *buf, int *err,
214  fifo_string_cache_t *frame_dup_cache, GChecksum *frame_cksum);
215 
224 
232 gboolean cf_can_save(capture_file *cf);
233 
240 gboolean cf_can_save_as(capture_file *cf);
241 
248 gboolean cf_has_unsaved_data(capture_file *cf);
249 
268 cf_write_status_t cf_save_records(capture_file * cf, const char *fname,
269  guint save_format,
270  wtap_compression_type compression_type,
271  gboolean discard_comments,
272  gboolean dont_reopen);
273 
289  const char *fname,
290  packet_range_t *range,
291  guint save_format,
292  wtap_compression_type compression_type);
293 
301 
311 gchar *cf_get_basename(capture_file *cf);
312 
320 void cf_set_tempfile_source(capture_file *cf, gchar *source);
321 
328 const gchar *cf_get_tempfile_source(capture_file *cf);
329 
337 
344 gboolean cf_is_tempfile(capture_file *cf);
345 
349 void cf_set_tempfile(capture_file *cf, gboolean is_tempfile);
350 
357 void cf_set_drops_known(capture_file *cf, gboolean drops_known);
358 
365 void cf_set_drops(capture_file *cf, guint32 drops);
366 
373 gboolean cf_get_drops_known(capture_file *cf);
374 
381 guint32 cf_get_drops(capture_file *cf);
382 
390 void cf_set_rfcode(capture_file *cf, dfilter_t *rfcode);
391 
400 cf_status_t cf_filter_packets(capture_file *cf, gchar *dfilter, gboolean force);
401 
409 
414 
421 
429 
430 /* print_range, enum which frames should be printed */
431 typedef enum {
432  print_range_selected_only, /* selected frame(s) only (currently only one) */
433  print_range_marked_only, /* marked frames only */
434  print_range_all_displayed, /* all frames currently displayed */
435  print_range_all_captured /* all frames in capture */
436 } print_range_e;
437 
438 typedef struct {
439  print_stream_t *stream; /* the stream to which we're printing */
440  print_format_e format; /* plain text or PostScript */
441  gboolean to_file; /* TRUE if we're printing to a file */
442  char *file; /* file output pathname */
443  char *cmd; /* print command string (not win32) */
444  packet_range_t range;
445 
446  gboolean print_summary; /* TRUE if we should print summary line. */
447  gboolean print_col_headings; /* TRUE if we should print column headings */
448  print_dissections_e print_dissections;
449  gboolean print_hex; /* TRUE if we should print hex data;
450  * FALSE if we should print only if not dissected. */
451  guint hexdump_options; /* Hexdump options if print_hex is TRUE. */
452  gboolean print_formfeed; /* TRUE if a formfeed should be printed before
453  * each new packet */
454 } print_args_t;
455 
465  gboolean show_progress_bar);
466 
475 
484 
493 
502 
511 
522 gboolean cf_find_packet_protocol_tree(capture_file *cf, const char *string,
523  search_direction dir, bool multiple);
524 
534 
543 gboolean cf_find_packet_summary_line(capture_file *cf, const char *string,
544  search_direction dir);
545 
557 gboolean cf_find_packet_data(capture_file *cf, const guint8 *string,
558  size_t string_size, search_direction dir,
559  bool multiple);
560 
569 gboolean cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode,
570  search_direction dir);
571 
580 gboolean
581 cf_find_packet_dfilter_string(capture_file *cf, const char *filter,
582  search_direction dir);
583 
591 gboolean cf_find_packet_marked(capture_file *cf, search_direction dir);
592 
600 gboolean cf_find_packet_time_reference(capture_file *cf, search_direction dir);
601 
611 gboolean cf_goto_frame(capture_file *cf, guint row, gboolean exact);
612 
621 gboolean cf_goto_framenum(capture_file *cf);
622 
629 void cf_select_packet(capture_file *cf, frame_data *frame);
630 
637 
644 void cf_mark_frame(capture_file *cf, frame_data *frame);
645 
652 void cf_unmark_frame(capture_file *cf, frame_data *frame);
653 
660 void cf_ignore_frame(capture_file *cf, frame_data *frame);
661 
668 void cf_unignore_frame(capture_file *cf, frame_data *frame);
669 
684 cf_merge_files_to_tempfile(gpointer pd_window, const char *temp_dir, char **out_filenamep,
685  int in_file_count, const char *const *in_filenames,
686  int file_type, gboolean do_append);
687 
695 void cf_update_section_comment(capture_file *cf, gchar *comment);
696 
705 void cf_update_section_comments(capture_file *cf, unsigned shb_idx, char **comments);
706 
707 /*
708  * Get the packet block for a packet (record).
709  * If the block has been edited, it returns the result of the edit,
710  * otherwise it returns the block from the file.
711  *
712  * @param cf the capture file
713  * @param fd the frame_data structure for the frame
714  * @returns A block (use wtap_block_unref to free) or NULL if there is none.
715  */
716 wtap_block_t cf_get_packet_block(capture_file *cf, const frame_data *fd);
717 
729 gboolean cf_set_modified_block(capture_file *cf, frame_data *fd, const wtap_block_t new_block);
730 
737 guint32 cf_comment_types(capture_file *cf);
738 
747 gboolean cf_add_ip_name_from_string(capture_file *cf, const char *addr, const char *name);
748 
749 #ifdef __cplusplus
750 }
751 #endif /* __cplusplus */
752 
753 #endif /* file.h */
gboolean cf_has_unsaved_data(capture_file *cf)
Definition: file.c:5420
gboolean cf_find_packet_marked(capture_file *cf, search_direction dir)
Definition: file.c:4608
void cf_unmark_frame(capture_file *cf, frame_data *frame)
Definition: file.c:5019
cf_print_status_t cf_write_csv_packets(capture_file *cf, print_args_t *print_args)
Definition: file.c:3071
gboolean cf_read_record(capture_file *cf, const frame_data *fdata, wtap_rec *rec, Buffer *buf)
Definition: file.c:1667
cf_read_status_t
Definition: file.h:32
@ CF_READ_ERROR
Definition: file.h:34
@ CF_READ_OK
Definition: file.h:33
@ CF_READ_ABORTED
Definition: file.h:35
gboolean cf_goto_frame(capture_file *cf, guint row, gboolean exact)
Definition: file.c:4808
gboolean cf_read_record_no_alert(capture_file *cf, const frame_data *fdata, wtap_rec *rec, Buffer *buf)
Definition: file.c:1681
void cf_update_section_comments(capture_file *cf, unsigned shb_idx, char **comments)
Definition: file.c:5090
gboolean cf_get_drops_known(capture_file *cf)
Definition: file.c:1201
gboolean cf_can_save(capture_file *cf)
Definition: file.c:5358
cf_status_t cf_reload(capture_file *cf)
Definition: file.c:6140
cf_read_status_t cf_continue_tail(capture_file *cf, volatile int to_read, wtap_rec *rec, Buffer *buf, int *err, fifo_string_cache_t *frame_dup_cache, GChecksum *frame_cksum)
gboolean cf_can_write_with_wiretap(capture_file *cf)
Definition: file.c:5329
void cf_close(capture_file *cf)
Definition: file.c:348
cf_read_status_t cf_retap_packets(capture_file *cf)
Definition: file.c:2401
void cf_callback_add(cf_callback_t func, gpointer user_data)
Definition: file.c:186
cf_print_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args)
Definition: file.c:2987
gulong cf_get_computed_elapsed(capture_file *cf)
Definition: file.c:217
void cf_reftime_packets(capture_file *cf)
Definition: file.c:2147
gboolean cf_add_ip_name_from_string(capture_file *cf, const char *addr, const char *name)
Definition: file.c:5243
void cf_callback_remove(cf_callback_t func, gpointer user_data)
Definition: file.c:198
void cf_set_drops_known(capture_file *cf, gboolean drops_known)
Definition: file.c:1187
void cf_set_tempfile(capture_file *cf, gboolean is_tempfile)
Definition: file.c:1179
guint32 cf_comment_types(capture_file *cf)
Definition: file.c:5209
gboolean cf_can_save_as(capture_file *cf)
Definition: file.c:5397
const gchar * cf_get_tempfile_source(capture_file *cf)
Definition: file.c:1155
cf_write_status_t cf_save_records(capture_file *cf, const char *fname, guint save_format, wtap_compression_type compression_type, gboolean discard_comments, gboolean dont_reopen)
Definition: file.c:5606
cf_read_status_t cf_read(capture_file *cf, gboolean reloading)
Definition: file.c:485
gchar * cf_get_basename(capture_file *cf)
Definition: file.c:1094
int cf_get_packet_count(capture_file *cf)
Definition: file.c:1166
gboolean cf_find_packet_time_reference(capture_file *cf, search_direction dir)
Definition: file.c:4621
void cf_ignore_frame(capture_file *cf, frame_data *frame)
Definition: file.c:5032
cf_write_status_t cf_export_specified_packets(capture_file *cf, const char *fname, packet_range_t *range, guint save_format, wtap_compression_type compression_type)
Definition: file.c:5966
gboolean cf_find_packet_dfilter_string(capture_file *cf, const char *filter, search_direction dir)
Definition: file.c:4558
gboolean cf_read_current_record(capture_file *cf)
Definition: file.c:1695
cf_read_status_t cf_finish_tail(capture_file *cf, wtap_rec *rec, Buffer *buf, int *err, fifo_string_cache_t *frame_dup_cache, GChecksum *frame_cksum)
cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_args)
Definition: file.c:2909
gboolean cf_find_packet_data(capture_file *cf, const guint8 *string, size_t string_size, search_direction dir, bool multiple)
Definition: file.c:3634
cf_print_status_t cf_write_carrays_packets(capture_file *cf, print_args_t *print_args)
Definition: file.c:3141
void cf_set_max_records(guint max_records)
Definition: file.c:152
gboolean cf_is_tempfile(capture_file *cf)
Definition: file.c:1173
cf_status_t cf_merge_files_to_tempfile(gpointer pd_window, const char *temp_dir, char **out_filenamep, int in_file_count, const char *const *in_filenames, int file_type, gboolean do_append)
Definition: file.c:1482
gchar * cf_get_display_name(capture_file *cf)
Definition: file.c:1068
field_info * cf_find_string_protocol_tree(capture_file *cf, proto_tree *tree)
Definition: file.c:3293
void cf_mark_frame(capture_file *cf, frame_data *frame)
Definition: file.c:5006
void cf_unselect_packet(capture_file *cf)
Definition: file.c:4984
gboolean cf_find_packet_protocol_tree(capture_file *cf, const char *string, search_direction dir, bool multiple)
Definition: file.c:3267
void cf_set_rfcode(capture_file *cf, dfilter_t *rfcode)
Definition: file.c:1214
void cf_fake_continue_tail(capture_file *cf)
cf_print_status_t cf_write_json_packets(capture_file *cf, print_args_t *print_args)
Definition: file.c:3210
cf_status_t cf_filter_packets(capture_file *cf, gchar *dfilter, gboolean force)
Definition: file.c:1564
gboolean cf_goto_framenum(capture_file *cf)
Definition: file.c:4908
gboolean cf_set_modified_block(capture_file *cf, frame_data *fd, const wtap_block_t new_block)
Definition: file.c:5169
void cf_set_drops(capture_file *cf, guint32 drops)
Definition: file.c:1194
cf_print_status_t cf_print_packets(capture_file *cf, print_args_t *print_args, gboolean show_progress_bar)
Definition: file.c:2703
gboolean cf_find_packet_summary_line(capture_file *cf, const char *string, search_direction dir)
Definition: file.c:3526
cf_status_t
Definition: file.h:26
@ CF_ERROR
Definition: file.h:28
@ CF_OK
Definition: file.h:27
gboolean cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode, search_direction dir)
Definition: file.c:4551
void cf_update_section_comment(capture_file *cf, gchar *comment)
Definition: file.c:5058
cf_status_t cf_open(capture_file *cf, const char *fname, unsigned int type, gboolean is_tempfile, int *err)
Definition: file.c:244
void cf_unignore_frame(capture_file *cf, frame_data *frame)
Definition: file.c:5045
void cf_redissect_packets(capture_file *cf)
Definition: file.c:1641
cf_print_status_t
Definition: file.h:46
@ CF_PRINT_OPEN_ERROR
Definition: file.h:48
@ CF_PRINT_WRITE_ERROR
Definition: file.h:49
@ CF_PRINT_OK
Definition: file.h:47
guint32 cf_get_drops(capture_file *cf)
Definition: file.c:1208
void cf_select_packet(capture_file *cf, frame_data *frame)
Definition: file.c:4932
void cf_set_tempfile_source(capture_file *cf, gchar *source)
Definition: file.c:1141
cf_write_status_t
Definition: file.h:39
@ CF_WRITE_OK
Definition: file.h:40
@ CF_WRITE_ERROR
Definition: file.h:41
@ CF_WRITE_ABORTED
Definition: file.h:42
Definition: cfile.h:67
Definition: proto.h:904
Definition: buffer.h:22
Definition: dfilter-int.h:35
Definition: proto.h:816
Definition: fifo_string_cache.h:24
Definition: file.h:75
Definition: packet_range.h:39
Definition: file.h:438
Definition: print_stream.h:43
Definition: stream.c:41
Definition: wtap_opttypes.c:85
Definition: wtap.h:1431