lustre/contrib/wireshark/README

   1 Instructions for Building Lustre/LNet Wireshark Support
   2 -------------------------------------------------------
   3
   4 To compile the RPMs for Wireshark and the Lustre/LNet wireshark
   5 plugins, please follow the instruction in paragraph
   6 'Build with packaging support'.
   7
   8 In case you prefer a lightweight compilation and installation without
   9 any packging 'overhead', please follow the instruction in paragraph
  10 'Build without packaging support'.
  11
  12
  13 Supported distributions:
  14
  15     CentOS 6.3   i686, x86_64
  16     SLES 11 SP1        x86_64
  17     SLES 11 SP2        x86_64
  18
  19
  20 Software Pre-requisits:
  21 To run and compile wirkshark the following software needs to be installed
  22     gtk2
  23     gtk2-devel
  24     glib2
  25     libpcap
  26     libpcap-devel
  27     perl
  28
  29
  30 Build with packaging support
  31 -------------------------------
  32 Simply type ./wsbuild on a node that match one of the disribution specified
  33 above to create the RPMs for wirkshark and the associated Lustre/LNet plugins.
  34
  35 Upon success the build results can be found in directory
  36 'wireshark-<version>/packaging/rpm/RPMS/x86_64' relative to this directory.
  37 The RPMs are:
  38
  39     wireshark-<version>-2.x86_64.rpm
  40     lustre-wireshark-plugins-<version>-2.x86_64.rpm
  41
  42 If one of the software components that need to be available for
  43 compilation (see 'Software Pre-requisits:' above) is missing the script will
  44 print an appropiate error message. The wireshark 'configure' script might also
  45 detect missing pre-requisite software. In both cases the software needs to be
  46 installed before.
  47
  48 The build can be configured with help of the source file 'wsconfig.sh', but should
  49 out of the box.
  50
  51
  52 Build without packaging support
  53 -------------------------------
  54 Pre-requisits:
  55
  56 - source tree for Wireshark (recommend version 1.6.8)
  57 - build Wireshark according to the instruction in the source tree.
  58 - install Wireshark (usually "make install")
  59
  60 Building Lustre/LNet Dissectors:
  61
  62 - edit the Makefile in the same directory as this README.
  63 - change this line to reflect where your Wireshark source tree is:
  64
  65 INCS = -I$(HOME)/wireshark-1.6.8 `pkg-config --libs --cflags glib-2.0`
  66
  67 - change this line to reflect where the Wireshark plugin directory is:
  68
  69 PLUGIN_DIR  = /usr/local/lib/wireshark/plugins/1.6.8
  70
  71 - save the Makefile after these changes.
  72 - run "make".  (you may need to be "root" for this as it will try to copy the
  73   dissectors to the Wireshark plugin directory.
  74
  75 As long as the make builds with no errors, you should have the dissectors built
  76 and installed for your version of Wireshark.
  77
  78 To verify that the plugins are installed:
  79 - run wirewhark (typing "wireshark" from the command line is usually good
  80   enough).
  81 - Select "About Wireshark" from the Help menu.
  82 - Click on the "Plugins" tab of the About window.
  83 - Look in the list for the Lustre and LNet plugins.
  84
  85 If they are there, the plugins are installed.  If not, something went wrong
  86 in the build process.
  87
  88 Note:  You can use tcpdump to capture packets on an Ethernet network, or
  89 ibdump to capture packets on an Infiniband network.  Tcpdump is usually already
  90 installed on most Linux distros.  You can get ibdump from this link:
  91
  92 http://www.mellanox.com/content/pages.php?pg=products_dyn&product_family=110&menu_section=34