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
90 To build with debug info and _DEBUG for lower priority debug messages
94 $ cmake .. -DCMAKE_BUILD_TYPE=DEBUG
97 4. Finally you can build using the generated Makefile:
106 When changing cmake options, for some reason the only way to get it to see the
107 changes sometimes is delete the contents of your build directory and do the
110 Building on Windows (Visual Studio)
111 -----------------------------------
112 1. Install CMake 2.6 or greater: http://cmake.org/cmake/resources/software.html
114 2. Install OpenSSL binaries. http://www.openssl.org/related/binaries.html
116 (**NOTE**: Preferably in the default location to make it easier for CMake to find them)
119 Be sure that OPENSSL_CONF environment variable is defined and points at
120 <OpenSSL install location>\bin\openssl.cfg
122 3. Generate the Visual studio project by opening the Visual Studio cmd prompt:
128 cmake -G "Visual Studio 10" ..
131 (**NOTE**: There is also a cmake-gui available on Windows if you prefer that)
134 See this link to find out the version number corresponding to your Visual Studio edition:
135 http://superuser.com/a/194065
137 4. Now you should have a generated Visual Studio Solution in your
138 `<path to src>/build` directory, which can be used to build.
140 5. Some additional deps may be needed
146 6. If you're using libuv, you must make sure to compile libuv with the same multithread-dll / Mtd attributes as libwebsockets itself
149 Building on Windows (MinGW)
150 ---------------------------
151 1. Install MinGW: http://sourceforge.net/projects/mingw/files
153 (**NOTE**: Preferably in the default location C:\MinGW)
155 2. Fix up MinGW headers
157 a) Add the following lines to C:\MinGW\include\winsock2.h:
160 #if(_WIN32_WINNT >= 0x0600)
162 typedef struct pollfd {
168 } WSAPOLLFD, *PWSAPOLLFD, FAR *LPWSAPOLLFD;
170 WINSOCK_API_LINKAGE int WSAAPI WSAPoll(LPWSAPOLLFD fdArray, ULONG fds, INT timeout);
172 #endif // (_WIN32_WINNT >= 0x0600)
175 b) Create C:\MinGW\include\mstcpip.h and copy and paste the content from following link into it:
177 http://wine-unstable.sourcearchive.com/documentation/1.1.32/mstcpip_8h-source.html
179 3. Install CMake 2.6 or greater: http://cmake.org/cmake/resources/software.html
181 4. Install OpenSSL binaries. http://www.openssl.org/related/binaries.html
183 (**NOTE**: Preferably in the default location to make it easier for CMake to find them)
186 Be sure that OPENSSL_CONF environment variable is defined and points at
187 <OpenSSL install location>\bin\openssl.cfg
189 5. Generate the build files (default is Make files) using MSYS shell:
192 $ cd /drive/path/to/src
195 $ cmake -G "MSYS Makefiles" -DCMAKE_INSTALL_PREFIX=C:/MinGW ..
198 (**NOTE**: The `build/`` directory can have any name and be located anywhere
199 on your filesystem, and that the argument `..` given to cmake is simply
200 the source directory of **libwebsockets** containing the [CMakeLists.txt](CMakeLists.txt)
201 project file. All examples in this file assumes you use "..")
204 To generate build files allowing to create libwebsockets binaries with debug information
205 set the CMAKE_BUILD_TYPE flag to DEBUG:
208 $ cmake -G "MSYS Makefiles" -DCMAKE_INSTALL_PREFIX=C:/MinGW -DCMAKE_BUILD_TYPE=DEBUG ..
211 6. Finally you can build using the generated Makefile and get the results deployed into your MinGW installation:
218 Setting compile options
219 -----------------------
221 To set compile time flags you can either use one of the CMake gui applications
222 or do it via command line.
226 To list avaialable options (ommit the H if you don't want the help text):
230 Then to set an option and build (for example turn off SSL support):
232 cmake -DLWS_WITH_SSL=0 ..
234 cmake -DLWS_WITH_SSL:BOOL=OFF ..
238 MBED3 is a non-posix embedded OS targeted on Cortex M class chips.
240 https://www.mbed.com/
242 It's quite unlike any other Posixy platform since the OS is linked statically
243 in with lws to form one binary.
245 At the minute server-only is supported and due to bugs in mbed3 network support,
246 the port is of alpha quality. However it can serve the test html, favicon.ico
247 and logo png and may be able to make ws connections. The binary for that
248 including the OS, test app, lws and all the assets is only 117KB.
250 0) Today mbed3 only properly works on FRDM K64F $35 Freescale Dev Board with
251 1MB Flash, 256KB SRAM and Ethernet.
253 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
255 1) Get a working mbed3 environment with arm-none-eabi-cs toolchain
256 (available in Fedora, Ubuntu and other distros)
258 2) Confirm you can build things using yotta by following the getting started guide here
260 https://docs.mbed.com/docs/getting-started-mbed-os/en/latest/
264 git clone https://github.com/warmcat/lws-test-server
268 4) mkdir -p yotta_modules ; cd yotta_modules
270 5) git clone https://github.com/warmcat/libwebsockets ; mv libwebsockets websockets ; cd ..
272 6) yotta target frdm-k64f-gcc
281 If you have a curses-enabled build you simply type:
282 (not all packages include this, my debian install does not for example).
288 On windows CMake comes with a gui application:
289 Start -> Programs -> CMake -> CMake (cmake-gui)
291 wolfSSL/CyaSSL replacement for OpenSSL
292 --------------------------------------
293 wolfSSL/CyaSSL is a lightweight SSL library targeted at embedded systems:
294 https://www.wolfssl.com/wolfSSL/Products-wolfssl.html
296 It contains a OpenSSL compatibility layer which makes it possible to pretty
297 much link to it instead of OpenSSL, giving a much smaller footprint.
299 **NOTE**: wolfssl needs to be compiled using the `--enable-opensslextra` flag for
302 Compiling libwebsockets with wolfSSL
303 ------------------------------------
306 cmake .. -DLWS_USE_WOLFSSL=1 \
307 -DLWS_WOLFSSL_INCLUDE_DIRS=/path/to/wolfssl \
308 -DLWS_WOLFSSL_LIBRARIES=/path/to/wolfssl/wolfssl.a ..
311 **NOTE**: On windows use the .lib file extension for `LWS_WOLFSSL_LIBRARIES` instead.
313 Compiling libwebsockets with CyaSSL
314 -----------------------------------
317 cmake .. -DLWS_USE_CYASSL=1 \
318 -DLWS_CYASSL_INCLUDE_DIRS=/path/to/cyassl \
319 -DLWS_CYASSL_LIBRARIES=/path/to/wolfssl/cyassl.a ..
322 **NOTE**: On windows use the .lib file extension for `LWS_CYASSL_LIBRARIES` instead.
324 Reproducing HTTP2.0 tests
325 -------------------------
327 You must have built and be running lws against a version of openssl that has
328 ALPN / NPN. Most distros still have older versions. You'll know it's right by
332 lwsts[4752]: Compiled with OpenSSL support
333 lwsts[4752]: Using SSL mode
334 lwsts[4752]: HTTP2 / ALPN enabled
339 For non-SSL HTTP2.0 upgrade
342 $ nghttp -nvasu http://localhost:7681/test.htm
345 For SSL / ALPN HTTP2.0 upgrade
348 $ nghttp -nvas https://localhost:7681/test.html
353 To enable cross-compiling **libwebsockets** using CMake you need to create
354 a "Toolchain file" that you supply to CMake when generating your build files.
355 CMake will then use the cross compilers and build paths specified in this file
356 to look for dependencies and such.
358 **Libwebsockets** includes an example toolchain file [cross-arm-linux-gnueabihf.cmake](cross-arm-linux-gnueabihf.cmake)
359 you can use as a starting point.
361 The commandline to configure for cross with this would look like
364 $ cmake .. -DCMAKE_INSTALL_PREFIX:PATH=/usr \
365 -DCMAKE_TOOLCHAIN_FILE=../cross-arm-linux-gnueabihf.cmake \
366 -DWITHOUT_EXTENSIONS=1 -DWITH_SSL=0
369 The example shows how to build with no external cross lib dependencies, you
370 need to provide the cross libraries otherwise.
372 **NOTE**: start from an EMPTY build directory if you had a non-cross build in there
373 before the settings will be cached and your changes ignored.
375 Additional information on cross compilation with CMake:
376 http://www.vtk.org/Wiki/CMake_Cross_Compiling
381 Embedded server-only configuration without extensions (ie, no compression
382 on websocket connections), but with full v13 websocket features and http
383 server, built on ARM Cortex-A9:
385 Update at 8dac94d (2013-02-18)
388 $ ./configure --without-client --without-extensions --disable-debug --without-daemonize
390 Context Creation, 1024 fd limit[2]: 16720 (includes 12 bytes per fd)
391 Per-connection [3]: 72 bytes, +1328 during headers
393 .text .rodata .data .bss
397 This shows the impact of the major configuration with/without options at
398 13ba5bbc633ea962d46d using Ubuntu ARM on a PandaBoard ES.
400 These are accounting for static allocations from the library elf, there are
401 additional dynamic allocations via malloc. These are a bit old now but give
402 the right idea for relative "expense" of features.
404 Static allocations, ARM9
406 | | .text | .rodata | .data | .bss |
407 |--------------------------------|---------|---------|-------|------|
408 | All (no without) | 35024 | 9940 | 336 | 4104 |
409 | without client | 25684 | 7144 | 336 | 4104 |
410 | without client, exts | 21652 | 6288 | 288 | 4104 |
411 | without client, exts, debug[1] | 19756 | 3768 | 288 | 4104 |
412 | without server | 30304 | 8160 | 336 | 4104 |
413 | without server, exts | 25382 | 7204 | 288 | 4104 |
414 | without server, exts, debug[1] | 23712 | 4256 | 288 | 4104 |
416 [1] `--disable-debug` only removes messages below `lwsl_notice`. Since that is
417 the default logging level the impact is not noticeable, error, warn and notice
418 logs are all still there.
420 [2] `1024` fd per process is the default limit (set by ulimit) in at least Fedora
421 and Ubuntu. You can make significant savings tailoring this to actual expected
422 peak fds, ie, at a limit of `20`, context creation allocation reduces to `4432 +
425 [3] known header content is freed after connection establishment