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  * Read the pseudo-header and raw data for a packet.  It will pop
 115  * up an alert box if there's an error.
 116  *
 117  * @param cf the capture file from which to read the packet
 118  * @param fdata the frame_data structure for the packet in question
 119  * @param pseudo_header pointer to a wtap_pseudo_header union into
 120  * which to read the packet's pseudo-header
 121  * @param pd a guin8 array into which to read the packet's raw data
 122  * @return TRUE if the read succeeded, FALSE if there was an error
 123  */
 124 gboolean cf_read_frame_r(capture_file *cf, frame_data *fdata,
 125                          union wtap_pseudo_header *pseudo_header, guint8 *pd);
 126
 127 /**
 128  * Read the pseudo-header and raw data for a packet into a
 129  * capture_file structure's pseudo_header and pd members.
 130  * It will pop up an alert box if there's an error.
 131  *
 132  * @param cf the capture file from which to read the packet
 133  * @param fdata the frame_data structure for the packet in question
 134  * @return TRUE if the read succeeded, FALSE if there was an error
 135  */
 136 gboolean cf_read_frame(capture_file *cf, frame_data *fdata);
 137
 138 /**
 139  * Start reading from the end of a capture file.
 140  * This is used in "Update list of packets in Real-Time".
 141  *
 142  * @param cf the capture file to be read from
 143  * @param fname the filename to be read from
 144  * @param is_tempfile is this a temporary file?
 145  * @param err the error code, if an error had occured
 146  * @return one of cf_status_t
 147  */
 148 cf_status_t cf_start_tail(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
 149
 150 /**
 151  * Read packets from the "end" of a capture file.
 152  *
 153  * @param cf the capture file to be read from
 154  * @param to_read the number of packets to read
 155  * @param err the error code, if an error had occured
 156  * @return one of cf_read_status_t
 157  */
 158 cf_read_status_t cf_continue_tail(capture_file *cf, volatile int to_read, int *err);
 159
 160 /**
 161  * Fake reading packets from the "end" of a capture file.
 162  *
 163  * @param cf the capture file to be read from
 164  */
 165 void cf_fake_continue_tail(capture_file *cf);
 166
 167 /**
 168  * Finish reading from "end" of a capture file.
 169  *
 170  * @param cf the capture file to be read from
 171  * @param err the error code, if an error had occured
 172  * @return one of cf_read_status_t
 173  */
 174 cf_read_status_t cf_finish_tail(capture_file *cf, int *err);
 175
 176 /**
 177  * Determine whether this capture file (or a range of it) can be saved
 178  * (except by copying the raw file data).
 179  *
 180  * @param cf the capture file to check
 181  * @return TRUE if it can be saved, FALSE if it can't
 182  */
 183 gboolean cf_can_save_as(capture_file *cf);
 184
 185 /**
 186  * Save a capture file (or a range of it).
 187  *
 188  * @param cf the capture file to save to
 189  * @param fname the filename to save to
 190  * @param range the range of packets to save
 191  * @param save_format the format of the file to save (libpcap, ...)
 192  * @param compressed whether to gzip compress the file
 193  * @return one of cf_status_t
 194  */
 195 cf_status_t cf_save(capture_file * cf, const char *fname, packet_range_t *range, guint save_format, gboolean compressed);
 196
 197 /**
 198  * Get a displayable name of the capture file.
 199  *
 200  * @param cf the capture file
 201  * @return the displayable name (don't have to be g_free'd)
 202  */
 203 const gchar *cf_get_display_name(capture_file *cf);
 204
 205 /**
 206  * Set the source of the capture data for temporary files, e.g.
 207  * "Interface eth0" or "Pipe from Pong"
 208  *
 209  * @param cf the capture file
 210  * @param source the source description. this will be copied internally.
 211  */
 212 void cf_set_tempfile_source(capture_file *cf, gchar *source);
 213
 214 /**
 215  * Get the source of the capture data for temporary files. Guaranteed to
 216  * return a non-null value. The returned value should not be freed.
 217  *
 218  * @param cf the capture file
 219  * @param source the source description. this will be copied internally.
 220  */
 221 const gchar *cf_get_tempfile_source(capture_file *cf);
 222
 223 /**
 224  * Get the number of packets in the capture file.
 225  *
 226  * @param cf the capture file
 227  * @return the number of packets in the capture file
 228  */
 229 int cf_get_packet_count(capture_file *cf);
 230
 231 /**
 232  * Set the number of packets in the capture file.
 233  *
 234  * @param cf the capture file
 235  * @param the number of packets in the capture file
 236  */
 237 void cf_set_packet_count(capture_file *cf, int packet_count);
 238
 239 /**
 240  * Is this capture file a temporary file?
 241  *
 242  * @param cf the capture file
 243  * @return TRUE if it's a temporary file, FALSE otherwise
 244  */
 245 gboolean cf_is_tempfile(capture_file *cf);
 246
 247 /**
 248  * Set flag, that this file is a tempfile.
 249  */
 250 void cf_set_tempfile(capture_file *cf, gboolean is_tempfile);
 251
 252 /**
 253  * Set flag, if the number of packet drops while capturing are known or not.
 254  *
 255  * @param cf the capture file
 256  * @param drops_known TRUE if the number of packet drops are known, FALSE otherwise
 257  */
 258 void cf_set_drops_known(capture_file *cf, gboolean drops_known);
 259
 260 /**
 261  * Set the number of packet drops while capturing.
 262  *
 263  * @param cf the capture file
 264  * @param drops the number of packet drops occured while capturing
 265  */
 266 void cf_set_drops(capture_file *cf, guint32 drops);
 267
 268 /**
 269  * Get flag state, if the number of packet drops while capturing are known or not.
 270  *
 271  * @param cf the capture file
 272  * @return TRUE if the number of packet drops are known, FALSE otherwise
 273  */
 274 gboolean cf_get_drops_known(capture_file *cf);
 275
 276 /**
 277  * Get the number of packet drops while capturing.
 278  *
 279  * @param cf the capture file
 280  * @return the number of packet drops occured while capturing
 281  */
 282 guint32 cf_get_drops(capture_file *cf);
 283
 284 /**
 285  * Set the read filter.
 286  * @todo this shouldn't be required, remove it somehow
 287  *
 288  * @param cf the capture file
 289  * @param rfcode the readfilter
 290  */
 291 void cf_set_rfcode(capture_file *cf, dfilter_t *rfcode);
 292
 293 /**
 294  * "Display Filter" packets in the capture file.
 295  *
 296  * @param cf the capture file
 297  * @param dfilter the display filter
 298  * @param force TRUE if do in any case, FALSE only if dfilter changed
 299  * @return one of cf_status_t
 300  */
 301 cf_status_t cf_filter_packets(capture_file *cf, gchar *dfilter, gboolean force);
 302
 303 /**
 304  * At least one "Refence Time" flag has changed, rescan all packets.
 305  *
 306  * @param cf the capture file
 307  */
 308 void cf_reftime_packets(capture_file *cf);
 309
 310 /**
 311  * Return the time it took to load the file
 312  */
 313 gulong cf_get_computed_elapsed(void);
 314
 315 /**
 316  * The coloring rules have changed, redo coloring
 317  *
 318  * @param cf the capture file
 319  */
 320 void cf_colorize_packets(capture_file *cf);
 321
 322 /**
 323  * "Something" has changed, rescan all packets.
 324  *
 325  * @param cf the capture file
 326  */
 327 void cf_redissect_packets(capture_file *cf);
 328
 329 /**
 330  * Rescan all packets and just run taps - don't reconstruct the display.
 331  *
 332  * @param cf the capture file
 333  * @return one of cf_read_status_t
 334  */
 335 cf_read_status_t cf_retap_packets(capture_file *cf);
 336
 337 /**
 338  * The time format has changed, rescan all packets.
 339  *
 340  * @param cf the capture file
 341  */
 342 void cf_change_time_formats(capture_file *cf);
 343
 344 /**
 345  * Adjust timestamp precision if auto is selected.
 346  *
 347  * @param cf the capture file
 348  */
 349 void cf_timestamp_auto_precision(capture_file *cf);
 350
 351 /**
 352  * Print the capture file.
 353  *
 354  * @param cf the capture file
 355  * @param print_args the arguments what and how to print
 356  * @return one of cf_print_status_t
 357  */
 358 cf_print_status_t cf_print_packets(capture_file *cf, print_args_t *print_args);
 359
 360 /**
 361  * Print (export) the capture file into PDML format.
 362  *
 363  * @param cf the capture file
 364  * @param print_args the arguments what and how to export
 365  * @return one of cf_print_status_t
 366  */
 367 cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_args);
 368
 369 /**
 370  * Print (export) the capture file into PSML format.
 371  *
 372  * @param cf the capture file
 373  * @param print_args the arguments what and how to export
 374  * @return one of cf_print_status_t
 375  */
 376 cf_print_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args);
 377
 378 /**
 379  * Print (export) the capture file into CSV format.
 380  *
 381  * @param cf the capture file
 382  * @param print_args the arguments what and how to export
 383  * @return one of cf_print_status_t
 384  */
 385 cf_print_status_t cf_write_csv_packets(capture_file *cf, print_args_t *print_args);
 386
 387 /**
 388  * Print (export) the capture file into C Arrays format.
 389  *
 390  * @param cf the capture file
 391  * @param print_args the arguments what and how to export
 392  * @return one of cf_print_status_t
 393  */
 394 cf_print_status_t cf_write_carrays_packets(capture_file *cf, print_args_t *print_args);
 395
 396 /**
 397  * Find packet with a protocol tree item that contains a specified text string.
 398  *
 399  * @param cf the capture file
 400  * @param string the string to find
 401  * @param dir direction in which to search
 402  * @return TRUE if a packet was found, FALSE otherwise
 403  */
 404 gboolean cf_find_packet_protocol_tree(capture_file *cf, const char *string,
 405                                       search_direction dir);
 406
 407 /**
 408  * Find packet whose summary line contains a specified text string.
 409  *
 410  * @param cf the capture file
 411  * @param string the string to find
 412  * @param dir direction in which to search
 413  * @return TRUE if a packet was found, FALSE otherwise
 414  */
 415 gboolean cf_find_packet_summary_line(capture_file *cf, const char *string,
 416                                      search_direction dir);
 417
 418 /**
 419  * Find packet whose data contains a specified byte string.
 420  *
 421  * @param cf the capture file
 422  * @param string the string to find
 423  * @param string_size the size of the string to find
 424  * @param dir direction in which to search
 425  * @return TRUE if a packet was found, FALSE otherwise
 426  */
 427 gboolean cf_find_packet_data(capture_file *cf, const guint8 *string,
 428                              size_t string_size, search_direction dir);
 429
 430 /**
 431  * Find packet that matches a compiled display filter.
 432  *
 433  * @param cf the capture file
 434  * @param sfcode the display filter to match
 435  * @param dir direction in which to search
 436  * @return TRUE if a packet was found, FALSE otherwise
 437  */
 438 gboolean cf_find_packet_dfilter(capture_file *cf, dfilter_t *sfcode,
 439                                 search_direction dir);
 440
 441 /**
 442  * Find packet that matches a display filter given as a text string.
 443  *
 444  * @param cf the capture file
 445  * @param filter the display filter to match
 446  * @param dir direction in which to search
 447  * @return TRUE if a packet was found, FALSE otherwise
 448  */
 449 gboolean
 450 cf_find_packet_dfilter_string(capture_file *cf, const char *filter,
 451                               search_direction dir);
 452
 453 /**
 454  * Find marked packet.
 455  *
 456  * @param cf the capture file
 457  * @param dir direction in which to search
 458  * @return TRUE if a packet was found, FALSE otherwise
 459  */
 460 gboolean cf_find_packet_marked(capture_file *cf, search_direction dir);
 461
 462 /**
 463  * Find time-reference packet.
 464  *
 465  * @param cf the capture file
 466  * @param dir direction in which to search
 467  * @return TRUE if a packet was found, FALSE otherwise
 468  */
 469 gboolean cf_find_packet_time_reference(capture_file *cf, search_direction dir);
 470
 471 /**
 472  * GoTo Packet in first row.
 473  *
 474  * @param cf the capture file
 475  * @return TRUE if the first row exists, FALSE otherwise
 476  */
 477 gboolean cf_goto_top_frame(capture_file *cf);
 478
 479 /**
 480  * GoTo Packet in last row.
 481  *
 482  * @param cf the capture file
 483  * @return TRUE if last row exists, FALSE otherwise
 484  */
 485 gboolean cf_goto_bottom_frame(capture_file *cf);
 486
 487 /**
 488  * GoTo Packet with the given row.
 489  *
 490  * @param cf the capture file
 491  * @param row the row to go to
 492  * @return TRUE if this row exists, FALSE otherwise
 493  */
 494 gboolean cf_goto_frame(capture_file *cf, guint row);
 495
 496 /**
 497  * Go to frame specified by currently selected protocol tree field.
 498  * (Go To Corresponding Packet)
 499  * @todo this is ugly and should be improved!
 500  *
 501  * @param cf the capture file
 502  * @return TRUE if this packet exists, FALSE otherwise
 503  */
 504 gboolean cf_goto_framenum(capture_file *cf);
 505
 506 /**
 507  * Select the packet in the given row.
 508  *
 509  * @param cf the capture file
 510  * @param row the row to select
 511  */
 512 void cf_select_packet(capture_file *cf, int row);
 513
 514 /**
 515  * Unselect all packets, if any.
 516  *
 517  * @param cf the capture file
 518  * @param row the row to select
 519  */
 520 void cf_unselect_packet(capture_file *cf);
 521
 522 /**
 523  * Unselect all protocol tree fields, if any.
 524  *
 525  * @param cf the capture file
 526  * @param row the row to select
 527  */
 528 void cf_unselect_field(capture_file *cf);
 529
 530 /**
 531  * Mark a particular frame in a particular capture.
 532  *
 533  * @param cf the capture file
 534  * @param frame the frame to be marked
 535  */
 536 void cf_mark_frame(capture_file *cf, frame_data *frame);
 537
 538 /**
 539  * Unmark a particular frame in a particular capture.
 540  *
 541  * @param cf the capture file
 542  * @param frame the frame to be unmarked
 543  */
 544 void cf_unmark_frame(capture_file *cf, frame_data *frame);
 545
 546 /**
 547  * Ignore a particular frame in a particular capture.
 548  *
 549  * @param cf the capture file
 550  * @param frame the frame to be ignored
 551  */
 552 void cf_ignore_frame(capture_file *cf, frame_data *frame);
 553
 554 /**
 555  * Unignore a particular frame in a particular capture.
 556  *
 557  * @param cf the capture file
 558  * @param frame the frame to be unignored
 559  */
 560 void cf_unignore_frame(capture_file *cf, frame_data *frame);
 561
 562 /**
 563  * Merge two (or more) capture files into one.
 564  * @todo is this the right place for this function? It doesn't have to do a lot with capture_file.
 565  *
 566  * @param out_filename pointer to output filename; if output filename is
 567  * NULL, a temporary file name is generated and *out_filename is set
 568  * to point to the generated file name
 569  * @param in_file_count the number of input files to merge
 570  * @param in_filnames array of input filenames
 571  * @param file_type the output filetype
 572  * @param do_append FALSE to merge chronologically, TRUE simply append
 573  * @return one of cf_status_t
 574  */
 575 cf_status_t
 576 cf_merge_files(char **out_filename, int in_file_count,
 577                char *const *in_filenames, int file_type, gboolean do_append);
 578
 579 #if defined(HAVE_HEIMDAL_KERBEROS) || defined(HAVE_MIT_KERBEROS)
 580 void read_keytab_file(const char *);
 581 #endif
 582
 583 #endif /* file.h */