file.h

   1 /* file.h
   2  * Definitions for file structures and routines
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   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_started,
  62     cf_cb_file_read_finished,
  63     cf_cb_packet_selected,
  64     cf_cb_packet_unselected,
  65     cf_cb_field_unselected,
  66     cf_cb_file_save_started,
  67     cf_cb_file_save_finished,
  68     cf_cb_file_save_reload_finished,
  69     cf_cb_file_save_failed
  70 } cf_cbs;
  71
  72 typedef void (*cf_callback_t) (gint event, gpointer data, gpointer user_data);
  73
  74 extern void
  75 cf_callback_add(cf_callback_t func, gpointer user_data);
  76
  77 extern void
  78 cf_callback_remove(cf_callback_t func);
  79
  80 /**
  81  * Open a capture file.
  82  *
  83  * @param cf the capture file to be opened
  84  * @param fname the filename to be opened
  85  * @param is_tempfile is this a temporary file?
  86  * @return one of cf_status_t
  87  */
  88 cf_status_t cf_open(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
  89
  90 /**
  91  * Close a capture file.
  92  *
  93  * @param cf the capture file to be closed
  94  */
  95 void cf_close(capture_file *cf);
  96
  97 /**
  98  * Reload a capture file.
  99  *
 100  * @param cf the capture file to be reloaded
 101  */
 102 void cf_reload(capture_file *cf);
 103
 104 /**
 105  * Read all packets of a capture file into the internal structures.
 106  *
 107  * @param cf the capture file to be read
 108  * @param from_save reread asked from cf_save
 109  * @return one of cf_read_status_t
 110  */
 111 cf_read_status_t cf_read(capture_file *cf, gboolean from_save);
 112
 113 /**
 114  * Start reading from the end of a capture file.
 115  * This is used in "Update list of packets in Real-Time".
 116  *
 117  * @param cf the capture file to be read from
 118  * @param fname the filename to be read from
 119  * @param is_tempfile is this a temporary file?
 120  * @param err the error code, if an error had occured
 121  * @return one of cf_status_t
 122  */
 123 cf_status_t cf_start_tail(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
 124
 125 /**
 126  * Read packets from the "end" of a capture file.
 127  *
 128  * @param cf the capture file to be read from
 129  * @param to_read the number of packets to read
 130  * @param err the error code, if an error had occured
 131  * @return one of cf_read_status_t
 132  */
 133 cf_read_status_t cf_continue_tail(capture_file *cf, volatile int to_read, int *err);
 134
 135 /**
 136  * Finish reading from "end" of a capture file.
 137  *
 138  * @param cf the capture file to be read from
 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_finish_tail(capture_file *cf, int *err);
 143
 144 /**
 145  * Determine whether this capture file (or a range of it) can be saved
 146  * (except by copying the raw file data).
 147  *
 148  * @param cf the capture file to check
 149  * @return TRUE if it can be saved, FALSE if it can't
 150  */
 151 gboolean cf_can_save_as(capture_file *cf);
 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 whether 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  * Set the source of the capture data for temporary files, e.g.
 175  * "Interface eth0" or "Pipe from Pong"
 176  *
 177  * @param cf the capture file
 178  * @param source the source description. this will be copied internally.
 179  */
 180 void cf_set_tempfile_source(capture_file *cf, gchar *source);
 181
 182 /**
 183  * Get the source of the capture data for temporary files. Guaranteed to
 184  * return a non-null value. The returned value should not be freed.
 185  *
 186  * @param cf the capture file
 187  * @param source the source description. this will be copied internally.
 188  */
 189 const gchar *cf_get_tempfile_source(capture_file *cf);
 190
 191 /**
 192  * Get the number of packets in the capture file.
 193  *
 194  * @param cf the capture file
 195  * @return the number of packets in the capture file
 196  */
 197 int cf_get_packet_count(capture_file *cf);
 198
 199 /**
 200  * Set the number of packets in the capture file.
 201  *
 202  * @param cf the capture file
 203  * @param the number of packets in the capture file
 204  */
 205 void cf_set_packet_count(capture_file *cf, int packet_count);
 206
 207 /**
 208  * Is this capture file a temporary file?
 209  *
 210  * @param cf the capture file
 211  * @return TRUE if it's a temporary file, FALSE otherwise
 212  */
 213 gboolean cf_is_tempfile(capture_file *cf);
 214
 215 /**
 216  * Set flag, that this file is a tempfile.
 217  */
 218 void cf_set_tempfile(capture_file *cf, gboolean is_tempfile);
 219
 220 /**
 221  * Set flag, if the number of packet drops while capturing are known or not.
 222  *
 223  * @param cf the capture file
 224  * @param drops_known TRUE if the number of packet drops are known, FALSE otherwise
 225  */
 226 void cf_set_drops_known(capture_file *cf, gboolean drops_known);
 227
 228 /**
 229  * Set the number of packet drops while capturing.
 230  *
 231  * @param cf the capture file
 232  * @param drops the number of packet drops occured while capturing
 233  */
 234 void cf_set_drops(capture_file *cf, guint32 drops);
 235
 236 /**
 237  * Get flag state, if the number of packet drops while capturing are known or not.
 238  *
 239  * @param cf the capture file
 240  * @return TRUE if the number of packet drops are known, FALSE otherwise
 241  */
 242 gboolean cf_get_drops_known(capture_file *cf);
 243
 244 /**
 245  * Get the number of packet drops while capturing.
 246  *
 247  * @param cf the capture file
 248  * @return the number of packet drops occured while capturing
 249  */
 250 guint32 cf_get_drops(capture_file *cf);
 251
 252 /**
 253  * Set the read filter.
 254  * @todo this shouldn't be required, remove it somehow
 255  *
 256  * @param cf the capture file
 257  * @param rfcode the readfilter
 258  */
 259 void cf_set_rfcode(capture_file *cf, dfilter_t *rfcode);
 260
 261 /**
 262  * "Display Filter" packets in the capture file.
 263  *
 264  * @param cf the capture file
 265  * @param dfilter the display filter
 266  * @param force TRUE if do in any case, FALSE only if dfilter changed
 267  * @return one of cf_status_t
 268  */
 269 cf_status_t cf_filter_packets(capture_file *cf, gchar *dfilter, gboolean force);
 270
 271 /**
 272  * At least one "Refence Time" flag has changed, rescan all packets.
 273  *
 274  * @param cf the capture file
 275  */
 276 void cf_reftime_packets(capture_file *cf);
 277
 278 /**
 279  * Return the time it took to load the file
 280  */
 281 gulong cf_get_computed_elapsed(void);
 282
 283 /**
 284  * The coloring rules have changed, redo coloring
 285  *
 286  * @param cf the capture file
 287  */
 288 void cf_colorize_packets(capture_file *cf);
 289
 290 /**
 291  * "Something" has changed, rescan all packets.
 292  *
 293  * @param cf the capture file
 294  */
 295 void cf_redissect_packets(capture_file *cf);
 296
 297 /**
 298  * Rescan all packets and just run taps - don't reconstruct the display.
 299  *
 300  * @param cf the capture file
 301  * @return one of cf_read_status_t
 302  */
 303 cf_read_status_t cf_retap_packets(capture_file *cf);
 304
 305 /**
 306  * The time format has changed, rescan all packets.
 307  *
 308  * @param cf the capture file
 309  */
 310 void cf_change_time_formats(capture_file *cf);
 311
 312 /**
 313  * Adjust timestamp precision if auto is selected.
 314  *
 315  * @param cf the capture file
 316  */
 317 void cf_timestamp_auto_precision(capture_file *cf);
 318
 319 /**
 320  * Print the capture file.
 321  *
 322  * @param cf the capture file
 323  * @param print_args the arguments what and how to print
 324  * @return one of cf_print_status_t
 325  */
 326 cf_print_status_t cf_print_packets(capture_file *cf, print_args_t *print_args);
 327
 328 /**
 329  * Print (export) the capture file into PDML format.
 330  *
 331  * @param cf the capture file
 332  * @param print_args the arguments what and how to export
 333  * @return one of cf_print_status_t
 334  */
 335 cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_args);
 336
 337 /**
 338  * Print (export) the capture file into PSML format.
 339  *
 340  * @param cf the capture file
 341  * @param print_args the arguments what and how to export
 342  * @return one of cf_print_status_t
 343  */
 344 cf_print_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args);
 345
 346 /**
 347  * Print (export) the capture file into CSV format.
 348  *
 349  * @param cf the capture file
 350  * @param print_args the arguments what and how to export
 351  * @return one of cf_print_status_t
 352  */
 353 cf_print_status_t cf_write_csv_packets(capture_file *cf, print_args_t *print_args);
 354
 355 /**
 356  * Print (export) the capture file into C Arrays format.
 357  *
 358  * @param cf the capture file
 359  * @param print_args the arguments what and how to export
 360  * @return one of cf_print_status_t
 361  */
 362 cf_print_status_t cf_write_carrays_packets(capture_file *cf, print_args_t *print_args);
 363
 364 /**
 365  * Find Packet in protocol tree.
 366  *
 367  * @param cf the capture file
 368  * @param string the string to find
 369  * @return TRUE if a packet was found, FALSE otherwise
 370  */
 371 gboolean cf_find_packet_protocol_tree(capture_file *cf, const char *string);
 372
 373 /**
 374  * Find Packet in summary line.
 375  *
 376  * @param cf the capture file
 377  * @param string the string to find
 378  * @return TRUE if a packet was found, FALSE otherwise
 379  */
 380 gboolean cf_find_packet_summary_line(capture_file *cf, const char *string);
 381
 382 /**
 383  * Find Packet in packet data.
 384  *
 385  * @param cf the capture file
 386  * @param string the string to find
 387  * @param string_size the size of the string to find
 388  * @return TRUE if a packet was found, FALSE otherwise
 389  */
 390 gboolean cf_find_packet_data(capture_file *cf, const guint8 *string,
 391                           size_t string_size);
 392
 393 /**
 394  * Find Packet by display filter.
 395  *
 396  * @param cf the capture file
 397  * @param sfcode the display filter to find a packet for
 398  * @return TRUE if a packet was found, FALSE otherwise
 399  */
 400 gboolean cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode);
 401
 402 /**
 403  * GoTo Packet in first row.
 404  *
 405  * @param cf the capture file
 406  * @return TRUE if the first row exists, FALSE otherwise
 407  */
 408 gboolean cf_goto_top_frame(capture_file *cf);
 409
 410 /**
 411  * GoTo Packet in last row.
 412  *
 413  * @param cf the capture file
 414  * @return TRUE if last row exists, FALSE otherwise
 415  */
 416 gboolean cf_goto_bottom_frame(capture_file *cf);
 417
 418 /**
 419  * GoTo Packet with the given row.
 420  *
 421  * @param cf the capture file
 422  * @param row the row to go to
 423  * @return TRUE if this row exists, FALSE otherwise
 424  */
 425 gboolean cf_goto_frame(capture_file *cf, guint row);
 426
 427 /**
 428  * Go to frame specified by currently selected protocol tree field.
 429  * (Go To Corresponding Packet)
 430  * @todo this is ugly and should be improved!
 431  *
 432  * @param cf the capture file
 433  * @return TRUE if this packet exists, FALSE otherwise
 434  */
 435 gboolean cf_goto_framenum(capture_file *cf);
 436
 437 /**
 438  * Select the packet in the given row.
 439  *
 440  * @param cf the capture file
 441  * @param row the row to select
 442  */
 443 void cf_select_packet(capture_file *cf, int row);
 444
 445 /**
 446  * Unselect all packets, if any.
 447  *
 448  * @param cf the capture file
 449  * @param row the row to select
 450  */
 451 void cf_unselect_packet(capture_file *cf);
 452
 453 /**
 454  * Unselect all protocol tree fields, if any.
 455  *
 456  * @param cf the capture file
 457  * @param row the row to select
 458  */
 459 void cf_unselect_field(capture_file *cf);
 460
 461 /**
 462  * Mark a particular frame in a particular capture.
 463  *
 464  * @param cf the capture file
 465  * @param frame the frame to be marked
 466  */
 467 void cf_mark_frame(capture_file *cf, frame_data *frame);
 468
 469 /**
 470  * Unmark a particular frame in a particular capture.
 471  *
 472  * @param cf the capture file
 473  * @param frame the frame to be unmarked
 474  */
 475 void cf_unmark_frame(capture_file *cf, frame_data *frame);
 476
 477 /**
 478  * Ignore a particular frame in a particular capture.
 479  *
 480  * @param cf the capture file
 481  * @param frame the frame to be ignored
 482  */
 483 void cf_ignore_frame(capture_file *cf, frame_data *frame);
 484
 485 /**
 486  * Unignore a particular frame in a particular capture.
 487  *
 488  * @param cf the capture file
 489  * @param frame the frame to be unignored
 490  */
 491 void cf_unignore_frame(capture_file *cf, frame_data *frame);
 492
 493 /**
 494  * Convert error number and info to a complete message.
 495  *
 496  * @param err the error number
 497  * @param err_info a string with additional details about this error
 498  * @return statically allocated error message
 499  */
 500 char *cf_read_error_message(int err, gchar *err_info);
 501
 502 /**
 503  * Merge two (or more) capture files into one.
 504  * @todo is this the right place for this function? It doesn't have to do a lot with capture_file.
 505  *
 506  * @param out_filename pointer to output filename; if output filename is
 507  * NULL, a temporary file name is generated and *out_filename is set
 508  * to point to the generated file name
 509  * @param in_file_count the number of input files to merge
 510  * @param in_filnames array of input filenames
 511  * @param file_type the output filetype
 512  * @param do_append FALSE to merge chronologically, TRUE simply append
 513  * @return one of cf_status_t
 514  */
 515 cf_status_t
 516 cf_merge_files(char **out_filename, int in_file_count,
 517                char *const *in_filenames, int file_type, gboolean do_append);
 518
 519 #if defined(HAVE_HEIMDAL_KERBEROS) || defined(HAVE_MIT_KERBEROS)
 520 void read_keytab_file(const char *);
 521 #endif
 522
 523 #endif /* file.h */