wireshark/doc/plugins.example build problem

As stated in doc/plugins.example/README:

Note that this builds against Wireshark's *installed* version. You should of
course adapt to your own needs.

So did you try doing that instead of trying to build against your locally compiled version?

my installed version of Wireshark not containing WiresharkConfig.cmake find /Applications/Wireshark.app -name "WiresharkConfig.cmake" - nop

all files

and I would like to be able to build without unnecessary dependencies (without Wireshark installed)

The issue here is, I believe, that WiresharkConfig.cmake is not properly packaged in the macOS App Bundle.

And it seems you would like to build your plugin in the build tree. For that you will have to place your code in /plugins/{epan,codecs,wiretap} and manually add the newly created plugin path to CMakelists.txt.

And it seems you would like to build your plugin in the build tree. - no, i need a separate shared library(.dll/.so/.dylib)

building without installing Wireshark can be handy for ci, in other projects.

ideally, I would like to have a separate repository with everything you need (include folder & cmake files) for building plugins. or at least so you can add wireshark folder as git sublodule

Ideally, I would like to have a separate repository with everything I need (include folder and cmake files) to create plugins. or at least be able to add the Wireshark folder as a git submodule, and include in CMakeLists.txt

Ideally, I would like to have a separate repository with everything I need (include folder and cmake files) to create plugins. or at least be able to add the Wireshark folder as a git submodule, and include in CMakeLists.txt

You would have to write your own makefile/build for that. I don't think it requires much more than an extra include flag for the compiler and maybe one or two macro definitions (with symbol resolution at run time).

The plugins.example build requires a Wireshark system installation. Or you can add your plugin to the Wireshark source tree. Currently those are the two options available.

now i do

pwd - Wireshark/build
cmake -GNinja .. " -DCMAKE_INSTALL_PREFIX="/Users/<user>/git/wireshark/build_install"
ninja install
cd ../doc/plugins.example/build/
cmake ..  -DCMAKE_PREFIX_PATH="/Users/<user>/git/wireshark/build_install"
-- The C compiler identification is AppleClang 12.0.0.12000032
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working C compiler: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/cc - skipped
-- Detecting C compile features
-- Detecting C compile features - done
-- Configuring done
-- Generating done
-- Build files have been written to: /Users/<user>/git/wireshark/doc/plugins.example/build

cmake --build .
In file included from /Users/<user>/git/wireshark/doc/plugins.example/hello.c:16:
In file included from /Users/<user>/git/wireshark/build_install/include/wireshark/epan/packet.h:16:
/Users/<user>/git/wireshark/build_install/include/wireshark/epan/epan.h:22:10: fatal error: 'wsutil/plugins.h' file not found
#include <wsutil/plugins.h>
         ^~~~~~~~~~~~~~~~~~
1 error generated.
make[2]: *** [CMakeFiles/hello.dir/hello.c.o] Error 1
make[1]: *** [CMakeFiles/hello.dir/all] Error 2
make: *** [all] Error 2

so copied wsutil/plugins.h and wsutil/plugins.c - got it built!) put hello.so in /Applications/Wireshark.app/Contents/PlugIns/wireshark/3-4/epan

try start and get

okay try start /Users//git/wireshark/build_install/bin/Wireshark.app and get "Problem Report for Wireshark"

Process:               Wireshark [27963]
Path:                  /Users/USER/*/Wireshark.app/Contents/MacOS/Wireshark
Identifier:            org.wireshark.Wireshark
Version:               3.5.0 (3.5.0)
Code Type:             X86-64 (Native)
Parent Process:        ??? [1]
Responsible:           Wireshark [27963]
User ID:               501

Date/Time:             2021-02-16 15:31:11.852 +0300
OS Version:            Mac OS X 10.15.7 (19H524)
Report Version:        12
Bridge OS Version:     3.0 (14Y908)
Anonymous UUID:        D1B8E154-F28A-F679-A716-55607E5351F2

Sleep/Wake UUID:       FE926E27-6BEC-475F-B19A-069B93153BFB

Time Awake Since Boot: 260000 seconds
Time Since Wake:       7300 seconds

System Integrity Protection: enabled

Crashed Thread:        0

Exception Type:        EXC_CRASH (SIGABRT)
Exception Codes:       0x0000000000000000, 0x0000000000000000
Exception Note:        EXC_CORPSE_NOTIFY

Termination Reason:    DYLD, [0x1] Library missing

Application Specific Information:
dyld: launch, loading dependent libraries

Dyld Error Message:
  Library not loaded: @rpath/libwireshark.0.dylib
  Referenced from: /Users/USER/*/Wireshark.app/Contents/MacOS/Wireshark
  Reason: image not found

