[lldb/API] Use a valid LineEntry object in SBCompileUnit::FindLineEntryIndex

[mib]

Summary

This patch updates SBCompileUnit::FindLineEntryIndex to pass a valid
LineEntry pointer to CompileUnit::FindLineEntry.

This caused LineTable::FindLineEntryIndexByFileIndexImpl to return its
best_match initial value (UINT32_MAX).

rdar://78115426

Signed-off-by: Med Ismail Bennani <[e-mail]>

[JDevlieghere]

LGTM

[mib]

Add test.

lldb/source/API/SBCompileUnit.cpp

 //===-- SBCompileUnit.cpp -------------------------------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #include "lldb/API/SBCompileUnit.h"
 #include "SBReproducerPrivate.h"
 #include "lldb/API/SBLineEntry.h"
 #include "lldb/API/SBStream.h"
 #include "lldb/Core/Module.h"
 #include "lldb/Symbol/CompileUnit.h"
 #include "lldb/Symbol/LineEntry.h"
 #include "lldb/Symbol/LineTable.h"
 #include "lldb/Symbol/SymbolFile.h"
uint32_t SBCompileUnit::FindLineEntryIndex(uint32_t start_idx, uint32_t line,
   uint32_t index = UINT32_MAX;
   if (m_opaque_ptr) {
     FileSpec file_spec;
     if (inline_file_spec && inline_file_spec->IsValid())
       file_spec = inline_file_spec->ref();
     else
       file_spec = m_opaque_ptr->GetPrimaryFile();
 
+    LineEntry line_entry;
     index = m_opaque_ptr->FindLineEntry(
         start_idx, line, inline_file_spec ? inline_file_spec->get() : nullptr,
-        exact, nullptr);
+        exact, &line_entry);
   }
 
   return index;
 }
 
 uint32_t SBCompileUnit::GetNumSupportFiles() const {
   LLDB_RECORD_METHOD_CONST_NO_ARGS(uint32_t, SBCompileUnit, GetNumSupportFiles);
 

lldb/test/API/functionalities/find-line-entry/Makefile

+C_SOURCES := main.c
+CFLAGS_EXTRAS := -std=c99
+
+include Makefile.rules

lldb/test/API/functionalities/find-line-entry/TestFindLineEntry.py

+"""
+Test that SBCompileUnit::FindLineEntryIndex works correctly.
+"""
+
+import lldb
+import lldbsuite.test.lldbutil as lldbutil
+from lldbsuite.test.lldbtest import *
+
+class FindLineEntry(TestBase):
+
+    mydir = TestBase.compute_mydir(__file__)
+
+    def test_compile_unit_find_line_entry_index(self):
+        """ Test the CompileUnit LineEntryIndex lookup API """
+        self.build()
+        exe = self.getBuildArtifact("a.out")
+        self.target = self.dbg.CreateTarget(exe)
+        self.assertTrue(self.target.IsValid(), "Target is not valid")
+
+        self.file = lldb.SBFileSpec("main.c")
+        sc_list = self.target.FindCompileUnits(self.file)
+        self.assertEqual(len(sc_list), 1)
+        cu = sc_list[0].GetCompileUnit()
+        self.assertTrue(cu.IsValid(), "CompileUnit is not valid")
+
+        # First look for valid line
+        self.line = line_number("main.c", "int change_me")
+        self.assertNotEqual(cu.FindLineEntryIndex(0, self.line, self.file),
+                            lldb.LLDB_INVALID_LINE_NUMBER)
+
+        # Then look for a line out of bound
+        self.assertEqual(cu.FindLineEntryIndex(0, 42, self.file),
+                            lldb.LLDB_INVALID_LINE_NUMBER)

lldb/test/API/functionalities/find-line-entry/main.c

+int main() {
+  int change_me = 0;
+  for (int i = 0; i < 2; i++) {
+    change_me++;
+  }
+  return 0;
+}