[lldb] Clarify the documentation for GetIndexOfChildMemberWithName

[adrian-prantl]

No description provided.

[llvmbot]

@llvm/pr-subscribers-lldb

Author: Adrian Prantl (adrian-prantl)

Changes

---

Full diff: https://github.com/llvm/llvm-project/pull/136633.diff

2 Files Affected:

• (modified) lldb/include/lldb/Symbol/CompilerType.h (+3)
• (modified) lldb/include/lldb/Symbol/TypeSystem.h (-8)

diff --git a/lldb/include/lldb/Symbol/CompilerType.h b/lldb/include/lldb/Symbol/CompilerType.h
index 3561bc70887e6..a219d95763954 100644
--- a/lldb/include/lldb/Symbol/CompilerType.h
+++ b/lldb/include/lldb/Symbol/CompilerType.h
@@ -450,6 +450,9 @@ class CompilerType {
   /// Lookup a child member given a name. This function will match member names
   /// only and will descend into "clang_type" children in search for the first
   /// member in this class, or any base class that matches "name".
+  /// \param child_indexes returns an index path for the first result.
+  /// \returns 0 if unsuccessful, otherwise the length of the index path.
+  ///
   /// TODO: Return all matches for a given name by returning a
   /// vector<vector<uint32_t>>
   /// so we catch all names that match a given child name, not just the first.
diff --git a/lldb/include/lldb/Symbol/TypeSystem.h b/lldb/include/lldb/Symbol/TypeSystem.h
index 59fb066e087d3..9e9edc09a0846 100644
--- a/lldb/include/lldb/Symbol/TypeSystem.h
+++ b/lldb/include/lldb/Symbol/TypeSystem.h
@@ -373,18 +373,10 @@ class TypeSystem : public PluginInterface,
       bool &child_is_base_class, bool &child_is_deref_of_parent,
       ValueObject *valobj, uint64_t &language_flags) = 0;
 
-  // Lookup a child given a name. This function will match base class names and
-  // member member names in "clang_type" only, not descendants.
   virtual uint32_t GetIndexOfChildWithName(lldb::opaque_compiler_type_t type,
                                            llvm::StringRef name,
                                            bool omit_empty_base_classes) = 0;
 
-  // Lookup a child member given a name. This function will match member names
-  // only and will descend into "clang_type" children in search for the first
-  // member in this class, or any base class that matches "name".
-  // TODO: Return all matches for a given name by returning a
-  // vector<vector<uint32_t>>
-  // so we catch all names that match a given child name, not just the first.
   virtual size_t GetIndexOfChildMemberWithName(
       lldb::opaque_compiler_type_t type, llvm::StringRef name,
       bool omit_empty_base_classes, std::vector<uint32_t> &child_indexes) = 0;

[jimingham]

LGTM

[llvm-ci]

LLVM Buildbot has detected a new failure on builder fuchsia-x86_64-linux running on fuchsia-debian-64-us-central1-b-1 while building lldb at step 4 "annotate".

Full details are available at: https://lab.llvm.org/buildbot/#/builders/11/builds/13550

Here is the relevant piece of the build log for the reference

Step 4 (annotate) failure: 'python ../llvm-zorg/zorg/buildbot/builders/annotated/fuchsia-linux.py ...' (failure)
...
[828/1384] Running the Clang regression tests
llvm-lit: /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/llvm/utils/lit/lit/llvm/config.py:520: note: using clang: /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin/clang
llvm-lit: /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/llvm/utils/lit/lit/llvm/subst.py:126: note: Did not find cir-opt in /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin:/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin
llvm-lit: /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/llvm/utils/lit/lit/llvm/subst.py:126: note: Did not find clang-repl in /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin:/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin
llvm-lit: /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/llvm/utils/lit/lit/llvm/config.py:520: note: using ld.lld: /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin/ld.lld
llvm-lit: /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/llvm/utils/lit/lit/llvm/config.py:520: note: using lld-link: /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin/lld-link
llvm-lit: /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/llvm/utils/lit/lit/llvm/config.py:520: note: using ld64.lld: /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin/ld64.lld
llvm-lit: /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/llvm/utils/lit/lit/llvm/config.py:520: note: using wasm-ld: /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin/wasm-ld
-- Testing: 22362 tests, 60 workers --
Testing:  0
FAIL: Clang :: Analysis/ftime-trace.cpp (948 of 22362)
******************** TEST 'Clang :: Analysis/ftime-trace.cpp' FAILED ********************
Exit Code: 1

