Revert "simulate memory leak"

This reverts commit db2f4c0.

simulate memory leak

update lrs_options-to-html.py to parse 'mark_as_advanced'

code review changes

revert simulated memory leak

simulate memory leak

avoid error if output file missing

Merge branch 'add_asan_to_CI' of https://github.com/gilpazintel/librealsense into add_asan_to_CI

Author: gilpazintel

.github/workflows/static_analysis.yaml

@@ -128,32 +128,32 @@ jobs:
             sed -i '/add_subdirectory(hello-realsense)/i add_subdirectory(memory-leaks-check)' "$CMAKE_FILE"
           fi
       
-      - name: Build Application with V4L Backend
+      - name: Build Application
         run: |
           mkdir build
           cd build
           cmake .. -DBUILD_EXAMPLES=true
           make -j$(($(nproc)-1))
       
-      - name: Run Valgrind with V4L Backend
+      - name: Run Valgrind
         run: |
           cd build
-          valgrind --leak-check=yes --show-leak-kinds=all --track-origins=yes --log-file=valgrind-V4L-out.txt ./Release/mem-leak-test
+          valgrind --leak-check=yes --show-leak-kinds=all --track-origins=yes --log-file=valgrind-out.txt ./Release/mem-leak-test
         continue-on-error: true
 
-      - name: Upload Valgrind V4L backend log
+      - name: Upload Valgrind log
         uses: actions/upload-artifact@c7d193f32edcb7bfad88892161225aeda64e9392 #v4
         with:
-          name: valgrind-V4L-log
-          path: build/valgrind-V4L-out.txt
+          name: valgrind-log
+          path: build/valgrind-out.txt
 
-      - name: Check Valgrind V4L Results
+      - name: Check Valgrind Results
         run: |
-            if grep -q "ERROR SUMMARY: [^0]" build/valgrind-V4L-out.txt; then
-                echo "Valgrind detected errors with V4L backend."
+            if grep -q "ERROR SUMMARY: [^0]" build/valgrind-out.txt; then
+                echo "Valgrind detected errors with backend."
                 exit 1
             else
-                echo "No errors detected by Valgrind with V4L backend."
+                echo "No errors detected by Valgrind with backend."
             fi
   ASANCheck: 
     name: ASAN Memory Leak Check
@@ -191,28 +191,28 @@ jobs:
         cmake .. -DBUILD_EXAMPLES=true -DBUILD_ASAN=true
         make -j$(($(nproc)-1))
 
-    - name: Run ASAN with V4L2 Backend
+    - name: Run ASAN
       run: |
         cd build
-        ASAN_OPTIONS=halt_on_error=0:detect_leaks=1:log_path=asan-V4L2-out.txt ./Release/mem-leak-test
+        ASAN_OPTIONS=halt_on_error=0:detect_leaks=1:log_path=asan-out.txt ./Release/mem-leak-test
       continue-on-error: true
 
-    - name: Upload ASAN V4L2 backend log
+    - name: Upload ASAN log
       uses: actions/upload-artifact@c7d193f32edcb7bfad88892161225aeda64e9392
       with:
-          name: asan-V4L2-log
-          path: build/asan-V4L2-out.txt*
+          name: asan-log
+          path: build/asan-out.txt*
 
-    - name: Check ASAN V4L Results
+    - name: Check ASAN Results
       run: |
             # Use a wildcard to match the file with any number appended
-            ASAN_FILE=$(ls build/asan-V4L2-out.txt* 2>/dev/null)
+            ASAN_FILE=$(ls build/asan-out.txt* 2>/dev/null || true)
             if [ -n "$ASAN_FILE" ]; then
                 if grep -q "SUMMARY: AddressSanitizer:" "$ASAN_FILE"; then
-                    echo "ASAN detected memory leaks with V4L backend."
+                    echo "ASAN detected memory leaks."
                     exit 1
                 else
-                    echo "No memory leaks detected by ASAN with V4L backend."
+                    echo "No memory leaks detected by ASAN."
                 fi
             else
                 echo "No ASAN output file found. No errors detected."

CMake/lrs_options.cmake

