1 Explain the cmake build system for wireshark
5 To find out the current state of the cmake implementation for
6 Wireshark, please take a look at "What needs to be done?" below.
11 How to get started with cmake (Unix/Linux and Win32/64)?
14 What needs to be done?
17 How to get started with cmake (Unix/Linux and Win32/64)?
18 ========================================================
20 You can find documentation on cmake at: http://www.cmake.org/
22 cmake is designed to support out of tree builds. So much so, that
23 in tree builds do not work properly in all cases.
25 How to do out of tree build (Unix/Linux):
27 2) Assuming, you are in the top directory of the wireshark source
31 5) cmake [options] ../<Name_of_WS_source_dir>
32 6) make (or cmake --build .)
33 7) (as root) umask 0022 && make install
36 In step 5) you may need to override the defaults for features. Common
39 # Disable the POSIX capabilities check
42 # Enable debugging symbols
43 -DCMAKE_BUILD_TYPE=Debug
49 -DENABLE_HTML_GUIDES=ON
50 -DENABLE_PDF_GUIDES=ON
52 # Make ccache and clang work together
53 -DCMAKE_C_FLAGS='-Qunused-arguments'
55 # Force Python path on Windows. May be needed if Cygwin's
56 # /usr/bin/python is present and is a symlink
57 # http://public.kitware.com/Bug/view.php?id=13818
58 -DPYTHON_EXECUTABLE=c:/Python27/python
60 # Disable building an application bundle (Wireshark.app) on OS X
61 -DENABLE_APPLICATION_BUNDLE=OFF
63 # Qt Creator expects .cbp files when used with CMake.
64 -G "CodeBlocks - Unix Makefiles"
65 -G "CodeBlocks - NMake Makefiles"
67 # We call try_compile many times, particularly via ConfigureChecks.cmake.
68 # Setting a lightweight try_compile configuration can speed up cmake,
69 # particularly for MSBuild.
70 -DCMAKE_TRY_COMPILE_CONFIGURATION=Release
73 After running cmake, you can always run "make help" to see
74 a list of all possible make targets.
77 Cmake honors user umask for creating directories as of now:
78 http://public.kitware.com/Bug/view.php?id=9620
79 To get predictable results please set umask explicitly.
81 How to do an out of tree build using Visual C++ 2013:
82 [This is used for the 2.x release builds, support for VS2010 and VS2012
83 is included, but hasn't been tested.]
84 0) Install cmake (currently 3.1.3 or later is recommended). You can use chocolatey,
86 1) Follow https://www.wireshark.org/docs/wsdg_html_chunked/ChSetupWin32.html
88 1a) Set the library search path.
89 If you set WIRESHARK_BASE_DIR,
90 %WIRESHARK_BASE_DIR%\wireshark-%WIRESHARK_TARGET_PLATFORM%-libs will
91 be used as the top-level library directory.
92 If you set WIRESHARK_LIB_DIR, it will be used as the top-level library
93 directory. This definition will require changing for different builds (x86 & x64).
94 1b) set WIRESHARK_TARGET_PLATFORM=win32 (or win64)
95 1c) set QT5_BASE_DIR=C:\Qt\5.4.1\5.4\msvc2013_opengl (must match the Qt component path
97 1d) If you want to use Visual Studio to build rather than msbuild from the command line,
98 make sure that the path to Cygwin is available to GUI applications.
99 2) mkdir c:\wireshark\build or as appropriate for you.
100 You will need one build directory for each bitness (win32, win64) you wish to build.
101 3) cd into the directory from 2) above.
102 4) Run the following to generate the build files:
103 cmake -DENABLE_CHM_GUIDES=on xxx path\to\sources
104 where path\to\sources is the absolute or relative path to the wireshark source tree
105 and xxx is replaced with one of the following:
106 nothing - This will build a VS solution for win32 using the latest version of VS found (preferred).
107 -G "Visual Studio 12" ("12" builds for VS2013. Use "11" for VS2012 or "10" for VS2010.)
108 -G "NMake Makefiles" - to build an nmake makefile.
109 -G "Visual Studio 12 Win64" (to build an x64 version you must add the "Win64", Win32 is the default)
110 5) Run one of the following to build Wireshark:
111 msbuild /m /p:Configuration=RelWithDebInfo wireshark.sln (preferred).
112 Open Wireshark.sln in Windows Explorer to build in Visual Studio
113 nmake /X- VERBOSE=1 (or cmake --build . -- VERBOSE=1 ) (if you generated nmake files).
114 Subsequent changes to source files and CMakeLists.txt will be automagically detected
115 and new build files generated, i.e. step 4) doesn't need to be run again.
116 Changes to the build environment, e.g. QT_BASE_DIR aren't detected so you must delete the
117 build dir and start form step 2) again.
118 6) The executables can be run from the appropriate directory, e.g. run\RelWithDebInfo for VS solutions
119 or run\ for NMake files.
120 7) To build an installer, build the nsis_package_prep and then the nsis_package projects, e.g.
121 msbuild /m /p:Configuration=RelWithDebInfo nsis_package_prep.vcxproj
122 msbuild /m /p:Configuration=RelWithDebInfo nsis_package.vcxproj
127 - Can create project files for many IDEs including Qt Creator, Visual Studio,
129 - Fast, builds in parallel in Visual Studio or msbuild with the /m flag
130 - Easier to understand/learn
131 - Doesn't create any files in the source tree in case of out of tree builds
132 - One build infrastructure for all of our tier 1 platforms (including Windows)
133 - Out of tree builds permits both Win32 and Win64 builds without requiring a "clean" when swapping.
138 - Everyone who wants to build from source needs cmake
139 - Current state of documentation isn't really better than
140 Autotools documentation. In some respects it's even worse
141 (you need to buy a book to get an explanation as to how
148 All the executables now build from clean source on:
149 * 32 bit openSUSE 11.3: (gnu)make and gcc
152 * 32 bit Ubuntu 10.04
153 * 64 bit Ubuntu 14.04
154 * 64 bit Debian Wheezy
157 * 32 bit Windows using Visual C++ 2013
158 * 64 bit Windows using Visual C++ 2013
161 The Buildbot runs CMake steps on Ubuntu, Win32, Win64, OS X, and Solaris.
162 Windows packages are built using CMake steps.
164 What needs to be done?
165 ======================
167 - Add back platform specific objects.
168 - Fix places in the cmake files marked as todo.
169 - Guides are not installed.
170 - Build source package (using CPack).
171 This is obsolete if we decide to release VCS snapshots instead
172 - Build packages using CPack: tarball, Windows installer + PortableApps, OS X
173 installer dmg, RPM, SVR4. This includes setting OS target version stuff
174 appropriately for OS X. We currently use NSIS for the Windows installer but
175 should probably use WiX instead.
176 - Add support for cmake configurations.
177 - Automatically figure out if *shark is running from the build directory
178 (making WIRESHARK_RUN_FROM_BUILD_DIRECTORY unnecessary like it is with
183 run/qtshark: Mach-O 64-bit x86_64 executable
185 so what you're running from the build directory is the executable
186 itself. autofoo includes libtool in our case, so what you're running
187 from the build directory is a script that then runs the executable,
188 and the executable is in a .libs directory; the code that checks for
189 "running from the build directory?" checks for that. The actual
190 executable isn't supposed to be run directly - it's expected to be run
191 by the wrapper script and might not even work if run directly, as it
192 won't find the relevant shared libraries.
194 We could perhaps check for the executable being in a "run" directory
195 instead, if the build drops it there. However, it's possible, at
196 least on OS X, to copy the executable to another directory and have
197 it run, so the guarantee that it's in a "run" directory is not as
199 - Get plugins loading when running *shark from the build directory.
200 That might involve handling ".libs" and "run" differently. The chance
201 that a random directory the executable was ultimately placed in would
202 be named "run" might also be a bit bigger than the chance that it's
204 - Get cross-compilation working (or ensure it does). It works with autofoo--and
206 - Handle -DFORTIFY_SOURCE=2 appropriately. (Do a Web search for
207 "cmake fortify" for some information.)
208 - Define the GTK_DISABLE_ and GDK_DISABLE_ values as appropriate if we
209 care about supporting the GTK+ version.
210 - Install the freedesktop integration files (wireshark.desktop,
211 wireshark-mime-package.xml, etc.).
214 Links regarding cmake
215 =====================
216 The home page of the cmake project
217 http://www.cmake.org/
219 The home page of the cmake project documentation
220 http://www.cmake.org/Wiki/CMake
222 About cmake in general and why KDE4 uses it
223 http://lwn.net/Articles/188693/
225 Introductory/tutorial presentation
226 http://ait.web.psi.ch/services/linux/hpc/hpc_user_cookbook/tools/cmake/docs/Cmake_VM_2007.pdf
228 Introductory article in Linux Journal
229 http://www.linuxjournal.com/node/6700/print
232 http://www.cmake.org/Wiki/CMake_Useful_Variables
235 http://www.cmake.org/Wiki/CMake_FAQ
237 Additional cmake modules
238 http://code.google.com/p/cmake-modules/