doc/README.capture

   1 This document is an attempt, to bring some light to the things done, when
   2 packet capturing is performed. There might be things missing, and others
   3 maybe wrong :-( The following will concentrate a bit on the Windows
   4 port of Wireshark.
   5
   6
   7 XXX: when ongoing file reorganization will be completed, the following
   8 two lists maybe won't be needed any longer!
   9
  10 libpcap related source files:
  11 -----------------------------
  12 capture-pcap-util.c
  13 capture-pcap-util.h
  14 capture-pcap-util-int.h
  15 capture-pcap-util-unix.c
  16 capture-wpcap.c
  17 capture-wpcap.h
  18
  19 Capture related source files:
  20 -----------------------------
  21 capture.c
  22 capture.h
  23 capture_loop.c
  24 capture_loop.h
  25 capture_opts.c
  26 capture_sync.c
  27 capture_ui_utils.c
  28 capture_ui_utils.h
  29
  30
  31 Capture driver
  32 --------------
  33 Wireshark doesn't have direct access to the capture hardware. Instead of this,
  34 it uses the Libpcap/Npcap library to capture data from network cards.
  35
  36 On Win32, in capture-wpcap.c the function load_wpcap_module() is called
  37 to load the wpcap.dll. This dll includes all functions needed for
  38 packet capturing.
  39
  40
  41
  42 Capture File
  43 ------------
  44 There are some kinds of targets to put the capture data into:
  45
  46 -temporary file
  47 -user specified "single" capture file
  48 -user specified "ringbuffer" capture file
  49
  50 Which kind of file is used depends on the user settings. In principle there
  51 is no difference in handling these files, so if not otherwise notified,
  52 it will be called the capture file.
  53
  54 The capture file is stored, using the wiretap library.
  55
  56
  57 Overview
  58 --------
  59 Capturing is done using a two task model: the currently running (parent)
  60 process will spawn a child process to do the real capture work, namely
  61 controlling libpcap. This two task model is used because it's necessary
  62 to split the capturing process (which should avoid packet drop) from the parent
  63 process which might need significant time to display the data.
  64
  65 When a capture is started, the parent builds a "command line" and creates a
  66 new child process with it. A pipe from the child to the parent is created
  67 which is used to transfer control messages.
  68
  69 The child will init libpcap and send the parent a "new capture file is used"
  70 control message through the pipe.
  71
  72 The child cyclically takes the packet data from libpcap and saves it to disk.
  73 From time to time it will send the parent a "new packets" control message.
  74
  75 If the parent process receives this "new packets" message and the option
  76 "Update list of packets in real time" is used, it will read the packet data
  77 from the file, dissect and display it.
  78
  79
  80 If the user wants to stop the capture, this can be done in two ways: by
  81 menu/toolbar of the parent process or the Stop button of the child processes
  82 dialog box (which obviously cannot be used it this dialog is hidden).
  83
  84 The Stop button will stop the capture itself, close the control pipe and then
  85 closes itself. The parent will detect this and stop its part of the capture.
  86
  87 If the menu/toolbar is used, the parent will send a break signal to the child
  88 which will lead to the same sequence as described above.
  89
  90 Win32 only: as the windows implementation of signals simply doesn't work,
  91 another pipe from the parent to the child is used to send a "close capture"
  92 message instead of a signal.
  93
  94
  95 Start capture
  96 -------------
  97 A capture is started, by specifying to start the capture at the command line,
  98 trigger the OK button in the "Capture Options" dialog box and some more. The
  99 capture start is actually done by calling the capture_start() function in
 100 capture.c.
 101
 102
 103 Capture child (Loop)
 104 --------------------
 105 The capture child will open the target capture file, prepare pcap things,
 106 init stop conditions, init the capture statistic dialog (if not hidden) and
 107 start a loop which is running until the flag ld.go is false.
 108
 109 Inside this loop,
 110
 111 -Qt main things are updated
 112 -pcap_dispatch(capture_pcap_cb) is called
 113 -the capture stop conditions are checked (ld.go is set to false to finish)
 114 -update the capture statistic dialog (if not hidden)
 115
 116 While this loop is running, the pcap_dispatch() will call capture_pcap_cb()
 117 for every packet captured. Inside this, the packet data is converted into
 118 wtap (wiretap) format and saved to file. Beside saving, it is trying to
 119 do some basic dissecting (for the statistic window), by calling the
 120 appropriate capture_xxx function.
 121
 122 When the user triggered a capture stop or one of the capture stop conditions
 123 matched, the ld.go flag is set to false, and the loop will stop shortly after.
 124
 125
 126 Capture parent
 127 --------------
 128 In the capture parent the cap_pipe_input_cb() function is called "cyclically"
 129 (unix:waiting for pipe, win32:timer,1000ms) to read data from the pipe and show
 130 it on the main screen. While the capture is in progress, no other capture file
 131 can be opened.
 132
 133
 134 Updating
 135 --------
 136 The actual packet capturing inside the libpcap is done using its own task.
 137 Catching and processing the packet data from the libpcap is done using the
 138 pcap_dispatch() function.