Binary Images:
       0x107655000 -        0x107d44ffb +org.wireshark.Wireshark (3.5.0 - 3.5.0) <7293225F-0699-3C58-8259-7CA3D47E8E97> /Users/USER/*/Wireshark.app/Contents/MacOS/Wireshark
       0x10ef3a000 -        0x10efcbf47  dyld (750.6) <326C6480-04F4-3164-A363-53079A148E2F> /usr/lib/dyld

please, help

how does it build on ci ?! (

on

https://gitlab.com/wireshark/wireshark/-/blob/master/.travis.yml#L80

i don't see any extra steps

plugins.example isn't being built with CI (it's documentation).

Is that your intended use case, CI for Wireshark plugins?

I mean that I'm trying to run the assembled wireshark.app but it does not work

Is that your intended use case, CI for Wireshark plugins? - if I understood you correctly, then no, but if the "build_install" folder is in a separate repository, then yes

I mean "is it your intended use case that you are developing your own plugin, want to run CI on it, and that is why, for some yet unknown reason to me, the pre-existing plugin build solutions don't suit you"...?

I don't think the Wireshark.app abort you pasted has anything to do with plugins.

To be clear, the issue with a missing macOS WiresharkConfig.cmake in the App Bundle seems like a legit bug. That should work, as far as I understand Apple's packaging guidelines.

I have no complaints about Wireshark Config.cmake missing from /Applications/Wireshark.app, although sad

@jvalverde I'll try to explain in a simple way

I'm on macos now, homebrew doesn't have wireshark-dev so to build the plugin I need to get WiresharkConfig.cmake from somewhere and everything else - the only way I see now is to build Wireshark to get the "installed" folder in which everything is
after I built Wireshark and got the installed folder

2.1) problem 1 - I cannot build the plugin because <wsutil/plugins.h/c> is missing in build_install/include/wireshark

2.2.1) I have never done install for CMakeLists.txt - so I don’t even know how to edit it / in what part of CMakeLists.txt - can you tell me?

2.2) Problem 2 - I can't run build_install / bin / Wireshark.app - it won't start

2.2.1) maybe I need to fix rpath (library dependencies) - but how to do this is not clear - in https://gitlab.com/wireshark/wireshark/-/blob/master/.travis.yml#L80 there is only "- ninja" and that's it, or is the assembly (release) for macos not going through travis?

to build the plugin, I would not want to build wireshark entirely every time - so the question is - where should we publish "build_install"? by analogy with wireshark-dev package on "Linux"

3.1) I immediately thought about a separate repository ..

3.2) maybe it is worth making a formula for homebrew - but most likely I need to download somewhere

maybe I need to fix rpath (library dependencies) - but how to do this is not clear - in https://gitlab.com/wireshark/wireshark/-/blob/master/.travis.yml#L80 there is only "- ninja" and that's it, or is the assembly (release) for macos not going through travis?

Not going through Travis: https://buildbot.wireshark.org/wireshark-master/builders/macOS%2010.14%20x64

Thanks for the clear explanation. I think I understand the confusion. For the purpose of using plugins.example an installation on macOS means "running the installation target for the build", so make install or ninja install. That's the way to obtain WiresharkConfig.cmake. It's a standard UN*X build.

The Wireshark.app stuff hasn't been tested at all and most likely won't work. And I don't think you will have success running that from the build directory either (I don't use macOS so my understanding of its conventions is limited).

2.2.1) I have never done install for CMakeLists.txt - so I don’t even know how to edit it / in what part of CMakeLists.txt - can you tell me?

Check here. Let me know if you have other questions.

i checkout to v3.4.3 and success build !

For the purpose of using plugins.example an installation on macOS means "running the installation target for the build", so make install or ninja install. That's the way to obtain WiresharkConfig.cmake.

not completely understood what you mean, if that for, building plugins.example requires "make install" then yes, I understand this, but since I do not want to clutter up my system, I specified a folder and then add this folder to -DCMAKE_INSTALL_PREFIX =

The Wireshark.app stuff hasn't been tested at all and most likely won't work. And I don't think you will have success running that from the build directory either

and who collects releases for macos? and how is it indicated on the site? https://1.eu.dl.wireshark.org/osx/Wireshark%203.4.3%20Intel%2064.dmg

#17237 (comment 510161772)

regarding question 2.1 - should I create a bug? (on v3.4.3 this problem is not present)

and 3. - Let's think about how to do it? (where to store it?) or create a separate bug?

and who collects releases for macos? and how is it indicated on the site? https://1.eu.dl.wireshark.org/osx/Wireshark%203.4.3%20Intel%2064.dmg

I don't mean binary Mac releases in general are unsupported. Sorry if that wasn't clear. I meant the development environment for building plugins is not supported by the *.dmg installation, as you've found out.

regarding question 2.1 - should I create a bug? (on v3.4.3 this problem is not present)

Not yet, I don't think it has been established that there's a bug. What is "build_install"?

3. - Let's think about how to do it? (where to store it?) or create a separate bug?

You don't need to build Wireshark every time. That's why /doc/plugin.example was created. That and easy distribution for out-of-tree source and binary plugins.

Feel free to reopen this with a more focused enhancement request.

To recap at the moment there is no SDK for macOS (with appbundle) or Windows (with installer).

Also absent a compelling use case there are no plans to add new build configurations for plugins (for example without the make install step).

closed

wireshark/doc/plugins.example build problem

Summary

Steps to reproduce

What is the current bug behavior?

What is the expected correct behavior?

Child items ...

Activity