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