Skip to content

Commit 63a343d

Browse files
JlalondJlalond
committed
Reapply "[LLDB][SBSaveCore] Add selectable memory regions to SBSaveCor… (#106293)
This reverts commit b959532.
1 parent 18cf14e commit 63a343d

20 files changed

+304
-31
lines changed

‎lldb/include/lldb/API/SBMemoryRegionInfo.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ class LLDB_API SBMemoryRegionInfo {
120120
private:
121121
friend class SBProcess;
122122
friend class SBMemoryRegionInfoList;
123-
123+
friend class SBSaveCoreOptions;
124124
friend class lldb_private::ScriptInterpreter;
125125

126126
lldb_private::MemoryRegionInfo &ref();

‎lldb/include/lldb/API/SBSaveCoreOptions.h

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,17 @@ class LLDB_API SBSaveCoreOptions {
8080
/// \return True if the thread was removed, false if it was not in the list.
8181
bool RemoveThread(lldb::SBThread thread);
8282

83+
/// Add a memory region to save in the core file.
84+
///
85+
/// \param region The memory region to save.
86+
/// \returns An empty SBError upon success, or an error if the region is
87+
/// invalid.
88+
/// \note Ranges that overlapped will be unioned into a single region, this
89+
/// also supercedes stack minification. Specifying full regions and a
90+
/// non-custom core style will include the specified regions and union them
91+
/// with all style specific regions.
92+
SBError AddMemoryRegionToSave(const SBMemoryRegionInfo &region);
93+
8394
/// Reset all options.
8495
void Clear();
8596

‎lldb/include/lldb/Symbol/SaveCoreOptions.h

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,15 @@
1010
#define LLDB_SOURCE_PLUGINS_OBJECTFILE_SaveCoreOPTIONS_H
1111

1212
#include "lldb/Utility/FileSpec.h"
13-
#include "lldb/lldb-forward.h"
14-
#include "lldb/lldb-types.h"
13+
#include "lldb/Utility/RangeMap.h"
1514

1615
#include <optional>
16+
#include <set>
1717
#include <string>
1818
#include <unordered_set>
1919

20+
using MemoryRanges = lldb_private::RangeVector<lldb::addr_t, lldb::addr_t>;
21+
2022
namespace lldb_private {
2123

2224
class SaveCoreOptions {
@@ -38,8 +40,12 @@ class SaveCoreOptions {
3840
Status AddThread(lldb::ThreadSP thread_sp);
3941
bool RemoveThread(lldb::ThreadSP thread_sp);
4042
bool ShouldThreadBeSaved(lldb::tid_t tid) const;
43+
bool HasSpecifiedThreads() const;
4144

4245
Status EnsureValidConfiguration(lldb::ProcessSP process_sp) const;
46+
const MemoryRanges &GetCoreFileMemoryRanges() const;
47+
48+
void AddMemoryRegionToSave(const lldb_private::MemoryRegionInfo &region);
4349

4450
void Clear();
4551

@@ -51,6 +57,7 @@ class SaveCoreOptions {
5157
std::optional<lldb::SaveCoreStyle> m_style;
5258
lldb::ProcessSP m_process_sp;
5359
std::unordered_set<lldb::tid_t> m_threads_to_save;
60+
MemoryRanges m_regions_to_save;
5461
};
5562
} // namespace lldb_private
5663

‎lldb/include/lldb/Target/Process.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
#include "lldb/Host/ProcessLaunchInfo.h"
3636
#include "lldb/Host/ProcessRunLock.h"
3737
#include "lldb/Symbol/ObjectFile.h"
38+
#include "lldb/Symbol/SaveCoreOptions.h"
3839
#include "lldb/Target/ExecutionContextScope.h"
3940
#include "lldb/Target/InstrumentationRuntime.h"
4041
#include "lldb/Target/Memory.h"
@@ -731,7 +732,9 @@ class Process : public std::enable_shared_from_this<Process>,
731732
}
732733
};
733734

734-
using CoreFileMemoryRanges = std::vector<CoreFileMemoryRange>;
735+
using CoreFileMemoryRanges =
736+
lldb_private::RangeDataVector<lldb::addr_t, lldb::addr_t,
737+
CoreFileMemoryRange>;
735738

736739
/// Helper function for Process::SaveCore(...) that calculates the address
737740
/// ranges that should be saved. This allows all core file plug-ins to save

‎lldb/include/lldb/Utility/RangeMap.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -450,6 +450,8 @@ class RangeDataVector {
450450

451451
void Append(const Entry &entry) { m_entries.emplace_back(entry); }
452452

453+
void Append(B &&b, S &&s, T &&t) { m_entries.emplace_back(Entry(b, s, t)); }
454+
453455
bool Erase(uint32_t start, uint32_t end) {
454456
if (start >= end || end > m_entries.size())
455457
return false;

‎lldb/include/lldb/lldb-enumerations.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1222,6 +1222,7 @@ enum SaveCoreStyle {
12221222
eSaveCoreFull = 1,
12231223
eSaveCoreDirtyOnly = 2,
12241224
eSaveCoreStackOnly = 3,
1225+
eSaveCoreCustomOnly = 4,
12251226
};
12261227

12271228
/// Events that might happen during a trace session.

‎lldb/include/lldb/lldb-forward.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,7 @@ class StackFrameRecognizer;
207207
class StackFrameRecognizerManager;
208208
class StackID;
209209
class Status;
210+
class SaveCoreOptions;
210211
class StopInfo;
211212
class Stoppoint;
212213
class StoppointCallbackContext;

‎lldb/include/lldb/lldb-private-interfaces.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
#ifndef LLDB_LLDB_PRIVATE_INTERFACES_H
1010
#define LLDB_LLDB_PRIVATE_INTERFACES_H
1111

12-
#include "lldb/Symbol/SaveCoreOptions.h"
1312
#include "lldb/lldb-enumerations.h"
1413
#include "lldb/lldb-forward.h"
1514
#include "lldb/lldb-private-enumerations.h"

‎lldb/source/API/SBSaveCoreOptions.cpp

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
//===----------------------------------------------------------------------===//
88

99
#include "lldb/API/SBSaveCoreOptions.h"
10+
#include "lldb/API/SBMemoryRegionInfo.h"
1011
#include "lldb/Host/FileSystem.h"
1112
#include "lldb/Symbol/SaveCoreOptions.h"
1213
#include "lldb/Utility/Instrumentation.h"
@@ -90,6 +91,16 @@ bool SBSaveCoreOptions::RemoveThread(lldb::SBThread thread) {
9091
return m_opaque_up->RemoveThread(thread.GetSP());
9192
}
9293

94+
lldb::SBError
95+
SBSaveCoreOptions::AddMemoryRegionToSave(const SBMemoryRegionInfo &region) {
96+
LLDB_INSTRUMENT_VA(this, region);
97+
// Currently add memory region can't fail, so we always return a success
98+
// SBerror, but because these API's live forever, this is the most future
99+
// proof thing to do.
100+
m_opaque_up->AddMemoryRegionToSave(region.ref());
101+
return SBError();
102+
}
103+
93104
void SBSaveCoreOptions::Clear() {
94105
LLDB_INSTRUMENT_VA(this);
95106
m_opaque_up->Clear();

‎lldb/source/Commands/CommandObjectProcess.cpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
#include "lldb/Interpreter/OptionArgParser.h"
2626
#include "lldb/Interpreter/OptionGroupPythonClassWithDict.h"
2727
#include "lldb/Interpreter/Options.h"
28+
#include "lldb/Symbol/SaveCoreOptions.h"
2829
#include "lldb/Target/Platform.h"
2930
#include "lldb/Target/Process.h"
3031
#include "lldb/Target/StopInfo.h"

‎lldb/source/Plugins/ObjectFile/Mach-O/ObjectFileMachO.cpp

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6568,7 +6568,9 @@ bool ObjectFileMachO::SaveCore(const lldb::ProcessSP &process_sp,
65686568
const uint32_t addr_byte_size = target_arch.GetAddressByteSize();
65696569
const ByteOrder byte_order = target_arch.GetByteOrder();
65706570
std::vector<llvm::MachO::segment_command_64> segment_load_commands;
6571-
for (const auto &core_range : core_ranges) {
6571+
for (const auto &core_range_info : core_ranges) {
6572+
// TODO: Refactor RangeDataVector to have a data iterator.
6573+
const auto &core_range = core_range_info.data;
65726574
uint32_t cmd_type = LC_SEGMENT_64;
65736575
uint32_t segment_size = sizeof(llvm::MachO::segment_command_64);
65746576
if (addr_byte_size == 4) {

‎lldb/source/Plugins/ObjectFile/Mach-O/ObjectFileMachO.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
#include "lldb/Core/Address.h"
1313
#include "lldb/Host/SafeMachO.h"
1414
#include "lldb/Symbol/ObjectFile.h"
15+
#include "lldb/Symbol/SaveCoreOptions.h"
1516
#include "lldb/Utility/FileSpec.h"
1617
#include "lldb/Utility/FileSpecList.h"
1718
#include "lldb/Utility/RangeMap.h"

‎lldb/source/Plugins/ObjectFile/Minidump/MinidumpFileBuilder.cpp

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -828,25 +828,32 @@ Status MinidumpFileBuilder::AddMemoryList() {
828828
// bytes of the core file. Thread structures in minidump files can only use
829829
// 32 bit memory descriptiors, so we emit them first to ensure the memory is
830830
// in accessible with a 32 bit offset.
831-
Process::CoreFileMemoryRanges ranges_32;
832-
Process::CoreFileMemoryRanges ranges_64;
831+
std::vector<Process::CoreFileMemoryRange> ranges_32;
832+
std::vector<Process::CoreFileMemoryRange> ranges_64;
833833
Process::CoreFileMemoryRanges all_core_memory_ranges;
834834
error = m_process_sp->CalculateCoreFileSaveRanges(m_save_core_options,
835835
all_core_memory_ranges);
836+
837+
std::vector<Process::CoreFileMemoryRange> all_core_memory_vec;
838+
// Extract all the data into just a vector of data. So we can mutate this in
839+
// place.
840+
for (const auto &core_range : all_core_memory_ranges)
841+
all_core_memory_vec.push_back(core_range.data);
842+
836843
if (error.Fail())
837844
return error;
838845

839846
// Start by saving all of the stacks and ensuring they fit under the 32b
840847
// limit.
841848
uint64_t total_size = GetCurrentDataEndOffset();
842-
auto iterator = all_core_memory_ranges.begin();
843-
while (iterator != all_core_memory_ranges.end()) {
849+
auto iterator = all_core_memory_vec.begin();
850+
while (iterator != all_core_memory_vec.end()) {
844851
if (m_saved_stack_ranges.count(iterator->range.start()) > 0) {
845852
// We don't save stacks twice.
846853
ranges_32.push_back(*iterator);
847854
total_size +=
848855
iterator->range.size() + sizeof(llvm::minidump::MemoryDescriptor);
849-
iterator = all_core_memory_ranges.erase(iterator);
856+
iterator = all_core_memory_vec.erase(iterator);
850857
} else {
851858
iterator++;
852859
}
@@ -866,11 +873,11 @@ Status MinidumpFileBuilder::AddMemoryList() {
866873
// Then anything overflow extends into 64b addressable space.
867874
// All core memeroy ranges will either container nothing on stacks only
868875
// or all the memory ranges including stacks
869-
if (!all_core_memory_ranges.empty())
870-
total_size += 256 + (all_core_memory_ranges.size() *
876+
if (!all_core_memory_vec.empty())
877+
total_size += 256 + (all_core_memory_vec.size() *
871878
sizeof(llvm::minidump::MemoryDescriptor_64));
872879

873-
for (const auto &core_range : all_core_memory_ranges) {
880+
for (const auto &core_range : all_core_memory_vec) {
874881
const addr_t range_size = core_range.range.size();
875882
// We don't need to check for stacks here because we already removed them
876883
// from all_core_memory_ranges.
@@ -955,15 +962,15 @@ Status MinidumpFileBuilder::DumpDirectories() const {
955962
}
956963

957964
static uint64_t
958-
GetLargestRangeSize(const Process::CoreFileMemoryRanges &ranges) {
965+
GetLargestRangeSize(const std::vector<Process::CoreFileMemoryRange> &ranges) {
959966
uint64_t max_size = 0;
960967
for (const auto &core_range : ranges)
961968
max_size = std::max(max_size, core_range.range.size());
962969
return max_size;
963970
}
964971

965-
Status
966-
MinidumpFileBuilder::AddMemoryList_32(Process::CoreFileMemoryRanges &ranges) {
972+
Status MinidumpFileBuilder::AddMemoryList_32(
973+
std::vector<Process::CoreFileMemoryRange> &ranges) {
967974
std::vector<MemoryDescriptor> descriptors;
968975
Status error;
969976
if (ranges.size() == 0)
@@ -1039,8 +1046,8 @@ MinidumpFileBuilder::AddMemoryList_32(Process::CoreFileMemoryRanges &ranges) {
10391046
return error;
10401047
}
10411048

1042-
Status
1043-
MinidumpFileBuilder::AddMemoryList_64(Process::CoreFileMemoryRanges &ranges) {
1049+
Status MinidumpFileBuilder::AddMemoryList_64(
1050+
std::vector<Process::CoreFileMemoryRange> &ranges) {
10441051
Status error;
10451052
if (ranges.empty())
10461053
return error;

‎lldb/source/Plugins/ObjectFile/Minidump/MinidumpFileBuilder.h

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
#include <utility>
2424
#include <variant>
2525

26+
#include "lldb/Symbol/SaveCoreOptions.h"
2627
#include "lldb/Target/Process.h"
2728
#include "lldb/Target/Target.h"
2829
#include "lldb/Utility/DataBufferHeap.h"
@@ -119,10 +120,10 @@ class MinidumpFileBuilder {
119120
// trigger a flush.
120121
lldb_private::Status AddData(const void *data, uint64_t size);
121122
// Add MemoryList stream, containing dumps of important memory segments
122-
lldb_private::Status
123-
AddMemoryList_64(lldb_private::Process::CoreFileMemoryRanges &ranges);
124-
lldb_private::Status
125-
AddMemoryList_32(lldb_private::Process::CoreFileMemoryRanges &ranges);
123+
lldb_private::Status AddMemoryList_64(
124+
std::vector<lldb_private::Process::CoreFileMemoryRange> &ranges);
125+
lldb_private::Status AddMemoryList_32(
126+
std::vector<lldb_private::Process::CoreFileMemoryRange> &ranges);
126127
// Update the thread list on disk with the newly emitted stack RVAs.
127128
lldb_private::Status FixThreadStacks();
128129
lldb_private::Status FlushBufferToDisk();

‎lldb/source/Plugins/ObjectFile/Minidump/ObjectFileMinidump.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
#define LLDB_SOURCE_PLUGINS_OBJECTFILE_MINIDUMP_OBJECTFILEMINIDUMP_H
2222

2323
#include "lldb/Symbol/ObjectFile.h"
24+
#include "lldb/Symbol/SaveCoreOptions.h"
2425
#include "lldb/Utility/ArchSpec.h"
2526

2627
class ObjectFileMinidump : public lldb_private::PluginInterface {

‎lldb/source/Plugins/ObjectFile/PECOFF/ObjectFilePECOFF.cpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
#include "lldb/Interpreter/OptionValueDictionary.h"
1818
#include "lldb/Interpreter/OptionValueProperties.h"
1919
#include "lldb/Symbol/ObjectFile.h"
20+
#include "lldb/Symbol/SaveCoreOptions.h"
2021
#include "lldb/Target/Process.h"
2122
#include "lldb/Target/SectionLoadList.h"
2223
#include "lldb/Target/Target.h"

‎lldb/source/Plugins/ObjectFile/PECOFF/ObjectFilePECOFF.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
#include <vector>
1414

1515
#include "lldb/Symbol/ObjectFile.h"
16+
#include "lldb/Symbol/SaveCoreOptions.h"
1617
#include "llvm/Object/COFF.h"
1718

1819
class ObjectFilePECOFF : public lldb_private::ObjectFile {

‎lldb/source/Symbol/SaveCoreOptions.cpp

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,19 @@ bool SaveCoreOptions::ShouldThreadBeSaved(lldb::tid_t tid) const {
102102
return m_threads_to_save.count(tid) > 0;
103103
}
104104

105+
bool SaveCoreOptions::HasSpecifiedThreads() const {
106+
return !m_threads_to_save.empty();
107+
}
108+
109+
void SaveCoreOptions::AddMemoryRegionToSave(
110+
const lldb_private::MemoryRegionInfo &region) {
111+
m_regions_to_save.Insert(region.GetRange(), /*combine=*/true);
112+
}
113+
114+
const MemoryRanges &SaveCoreOptions::GetCoreFileMemoryRanges() const {
115+
return m_regions_to_save;
116+
}
117+
105118
Status SaveCoreOptions::EnsureValidConfiguration(
106119
lldb::ProcessSP process_sp) const {
107120
Status error;
@@ -131,4 +144,5 @@ void SaveCoreOptions::Clear() {
131144
m_style = std::nullopt;
132145
m_threads_to_save.clear();
133146
m_process_sp.reset();
147+
m_regions_to_save.Clear();
134148
}

0 commit comments

Comments
 (0)