aboutsummaryrefslogtreecommitdiffstats
path: root/src/CMakeLists.txt
blob: 962b41b7cd520cb519500486a6194b5b7c443dee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
###########################################################################
# Copyright 2016 IoT.bzh
#
# author: José Bollo <jose.bollo@iot.bzh>
# author: Stéphane Desneux <stephane.desneux@iot.bzh>
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
###########################################################################

include(GNUInstallDirs)

set(TARGET "root@192.168.1.206")
set(PROJECT_VERSION "0.1")
set(PROJECT_ICON "icon.png")
set(PROJECT_LIBDIR "libs")

set(CMAKE_BUILD_TYPE Debug)

###########################################################################

link_libraries(-Wl,--as-needed -Wl,--gc-sections)

add_compile_options(-Wall -Wextra -Wconversion)
add_compile_options(-Wno-unused-parameter) # frankly not using a parameter does it care?
add_compile_options(-Werror=maybe-uninitialized)
add_compile_options(-Werror=implicit-function-declaration)
add_compile_options(-ffunction-sections -fdata-sections)
add_compile_options(-Wl,--as-needed -Wl,--gc-sections)
add_compile_options(-fPIC)
add_compile_options(-D_REENTRANT)

set(CMAKE_C_FLAGS_PROFILING    "-g -O0 -pg -Wp,-U_FORTIFY_SOURCE")
set(CMAKE_C_FLAGS_DEBUG        "-g -O0 -ggdb -Wp,-U_FORTIFY_SOURCE")
set(CMAKE_C_FLAGS_RELEASE      "-g -O0 -Wall -Werror")
set(CMAKE_C_FLAGS_CCOV         "-g -O0 --coverage")

set(CMAKE_CXX_FLAGS_PROFILING    "-g -O0 -std=c++11 -pg -Wp,-U_FORTIFY_SOURCE")
set(CMAKE_CXX_FLAGS_DEBUG        "-g -O0 -std=c++11 -ggdb -Wp,-U_FORTIFY_SOURCE")
set(CMAKE_CXX_FLAGS_RELEASE      "-g -O2 -std=c++11")
set(CMAKE_CXX_FLAGS_CCOV         "-g -O2 -std=c++11 --coverage")

###########################################################################

include(FindPkgConfig)

pkg_check_modules(EXTRAS REQUIRED json-c libsystemd afb-daemon)
add_compile_options(${EXTRAS_CFLAGS})
add_compile_options(${EXTRAS_CXXFLAGS})

# Needed to compile openxc-message-format library.
#
# The reason you need to do this is that some of your messages contain tag
# numbers or field sizes that are larger than what can fit in the default
# 8 bit descriptors.
add_definitions(-DPB_FIELD_16BIT)

# Needed extra directories to hit the required headers files.
include_directories(${EXTRAS_INCLUDE_DIRS} ${PROJECT_SOURCE_DIR} ${PROJECT_LIBDIR}/openxc-message-format/gen/cpp ${PROJECT_LIBDIR}/nanopb/  ${PROJECT_LIBDIR}/uds-c/src  ${PROJECT_LIBDIR}/bitfield-c/src ${PROJECT_LIBDIR}/isotp-c/src)
link_libraries(${EXTRAS_LIBRARIES})
###########################################################################
# the library used by the binding : openxc, bitfield, uds, isotp

add_library(bitfield STATIC ${PROJECT_LIBDIR}/bitfield-c/src/bitfield/8byte.c ${PROJECT_LIBDIR}/bitfield-c/src/bitfield/bitarray.c ${PROJECT_LIBDIR}/bitfield-c/src/bitfield/bitfield.c ${PROJECT_LIBDIR}/bitfield-c/src/canutil/read.c ${PROJECT_LIBDIR}/bitfield-c/src/canutil/write.c)
add_library(isotp STATIC ${PROJECT_LIBDIR}/isotp-c/src/isotp/isotp.c ${PROJECT_LIBDIR}/isotp-c/src/isotp/receive.c ${PROJECT_LIBDIR}/isotp-c/src/isotp/send.c)
add_library(uds STATIC ${PROJECT_LIBDIR}/uds-c/src/uds/extras.c ${PROJECT_LIBDIR}/uds-c/src/uds/uds.c)
add_library(openxc STATIC ${PROJECT_LIBDIR}/openxc-message-format/gen/cpp/openxc.pb.c ${PROJECT_LIBDIR}/nanopb/pb_encode.c ${PROJECT_LIBDIR}/nanopb/pb_decode.c ${PROJECT_LIBDIR}/nanopb/pb_common.c)
###########################################################################
# the binding for afb

