[LLDB][SaveCore] Add SBSaveCoreOptions Object, and SBProcess::SaveCore() overload #98403
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| //===-- SBCoreDumpOptions.h -------------------------------------*- C++ -*-===// | ||
| // | ||
| // 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_API_SBCOREDUMPOPTIONS_H | ||
| #define LLDB_API_SBCOREDUMPOPTIONS_H | ||
|
|
||
| #include "lldb/API/SBDefines.h" | ||
| #include "lldb/Symbol/CoreDumpOptions.h" | ||
|
|
||
| namespace lldb { | ||
|
|
||
| class LLDB_API SBCoreDumpOptions { | ||
| public: | ||
| SBCoreDumpOptions(const char *filePath); | ||
|
||
| SBCoreDumpOptions(const lldb::SBCoreDumpOptions &rhs); | ||
| ~SBCoreDumpOptions() = default; | ||
|
|
||
| const SBCoreDumpOptions &operator=(const lldb::SBCoreDumpOptions &rhs); | ||
|
|
||
| /// Set the Core dump plugin name. | ||
| /// | ||
| /// \param plugin Name of the object file plugin. | ||
| void SetCoreDumpPluginName(const char *plugin); | ||
Jlalond marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Jlalond marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| /// Get the Core dump plugin name, if set. | ||
| /// | ||
| /// \return The name of the plugin, or nullopt if not set. | ||
| const std::optional<const char *> GetCoreDumpPluginName() const; | ||
|
||
|
|
||
| /// Set the Core dump style. | ||
| /// | ||
| /// \param style The style of the core dump. | ||
| void SetCoreDumpStyle(lldb::SaveCoreStyle style); | ||
|
|
||
| /// Get the Core dump style, if set. | ||
| /// | ||
| /// \return The core dump style, or nullopt if not set. | ||
| const std::optional<lldb::SaveCoreStyle> GetCoreDumpStyle() const; | ||
|
||
|
|
||
| /// Get the output file path | ||
| /// | ||
| /// \return The output file path. | ||
| const char *GetOutputFile() const; | ||
|
||
|
|
||
| protected: | ||
| friend class SBProcess; | ||
| lldb_private::CoreDumpOptions &Ref() const; | ||
Jlalond marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| private: | ||
| std::unique_ptr<lldb_private::CoreDumpOptions> m_opaque_up; | ||
| }; // SBCoreDumpOptions | ||
| } // namespace lldb | ||
|
|
||
| #endif // LLDB_API_SBCOREDUMPOPTIONS_H | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| //===-- CoreDumpOptions.h ---------------------------------------*- C++ -*-===// | ||
| // | ||
| // 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_SOURCE_PLUGINS_OBJECTFILE_COREDUMPOPTIONS_H | ||
| #define LLDB_SOURCE_PLUGINS_OBJECTFILE_COREDUMPOPTIONS_H | ||
|
|
||
| #include "lldb/Utility/FileSpec.h" | ||
| #include "lldb/lldb-forward.h" | ||
| #include "lldb/lldb-types.h" | ||
|
|
||
| #include <optional> | ||
| #include <string> | ||
|
|
||
| namespace lldb_private { | ||
|
|
||
| class CoreDumpOptions { | ||
|
||
| public: | ||
| CoreDumpOptions(const lldb_private::FileSpec &fspec) | ||
|
||
| : m_core_dump_file(std::move(fspec)){}; | ||
| ~CoreDumpOptions() = default; | ||
|
|
||
| void SetCoreDumpPluginName(llvm::StringRef name); | ||
| std::optional<llvm::StringRef> GetCoreDumpPluginName() const; | ||
|
||
|
|
||
| void SetCoreDumpStyle(lldb::SaveCoreStyle style); | ||
| lldb::SaveCoreStyle GetCoreDumpStyle() const; | ||
|
|
||
| const lldb_private::FileSpec &GetOutputFile() const; | ||
|
||
|
|
||
| private: | ||
| std::optional<std::string> m_core_dump_plugin_name; | ||
|
||
| const lldb_private::FileSpec m_core_dump_file; | ||
|
||
| lldb::SaveCoreStyle m_core_dump_style = lldb::eSaveCoreUnspecified; | ||
|
||
| }; | ||
| } // namespace lldb_private | ||
|
|
||
| #endif // LLDB_SOURCE_PLUGINS_OBJECTFILE_COREDUMPOPTIONS_H | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| //===-- SBCoreDumpOptions.cpp -----------------------------------*- C++ -*-===// | ||
| // | ||
| // 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/SBCoreDumpOptions.h" | ||
| #include "lldb/Host/FileSystem.h" | ||
| #include "lldb/Symbol/CoreDumpOptions.h" | ||
| #include "lldb/Utility/Instrumentation.h" | ||
|
|
||
| #include "Utils.h" | ||
|
|
||
| using namespace lldb; | ||
|
|
||
| SBCoreDumpOptions::SBCoreDumpOptions(const char *filePath) { | ||
| LLDB_INSTRUMENT_VA(this, filePath); | ||
| lldb_private::FileSpec fspec(filePath); | ||
| lldb_private::FileSystem::Instance().Resolve(fspec); | ||
| m_opaque_up = std::make_unique<lldb_private::CoreDumpOptions>(fspec); | ||
| } | ||
|
|
||
| SBCoreDumpOptions::SBCoreDumpOptions(const SBCoreDumpOptions &rhs) { | ||
| LLDB_INSTRUMENT_VA(this, rhs); | ||
|
|
||
| m_opaque_up = clone(rhs.m_opaque_up); | ||
| } | ||
|
|
||
| const SBCoreDumpOptions & | ||
| SBCoreDumpOptions::operator=(const SBCoreDumpOptions &rhs) { | ||
| LLDB_INSTRUMENT_VA(this, rhs); | ||
|
|
||
| if (this != &rhs) | ||
| m_opaque_up = clone(rhs.m_opaque_up); | ||
| return *this; | ||
| } | ||
|
|
||
| void SBCoreDumpOptions::SetCoreDumpPluginName(const char *name) { | ||
| m_opaque_up->SetCoreDumpPluginName(name); | ||
| } | ||
|
|
||
| void SBCoreDumpOptions::SetCoreDumpStyle(lldb::SaveCoreStyle style) { | ||
| m_opaque_up->SetCoreDumpStyle(style); | ||
| } | ||
|
|
||
| const std::optional<const char *> | ||
| SBCoreDumpOptions::GetCoreDumpPluginName() const { | ||
| const auto &name = m_opaque_up->GetCoreDumpPluginName(); | ||
|
||
| if (name->empty()) | ||
| return std::nullopt; | ||
| return name->data(); | ||
| } | ||
|
|
||
| const char *SBCoreDumpOptions::GetOutputFile() const { | ||
| return m_opaque_up->GetOutputFile().GetFilename().AsCString(); | ||
| } | ||
|
||
|
|
||
| const std::optional<lldb::SaveCoreStyle> | ||
|
||
| SBCoreDumpOptions::GetCoreDumpStyle() const { | ||
| return m_opaque_up->GetCoreDumpStyle(); | ||
| } | ||
|
|
||
| lldb_private::CoreDumpOptions &SBCoreDumpOptions::Ref() const { | ||
| return *m_opaque_up.get(); | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we change the name to
SBSaveCoreOptions?SBCoreDumpOptionsseems like they would be used to dump a core dump to the terminal?