https://github.com/JDevlieghere updated https://github.com/llvm/llvm-project/pull/168624
>From daea9d92bff226b4b8a1cb41ac306c6ab670becb Mon Sep 17 00:00:00 2001 From: Jonas Devlieghere <[email protected]> Date: Tue, 18 Nov 2025 14:43:30 -0800 Subject: [PATCH 1/6] [lldb] Eliminate SupportFileSP nullptr derefs This patch fixes and eliminates the possibility of SupportFileSP ever being nullptr. The support file was originally treated like a value type, but became a polymorphic type and therefore has to be stored and passed around as a pointer. To avoid having all the callers check the validity of the pointer, I introduced the invariant that SupportFileSP is never null and always default constructed. However, without enforcement at the type level, that's fragile and indeed, we already identified two crashes where someone accidentally broke that invariant. This PR introduces a NonNullSharedPtr to prevent that. NonNullSharedPtr is a smart pointer wrapper around std::shared_ptr that guarantees the pointer is never null. If default-constructed, it creates a default-constructed instance of the contained type. rdar://164989579 --- lldb/include/lldb/Core/SourceManager.h | 29 +++--- lldb/include/lldb/Symbol/CompileUnit.h | 6 +- lldb/include/lldb/Symbol/Function.h | 4 +- lldb/include/lldb/Symbol/LineEntry.h | 4 +- lldb/include/lldb/Utility/FileSpecList.h | 2 +- lldb/include/lldb/Utility/NonNullSharedPtr.h | 96 +++++++++++++++++++ lldb/include/lldb/Utility/SupportFile.h | 3 + lldb/include/lldb/lldb-forward.h | 1 - lldb/source/Commands/CommandObjectSource.cpp | 2 +- lldb/source/Core/SourceManager.cpp | 7 +- .../SymbolFile/DWARF/SymbolFileDWARF.cpp | 2 +- lldb/source/Symbol/CompileUnit.cpp | 2 +- lldb/source/Target/ThreadPlanStepRange.cpp | 2 +- lldb/source/Utility/FileSpecList.cpp | 4 +- 14 files changed, 132 insertions(+), 32 deletions(-) create mode 100644 lldb/include/lldb/Utility/NonNullSharedPtr.h diff --git a/lldb/include/lldb/Core/SourceManager.h b/lldb/include/lldb/Core/SourceManager.h index 83dc74768733d..f2b08528b6854 100644 --- a/lldb/include/lldb/Core/SourceManager.h +++ b/lldb/include/lldb/Core/SourceManager.h @@ -11,6 +11,7 @@ #include "lldb/Utility/Checksum.h" #include "lldb/Utility/FileSpec.h" +#include "lldb/Utility/SupportFile.h" #include "lldb/lldb-defines.h" #include "lldb/lldb-forward.h" @@ -38,8 +39,8 @@ class SourceManager { const SourceManager::File &rhs); public: - File(lldb::SupportFileSP support_file_sp, lldb::TargetSP target_sp); - File(lldb::SupportFileSP support_file_sp, lldb::DebuggerSP debugger_sp); + File(SupportFileSP support_file_sp, lldb::TargetSP target_sp); + File(SupportFileSP support_file_sp, lldb::DebuggerSP debugger_sp); bool ModificationTimeIsStale() const; bool PathRemappingIsStale() const; @@ -57,7 +58,7 @@ class SourceManager { bool LineIsValid(uint32_t line); - lldb::SupportFileSP GetSupportFile() const { + SupportFileSP GetSupportFile() const { assert(m_support_file_sp && "SupportFileSP must always be valid"); return m_support_file_sp; } @@ -80,13 +81,13 @@ class SourceManager { protected: /// Set file and update modification time. - void SetSupportFile(lldb::SupportFileSP support_file_sp); + void SetSupportFile(SupportFileSP support_file_sp); bool CalculateLineOffsets(uint32_t line = UINT32_MAX); /// The support file. If the target has source mappings, this might be /// different from the original support file passed to the constructor. - lldb::SupportFileSP m_support_file_sp; + SupportFileSP m_support_file_sp; /// Keep track of the on-disk checksum. Checksum m_checksum; @@ -107,9 +108,9 @@ class SourceManager { lldb::TargetWP m_target_wp; private: - void CommonInitializer(lldb::SupportFileSP support_file_sp, + void CommonInitializer(SupportFileSP support_file_sp, lldb::TargetSP target_sp); - void CommonInitializerImpl(lldb::SupportFileSP support_file_sp, + void CommonInitializerImpl(SupportFileSP support_file_sp, lldb::TargetSP target_sp); }; @@ -162,7 +163,7 @@ class SourceManager { } size_t DisplaySourceLinesWithLineNumbers( - lldb::SupportFileSP support_file_sp, uint32_t line, uint32_t column, + SupportFileSP support_file_sp, uint32_t line, uint32_t column, uint32_t context_before, uint32_t context_after, const char *current_line_cstr, Stream *s, const SymbolContextList *bp_locs = nullptr); @@ -176,13 +177,13 @@ class SourceManager { size_t DisplayMoreWithLineNumbers(Stream *s, uint32_t count, bool reverse, const SymbolContextList *bp_locs = nullptr); - bool SetDefaultFileAndLine(lldb::SupportFileSP support_file_sp, + bool SetDefaultFileAndLine(SupportFileSP support_file_sp, uint32_t line); struct SupportFileAndLine { - lldb::SupportFileSP support_file_sp; + SupportFileSP support_file_sp; uint32_t line; - SupportFileAndLine(lldb::SupportFileSP support_file_sp, uint32_t line) + SupportFileAndLine(SupportFileSP support_file_sp, uint32_t line) : support_file_sp(support_file_sp), line(line) {} }; @@ -192,15 +193,15 @@ class SourceManager { return (GetFile(m_last_support_file_sp).get() != nullptr); } - void FindLinesMatchingRegex(lldb::SupportFileSP support_file_sp, + void FindLinesMatchingRegex(SupportFileSP support_file_sp, RegularExpression ®ex, uint32_t start_line, uint32_t end_line, std::vector<uint32_t> &match_lines); - FileSP GetFile(lldb::SupportFileSP support_file_sp); + FileSP GetFile(SupportFileSP support_file_sp); protected: - lldb::SupportFileSP m_last_support_file_sp; + SupportFileSP m_last_support_file_sp; uint32_t m_last_line; uint32_t m_last_count; bool m_default_set; diff --git a/lldb/include/lldb/Symbol/CompileUnit.h b/lldb/include/lldb/Symbol/CompileUnit.h index c5bb080d21184..d537dacdc9b17 100644 --- a/lldb/include/lldb/Symbol/CompileUnit.h +++ b/lldb/include/lldb/Symbol/CompileUnit.h @@ -118,7 +118,7 @@ class CompileUnit : public std::enable_shared_from_this<CompileUnit>, /// An rvalue list of already parsed support files. /// \see lldb::LanguageType CompileUnit(const lldb::ModuleSP &module_sp, void *user_data, - lldb::SupportFileSP support_file_sp, lldb::user_id_t uid, + SupportFileSP support_file_sp, lldb::user_id_t uid, lldb::LanguageType language, lldb_private::LazyBool is_optimized, SupportFileList &&support_files = {}); @@ -234,7 +234,7 @@ class CompileUnit : public std::enable_shared_from_this<CompileUnit>, } /// Return the primary source file associated with this compile unit. - lldb::SupportFileSP GetPrimarySupportFile() const { + SupportFileSP GetPrimarySupportFile() const { return m_primary_support_file_sp; } @@ -430,7 +430,7 @@ class CompileUnit : public std::enable_shared_from_this<CompileUnit>, /// compile unit. std::vector<SourceModule> m_imported_modules; /// The primary file associated with this compile unit. - lldb::SupportFileSP m_primary_support_file_sp; + SupportFileSP m_primary_support_file_sp; /// Files associated with this compile unit's line table and declarations. SupportFileList m_support_files; /// Line table that will get parsed on demand. diff --git a/lldb/include/lldb/Symbol/Function.h b/lldb/include/lldb/Symbol/Function.h index 21b3f9ab4a70c..3f390e6edef8f 100644 --- a/lldb/include/lldb/Symbol/Function.h +++ b/lldb/include/lldb/Symbol/Function.h @@ -469,12 +469,12 @@ class Function : public UserID, public SymbolContextScope { /// /// \param[out] line_no /// The line number. - void GetStartLineSourceInfo(lldb::SupportFileSP &source_file_sp, + void GetStartLineSourceInfo(SupportFileSP &source_file_sp, uint32_t &line_no); using SourceRange = Range<uint32_t, uint32_t>; /// Find the file and line number range of the function. - llvm::Expected<std::pair<lldb::SupportFileSP, SourceRange>> GetSourceInfo(); + llvm::Expected<std::pair<SupportFileSP, SourceRange>> GetSourceInfo(); /// Get the outgoing call edges from this function, sorted by their return /// PC addresses (in increasing order). diff --git a/lldb/include/lldb/Symbol/LineEntry.h b/lldb/include/lldb/Symbol/LineEntry.h index 8da59cf0bd24a..c6b414cb9659c 100644 --- a/lldb/include/lldb/Symbol/LineEntry.h +++ b/lldb/include/lldb/Symbol/LineEntry.h @@ -137,10 +137,10 @@ struct LineEntry { AddressRange range; /// The source file, possibly mapped by the target.source-map setting. - lldb::SupportFileSP file_sp; + SupportFileSP file_sp; /// The original source file, from debug info. - lldb::SupportFileSP original_file_sp; + SupportFileSP original_file_sp; /// The source line number, or LLDB_INVALID_LINE_NUMBER if there is no line /// number information. diff --git a/lldb/include/lldb/Utility/FileSpecList.h b/lldb/include/lldb/Utility/FileSpecList.h index d091a9246e082..1ebdf3969f2c6 100644 --- a/lldb/include/lldb/Utility/FileSpecList.h +++ b/lldb/include/lldb/Utility/FileSpecList.h @@ -41,7 +41,7 @@ class SupportFileList { bool AppendIfUnique(const FileSpec &file); size_t GetSize() const { return m_files.size(); } const FileSpec &GetFileSpecAtIndex(size_t idx) const; - lldb::SupportFileSP GetSupportFileAtIndex(size_t idx) const; + SupportFileSP GetSupportFileAtIndex(size_t idx) const; size_t FindFileIndex(size_t idx, const FileSpec &file, bool full) const; /// Find a compatible file index. /// diff --git a/lldb/include/lldb/Utility/NonNullSharedPtr.h b/lldb/include/lldb/Utility/NonNullSharedPtr.h new file mode 100644 index 0000000000000..2f87c34a59bde --- /dev/null +++ b/lldb/include/lldb/Utility/NonNullSharedPtr.h @@ -0,0 +1,96 @@ +//===----------------------------------------------------------------------===// +// +// 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 +// +//===----------------------------------------------------------------------===// + +#ifndef LLDB_UTILITY_NONNULLSHAREDPTR_H +#define LLDB_UTILITY_NONNULLSHAREDPTR_H + +#include <memory> +#include <utility> + +namespace lldb_private { + +/// A non-nullable shared pointer that always holds a valid object. +/// +/// NonNullSharedPtr is a smart pointer wrapper around std::shared_ptr that +/// guarantees the pointer is never null. If default-constructed, it creates +/// a default-constructed instance of T. +/// +/// This class is used for enforcing invariants at the type level and +/// eliminating entire classes of null pointer bugs. +/// +/// @tparam T The type of object to manage. Must be default-constructible. +template <typename T> class NonNullSharedPtr : private std::shared_ptr<T> { + using Base = std::shared_ptr<T>; + +public: + NonNullSharedPtr() : Base(std::make_shared<T>()) {} + + NonNullSharedPtr(const std::shared_ptr<T> &t) + : Base(t ? t : std::make_shared<T>()) { + assert(t && "NonNullSharedPtr initialized from NULL shared_ptr"); + } + + NonNullSharedPtr(std::shared_ptr<T> &&t) + : Base(t ? std::move(t) : std::make_shared<T>()) { + // Can't assert on t as it's been moved-from. + } + + NonNullSharedPtr(const NonNullSharedPtr &other) : Base(other) {} + + NonNullSharedPtr(NonNullSharedPtr &&other) noexcept + : Base(std::move(other)) {} + + NonNullSharedPtr &operator=(const NonNullSharedPtr &other) { + Base::operator=(other); + return *this; + } + + NonNullSharedPtr &operator=(NonNullSharedPtr &&other) noexcept { + Base::operator=(std::move(other)); + return *this; + } + + using Base::operator*; + using Base::operator->; + using Base::get; + using Base::unique; + using Base::use_count; + using Base::operator bool; + + void swap(NonNullSharedPtr &other) noexcept { Base::swap(other); } + + /// Explicitly deleted operations that could introduce nullptr. + /// @{ + void reset() = delete; + void reset(T *ptr) = delete; + /// @} +}; + +} // namespace lldb_private + +template <typename T> +bool operator==(const lldb_private::NonNullSharedPtr<T> &lhs, + const lldb_private::NonNullSharedPtr<T> &rhs) { + return lhs.get() == rhs.get(); +} + +template <typename T> +bool operator!=(const lldb_private::NonNullSharedPtr<T> &lhs, + const lldb_private::NonNullSharedPtr<T> &rhs) { + return !(lhs == rhs); +} + +/// Specialized swap function for NonNullSharedPtr to enable argument-dependent +/// lookup (ADL) and efficient swapping. +template <typename T> +void swap(lldb_private::NonNullSharedPtr<T> &lhs, + lldb_private::NonNullSharedPtr<T> &rhs) noexcept { + lhs.swap(rhs); +} + +#endif diff --git a/lldb/include/lldb/Utility/SupportFile.h b/lldb/include/lldb/Utility/SupportFile.h index c389edf0e9f12..4bc898906ea35 100644 --- a/lldb/include/lldb/Utility/SupportFile.h +++ b/lldb/include/lldb/Utility/SupportFile.h @@ -11,6 +11,7 @@ #include "lldb/Utility/Checksum.h" #include "lldb/Utility/FileSpec.h" +#include "lldb/Utility/NonNullSharedPtr.h" namespace lldb_private { @@ -76,6 +77,8 @@ class SupportFile { const Checksum m_checksum; }; +typedef NonNullSharedPtr<lldb_private::SupportFile> SupportFileSP; + } // namespace lldb_private #endif // LLDB_UTILITY_SUPPORTFILE_H diff --git a/lldb/include/lldb/lldb-forward.h b/lldb/include/lldb/lldb-forward.h index 8b8d081ca2113..c8e2e97953aa4 100644 --- a/lldb/include/lldb/lldb-forward.h +++ b/lldb/include/lldb/lldb-forward.h @@ -493,7 +493,6 @@ typedef std::shared_ptr<lldb_private::TypeSummaryImpl> TypeSummaryImplSP; typedef std::shared_ptr<lldb_private::TypeSummaryOptions> TypeSummaryOptionsSP; typedef std::shared_ptr<lldb_private::ScriptedSyntheticChildren> ScriptedSyntheticChildrenSP; -typedef std::shared_ptr<lldb_private::SupportFile> SupportFileSP; typedef std::shared_ptr<lldb_private::UnixSignals> UnixSignalsSP; typedef std::weak_ptr<lldb_private::UnixSignals> UnixSignalsWP; typedef std::shared_ptr<lldb_private::UnwindAssembly> UnwindAssemblySP; diff --git a/lldb/source/Commands/CommandObjectSource.cpp b/lldb/source/Commands/CommandObjectSource.cpp index 0b4599b16ef0d..b280e0536b2cf 100644 --- a/lldb/source/Commands/CommandObjectSource.cpp +++ b/lldb/source/Commands/CommandObjectSource.cpp @@ -1194,7 +1194,7 @@ class CommandObjectSourceList : public CommandObjectParsed { // file(s) will be found and assigned to // sc.comp_unit->GetPrimarySupportFile, which is NOT what we want to // print. Instead, we want to print the one from the line entry. - lldb::SupportFileSP found_file_sp = sc.line_entry.file_sp; + SupportFileSP found_file_sp = sc.line_entry.file_sp; target.GetSourceManager().DisplaySourceLinesWithLineNumbers( found_file_sp, m_options.start_line, column, 0, diff --git a/lldb/source/Core/SourceManager.cpp b/lldb/source/Core/SourceManager.cpp index 097173ffe678e..618cc8e411f19 100644 --- a/lldb/source/Core/SourceManager.cpp +++ b/lldb/source/Core/SourceManager.cpp @@ -25,6 +25,7 @@ #include "lldb/Target/Target.h" #include "lldb/Utility/AnsiTerminal.h" #include "lldb/Utility/ConstString.h" +#include "lldb/Utility/SupportFile.h" #include "lldb/Utility/DataBuffer.h" #include "lldb/Utility/LLDBLog.h" #include "lldb/Utility/Log.h" @@ -325,7 +326,7 @@ size_t SourceManager::DisplaySourceLinesWithLineNumbersUsingLastFile( } size_t SourceManager::DisplaySourceLinesWithLineNumbers( - lldb::SupportFileSP support_file_sp, uint32_t line, uint32_t column, + SupportFileSP support_file_sp, uint32_t line, uint32_t column, uint32_t context_before, uint32_t context_after, const char *current_line_cstr, Stream *s, const SymbolContextList *bp_locs) { @@ -389,7 +390,7 @@ size_t SourceManager::DisplayMoreWithLineNumbers( return 0; } -bool SourceManager::SetDefaultFileAndLine(lldb::SupportFileSP support_file_sp, +bool SourceManager::SetDefaultFileAndLine(SupportFileSP support_file_sp, uint32_t line) { assert(support_file_sp && "SupportFile must be valid"); @@ -575,7 +576,7 @@ void SourceManager::File::CommonInitializerImpl(SupportFileSP support_file_sp, } } -void SourceManager::File::SetSupportFile(lldb::SupportFileSP support_file_sp) { +void SourceManager::File::SetSupportFile(SupportFileSP support_file_sp) { FileSpec file_spec = support_file_sp->GetSpecOnly(); resolve_tilde(file_spec); m_support_file_sp = diff --git a/lldb/source/Plugins/SymbolFile/DWARF/SymbolFileDWARF.cpp b/lldb/source/Plugins/SymbolFile/DWARF/SymbolFileDWARF.cpp index bcb3ad854c388..ff0aa3e6e4257 100644 --- a/lldb/source/Plugins/SymbolFile/DWARF/SymbolFileDWARF.cpp +++ b/lldb/source/Plugins/SymbolFile/DWARF/SymbolFileDWARF.cpp @@ -794,7 +794,7 @@ lldb::CompUnitSP SymbolFileDWARF::ParseCompileUnit(DWARFCompileUnit &dwarf_cu) { } else { ModuleSP module_sp(m_objfile_sp->GetModule()); if (module_sp) { - auto initialize_cu = [&](lldb::SupportFileSP support_file_sp, + auto initialize_cu = [&](SupportFileSP support_file_sp, LanguageType cu_language, SupportFileList &&support_files = {}) { BuildCuTranslationTable(); diff --git a/lldb/source/Symbol/CompileUnit.cpp b/lldb/source/Symbol/CompileUnit.cpp index 166f111ef6220..c23b7c4a6a5cb 100644 --- a/lldb/source/Symbol/CompileUnit.cpp +++ b/lldb/source/Symbol/CompileUnit.cpp @@ -27,7 +27,7 @@ CompileUnit::CompileUnit(const lldb::ModuleSP &module_sp, void *user_data, language, is_optimized) {} CompileUnit::CompileUnit(const lldb::ModuleSP &module_sp, void *user_data, - lldb::SupportFileSP support_file_sp, + SupportFileSP support_file_sp, const lldb::user_id_t cu_sym_id, lldb::LanguageType language, lldb_private::LazyBool is_optimized, diff --git a/lldb/source/Target/ThreadPlanStepRange.cpp b/lldb/source/Target/ThreadPlanStepRange.cpp index dca96cc74ba46..20ca1fc3dbb2a 100644 --- a/lldb/source/Target/ThreadPlanStepRange.cpp +++ b/lldb/source/Target/ThreadPlanStepRange.cpp @@ -431,7 +431,7 @@ bool ThreadPlanStepRange::SetNextBranchBreakpoint() { top_most_line_entry.original_file_sp = std::make_shared<SupportFile>(call_site_file_spec); top_most_line_entry.range = range; - top_most_line_entry.file_sp.reset(); + top_most_line_entry.file_sp = std::make_shared<SupportFile>(); top_most_line_entry.ApplyFileMappings( GetThread().CalculateTarget()); if (!top_most_line_entry.file_sp) diff --git a/lldb/source/Utility/FileSpecList.cpp b/lldb/source/Utility/FileSpecList.cpp index 5852367f77827..a4076ee815719 100644 --- a/lldb/source/Utility/FileSpecList.cpp +++ b/lldb/source/Utility/FileSpecList.cpp @@ -46,7 +46,7 @@ bool FileSpecList::AppendIfUnique(const FileSpec &file_spec) { bool SupportFileList::AppendIfUnique(const FileSpec &file_spec) { collection::iterator end = m_files.end(); if (find_if(m_files.begin(), end, - [&](const std::shared_ptr<SupportFile> &support_file) { + [&](const SupportFileSP &support_file) { return support_file->GetSpecOnly() == file_spec; }) == end) { Append(file_spec); @@ -214,7 +214,7 @@ const FileSpec &SupportFileList::GetFileSpecAtIndex(size_t idx) const { return g_empty_file_spec; } -std::shared_ptr<SupportFile> +SupportFileSP SupportFileList::GetSupportFileAtIndex(size_t idx) const { if (idx < m_files.size()) return m_files[idx]; >From 98a3330117735c12fdc510105090224072f7c015 Mon Sep 17 00:00:00 2001 From: Jonas Devlieghere <[email protected]> Date: Tue, 18 Nov 2025 15:22:53 -0800 Subject: [PATCH 2/6] Fix TestInlineStepping.py --- lldb/source/Target/ThreadPlanStepRange.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lldb/source/Target/ThreadPlanStepRange.cpp b/lldb/source/Target/ThreadPlanStepRange.cpp index 20ca1fc3dbb2a..3a9deb6f5c6fd 100644 --- a/lldb/source/Target/ThreadPlanStepRange.cpp +++ b/lldb/source/Target/ThreadPlanStepRange.cpp @@ -434,7 +434,7 @@ bool ThreadPlanStepRange::SetNextBranchBreakpoint() { top_most_line_entry.file_sp = std::make_shared<SupportFile>(); top_most_line_entry.ApplyFileMappings( GetThread().CalculateTarget()); - if (!top_most_line_entry.file_sp) + if (!top_most_line_entry.file_sp->GetSpecOnly()) top_most_line_entry.file_sp = top_most_line_entry.original_file_sp; } >From ff3e98e6afcb053afccea5ff2af7e182f3355b03 Mon Sep 17 00:00:00 2001 From: Jonas Devlieghere <[email protected]> Date: Tue, 18 Nov 2025 15:25:57 -0800 Subject: [PATCH 3/6] Fix formatting --- lldb/include/lldb/Core/SourceManager.h | 3 +-- lldb/include/lldb/Symbol/Function.h | 3 +-- lldb/source/Core/SourceManager.cpp | 2 +- lldb/source/Utility/FileSpecList.cpp | 10 ++++------ 4 files changed, 7 insertions(+), 11 deletions(-) diff --git a/lldb/include/lldb/Core/SourceManager.h b/lldb/include/lldb/Core/SourceManager.h index f2b08528b6854..1da29006acd93 100644 --- a/lldb/include/lldb/Core/SourceManager.h +++ b/lldb/include/lldb/Core/SourceManager.h @@ -177,8 +177,7 @@ class SourceManager { size_t DisplayMoreWithLineNumbers(Stream *s, uint32_t count, bool reverse, const SymbolContextList *bp_locs = nullptr); - bool SetDefaultFileAndLine(SupportFileSP support_file_sp, - uint32_t line); + bool SetDefaultFileAndLine(SupportFileSP support_file_sp, uint32_t line); struct SupportFileAndLine { SupportFileSP support_file_sp; diff --git a/lldb/include/lldb/Symbol/Function.h b/lldb/include/lldb/Symbol/Function.h index 3f390e6edef8f..a683f1452a21f 100644 --- a/lldb/include/lldb/Symbol/Function.h +++ b/lldb/include/lldb/Symbol/Function.h @@ -469,8 +469,7 @@ class Function : public UserID, public SymbolContextScope { /// /// \param[out] line_no /// The line number. - void GetStartLineSourceInfo(SupportFileSP &source_file_sp, - uint32_t &line_no); + void GetStartLineSourceInfo(SupportFileSP &source_file_sp, uint32_t &line_no); using SourceRange = Range<uint32_t, uint32_t>; /// Find the file and line number range of the function. diff --git a/lldb/source/Core/SourceManager.cpp b/lldb/source/Core/SourceManager.cpp index 618cc8e411f19..d50ea2d980aab 100644 --- a/lldb/source/Core/SourceManager.cpp +++ b/lldb/source/Core/SourceManager.cpp @@ -25,12 +25,12 @@ #include "lldb/Target/Target.h" #include "lldb/Utility/AnsiTerminal.h" #include "lldb/Utility/ConstString.h" -#include "lldb/Utility/SupportFile.h" #include "lldb/Utility/DataBuffer.h" #include "lldb/Utility/LLDBLog.h" #include "lldb/Utility/Log.h" #include "lldb/Utility/RegularExpression.h" #include "lldb/Utility/Stream.h" +#include "lldb/Utility/SupportFile.h" #include "lldb/lldb-enumerations.h" #include "llvm/ADT/Twine.h" diff --git a/lldb/source/Utility/FileSpecList.cpp b/lldb/source/Utility/FileSpecList.cpp index a4076ee815719..bcfe718099509 100644 --- a/lldb/source/Utility/FileSpecList.cpp +++ b/lldb/source/Utility/FileSpecList.cpp @@ -45,10 +45,9 @@ bool FileSpecList::AppendIfUnique(const FileSpec &file_spec) { // FIXME: Replace this with a DenseSet at the call site. It is inefficient. bool SupportFileList::AppendIfUnique(const FileSpec &file_spec) { collection::iterator end = m_files.end(); - if (find_if(m_files.begin(), end, - [&](const SupportFileSP &support_file) { - return support_file->GetSpecOnly() == file_spec; - }) == end) { + if (find_if(m_files.begin(), end, [&](const SupportFileSP &support_file) { + return support_file->GetSpecOnly() == file_spec; + }) == end) { Append(file_spec); return true; } @@ -214,8 +213,7 @@ const FileSpec &SupportFileList::GetFileSpecAtIndex(size_t idx) const { return g_empty_file_spec; } -SupportFileSP -SupportFileList::GetSupportFileAtIndex(size_t idx) const { +SupportFileSP SupportFileList::GetSupportFileAtIndex(size_t idx) const { if (idx < m_files.size()) return m_files[idx]; return {}; >From 4964eac1e46dc0b8eb1a9d80e5a6d2afd7938179 Mon Sep 17 00:00:00 2001 From: Jonas Devlieghere <[email protected]> Date: Tue, 18 Nov 2025 16:09:56 -0800 Subject: [PATCH 4/6] Remove (in)equality functions --- lldb/include/lldb/Utility/NonNullSharedPtr.h | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/lldb/include/lldb/Utility/NonNullSharedPtr.h b/lldb/include/lldb/Utility/NonNullSharedPtr.h index 2f87c34a59bde..56d573dbd759c 100644 --- a/lldb/include/lldb/Utility/NonNullSharedPtr.h +++ b/lldb/include/lldb/Utility/NonNullSharedPtr.h @@ -73,18 +73,6 @@ template <typename T> class NonNullSharedPtr : private std::shared_ptr<T> { } // namespace lldb_private -template <typename T> -bool operator==(const lldb_private::NonNullSharedPtr<T> &lhs, - const lldb_private::NonNullSharedPtr<T> &rhs) { - return lhs.get() == rhs.get(); -} - -template <typename T> -bool operator!=(const lldb_private::NonNullSharedPtr<T> &lhs, - const lldb_private::NonNullSharedPtr<T> &rhs) { - return !(lhs == rhs); -} - /// Specialized swap function for NonNullSharedPtr to enable argument-dependent /// lookup (ADL) and efficient swapping. template <typename T> >From 8b1c0843b62d0ac1455590de2eb2652d236cbf71 Mon Sep 17 00:00:00 2001 From: Jonas Devlieghere <[email protected]> Date: Thu, 20 Nov 2025 13:44:46 -0800 Subject: [PATCH 5/6] Remove default constructor & noexcept --- lldb/include/lldb/Utility/NonNullSharedPtr.h | 14 +++++--------- .../Breakpoint/BreakpointResolverFileLine.cpp | 2 +- lldb/source/Core/Disassembler.cpp | 5 +++-- lldb/source/Symbol/Function.cpp | 2 +- lldb/source/Symbol/LineTable.cpp | 2 +- lldb/source/Utility/FileSpecList.cpp | 2 +- 6 files changed, 12 insertions(+), 15 deletions(-) diff --git a/lldb/include/lldb/Utility/NonNullSharedPtr.h b/lldb/include/lldb/Utility/NonNullSharedPtr.h index 56d573dbd759c..7e12ce72c6238 100644 --- a/lldb/include/lldb/Utility/NonNullSharedPtr.h +++ b/lldb/include/lldb/Utility/NonNullSharedPtr.h @@ -17,8 +17,7 @@ namespace lldb_private { /// A non-nullable shared pointer that always holds a valid object. /// /// NonNullSharedPtr is a smart pointer wrapper around std::shared_ptr that -/// guarantees the pointer is never null. If default-constructed, it creates -/// a default-constructed instance of T. +/// guarantees the pointer is never null. /// /// This class is used for enforcing invariants at the type level and /// eliminating entire classes of null pointer bugs. @@ -28,8 +27,6 @@ template <typename T> class NonNullSharedPtr : private std::shared_ptr<T> { using Base = std::shared_ptr<T>; public: - NonNullSharedPtr() : Base(std::make_shared<T>()) {} - NonNullSharedPtr(const std::shared_ptr<T> &t) : Base(t ? t : std::make_shared<T>()) { assert(t && "NonNullSharedPtr initialized from NULL shared_ptr"); @@ -42,15 +39,14 @@ template <typename T> class NonNullSharedPtr : private std::shared_ptr<T> { NonNullSharedPtr(const NonNullSharedPtr &other) : Base(other) {} - NonNullSharedPtr(NonNullSharedPtr &&other) noexcept - : Base(std::move(other)) {} + NonNullSharedPtr(NonNullSharedPtr &&other) : Base(std::move(other)) {} NonNullSharedPtr &operator=(const NonNullSharedPtr &other) { Base::operator=(other); return *this; } - NonNullSharedPtr &operator=(NonNullSharedPtr &&other) noexcept { + NonNullSharedPtr &operator=(NonNullSharedPtr &&other) { Base::operator=(std::move(other)); return *this; } @@ -62,7 +58,7 @@ template <typename T> class NonNullSharedPtr : private std::shared_ptr<T> { using Base::use_count; using Base::operator bool; - void swap(NonNullSharedPtr &other) noexcept { Base::swap(other); } + void swap(NonNullSharedPtr &other) { Base::swap(other); } /// Explicitly deleted operations that could introduce nullptr. /// @{ @@ -77,7 +73,7 @@ template <typename T> class NonNullSharedPtr : private std::shared_ptr<T> { /// lookup (ADL) and efficient swapping. template <typename T> void swap(lldb_private::NonNullSharedPtr<T> &lhs, - lldb_private::NonNullSharedPtr<T> &rhs) noexcept { + lldb_private::NonNullSharedPtr<T> &rhs) { lhs.swap(rhs); } diff --git a/lldb/source/Breakpoint/BreakpointResolverFileLine.cpp b/lldb/source/Breakpoint/BreakpointResolverFileLine.cpp index a94e9e23163d3..8eef0e3ed1364 100644 --- a/lldb/source/Breakpoint/BreakpointResolverFileLine.cpp +++ b/lldb/source/Breakpoint/BreakpointResolverFileLine.cpp @@ -139,7 +139,7 @@ void BreakpointResolverFileLine::FilterContexts(SymbolContextList &sc_list) { if (!sc.block) continue; - SupportFileSP file_sp; + SupportFileSP file_sp = std::make_shared<SupportFile>(); uint32_t line; const Block *inline_block = sc.block->GetContainingInlinedBlock(); if (inline_block) { diff --git a/lldb/source/Core/Disassembler.cpp b/lldb/source/Core/Disassembler.cpp index f2ed1f7395346..19b50f527b613 100644 --- a/lldb/source/Core/Disassembler.cpp +++ b/lldb/source/Core/Disassembler.cpp @@ -208,7 +208,7 @@ Disassembler::GetFunctionDeclLineEntry(const SymbolContext &sc) { return {}; LineEntry prologue_end_line = sc.line_entry; - SupportFileSP func_decl_file_sp; + SupportFileSP func_decl_file_sp = std::make_shared<SupportFile>(); uint32_t func_decl_line; sc.function->GetStartLineSourceInfo(func_decl_file_sp, func_decl_line); @@ -539,7 +539,8 @@ void Disassembler::PrintInstructions(Debugger &debugger, const ArchSpec &arch, LineEntry prologue_end_line = sc.line_entry; if (!ElideMixedSourceAndDisassemblyLine(exe_ctx, sc, prologue_end_line)) { - SupportFileSP func_decl_file_sp; + SupportFileSP func_decl_file_sp = + std::make_shared<SupportFile>(); uint32_t func_decl_line; sc.function->GetStartLineSourceInfo(func_decl_file_sp, func_decl_line); diff --git a/lldb/source/Symbol/Function.cpp b/lldb/source/Symbol/Function.cpp index 2be1e389aa1d0..8b50f3c519184 100644 --- a/lldb/source/Symbol/Function.cpp +++ b/lldb/source/Symbol/Function.cpp @@ -302,7 +302,7 @@ void Function::GetStartLineSourceInfo(SupportFileSP &source_file_sp, llvm::Expected<std::pair<SupportFileSP, Function::SourceRange>> Function::GetSourceInfo() { - SupportFileSP source_file_sp; + SupportFileSP source_file_sp = std::make_shared<SupportFile>(); uint32_t start_line; GetStartLineSourceInfo(source_file_sp, start_line); LineTable *line_table = m_comp_unit->GetLineTable(); diff --git a/lldb/source/Symbol/LineTable.cpp b/lldb/source/Symbol/LineTable.cpp index ca3accd6894a7..6e441bf562f6f 100644 --- a/lldb/source/Symbol/LineTable.cpp +++ b/lldb/source/Symbol/LineTable.cpp @@ -327,7 +327,7 @@ void LineTable::Dump(Stream *s, Target *target, Address::DumpStyle style, Address::DumpStyle fallback_style, bool show_line_ranges) { const size_t count = m_entries.size(); LineEntry line_entry; - SupportFileSP prev_file; + SupportFileSP prev_file = std::make_shared<SupportFile>(); for (size_t idx = 0; idx < count; ++idx) { ConvertEntryAtIndexToLineEntry(idx, line_entry); line_entry.Dump(s, target, !prev_file->Equal(*line_entry.original_file_sp), diff --git a/lldb/source/Utility/FileSpecList.cpp b/lldb/source/Utility/FileSpecList.cpp index bcfe718099509..bd7d587d3386c 100644 --- a/lldb/source/Utility/FileSpecList.cpp +++ b/lldb/source/Utility/FileSpecList.cpp @@ -216,7 +216,7 @@ const FileSpec &SupportFileList::GetFileSpecAtIndex(size_t idx) const { SupportFileSP SupportFileList::GetSupportFileAtIndex(size_t idx) const { if (idx < m_files.size()) return m_files[idx]; - return {}; + return std::make_shared<SupportFile>(); } // Return the size in bytes that this object takes in memory. This returns the >From 76d08e5e4535b5df45a9fbe4f0104e9f6e367205 Mon Sep 17 00:00:00 2001 From: Jonas Devlieghere <[email protected]> Date: Thu, 20 Nov 2025 13:54:15 -0800 Subject: [PATCH 6/6] SupportFileSP -> SupportFileNSP --- lldb/include/lldb/Core/SourceManager.h | 38 ++++----- lldb/include/lldb/Symbol/CompileUnit.h | 12 +-- lldb/include/lldb/Symbol/Function.h | 5 +- lldb/include/lldb/Symbol/LineEntry.h | 4 +- lldb/include/lldb/Utility/FileSpecList.h | 2 +- lldb/include/lldb/Utility/SupportFile.h | 2 +- .../Breakpoint/BreakpointResolverFileLine.cpp | 2 +- .../Commands/CommandObjectBreakpoint.cpp | 2 +- lldb/source/Commands/CommandObjectSource.cpp | 4 +- lldb/source/Core/Disassembler.cpp | 4 +- lldb/source/Core/SourceManager.cpp | 80 +++++++++---------- lldb/source/Expression/REPL.cpp | 2 +- .../SymbolFile/DWARF/SymbolFileDWARF.cpp | 4 +- lldb/source/Symbol/CompileUnit.cpp | 4 +- lldb/source/Symbol/Function.cpp | 6 +- lldb/source/Symbol/LineTable.cpp | 2 +- lldb/source/Target/StackFrame.cpp | 2 +- lldb/source/Utility/FileSpecList.cpp | 4 +- lldb/unittests/Symbol/LineTableTest.cpp | 2 +- 19 files changed, 90 insertions(+), 91 deletions(-) diff --git a/lldb/include/lldb/Core/SourceManager.h b/lldb/include/lldb/Core/SourceManager.h index 1da29006acd93..5a7b51528eb97 100644 --- a/lldb/include/lldb/Core/SourceManager.h +++ b/lldb/include/lldb/Core/SourceManager.h @@ -39,8 +39,8 @@ class SourceManager { const SourceManager::File &rhs); public: - File(SupportFileSP support_file_sp, lldb::TargetSP target_sp); - File(SupportFileSP support_file_sp, lldb::DebuggerSP debugger_sp); + File(SupportFileNSP support_file_nsp, lldb::TargetSP target_sp); + File(SupportFileNSP support_file_nsp, lldb::DebuggerSP debugger_sp); bool ModificationTimeIsStale() const; bool PathRemappingIsStale() const; @@ -58,9 +58,9 @@ class SourceManager { bool LineIsValid(uint32_t line); - SupportFileSP GetSupportFile() const { - assert(m_support_file_sp && "SupportFileSP must always be valid"); - return m_support_file_sp; + SupportFileNSP GetSupportFile() const { + assert(m_support_file_nsp && "SupportFileNSP must always be valid"); + return m_support_file_nsp; } uint32_t GetSourceMapModificationID() const { return m_source_map_mod_id; } @@ -81,13 +81,13 @@ class SourceManager { protected: /// Set file and update modification time. - void SetSupportFile(SupportFileSP support_file_sp); + void SetSupportFile(SupportFileNSP support_file_nsp); bool CalculateLineOffsets(uint32_t line = UINT32_MAX); /// The support file. If the target has source mappings, this might be /// different from the original support file passed to the constructor. - SupportFileSP m_support_file_sp; + SupportFileNSP m_support_file_nsp; /// Keep track of the on-disk checksum. Checksum m_checksum; @@ -108,9 +108,9 @@ class SourceManager { lldb::TargetWP m_target_wp; private: - void CommonInitializer(SupportFileSP support_file_sp, + void CommonInitializer(SupportFileNSP support_file_nsp, lldb::TargetSP target_sp); - void CommonInitializerImpl(SupportFileSP support_file_sp, + void CommonInitializerImpl(SupportFileNSP support_file_nsp, lldb::TargetSP target_sp); }; @@ -157,13 +157,13 @@ class SourceManager { ~SourceManager(); - FileSP GetLastFile() { return GetFile(m_last_support_file_sp); } + FileSP GetLastFile() { return GetFile(m_last_support_file_nsp); } bool AtLastLine(bool reverse) { return m_last_line == UINT32_MAX || (reverse && m_last_line == 1); } size_t DisplaySourceLinesWithLineNumbers( - SupportFileSP support_file_sp, uint32_t line, uint32_t column, + SupportFileNSP support_file_nsp, uint32_t line, uint32_t column, uint32_t context_before, uint32_t context_after, const char *current_line_cstr, Stream *s, const SymbolContextList *bp_locs = nullptr); @@ -177,30 +177,30 @@ class SourceManager { size_t DisplayMoreWithLineNumbers(Stream *s, uint32_t count, bool reverse, const SymbolContextList *bp_locs = nullptr); - bool SetDefaultFileAndLine(SupportFileSP support_file_sp, uint32_t line); + bool SetDefaultFileAndLine(SupportFileNSP support_file_nsp, uint32_t line); struct SupportFileAndLine { - SupportFileSP support_file_sp; + SupportFileNSP support_file_nsp; uint32_t line; - SupportFileAndLine(SupportFileSP support_file_sp, uint32_t line) - : support_file_sp(support_file_sp), line(line) {} + SupportFileAndLine(SupportFileNSP support_file_nsp, uint32_t line) + : support_file_nsp(support_file_nsp), line(line) {} }; std::optional<SupportFileAndLine> GetDefaultFileAndLine(); bool DefaultFileAndLineSet() { - return (GetFile(m_last_support_file_sp).get() != nullptr); + return (GetFile(m_last_support_file_nsp).get() != nullptr); } - void FindLinesMatchingRegex(SupportFileSP support_file_sp, + void FindLinesMatchingRegex(SupportFileNSP support_file_nsp, RegularExpression ®ex, uint32_t start_line, uint32_t end_line, std::vector<uint32_t> &match_lines); - FileSP GetFile(SupportFileSP support_file_sp); + FileSP GetFile(SupportFileNSP support_file_nsp); protected: - SupportFileSP m_last_support_file_sp; + SupportFileNSP m_last_support_file_nsp; uint32_t m_last_line; uint32_t m_last_count; bool m_default_set; diff --git a/lldb/include/lldb/Symbol/CompileUnit.h b/lldb/include/lldb/Symbol/CompileUnit.h index d537dacdc9b17..bb9594699df33 100644 --- a/lldb/include/lldb/Symbol/CompileUnit.h +++ b/lldb/include/lldb/Symbol/CompileUnit.h @@ -93,7 +93,7 @@ class CompileUnit : public std::enable_shared_from_this<CompileUnit>, /// \param[in] user_data /// User data where the SymbolFile parser can store data. /// - /// \param[in] support_file_sp + /// \param[in] support_file_nsp /// The file specification for the source file of this compile /// unit. /// @@ -118,7 +118,7 @@ class CompileUnit : public std::enable_shared_from_this<CompileUnit>, /// An rvalue list of already parsed support files. /// \see lldb::LanguageType CompileUnit(const lldb::ModuleSP &module_sp, void *user_data, - SupportFileSP support_file_sp, lldb::user_id_t uid, + SupportFileNSP support_file_nsp, lldb::user_id_t uid, lldb::LanguageType language, lldb_private::LazyBool is_optimized, SupportFileList &&support_files = {}); @@ -230,12 +230,12 @@ class CompileUnit : public std::enable_shared_from_this<CompileUnit>, /// Return the primary source spec associated with this compile unit. const FileSpec &GetPrimaryFile() const { - return m_primary_support_file_sp->GetSpecOnly(); + return m_primary_support_file_nsp->GetSpecOnly(); } /// Return the primary source file associated with this compile unit. - SupportFileSP GetPrimarySupportFile() const { - return m_primary_support_file_sp; + SupportFileNSP GetPrimarySupportFile() const { + return m_primary_support_file_nsp; } /// Get the line table for the compile unit. @@ -430,7 +430,7 @@ class CompileUnit : public std::enable_shared_from_this<CompileUnit>, /// compile unit. std::vector<SourceModule> m_imported_modules; /// The primary file associated with this compile unit. - SupportFileSP m_primary_support_file_sp; + SupportFileNSP m_primary_support_file_nsp; /// Files associated with this compile unit's line table and declarations. SupportFileList m_support_files; /// Line table that will get parsed on demand. diff --git a/lldb/include/lldb/Symbol/Function.h b/lldb/include/lldb/Symbol/Function.h index a683f1452a21f..57bd509b26824 100644 --- a/lldb/include/lldb/Symbol/Function.h +++ b/lldb/include/lldb/Symbol/Function.h @@ -469,11 +469,12 @@ class Function : public UserID, public SymbolContextScope { /// /// \param[out] line_no /// The line number. - void GetStartLineSourceInfo(SupportFileSP &source_file_sp, uint32_t &line_no); + void GetStartLineSourceInfo(SupportFileNSP &source_file_sp, + uint32_t &line_no); using SourceRange = Range<uint32_t, uint32_t>; /// Find the file and line number range of the function. - llvm::Expected<std::pair<SupportFileSP, SourceRange>> GetSourceInfo(); + llvm::Expected<std::pair<SupportFileNSP, SourceRange>> GetSourceInfo(); /// Get the outgoing call edges from this function, sorted by their return /// PC addresses (in increasing order). diff --git a/lldb/include/lldb/Symbol/LineEntry.h b/lldb/include/lldb/Symbol/LineEntry.h index c6b414cb9659c..a61b72f253dd7 100644 --- a/lldb/include/lldb/Symbol/LineEntry.h +++ b/lldb/include/lldb/Symbol/LineEntry.h @@ -137,10 +137,10 @@ struct LineEntry { AddressRange range; /// The source file, possibly mapped by the target.source-map setting. - SupportFileSP file_sp; + SupportFileNSP file_sp; /// The original source file, from debug info. - SupportFileSP original_file_sp; + SupportFileNSP original_file_sp; /// The source line number, or LLDB_INVALID_LINE_NUMBER if there is no line /// number information. diff --git a/lldb/include/lldb/Utility/FileSpecList.h b/lldb/include/lldb/Utility/FileSpecList.h index 1ebdf3969f2c6..b565c2ab7f762 100644 --- a/lldb/include/lldb/Utility/FileSpecList.h +++ b/lldb/include/lldb/Utility/FileSpecList.h @@ -41,7 +41,7 @@ class SupportFileList { bool AppendIfUnique(const FileSpec &file); size_t GetSize() const { return m_files.size(); } const FileSpec &GetFileSpecAtIndex(size_t idx) const; - SupportFileSP GetSupportFileAtIndex(size_t idx) const; + SupportFileNSP GetSupportFileAtIndex(size_t idx) const; size_t FindFileIndex(size_t idx, const FileSpec &file, bool full) const; /// Find a compatible file index. /// diff --git a/lldb/include/lldb/Utility/SupportFile.h b/lldb/include/lldb/Utility/SupportFile.h index 4bc898906ea35..edc327dfd9010 100644 --- a/lldb/include/lldb/Utility/SupportFile.h +++ b/lldb/include/lldb/Utility/SupportFile.h @@ -77,7 +77,7 @@ class SupportFile { const Checksum m_checksum; }; -typedef NonNullSharedPtr<lldb_private::SupportFile> SupportFileSP; +typedef NonNullSharedPtr<lldb_private::SupportFile> SupportFileNSP; } // namespace lldb_private diff --git a/lldb/source/Breakpoint/BreakpointResolverFileLine.cpp b/lldb/source/Breakpoint/BreakpointResolverFileLine.cpp index 8eef0e3ed1364..cef1ef1b08fe0 100644 --- a/lldb/source/Breakpoint/BreakpointResolverFileLine.cpp +++ b/lldb/source/Breakpoint/BreakpointResolverFileLine.cpp @@ -139,7 +139,7 @@ void BreakpointResolverFileLine::FilterContexts(SymbolContextList &sc_list) { if (!sc.block) continue; - SupportFileSP file_sp = std::make_shared<SupportFile>(); + SupportFileNSP file_sp = std::make_shared<SupportFile>(); uint32_t line; const Block *inline_block = sc.block->GetContainingInlinedBlock(); if (inline_block) { diff --git a/lldb/source/Commands/CommandObjectBreakpoint.cpp b/lldb/source/Commands/CommandObjectBreakpoint.cpp index 5a5512610cd33..1fc305fc3170c 100644 --- a/lldb/source/Commands/CommandObjectBreakpoint.cpp +++ b/lldb/source/Commands/CommandObjectBreakpoint.cpp @@ -795,7 +795,7 @@ class CommandObjectBreakpointSet : public CommandObjectParsed { // frame's file. if (auto maybe_file_and_line = target.GetSourceManager().GetDefaultFileAndLine()) { - file = maybe_file_and_line->support_file_sp->GetSpecOnly(); + file = maybe_file_and_line->support_file_nsp->GetSpecOnly(); return true; } diff --git a/lldb/source/Commands/CommandObjectSource.cpp b/lldb/source/Commands/CommandObjectSource.cpp index b280e0536b2cf..c9835e74ac51b 100644 --- a/lldb/source/Commands/CommandObjectSource.cpp +++ b/lldb/source/Commands/CommandObjectSource.cpp @@ -777,7 +777,7 @@ class CommandObjectSourceList : public CommandObjectParsed { if (sc.function) { Target &target = GetTarget(); - SupportFileSP start_file = std::make_shared<SupportFile>(); + SupportFileNSP start_file = std::make_shared<SupportFile>(); uint32_t start_line; uint32_t end_line; FileSpec end_file; @@ -1194,7 +1194,7 @@ class CommandObjectSourceList : public CommandObjectParsed { // file(s) will be found and assigned to // sc.comp_unit->GetPrimarySupportFile, which is NOT what we want to // print. Instead, we want to print the one from the line entry. - SupportFileSP found_file_sp = sc.line_entry.file_sp; + SupportFileNSP found_file_sp = sc.line_entry.file_sp; target.GetSourceManager().DisplaySourceLinesWithLineNumbers( found_file_sp, m_options.start_line, column, 0, diff --git a/lldb/source/Core/Disassembler.cpp b/lldb/source/Core/Disassembler.cpp index 19b50f527b613..06d2a3de62736 100644 --- a/lldb/source/Core/Disassembler.cpp +++ b/lldb/source/Core/Disassembler.cpp @@ -208,7 +208,7 @@ Disassembler::GetFunctionDeclLineEntry(const SymbolContext &sc) { return {}; LineEntry prologue_end_line = sc.line_entry; - SupportFileSP func_decl_file_sp = std::make_shared<SupportFile>(); + SupportFileNSP func_decl_file_sp = std::make_shared<SupportFile>(); uint32_t func_decl_line; sc.function->GetStartLineSourceInfo(func_decl_file_sp, func_decl_line); @@ -539,7 +539,7 @@ void Disassembler::PrintInstructions(Debugger &debugger, const ArchSpec &arch, LineEntry prologue_end_line = sc.line_entry; if (!ElideMixedSourceAndDisassemblyLine(exe_ctx, sc, prologue_end_line)) { - SupportFileSP func_decl_file_sp = + SupportFileNSP func_decl_file_sp = std::make_shared<SupportFile>(); uint32_t func_decl_line; sc.function->GetStartLineSourceInfo(func_decl_file_sp, diff --git a/lldb/source/Core/SourceManager.cpp b/lldb/source/Core/SourceManager.cpp index d50ea2d980aab..c60288c633e4c 100644 --- a/lldb/source/Core/SourceManager.cpp +++ b/lldb/source/Core/SourceManager.cpp @@ -70,22 +70,20 @@ static std::string toString(const Checksum &checksum) { // SourceManager constructor SourceManager::SourceManager(const TargetSP &target_sp) - : m_last_support_file_sp(std::make_shared<SupportFile>()), m_last_line(0), + : m_last_support_file_nsp(std::make_shared<SupportFile>()), m_last_line(0), m_last_count(0), m_default_set(false), m_target_wp(target_sp), m_debugger_wp(target_sp->GetDebugger().shared_from_this()) {} SourceManager::SourceManager(const DebuggerSP &debugger_sp) - : m_last_support_file_sp(std::make_shared<SupportFile>()), m_last_line(0), + : m_last_support_file_nsp(std::make_shared<SupportFile>()), m_last_line(0), m_last_count(0), m_default_set(false), m_target_wp(), m_debugger_wp(debugger_sp) {} // Destructor SourceManager::~SourceManager() = default; -SourceManager::FileSP SourceManager::GetFile(SupportFileSP support_file_sp) { - assert(support_file_sp && "SupportFileSP must be valid"); - - FileSpec file_spec = support_file_sp->GetSpecOnly(); +SourceManager::FileSP SourceManager::GetFile(SupportFileNSP support_file_nsp) { + FileSpec file_spec = support_file_nsp->GetSpecOnly(); if (!file_spec) return {}; @@ -98,8 +96,8 @@ SourceManager::FileSP SourceManager::GetFile(SupportFileSP support_file_sp) { LLDB_LOG(log, "Source file caching disabled: creating new source file: {0}", file_spec); if (target_sp) - return std::make_shared<File>(support_file_sp, target_sp); - return std::make_shared<File>(support_file_sp, debugger_sp); + return std::make_shared<File>(support_file_nsp, target_sp); + return std::make_shared<File>(support_file_nsp, debugger_sp); } ProcessSP process_sp = target_sp ? target_sp->GetProcessSP() : ProcessSP(); @@ -160,9 +158,9 @@ SourceManager::FileSP SourceManager::GetFile(SupportFileSP support_file_sp) { // (Re)create the file. if (target_sp) - file_sp = std::make_shared<File>(support_file_sp, target_sp); + file_sp = std::make_shared<File>(support_file_nsp, target_sp); else - file_sp = std::make_shared<File>(support_file_sp, debugger_sp); + file_sp = std::make_shared<File>(support_file_nsp, debugger_sp); // Add the file to the debugger and process cache. If the file was // invalidated, this will overwrite it. @@ -326,12 +324,12 @@ size_t SourceManager::DisplaySourceLinesWithLineNumbersUsingLastFile( } size_t SourceManager::DisplaySourceLinesWithLineNumbers( - SupportFileSP support_file_sp, uint32_t line, uint32_t column, + SupportFileNSP support_file_nsp, uint32_t line, uint32_t column, uint32_t context_before, uint32_t context_after, const char *current_line_cstr, Stream *s, const SymbolContextList *bp_locs) { - assert(support_file_sp && "SupportFile must be valid"); - FileSP file_sp(GetFile(support_file_sp)); + assert(support_file_nsp && "SupportFile must be valid"); + FileSP file_sp(GetFile(support_file_nsp)); uint32_t start_line; uint32_t count = context_before + context_after + 1; @@ -344,7 +342,7 @@ size_t SourceManager::DisplaySourceLinesWithLineNumbers( if (last_file_sp.get() != file_sp.get()) { if (line == 0) m_last_line = 0; - m_last_support_file_sp = support_file_sp; + m_last_support_file_nsp = support_file_nsp; } return DisplaySourceLinesWithLineNumbersUsingLastFile( @@ -390,15 +388,15 @@ size_t SourceManager::DisplayMoreWithLineNumbers( return 0; } -bool SourceManager::SetDefaultFileAndLine(SupportFileSP support_file_sp, +bool SourceManager::SetDefaultFileAndLine(SupportFileNSP support_file_nsp, uint32_t line) { - assert(support_file_sp && "SupportFile must be valid"); + assert(support_file_nsp && "SupportFile must be valid"); m_default_set = true; - if (FileSP file_sp = GetFile(support_file_sp)) { + if (FileSP file_sp = GetFile(support_file_nsp)) { m_last_line = line; - m_last_support_file_sp = support_file_sp; + m_last_support_file_nsp = support_file_nsp; return true; } @@ -408,7 +406,7 @@ bool SourceManager::SetDefaultFileAndLine(SupportFileSP support_file_sp, std::optional<SourceManager::SupportFileAndLine> SourceManager::GetDefaultFileAndLine() { if (FileSP last_file_sp = GetLastFile()) - return SupportFileAndLine(m_last_support_file_sp, m_last_line); + return SupportFileAndLine(m_last_support_file_nsp, m_last_line); if (!m_default_set) { TargetSP target_sp(m_target_wp.lock()); @@ -447,36 +445,36 @@ SourceManager::GetDefaultFileAndLine() { return std::nullopt; } -void SourceManager::FindLinesMatchingRegex(SupportFileSP support_file_sp, +void SourceManager::FindLinesMatchingRegex(SupportFileNSP support_file_nsp, RegularExpression ®ex, uint32_t start_line, uint32_t end_line, std::vector<uint32_t> &match_lines) { match_lines.clear(); - FileSP file_sp = GetFile(support_file_sp); + FileSP file_sp = GetFile(support_file_nsp); if (!file_sp) return; return file_sp->FindLinesMatchingRegex(regex, start_line, end_line, match_lines); } -SourceManager::File::File(SupportFileSP support_file_sp, +SourceManager::File::File(SupportFileNSP support_file_nsp, lldb::DebuggerSP debugger_sp) - : m_support_file_sp(std::make_shared<SupportFile>()), m_checksum(), + : m_support_file_nsp(std::make_shared<SupportFile>()), m_checksum(), m_mod_time(), m_debugger_wp(debugger_sp), m_target_wp(TargetSP()) { - CommonInitializer(support_file_sp, {}); + CommonInitializer(support_file_nsp, {}); } -SourceManager::File::File(SupportFileSP support_file_sp, TargetSP target_sp) - : m_support_file_sp(std::make_shared<SupportFile>()), m_checksum(), +SourceManager::File::File(SupportFileNSP support_file_nsp, TargetSP target_sp) + : m_support_file_nsp(std::make_shared<SupportFile>()), m_checksum(), m_mod_time(), m_debugger_wp(target_sp ? target_sp->GetDebugger().shared_from_this() : DebuggerSP()), m_target_wp(target_sp) { - CommonInitializer(support_file_sp, target_sp); + CommonInitializer(support_file_nsp, target_sp); } -void SourceManager::File::CommonInitializer(SupportFileSP support_file_sp, +void SourceManager::File::CommonInitializer(SupportFileNSP support_file_nsp, TargetSP target_sp) { // It might take a while to read a source file, for example because it's // coming from a virtual file system that's fetching the data on demand. When @@ -485,23 +483,23 @@ void SourceManager::File::CommonInitializer(SupportFileSP support_file_sp, static constexpr auto g_progress_delay = std::chrono::milliseconds(500); std::future<void> future = std::async(std::launch::async, [=]() { - CommonInitializerImpl(support_file_sp, target_sp); + CommonInitializerImpl(support_file_nsp, target_sp); }); std::optional<Progress> progress; if (future.wait_for(g_progress_delay) == std::future_status::timeout) { Debugger *debugger = target_sp ? &target_sp->GetDebugger() : nullptr; progress.emplace("Loading source file", - support_file_sp->GetSpecOnly().GetFilename().GetString(), + support_file_nsp->GetSpecOnly().GetFilename().GetString(), 1, debugger); } future.wait(); } -void SourceManager::File::CommonInitializerImpl(SupportFileSP support_file_sp, +void SourceManager::File::CommonInitializerImpl(SupportFileNSP support_file_nsp, TargetSP target_sp) { // Set the file and update the modification time. - SetSupportFile(support_file_sp); + SetSupportFile(support_file_nsp); // Always update the source map modification ID if we have a target. if (target_sp) @@ -512,7 +510,7 @@ void SourceManager::File::CommonInitializerImpl(SupportFileSP support_file_sp, if (target_sp) { // If this is just a file name, try finding it in the target. { - FileSpec file_spec = support_file_sp->GetSpecOnly(); + FileSpec file_spec = support_file_nsp->GetSpecOnly(); if (!file_spec.GetDirectory() && file_spec.GetFilename()) { bool check_inlines = false; SymbolContextList sc_list; @@ -549,7 +547,7 @@ void SourceManager::File::CommonInitializerImpl(SupportFileSP support_file_sp, // Try remapping the file if it doesn't exist. { - FileSpec file_spec = support_file_sp->GetSpecOnly(); + FileSpec file_spec = support_file_nsp->GetSpecOnly(); if (!FileSystem::Instance().Exists(file_spec)) { // Check target specific source remappings (i.e., the // target.source-map setting), then fall back to the module @@ -562,7 +560,7 @@ void SourceManager::File::CommonInitializerImpl(SupportFileSP support_file_sp, } if (remapped) SetSupportFile(std::make_shared<SupportFile>( - *remapped, support_file_sp->GetChecksum())); + *remapped, support_file_nsp->GetChecksum())); } } } @@ -571,16 +569,16 @@ void SourceManager::File::CommonInitializerImpl(SupportFileSP support_file_sp, // If the file exists, read in the data. if (m_mod_time != llvm::sys::TimePoint<>()) { m_data_sp = FileSystem::Instance().CreateDataBuffer( - m_support_file_sp->GetSpecOnly()); + m_support_file_nsp->GetSpecOnly()); m_checksum = llvm::MD5::hash(m_data_sp->GetData()); } } -void SourceManager::File::SetSupportFile(SupportFileSP support_file_sp) { - FileSpec file_spec = support_file_sp->GetSpecOnly(); +void SourceManager::File::SetSupportFile(SupportFileNSP support_file_nsp) { + FileSpec file_spec = support_file_nsp->GetSpecOnly(); resolve_tilde(file_spec); - m_support_file_sp = - std::make_shared<SupportFile>(file_spec, support_file_sp->GetChecksum()); + m_support_file_nsp = + std::make_shared<SupportFile>(file_spec, support_file_nsp->GetChecksum()); m_mod_time = FileSystem::Instance().GetModificationTime(file_spec); } @@ -655,7 +653,7 @@ bool SourceManager::File::ModificationTimeIsStale() const { // source cache and only update when we determine a file has been updated. // For now we check each time we want to display info for the file. auto curr_mod_time = FileSystem::Instance().GetModificationTime( - m_support_file_sp->GetSpecOnly()); + m_support_file_nsp->GetSpecOnly()); return curr_mod_time != llvm::sys::TimePoint<>() && m_mod_time != curr_mod_time; } diff --git a/lldb/source/Expression/REPL.cpp b/lldb/source/Expression/REPL.cpp index 92017d271a2df..c6cf6d87a7220 100644 --- a/lldb/source/Expression/REPL.cpp +++ b/lldb/source/Expression/REPL.cpp @@ -615,6 +615,6 @@ Status REPL::RunLoop() { // Restore the default file and line if (default_file_line) m_target.GetSourceManager().SetDefaultFileAndLine( - default_file_line->support_file_sp, default_file_line->line); + default_file_line->support_file_nsp, default_file_line->line); return error; } diff --git a/lldb/source/Plugins/SymbolFile/DWARF/SymbolFileDWARF.cpp b/lldb/source/Plugins/SymbolFile/DWARF/SymbolFileDWARF.cpp index ff0aa3e6e4257..35c63129b71f2 100644 --- a/lldb/source/Plugins/SymbolFile/DWARF/SymbolFileDWARF.cpp +++ b/lldb/source/Plugins/SymbolFile/DWARF/SymbolFileDWARF.cpp @@ -794,12 +794,12 @@ lldb::CompUnitSP SymbolFileDWARF::ParseCompileUnit(DWARFCompileUnit &dwarf_cu) { } else { ModuleSP module_sp(m_objfile_sp->GetModule()); if (module_sp) { - auto initialize_cu = [&](SupportFileSP support_file_sp, + auto initialize_cu = [&](SupportFileNSP support_file_nsp, LanguageType cu_language, SupportFileList &&support_files = {}) { BuildCuTranslationTable(); cu_sp = std::make_shared<CompileUnit>( - module_sp, &dwarf_cu, support_file_sp, + module_sp, &dwarf_cu, support_file_nsp, *GetDWARFUnitIndex(dwarf_cu.GetID()), cu_language, eLazyBoolCalculate, std::move(support_files)); diff --git a/lldb/source/Symbol/CompileUnit.cpp b/lldb/source/Symbol/CompileUnit.cpp index c23b7c4a6a5cb..703ef131ad6bf 100644 --- a/lldb/source/Symbol/CompileUnit.cpp +++ b/lldb/source/Symbol/CompileUnit.cpp @@ -27,14 +27,14 @@ CompileUnit::CompileUnit(const lldb::ModuleSP &module_sp, void *user_data, language, is_optimized) {} CompileUnit::CompileUnit(const lldb::ModuleSP &module_sp, void *user_data, - SupportFileSP support_file_sp, + SupportFileNSP support_file_nsp, const lldb::user_id_t cu_sym_id, lldb::LanguageType language, lldb_private::LazyBool is_optimized, SupportFileList &&support_files) : ModuleChild(module_sp), UserID(cu_sym_id), m_user_data(user_data), m_language(language), m_flags(0), - m_primary_support_file_sp(support_file_sp), + m_primary_support_file_nsp(support_file_nsp), m_support_files(std::move(support_files)), m_is_optimized(is_optimized) { if (language != eLanguageTypeUnknown) m_flags.Set(flagsParsedLanguage); diff --git a/lldb/source/Symbol/Function.cpp b/lldb/source/Symbol/Function.cpp index 8b50f3c519184..11b823c8c53d6 100644 --- a/lldb/source/Symbol/Function.cpp +++ b/lldb/source/Symbol/Function.cpp @@ -272,7 +272,7 @@ Function::Function(CompileUnit *comp_unit, lldb::user_id_t func_uid, Function::~Function() = default; -void Function::GetStartLineSourceInfo(SupportFileSP &source_file_sp, +void Function::GetStartLineSourceInfo(SupportFileNSP &source_file_sp, uint32_t &line_no) { line_no = 0; source_file_sp = std::make_shared<SupportFile>(); @@ -300,9 +300,9 @@ void Function::GetStartLineSourceInfo(SupportFileSP &source_file_sp, } } -llvm::Expected<std::pair<SupportFileSP, Function::SourceRange>> +llvm::Expected<std::pair<SupportFileNSP, Function::SourceRange>> Function::GetSourceInfo() { - SupportFileSP source_file_sp = std::make_shared<SupportFile>(); + SupportFileNSP source_file_sp = std::make_shared<SupportFile>(); uint32_t start_line; GetStartLineSourceInfo(source_file_sp, start_line); LineTable *line_table = m_comp_unit->GetLineTable(); diff --git a/lldb/source/Symbol/LineTable.cpp b/lldb/source/Symbol/LineTable.cpp index 6e441bf562f6f..ae2abf5befb48 100644 --- a/lldb/source/Symbol/LineTable.cpp +++ b/lldb/source/Symbol/LineTable.cpp @@ -327,7 +327,7 @@ void LineTable::Dump(Stream *s, Target *target, Address::DumpStyle style, Address::DumpStyle fallback_style, bool show_line_ranges) { const size_t count = m_entries.size(); LineEntry line_entry; - SupportFileSP prev_file = std::make_shared<SupportFile>(); + SupportFileNSP prev_file = std::make_shared<SupportFile>(); for (size_t idx = 0; idx < count; ++idx) { ConvertEntryAtIndexToLineEntry(idx, line_entry); line_entry.Dump(s, target, !prev_file->Equal(*line_entry.original_file_sp), diff --git a/lldb/source/Target/StackFrame.cpp b/lldb/source/Target/StackFrame.cpp index 95b515412d693..78f67d21d6600 100644 --- a/lldb/source/Target/StackFrame.cpp +++ b/lldb/source/Target/StackFrame.cpp @@ -2057,7 +2057,7 @@ bool StackFrame::GetStatus(Stream &strm, bool show_frame_info, bool show_source, if (m_sc.comp_unit && m_sc.line_entry.IsValid()) { have_debuginfo = true; if (source_lines_before > 0 || source_lines_after > 0) { - SupportFileSP source_file_sp = m_sc.line_entry.file_sp; + SupportFileNSP source_file_sp = m_sc.line_entry.file_sp; uint32_t start_line = m_sc.line_entry.line; if (!start_line && m_sc.function) { m_sc.function->GetStartLineSourceInfo(source_file_sp, start_line); diff --git a/lldb/source/Utility/FileSpecList.cpp b/lldb/source/Utility/FileSpecList.cpp index bd7d587d3386c..8aa0820bd78d0 100644 --- a/lldb/source/Utility/FileSpecList.cpp +++ b/lldb/source/Utility/FileSpecList.cpp @@ -45,7 +45,7 @@ bool FileSpecList::AppendIfUnique(const FileSpec &file_spec) { // FIXME: Replace this with a DenseSet at the call site. It is inefficient. bool SupportFileList::AppendIfUnique(const FileSpec &file_spec) { collection::iterator end = m_files.end(); - if (find_if(m_files.begin(), end, [&](const SupportFileSP &support_file) { + if (find_if(m_files.begin(), end, [&](const SupportFileNSP &support_file) { return support_file->GetSpecOnly() == file_spec; }) == end) { Append(file_spec); @@ -213,7 +213,7 @@ const FileSpec &SupportFileList::GetFileSpecAtIndex(size_t idx) const { return g_empty_file_spec; } -SupportFileSP SupportFileList::GetSupportFileAtIndex(size_t idx) const { +SupportFileNSP SupportFileList::GetSupportFileAtIndex(size_t idx) const { if (idx < m_files.size()) return m_files[idx]; return std::make_shared<SupportFile>(); diff --git a/lldb/unittests/Symbol/LineTableTest.cpp b/lldb/unittests/Symbol/LineTableTest.cpp index eadab40a37fac..1c575ee09db0e 100644 --- a/lldb/unittests/Symbol/LineTableTest.cpp +++ b/lldb/unittests/Symbol/LineTableTest.cpp @@ -177,7 +177,7 @@ CreateFakeModule(std::vector<LineTable::Sequence> line_sequences) { return createStringError("No .text"); auto cu_up = std::make_unique<CompileUnit>(module_sp, /*user_data=*/nullptr, - /*support_file_sp=*/nullptr, + /*support_file_nsp=*/nullptr, /*uid=*/0, eLanguageTypeC, /*is_optimized=*/eLazyBoolNo); LineTable *line_table = new LineTable(cu_up.get(), std::move(line_sequences)); _______________________________________________ lldb-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
