4.5. Microsoft compiler toolchain (Windows native)

To compile Wireshark on Windows using the Microsoft C/C++ compiler, you’ll need:

  1. C compiler (cl.exe)
  2. Assembler (ml.exe for 32-bit targets and ml64.exe for 64-bit targets)
  3. Linker (link.exe)
  4. Resource Compiler (rc.exe)
  5. C runtime headers and libraries (e.g. stdio.h, vcruntime140.lib)
  6. Windows platform headers and libraries (e.g. windows.h, WS2_32.lib)
  7. HTML help headers and libraries (htmlhelp.h, htmlhelp.lib)

4.5.1. Official Toolchain Packages And Alternatives

Official releases are or were built with the following Visual C++ versions:

  • Wireshark 3.2.x: Microsoft Visual C++ 2019.
  • Wireshark 3.0.x: Microsoft Visual C++ 2017.
  • Wireshark 2.6.x: Microsoft Visual C++ 2017.
  • Wireshark 2.4.x: Microsoft Visual C++ 2015.
  • Wireshark 2.2.x: Microsoft Visual C++ 2013.
  • Wireshark 2.0.x: Microsoft Visual C++ 2013.
  • Wireshark 1.12.x: Microsoft Visual C++ 2010 SP1.
  • Wireshark 1.10.x: Microsoft Visual C++ 2010 SP1.
  • Wireshark 1.8.x: Microsoft Visual C++ 2010 SP1.
  • Wireshark 1.6.x: Microsoft Visual C++ 2008 SP1.
  • Wireshark 1.4.x: Microsoft Visual C++ 2008 SP1.
  • Wireshark 1.2.x: Microsoft Visual C++ 2008 SP1.
  • Wireshark 1.0.x and earlier: Microsoft Visual C++ 6.0.

Using the release compilers is recommended for Wireshark development work.

“Community” editions of Visual Studio such as “Visual Studio Community 2019” can be used to compile Wireshark but any PortableApps packages you create with them might require the installation of a separate Visual C++ Redistributable package on any machine on which the PortableApps package is to be used. See Section 4.5.4, “Visual C++ Runtime “Redistributable” Files” below for more details.

However, you might already have a different Microsoft C++ compiler installed. It should be possible to use any of the following with the considerations listed. You will need to sign up for a Visual Studio Dev Essentials account if you don’t have a Visual Studio (MSDN) subscription. The older versions can be downloaded from https://visualstudio.microsoft.com/vs/older-downloads/.

Visual C++ 2019 Community Edition

IDE + Debugger?
Yes
SDK required for 64-bit builds?
No

CMake Generator: Visual Studio 16

You can use Chocolatey to install Visual Studio, e.g:

PS:\> choco install visualstudiocommunity2019 visualstudio2019-workload-nativedesktop

4.5.2. cl.exe (C Compiler)

The following table gives an overview of the possible Microsoft toolchain variants and their specific C compiler versions ordered by release date.

Compiler Package

cl.exe

_MSC_VER

Visual Studio 2019

16.0.0

1920

Visual Studio 2019

16.1.2

1921

Visual Studio 2019

16.2.3

1922

Visual Studio 2019

16.3.2

1923

After correct installation of the toolchain, typing at the Visual Studio Command line prompt (cmd.exe):

> cl

should result in something like:

Microsoft (R) C/C++ Optimizing Compiler Version 19.23.28106.4 for x64
Copyright (C) Microsoft Corporation.  All rights reserved.

usage: cl [ option... ] filename... [ /link linkoption... ]

However, the version string may vary.

Documentation on the compiler can be found at Microsoft Docs

4.5.3. link.exe (Linker)

After correct installation, typing at the Visual Studio Command line prompt (cmd.exe):

> link

should result in something like:

Microsoft (R) Incremental Linker Version 14.23.28106.4
Copyright (C) Microsoft Corporation.  All rights reserved.

 usage: LINK [options] [files] [@commandfile]
 ...

However, the version string may vary.

Documentation on the linker can be found at Microsoft Docs

4.5.4. Visual C++ Runtime “Redistributable” Files

Please note: The following is not legal advice. Ask your preferred lawyer instead. It’s the authors view and this view might be wrong.

Wireshark and its libraries depend on POSIX functions such as fopen() and malloc(). On Windows, these functions are provided by the Microsoft Visual C++ Runtime. There are many different versions of the CRT and Visual C++ 2015 and later use the Universal CRT.

The Universal CRT comes standard with Windows 10 and is installed as part of Windows Update on earlier versions of Windows. The Wireshark .exe installers include redistributables (vcredist_x86.exe or vcredist_x64.exe) which ensure that the Universal CRT is installed and up to date.

[Note]Make sure you’re allowed to distribute this file

The files to redistribute must be mentioned in the redist.txt file of the compiler package. Otherwise it can’t be legally redistributed by third parties like us.

The following Microsoft Docs link is recommended for the interested reader:

Redistributing Visual C++ Files

In all cases where vcredist_x86.exe or vcredist_x64.exe is downloaded it should be downloaded to the directory into which the support libraries for Wireshark have been downloaded and installed. This directory is specified by the WIRESHARK_BASE_DIR or WIRESHARK_LIB_DIR environment variables. It need not, and should not, be run after being downloaded.

4.5.5. Windows Platform SDK

The Windows Platform SDK (PSDK) or Windows SDK is a free (as in beer) download and contains platform specific headers and libraries (e.g. windows.h, WSock32.lib, etc.). As new Windows features evolve in time, updated SDKs become available that include new and updated APIs.

When you purchase a commercial Visual Studio or use the Community Edition, it will include an SDK.