message(STATUS "Creation of ${PROJECT_NAME} binding for AFB-DAEMON")
###########################################################################
add_library(${PROJECT_NAME} MODULE ${PROJECT_NAME}.cpp configuration.cpp configuration-generated.cpp
	can/can-bus.cpp can/can-bus-dev.cpp can/can-message-set.cpp can/can-message-definition.cpp can/can-message.cpp can/can-signals.cpp can/can-decoder.cpp
	obd2/obd2-signals.cpp obd2/diagnostic-manager.cpp obd2/active-diagnostic-request.cpp
	utils/signals.cpp utils/openxc-utils.cpp utils/timer.cpp utils/socket.cpp)
target_link_libraries(${PROJECT_NAME} pthread bitfield uds isotp openxc)

set_target_properties(${PROJECT_NAME} PROPERTIES
	PREFIX ""
	LINK_FLAGS "-Wl,--version-script=${CMAKE_CURRENT_SOURCE_DIR}/export.map"
)

###########################################################################
# WGT packaging

message(STATUS "Creation of ${PROJECT_NAME}.wgt package for AppFW")
###########################################################################
configure_file(config.xml.in config.xml)
configure_file(can_buses.json.in can_buses.json)

add_custom_command(
	OUTPUT ${PROJECT_NAME}.wgt
	DEPENDS ${PROJECT_NAME} bitfield isotp uds openxc config.xml.in can_buses.json.in
	COMMAND rm -rf package
	COMMAND mkdir -p package/${PROJECT_LIBDIR} package/htdocs package/etc
	COMMAND cp config.xml package/
	COMMAND cp can_buses.json package/etc
	COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT_ICON} package/icon.png
	COMMAND cp ${PROJECT_NAME}.so package/libs
	COMMAND wgtpkg-pack -f -o ${PROJECT_NAME}.wgt package
)
add_custom_target(widget ALL DEPENDS ${PROJECT_NAME}.wgt)

###########################################################################
# WGT install

#message(STATUS "Creation of ${PROJECT_NAME}.wgt package for AppFW")
###########################################################################
install(CODE "execute_process(
	COMMAND scp -r ${CMAKE_SOURCE_DIR} src/${PROJECT_NAME}.wgt ${TARGET}:/tmp
	COMMAND ssh ${TARGET} \"/usr/bin/afm-util remove ${PROJECT_NAME}@${PROJECT_VERSION} && /usr/bin/afm-util install /tmp/${PROJECT_NAME}.wgt\")"
	)
