Bpf demo (#96)

* eBPF based process and syscall monitoring example
* Build script improved for more control over what is build
* Fixed DAQ event macros: Trigger DAQ event on first call
* Removed hack for rust version which detects unused calibration segment management and then use the callbacks
* Option to completely disable calibration segment management

Author: RainerZ

.gitignore

@@ -2,14 +2,6 @@
 /build
 /build-*
 
-# vscode
-/DEBUGGING_SETUP.md
-/.vscode/c_cpp_properties.json
-
-# doxygen
-/docs/html
-/Doxyfile.bak
-
 
 # CANape artefacts
 *.hex 
@@ -18,25 +10,16 @@
 *.tmp
 
 # Examples A2L files
-/*.a2l
-/*.bin
-/c_demo.a2l
-/cpp_demo.a2l
-/hello_xcp.a2l
-/struct_demo.a2l
-/multi_thread_demo.a2l
+*.a2l
+*.bin
 
 # Temporary files
-/conversions.a2l
-/groups.a2l
-/typedefs.a2l
+conversions.a2l
+groups.a2l
+typedefs.a2l
+*.bak
 
 
-/a2l_test.a2l
-/DOCUMENTATION.md
-/pi5
-/pi5.pub
-/setup_remote_pi.sh
-/sync.sh
-*.out
-/REMOTE_DEVELOPMENT.md
+/run_remote.sh
+/run.sh
+/examples/bpf_demo/CANape/CANapeTmpMea.ini

.vscode/launch.json

@@ -115,7 +115,7 @@
                 "debuggerPath": "/usr/bin/gdb",
                 "pipeProgram": "ssh",
                 "pipeArgs": [
-                    "[email protected].205"
+                    "[email protected].206"
                 ],
                 "pipeCwd": ""
             },
@@ -143,7 +143,7 @@
                 "debuggerPath": "/usr/bin/gdb",
                 "pipeProgram": "ssh",
                 "pipeArgs": [
-                    "[email protected].205"
+                    "[email protected].206"
                 ],
                 "pipeCwd": ""
             },

.vscode/tasks.json

@@ -13,7 +13,7 @@
                 "--exclude=\"*.out\"",
                 "--exclude=\"*.a\"",
                 "./",
-                "[email protected].205:~/XCPlite-RainerZ/"
+                "[email protected].206:~/XCPlite-RainerZ/"
             ],
             "options": {
                 "cwd": "${workspaceFolder}"
@@ -28,7 +28,7 @@
                 "focus": false,
                 "panel": "shared"
             },
-            "detail": "rsync to Raspberry Pi [email protected].205:~/XCPlite-RainerZ/"
+            "detail": "rsync to Raspberry Pi [email protected].206:~/XCPlite-RainerZ/"
         },
         {
             "type": "shell",
@@ -47,7 +47,7 @@
                 "focus": false,
                 "panel": "shared"
             },
-            "detail": "Call ./sync.sh - rsync to Raspberry Pi [email protected].205:~/XCPlite-RainerZ/"
+            "detail": "Call ./sync.sh - rsync to Raspberry Pi [email protected].206:~/XCPlite-RainerZ/"
         },
         {
             "type": "cppbuild",
@@ -235,7 +235,7 @@
             "label": "XCPlite: Remote configure CMake on Pi",
             "command": "ssh",
             "args": [
-                "[email protected].205",
+                "[email protected].206",
                 "cd ~/XCPlite-RainerZ && cmake -B build -S . -DCMAKE_BUILD_TYPE=Debug"
             ],
             "group": "build",
@@ -247,7 +247,7 @@
             "label": "XCPlite: Remote build hello_xcp on Pi",
             "command": "ssh",
             "args": [
-                "[email protected].205",
+                "[email protected].206",
                 "cd ~/XCPlite-RainerZ && cmake --build build --target hello_xcp"
             ],
             "group": {
@@ -265,7 +265,7 @@
             "label": "XCPlite: Remote build cpp_demo on Pi",
             "command": "ssh",
             "args": [
-                "[email protected].205",
+                "[email protected].206",
                 "cd ~/XCPlite-RainerZ && cmake --build build --target cpp_demo"
             ],
             "group": {
@@ -283,7 +283,7 @@
             "label": "XCPlite: Remote build all on Pi",
             "command": "ssh",
             "args": [
-                "[email protected].205",
+                "[email protected].206",
                 "cd ~/XCPlite-RainerZ && cmake --build build"
             ],
             "group": {
@@ -301,7 +301,7 @@
             "label": "XCPlite: Remote kill XCP processes on Pi",
             "command": "ssh",
             "args": [
-                "[email protected].205",
+                "[email protected].206",
                 "pkill -f 'hello_xcp\\|cpp_demo\\|c_demo\\|multi_thread_demo' || true"
             ],
             "group": "build",

CMakeLists.txt

@@ -146,6 +146,11 @@ add_executable(c_demo ${c_demo_SOURCES})
 target_include_directories(c_demo PUBLIC "${PROJECT_ROOT}/inc")
 target_link_libraries(c_demo PRIVATE xcplib)
 
+# Example cpp_demo
+add_executable(cpp_demo examples/cpp_demo/src/main.cpp examples/cpp_demo/src/sig_gen.cpp examples/cpp_demo/src/lookup.cpp)
+target_include_directories(cpp_demo PUBLIC "${PROJECT_ROOT}/inc")
+target_link_libraries(cpp_demo PRIVATE xcplib)
+
 # Example struct_demo
 set(struct_demo_SOURCES examples/struct_demo/src/main.c)
 set_source_files_properties(${struct_demo_SOURCES} PROPERTIES LANGUAGE C)
@@ -160,11 +165,23 @@ add_executable(multi_thread_demo ${multi_thread_demo_SOURCES})
 target_include_directories(multi_thread_demo PUBLIC "${PROJECT_ROOT}/inc")
 target_link_libraries(multi_thread_demo PRIVATE xcplib)
 
-# Example cpp_demo
-add_executable(cpp_demo examples/cpp_demo/src/main.cpp examples/cpp_demo/src/sig_gen.cpp examples/cpp_demo/src/lookup.cpp)
-target_include_directories(cpp_demo PUBLIC "${PROJECT_ROOT}/inc")
-target_link_libraries(cpp_demo PRIVATE xcplib)
-
+# Example bpf_demo
+set(bpf_demo_SOURCES examples/bpf_demo/src/main.c)   
+set_source_files_properties(${bpf_demo_SOURCES} PROPERTIES LANGUAGE C)
+add_executable(bpf_demo ${bpf_demo_SOURCES})
+target_include_directories(bpf_demo PUBLIC "${PROJECT_ROOT}/inc")
+target_link_libraries(bpf_demo PRIVATE xcplib)
+
+# Add libbpf dependency for Linux builds
+if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
+    find_library(LIBBPF_LIBRARY bpf)
+    if(LIBBPF_LIBRARY)
+        target_link_libraries(bpf_demo PRIVATE ${LIBBPF_LIBRARY})
+        message(STATUS "Found libbpf: ${LIBBPF_LIBRARY}")
+    else()
+        message(WARNING "libbpf not found. BPF functionality will be disabled.")
+    endif()
+endif()
 
 # Tests
 if(BUILD_TEST)
@@ -201,12 +218,13 @@ else()
     target_link_libraries(hello_xcp_cpp PRIVATE m)
 
     # Set .out suffix for executables on non-Windows platforms
-    set_target_properties(c_demo PROPERTIES SUFFIX ".out")
     set_target_properties(hello_xcp PROPERTIES SUFFIX ".out")
+    set_target_properties(hello_xcp_cpp PROPERTIES SUFFIX ".out")
+    set_target_properties(c_demo PROPERTIES SUFFIX ".out")
+    set_target_properties(cpp_demo PROPERTIES SUFFIX ".out")
     set_target_properties(struct_demo PROPERTIES SUFFIX ".out")
     set_target_properties(multi_thread_demo PROPERTIES SUFFIX ".out")
-    set_target_properties(cpp_demo PROPERTIES SUFFIX ".out")
-    set_target_properties(hello_xcp_cpp PROPERTIES SUFFIX ".out")
+    set_target_properties(bpf_demo PROPERTIES SUFFIX ".out")
 
     if(BUILD_TEST)
         set_target_properties(type_detection_test_c PROPERTIES SUFFIX ".out")

README.md

@@ -7,8 +7,11 @@ XCP is a measurement and calibration protocol commonly used in the automotive in
 It provides real time signal oriented data acquisition (measurement, logging) and modification of parameter constants (calibration) in a target micro controller system (ECU), to help observing and optimizing cyber physical control algorithms in real time.  
 
 Timestamped events, measurement variables and parameter constants are described by an ASAM-A2L description file, another associated ASAM standard. A2L is a human readable ASCII format.  
-Data objects are identified by address. In a micro controller system programmed in C or C++, these addresses are used to directly access the ECUs memory. This concept has minimum impact on the target system in terms of memory consumption, runtime and needs minimum code instrumentation. The A2l is a kind of annotated ELF Linker-Address-Map, with meta information on data instances and data types (MC specific types - lookup-tables, axis scaling, physical limits and units, conversion rules, ...).  
-In a Microprocessor system developed in a system programming language like C, C++ or Rust, this concept is still usefull and efficient. Measurement signals and calibration parameters must have a static lifetime and a defined memory layout, but no predefined memory location and no static storage class. Data acquisition and modification is achieved by appropriate code instrumentation for measurement and wrapper types for groups of calibration parameters.
+In a micro controller system programmed in C or C++, measurement data items are directly accessed in their original memory locations. This concept has minimum impact on the target system in terms of memory consumption, runtime and needs minimum code instrumentation. The A2l is a kind of annotated ELF Linker-Address-Map, with meta information on data instances and data types (MC specific types - lookup-tables, axis scaling, physical limits and units, conversion rules, ...).  
+
+In a Microprocessor system developed in a system programming language like C, C++ or Rust, this concept is still useful and efficient. Measurement signals and calibration parameters usually have a static lifetime and a defined memory layout, but no predefined memory location and are not limited to static storage classes. Data acquisition and modification is achieved by appropriate code instrumentation for measurement and wrapper types for groups of calibration parameters.
+
+From a software developer perspective, XCP may be considered to be a high-frequency application level tracing solution, using statically instrumented trace points with configurable associated data. Tracing can be started, stopped and reconfigured during runtime. What is not configured, does not consume bandwidth, memory and other resources. The acquired context data is always consistent and trace events are precisely time stamped. Data types and instances of available context data items are defined as code or obtained by a XCP tool from ELF/DWARF debug information. Data instances may be in global, local, thread local and heap storage locations. In addition to that, XCP provides the capability to modify application variables and state in a thread safe and consistent way.  
 
 The ASAM-XCP standard defines a protocol and a transport layer. There are transport layers for all common communication busses used in the automotive industry, such as CAN, CAN-FD, FLEXRAY, SPI and Ethernet.  
 
@@ -23,10 +26,10 @@ Visit the Virtual VectorAcademy for an E-Learning on XCP:
 
 XCPlite is an implementation of XCP for Microprocessors in pure C, optimized for the XCP on Ethernet Transport Layer for TCP or UDP with jumbo frames.  
 It is optimized for 64 Bit platforms with POSIX based Operating Systems, but also runs on 32 Bit platforms and on Windows with some restrictions.  
-The A2L measurement and calibration object database can be generated during runtime and uploaded by the XCP client on connect.  
+The A2L measurement and calibration object database can be generated during runtime and uploaded by the XCP client tool on connect.  
 
 XCPlite is provided to test and demonstrate calibration tools such as CANape or any other XCP client implementation.  
-It may serve as a base for individually customized XCP implementations on Microprocessors.  
+It may serve as a base for individually customized XCP on Ethernet implementations on Microprocessors.  
 It implements and demonstrates some techniques how to deal with variables in dynamically allocated memory and how to do measurement and calibration in multi-threaded applications.  
 
 XCPlite is used as a C library by the implementation of XCP for Rust in:  
@@ -82,13 +85,12 @@ There is a CANape project for each example in a directory folder "examples/<Exam
 To load a project into CANape, select load project and navigate to the CANape.ini file in this folder.  
 All CANape project examples are configured to upload the A2L file via XCP. The IP address of the XCP server is stored in the A2L file uploaded last time. If CANape can not connect, check that the correct IP address is configured in "Device Configuration/Devices/<DeviceName>/Protocol/Transport Layer".  
 
-The examples should run with a CANape demo version, which can be downloaded from https://www.vector.com/de/de/support-downloads/download-center. 
+The examples should run with a CANape demo version, which can be downloaded from <https://www.vector.com/de/de/support-downloads/download-center>.
 The demo installation must be explicitly enabled in the installer and has some limitations:  
 It will store only the first seconds of measurement data and the number of measurement signals is limited.
 
 Note: Some of the examples use display windows without title bars to make it look cleaner. This option can be turned of with "Options/Display/View/Display Headline".  
 
-
 ### Example Details
 
 hello_xcp:  
@@ -135,6 +137,13 @@ cpp_demo:
   Demonstrates measurement of member variables and stack variables in class instance member functions.  
   Shows how to create a class with calibration parameters as member variables.  
 
+threadx_demo:
+  Planned
+  
+bpf_demo:
+  Experimental, work in progress.  
+  Demonstrates tracing of process creations and selected syscalls.  
+  
 ![CANape Screenshot](examples/cpp_demo/cpp_demo.png)
 
 ### Building a CANape project and configuration from scratch