-Introduction to CMake
----------------------
+Notes about building lws
+========================
+
+
+@section cm Introduction to CMake
CMake is a multi-platform build tool that can generate build files for many
different target platforms. See more info at http://www.cmake.org
simply remove your build directory.
Libwebsockets has been tested to build successfully on the following platforms
-with SSL support (both OpenSSL/wolfSSL):
+with SSL support (for OpenSSL/wolfSSL/BoringSSL):
- Windows (Visual Studio)
- Windows (MinGW)
- OSX
- NetBSD
-Building the library and test apps
-----------------------------------
+
+@section build1 Building the library and test apps
The project settings used by CMake to generate the platform specific build
files is called [CMakeLists.txt](CMakeLists.txt). CMake then uses one of its "Generators" to
Note that by default OpenSSL will be linked, if you don't want SSL support
see below on how to toggle compile options.
-Building on Unix:
------------------
+
+@section bu Building on Unix:
1. Install CMake 2.8 or greater: http://cmake.org/cmake/resources/software.html
(Most Unix distributions comes with a packaged version also)
2. Install OpenSSL.
3. Generate the build files (default is Make files):
+```
+ $ cd /path/to/src
+ $ mkdir build
+ $ cd build
+ $ cmake ..
+```
- ```bash
- $ cd /path/to/src
- $ mkdir build
- $ cd build
- $ cmake ..
- ```
-
- (**NOTE**: The `build/`` directory can have any name and be located anywhere
- on your filesystem, and that the argument `..` given to cmake is simply
- the source directory of **libwebsockets** containing the [CMakeLists.txt](CMakeLists.txt)
- project file. All examples in this file assumes you use "..")
-
- **NOTE2**:
- A common option you may want to give is to set the install path, same
- as --prefix= with autotools. It defaults to /usr/local.
- You can do this by, eg
-
- ```bash
- $ cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr ..
- ```
-
- **NOTE3**:
- On machines that want libraries in lib64, you can also add the
- following to the cmake line
+4. Finally you can build using the generated Makefile:
+```
+ $ make && sudo make install
+```
+**NOTE**: The `build/`` directory can have any name and be located anywhere
+ on your filesystem, and that the argument `..` given to cmake is simply
+ the source directory of **libwebsockets** containing the [CMakeLists.txt](CMakeLists.txt)
+ project file. All examples in this file assumes you use ".."
+
+**NOTE2**:
+A common option you may want to give is to set the install path, same
+as --prefix= with autotools. It defaults to /usr/local.
+You can do this by, eg
+```
+ $ cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr .
+```
- ```bash
+**NOTE3**:
+On machines that want libraries in lib64, you can also add the
+following to the cmake line
+```
-DLIB_SUFFIX=64
- ```
-
- **NOTE4**:
- If you are building against a non-distro OpenSSL (eg, in order to get
- access to ALPN support only in newer OpenSSL versions) the nice way to
- express that in one cmake command is eg,
+```
- ```bash
+**NOTE4**:
+If you are building against a non-distro OpenSSL (eg, in order to get
+access to ALPN support only in newer OpenSSL versions) the nice way to
+express that in one cmake command is eg,
+```
$ cmake .. -DOPENSSL_ROOT_DIR=/usr/local/ssl \
-DCMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE=/usr/local/ssl \
-DLWS_WITH_HTTP2=1
- ```
-
- When you run the test apps using non-distro SSL, you have to force them
- to use your libs, not the distro ones
+```
- ```bash
+When you run the test apps using non-distro SSL, you have to force them
+to use your libs, not the distro ones
+```
$ LD_LIBRARY_PATH=/usr/local/ssl/lib libwebsockets-test-server --ssl
- ```
+```
- **NOTE5**:
- To build with debug info and _DEBUG for lower priority debug messages
- compiled in, use
+To get it to build on latest openssl (2016-04-10) it needed this approach
+```
+ 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"
+```
+
+Mac users have reported
+
+```
+ $ export OPENSSL_ROOT_DIR=/usr/local/Cellar/openssl/1.0.2k; cmake ..; make -j4
+```
+
+worked for them when using "homebrew" OpenSSL
- ```bash
+**NOTE5**:
+To build with debug info and _DEBUG for lower priority debug messages
+compiled in, use
+```
$ cmake .. -DCMAKE_BUILD_TYPE=DEBUG
- ````
+```
+
+**NOTE6**
+To build on Solaris the linker needs to be informed to use lib socket
+and libnsl, and only builds in 64bit mode.
+
+```bash
+ $ cmake .. -DCMAKE_C_FLAGS=-m64 -DCMAKE_EXE_LINKER_FLAGS="-lsocket -lnsl"
+```
4. Finally you can build using the generated Makefile:
- ```bash
+```bash
$ make
- ```
+ ```
-Quirk of cmake
---------------
+@section lcap Linux Capabilities
+
+On Linux, lws now lets you retain selected root capabilities when dropping
+privileges. If libcap-dev or similar package is installed providing
+sys/capabilities.h, and libcap or similar package is installed providing
+libcap.so, CMake will enable the capability features.
+
+The context creation info struct .caps[] and .count_caps members can then
+be set by user code to enable selected root capabilities to survive the
+transition to running under an unprivileged user.
+
+@section cmq Quirk of cmake
When changing cmake options, for some reason the only way to get it to see the
changes sometimes is delete the contents of your build directory and do the
cmake from scratch.
-Building on Windows (Visual Studio)
------------------------------------
+deleting build/CMakeCache.txt may be enough.
+
+
+@section cmw Building on Windows (Visual Studio)
+
1. Install CMake 2.6 or greater: http://cmake.org/cmake/resources/software.html
2. Install OpenSSL binaries. http://www.openssl.org/related/binaries.html
3. Generate the Visual studio project by opening the Visual Studio cmd prompt:
- ```bash
- cd <path to src>
- md build
- cd build
- cmake -G "Visual Studio 10" ..
- ```
+```
+ md build
+ cd build
+ cmake -G "Visual Studio 10" ..
+```
(**NOTE**: There is also a cmake-gui available on Windows if you prefer that)
4. Now you should have a generated Visual Studio Solution in your
`<path to src>/build` directory, which can be used to build.
-Building on Windows (MinGW)
----------------------------
+5. Some additional deps may be needed
+
+ - iphlpapi.lib
+ - psapi.lib
+ - userenv.lib
+
+6. If you're using libuv, you must make sure to compile libuv with the same multithread-dll / Mtd attributes as libwebsockets itself
+
+
+@section cmwmgw Building on Windows (MinGW)
+
1. Install MinGW: http://sourceforge.net/projects/mingw/files
(**NOTE**: Preferably in the default location C:\MinGW)
2. Fix up MinGW headers
- a) Add the following lines to C:\MinGW\include\winsock2.h:
-
- ```c
- #if(_WIN32_WINNT >= 0x0600)
+ a) If still necessary, sdd the following lines to C:\MinGW\include\winsock2.h:
+```
+ #if(_WIN32_WINNT >= 0x0600)
- typedef struct pollfd {
+ typedef struct pollfd {
- SOCKET fd;
- SHORT events;
- SHORT revents;
+ SOCKET fd;
+ SHORT events;
+ SHORT revents;
- } WSAPOLLFD, *PWSAPOLLFD, FAR *LPWSAPOLLFD;
+ } WSAPOLLFD, *PWSAPOLLFD, FAR *LPWSAPOLLFD;
- WINSOCK_API_LINKAGE int WSAAPI WSAPoll(LPWSAPOLLFD fdArray, ULONG fds, INT timeout);
+ WINSOCK_API_LINKAGE int WSAAPI WSAPoll(LPWSAPOLLFD fdArray, ULONG fds, INT timeout);
+
+ #endif // (_WIN32_WINNT >= 0x0600)
+```
- #endif // (_WIN32_WINNT >= 0x0600)
- ```
+ Update crtdefs.h line 47 to say:
+
+```
+ typedef __int64 ssize_t;
+```
b) Create C:\MinGW\include\mstcpip.h and copy and paste the content from following link into it:
-
- http://wine-unstable.sourcearchive.com/documentation/1.1.32/mstcpip_8h-source.html
+
+ https://github.com/Alexpux/mingw-w64/blob/master/mingw-w64-headers/include/mstcpip.h
3. Install CMake 2.6 or greater: http://cmake.org/cmake/resources/software.html
<OpenSSL install location>\bin\openssl.cfg
5. Generate the build files (default is Make files) using MSYS shell:
-
- ```bash
- $ cd /drive/path/to/src
- $ mkdir build
- $ cd build
- $ cmake -G "MSYS Makefiles" -DCMAKE_INSTALL_PREFIX=C:/MinGW ..
- ```
-
+```
+ $ cd /drive/path/to/src
+ $ mkdir build
+ $ cd build
+ $ cmake -G "MSYS Makefiles" -DCMAKE_INSTALL_PREFIX=C:/MinGW ..
+```
(**NOTE**: The `build/`` directory can have any name and be located anywhere
on your filesystem, and that the argument `..` given to cmake is simply
the source directory of **libwebsockets** containing the [CMakeLists.txt](CMakeLists.txt)
**NOTE2**:
To generate build files allowing to create libwebsockets binaries with debug information
set the CMAKE_BUILD_TYPE flag to DEBUG:
+```
+ $ cmake -G "MSYS Makefiles" -DCMAKE_INSTALL_PREFIX=C:/MinGW -DCMAKE_BUILD_TYPE=DEBUG ..
+```
+6. Finally you can build using the generated Makefile and get the results deployed into your MinGW installation:
- ```bash
- $ cmake -G "MSYS Makefiles" -DCMAKE_INSTALL_PREFIX=C:/MinGW -DCMAKE_BUILD_TYPE=DEBUG ..
- ```
+```
+ $ make
+ $ make install
+```
-6. Finally you can build using the generated Makefile and get the results deployed into your MinGW installation:
+@section optee Building for OP-TEE
- ```bash
- $ make
- $ make install
- ```
+OP-TEE is a "Secure World" Trusted Execution Environment.
-Setting compile options
------------------------
+Although lws is only part of the necessary picture to have an https-enabled
+TA, it does support OP-TEE as a platform and if you provide the other
+pieces, does work very well.
+
+Select it in cmake with `-DLWS_PLAT_OPTEE=1`
+
+
+@section cmco Setting compile options
To set compile time flags you can either use one of the CMake gui applications
-or do it via command line.
+or do it via the command line.
+
+@subsection cmcocl Command line
-Command line
-------------
-To list avaialable options (ommit the H if you don't want the help text):
+To list available options (omit the H if you don't want the help text):
cmake -LH ..
or
cmake -DLWS_WITH_SSL:BOOL=OFF ..
-Building on mbed3
------------------
-MBED3 is a non-posix embedded OS targeted on Cortex M class chips.
+@subsection cmcoug Unix GUI
-https://www.mbed.com/
+If you have a curses-enabled build you simply type:
+(not all packages include this, my debian install does not for example).
-It's quite unlike any other Posixy platform since the OS is linked statically
-in with lws to form one binary.
+ ccmake
-At the minute server-only is supported and due to bugs in mbed3 network support,
-the port is of alpha quality. However it can serve the test html, favicon.ico
-and logo png and may be able to make ws connections. The binary for that
-including the OS, test app, lws and all the assets is only 117KB.
+@subsection cmcowg Windows GUI
-0) Today mbed3 only properly works on FRDM K64F $35 Freescale Dev Board with
-1MB Flash, 256KB SRAM and Ethernet.
+On windows CMake comes with a gui application:
+ Start -> Programs -> CMake -> CMake (cmake-gui)
-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
-1) Get a working mbed3 environment with arm-none-eabi-cs toolchain
-(available in Fedora, Ubuntu and other distros)
+@section wolf wolfSSL/CyaSSL replacement for OpenSSL
-2) Confirm you can build things using yotta by following the getting started guide here
+wolfSSL/CyaSSL is a lightweight SSL library targeted at embedded systems:
+https://www.wolfssl.com/wolfSSL/Products-wolfssl.html
-https://docs.mbed.com/docs/getting-started-mbed-os/en/latest/
+It contains a OpenSSL compatibility layer which makes it possible to pretty
+much link to it instead of OpenSSL, giving a much smaller footprint.
-3)
+**NOTE**: wolfssl needs to be compiled using the `--enable-opensslextra` flag for
+this to work.
-git clone https://github.com/warmcat/lws-test-server
+@section wolf1 Compiling libwebsockets with wolfSSL
-and cd into it
+```
+ cmake .. -DLWS_USE_WOLFSSL=1 \
+ -DLWS_WOLFSSL_INCLUDE_DIRS=/path/to/wolfssl \
+ -DLWS_WOLFSSL_LIBRARIES=/path/to/wolfssl/wolfssl.a ..
+```
-4) mkdir -p yotta_modules ; cd yotta_modules
+**NOTE**: On windows use the .lib file extension for `LWS_WOLFSSL_LIBRARIES` instead.
-5) git clone https://github.com/warmcat/libwebsockets ; mv libwebsockets websockets ; cd ..
+@section cya Compiling libwebsockets with CyaSSL
-6) yotta target frdm-k64f-gcc
+```
+ cmake .. -DLWS_USE_CYASSL=1 \
+ -DLWS_CYASSL_INCLUDE_DIRS=/path/to/cyassl \
+ -DLWS_CYASSL_LIBRARIES=/path/to/wolfssl/cyassl.a ..
+```
-7) yotta install
+**NOTE**: On windows use the .lib file extension for `LWS_CYASSL_LIBRARIES` instead.
-8) yotta build
+@section esp32 Building for ESP32
+Step 1, get ESP-IDF with lws integrated as a component
-Unix GUI
---------
-If you have a curses-enabled build you simply type:
-(not all packages include this, my debian install does not for example).
+```
+ $ git clone --int --recursive https://github.com/lws-team/lws-esp-idf
+```
- ccmake
+Step 2: Get Application including the test plugins
-Windows GUI
------------
-On windows CMake comes with a gui application:
- Start -> Programs -> CMake -> CMake (cmake-gui)
+```
+ $ git clone https://github.com/lws-team/lws-esp32
+```
-wolfSSL/CyaSSL replacement for OpenSSL
---------------------------------------
-wolfSSL/CyaSSL is a lightweight SSL library targeted at embedded systems:
-https://www.wolfssl.com/wolfSSL/Products-wolfssl.html
+Set your IDF_PATH to point to the esp-idf you downloaded in 1)
-It contains a OpenSSL compatibility layer which makes it possible to pretty
-much link to it instead of OpenSSL, giving a much smaller footprint.
+There's docs for how to build the lws-esp32 test app and reproduce it in the README.md here
-**NOTE**: wolfssl needs to be compiled using the `--enable-opensslextra` flag for
-this to work.
+https://github.com/lws-team/lws-esp32/blob/master/README.md
-Compiling libwebsockets with wolfSSL
-------------------------------------
-```bash
-cmake .. -DLWS_USE_WOLFSSL=1 \
- -DLWS_WOLFSSL_INCLUDE_DIRS=/path/to/wolfssl \
- -DLWS_WOLFSSL_LIBRARIES=/path/to/wolfssl/wolfssl.a ..
-```
+@section extplugins Building plugins outside of lws itself
-**NOTE**: On windows use the .lib file extension for `LWS_WOLFSSL_LIBRARIES` instead.
+The directory ./plugin-standalone/ shows how easy it is to create plugins
+outside of lws itself. First build lws itself with -DLWS_WITH_PLUGINS,
+then use the same flow to build the standalone plugin
+```
+ cd ./plugin-standalone
+ mkdir build
+ cd build
+ cmake ..
+ make && sudo make install
+```
-Compiling libwebsockets with CyaSSL
------------------------------------
+if you changed the default plugin directory when you built lws, you must
+also give the same arguments to cmake here (eg,
+` -DCMAKE_INSTALL_PREFIX:PATH=/usr/something/else...` )
-```bash
-cmake .. -DLWS_USE_CYASSL=1 \
- -DLWS_CYASSL_INCLUDE_DIRS=/path/to/cyassl \
- -DLWS_CYASSL_LIBRARIES=/path/to/wolfssl/cyassl.a ..
+Otherwise if you run lwsws or libwebsockets-test-server-v2.0, it will now
+find the additional plugin "libprotocol_example_standalone.so"
```
+ lwsts[21257]: Plugins:
+ lwsts[21257]: libprotocol_dumb_increment.so
+ lwsts[21257]: libprotocol_example_standalone.so
+ lwsts[21257]: libprotocol_lws_mirror.so
+ lwsts[21257]: libprotocol_lws_server_status.so
+ lwsts[21257]: libprotocol_lws_status.so
+```
+If you have multiple vhosts, you must enable plugins at the vhost
+additionally, discovered plugins are not enabled automatically for security
+reasons. You do this using info->pvo or for lwsws, in the JSON config.
-**NOTE**: On windows use the .lib file extension for `LWS_CYASSL_LIBRARIES` instead.
-Reproducing HTTP2.0 tests
--------------------------
+@section http2rp Reproducing HTTP2.0 tests
You must have built and be running lws against a version of openssl that has
ALPN / NPN. Most distros still have older versions. You'll know it's right by
seeing
-
-```bash
-lwsts[4752]: Compiled with OpenSSL support
-lwsts[4752]: Using SSL mode
-lwsts[4752]: HTTP2 / ALPN enabled
```
-
+ lwsts[4752]: Compiled with OpenSSL support
+ lwsts[4752]: Using SSL mode
+ lwsts[4752]: HTTP2 / ALPN enabled
+```
at lws startup.
For non-SSL HTTP2.0 upgrade
-
-```bash
-$ nghttp -nvasu http://localhost:7681/test.htm
```
-
+ $ nghttp -nvasu http://localhost:7681/test.htm
+```
For SSL / ALPN HTTP2.0 upgrade
-
```
-$ nghttp -nvas https://localhost:7681/test.html
+ $ nghttp -nvas https://localhost:7681/test.html
```
-Cross compiling
----------------
+@section cross Cross compiling
+
To enable cross-compiling **libwebsockets** using CMake you need to create
a "Toolchain file" that you supply to CMake when generating your build files.
CMake will then use the cross compilers and build paths specified in this file
you can use as a starting point.
The commandline to configure for cross with this would look like
-
-```bash
-$ cmake .. -DCMAKE_INSTALL_PREFIX:PATH=/usr \
- -DCMAKE_TOOLCHAIN_FILE=../cross-arm-linux-gnueabihf.cmake \
- -DWITHOUT_EXTENSIONS=1 -DWITH_SSL=0
```
-
+ $ cmake .. -DCMAKE_INSTALL_PREFIX:PATH=/usr \
+ -DCMAKE_TOOLCHAIN_FILE=../cross-arm-linux-gnueabihf.cmake \
+ -DLWS_WITHOUT_EXTENSIONS=1 -DLWS_WITH_SSL=0
+```
The example shows how to build with no external cross lib dependencies, you
need to provide the cross libraries otherwise.
Additional information on cross compilation with CMake:
http://www.vtk.org/Wiki/CMake_Cross_Compiling
-Memory efficiency
------------------
+@section mem Memory efficiency
Embedded server-only configuration without extensions (ie, no compression
on websocket connections), but with full v13 websocket features and http
server, built on ARM Cortex-A9:
Update at 8dac94d (2013-02-18)
+```
+ $ ./configure --without-client --without-extensions --disable-debug --without-daemonize
-```bash
-$ ./configure --without-client --without-extensions --disable-debug --without-daemonize
-
-Context Creation, 1024 fd limit[2]: 16720 (includes 12 bytes per fd)
-Per-connection [3]: 72 bytes, +1328 during headers
+ Context Creation, 1024 fd limit[2]: 16720 (includes 12 bytes per fd)
+ Per-connection [3]: 72 bytes, +1328 during headers
-.text .rodata .data .bss
-11512 2784 288 4
+ .text .rodata .data .bss
+ 11512 2784 288 4
```
-
This shows the impact of the major configuration with/without options at
13ba5bbc633ea962d46d using Ubuntu ARM on a PandaBoard ES.
projects / platform / upstream / libwebsockets.git / blobdiff