osmocom
/
wireshark
11
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity
wireshark/cmake/modules/WiresharkPlugin.cmake

85 lines
2.7 KiB
CMake
Raw Normal View History

CMake: Set an output directory for plugins. Redefine PLUGIN_DIR similar to DATAFILE_DIR and use it on all platforms. Add WiresharkPlugin.cmake so that we can start defining common macros for plugins/*/CMakeLists.txt. Load plugins in out-of-tree builds. Change-Id: I8c1359ed3cf8a71788b8320ff89dfe2d3969def2 Reviewed-on: https://code.wireshark.org/review/6640 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-01-18 21:27:13 +00:00
# Plugin convenience macros.
Remove Nmake build system Change-Id: I3bd474f3cda9667dec66426b5729449953df3e61 Reviewed-on: https://code.wireshark.org/review/15777 Petri-Dish: Pascal Quantin <pascal.quantin@gmail.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Jörg Mayer <jmayer@loplof.de> Reviewed-by: Balint Reczey <balint@balintreczey.hu>
2016-06-08 13:57:00 +00:00
# Set information
CMake: Set an output directory for plugins. Redefine PLUGIN_DIR similar to DATAFILE_DIR and use it on all platforms. Add WiresharkPlugin.cmake so that we can start defining common macros for plugins/*/CMakeLists.txt. Load plugins in out-of-tree builds. Change-Id: I8c1359ed3cf8a71788b8320ff89dfe2d3969def2 Reviewed-on: https://code.wireshark.org/review/6640 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-01-18 21:27:13 +00:00
macro(SET_MODULE_INFO _plugin _ver_major _ver_minor _ver_micro _ver_extra)
plugins: Remove redundant plugin.rc.in files plugin.rc is Windows specific, also add condition to reflect that. Change-Id: Ibbb7dab77dd1f277e2302c8f931218ca433f8c72 Reviewed-on: https://code.wireshark.org/review/24833 Reviewed-by: João Valverde <j@v6e.pt> Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com>
2017-12-15 00:04:32 +00:00
if(WIN32)
# Create the Windows .rc file for the plugin.
plugin.rc.in: Cleanup some unnecessary code Also add comment noting that MSVC_VARIANT is not the same thing as CMAKE_GENERATOR. Change-Id: Icc0f4a491786e4045c650509957655ef41352b29 Reviewed-on: https://code.wireshark.org/review/24846 Reviewed-by: João Valverde <j@v6e.pt>
2017-12-15 22:13:59 +00:00
set(MODULE_NAME ${_plugin})
plugins: Remove redundant plugin.rc.in files plugin.rc is Windows specific, also add condition to reflect that. Change-Id: Ibbb7dab77dd1f277e2302c8f931218ca433f8c72 Reviewed-on: https://code.wireshark.org/review/24833 Reviewed-by: João Valverde <j@v6e.pt> Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com>
2017-12-15 00:04:32 +00:00
set(MODULE_VERSION_MAJOR ${_ver_major})
set(MODULE_VERSION_MINOR ${_ver_minor})
set(MODULE_VERSION_MICRO ${_ver_micro})
set(MODULE_VERSION_EXTRA ${_ver_extra})
set(MODULE_VERSION "${MODULE_VERSION_MAJOR}.${MODULE_VERSION_MINOR}.${MODULE_VERSION_MICRO}.${MODULE_VERSION_EXTRA}")
set(RC_MODULE_VERSION "${MODULE_VERSION_MAJOR},${MODULE_VERSION_MINOR},${MODULE_VERSION_MICRO},${MODULE_VERSION_EXTRA}")
set(MSVC_VARIANT "${CMAKE_GENERATOR}")
# Create the plugin.rc file from the template
if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/plugin.rc.in)
set(_plugin_rc_in ${CMAKE_CURRENT_SOURCE_DIR}/plugin.rc.in)
else()
set(_plugin_rc_in ${CMAKE_SOURCE_DIR}/plugins/plugin.rc.in)
endif()
configure_file(${_plugin_rc_in} plugin.rc @ONLY)
CMake: Replace generator expression with variable Should fix OSX buildbot. Change-Id: I52abdeab8c547079edc8aec6a0c6e12e928838c6 Reviewed-on: https://code.wireshark.org/review/24873 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot Reviewed-by: João Valverde <j@v6e.pt>
2017-12-17 12:26:26 +00:00
set(PLUGIN_RC_FILE ${CMAKE_CURRENT_BINARY_DIR}/plugin.rc)
plugins: Remove redundant plugin.rc.in files plugin.rc is Windows specific, also add condition to reflect that. Change-Id: Ibbb7dab77dd1f277e2302c8f931218ca433f8c72 Reviewed-on: https://code.wireshark.org/review/24833 Reviewed-by: João Valverde <j@v6e.pt> Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com>
2017-12-15 00:04:32 +00:00
endif()
plugins: Remove moduleinfo.h Micro version bump for mate to homogenize it between CMake and autotools. The cmake macro doesn't handle the "a" suffix and it doesn't seem worth implementing. Change-Id: Ib022c6aa170623b83a9700e4fa098c60a9cddfab Reviewed-on: https://code.wireshark.org/review/24847 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot Reviewed-by: João Valverde <j@v6e.pt>
2017-12-15 00:49:31 +00:00
set(PLUGIN_VERSION "${_ver_major}.${_ver_minor}.${_ver_micro}")
add_definitions(-DPLUGIN_VERSION=\"${PLUGIN_VERSION}\")
CMake: Set an output directory for plugins. Redefine PLUGIN_DIR similar to DATAFILE_DIR and use it on all platforms. Add WiresharkPlugin.cmake so that we can start defining common macros for plugins/*/CMakeLists.txt. Load plugins in out-of-tree builds. Change-Id: I8c1359ed3cf8a71788b8320ff89dfe2d3969def2 Reviewed-on: https://code.wireshark.org/review/6640 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-01-18 21:27:13 +00:00
endmacro()
Don't link wiretap plugins with libwireshark. Make the second argument to add_plugin_library() and install_plugin() be a plugin type - currently, either "epan" or "wiretap" - and, based on its value, set the subfolder and required libraries in add_plugin_library() and the subfolder in install_plugin(). If it's not one of the known values, fail. Change-Id: I556863772c59330d2854fbb4673f544f8359dcd2 Reviewed-on: https://code.wireshark.org/review/25579 Petri-Dish: Guy Harris <guy@alum.mit.edu> Tested-by: Petri Dish Buildbot Reviewed-by: Guy Harris <guy@alum.mit.edu>
2018-02-03 20:25:24 +00:00
macro(ADD_PLUGIN_LIBRARY _plugin _plugin_type)
if(${_plugin_type} STREQUAL "epan")
set(_subfolder "epan")
set(_required_libraries "epan")
elseif(${_plugin_type} STREQUAL "wiretap")
set(_subfolder "wiretap")
set(_required_libraries "wiretap")
else()
message(FATAL_ERROR "add_plugin_library called with invalid plugin type ${_plugin_type}")
endif()
Fix (and chop) static build option This sets the scope of the static build option to Wireshark support libraries only. Before the patch: Static plugins don't work with CMake and autotools. autotools static build is broken, and most likely will always be, as building Wireshark all-static is difficult and time-consuming. After the patch: For CMake Wireshark will be built with static or shared libraries and dynamic plugins. Everything just works. CMake apparently doesn't want you building static and shared libraries at the same time. For autotools Wireshark will be built with shared libraries by default. --disable-shared and --enable-static options work as usual. Dlopened plugins are not built if --disable-shared is given to configure (to disable shared libraries). This is a limitations imposed by libtool. Tested on Linux. This removes broken support for building plugins statically. Change-Id: Ib8e8176976f136eea93a2ce8f9857b6cf9bec64c Reviewed-on: https://code.wireshark.org/review/24241 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot Reviewed-by: João Valverde <j@v6e.pt>
2017-11-01 20:22:32 +00:00
add_library(${_plugin} MODULE
CMake: Set an output directory for plugins. Redefine PLUGIN_DIR similar to DATAFILE_DIR and use it on all platforms. Add WiresharkPlugin.cmake so that we can start defining common macros for plugins/*/CMakeLists.txt. Load plugins in out-of-tree builds. Change-Id: I8c1359ed3cf8a71788b8320ff89dfe2d3969def2 Reviewed-on: https://code.wireshark.org/review/6640 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-01-18 21:27:13 +00:00
${PLUGIN_FILES}
CMake: Replace generator expression with variable Should fix OSX buildbot. Change-Id: I52abdeab8c547079edc8aec6a0c6e12e928838c6 Reviewed-on: https://code.wireshark.org/review/24873 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot Reviewed-by: João Valverde <j@v6e.pt>
2017-12-17 12:26:26 +00:00
${PLUGIN_RC_FILE}
CMake: Set an output directory for plugins. Redefine PLUGIN_DIR similar to DATAFILE_DIR and use it on all platforms. Add WiresharkPlugin.cmake so that we can start defining common macros for plugins/*/CMakeLists.txt. Load plugins in out-of-tree builds. Change-Id: I8c1359ed3cf8a71788b8320ff89dfe2d3969def2 Reviewed-on: https://code.wireshark.org/review/6640 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-01-18 21:27:13 +00:00
)
set_target_properties(${_plugin} PROPERTIES
PREFIX ""
LINK_FLAGS "${WS_LINK_FLAGS}"
FOLDER "Plugins"
)
plugins: Add source tree subfolder for plugin library This allows some simplification and makes things more consistent, particularly for loading plugins from the build dir. Also fixes the issue reported here: https://www.wireshark.org/lists/wireshark-dev/201801/msg00061.html Change-Id: I0d8a000ee679172bccad546a3b0c47a79486f44d Reviewed-on: https://code.wireshark.org/review/25329 Petri-Dish: João Valverde <j@v6e.pt> Reviewed-by: João Valverde <j@v6e.pt>
2018-01-15 12:40:55 +00:00
set_target_properties(${_plugin} PROPERTIES
LIBRARY_OUTPUT_DIRECTORY ${PLUGIN_DIR}/${_subfolder}
CMake: Set an output directory for plugins. Redefine PLUGIN_DIR similar to DATAFILE_DIR and use it on all platforms. Add WiresharkPlugin.cmake so that we can start defining common macros for plugins/*/CMakeLists.txt. Load plugins in out-of-tree builds. Change-Id: I8c1359ed3cf8a71788b8320ff89dfe2d3969def2 Reviewed-on: https://code.wireshark.org/review/6640 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-01-18 21:27:13 +00:00
)
# Try to force output to ${PLUGIN_DIR} without the configuration
Use an enum for plugin types. Make plugins.c the source of truth for plugin names. Where plugins reside and what they do are two different things, so split the plugin directory and description into two separate elements. CMake creates portable[1] builds on Windows and macOS. That is, the build-time directory layout is the same as the installation directory layout. Adjust various plugin paths macOS accordingly. [1] You have to run osx-app.sh on macOS to prepare the application bundle, but the goal is to create a directory/bundle that can be moved or copied to a different system and run in the new location. Change-Id: Icf9d02e61918fdf1404468baf52542910edf2743 Reviewed-on: https://code.wireshark.org/review/25166 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2018-01-05 17:09:40 +00:00
# type appended. Needed on Windows.
CMake: Set an output directory for plugins. Redefine PLUGIN_DIR similar to DATAFILE_DIR and use it on all platforms. Add WiresharkPlugin.cmake so that we can start defining common macros for plugins/*/CMakeLists.txt. Load plugins in out-of-tree builds. Change-Id: I8c1359ed3cf8a71788b8320ff89dfe2d3969def2 Reviewed-on: https://code.wireshark.org/review/6640 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-01-18 21:27:13 +00:00
foreach(_config_type ${CMAKE_CONFIGURATION_TYPES})
string(TOUPPER ${_config_type} _config_upper)
set_target_properties(${_plugin} PROPERTIES
Refactor plugin registration and loading Put different types of plugins (libwiretap, libwireshark) in different subdirectories, give libwiretap and libwireshark init routines that load the plugins, and have them scan the appropriate subdirectories so that we don't even *try* to, for example, load libwireshark plugins in programs that only use libwiretap. Compiled plugins are stored in subfolders of the plugin folders, with the subfolder name being the Wireshark minor version number (X.Y). There is another hierarchical level for each Wireshark library (libwireshark, libwscodecs and libwiretap). The folder names are respectively plugins/X.Y/{epan,codecs,wiretap}. Currently we only distribute "epan" (libwireshark) plugins. Change-Id: I3438787a6f45820d64ba4ca91cbe3c8864708acb Reviewed-on: https://code.wireshark.org/review/23983 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot Reviewed-by: João Valverde <j@v6e.pt>
2017-09-30 23:56:03 +00:00
LIBRARY_OUTPUT_DIRECTORY_${_config_upper} ${CMAKE_BINARY_DIR}/run/${_config_type}/${PLUGIN_VERSION_DIR}/${_subfolder}
CMake: Set an output directory for plugins. Redefine PLUGIN_DIR similar to DATAFILE_DIR and use it on all platforms. Add WiresharkPlugin.cmake so that we can start defining common macros for plugins/*/CMakeLists.txt. Load plugins in out-of-tree builds. Change-Id: I8c1359ed3cf8a71788b8320ff89dfe2d3969def2 Reviewed-on: https://code.wireshark.org/review/6640 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-01-18 21:27:13 +00:00
)
endforeach()
Don't link wiretap plugins with libwireshark. Make the second argument to add_plugin_library() and install_plugin() be a plugin type - currently, either "epan" or "wiretap" - and, based on its value, set the subfolder and required libraries in add_plugin_library() and the subfolder in install_plugin(). If it's not one of the known values, fail. Change-Id: I556863772c59330d2854fbb4673f544f8359dcd2 Reviewed-on: https://code.wireshark.org/review/25579 Petri-Dish: Guy Harris <guy@alum.mit.edu> Tested-by: Petri Dish Buildbot Reviewed-by: Guy Harris <guy@alum.mit.edu>
2018-02-03 20:25:24 +00:00
target_link_libraries(${_plugin} ${_required_libraries})
CMake: Add a top-level nsis_package target. Add packaging/nsis/CMakeLists.txt and use it to generate each NSIS include file. Add macros to generate packaging-related targets and invoke them from the top-level CMakeLists.txt. Add a top-level "plugins" target. Copy plugins to "plugins" in each of our staging directories instead of "plugins/$VERSION". Add missing files to the copy_data_files and copy_cli_dlls targets. Add all files in the NSIS package from the staging directory. Drop a bunch of no-longer-needed defines, e.g. MSVC_VARIANT. Change-Id: Ib1079260d164c65118050f1431af8e582cd577fa Reviewed-on: https://code.wireshark.org/review/6459 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-01-06 23:07:50 +00:00
add_dependencies(plugins ${_plugin})
CMake: Set an output directory for plugins. Redefine PLUGIN_DIR similar to DATAFILE_DIR and use it on all platforms. Add WiresharkPlugin.cmake so that we can start defining common macros for plugins/*/CMakeLists.txt. Load plugins in out-of-tree builds. Change-Id: I8c1359ed3cf8a71788b8320ff89dfe2d3969def2 Reviewed-on: https://code.wireshark.org/review/6640 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-01-18 21:27:13 +00:00
endmacro()
Refactor plugin registration and loading Put different types of plugins (libwiretap, libwireshark) in different subdirectories, give libwiretap and libwireshark init routines that load the plugins, and have them scan the appropriate subdirectories so that we don't even *try* to, for example, load libwireshark plugins in programs that only use libwiretap. Compiled plugins are stored in subfolders of the plugin folders, with the subfolder name being the Wireshark minor version number (X.Y). There is another hierarchical level for each Wireshark library (libwireshark, libwscodecs and libwiretap). The folder names are respectively plugins/X.Y/{epan,codecs,wiretap}. Currently we only distribute "epan" (libwireshark) plugins. Change-Id: I3438787a6f45820d64ba4ca91cbe3c8864708acb Reviewed-on: https://code.wireshark.org/review/23983 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot Reviewed-by: João Valverde <j@v6e.pt>
2017-09-30 23:56:03 +00:00
Don't link wiretap plugins with libwireshark. Make the second argument to add_plugin_library() and install_plugin() be a plugin type - currently, either "epan" or "wiretap" - and, based on its value, set the subfolder and required libraries in add_plugin_library() and the subfolder in install_plugin(). If it's not one of the known values, fail. Change-Id: I556863772c59330d2854fbb4673f544f8359dcd2 Reviewed-on: https://code.wireshark.org/review/25579 Petri-Dish: Guy Harris <guy@alum.mit.edu> Tested-by: Petri Dish Buildbot Reviewed-by: Guy Harris <guy@alum.mit.edu>
2018-02-03 20:25:24 +00:00
macro(INSTALL_PLUGIN _plugin _plugin_type)
if(${_plugin_type} STREQUAL "epan")
set(_subfolder "epan")
elseif(${_plugin_type} STREQUAL "wiretap")
set(_subfolder "wiretap")
else()
message(FATAL_ERROR "install_plugin called with invalid plugin type ${_plugin_type}")
endif()
Refactor plugin registration and loading Put different types of plugins (libwiretap, libwireshark) in different subdirectories, give libwiretap and libwireshark init routines that load the plugins, and have them scan the appropriate subdirectories so that we don't even *try* to, for example, load libwireshark plugins in programs that only use libwiretap. Compiled plugins are stored in subfolders of the plugin folders, with the subfolder name being the Wireshark minor version number (X.Y). There is another hierarchical level for each Wireshark library (libwireshark, libwscodecs and libwiretap). The folder names are respectively plugins/X.Y/{epan,codecs,wiretap}. Currently we only distribute "epan" (libwireshark) plugins. Change-Id: I3438787a6f45820d64ba4ca91cbe3c8864708acb Reviewed-on: https://code.wireshark.org/review/23983 Petri-Dish: João Valverde <j@v6e.pt> Tested-by: Petri Dish Buildbot Reviewed-by: João Valverde <j@v6e.pt>
2017-09-30 23:56:03 +00:00
install(TARGETS ${_plugin}
LIBRARY DESTINATION ${PLUGIN_INSTALL_LIBDIR}/${_subfolder} NAMELINK_SKIP
RUNTIME DESTINATION ${PLUGIN_INSTALL_LIBDIR}
ARCHIVE DESTINATION ${PLUGIN_INSTALL_LIBDIR}
)
endmacro()