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