README.build

   1 Introduction
   2 ------------
   3 Libwebsockets can be built using two different build systems
   4 autoconf or CMake. autoconf only works on Unix systems, or mingw/cygwin
   5 on Windows. CMake works differently and can generate platform specific
   6 project files for most popular IDEs and build systems.
   7
   8 ################################### Autoconf ###################################
   9
  10 Building the library and test apps
  11 ----------------------------------
  12
  13 You need to regenerate the autotools and libtoolize stuff for your system
  14
  15 $ ./autogen.sh
  16
  17 Then,
  18
  19 ------Fedora x86_64
  20
  21  ./configure --prefix=/usr --libdir=/usr/lib64 --enable-openssl
  22
  23 ------Apple
  24
  25 Christopher Baker reported that this is needed
  26
  27 ./configure CC="gcc -arch i386 -arch x86_64" CXX="g++ -arch i386 -arch
  28 x86_64" CPP="gcc -E" CXXCPP="g++ -E" --enable-nofork
  29
  30 ------mingw
  31
  32 I did the following to get working build, ping test is disabled when
  33 building this way
  34
  35 1) install mingw64_w32 compiler packages from Fedora
  36 2) additionally install mingw64-zlib package
  37 3) ./configure --prefix=/usr --enable-mingw --host=x86_64-w64-mingw32
  38 4) make
  39
  40 ------MIPS cross-build using OpenWRT
  41
  42  ./configure --prefix=/usr --without-extensions --host mips-openwrt-linux
  43
  44 I did not try building the extensions since they need cross-zlib, but it
  45 should also be workable.
  46
  47 ------Other uClibc
  48
  49 you may need --enable-builtin-getifaddrs if your toolchain
  50 doesn't have it - openWRT uclibc has it so you don't need this option.
  51
  52 ------ARM cross-build
  53
  54 ./configure --prefix=/usr --host=arm-linux-gnueabi --without-client --without-extensions
  55
  56 you can build cross with client and extensions perfectly well, but
  57 apart from the size shrink this has the nice characteristic that no
  58 non-toolchain libraries are needed to build it.
  59
  60
  61 otherwise if /usr/local/... and /usr/local/lib are OK then...
  62
  63 $ ./configure
  64 $ make clean
  65 $ make && sudo make install
  66 $ libwebsockets-test-server
  67
  68 should be enough to get a test server listening on port 7861.
  69
  70
  71 Configure script options
  72 ------------------------
  73
  74 There are several other possible configure options
  75
  76 --enable-openssl        Builds in the SSL support
  77
  78 --with-cyassl           Use cyassl instead of OpenSSL... you will need CyaSSL
  79                         to have been configured with --enable-opensslExtra
  80 \                       when it was built.
  81
  82 --enable-libcrypto      by default libwebsockets uses its own
  83                         built-in md5 and sha-1 implementation for
  84                         simplicity.  However the libcrypto ones
  85                         may be faster, and in a distro context it
  86                         may be highly desirable to use a common
  87                         library implementation for ease of security
  88                         upgrades.  Give this configure option
  89                         to disable the built-in ones and force use
  90                         of the libcrypto (part of openssl) ones.
  91
  92 --with-client-cert-dir=dir   tells the client ssl support where to
  93                              look for trust certificates to validate
  94                              the remote certificate against.
  95
  96 --enable-noping         Don't try to build the ping test app
  97                         It needs some unixy environment that
  98                         may choke in other build contexts, this
  99                         lets you cleanly stop it being built
 100
 101 --enable-builtin-getifaddrs  if your libc lacks getifaddrs, you can build an
 102                         implementation into the library.  By default your libc
 103                         one is used.
 104
 105 --without-testapps      Just build the library not the test apps
 106
 107 --without-client        Don't build the client part of the library nor the
 108                         test apps that need the client part.  Useful to
 109                         minimize library footprint for embedded server-only
 110                         case
 111
 112 --without-server        Don't build the server part of the library nor the
 113                         test apps that need the server part.  Useful to
 114                         minimize library footprint for embedded client-only
 115                         case
 116
 117 --without-daemonize     Don't build daemonize.c / lws_daemonize
 118
 119 --disable-debug         Remove all debug logging below lwsl_notice in severity
 120                         from the code -- it's not just defeated from logging
 121                         but removed from compilation
 122
 123 --without-extensions    Remove all code and data around protocol extensions.
 124                         This reduces the code footprint considerably but
 125                         you will lose extension features like compression.
 126                         However that may be irrelevant for embedded use and
 127                         the code / data size / speed improvements may be
 128                         critical.
 129
 130 --with-latency          Builds the latency-tracking code into the library...
 131                         this slows your library down a bit but is very useful
 132                         to find the cause of unexpected latencies occurring
 133                         inside the library.  See README.test-apps for more
 134                         info
 135
 136
 137 Externally configurable important constants
 138 -------------------------------------------
 139
 140 You can control these from configure by just setting them as commandline
 141 args throgh CFLAGS, eg
 142
 143 ./configure CFLAGS="-DLWS_MAX_ZLIB_CONN_BUFFER=8192"
 144
 145
 146 They all have reasonable defaults usable for all use-cases except resource-
 147 constrained, so you only need to take care about them if you want to tune them
 148 to the amount of memory available.
 149
 150  - LWS_MAX_HEADER_LEN default 1024: allocated area to copy http headers that
 151 libwebsockets knows about into.  You only need to think about increasing this
 152 if your application might have monster length URLs for example, or some other
 153 header that lws cares about will be abnormally large (headers it does not
 154 know about are skipped).
 155
 156  - LWS_MAX_PROTOCOLS default 5: largest amount of different protocols the
 157 server can serve
 158
 159  - LWS_MAX_EXTENSIONS_ACTIVE default 3: largest amount of extensions we can
 160 choose to have active on one connection
 161
 162  - SPEC_LATEST_SUPPORTED default 13: only change if you want to remove support
 163 for later protocol versions... unlikely
 164
 165  - AWAITING_TIMEOUT default 5: after this many seconds without a response, the
 166 server will hang up on the client
 167
 168  - CIPHERS_LIST_STRING default "DEFAULT": SSL Cipher selection.  It's advisable
 169 to tweak the ciphers allowed to be negotiated on secure connections for
 170 performance reasons, otherwise a slow algorithm may be selected by the two
 171 endpoints and the server could expend most of its time just encrypting and
 172 decrypting data, severely limiting the amount of messages it will be able to
 173 handle per second.  For example::
 174
 175     "RC4-MD5:RC4-SHA:AES128-SHA:AES256-SHA:HIGH:!DSS:!aNULL"
 176
 177  - SYSTEM_RANDOM_FILEPATH default "/dev/urandom": if your random device differs
 178 you can set it here
 179
 180  - LWS_MAX_ZLIB_CONN_BUFFER  maximum size a compression buffer is allowed to
 181 grow to before closing the connection.  Some limit is needed or any connecton
 182 can exhaust all server memory by sending it 4G buffers full of zeros which the
 183 server is expect to expand atomically.  Default is 64KBytes.
 184
 185  - LWS_SOMAXCONN  maximum number of pending connect requests the listening
 186 socket can cope with.  Default is SOMAXCONN.  If you need to use synthetic
 187 tests that just spam hundreds of connect requests at once without dropping
 188 any, you can try messing with these as well as ulimit (see later)
 189 (courtesy Edwin van der Oetelaar)
 190
 191 echo "2048 64512" > /proc/sys/net/ipv4/ip_local_port_range
 192 echo "1" > /proc/sys/net/ipv4/tcp_tw_recycle
 193 echo "1" > /proc/sys/net/ipv4/tcp_tw_reuse
 194 echo "10" > /proc/sys/net/ipv4/tcp_fin_timeout
 195 echo "65536" > /proc/sys/net/core/somaxconn
 196 echo "65536" > /proc/sys/net/ipv4/tcp_max_syn_backlog
 197 echo "262144" > /proc/sys/net/netfilter/nf_conntrack_max
 198
 199
 200 Memory efficiency
 201 -----------------
 202
 203 Embedded server-only configuration without extensions (ie, no compression
 204 on websocket connections), but with full v13 websocket features and http
 205 server, built on ARM Cortex-A9:
 206
 207 Update at 8dac94d (2013-02-18)
 208
 209 ./configure --without-client --without-extensions --disable-debug --without-daemonize
 210
 211 Context Creation, 1024 fd limit[2]:   16720 (includes 12 bytes per fd)
 212 Per-connection [3]:                      72 bytes, +1328 during headers
 213
 214 .text   .rodata .data   .bss
 215 11512   2784    288     4
 216
 217 This shows the impact of the major configuration with/without options at
 218 13ba5bbc633ea962d46d using Ubuntu ARM on a PandaBoard ES.
 219
 220 These are accounting for static allocations from the library elf, there are
 221 additional dynamic allocations via malloc.  These are a bit old now but give
 222 the right idea for relative "expense" of features.
 223
 224 Static allocations, ARM9
 225                                 .text   .rodata .data   .bss
 226  All (no without)               35024   9940    336     4104
 227  without client                 25684   7144    336     4104
 228  without client, exts           21652   6288    288     4104
 229  without client, exts, debug[1] 19756   3768    288     4104
 230  without server                 30304   8160    336     4104
 231  without server, exts           25382   7204    288     4104
 232  without server, exts, debug[1] 23712   4256    288     4104
 233
 234 [1] --disable-debug only removes messages below lwsl_notice.  Since that is
 235 the default logging level the impact is not noticable, error, warn and notice
 236 logs are all still there.
 237
 238 [2] 1024 fd per process is the default limit (set by ulimit) in at least Fedora
 239 and Ubuntu.  You can make significant savings tailoring this to actual expected
 240 peak fds, ie, at a limit of 20, context creation allocation reduces to 4432 +
 241 240 = 4672)
 242
 243 [3] known header content is freed after connection establishment
 244
 245
 246 #################################### CMake ####################################
 247
 248 CMake is a multi-platform build tool that can generate build files for many
 249 different target platforms. See more info at http://www.cmake.org
 250
 251 CMake also allows/recommends you to do "out of source"-builds, that is,
 252 the build files are separated from your sources, so there is no need to
 253 create elaborate clean scripts to get a clean source tree, instead you
 254 simply remove your build directory.
 255
 256 Libwebsockets has been tested to build successfully on the following platforms
 257 with SSL support (both OpenSSL/CyaSSL):
 258
 259 - Windows
 260 - Linux (x86 and ARM)
 261 - OSX
 262 - NetBSD
 263
 264 Building the library and test apps
 265 ----------------------------------
 266
 267 The project settings used by CMake to generate the platform specific build
 268 files is called CMakeLists.txt. CMake then uses one of its "Generators" to
 269 output a Visual Studio project or Make file for instance. To see a list of
 270 the available generators for your platform, simply run the "cmake" command.
 271
 272 Note that by default OpenSSL will be linked, if you don't want SSL support
 273 see below on how to toggle compile options.
 274
 275 Building on Unix:
 276 -----------------
 277
 278 1. Install CMake 2.6 or greater: http://cmake.org/cmake/resources/software.html
 279    (Most Unix distributions comes with a packaged version also)
 280
 281 2. Install OpenSSL.
 282
 283 3. Generate the build files (default is Make files):
 284
 285         cd /path/to/src
 286         mkdir build
 287         cd build
 288         cmake ..
 289
 290         (NOTE: The build/ directory can have any name and be located anywhere
 291          on your filesystem, and that the argument ".." given to cmake is simply
 292          the source directory of libwebsockets containing the CMakeLists.txt project
 293          file. All examples in this file assumes you use "..")
 294
 295         A common option you may want to give is to set the install path, same
 296         as --prefix= with autotools.  It defaults to /usr/local.
 297         You can do this by, eg
 298
 299         cmake .. -DCMAKE_INSTALL_PREFIX:PATH=/usr
 300
 301 4. Finally you can build using the generated Makefile:
 302
 303         make
 304
 305 Building on Windows (Visual Studio)
 306 -----------------------------------
 307 1. Install CMake 2.6 or greater: http://cmake.org/cmake/resources/software.html
 308
 309 2. Install OpenSSL binaries. http://www.openssl.org/related/binaries.html
 310    (Preferably in the default location to make it easier for CMake to find them)
 311
 312 3. Generate the Visual studio project by opening the Visual Studio cmd prompt:
 313
 314    cd <path to src>
 315    md build
 316    cd build
 317    cmake -G "Visual Studio 10" ..
 318
 319    (NOTE: There is also a cmake-gui available on Windows if you prefer that)
 320
 321 4. Now you should have a generated Visual Studio Solution in  your
 322    <path to src>/build directory, which can be used to build.
 323
 324 Setting compile options
 325 -----------------------
 326
 327 To set compile time flags you can either use one of the CMake gui applications
 328 or do it via command line.
 329
 330 Command line
 331 ------------
 332 To list avaialable options (ommit the H if you don't want the help text):
 333
 334         cmake -LH ..
 335
 336 Then to set an option and build (for example turn off SSL support):
 337
 338         cmake -DWITH_SSL=0 ..
 339 or
 340         cmake -DWITH_SSL:BOOL=OFF ..
 341
 342 Unix GUI
 343 --------
 344 If you have a curses enabled build you simply type:
 345 (not all packages include this, my debian install does not for example).
 346
 347         ccmake
 348
 349 Windows GUI
 350 -----------
 351 On windows CMake comes with a gui application:
 352         Start -> Programs -> CMake -> CMake (cmake-gui)
 353
 354 CyaSSL replacement for OpenSSL
 355 ------------------------------
 356 CyaSSL is a lightweight SSL library targeted at embedded system:
 357 http://www.yassl.com/yaSSL/Products-cyassl.html
 358
 359 It contains a OpenSSL compatability layer which makes it possible to pretty
 360 much link to it instead of OpenSSL, giving a much smaller footprint.
 361
 362 NOTE: At the time of writing this the current release of CyaSSL contains a
 363 crash bug due to some APIs libwebsocket uses. To be able to use this you will
 364 need to use the current HEAD in their official repository:
 365         https://github.com/cyassl/cyassl
 366
 367 NOTE: cyassl needs to be compiled using the --enable-opensslExtra flag for
 368 this to work.
 369
 370 Compiling libwebsockets with CyaSSL
 371 -----------------------------------
 372
 373 cmake -DUSE_CYASSL=1
 374           -DCYASSL_INCLUDE_DIRS=/path/to/cyassl
 375           -DCYASSL_LIB=/path/to/cyassl/cyassl.a ..
 376
 377 NOTE: On windows use the .lib file extension for CYASSL_LIB instead.
 378
 379 Cross compiling
 380 ---------------
 381 To enable cross compiling libwebsockets using CMake you need to create
 382 a "Toolchain file" that you supply to CMake when generating your build files.
 383 CMake will then use the cross compilers and build paths specified in this file
 384 to look for dependencies and such.
 385
 386 Below is an example of how one of these files might look like:
 387
 388         #
 389         # CMake Toolchain file for crosscompiling on ARM.
 390         #
 391         # This can be used when running cmake in the following way:
 392         #  cd build/
 393         #  cmake .. -DCMAKE_TOOLCHAIN_FILE=/path/to/this/file/TC_arm-linux-gcc.cmake
 394         #
 395
 396         set(CROSS_PATH /path/to/cross_environment/uClibc)
 397
 398         # Target operating system name.
 399         set(CMAKE_SYSTEM_NAME Linux)
 400
 401         # Name of C compiler.
 402         set(CMAKE_C_COMPILER "${CROSS_PATH}/bin/arm-linux-uclibc-gcc")
 403         set(CMAKE_CXX_COMPILER "${CROSS_PATH}/bin/arm-linux-uclibc-g++")
 404
 405         # Where to look for the target environment. (More paths can be added here)
 406         set(CMAKE_FIND_ROOT_PATH "${CROSS_PATH}")
 407
 408         # Adjust the default behavior of the FIND_XXX() commands:
 409         # search programs in the host environment only.
 410         set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
 411
 412         # Search headers and libraries in the target environment only.
 413         set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
 414         set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
 415
 416 Additional information on cross compilation with CMake:
 417         http://www.vtk.org/Wiki/CMake_Cross_Compiling