file.h

   1 /* file.h
   2  * Definitions for file structures and routines
   3  *
   4  * $Id$
   5  *
   6  * Ethereal - Network traffic analyzer
   7  * By Gerald Combs <gerald@ethereal.com>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  23  */
  24
  25 #ifndef __FILE_H__
  26 #define __FILE_H__
  27
  28 #include "packet-range.h"
  29 #include "wiretap/wtap.h"
  30 #include <epan/dfilter/dfilter.h>
  31 #include "print.h"
  32 #include <errno.h>
  33 #include <epan/epan.h>
  34
  35 #include "cfile.h"
  36
  37
  38 /** Return values from functions that only can succeed or fail. */
  39 typedef enum {
  40         CF_OK,                      /**< operation succeeded */
  41         CF_ERROR        /**< operation got an error (function may provide err with details) */
  42 } cf_status_t;
  43
  44 /** Return values from functions that read capture files. */
  45 typedef enum {
  46         CF_READ_OK,             /**< operation succeeded */
  47         CF_READ_ERROR,          /**< operation got an error (function may provide err with details) */
  48         CF_READ_ABORTED         /**< operation aborted by user */
  49 } cf_read_status_t;
  50
  51 /** Return values from functions that print sets of packets. */
  52 typedef enum {
  53         CF_PRINT_OK,                /**< print operation succeeded */
  54         CF_PRINT_OPEN_ERROR,    /**< print operation failed while opening printer */
  55         CF_PRINT_WRITE_ERROR    /**< print operation failed while writing to the printer */
  56 } cf_print_status_t;
  57
  58 typedef enum {
  59     cf_cb_file_closing,
  60     cf_cb_file_closed,
  61     cf_cb_file_read_start,
  62     cf_cb_file_read_finished,
  63 #ifdef HAVE_LIBPCAP
  64     cf_cb_live_capture_prepared,
  65     cf_cb_live_capture_update_started,
  66     cf_cb_live_capture_update_continue,
  67     cf_cb_live_capture_update_finished,
  68     cf_cb_live_capture_fixed_started,
  69     cf_cb_live_capture_fixed_finished,
  70         cf_cb_live_capture_stopping,
  71 #endif
  72     cf_cb_packet_selected,
  73     cf_cb_packet_unselected,
  74     cf_cb_field_unselected,
  75     cf_cb_file_safe_started,
  76     cf_cb_file_safe_finished,
  77     cf_cb_file_safe_reload_finished,
  78     cf_cb_file_safe_failed
  79 } cf_cbs;
  80
  81 typedef void (*cf_callback_t) (gint event, gpointer data, gpointer user_data);
  82
  83 extern void
  84 cf_callback_invoke(int event, gpointer data);
  85
  86 extern void
  87 cf_callback_add(cf_callback_t func, gpointer user_data);
  88
  89 extern void
  90 cf_callback_remove(cf_callback_t func);
  91
  92 /**
  93  * Open a capture file.
  94  *
  95  * @param cf the capture file to be opened
  96  * @param fname the filename to be opened
  97  * @param is_tempfile is this a temporary file?
  98  * @return one of cf_status_t
  99  */
 100 cf_status_t cf_open(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
 101
 102 /**
 103  * Close a capture file.
 104  *
 105  * @param cf the capture file to be closed
 106  */
 107 void cf_close(capture_file *cf);
 108
 109 /**
 110  * Reload a capture file.
 111  *
 112  * @param cf the capture file to be reloaded
 113  */
 114 void cf_reload(capture_file *cf);
 115
 116 /**
 117  * Read all packets of a capture file into the internal structures.
 118  *
 119  * @param cf the capture file to be read
 120  * @return one of cf_read_status_t
 121  */
 122 cf_read_status_t cf_read(capture_file *cf);
 123
 124 /**
 125  * Start reading from the end of a capture file.
 126  * This is used in "Update list of packets in Real-Time".
 127  *
 128  * @param cf the capture file to be read from
 129  * @param fname the filename to be read from
 130  * @param is_tempfile is this a temporary file?
 131  * @param err the error code, if an error had occured
 132  * @return one of cf_status_t
 133  */
 134 cf_status_t cf_start_tail(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
 135
 136 /**
 137  * Read packets from the "end" of a capture file.
 138  *
 139  * @param cf the capture file to be read from
 140  * @param to_read the number of packets to read
 141  * @param err the error code, if an error had occured
 142  * @return one of cf_read_status_t
 143  */
 144 cf_read_status_t cf_continue_tail(capture_file *cf, int to_read, int *err);
 145
 146 /**
 147  * Finish reading from "end" of a capture file.
 148  *
 149  * @param cf the capture file to be read from
 150  * @param err the error code, if an error had occured
 151  * @return one of cf_read_status_t
 152  */
 153 cf_read_status_t cf_finish_tail(capture_file *cf, int *err);
 154
 155 /**
 156  * Save a capture file (or a range of it).
 157  *
 158  * @param cf the capture file to save to
 159  * @param fname the filename to save to
 160  * @param range the range of packets to save
 161  * @param save_format the format of the file to save (libpcap, ...)
 162  * @param compressed wether to gzip compress the file
 163  * @return one of cf_status_t
 164  */
 165 cf_status_t cf_save(capture_file * cf, const char *fname, packet_range_t *range, guint save_format, gboolean compressed);
 166
 167 /**
 168  * Get a displayable name of the capture file.
 169  *
 170  * @param cf the capture file
 171  * @return the displayable name (don't have to be g_free'd)
 172  */
 173 const gchar *cf_get_display_name(capture_file *cf);
 174
 175 /**
 176  * Get the number of packets in the capture file.
 177  *
 178  * @param cf the capture file
 179  * @return the number of packets in the capture file
 180  */
 181 int cf_packet_count(capture_file *cf);
 182
 183 /**
 184  * Is this capture file a temporary file?
 185  *
 186  * @param cf the capture file
 187  * @return TRUE if it's a temporary file, FALSE otherwise
 188  */
 189 gboolean cf_is_tempfile(capture_file *cf);
 190
 191 /**
 192  * Set flag, that this file is a tempfile.
 193  */
 194 void cf_set_tempfile(capture_file *cf, gboolean is_tempfile);
 195
 196 /**
 197  * Set flag, if the number of packet drops while capturing are known or not.
 198  *
 199  * @param cf the capture file
 200  * @param drops_known TRUE if the number of packet drops are known, FALSE otherwise
 201  */
 202 void cf_set_drops_known(capture_file *cf, gboolean drops_known);
 203
 204 /**
 205  * Set the number of packet drops while capturing.
 206  *
 207  * @param cf the capture file
 208  * @param drops the number of packet drops occured while capturing
 209  */
 210 void cf_set_drops(capture_file *cf, guint32 drops);
 211
 212 /**
 213  * Get flag state, if the number of packet drops while capturing are known or not.
 214  *
 215  * @param cf the capture file
 216  * @return TRUE if the number of packet drops are known, FALSE otherwise
 217  */
 218 gboolean cf_get_drops_known(capture_file *cf);
 219
 220 /**
 221  * Get the number of packet drops while capturing.
 222  *
 223  * @param cf the capture file
 224  * @return the number of packet drops occured while capturing
 225  */
 226 guint32 cf_get_drops(capture_file *cf);
 227
 228 /**
 229  * Set the read filter.
 230  * @todo this shouldn't be required, remove it somehow
 231  *
 232  * @param cf the capture file
 233  * @param rfcode the readfilter
 234  */
 235 void cf_set_rfcode(capture_file *cf, dfilter_t *rfcode);
 236
 237 /**
 238  * "Display Filter" packets in the capture file.
 239  *
 240  * @param cf the capture file
 241  * @param dfilter the display filter
 242  * @param force TRUE if do in any case, FALSE only if dfilter changed
 243  * @return one of cf_status_t
 244  */
 245 cf_status_t cf_filter_packets(capture_file *cf, gchar *dfilter, gboolean force);
 246
 247 /**
 248  * At least one "Refence Time" flag has changed, rescan all packets.
 249  *
 250  * @param cf the capture file
 251  */
 252 void cf_reftime_packets(capture_file *cf);
 253
 254 /**
 255  * At least one "Refence Time" flag has changed, rescan all packets.
 256  *
 257  * @param cf the capture file
 258  */
 259 void cf_colorize_packets(capture_file *cf);
 260
 261 /**
 262  * "Something" has changed, rescan all packets.
 263  *
 264  * @param cf the capture file
 265  */
 266 void cf_redissect_packets(capture_file *cf);
 267
 268 /**
 269  * Rescan all packets and just run taps - don't reconstruct the display.
 270  *
 271  * @param cf the capture file
 272  * @param do_columns TRUE if columns are to be generated, FALSE otherwise
 273  * @return one of cf_read_status_t
 274  */
 275 cf_read_status_t cf_retap_packets(capture_file *cf, gboolean do_columns);
 276
 277 /**
 278  * The time format has changed, rescan all packets.
 279  *
 280  * @param cf the capture file
 281  */
 282 void cf_change_time_formats(capture_file *cf);
 283
 284 /**
 285  * Print the capture file.
 286  *
 287  * @param cf the capture file
 288  * @param print_args the arguments what and how to print
 289  * @return one of cf_print_status_t
 290  */
 291 cf_print_status_t cf_print_packets(capture_file *cf, print_args_t *print_args);
 292
 293 /**
 294  * Print (export) the capture file into PDML format.
 295  *
 296  * @param cf the capture file
 297  * @param print_args the arguments what and how to export
 298  * @return one of cf_print_status_t
 299  */
 300 cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_args);
 301
 302 /**
 303  * Print (export) the capture file into PSML format.
 304  *
 305  * @param cf the capture file
 306  * @param print_args the arguments what and how to export
 307  * @return one of cf_print_status_t
 308  */
 309 cf_print_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args);
 310
 311 /**
 312  * Print (export) the capture file into CSV format.
 313  *
 314  * @param cf the capture file
 315  * @param print_args the arguments what and how to export
 316  * @return one of cf_print_status_t
 317  */
 318 cf_print_status_t cf_write_csv_packets(capture_file *cf, print_args_t *print_args);
 319
 320 /**
 321  * Find Packet in protocol tree.
 322  *
 323  * @param cf the capture file
 324  * @param string the string to find
 325  * @return TRUE if a packet was found, FALSE otherwise
 326  */
 327 gboolean cf_find_packet_protocol_tree(capture_file *cf, const char *string);
 328
 329 /**
 330  * Find Packet in summary line.
 331  *
 332  * @param cf the capture file
 333  * @param string the string to find
 334  * @return TRUE if a packet was found, FALSE otherwise
 335  */
 336 gboolean cf_find_packet_summary_line(capture_file *cf, const char *string);
 337
 338 /**
 339  * Find Packet in packet data.
 340  *
 341  * @param cf the capture file
 342  * @param string the string to find
 343  * @param string_size the size of the string to find
 344  * @return TRUE if a packet was found, FALSE otherwise
 345  */
 346 gboolean cf_find_packet_data(capture_file *cf, const guint8 *string,
 347                           size_t string_size);
 348
 349 /**
 350  * Find Packet by display filter.
 351  *
 352  * @param cf the capture file
 353  * @param sfcode the display filter to find a packet for
 354  * @return TRUE if a packet was found, FALSE otherwise
 355  */
 356 gboolean cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode);
 357
 358 /**
 359  * GoTo Packet in first row.
 360  *
 361  * @param cf the capture file
 362  * @return TRUE if the first row exists, FALSE otherwise
 363  */
 364 gboolean cf_goto_top_frame(capture_file *cf);
 365
 366 /**
 367  * GoTo Packet in last row.
 368  *
 369  * @param cf the capture file
 370  * @return TRUE if last row exists, FALSE otherwise
 371  */
 372 gboolean cf_goto_bottom_frame(capture_file *cf);
 373
 374 /**
 375  * GoTo Packet with the given row.
 376  *
 377  * @param cf the capture file
 378  * @param row the row to go to
 379  * @return TRUE if this row exists, FALSE otherwise
 380  */
 381 gboolean cf_goto_frame(capture_file *cf, guint row);
 382
 383 /**
 384  * Go to frame specified by currently selected protocol tree field.
 385  * (Go To Corresponding Packet)
 386  * @todo this is ugly and should be improved!
 387  *
 388  * @param cf the capture file
 389  * @return TRUE if this packet exists, FALSE otherwise
 390  */
 391 gboolean cf_goto_framenum(capture_file *cf);
 392
 393 /**
 394  * Select the packet in the given row.
 395  *
 396  * @param cf the capture file
 397  * @param row the row to select
 398  */
 399 void cf_select_packet(capture_file *cf, int row);
 400
 401 /**
 402  * Unselect all packets, if any.
 403  *
 404  * @param cf the capture file
 405  * @param row the row to select
 406  */
 407 void cf_unselect_packet(capture_file *cf);
 408
 409 /**
 410  * Unselect all protocol tree fields, if any.
 411  *
 412  * @param cf the capture file
 413  * @param row the row to select
 414  */
 415 void cf_unselect_field(capture_file *cf);
 416
 417 /**
 418  * Mark a particular frame in a particular capture.
 419  *
 420  * @param cf the capture file
 421  * @param frame the frame to be marked
 422  */
 423 void cf_mark_frame(capture_file *cf, frame_data *frame);
 424
 425 /**
 426  * Unmark a particular frame in a particular capture.
 427  *
 428  * @param cf the capture file
 429  * @param frame the frame to be unmarked
 430  */
 431 void cf_unmark_frame(capture_file *cf, frame_data *frame);
 432
 433 /**
 434  * Convert error number and info to a complete message.
 435  *
 436  * @param err the error number
 437  * @param err_info the additional info about this error (e.g. filename)
 438  * @return statically allocated error message
 439  */
 440 char *cf_read_error_message(int err, const gchar *err_info);
 441
 442 /**
 443  * Merge two (or more) capture files into one.
 444  * @todo is this the right place for this function? It doesn't have to do a lot with capture_file.
 445  *
 446  * @param out_filename pointer to output filename; if output filename is
 447  * NULL, a temporary file name is generated and *out_filename is set
 448  * to point to the generated file name
 449  * @param in_file_count the number of input files to merge
 450  * @param in_filnames array of input filenames
 451  * @param file_type the output filetype
 452  * @param do_append FALSE to merge chronologically, TRUE simply append
 453  * @return one of cf_status_t
 454  */
 455 cf_status_t
 456 cf_merge_files(char **out_filename, int in_file_count,
 457                char *const *in_filenames, int file_type, gboolean do_append);
 458
 459 #endif /* file.h */