In order to be able to dissect libvirt protocol the wireshark plugin needs to be registered. So far this plugin registration code was generated on every build using a script that was copied over from wireshark's tools/ directory. This is suboptimal, because the way that plugins register changes across wireshark releases. Therefore, let's keep the generated file in the git, put the command line used to generate the file into a comment and remove the script. This solution allows us to put different registration mechanism into one file (under #ifdef-s) and thus compile with wider range of wireshark releases. Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- .gitignore | 1 - tools/Makefile.am | 15 +- tools/wireshark/src/plugin.c | 45 ++++++ tools/wireshark/util/make-dissector-reg | 205 ------------------------ 4 files changed, 48 insertions(+), 218 deletions(-) create mode 100644 tools/wireshark/src/plugin.c delete mode 100755 tools/wireshark/util/make-dissector-reg diff --git a/.gitignore b/.gitignore index df0ac8e3d4..3303eed411 100644 --- a/.gitignore +++ b/.gitignore @@ -190,7 +190,6 @@ /tools/virt-admin /tools/virt-*-validate /tools/virt-sanlock-cleanup -/tools/wireshark/src/plugin.c /tools/wireshark/src/libvirt /update.log GPATH diff --git a/tools/Makefile.am b/tools/Makefile.am index 613c9a77f0..f2f84f7852 100644 --- a/tools/Makefile.am +++ b/tools/Makefile.am @@ -444,9 +444,7 @@ uninstall-bash-completion: endif ! WITH_BASH_COMPLETION -EXTRA_DIST += \ - wireshark/util/genxdrstub.pl \ - wireshark/util/make-dissector-reg +EXTRA_DIST += wireshark/util/genxdrstub.pl if WITH_WIRESHARK_DISSECTOR @@ -454,19 +452,14 @@ ws_plugin_LTLIBRARIES = wireshark/src/libvirt.la wireshark_src_libvirt_la_CFLAGS = \ -I wireshark/src $(WIRESHARK_DISSECTOR_CFLAGS) $(XDR_CFLAGS) wireshark_src_libvirt_la_LDFLAGS = -avoid-version -module -nodist_wireshark_src_libvirt_la_SOURCES = wireshark/src/plugin.c wireshark_src_libvirt_la_SOURCES = \ wireshark/src/packet-libvirt.h \ - wireshark/src/packet-libvirt.c + wireshark/src/packet-libvirt.c \ + wireshark/src/plugin.c wireshark/src/packet-libvirt.c: wireshark/src/packet-libvirt.h \ wireshark/src/libvirt/protocol.h -wireshark/src/plugin.c: wireshark/src/packet-libvirt.c - $(AM_V_GEN)cd wireshark/src && \ - $(abs_top_srcdir)/tools/wireshark/util/make-dissector-reg \ - . plugin packet-libvirt.c - WS_DISSECTOR_PROTO_FILES = \ $(abs_top_srcdir)/src/remote/remote_protocol.x \ $(abs_top_srcdir)/src/remote/qemu_protocol.x \ @@ -481,8 +474,6 @@ wireshark/src/libvirt/protocol.h: wireshark/util/genxdrstub.pl \ $(PERL) $(abs_top_srcdir)/tools/wireshark/util/genxdrstub.pl \ $(WS_DISSECTOR_PROTO_FILES) -CLEANFILES += wireshark/src/plugin.c - endif WITH_WIRESHARK_DISSECTOR if WITH_BSD_NSS diff --git a/tools/wireshark/src/plugin.c b/tools/wireshark/src/plugin.c new file mode 100644 index 0000000000..2a85688f43 --- /dev/null +++ b/tools/wireshark/src/plugin.c @@ -0,0 +1,45 @@ +/* + * plugin.c: Wireshark's plugin registration + * + * The registration routines were generated using wireshark's + * make-dissector-reg script (found under wirshark.git/tools/): + * + * libvirt.git/tools/wireshark/src $ \ + * /path/to/wireshark.git/tools/make-dissector-reg \ + * . plugin packet-libvirt.c + * + */ + +#include <config.h> + +#include <gmodule.h> + +/* plugins are DLLs */ +#define WS_BUILD_DLL +#include <wireshark/ws_symbol_export.h> + +#include "packet-libvirt.h" + +/* In 1.12 wireshark WS_DLL_PUBLIC_NOEXTERN was substitued with + * WS_DLL_PUBLIC_DEF. See wireshark's commit + * 5d87a8c46171f572568db5a47c093423482e342f for more info. */ +#ifndef WS_DLL_PUBLIC_NOEXTERN +# define WS_DLL_PUBLIC_NOEXTERN WS_DLL_PUBLIC_DEF +#endif + +#ifndef ENABLE_STATIC +WS_DLL_PUBLIC_NOEXTERN const gchar version[] = VERSION; + +/* Start the functions we need for the plugin stuff */ + +WS_DLL_PUBLIC_NOEXTERN void +plugin_register(void) +{ + proto_register_libvirt(); +} +WS_DLL_PUBLIC_NOEXTERN void +plugin_reg_handoff(void) +{ + proto_reg_handoff_libvirt(); +} +#endif diff --git a/tools/wireshark/util/make-dissector-reg b/tools/wireshark/util/make-dissector-reg deleted file mode 100755 index 6fa25c1eed..0000000000 --- a/tools/wireshark/util/make-dissector-reg +++ /dev/null @@ -1,205 +0,0 @@ -#! /bin/sh -# This program is free software; you can redistribute it and/or -# modify it under the terms of the GNU General Public License -# as published by the Free Software Foundation; either version 2 -# of the License, or (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program; if not, see <http://www.gnu.org/licenses/>. -# -# Copied from Wireshark(http://www.wireshark.org/) - -# -# The first argument is the directory in which the source files live. -# -srcdir="$1" -shift - -# -# The second argument is either "plugin" or "dissectors"; if it's -# "plugin", we build a plugin.c for a plugin, and if it's -# "dissectors", we build a register.c for libwireshark. -# -registertype="$1" -shift -if [ "$registertype" = plugin ] -then - outfile="plugin.c" -elif [ "$registertype" = dissectors ] -then - outfile="register.c" -else - echo "Unknown output type '$registertype'" 1>&2 - exit 1 -fi - -# -# All subsequent arguments are the files to scan. -# -rm -f ${outfile}-tmp -echo '/* Do not modify this file. */' >${outfile}-tmp -echo '/* It is created automatically by the Makefile. */'>>${outfile}-tmp -if [ "$registertype" = plugin ] -then - cat <<"EOF" >>${outfile}-tmp -#include "config.h" - -#include <gmodule.h> - -/* plugins are DLLs */ -#define WS_BUILD_DLL -#include "ws_symbol_export.h" - -/* In 1.12 wireshark WS_DLL_PUBLIC_NOEXTERN was substitued with - * WS_DLL_PUBLIC_DEF. See wireshark's commit - * 5d87a8c46171f572568db5a47c093423482e342f for more info. */ -#ifndef WS_DLL_PUBLIC_NOEXTERN -# define WS_DLL_PUBLIC_NOEXTERN WS_DLL_PUBLIC_DEF -#endif - -#ifndef ENABLE_STATIC -WS_DLL_PUBLIC_NOEXTERN const gchar version[] = VERSION; - -/* Start the functions we need for the plugin stuff */ - -WS_DLL_PUBLIC_NOEXTERN void -plugin_register (void) -{ -EOF -# -# Build code to call all the protocol registration routines. -# -for f in "$@" -do - if [ -f $f ] - then - srcfile=$f - else - srcfile=$srcdir/$f - fi - grep '^proto_register_[a-z_0-9A-Z]* *(' $srcfile 2>/dev/null | grep -v ';' -done | sed -e 's/^.*://' -e 's/^\([a-z_0-9A-Z]*\).*/ {extern void \1 (void); \1 ();}/' >>${outfile}-tmp -for f in "$@" -do - if [ -f $f ] - then - srcfile=$f - else - srcfile=$srcdir/$f - fi - grep '^void proto_register_[a-z_0-9A-Z]* *(' $srcfile 2>/dev/null | grep -v ';' -done | sed -e 's/^.*://' -e 's/^void \([a-z_0-9A-Z]*\).*/ {extern void \1 (void); \1 ();}/' >>${outfile}-tmp -else - cat <<"EOF" >>${outfile}-tmp -#include "register.h" -void -register_all_protocols(register_cb cb, gpointer client_data) -{ -EOF -# -# Build code to call all the protocol registration routines. -# -for f in "$@" -do - if [ -f $f ] - then - srcfile=$f - else - srcfile=$srcdir/$f - fi - grep '^proto_register_[a-z_0-9A-Z]* *(' $srcfile 2>/dev/null | grep -v ';' -done | sed -e 's/^.*://' -e 's/^\([a-z_0-9A-Z]*\).*/ {extern void \1 (void); if(cb) (*cb)(RA_REGISTER, \"\1\", client_data); \1 ();}/' >>${outfile}-tmp -for f in "$@" -do - if [ -f $f ] - then - srcfile=$f - else - srcfile=$srcdir/$f - fi - grep '^void proto_register_[a-z_0-9A-Z]* *(' $srcfile 2>/dev/null | grep -v ';' -done | sed -e 's/^.*://' -e 's/^void \([a-z_0-9A-Z]*\).*/ {extern void \1 (void); if(cb) (*cb)(RA_REGISTER, \"\1\", client_data); \1 ();}/' >>${outfile}-tmp - -fi -echo '}' >>${outfile}-tmp - - -# -# Build code to call all the protocol handoff registration routines. -# -if [ "$registertype" = plugin ] -then - cat <<"EOF" >>${outfile}-tmp -WS_DLL_PUBLIC_NOEXTERN void -plugin_reg_handoff(void) -{ -EOF -for f in "$@" -do - if [ -f $f ] - then - srcfile=$f - else - srcfile=$srcdir/$f - fi - grep '^proto_reg_handoff_[a-z_0-9A-Z]* *(' $srcfile 2>/dev/null | grep -v ';' -done | sed -e 's/^.*://' -e 's/^\([a-z_0-9A-Z]*\).*/ {extern void \1 (void); \1 ();}/' >>${outfile}-tmp -for f in "$@" -do - if [ -f $f ] - then - srcfile=$f - else - srcfile=$srcdir/$f - fi - grep '^void proto_reg_handoff_[a-z_0-9A-Z]* *(' $srcfile 2>/dev/null | grep -v ';' -done | sed -e 's/^.*://' -e 's/^void \([a-z_0-9A-Z]*\).*/ {extern void \1 (void); \1 ();}/' >>${outfile}-tmp -else - cat <<"EOF" >>${outfile}-tmp -void -register_all_protocol_handoffs(register_cb cb, gpointer client_data) -{ -EOF -for f in "$@" -do - if [ -f $f ] - then - srcfile=$f - else - srcfile=$srcdir/$f - fi - grep '^proto_reg_handoff_[a-z_0-9A-Z]* *(' $srcfile 2>/dev/null | grep -v ';' -done | sed -e 's/^.*://' -e 's/^\([a-z_0-9A-Z]*\).*/ {extern void \1 (void); if(cb) (*cb)(RA_HANDOFF, \"\1\", client_data); \1 ();}/' >>${outfile}-tmp -for f in "$@" -do - if [ -f $f ] - then - srcfile=$f - else - srcfile=$srcdir/$f - fi - grep '^void proto_reg_handoff_[a-z_0-9A-Z]* *(' $srcfile 2>/dev/null | grep -v ';' -done | sed -e 's/^.*://' -e 's/^void \([a-z_0-9A-Z]*\).*/ {extern void \1 (void); if(cb) (*cb)(RA_HANDOFF, \"\1\", client_data); \1 ();}/' >>${outfile}-tmp -fi -echo '}' >>${outfile}-tmp -if [ "$registertype" = plugin ] -then - echo '#endif' >>${outfile}-tmp -else - cat <<"EOF" >>${outfile}-tmp -gulong register_count(void) -{ -EOF - proto_regs=`grep RA_REGISTER ${outfile}-tmp | wc -l` - handoff_regs=`grep RA_HANDOFF ${outfile}-tmp | wc -l` - echo " return $proto_regs + $handoff_regs;" >>${outfile}-tmp - echo '}' >>${outfile}-tmp -fi - -# Only overwrite outfile if it differs from newly generated file -mv ${outfile}-tmp ${outfile} -- 2.19.2

Since wirshark-2.5.0 toplevel plugins are no longer loaded. Only plugins from epan/, wiretap/ or codecs/ subdirs are. Update the plugin dir we generate. This is safe to do even for older wiresharks, since they load plugins from there too. Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- libvirt.spec.in | 4 ++-- m4/virt-wireshark.m4 | 6 ++++++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/libvirt.spec.in b/libvirt.spec.in index c0e538d92d..13f41bb4a5 100644 --- a/libvirt.spec.in +++ b/libvirt.spec.in @@ -168,9 +168,9 @@ %define with_wireshark 0%{!?_without_wireshark:1} %endif %if 0%{?fedora} || 0%{?rhel} > 7 - %define wireshark_plugindir %(pkg-config --variable plugindir wireshark) + %define wireshark_plugindir %(pkg-config --variable plugindir wireshark)/epan %else - %define wireshark_plugindir %{_libdir}/wireshark/plugins + %define wireshark_plugindir %{_libdir}/wireshark/plugins/epan %endif # Enable libssh transport for new enough distros diff --git a/m4/virt-wireshark.m4 b/m4/virt-wireshark.m4 index 1283a0f403..a8f8083f5e 100644 --- a/m4/virt-wireshark.m4 +++ b/m4/virt-wireshark.m4 @@ -50,6 +50,12 @@ AC_DEFUN([LIBVIRT_CHECK_WIRESHARK],[ dnl time ws_plugindir='${exec_prefix}'"${ws_plugindir#$ws_exec_prefix}" fi + + dnl Since wireshark 2.5.0 plugins can't leave in top level + dnl plugindir but have to be under one of ["epan", + dnl "wiretap", "codecs"] subdir. The first one looks okay. + ws_plugindir="$ws_plugindir/epan" + elif test "x$with_ws_plugindir" = "xno" || test "x$with_ws_plugindir" = "xyes"; then AC_MSG_ERROR([ws-plugindir must be used only with valid path]) else -- 2.19.2

The wireshark-2.4.0 is almost 2 years old now. Assuming anybody interested in running latest libvirt doesn't run old wireshark, it is safe to do this. It also simplifies the code. Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- libvirt.spec.in | 8 ++---- m4/virt-wireshark.m4 | 4 +-- tools/wireshark/src/packet-libvirt.c | 39 ---------------------------- tools/wireshark/src/plugin.c | 14 +++------- 4 files changed, 7 insertions(+), 58 deletions(-) diff --git a/libvirt.spec.in b/libvirt.spec.in index 13f41bb4a5..9beffba203 100644 --- a/libvirt.spec.in +++ b/libvirt.spec.in @@ -166,11 +166,7 @@ # Enable wireshark plugins for all distros shipping libvirt 1.2.2 or newer %if 0%{?fedora} %define with_wireshark 0%{!?_without_wireshark:1} -%endif -%if 0%{?fedora} || 0%{?rhel} > 7 %define wireshark_plugindir %(pkg-config --variable plugindir wireshark)/epan -%else - %define wireshark_plugindir %{_libdir}/wireshark/plugins/epan %endif # Enable libssh transport for new enough distros @@ -389,7 +385,7 @@ BuildRequires: numad %endif %if %{with_wireshark} -BuildRequires: wireshark-devel >= 2.1.0 +BuildRequires: wireshark-devel >= 2.4.0 %endif %if %{with_libssh} @@ -935,7 +931,7 @@ Bash completion script stub. %if %{with_wireshark} %package wireshark Summary: Wireshark dissector plugin for libvirt RPC transactions -Requires: wireshark >= 1.12.6-4 +Requires: wireshark >= 2.4.0 Requires: %{name}-libs = %{version}-%{release} %description wireshark diff --git a/m4/virt-wireshark.m4 b/m4/virt-wireshark.m4 index a8f8083f5e..2fbf691590 100644 --- a/m4/virt-wireshark.m4 +++ b/m4/virt-wireshark.m4 @@ -18,14 +18,14 @@ dnl <http://www.gnu.org/licenses/>. dnl AC_DEFUN([LIBVIRT_ARG_WIRESHARK],[ - LIBVIRT_ARG_WITH_FEATURE([WIRESHARK_DISSECTOR], [wireshark], [check], [1.11.3]) + LIBVIRT_ARG_WITH_FEATURE([WIRESHARK_DISSECTOR], [wireshark], [check], [2.4.0]) LIBVIRT_ARG_WITH([WS_PLUGINDIR], [wireshark plugins directory for use when installing wireshark plugin], [check]) ]) AC_DEFUN([LIBVIRT_CHECK_WIRESHARK],[ - LIBVIRT_CHECK_PKG([WIRESHARK_DISSECTOR], [wireshark], [1.11.3]) + LIBVIRT_CHECK_PKG([WIRESHARK_DISSECTOR], [wireshark], [2.4.0]) dnl Check for system location of wireshark plugins if test "x$with_wireshark_dissector" != "xno" ; then diff --git a/tools/wireshark/src/packet-libvirt.c b/tools/wireshark/src/packet-libvirt.c index e759e81bae..dc3aa410e5 100644 --- a/tools/wireshark/src/packet-libvirt.c +++ b/tools/wireshark/src/packet-libvirt.c @@ -42,12 +42,6 @@ # define dbg(fmt, ...) #endif -/* Wireshark 1.12 brings API change */ -#define WIRESHARK_VERSION \ - ((VERSION_MAJOR * 1000 * 1000) + \ - (VERSION_MINOR * 1000) + \ - (VERSION_MICRO)) - static int proto_libvirt = -1; static int hf_libvirt_length = -1; static int hf_libvirt_program = -1; @@ -373,17 +367,8 @@ dissect_libvirt_payload_xdr_data(tvbuff_t *tvb, proto_tree *tree, gint payload_l payload_length -= 4; } -#if WIRESHARK_VERSION < 200400 - payload_tvb = tvb_new_subset(tvb, start, -1, payload_length); -#else payload_tvb = tvb_new_subset_remaining(tvb, start); -#endif - -#if WIRESHARK_VERSION < 1012000 - payload_data = (caddr_t)tvb_memdup(payload_tvb, 0, payload_length); -#else payload_data = (caddr_t)tvb_memdup(NULL, payload_tvb, 0, payload_length); -#endif xdrmem_create(&xdrs, payload_data, payload_length, XDR_DECODE); dissect(payload_tvb, tree, &xdrs, -1); @@ -456,14 +441,9 @@ dissect_libvirt_payload(tvbuff_t *tvb, proto_tree *tree, proto_tree_add_item(tree, hf_libvirt_unknown, tvb, VIR_HEADER_LEN, -1, ENC_NA); } -#if WIRESHARK_VERSION < 1012000 -static void -dissect_libvirt_message(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree) -#else static int dissect_libvirt_message(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *opaque ATTRIBUTE_UNUSED) -#endif { goffset offset; guint32 prog, proc, type, serial, status; @@ -524,44 +504,25 @@ dissect_libvirt_message(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, dissect_libvirt_payload(tvb, libvirt_tree, prog, proc, type, status); } -#if WIRESHARK_VERSION >= 1012000 return 0; -#endif } -#if WIRESHARK_VERSION >= 1099002 static guint get_message_len(packet_info *pinfo ATTRIBUTE_UNUSED, tvbuff_t *tvb, int offset, void *data ATTRIBUTE_UNUSED) -#else -static guint32 -get_message_len(packet_info *pinfo ATTRIBUTE_UNUSED, tvbuff_t *tvb, int offset) -#endif { return tvb_get_ntohl(tvb, offset); } -#if WIRESHARK_VERSION >= 2000001 static int dissect_libvirt(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data ATTRIBUTE_UNUSED) -#else -static void -dissect_libvirt(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree) -#endif { /* Another magic const - 4; simply, how much bytes * is needed to tell the length of libvirt packet. */ -#if WIRESHARK_VERSION < 1012000 - tcp_dissect_pdus(tvb, pinfo, tree, TRUE, 4, - get_message_len, dissect_libvirt_message); -#else tcp_dissect_pdus(tvb, pinfo, tree, TRUE, 4, get_message_len, dissect_libvirt_message, NULL); -#endif -#if WIRESHARK_VERSION >= 2000001 return tvb_captured_length(tvb); -#endif } void diff --git a/tools/wireshark/src/plugin.c b/tools/wireshark/src/plugin.c index 3741334e85..504e4383a7 100644 --- a/tools/wireshark/src/plugin.c +++ b/tools/wireshark/src/plugin.c @@ -31,29 +31,21 @@ (VERSION_MICRO)) #if WIRESHARK_VERSION < 2005000 -/* In 1.12 wireshark WS_DLL_PUBLIC_NOEXTERN was substitued with - * WS_DLL_PUBLIC_DEF. See wireshark's commit - * 5d87a8c46171f572568db5a47c093423482e342f for more info. */ -# ifndef WS_DLL_PUBLIC_NOEXTERN -# define WS_DLL_PUBLIC_NOEXTERN WS_DLL_PUBLIC_DEF -# endif -# ifndef ENABLE_STATIC -WS_DLL_PUBLIC_NOEXTERN const gchar version[] = VERSION; +WS_DLL_PUBLIC_DEF const gchar version[] = VERSION; /* Start the functions we need for the plugin stuff */ -WS_DLL_PUBLIC_NOEXTERN void +WS_DLL_PUBLIC_DEF void plugin_register(void) { proto_register_libvirt(); } -WS_DLL_PUBLIC_NOEXTERN void +WS_DLL_PUBLIC_DEF void plugin_reg_handoff(void) { proto_reg_handoff_libvirt(); } -# endif #elif WIRESHARK_VERSION < 2009000 -- 2.19.2