LL_PREFIX}/lib/pkgconfig) set(LD_LIBRARY_PATH ${CMAKE_INSTALL_PREFIX}/lib64 ${CMAKE_INSTALL_PREFIX}/lib) ``` ```bash mkdir -p build cd build cmake -DCMAKE_INSTALL_PREFIX=$INSTALL_PREFIX .. make # Note: 1) Controller is now a standalone project and should added on top of project bindings 2) If you want monitoring add '--alias=/monitoring:$HOME/opt/afb-monitoring' (should point to monitoring HTML5 pages) 3) To expose AAAA control interface add '--ws-server=unix:/var/tmp/afb-ws/ctl-aaaa' afb-daemon --workdir=. --ldpaths=. --binding=../../afb-controller/build/afb-source/afb-control-afb.so --port=1234 --roothttp=../htdocs --token="" --verbose Warning: See below net on GDB requiring (--workdir=.) ``` # Note: GDB Source Debug limits/features Warning: technically AGL bindings are shared libraries loaded thought 'dlopen'. GDB supports source debug of dynamically loaded libraries, but user should be warn that the actual path to sharelib symbols is directly inherited from DLOPEN. As a result if you change your directory after binder start with --workdir=xxx then GDB will stop working. Conclusion: double-check that --workdir=. and run debug session from ./build directory. Any IDEs like Netbeans or VisualCode should work out of the box. ```bash Examples: # WORK when running in direct afb-daemon --workdir=.. --ldpaths=build --port=1234 --roothttp=./htdocs # FAIL when using GDB with warning: Could not load shared library .... gdb -args afb-daemon --workdir=.. --ldpaths=build --port=1234 --roothttp=./htdocs ... warning: Could not load shared library symbols for ./build/ucs2-afb/afb-ucs2.so. Do you need "set solib-search-path" or "set sysroot"? ... ``` To debug sharelib symbol path: start your binder under GDB. Then break your session after the binder has loaded its bindings. Finally use "info sharedlibrary" and check 'SymsRead'. If equal to 'No' then either you start GDB from the wrong relative directory, either you have to use 'set solib-search-path' to force the path. ```bash gdb -args afb-daemon --workdir=.. --ldpaths=build --port=1234 --roothttp=./htdocs run ... NOTICE: API UNICENS added NOTICE: Waiting port=1234 rootdir=. NOTICE: Browser URL= http://localhost:1234 (hit Ctrl-C to break the execution) info sharedlibrary afb-* ``` # Running an debugging on a target ```bash export RSYNC_TARGET=root@xx.xx.xx.xx export RSYNC_PREFIX=/opt # WARNING: installation directory should exist mkdir $RSYNC_TARGET cd $RSYNC_TARGET cmake -DRSYNC_TARGET=$RSYNC_TARGET -DRSYNC_PREFIX=$RSYNC_PREFIX .. make remote-target-populate ./build/target/start-${RSYNC_TARGET}.sh firefox http://localhost:1234 # WARNING: do not forget firewall if any ssh -tt ${RSYNC_TARGET} speaker-test -twav -D hw:ep01 -c 2 ``` Note: remote-target-populate will * create a script to remotely start the binder on the target in ./build/target/start-on-target-name.sh * create a gdbinit file to transparently debug remotely in source code with gdb -x ./build/target/gdb-on-target-name.ini * to run and debug directly from your IDE just configure the run and debug properties with the corresponding filename * run a generic control and pass virtual channel as a parameter (check remaning PCM in plugin) Note that Netbeans impose to set debug directory to ./build/pkgout or it won't find binding symbols for source debugging # <a name="Build"></a> Building AFB-daemon from source on Standard Linux Distribution ## Handle dependencies using packager > (OpenSuse-42.2, Fedora-25, Ubuntu 16.04.2LTS) Using system package repositories: * gcc > 4.8 * systemd-devel (libsystemd-dev>=222) * libuuid-devel (OpenSuse) or uuid-dev (Ubuntu) * file-devel(OpenSuSe) or libmagic-dev(Ubuntu) * libjson-c-devel * ElectricFence (BUG should not be mandatory) * libopenssl-devel libgcrypt-devel libgnutls-devel (optional but requested by libmicrohttpd for https) Using [AGL repositories](https://en.opensuse.org/LinuxAutomotive): * libmicrohttpd>=0.9.55 (as today OpenSuse-42.2, 42.3 or Ubuntu-16.4 ship older versions) * afb-daemon from AGL Gerrit ```git clone https://gerrit.automotivelinux.org/gerrit/src/app-framework-binder``` OpenSuse >= 42.2: ```bash export DISTRO="openSUSE_Leap_42.2" sudo zypper ar http://download.opensuse.org/repositories/isv:/LinuxAutomotive:/app-Framework/${DISTRO}/isv:LinuxAutomotive:app-Framework.repo sudo zypper ref #For openSUSE_Leap_42.2 gcc config sudo zypper install agl-gcc5-setup #For openSUSE_Leap_42.3 gcc config #sudo zypper install agl-gcc6-setup #Install application framework sudo zypper install agl-app-framework-binder # Other needed system devel packages: zypper in gcc5 gdb gcc5-c++ git cmake make ElectricFence systemd-devel libopenssl-devel libuuid-devel alsa-devel libgcrypt-devel libgnutls-devel libjson-c-devel file-devel mxml-devel ``` Fedora >= 26: ```bash export DISTRO="Fedora_26" sudo dnf config-manager --add-repo http://download.opensuse.org/repositories/isv:/LinuxAutomotive:/app-Framework/${DISTRO}/isv:LinuxAutomotive:app-Framework.repo #Install application framework sudo zypper install agl-app-framework-binder # Other needed system devel packages: dnf install gdb git cmake make ElectricFence systemd-devel libopenssl-devel libuuid-devel alsa-devel libgcrypt-devel libgnutls-devel libjson-c-devel file-devel mxml-devel ``` Ubuntu >= 16.4: ```bash export DISTRO="xUbuntu_16.04" wget -O - http://download.opensuse.org/repositories/isv:/LinuxAutomotive:/app-Framework/${DISTRO}/Release.key | sudo apt-key add - sudo bash -c "cat >> /etc/apt/sources.list.d/AGL.list <<EOF #AGL deb http://download.opensuse.org/repositories/isv:/LinuxAutomotive:/app-Framework/${DISTRO}/ ./ EOF" sudo apt-get update #Install application framework sudo apt-get install agl-app-framework-binder # Or for Ubuntu 17.04 #sudo apt-get install agl-app-framework-binder-bin #sudo apt-get install agl-app-framework-binder-dev # Other needed system devel packages: apt-get install cmake git electric-fence libsystemd-dev libssl-dev uuid-dev libasound2-dev libgcrypt20-dev libgnutls-dev libgnutls-dev libjson-c-dev libmagic-dev libmxml-dev ``` You might want to add following variables into ~/.bashrc: ```bash echo "#---------- AGL options Start ---------" >>~/.bashrc echo "# Object: AGL cmake option for binder/bindings" >>~/.bashrc echo "# Date: `date`" >>~/.bashrc echo 'export CC=gcc-5; export CXX=g++-5' >>~/.bashrc # if using gcc5 echo 'export INSTALL_PREFIX=$HOME/opt' >>~/.bashrc echo 'export LD_LIBRARY_PATH=$INSTALL_PREFIX/lib64:$INSTALL_PREFIX/lib' >>~/.bashrc echo 'export LIBRARY_PATH=$INSTALL_PREFIX/lib64:$INSTALL_PREFIX/lib' >>~/.bashrc echo 'export PKG_CONFIG_PATH=$INSTALL_PREFIX/lib64/pkgconfig:$INSTALL_PREFIX/lib/pkgconfig' >>~/.bashrc echo 'export PATH=$INSTALL_PREFIX/bin:$PATH' >>~/.bashrc echo 'export RSYNC_TARGET=MY_TARGET_HOSTNAME' >>~/.bashrc echo 'export RSYNC_PREFIX=./opt' >>~/.bashrc echo "#---------- AGL options End ---------" >>~/.bashrc source ~/.bashrc ``` ## Handle dependencies from sources Install devel packages from your system official repositories and use the following instructions to install `libmicrohttpd` and `app-framework-binder`: ```bash # install LibMicroHttpd LIB_MH_VERSION=0.9.55 wget https://ftp.gnu.org/gnu/libmicrohttpd/libmicrohttpd-${LIB_MH_VERSION}.tar.gz tar -xzf libmicrohttpd-${LIB_MH_VERSION}.tar.gz cd libmicrohttpd-${LIB_MH_VERSION} ./configure --prefix=${INSTALL_PREFIX} make sudo make install-strip # retrieve last AFB_daemon from AGL git clone https://gerrit.automotivelinux.org/gerrit/src/app-framework-binder # Warning: previous GCC options should be set before initial cmake (clean Build/*) cd app-framework-binder; mkdir -p build; cd build cmake -DCMAKE_INSTALL_PREFIX=$INSTALL_PREFIX .. make make install ```