Skip to content

Latest commit

 

History

History
87 lines (69 loc) · 4.9 KB

dlt_build_options.md

File metadata and controls

87 lines (69 loc) · 4.9 KB
Raw

DLT Build Options

DLT is highly configurable. It allows you to choose between certain technologies or implementations and to turn on or off certain features. This way, you can adjust it to your needs and keep the build process as simple as possible.

In order to change these options, you can modify these values with cmake, do the appropriate changes in CmakeList.txt or via the commandline for cmake

Change a value with: cmake -D<Variable>=<Value>, E.g.

cmake .. -DWITH_SYSTEMD=ON -DWITH_SYSTEMD_JOURNAL=ON -DCMAKE_INSTALL_PREFIX=/usr

General Options

Option Value Comment
BUILD_SHARED_LIBS ON Set to OFF to build static libraries
DLT_IPC "FIFO" Set to either "UNIX_SOCKET" or "FIFO"
WITH_DLT_USE_IPv6 ON Set to ON for IPv6 support
WITH_DLT_EXAMPLES ON Set to ON to build src/examples binaries
DLT_USER covesa Set user for process not run as root
WITH_CHECK_CONFIG_FILE OFF Set to ON to create a configure file of CheckIncludeFiles and CheckFunctionExists
CMAKE_INSTALL_PREFIX /usr/local
CMAKE_BUILD_TYPE RelWithDebInfo
WITH_UDP_CONNECTION OFF Set to ON to enable dlt UDP multicast SUPPORT
WITH_DLT_DAEMON_VSOCK_IPC OFF Set to ON for VSOCK support in daemon.
WITH_DLT_LIB_VSOCK_IPC OFF Set to ON for VSOCK support in libdlt (DLT_IPC is overridden in libdlt).
DLT_VSOCK_PORT 13490 Port to use for VSOCK communication.
WITH_LEGACY_INCLUDE_PATH ON Set to ON to add /dlt to include paths for the CMake config file, in addition to only
WITH_DLT_LOG_LEVEL_APP_CONFIG OFF Set to ON to enable default log levels based on application ids

Command Line Tool Options

Option Value Comment
WITH_DLT_ADAPTOR OFF Set to ON to build src/adaptor binaries
WITH_DLT_CONSOLE ON Set to ON to build src/console binaries
WITH_DLT_SYSTEM OFF Set to ON to build src/system binaries
WITH_DLT_LOGSTORAGE_CTRL_UDEV OFF PROTOTYPE! Set to ON to build
WITH_DLT_KPI OFF Set to ON to build src/kpi binaries
WITH_EXTENDED_FILTERING OFF Set to OFF to build without extended filtering. Using json filter files is only supported for Linux based system with json-c and QNX.

Linux OS Integration Options

Option Value Comment
WITH_SYSTEMD OFF Set to ON to run CMakeLists.txt in systemd
WITH_SYSTEMD_WATCHDOG OFF Set to ON to use the systemd watchdog in dlt-daemon
WITH_SYSTEMD_WATCHDOG_ENFORCE_MSG_RX OFF Set to ON to notify the watchdog only if new messages where received in dlt-daemon since last notify
WITH_SYSTEMD_WATCHDOG_ENFORCE_MSG_RX_DLT_SYSTEM OFF Set to ON to notify the watchdog only if new messages where received in dlt-system since last notify
WITH_SYSTEMD_JOURNAL OFF Set to ON to use the systemd journal in dlt-system
WITH_DLT_DBUS OFF Set to ON to build src/dbus binaries

QNX OS Integration Options

Option Value Comment
WITH_DLT_QNX_SYSTEM OFF Set to ON to build QNX system binary dlt-qnx-system
DLT_QNX_SLOG_ADAPTER_WAIT_BUFFER_TIMEOUT_MS 100 Maximum time in milliseconds to wait for buffer space in dlt before messages from the slog will be discarded.

Documentation Options

Option Value Comment
WITH_DOC OFF Set to ON to build API documentation
WITH_MAN OFF Set to ON to build man pages

Test Options

Option Value Comment
WITH_TESTSCRIPTS OFF Set to ON to run CMakeLists.txt in test scripts
WITH_DLT_TESTS ON Set to ON to build src/test binaries
WITH_DLTTEST OFF Set to ON to build with modifications to test User-Daemon communication with corrupt messages
WITH_DLT_UNIT_TESTS OFF Set to ON to build unit test binaries
WITH_GPROF OFF Set -pg to compile flag

Experimental Features Options (Dragons ahead!)

Option Value Comment
WITH_DLT_SHM_ENABLE OFF Set to ON to enable shared memory as IPC
WITH_DLT_CXX11_EXT OFF Set to ON to build C++11 extensions
WITH_DLT_COREDUMPHANDLER OFF Set to ON to build src/core_dump_handler binaries.