Command Output (stderr):
--
/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin/clang -cc1 -internal-isystem /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/lib/clang/21/include -nostdsysteminc -analyze -analyzer-constraints=range -setup-static-analyzer -analyzer-checker=core /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/clang/test/Analysis/ftime-trace.cpp -ftime-trace=/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/tools/clang/test/Analysis/Output/ftime-trace.cpp.tmp.raw.json -ftime-trace-granularity=0 -verify # RUN: at line 1
+ /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin/clang -cc1 -internal-isystem /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/lib/clang/21/include -nostdsysteminc -analyze -analyzer-constraints=range -setup-static-analyzer -analyzer-checker=core /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/clang/test/Analysis/ftime-trace.cpp -ftime-trace=/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/tools/clang/test/Analysis/Output/ftime-trace.cpp.tmp.raw.json -ftime-trace-granularity=0 -verify
"/usr/bin/python3.10" -c 'import json, sys; print(json.dumps(json.load(sys.stdin), indent=4))' < /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/tools/clang/test/Analysis/Output/ftime-trace.cpp.tmp.raw.json > /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/tools/clang/test/Analysis/Output/ftime-trace.cpp.tmp.formatted.json # RUN: at line 2
+ /usr/bin/python3.10 -c 'import json, sys; print(json.dumps(json.load(sys.stdin), indent=4))'
/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin/FileCheck --input-file=/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/tools/clang/test/Analysis/Output/ftime-trace.cpp.tmp.formatted.json --check-prefix=CHECK /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/clang/test/Analysis/ftime-trace.cpp # RUN: at line 3
+ /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin/FileCheck --input-file=/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/tools/clang/test/Analysis/Output/ftime-trace.cpp.tmp.formatted.json --check-prefix=CHECK /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/clang/test/Analysis/ftime-trace.cpp
/var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/clang/test/Analysis/ftime-trace.cpp:34:11: error: CHECK: expected string not found in input
// CHECK: "name": "Total CheckerManager::runCheckersForStmt (Pre)",
          ^
/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/tools/clang/test/Analysis/Output/ftime-trace.cpp.tmp.formatted.json:2474:3: note: scanning from here
 }
  ^
/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/tools/clang/test/Analysis/Output/ftime-trace.cpp.tmp.formatted.json:2662:2: note: possible intended match here
 "name": "Total CheckerManager::runCheckersForStmt (Post)",
 ^

Input file: /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/tools/clang/test/Analysis/Output/ftime-trace.cpp.tmp.formatted.json
Check file: /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/clang/test/Analysis/ftime-trace.cpp

-dump-input=help explains the following input dump.

Input was:
<<<<<<
            .
            .
            .
         2469:  "dur": 979, 
         2470:  "name": "Total dispatchWorkItem PostStmt", 
         2471:  "args": { 
         2472:  "count": 31, 
         2473:  "avg ms": 0 
         2474:  } 
