4 CMake is a multi-platform build tool that can generate build files for many
5 different target platforms. See more info at http://www.cmake.org
7 CMake also allows/recommends you to do "out of source"-builds, that is,
8 the build files are separated from your sources, so there is no need to
9 create elaborate clean scripts to get a clean source tree, instead you
10 simply remove your build directory.
12 Libwebsockets has been tested to build successfully on the following platforms
13 with SSL support (both OpenSSL/wolfSSL):
15 - Windows (Visual Studio)
21 Building the library and test apps
22 ----------------------------------
24 The project settings used by CMake to generate the platform specific build
25 files is called [CMakeLists.txt](CMakeLists.txt). CMake then uses one of its "Generators" to
26 output a Visual Studio project or Make file for instance. To see a list of
27 the available generators for your platform, simply run the "cmake" command.
29 Note that by default OpenSSL will be linked, if you don't want SSL support
30 see below on how to toggle compile options.
35 1. Install CMake 2.8 or greater: http://cmake.org/cmake/resources/software.html
36 (Most Unix distributions comes with a packaged version also)
40 3. Generate the build files (default is Make files):
49 (**NOTE**: The `build/`` directory can have any name and be located anywhere
50 on your filesystem, and that the argument `..` given to cmake is simply
51 the source directory of **libwebsockets** containing the [CMakeLists.txt](CMakeLists.txt)
52 project file. All examples in this file assumes you use "..")
55 A common option you may want to give is to set the install path, same
56 as --prefix= with autotools. It defaults to /usr/local.
57 You can do this by, eg
60 $ cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr ..
64 On machines that want libraries in lib64, you can also add the
65 following to the cmake line
72 If you are building against a non-distro OpenSSL (eg, in order to get
73 access to ALPN support only in newer OpenSSL versions) the nice way to
74 express that in one cmake command is eg,
77 $ cmake .. -DOPENSSL_ROOT_DIR=/usr/local/ssl \
78 -DCMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE=/usr/local/ssl \
82 When you run the test apps using non-distro SSL, you have to force them
83 to use your libs, not the distro ones
86 $ LD_LIBRARY_PATH=/usr/local/ssl/lib libwebsockets-test-server --ssl
89 4. Finally you can build using the generated Makefile:
98 When changing cmake options, for some reason the only way to get it to see the
99 changes sometimes is delete the contents of your build directory and do the
102 Building on Windows (Visual Studio)
103 -----------------------------------
104 1. Install CMake 2.6 or greater: http://cmake.org/cmake/resources/software.html
106 2. Install OpenSSL binaries. http://www.openssl.org/related/binaries.html
108 (**NOTE**: Preferably in the default location to make it easier for CMake to find them)
111 Be sure that OPENSSL_CONF environment variable is defined and points at
112 <OpenSSL install location>\bin\openssl.cfg
114 3. Generate the Visual studio project by opening the Visual Studio cmd prompt:
120 cmake -G "Visual Studio 10" ..
123 (**NOTE**: There is also a cmake-gui available on Windows if you prefer that)
126 See this link to find out the version number corresponding to your Visual Studio edition:
127 http://superuser.com/a/194065
129 4. Now you should have a generated Visual Studio Solution in your
130 `<path to src>/build` directory, which can be used to build.
132 Building on Windows (MinGW)
133 ---------------------------
134 1. Install MinGW: http://sourceforge.net/projects/mingw/files
136 (**NOTE**: Preferably in the default location C:\MinGW)
138 2. Fix up MinGW headers
140 a) Add the following lines to C:\MinGW\include\winsock2.h:
143 #if(_WIN32_WINNT >= 0x0600)
145 typedef struct pollfd {
151 } WSAPOLLFD, *PWSAPOLLFD, FAR *LPWSAPOLLFD;
153 WINSOCK_API_LINKAGE int WSAAPI WSAPoll(LPWSAPOLLFD fdArray, ULONG fds, INT timeout);
155 #endif // (_WIN32_WINNT >= 0x0600)
158 b) Create C:\MinGW\include\mstcpip.h and copy and paste the content from following link into it:
160 http://wine-unstable.sourcearchive.com/documentation/1.1.32/mstcpip_8h-source.html
162 3. Install CMake 2.6 or greater: http://cmake.org/cmake/resources/software.html
164 4. Install OpenSSL binaries. http://www.openssl.org/related/binaries.html
166 (**NOTE**: Preferably in the default location to make it easier for CMake to find them)
169 Be sure that OPENSSL_CONF environment variable is defined and points at
170 <OpenSSL install location>\bin\openssl.cfg
172 5. Generate the build files (default is Make files) using MSYS shell:
175 $ cd /drive/path/to/src
178 $ cmake -G "MSYS Makefiles" -DCMAKE_INSTALL_PREFIX=C:/MinGW ..
181 (**NOTE**: The `build/`` directory can have any name and be located anywhere
182 on your filesystem, and that the argument `..` given to cmake is simply
183 the source directory of **libwebsockets** containing the [CMakeLists.txt](CMakeLists.txt)
184 project file. All examples in this file assumes you use "..")
187 To generate build files allowing to create libwebsockets binaries with debug information
188 set the CMAKE_BUILD_TYPE flag to DEBUG:
191 $ cmake -G "MSYS Makefiles" -DCMAKE_INSTALL_PREFIX=C:/MinGW -DCMAKE_BUILD_TYPE=DEBUG ..
194 6. Finally you can build using the generated Makefile and get the results deployed into your MinGW installation:
201 Setting compile options
202 -----------------------
204 To set compile time flags you can either use one of the CMake gui applications
205 or do it via command line.
209 To list avaialable options (ommit the H if you don't want the help text):
213 Then to set an option and build (for example turn off SSL support):
215 cmake -DLWS_WITH_SSL=0 ..
217 cmake -DLWS_WITH_SSL:BOOL=OFF ..
221 MBED3 is a non-posix embedded OS targeted on Cortex M class chips.
223 https://www.mbed.com/
225 It's quite unlike any other Posixy platform since the OS is linked statically
226 in with lws to form one binary.
228 At the minute server-only is supported and due to bugs in mbed3 network support,
229 the port is of alpha quality. However it can serve the test html, favicon.ico
230 and logo png and may be able to make ws connections. The binary for that
231 including the OS, test app, lws and all the assets is only 117KB.
233 0) Today mbed3 only properly works on FRDM K64F $35 Freescale Dev Board with
234 1MB Flash, 256KB SRAM and Ethernet.
236 http://www.freescale.com/products/arm-processors/kinetis-cortex-m/k-series/k6x-ethernet-mcus/freescale-freedom-development-platform-for-kinetis-k64-k63-and-k24-mcus:FRDM-K64F
238 1) Get a working mbed3 environment with arm-none-eabi-cs toolchain
239 (available in Fedora, Ubuntu and other distros)
241 2) Confirm you can build things using yotta by following the getting started guide here
243 https://docs.mbed.com/docs/getting-started-mbed-os/en/latest/
247 git clone https://github.com/warmcat/lws-test-server
251 4) mkdir -p yotta_modules ; cd yotta_modules
253 5) git clone https://github.com/warmcat/libwebsockets ; mv libwebsockets websockets ; cd ..
255 6) yotta target frdm-k64f-gcc
264 If you have a curses-enabled build you simply type:
265 (not all packages include this, my debian install does not for example).
271 On windows CMake comes with a gui application:
272 Start -> Programs -> CMake -> CMake (cmake-gui)
274 wolfSSL/CyaSSL replacement for OpenSSL
275 --------------------------------------
276 wolfSSL/CyaSSL is a lightweight SSL library targeted at embedded systems:
277 https://www.wolfssl.com/wolfSSL/Products-wolfssl.html
279 It contains a OpenSSL compatibility layer which makes it possible to pretty
280 much link to it instead of OpenSSL, giving a much smaller footprint.
282 **NOTE**: wolfssl needs to be compiled using the `--enable-opensslextra` flag for
285 Compiling libwebsockets with wolfSSL
286 ------------------------------------
289 cmake .. -DLWS_USE_WOLFSSL=1 \
290 -DLWS_WOLFSSL_INCLUDE_DIRS=/path/to/wolfssl \
291 -DLWS_WOLFSSL_LIBRARIES=/path/to/wolfssl/wolfssl.a ..
294 **NOTE**: On windows use the .lib file extension for `LWS_WOLFSSL_LIBRARIES` instead.
296 Compiling libwebsockets with CyaSSL
297 -----------------------------------
300 cmake .. -DLWS_USE_CYASSL=1 \
301 -DLWS_CYASSL_INCLUDE_DIRS=/path/to/cyassl \
302 -DLWS_CYASSL_LIBRARIES=/path/to/wolfssl/cyassl.a ..
305 **NOTE**: On windows use the .lib file extension for `LWS_CYASSL_LIBRARIES` instead.
307 Reproducing HTTP2.0 tests
308 -------------------------
310 You must have built and be running lws against a version of openssl that has
311 ALPN / NPN. Most distros still have older versions. You'll know it's right by
315 lwsts[4752]: Compiled with OpenSSL support
316 lwsts[4752]: Using SSL mode
317 lwsts[4752]: HTTP2 / ALPN enabled
322 For non-SSL HTTP2.0 upgrade
325 $ nghttp -nvasu http://localhost:7681/test.htm
328 For SSL / ALPN HTTP2.0 upgrade
331 $ nghttp -nvas https://localhost:7681/test.html
336 To enable cross-compiling **libwebsockets** using CMake you need to create
337 a "Toolchain file" that you supply to CMake when generating your build files.
338 CMake will then use the cross compilers and build paths specified in this file
339 to look for dependencies and such.
341 **Libwebsockets** includes an example toolchain file [cross-arm-linux-gnueabihf.cmake](cross-arm-linux-gnueabihf.cmake)
342 you can use as a starting point.
344 The commandline to configure for cross with this would look like
347 $ cmake .. -DCMAKE_INSTALL_PREFIX:PATH=/usr \
348 -DCMAKE_TOOLCHAIN_FILE=../cross-arm-linux-gnueabihf.cmake \
349 -DWITHOUT_EXTENSIONS=1 -DWITH_SSL=0
352 The example shows how to build with no external cross lib dependencies, you
353 need to provide the cross libraries otherwise.
355 **NOTE**: start from an EMPTY build directory if you had a non-cross build in there
356 before the settings will be cached and your changes ignored.
358 Additional information on cross compilation with CMake:
359 http://www.vtk.org/Wiki/CMake_Cross_Compiling
364 Embedded server-only configuration without extensions (ie, no compression
365 on websocket connections), but with full v13 websocket features and http
366 server, built on ARM Cortex-A9:
368 Update at 8dac94d (2013-02-18)
371 $ ./configure --without-client --without-extensions --disable-debug --without-daemonize
373 Context Creation, 1024 fd limit[2]: 16720 (includes 12 bytes per fd)
374 Per-connection [3]: 72 bytes, +1328 during headers
376 .text .rodata .data .bss
380 This shows the impact of the major configuration with/without options at
381 13ba5bbc633ea962d46d using Ubuntu ARM on a PandaBoard ES.
383 These are accounting for static allocations from the library elf, there are
384 additional dynamic allocations via malloc. These are a bit old now but give
385 the right idea for relative "expense" of features.
387 Static allocations, ARM9
389 | | .text | .rodata | .data | .bss |
390 |--------------------------------|---------|---------|-------|------|
391 | All (no without) | 35024 | 9940 | 336 | 4104 |
392 | without client | 25684 | 7144 | 336 | 4104 |
393 | without client, exts | 21652 | 6288 | 288 | 4104 |
394 | without client, exts, debug[1] | 19756 | 3768 | 288 | 4104 |
395 | without server | 30304 | 8160 | 336 | 4104 |
396 | without server, exts | 25382 | 7204 | 288 | 4104 |
397 | without server, exts, debug[1] | 23712 | 4256 | 288 | 4104 |
399 [1] `--disable-debug` only removes messages below `lwsl_notice`. Since that is
400 the default logging level the impact is not noticeable, error, warn and notice
401 logs are all still there.
403 [2] `1024` fd per process is the default limit (set by ulimit) in at least Fedora
404 and Ubuntu. You can make significant savings tailoring this to actual expected
405 peak fds, ie, at a limit of `20`, context creation allocation reduces to `4432 +
408 [3] known header content is freed after connection establishment