diff options
Diffstat (limited to 'extras/wireshark/readme.md')
| -rw-r--r-- | extras/wireshark/readme.md | 53 |
1 files changed, 28 insertions, 25 deletions
diff --git a/extras/wireshark/readme.md b/extras/wireshark/readme.md index d47806d53f2..fe4fdbfeb5a 100644 --- a/extras/wireshark/readme.md +++ b/extras/wireshark/readme.md @@ -1,25 +1,31 @@ How to build a vpp dispatch trace aware Wireshark ================================================= -At some point, we will upstream our vpp pcap dispatch trace dissector. -It's not finished - contributions welcome - and we have to work through -whatever issues will be discovered during the upstreaming process. +We have upstreamed our vpp pcap dispatch trace dissector. After +working through a laundry list of issues discovered during the +upstreaming process, it appears that the code is close to being +merged. See https://code.wireshark.org/review/#/c/31466. -On the other hand, it's ready for some tire-kicking. Here's how to build -wireshark +As of this writing, the simplest way to build a vpp dispatch trace +aware wireshark is to clone the wireshark repo, and apply the vpp +dissector patch. -Download and patch wireshark source code ------------------------------------------ -The wireshark git repo is large, so it takes a while to clone. +Download wireshark source code +------------------------------ + +The wireshark git repo is large, so it takes a while to clone. ``` git clone https://code.wireshark.org/review/wireshark - cp .../extras/wireshark/packet-vpp.c wireshark/epan/dissectors - patch -p1 < .../extras/wireshark/diffs.txt ``` -The small patch adds packet-vpp.c to the dissector list. +Download Gerrit 31466 using the URL shown above. If you have "git +review" set up, it's as simple as "git review -d 31466" in the wireshark +workspace. + +Alternatively, download a patch-file from the gerrit server and apply +the patch. Install prerequisite Debian packages ------------------------------------ @@ -36,13 +42,14 @@ to compile wireshark, beyond what's typically installed on an Ubuntu Compile Wireshark ----------------- -Mercifully, Wireshark uses cmake, so it's relatively easy to build, at -least on Ubuntu 18.04. - +Wireshark uses cmake, so it's relatively easy to build, at least on +Ubuntu 18.04. ``` $ cd wireshark - $ cmake -G Ninja + $ mkdir build + $ cd build + $ cmake -G Ninja ../ $ ninja -j 8 $ sudo ninja install ``` @@ -67,15 +74,11 @@ dispatch trace capture like so: Display in Wireshark -------------------- -Display /tmp/vppcapture in the vpp-enabled version of wireshark. With -any luck, normal version of wireshark will refuse to process vpp -dispatch trace pcap files because they won't understand the encap type. +Display /tmp/vppcapture in the vpp-enabled version of wireshark. +Normal version of wireshark will refuse to process vpp dispatch trace +pcap files because they won't understand the encap type. Set wireshark to filter on vpp.bufferindex to watch a single packet -traverse the forwarding graph. Otherwise, you'll see a vector of packets -in e.g. ip4-lookup, then a vector of packets in ip4-rewrite, etc. - - - - - +traverse the forwarding graph. Otherwise, you'll see a vector of +packets in e.g. ip4-lookup, then a vector of packets in ip4-rewrite, +etc. |