check:34'0       X error: no match found
Step 7 (check) failure: check (failure)
...
[828/1384] Running the Clang regression tests
llvm-lit: /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/llvm/utils/lit/lit/llvm/config.py:520: note: using clang: /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin/clang
llvm-lit: /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/llvm/utils/lit/lit/llvm/subst.py:126: note: Did not find cir-opt in /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin:/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin
llvm-lit: /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/llvm/utils/lit/lit/llvm/subst.py:126: note: Did not find clang-repl in /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin:/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin
llvm-lit: /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/llvm/utils/lit/lit/llvm/config.py:520: note: using ld.lld: /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin/ld.lld
llvm-lit: /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/llvm/utils/lit/lit/llvm/config.py:520: note: using lld-link: /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin/lld-link
llvm-lit: /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/llvm/utils/lit/lit/llvm/config.py:520: note: using ld64.lld: /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin/ld64.lld
llvm-lit: /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/llvm/utils/lit/lit/llvm/config.py:520: note: using wasm-ld: /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin/wasm-ld
-- Testing: 22362 tests, 60 workers --
Testing:  0
FAIL: Clang :: Analysis/ftime-trace.cpp (948 of 22362)
******************** TEST 'Clang :: Analysis/ftime-trace.cpp' FAILED ********************
Exit Code: 1

Command Output (stderr):
--
/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin/clang -cc1 -internal-isystem /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/lib/clang/21/include -nostdsysteminc -analyze -analyzer-constraints=range -setup-static-analyzer -analyzer-checker=core /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/clang/test/Analysis/ftime-trace.cpp -ftime-trace=/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/tools/clang/test/Analysis/Output/ftime-trace.cpp.tmp.raw.json -ftime-trace-granularity=0 -verify # RUN: at line 1
+ /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin/clang -cc1 -internal-isystem /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/lib/clang/21/include -nostdsysteminc -analyze -analyzer-constraints=range -setup-static-analyzer -analyzer-checker=core /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/clang/test/Analysis/ftime-trace.cpp -ftime-trace=/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/tools/clang/test/Analysis/Output/ftime-trace.cpp.tmp.raw.json -ftime-trace-granularity=0 -verify
"/usr/bin/python3.10" -c 'import json, sys; print(json.dumps(json.load(sys.stdin), indent=4))' < /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/tools/clang/test/Analysis/Output/ftime-trace.cpp.tmp.raw.json > /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/tools/clang/test/Analysis/Output/ftime-trace.cpp.tmp.formatted.json # RUN: at line 2
+ /usr/bin/python3.10 -c 'import json, sys; print(json.dumps(json.load(sys.stdin), indent=4))'
/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin/FileCheck --input-file=/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/tools/clang/test/Analysis/Output/ftime-trace.cpp.tmp.formatted.json --check-prefix=CHECK /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/clang/test/Analysis/ftime-trace.cpp # RUN: at line 3
+ /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/bin/FileCheck --input-file=/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/tools/clang/test/Analysis/Output/ftime-trace.cpp.tmp.formatted.json --check-prefix=CHECK /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/clang/test/Analysis/ftime-trace.cpp
/var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/clang/test/Analysis/ftime-trace.cpp:34:11: error: CHECK: expected string not found in input
// CHECK: "name": "Total CheckerManager::runCheckersForStmt (Pre)",
          ^
/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/tools/clang/test/Analysis/Output/ftime-trace.cpp.tmp.formatted.json:2474:3: note: scanning from here
 }
  ^
/var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/tools/clang/test/Analysis/Output/ftime-trace.cpp.tmp.formatted.json:2662:2: note: possible intended match here
 "name": "Total CheckerManager::runCheckersForStmt (Post)",
 ^

Input file: /var/lib/buildbot/fuchsia-x86_64-linux/build/llvm-build-qu6bum89/tools/clang/test/Analysis/Output/ftime-trace.cpp.tmp.formatted.json
Check file: /var/lib/buildbot/fuchsia-x86_64-linux/llvm-project/clang/test/Analysis/ftime-trace.cpp

-dump-input=help explains the following input dump.

Input was:
<<<<<<
            .
            .
            .
         2469:  "dur": 979, 
         2470:  "name": "Total dispatchWorkItem PostStmt", 
         2471:  "args": { 
         2472:  "count": 31, 
         2473:  "avg ms": 0 
         2474:  } 
check:34'0       X error: no match found