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_closed,
  60     cf_cb_file_read_start,
  61     cf_cb_file_read_finished,
  62 #ifdef HAVE_LIBPCAP
  63     cf_cb_live_capture_prepare,
  64     cf_cb_live_capture_started,
  65     cf_cb_live_capture_finished,
  66 #endif
  67     cf_cb_packet_selected,
  68     cf_cb_packet_unselected,
  69     cf_cb_field_unselected,
  70     cf_cb_file_safe_started,
  71     cf_cb_file_safe_finished,
  72     cf_cb_file_safe_reload_finished,
  73     cf_cb_file_safe_failed
  74 } cf_cbs;
  75
  76 typedef void (*cf_callback_t) (gint event, gpointer data, gpointer user_data);
  77
  78 extern void
  79 cf_callback_invoke(int event, gpointer data);
  80
  81 extern void
  82 cf_callback_add(cf_callback_t func, gpointer user_data);
  83
  84 extern void
  85 cf_callback_remove(cf_callback_t func);
  86
  87 /**
  88  * Open a capture file.
  89  *
  90  * @param cf the capture file to be opened
  91  * @param fname the filename to be opened
  92  * @param is_tempfile is this a temporary file?
  93  * @return one of cf_status_t
  94  */
  95 cf_status_t cf_open(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
  96
  97 /**
  98  * Close a capture file.
  99  *
 100  * @param cf the capture file to be closed
 101  */
 102 void cf_close(capture_file *cf);
 103
 104 /**
 105  * Reload a capture file.
 106  *
 107  * @param cf the capture file to be reloaded
 108  */
 109 void cf_reload(capture_file *cf);
 110
 111 /**
 112  * Read all packets of a capture file into the internal structures.
 113  *
 114  * @param cf the capture file to be read
 115  * @return one of cf_read_status_t
 116  */
 117 cf_read_status_t cf_read(capture_file *cf);
 118
 119 /**
 120  * Start reading from the end of a capture file.
 121  * This is used in "Update list of packets in Real-Time".
 122  *
 123  * @param cf the capture file to be read from
 124  * @param fname the filename to be read from
 125  * @param is_tempfile is this a temporary file?
 126  * @param err the error code, if an error had occured
 127  * @return one of cf_status_t
 128  */
 129 cf_status_t cf_start_tail(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
 130
 131 /**
 132  * Read packets from the "end" of a capture file.
 133  *
 134  * @param cf the capture file to be read from
 135  * @param to_read the number of packets to read
 136  * @param err the error code, if an error had occured
 137  * @return one of cf_read_status_t
 138  */
 139 cf_read_status_t cf_continue_tail(capture_file *cf, int to_read, int *err);
 140
 141 /**
 142  * Finish reading from "end" of a capture file.
 143  *
 144  * @param cf the capture file to be read from
 145  * @param err the error code, if an error had occured
 146  * @return one of cf_read_status_t
 147  */
 148 cf_read_status_t cf_finish_tail(capture_file *cf, int *err);
 149
 150 /**
 151  * Save a capture file (or a range of it).
 152  *
 153  * @param cf the capture file to save to
 154  * @param fname the filename to save to
 155  * @param range the range of packets to save
 156  * @param save_format the format of the file to save (libpcap, ...)
 157  * @return one of cf_status_t
 158  */
 159 cf_status_t cf_save(capture_file * cf, const char *fname, packet_range_t *range, guint save_format);
 160
 161 /**
 162  * Get a displayable name of the capture file.
 163  *
 164  * @param cf the capture file
 165  * @return the displayable name (don't have to be g_free'd)
 166  */
 167 const gchar *cf_get_display_name(capture_file *cf);
 168
 169 /**
 170  * Get the number of packets in the capture file.
 171  *
 172  * @param cf the capture file
 173  * @return the number of packets in the capture file
 174  */
 175 int cf_packet_count(capture_file *cf);
 176
 177 /**
 178  * Is this capture file a temporary file?
 179  *
 180  * @param cf the capture file
 181  * @return TRUE if it's a temporary file, FALSE otherwise
 182  */
 183 gboolean cf_is_tempfile(capture_file *cf);
 184
 185 /**
 186  * Set flag, that this file is a tempfile.
 187  */
 188 void cf_set_tempfile(capture_file *cf, gboolean is_tempfile);
 189
 190 /**
 191  * Set flag, if the number of packet drops while capturing are known or not.
 192  *
 193  * @param cf the capture file
 194  * @param drops_known TRUE if the number of packet drops are known, FALSE otherwise
 195  */
 196 void cf_set_drops_known(capture_file *cf, gboolean drops_known);
 197
 198 /**
 199  * Set the number of packet drops while capturing.
 200  *
 201  * @param cf the capture file
 202  * @param drops the number of packet drops occured while capturing
 203  */
 204 void cf_set_drops(capture_file *cf, guint32 drops);
 205
 206 /**
 207  * Get flag state, if the number of packet drops while capturing are known or not.
 208  *
 209  * @param cf the capture file
 210  * @return TRUE if the number of packet drops are known, FALSE otherwise
 211  */
 212 gboolean cf_get_drops_known(capture_file *cf);
 213
 214 /**
 215  * Get the number of packet drops while capturing.
 216  *
 217  * @param cf the capture file
 218  * @return the number of packet drops occured while capturing
 219  */
 220 guint32 cf_get_drops(capture_file *cf);
 221
 222 /**
 223  * Set the read filter.
 224  * @todo this shouldn't be required, remove it somehow
 225  *
 226  * @param cf the capture file
 227  * @param rfcode the readfilter
 228  */
 229 void cf_set_rfcode(capture_file *cf, dfilter_t *rfcode);
 230
 231 /**
 232  * "Display Filter" packets in the capture file.
 233  *
 234  * @param cf the capture file
 235  * @param dfilter the display filter
 236  * @param force TRUE if do in any case, FALSE only if dfilter changed
 237  * @return one of cf_status_t
 238  */
 239 cf_status_t cf_filter_packets(capture_file *cf, gchar *dfilter, gboolean force);
 240
 241 /**
 242  * At least one "Refence Time" flag has changed, rescan all packets.
 243  *
 244  * @param cf the capture file
 245  */
 246 void cf_reftime_packets(capture_file *cf);
 247
 248 /**
 249  * At least one "Refence Time" flag has changed, rescan all packets.
 250  *
 251  * @param cf the capture file
 252  */
 253 void cf_colorize_packets(capture_file *cf);
 254
 255 /**
 256  * "Something" has changed, rescan all packets.
 257  *
 258  * @param cf the capture file
 259  */
 260 void cf_redissect_packets(capture_file *cf);
 261
 262 /**
 263  * Rescan all packets and just run taps - don't reconstruct the display.
 264  *
 265  * @param cf the capture file
 266  * @return one of cf_read_status_t
 267  */
 268 cf_read_status_t cf_retap_packets(capture_file *cf);
 269
 270 /**
 271  * The time format has changed, rescan all packets.
 272  *
 273  * @param cf the capture file
 274  */
 275 void cf_change_time_formats(capture_file *cf);
 276
 277 /**
 278  * Print the capture file.
 279  *
 280  * @param cf the capture file
 281  * @param print_args the arguments what and how to print
 282  * @return one of cf_print_status_t
 283  */
 284 cf_print_status_t cf_print_packets(capture_file *cf, print_args_t *print_args);
 285
 286 /**
 287  * Print (export) the capture file into PDML format.
 288  *
 289  * @param cf the capture file
 290  * @param print_args the arguments what and how to export
 291  * @return one of cf_print_status_t
 292  */
 293 cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_args);
 294
 295 /**
 296  * Print (export) the capture file into PSML format.
 297  *
 298  * @param cf the capture file
 299  * @param print_args the arguments what and how to export
 300  * @return one of cf_print_status_t
 301  */
 302 cf_print_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args);
 303
 304 /**
 305  * Print (export) the capture file into CSV format.
 306  *
 307  * @param cf the capture file
 308  * @param print_args the arguments what and how to export
 309  * @return one of cf_print_status_t
 310  */
 311 cf_print_status_t cf_write_csv_packets(capture_file *cf, print_args_t *print_args);
 312
 313 /**
 314  * Find Packet in protocol tree.
 315  *
 316  * @param cf the capture file
 317  * @param string the string to find
 318  * @return TRUE if a packet was found, FALSE otherwise
 319  */
 320 gboolean cf_find_packet_protocol_tree(capture_file *cf, const char *string);
 321
 322 /**
 323  * Find Packet in summary line.
 324  *
 325  * @param cf the capture file
 326  * @param string the string to find
 327  * @return TRUE if a packet was found, FALSE otherwise
 328  */
 329 gboolean cf_find_packet_summary_line(capture_file *cf, const char *string);
 330
 331 /**
 332  * Find Packet in packet data.
 333  *
 334  * @param cf the capture file
 335  * @param string the string to find
 336  * @param string_size the size of the string to find
 337  * @return TRUE if a packet was found, FALSE otherwise
 338  */
 339 gboolean cf_find_packet_data(capture_file *cf, const guint8 *string,
 340                           size_t string_size);
 341
 342 /**
 343  * Find Packet by display filter.
 344  *
 345  * @param cf the capture file
 346  * @param sfcode the display filter to find a packet for
 347  * @return TRUE if a packet was found, FALSE otherwise
 348  */
 349 gboolean cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode);
 350
 351 /**
 352  * GoTo Packet in first row.
 353  *
 354  * @param cf the capture file
 355  * @return TRUE if the first row exists, FALSE otherwise
 356  */
 357 gboolean cf_goto_top_frame(capture_file *cf);
 358
 359 /**
 360  * GoTo Packet in last row.
 361  *
 362  * @param cf the capture file
 363  * @return TRUE if last row exists, FALSE otherwise
 364  */
 365 gboolean cf_goto_bottom_frame(capture_file *cf);
 366
 367 /**
 368  * GoTo Packet with the given row.
 369  *
 370  * @param cf the capture file
 371  * @param row the row to go to
 372  * @return TRUE if this row exists, FALSE otherwise
 373  */
 374 gboolean cf_goto_frame(capture_file *cf, guint row);
 375
 376 /**
 377  * Go to frame specified by currently selected protocol tree field.
 378  * (Go To Corresponding Packet)
 379  * @todo this is ugly and should be improved!
 380  *
 381  * @param cf the capture file
 382  * @return TRUE if this packet exists, FALSE otherwise
 383  */
 384 gboolean cf_goto_framenum(capture_file *cf);
 385
 386 /**
 387  * Select the packet in the given row.
 388  *
 389  * @param cf the capture file
 390  * @param row the row to select
 391  */
 392 void cf_select_packet(capture_file *cf, int row);
 393
 394 /**
 395  * Unselect all packets, if any.
 396  *
 397  * @param cf the capture file
 398  * @param row the row to select
 399  */
 400 void cf_unselect_packet(capture_file *cf);
 401
 402 /**
 403  * Unselect all protocol tree fields, if any.
 404  *
 405  * @param cf the capture file
 406  * @param row the row to select
 407  */
 408 void cf_unselect_field(capture_file *cf);
 409
 410 /**
 411  * Mark a particular frame in a particular capture.
 412  *
 413  * @param cf the capture file
 414  * @param frame the frame to be marked
 415  */
 416 void cf_mark_frame(capture_file *cf, frame_data *frame);
 417
 418 /**
 419  * Unmark a particular frame in a particular capture.
 420  *
 421  * @param cf the capture file
 422  * @param frame the frame to be unmarked
 423  */
 424 void cf_unmark_frame(capture_file *cf, frame_data *frame);
 425
 426 /**
 427  * Convert error number and info to a complete message.
 428  *
 429  * @param err the error number
 430  * @param err_info the additional info about this error (e.g. filename)
 431  * @return statically allocated error message
 432  */
 433 char *cf_read_error_message(int err, const gchar *err_info);
 434
 435 /**
 436  * Merge two (or more) capture files into one.
 437  * @todo is this the right place for this function? It doesn't have to do a lot with capture_file.
 438  *
 439  * @param out_filename pointer to output filename; if output filename is
 440  * NULL, a temporary file name is generated and *out_filename is set
 441  * to point to the generated file name
 442  * @param in_file_count the number of input files to merge
 443  * @param in_filnames array of input filenames
 444  * @param file_type the output filetype
 445  * @param do_append FALSE to merge chronologically, TRUE simply append
 446  * @return one of cf_status_t
 447  */
 448 cf_status_t
 449 cf_merge_files(char **out_filename, int in_file_count,
 450                char *const *in_filenames, int file_type, gboolean do_append);
 451
 452 #endif /* file.h */