README.build.md

   1 Notes about building lws
   2 ========================
   3
   4
   5 @section cm Introduction to CMake
   6
   7 CMake is a multi-platform build tool that can generate build files for many
   8 different target platforms. See more info at http://www.cmake.org
   9
  10 CMake also allows/recommends you to do "out of source"-builds, that is,
  11 the build files are separated from your sources, so there is no need to
  12 create elaborate clean scripts to get a clean source tree, instead you
  13 simply remove your build directory.
  14
  15 Libwebsockets has been tested to build successfully on the following platforms
  16 with SSL support (both OpenSSL/wolfSSL):
  17
  18 - Windows (Visual Studio)
  19 - Windows (MinGW)
  20 - Linux (x86 and ARM)
  21 - OSX
  22 - NetBSD
  23
  24
  25 @section build1 Building the library and test apps
  26
  27 The project settings used by CMake to generate the platform specific build
  28 files is called [CMakeLists.txt](CMakeLists.txt). CMake then uses one of its "Generators" to
  29 output a Visual Studio project or Make file for instance. To see a list of
  30 the available generators for your platform, simply run the "cmake" command.
  31
  32 Note that by default OpenSSL will be linked, if you don't want SSL support
  33 see below on how to toggle compile options.
  34
  35
  36 @section bu Building on Unix:
  37
  38 1. Install CMake 2.8 or greater: http://cmake.org/cmake/resources/software.html
  39    (Most Unix distributions comes with a packaged version also)
  40
  41 2. Install OpenSSL.
  42
  43 3. Generate the build files (default is Make files):
  44 ```
  45         $ cd /path/to/src
  46         $ mkdir build
  47         $ cd build
  48         $ cmake ..
  49 ```
  50
  51 4. Finally you can build using the generated Makefile:
  52 ```
  53         $ make && sudo make install
  54 ```
  55 **NOTE**: The `build/`` directory can have any name and be located anywhere
  56  on your filesystem, and that the argument `..` given to cmake is simply
  57  the source directory of **libwebsockets** containing the [CMakeLists.txt](CMakeLists.txt)
  58  project file. All examples in this file assumes you use ".."
  59
  60 **NOTE2**:
  61 A common option you may want to give is to set the install path, same
  62 as --prefix= with autotools.  It defaults to /usr/local.
  63 You can do this by, eg
  64 ```
  65         $ cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr .
  66 ```
  67
  68 **NOTE3**:
  69 On machines that want libraries in lib64, you can also add the
  70 following to the cmake line
  71 ```
  72         -DLIB_SUFFIX=64
  73 ```
  74
  75 **NOTE4**:
  76 If you are building against a non-distro OpenSSL (eg, in order to get
  77 access to ALPN support only in newer OpenSSL versions) the nice way to
  78 express that in one cmake command is eg,
  79 ```
  80         $ cmake .. -DOPENSSL_ROOT_DIR=/usr/local/ssl \
  81                  -DCMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE=/usr/local/ssl \
  82                  -DLWS_WITH_HTTP2=1
  83 ```
  84
  85 When you run the test apps using non-distro SSL, you have to force them
  86 to use your libs, not the distro ones
  87 ```
  88         $ LD_LIBRARY_PATH=/usr/local/ssl/lib libwebsockets-test-server --ssl
  89 ```
  90
  91 To get it to build on latest openssl (2016-04-10) it needed this approach
  92 ```
  93         cmake .. -DLWS_WITH_HTTP2=1 -DLWS_OPENSSL_INCLUDE_DIRS=/usr/local/include/openssl -DLWS_OPENSSL_LIBRARIES="/usr/local/lib64/libssl.so;/usr/local/lib64/libcrypto.so"
  94 ```
  95
  96 **NOTE5**:
  97 To build with debug info and _DEBUG for lower priority debug messages
  98 compiled in, use
  99 ```
 100         $ cmake .. -DCMAKE_BUILD_TYPE=DEBUG
 101 ```
 102
 103 @section cmq Quirk of cmake
 104
 105 When changing cmake options, for some reason the only way to get it to see the
 106 changes sometimes is delete the contents of your build directory and do the
 107 cmake from scratch.
 108
 109
 110 @section cmw Building on Windows (Visual Studio)
 111
 112 1. Install CMake 2.6 or greater: http://cmake.org/cmake/resources/software.html
 113
 114 2. Install OpenSSL binaries. http://www.openssl.org/related/binaries.html
 115
 116    (**NOTE**: Preferably in the default location to make it easier for CMake to find them)
 117
 118    **NOTE2**:
 119    Be sure that OPENSSL_CONF environment variable is defined and points at
 120    <OpenSSL install location>\bin\openssl.cfg
 121
 122 3. Generate the Visual studio project by opening the Visual Studio cmd prompt:
 123
 124 ```
 125         cd <path to src>
 126         md build
 127         cd build
 128         cmake -G "Visual Studio 10" ..
 129 ```
 130
 131    (**NOTE**: There is also a cmake-gui available on Windows if you prefer that)
 132
 133    **NOTE2**:
 134    See this link to find out the version number corresponding to your Visual Studio edition:
 135    http://superuser.com/a/194065
 136
 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.
 139
 140 5. Some additional deps may be needed
 141
 142  - iphlpapi.lib
 143  - psapi.lib
 144  - userenv.lib
 145
 146 6. If you're using libuv, you must make sure to compile libuv with the same multithread-dll / Mtd attributes as libwebsockets itself
 147
 148
 149 @section cmwmgw Building on Windows (MinGW)
 150
 151 1. Install MinGW: http://sourceforge.net/projects/mingw/files
 152
 153    (**NOTE**: Preferably in the default location C:\MinGW)
 154
 155 2. Fix up MinGW headers
 156
 157    a) Add the following lines to C:\MinGW\include\winsock2.h:
 158 ```
 159         #if(_WIN32_WINNT >= 0x0600)
 160
 161         typedef struct pollfd {
 162
 163                 SOCKET  fd;
 164                 SHORT   events;
 165                 SHORT   revents;
 166
 167         } WSAPOLLFD, *PWSAPOLLFD, FAR *LPWSAPOLLFD;
 168
 169         WINSOCK_API_LINKAGE int WSAAPI WSAPoll(LPWSAPOLLFD fdArray, ULONG fds, INT timeout);
 170
 171         #endif // (_WIN32_WINNT >= 0x0600)
 172 ```
 173    b) Create C:\MinGW\include\mstcpip.h and copy and paste the content from following link into it:
 174
 175    http://wine-unstable.sourcearchive.com/documentation/1.1.32/mstcpip_8h-source.html
 176
 177 3. Install CMake 2.6 or greater: http://cmake.org/cmake/resources/software.html
 178
 179 4. Install OpenSSL binaries. http://www.openssl.org/related/binaries.html
 180
 181    (**NOTE**: Preferably in the default location to make it easier for CMake to find them)
 182
 183    **NOTE2**:
 184    Be sure that OPENSSL_CONF environment variable is defined and points at
 185    <OpenSSL install location>\bin\openssl.cfg
 186
 187 5. Generate the build files (default is Make files) using MSYS shell:
 188 ```
 189         $ cd /drive/path/to/src
 190         $ mkdir build
 191         $ cd build
 192         $ cmake -G "MSYS Makefiles" -DCMAKE_INSTALL_PREFIX=C:/MinGW ..
 193 ```
 194    (**NOTE**: The `build/`` directory can have any name and be located anywhere
 195     on your filesystem, and that the argument `..` given to cmake is simply
 196     the source directory of **libwebsockets** containing the [CMakeLists.txt](CMakeLists.txt)
 197     project file. All examples in this file assumes you use "..")
 198
 199    **NOTE2**:
 200    To generate build files allowing to create libwebsockets binaries with debug information
 201    set the CMAKE_BUILD_TYPE flag to DEBUG:
 202 ```
 203         $ cmake -G "MSYS Makefiles" -DCMAKE_INSTALL_PREFIX=C:/MinGW -DCMAKE_BUILD_TYPE=DEBUG ..
 204 ```
 205 6. Finally you can build using the generated Makefile and get the results deployed into your MinGW installation:
 206
 207 ```
 208         $ make
 209         $ make install
 210 ```
 211
 212 @section mbed3 Building on mbed3
 213
 214 MBED3 is a non-posix embedded OS targeted on Cortex M class chips.
 215
 216 https://www.mbed.com/
 217
 218 It's quite unlike any other Posixy platform since the OS is linked statically
 219 in with lws to form one binary.
 220
 221 At the minute server-only is supported and due to bugs in mbed3 network support,
 222 the port is of alpha quality.  However it can serve the test html, favicon.ico
 223 and logo png and may be able to make ws connections.  The binary for that
 224 including the OS, test app, lws and all the assets is only 117KB.
 225
 226 0) Today mbed3 only properly works on FRDM K64F $35 Freescale Dev Board with
 227 1MB Flash, 256KB SRAM and Ethernet.
 228
 229 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
 230
 231 1) Get a working mbed3 environment with arm-none-eabi-cs toolchain
 232 (available in Fedora, Ubuntu and other distros)
 233
 234 2) Confirm you can build things using yotta by following the getting started guide here
 235
 236 https://docs.mbed.com/docs/getting-started-mbed-os/en/latest/
 237
 238 3)
 239
 240 git clone https://github.com/warmcat/lws-test-server
 241
 242 and cd into it
 243
 244 4) mkdir -p yotta_modules ; cd yotta_modules
 245
 246 5) git clone https://github.com/warmcat/libwebsockets ; mv libwebsockets websockets ; cd ..
 247
 248 6) yotta target frdm-k64f-gcc
 249
 250 7) yotta install
 251
 252 8) yotta build
 253
 254 @section cmco Setting compile options
 255
 256
 257 To set compile time flags you can either use one of the CMake gui applications
 258 or do it via command line.
 259
 260 @subsection cmcocl Command line
 261
 262 To list avaialable options (omit the H if you don't want the help text):
 263
 264         cmake -LH ..
 265
 266 Then to set an option and build (for example turn off SSL support):
 267
 268         cmake -DLWS_WITH_SSL=0 ..
 269 or
 270         cmake -DLWS_WITH_SSL:BOOL=OFF ..
 271
 272 @subsection cmcoug Unix GUI
 273
 274 If you have a curses-enabled build you simply type:
 275 (not all packages include this, my debian install does not for example).
 276
 277         ccmake
 278
 279 @subsection cmcowg Windows GUI
 280
 281 On windows CMake comes with a gui application:
 282         Start -> Programs -> CMake -> CMake (cmake-gui)
 283
 284
 285 @section wolf wolfSSL/CyaSSL replacement for OpenSSL
 286
 287 wolfSSL/CyaSSL is a lightweight SSL library targeted at embedded systems:
 288 https://www.wolfssl.com/wolfSSL/Products-wolfssl.html
 289
 290 It contains a OpenSSL compatibility layer which makes it possible to pretty
 291 much link to it instead of OpenSSL, giving a much smaller footprint.
 292
 293 **NOTE**: wolfssl needs to be compiled using the `--enable-opensslextra` flag for
 294 this to work.
 295
 296 @section wolf1 Compiling libwebsockets with wolfSSL
 297
 298 ```
 299         cmake .. -DLWS_USE_WOLFSSL=1 \
 300                  -DLWS_WOLFSSL_INCLUDE_DIRS=/path/to/wolfssl \
 301                  -DLWS_WOLFSSL_LIBRARIES=/path/to/wolfssl/wolfssl.a ..
 302 ```
 303
 304 **NOTE**: On windows use the .lib file extension for `LWS_WOLFSSL_LIBRARIES` instead.
 305
 306 @section cya Compiling libwebsockets with CyaSSL
 307
 308 ```
 309         cmake .. -DLWS_USE_CYASSL=1 \
 310                  -DLWS_CYASSL_INCLUDE_DIRS=/path/to/cyassl \
 311                  -DLWS_CYASSL_LIBRARIES=/path/to/wolfssl/cyassl.a ..
 312 ```
 313
 314 **NOTE**: On windows use the .lib file extension for `LWS_CYASSL_LIBRARIES` instead.
 315
 316
 317 @section extplugins Building plugins outside of lws itself
 318
 319 The directory ./plugin-standalone/ shows how easy it is to create plugins
 320 outside of lws itself.  First build lws itself with -DLWS_WITH_PLUGINS,
 321 then use the same flow to build the standalone plugin
 322 ```
 323         cd ./plugin-standalone
 324         mkdir build
 325         cd build
 326         cmake ..
 327         make && sudo make install
 328 ```
 329
 330 if you changed the default plugin directory when you built lws, you must
 331 also give the same arguments to cmake here (eg,
 332 ` -DCMAKE_INSTALL_PREFIX:PATH=/usr/something/else...` )
 333
 334 Otherwise if you run lwsws or libwebsockets-test-server-v2.0, it will now
 335 find the additional plugin "libprotocol_example_standalone.so"
 336 ```
 337         lwsts[21257]:   Plugins:
 338         lwsts[21257]:    libprotocol_dumb_increment.so
 339         lwsts[21257]:    libprotocol_example_standalone.so
 340         lwsts[21257]:    libprotocol_lws_mirror.so
 341         lwsts[21257]:    libprotocol_lws_server_status.so
 342         lwsts[21257]:    libprotocol_lws_status.so
 343 ```
 344 If you have multiple vhosts, you must enable plugins at the vhost
 345 additionally, discovered plugins are not enabled automatically for security
 346 reasons.  You do this using info->pvo or for lwsws, in the JSON config.
 347
 348
 349 @section http2rp Reproducing HTTP2.0 tests
 350
 351 You must have built and be running lws against a version of openssl that has
 352 ALPN / NPN.  Most distros still have older versions.  You'll know it's right by
 353 seeing
 354 ```
 355         lwsts[4752]:  Compiled with OpenSSL support
 356         lwsts[4752]:  Using SSL mode
 357         lwsts[4752]:  HTTP2 / ALPN enabled
 358 ```
 359 at lws startup.
 360
 361 For non-SSL HTTP2.0 upgrade
 362 ```
 363         $ nghttp -nvasu http://localhost:7681/test.htm
 364 ```
 365 For SSL / ALPN HTTP2.0 upgrade
 366 ```
 367         $ nghttp -nvas https://localhost:7681/test.html
 368 ```
 369
 370 @section cross Cross compiling
 371
 372 To enable cross-compiling **libwebsockets** using CMake you need to create
 373 a "Toolchain file" that you supply to CMake when generating your build files.
 374 CMake will then use the cross compilers and build paths specified in this file
 375 to look for dependencies and such.
 376
 377 **Libwebsockets** includes an example toolchain file [cross-arm-linux-gnueabihf.cmake](cross-arm-linux-gnueabihf.cmake)
 378 you can use as a starting point.
 379
 380 The commandline to configure for cross with this would look like
 381 ```
 382         $ cmake .. -DCMAKE_INSTALL_PREFIX:PATH=/usr \
 383                  -DCMAKE_TOOLCHAIN_FILE=../cross-arm-linux-gnueabihf.cmake \
 384                  -DWITHOUT_EXTENSIONS=1 -DWITH_SSL=0
 385 ```
 386 The example shows how to build with no external cross lib dependencies, you
 387 need to provide the cross libraries otherwise.
 388
 389 **NOTE**: start from an EMPTY build directory if you had a non-cross build in there
 390         before the settings will be cached and your changes ignored.
 391
 392 Additional information on cross compilation with CMake:
 393         http://www.vtk.org/Wiki/CMake_Cross_Compiling
 394
 395 @section mem Memory efficiency
 396
 397 Embedded server-only configuration without extensions (ie, no compression
 398 on websocket connections), but with full v13 websocket features and http
 399 server, built on ARM Cortex-A9:
 400
 401 Update at 8dac94d (2013-02-18)
 402 ```
 403         $ ./configure --without-client --without-extensions --disable-debug --without-daemonize
 404
 405         Context Creation, 1024 fd limit[2]:   16720 (includes 12 bytes per fd)
 406         Per-connection [3]:                      72 bytes, +1328 during headers
 407
 408         .text   .rodata .data   .bss
 409         11512   2784    288     4
 410 ```
 411 This shows the impact of the major configuration with/without options at
 412 13ba5bbc633ea962d46d using Ubuntu ARM on a PandaBoard ES.
 413
 414 These are accounting for static allocations from the library elf, there are
 415 additional dynamic allocations via malloc.  These are a bit old now but give
 416 the right idea for relative "expense" of features.
 417
 418 Static allocations, ARM9
 419
 420 |                                | .text   | .rodata | .data | .bss |
 421 |--------------------------------|---------|---------|-------|------|
 422 | All (no without)               | 35024   | 9940    | 336   | 4104 |
 423 | without client                 | 25684   | 7144    | 336   | 4104 |
 424 | without client, exts           | 21652   | 6288    | 288   | 4104 |
 425 | without client, exts, debug[1] | 19756   | 3768    | 288   | 4104 |
 426 | without server                 | 30304   | 8160    | 336   | 4104 |
 427 | without server, exts           | 25382   | 7204    | 288   | 4104 |
 428 | without server, exts, debug[1] | 23712   | 4256    | 288   | 4104 |
 429
 430 [1] `--disable-debug` only removes messages below `lwsl_notice`.  Since that is
 431 the default logging level the impact is not noticeable, error, warn and notice
 432 logs are all still there.
 433
 434 [2] `1024` fd per process is the default limit (set by ulimit) in at least Fedora
 435 and Ubuntu.  You can make significant savings tailoring this to actual expected
 436 peak fds, ie, at a limit of `20`, context creation allocation reduces to `4432 +
 437 240 = 4672`)
 438
 439 [3] known header content is freed after connection establishment