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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23  */
  24
  25 #ifndef __FILE_H__
  26 #define __FILE_H__
  27
  28 #include "wiretap/wtap.h"
  29 #include "print.h"
  30 #include <errno.h>
  31 #include <epan/epan.h>
  32
  33 #include "packet-range.h"
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif /* __cplusplus */
  38
  39 /** Return values from functions that only can succeed or fail. */
  40 typedef enum {
  41     CF_OK,      /**< operation succeeded */
  42     CF_ERROR    /**< operation got an error (function may provide err with details) */
  43 } cf_status_t;
  44
  45 /** Return values from functions that read capture files. */
  46 typedef enum {
  47     CF_READ_OK,      /**< operation succeeded */
  48     CF_READ_ERROR,   /**< operation got an error (function may provide err with details) */
  49     CF_READ_ABORTED  /**< operation aborted by user */
  50 } cf_read_status_t;
  51
  52 /** Return values from functions that write out packets. */
  53 typedef enum {
  54     CF_WRITE_OK,      /**< operation succeeded */
  55     CF_WRITE_ERROR,   /**< operation got an error (function may provide err with details) */
  56     CF_WRITE_ABORTED, /**< operation aborted by user */
  57 } cf_write_status_t;
  58
  59 /** Return values from functions that print sets of packets. */
  60 typedef enum {
  61         CF_PRINT_OK,            /**< print operation succeeded */
  62         CF_PRINT_OPEN_ERROR,    /**< print operation failed while opening printer */
  63         CF_PRINT_WRITE_ERROR    /**< print operation failed while writing to the printer */
  64 } cf_print_status_t;
  65
  66 typedef enum {
  67     cf_cb_file_opened,
  68     cf_cb_file_closing,
  69     cf_cb_file_closed,
  70     cf_cb_file_read_started,
  71     cf_cb_file_read_finished,
  72     cf_cb_file_reload_started,
  73     cf_cb_file_reload_finished,
  74     cf_cb_file_rescan_started,
  75     cf_cb_file_rescan_finished,
  76     cf_cb_file_fast_save_finished,
  77     cf_cb_packet_selected,
  78     cf_cb_packet_unselected,
  79     cf_cb_field_unselected,
  80     cf_cb_file_save_started,
  81     cf_cb_file_save_finished,
  82     cf_cb_file_save_failed,
  83     cf_cb_file_save_stopped,
  84     cf_cb_file_export_specified_packets_started,
  85     cf_cb_file_export_specified_packets_finished,
  86     cf_cb_file_export_specified_packets_failed,
  87     cf_cb_file_export_specified_packets_stopped
  88 } cf_cbs;
  89
  90 typedef void (*cf_callback_t) (gint event, gpointer data, gpointer user_data);
  91
  92 typedef struct {
  93     const char    *string;
  94     size_t         string_len;
  95     capture_file  *cf;
  96     gboolean       frame_matched;
  97     field_info    *finfo;
  98 } match_data;
  99
 100 extern void
 101 cf_callback_add(cf_callback_t func, gpointer user_data);
 102
 103 extern void
 104 cf_callback_remove(cf_callback_t func);
 105
 106 /**
 107  * Open a capture file.
 108  *
 109  * @param cf the capture file to be opened
 110  * @param fname the filename to be opened
 111  * @param is_tempfile is this a temporary file?
 112  * @param err error code
 113  * @return one of cf_status_t
 114  */
 115 cf_status_t cf_open(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
 116
 117 /**
 118  * Close a capture file.
 119  *
 120  * @param cf the capture file to be closed
 121  */
 122 void cf_close(capture_file *cf);
 123
 124 /**
 125  * Reload a capture file.
 126  *
 127  * @param cf the capture file to be reloaded
 128  */
 129 void cf_reload(capture_file *cf);
 130
 131 /**
 132  * Read all packets of a capture file into the internal structures.
 133  *
 134  * @param cf the capture file to be read
 135  * @param from_save reread asked from cf_save_packets
 136  * @return one of cf_read_status_t
 137  */
 138 cf_read_status_t cf_read(capture_file *cf, gboolean from_save);
 139
 140 /**
 141  * Read the pseudo-header and raw data for a packet.  It will pop
 142  * up an alert box if there's an error.
 143  *
 144  * @param cf the capture file from which to read the packet
 145  * @param fdata the frame_data structure for the packet in question
 146  * @param pseudo_header pointer to a wtap_pseudo_header union into
 147  * which to read the packet's pseudo-header
 148  * @param pd a guin8 array into which to read the packet's raw data
 149  * @return TRUE if the read succeeded, FALSE if there was an error
 150  */
 151 gboolean cf_read_frame_r(capture_file *cf, frame_data *fdata,
 152                          struct wtap_pkthdr *phdr, guint8 *pd);
 153
 154 /**
 155  * Read the pseudo-header and raw data for a packet into a
 156  * capture_file structure's pseudo_header and pd members.
 157  * It will pop up an alert box if there's an error.
 158  *
 159  * @param cf the capture file from which to read the packet
 160  * @param fdata the frame_data structure for the packet in question
 161  * @return TRUE if the read succeeded, FALSE if there was an error
 162  */
 163 gboolean cf_read_frame(capture_file *cf, frame_data *fdata);
 164
 165 /**
 166  * Start reading from the end of a capture file.
 167  * This is used in "Update list of packets in Real-Time".
 168  *
 169  * @param cf the capture file to be read from
 170  * @param fname the filename to be read from
 171  * @param is_tempfile is this a temporary file?
 172  * @param err the error code, if an error had occured
 173  * @return one of cf_status_t
 174  */
 175 cf_status_t cf_start_tail(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
 176
 177 /**
 178  * Read packets from the "end" of a capture file.
 179  *
 180  * @param cf the capture file to be read from
 181  * @param to_read the number of packets to read
 182  * @param err the error code, if an error had occured
 183  * @return one of cf_read_status_t
 184  */
 185 cf_read_status_t cf_continue_tail(capture_file *cf, volatile int to_read, int *err);
 186
 187 /**
 188  * Fake reading packets from the "end" of a capture file.
 189  *
 190  * @param cf the capture file to be read from
 191  */
 192 void cf_fake_continue_tail(capture_file *cf);
 193
 194 /**
 195  * Finish reading from "end" of a capture file.
 196  *
 197  * @param cf the capture file to be read from
 198  * @param err the error code, if an error had occured
 199  * @return one of cf_read_status_t
 200  */
 201 cf_read_status_t cf_finish_tail(capture_file *cf, int *err);
 202
 203 /**
 204  * Determine whether this capture file (or a range of it) can be saved
 205  * in any format using Wiretap rather than by copying the raw data.
 206  *
 207  * @param cf the capture file to check
 208  * @return TRUE if it can be saved, FALSE if it can't
 209  */
 210 gboolean cf_can_write_with_wiretap(capture_file *cf);
 211
 212 /**
 213  * Save all packets in a capture file to a new file, and, if that succeeds,
 214  * make that file the current capture file.  If there's already a file with
 215  * that name, do a "safe save", writing to a temporary file in the same
 216  * directory and, if the write succeeds, renaming the new file on top of the
 217  * old file, so that if the write fails, the old file is still intact.
 218  *
 219  * @param cf the capture file to save to
 220  * @param fname the filename to save to
 221  * @param save_format the format of the file to save (libpcap, ...)
 222  * @param compressed whether to gzip compress the file
 223  * @discard_comments TRUE if we should discard comments if the save
 224  * succeeds (because we saved in a format that doesn't support
 225  * comments)
 226  * @param dont_reopen TRUE if it shouldn't reopen and make that file the
 227  * current capture file
 228  * @return one of cf_write_status_t
 229  */
 230 cf_write_status_t cf_save_packets(capture_file * cf, const char *fname,
 231                                   guint save_format, gboolean compressed,
 232                                   gboolean discard_comments,
 233                                   gboolean dont_reopen);
 234
 235 /**
 236  * Export some or all packets from a capture file to a new file.  If there's
 237  * already a file with that name, do a "safe save", writing to a temporary
 238  * file in the same directory and, if the write succeeds, renaming the new
 239  * file on top of the old file, so that if the write fails, the old file is
 240  * still intact.
 241  *
 242  * @param cf the capture file to write to
 243  * @param fname the filename to write to
 244  * @param range the range of packets to write
 245  * @param save_format the format of the file to write (libpcap, ...)
 246  * @param compressed whether to gzip compress the file
 247  * @return one of cf_write_status_t
 248  */
 249 cf_write_status_t cf_export_specified_packets(capture_file *cf,
 250                                               const char *fname,
 251                                               packet_range_t *range,
 252                                               guint save_format,
 253                                               gboolean compressed);
 254
 255 /**
 256  * Get a displayable name of the capture file.
 257  *
 258  * @param cf the capture file
 259  * @return the displayable name (must be g_free'd)
 260  */
 261 gchar *cf_get_display_name(capture_file *cf);
 262
 263 /**
 264  * Set the source of the capture data for temporary files, e.g.
 265  * "Interface eth0" or "Pipe from Pong"
 266  *
 267  * @param cf the capture file
 268  * @param source the source description. this will be copied internally.
 269  */
 270 void cf_set_tempfile_source(capture_file *cf, gchar *source);
 271
 272 /**
 273  * Get the source of the capture data for temporary files. Guaranteed to
 274  * return a non-null value. The returned value should not be freed.
 275  *
 276  * @param cf the capture file
 277  */
 278 const gchar *cf_get_tempfile_source(capture_file *cf);
 279
 280 /**
 281  * Get the number of packets in the capture file.
 282  *
 283  * @param cf the capture file
 284  * @return the number of packets in the capture file
 285  */
 286 int cf_get_packet_count(capture_file *cf);
 287
 288 /**
 289  * Set the number of packets in the capture file.
 290  *
 291  * @param cf the capture file
 292  * @param packet_count the number of packets in the capture file
 293  */
 294 void cf_set_packet_count(capture_file *cf, int packet_count);
 295
 296 /**
 297  * Is this capture file a temporary file?
 298  *
 299  * @param cf the capture file
 300  * @return TRUE if it's a temporary file, FALSE otherwise
 301  */
 302 gboolean cf_is_tempfile(capture_file *cf);
 303
 304 /**
 305  * Set flag, that this file is a tempfile.
 306  */
 307 void cf_set_tempfile(capture_file *cf, gboolean is_tempfile);
 308
 309 /**
 310  * Set flag, if the number of packet drops while capturing are known or not.
 311  *
 312  * @param cf the capture file
 313  * @param drops_known TRUE if the number of packet drops are known, FALSE otherwise
 314  */
 315 void cf_set_drops_known(capture_file *cf, gboolean drops_known);
 316
 317 /**
 318  * Set the number of packet drops while capturing.
 319  *
 320  * @param cf the capture file
 321  * @param drops the number of packet drops occured while capturing
 322  */
 323 void cf_set_drops(capture_file *cf, guint32 drops);
 324
 325 /**
 326  * Get flag state, if the number of packet drops while capturing are known or not.
 327  *
 328  * @param cf the capture file
 329  * @return TRUE if the number of packet drops are known, FALSE otherwise
 330  */
 331 gboolean cf_get_drops_known(capture_file *cf);
 332
 333 /**
 334  * Get the number of packet drops while capturing.
 335  *
 336  * @param cf the capture file
 337  * @return the number of packet drops occured while capturing
 338  */
 339 guint32 cf_get_drops(capture_file *cf);
 340
 341 /**
 342  * Set the read filter.
 343  * @todo this shouldn't be required, remove it somehow
 344  *
 345  * @param cf the capture file
 346  * @param rfcode the readfilter
 347  */
 348 void cf_set_rfcode(capture_file *cf, dfilter_t *rfcode);
 349
 350 /**
 351  * "Display Filter" packets in the capture file.
 352  *
 353  * @param cf the capture file
 354  * @param dfilter the display filter
 355  * @param force TRUE if do in any case, FALSE only if dfilter changed
 356  * @return one of cf_status_t
 357  */
 358 cf_status_t cf_filter_packets(capture_file *cf, gchar *dfilter, gboolean force);
 359
 360 /**
 361  * At least one "Refence Time" flag has changed, rescan all packets.
 362  *
 363  * @param cf the capture file
 364  */
 365 void cf_reftime_packets(capture_file *cf);
 366
 367 /**
 368  * Return the time it took to load the file
 369  */
 370 gulong cf_get_computed_elapsed(void);
 371
 372 /**
 373  * "Something" has changed, rescan all packets.
 374  *
 375  * @param cf the capture file
 376  */
 377 void cf_redissect_packets(capture_file *cf);
 378
 379 /**
 380  * Rescan all packets and just run taps - don't reconstruct the display.
 381  *
 382  * @param cf the capture file
 383  * @return one of cf_read_status_t
 384  */
 385 cf_read_status_t cf_retap_packets(capture_file *cf);
 386
 387 /**
 388  * Adjust timestamp precision if auto is selected.
 389  *
 390  * @param cf the capture file
 391  */
 392 void cf_timestamp_auto_precision(capture_file *cf);
 393
 394 /**
 395  * Print the capture file.
 396  *
 397  * @param cf the capture file
 398  * @param print_args the arguments what and how to print
 399  * @return one of cf_print_status_t
 400  */
 401 cf_print_status_t cf_print_packets(capture_file *cf, print_args_t *print_args);
 402
 403 /**
 404  * Print (export) the capture file into PDML format.
 405  *
 406  * @param cf the capture file
 407  * @param print_args the arguments what and how to export
 408  * @return one of cf_print_status_t
 409  */
 410 cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_args);
 411
 412 /**
 413  * Print (export) the capture file into PSML format.
 414  *
 415  * @param cf the capture file
 416  * @param print_args the arguments what and how to export
 417  * @return one of cf_print_status_t
 418  */
 419 cf_print_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args);
 420
 421 /**
 422  * Print (export) the capture file into CSV format.
 423  *
 424  * @param cf the capture file
 425  * @param print_args the arguments what and how to export
 426  * @return one of cf_print_status_t
 427  */
 428 cf_print_status_t cf_write_csv_packets(capture_file *cf, print_args_t *print_args);
 429
 430 /**
 431  * Print (export) the capture file into C Arrays format.
 432  *
 433  * @param cf the capture file
 434  * @param print_args the arguments what and how to export
 435  * @return one of cf_print_status_t
 436  */
 437 cf_print_status_t cf_write_carrays_packets(capture_file *cf, print_args_t *print_args);
 438
 439 /**
 440  * Find packet with a protocol tree item that contains a specified text string.
 441  *
 442  * @param cf the capture file
 443  * @param string the string to find
 444  * @param dir direction in which to search
 445  * @return TRUE if a packet was found, FALSE otherwise
 446  */
 447 gboolean cf_find_packet_protocol_tree(capture_file *cf, const char *string,
 448                                       search_direction dir);
 449
 450 /**
 451  * Find field with a label that contains text string cfile->sfilter.
 452  *
 453  * @param cf the capture file
 454  * @param tree the protocol tree
 455  * @param mdata the first field (mdata->finfo) that matched the string
 456  * @return TRUE if a packet was found, FALSE otherwise
 457  */
 458 extern gboolean cf_find_string_protocol_tree(capture_file *cf, proto_tree *tree,
 459                                              match_data *mdata);
 460
 461 /**
 462  * Find packet whose summary line contains a specified text string.
 463  *
 464  * @param cf the capture file
 465  * @param string the string to find
 466  * @param dir direction in which to search
 467  * @return TRUE if a packet was found, FALSE otherwise
 468  */
 469 gboolean cf_find_packet_summary_line(capture_file *cf, const char *string,
 470                                      search_direction dir);
 471
 472 /**
 473  * Find packet whose data contains a specified byte string.
 474  *
 475  * @param cf the capture file
 476  * @param string the string to find
 477  * @param string_size the size of the string to find
 478  * @param dir direction in which to search
 479  * @return TRUE if a packet was found, FALSE otherwise
 480  */
 481 gboolean cf_find_packet_data(capture_file *cf, const guint8 *string,
 482                              size_t string_size, search_direction dir);
 483
 484 /**
 485  * Find packet that matches a compiled display filter.
 486  *
 487  * @param cf the capture file
 488  * @param sfcode the display filter to match
 489  * @param dir direction in which to search
 490  * @return TRUE if a packet was found, FALSE otherwise
 491  */
 492 gboolean cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode,
 493                                 search_direction dir);
 494
 495 /**
 496  * Find packet that matches a display filter given as a text string.
 497  *
 498  * @param cf the capture file
 499  * @param filter the display filter to match
 500  * @param dir direction in which to search
 501  * @return TRUE if a packet was found, FALSE otherwise
 502  */
 503 gboolean
 504 cf_find_packet_dfilter_string(capture_file *cf, const char *filter,
 505                               search_direction dir);
 506
 507 /**
 508  * Find marked packet.
 509  *
 510  * @param cf the capture file
 511  * @param dir direction in which to search
 512  * @return TRUE if a packet was found, FALSE otherwise
 513  */
 514 gboolean cf_find_packet_marked(capture_file *cf, search_direction dir);
 515
 516 /**
 517  * Find time-reference packet.
 518  *
 519  * @param cf the capture file
 520  * @param dir direction in which to search
 521  * @return TRUE if a packet was found, FALSE otherwise
 522  */
 523 gboolean cf_find_packet_time_reference(capture_file *cf, search_direction dir);
 524
 525 /**
 526  * GoTo Packet in first row.
 527  *
 528  * @return TRUE if the first row exists, FALSE otherwise
 529  */
 530 gboolean cf_goto_top_frame(void);
 531
 532 /**
 533  * GoTo Packet in last row.
 534  *
 535  * @return TRUE if last row exists, FALSE otherwise
 536  */
 537 gboolean cf_goto_bottom_frame(void);
 538
 539 /**
 540  * GoTo Packet with the given row.
 541  *
 542  * @param cf the capture file
 543  * @param row the row to go to
 544  * @return TRUE if this row exists, FALSE otherwise
 545  */
 546 gboolean cf_goto_frame(capture_file *cf, guint row);
 547
 548 /**
 549  * Go to frame specified by currently selected protocol tree field.
 550  * (Go To Corresponding Packet)
 551  * @todo this is ugly and should be improved!
 552  *
 553  * @param cf the capture file
 554  * @return TRUE if this packet exists, FALSE otherwise
 555  */
 556 gboolean cf_goto_framenum(capture_file *cf);
 557
 558 /**
 559  * Select the packet in the given row.
 560  *
 561  * @param cf the capture file
 562  * @param row the row to select
 563  */
 564 void cf_select_packet(capture_file *cf, int row);
 565
 566 /**
 567  * Unselect all packets, if any.
 568  *
 569  * @param cf the capture file
 570  */
 571 void cf_unselect_packet(capture_file *cf);
 572
 573 /**
 574  * Unselect all protocol tree fields, if any.
 575  *
 576  * @param cf the capture file
 577  */
 578 void cf_unselect_field(capture_file *cf);
 579
 580 /**
 581  * Mark a particular frame in a particular capture.
 582  *
 583  * @param cf the capture file
 584  * @param frame the frame to be marked
 585  */
 586 void cf_mark_frame(capture_file *cf, frame_data *frame);
 587
 588 /**
 589  * Unmark a particular frame in a particular capture.
 590  *
 591  * @param cf the capture file
 592  * @param frame the frame to be unmarked
 593  */
 594 void cf_unmark_frame(capture_file *cf, frame_data *frame);
 595
 596 /**
 597  * Ignore a particular frame in a particular capture.
 598  *
 599  * @param cf the capture file
 600  * @param frame the frame to be ignored
 601  */
 602 void cf_ignore_frame(capture_file *cf, frame_data *frame);
 603
 604 /**
 605  * Unignore a particular frame in a particular capture.
 606  *
 607  * @param cf the capture file
 608  * @param frame the frame to be unignored
 609  */
 610 void cf_unignore_frame(capture_file *cf, frame_data *frame);
 611
 612 /**
 613  * Merge two (or more) capture files into one.
 614  * @todo is this the right place for this function? It doesn't have to do a lot with capture_file.
 615  *
 616  * @param out_filename pointer to output filename; if output filename is
 617  * NULL, a temporary file name is generated and *out_filename is set
 618  * to point to the generated file name
 619  * @param in_file_count the number of input files to merge
 620  * @param in_filenames array of input filenames
 621  * @param file_type the output filetype
 622  * @param do_append FALSE to merge chronologically, TRUE simply append
 623  * @return one of cf_status_t
 624  */
 625 cf_status_t
 626 cf_merge_files(char **out_filename, int in_file_count,
 627                char *const *in_filenames, int file_type, gboolean do_append);
 628
 629
 630 /**
 631  * Get the comment on a capture from the SHB data block
 632  *
 633  * @param cf the capture file
 634  */
 635 const gchar* cf_read_shb_comment(capture_file *cf);
 636
 637 /**
 638  * Update(replace) the comment on a capture from the SHB data block
 639  *
 640  * @param cf the capture file
 641  * @param comment the string replacing the old comment
 642  */
 643 void cf_update_capture_comment(capture_file *cf, gchar *comment);
 644
 645 /**
 646  * Update(replace) the comment on a capture from a frame
 647  *
 648  * @param cf the capture file
 649  * @param fdata the frame_data structure for the frame
 650  * @param comment the string replacing the old comment
 651  */
 652 void cf_update_packet_comment(capture_file *cf, frame_data *fdata, gchar *comment);
 653
 654 /**
 655  * Does this capture file have any comments?
 656  *
 657  * @param cf the capture file
 658  * @return TRUE if it does, FALSE if it doesn't
 659  */
 660 gboolean cf_has_comments(capture_file *cf);
 661
 662 #if defined(HAVE_HEIMDAL_KERBEROS) || defined(HAVE_MIT_KERBEROS)
 663 void read_keytab_file(const char *);
 664 #endif
 665
 666 #ifdef __cplusplus
 667 }
 668 #endif /* __cplusplus */
 669
 670 #endif /* file.h */