@@ -55,3 +55,5 @@ option(BUILD_WITH_DDS "Access camera devices through DDS topics (requires CMake
 option(BUILD_RS2_ALL "Build realsense2-all static bundle containing all realsense libraries (with BUILD_SHARED_LIBS=OFF)" ON)
 option(ENABLE_SECURITY_FLAGS "Enable additional compiler security flags to enhance the build's security" OFF)
 option(USE_EXTERNAL_LZ4 "Use externally build LZ4 library instead of building and using the in this repo provided version" OFF)
+option(BUILD_ASAN "Enable AddressSanitizer" OFF)
+mark_as_advanced(BUILD_ASAN)

CMakeLists.txt

@@ -4,18 +4,6 @@ cmake_minimum_required(VERSION 3.8)
 set( LRS_TARGET realsense2 )
 project( ${LRS_TARGET} LANGUAGES CXX C )
 
-# Define custom option for ASan
-option(BUILD_ASAN "Enable AddressSanitizer" OFF)
-
-# Conditionally apply ASan flags
-if(BUILD_ASAN)
-  message(STATUS "AddressSanitizer is enabled")
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=address -g")
-  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=address -g")
-  set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fsanitize=address")
-  set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -fsanitize=address")
-endif()
-
 # Allow librealsense2 and all of the nested project to include the main repo folder
 set(REPO_ROOT ${CMAKE_CURRENT_SOURCE_DIR})
 include_directories(${REPO_ROOT})
@@ -63,6 +51,11 @@ global_set_flags()
 add_library(${LRS_TARGET})
 # Apply ASan flags if enabled
 if(BUILD_ASAN)
+  message(STATUS "AddressSanitizer is enabled")
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=address -g")
+  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=address -g")
+  set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fsanitize=address")
+  set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -fsanitize=address")
   target_compile_options(${LRS_TARGET} PRIVATE -fsanitize=address -g)
 endif()
 

scripts/lrs_options-to-html.py

@@ -1,6 +1,5 @@
 import sys
 
-
 def add_style(option, val):
     # colorize ON and OFF keywords
     val = val.replace('ON', '<span style="color: #4CAF50;">ON</span>')
@@ -22,25 +21,32 @@ def add_style(option, val):
 
     return val
 
-
 def add_row(option, description, value):
+    advanced = "YES" if option in advanced_options else "NO"
     if option in table_rows:
         # update value if option exists
         table_rows[option][2] = value
+        table_rows[option][3] = advanced
     else:
         # add to table new option
-        table_rows[option] = [option, description, value]
+        table_rows[option] = [option, description, value, advanced]
 
+def update_advanced_status():
+    for option in table_rows:
+        if option in advanced_options:
+            table_rows[option][3] = "YES"  # Update advanced status to YES
 
 with open('CMake/lrs_options.cmake', 'r') as file:
     lines = file.readlines()
 
 table_rows = {}
+advanced_options = set()
 in_cond = False
 in_elseif = False
 in_else = False
 current_condition = None
 current_comment = ""
+last_option = None  # Track the last option processed
 
 for i, line in enumerate(lines):
     if line.strip().startswith(('option(', 'set(')):
@@ -71,6 +77,7 @@ def add_row(option, description, value):
 
         value = add_style(option, value)
         add_row(option, description, value)
+        last_option = option  # Update the last option processed
     elif line.startswith('if'):
         parts = line.strip().split('(', 1)
         condition = parts[1][:-1]  # remove last ")" - part of the 'if'
@@ -94,19 +101,28 @@ def add_row(option, description, value):
         continue  # ignore internal comments
     elif line.startswith('#'):
         current_comment += line.strip('# \n')
+    elif line.startswith('mark_as_advanced'):
+        parts = line.strip().split('(')
+        option = parts[1].strip(')')  # extract the option name
+        advanced_options.add(option)  # add to advanced options set
+        if last_option:  # Check if last_option is set
+            advanced_options.add(last_option)  # Mark the last option as advanced
     elif line.strip():
         # if we reach a line that doesn't match the pattern, throw an error as it's not handled (shouldn't happen)
         raise Exception(f"{i, line} not handled")
 
+# Update advanced status for all options after processing the file
+update_advanced_status()
 
 def format_dict_values():
     return ''.join(
                     f'\n      <tr>'
                     f'\n\t<td>\n\t  <b><code>{option}</code></b>'f'\n\t</td>'
                     f'\n\t<td>\n\t  {description}\n\t</td>'
                     f'\n\t<td>\n\t  {value}\n\t</td>'
+                    f'\n\t<td>\n\t  <span style="color: {"#4CAF50" if advanced == "YES" else "#E74C3C"};">{advanced}</span>\n\t</td>'
                     f'\n      </tr>'
-                    for option, description, value in table_rows.values())
+                    for option, description, value, advanced in table_rows.values())
 
 def get_sdk_version():
     if len(sys.argv) > 1:
@@ -117,7 +133,6 @@ def get_sdk_version():
         # if no parameter provided - no version number will be included
         return ""
 
-
 html = f'''<!DOCTYPE html>
 <html>
 <head>
@@ -131,9 +146,10 @@ def get_sdk_version():
     <h2>{get_sdk_version()}</h2>
     <table>
       <tr>
-        <th style="width: 30%">Option</th>
-        <th style="width: 55%">Description</th>
+        <th style="width: 25%">Option</th>
+        <th style="width: 45%">Description</th>
         <th style="width: 15%">Default</th>
+        <th style="width: 15%">Advanced</th>
       </tr>{format_dict_values()}
     </table>
   </div>
@@ -143,4 +159,4 @@ def get_sdk_version():
 
 with open('doc/build-flags.html', 'w') as file:
     file.write(html)
-    print("build-flags.html generated")
+    print("build-flags.html generated")