https://github.com/real-mikhail updated
https://github.com/llvm/llvm-project/pull/129092
>From 1d2da22bceb83cbda54567e5f819e55555eef4e6 Mon Sep 17 00:00:00 2001
From: Mikhail Zakharov <mikhail.zakha...@jetbrains.com>
Date: Thu, 27 Feb 2025 18:43:33 +0100
Subject: [PATCH 1/9] [lldb] Do not bump memory modificator ID when "internal"
debugger memory is updated
This change prevents invalidating and updating values in
`ValueObject::UpdateValueIfNeeded` when only "internal" debugger memory is
updated.
Writing to "internal" debugger memory happens when, for instance, user
expressions are evaluated by pretty printers.
For some collections getting collection size is an expensive operation (it
requires traversal of the collection) and broken value caching (being
invalidated after executing expressions) make things worse.
At the same time evaluating user expression with side effects (visible to
target, not only to debugger) will still bump memory ID because:
1. If expression is evaluated via interpreter: it will cause write to
"non-internal" memory
2. If expression is JIT-compiled: then to call the function LLDB will write to
"non-internal" stack memory
---
lldb/include/lldb/Target/Memory.h | 4 +-
lldb/source/Target/Memory.cpp | 8 ++
lldb/source/Target/Process.cpp | 7 +-
.../Shell/Expr/TestExprWithSideEffect.cpp | 82 +++++++++++++++++++
4 files changed, 99 insertions(+), 2 deletions(-)
create mode 100644 lldb/test/Shell/Expr/TestExprWithSideEffect.cpp
diff --git a/lldb/include/lldb/Target/Memory.h
b/lldb/include/lldb/Target/Memory.h
index 2d1489a2c96ea..864ef6ca00802 100644
--- a/lldb/include/lldb/Target/Memory.h
+++ b/lldb/include/lldb/Target/Memory.h
@@ -125,6 +125,8 @@ class AllocatedMemoryCache {
bool DeallocateMemory(lldb::addr_t ptr);
+ bool IsInCache(lldb::addr_t addr) const;
+
protected:
typedef std::shared_ptr<AllocatedBlock> AllocatedBlockSP;
@@ -133,7 +135,7 @@ class AllocatedMemoryCache {
// Classes that inherit from MemoryCache can see and modify these
Process &m_process;
- std::recursive_mutex m_mutex;
+ mutable std::recursive_mutex m_mutex;
typedef std::multimap<uint32_t, AllocatedBlockSP> PermissionsToBlockMap;
PermissionsToBlockMap m_memory_map;
diff --git a/lldb/source/Target/Memory.cpp b/lldb/source/Target/Memory.cpp
index 5cdd84f6640f0..9bfb8c349aa2c 100644
--- a/lldb/source/Target/Memory.cpp
+++ b/lldb/source/Target/Memory.cpp
@@ -433,3 +433,11 @@ bool AllocatedMemoryCache::DeallocateMemory(lldb::addr_t
addr) {
(uint64_t)addr, success);
return success;
}
+
+bool AllocatedMemoryCache::IsInCache(lldb::addr_t addr) const {
+ std::lock_guard guard(m_mutex);
+
+ return llvm::any_of(m_memory_map, [addr](const auto &block) {
+ return block.second->Contains(addr);
+ });
+}
diff --git a/lldb/source/Target/Process.cpp b/lldb/source/Target/Process.cpp
index 6db582096155f..1150fabf2d0ed 100644
--- a/lldb/source/Target/Process.cpp
+++ b/lldb/source/Target/Process.cpp
@@ -2267,6 +2267,7 @@ size_t Process::WriteMemoryPrivate(addr_t addr, const
void *buf, size_t size,
return bytes_written;
}
+#define USE_ALLOCATE_MEMORY_CACHE 1
size_t Process::WriteMemory(addr_t addr, const void *buf, size_t size,
Status &error) {
if (ABISP abi_sp = GetABI())
@@ -2279,7 +2280,12 @@ size_t Process::WriteMemory(addr_t addr, const void
*buf, size_t size,
if (buf == nullptr || size == 0)
return 0;
+#if defined(USE_ALLOCATE_MEMORY_CACHE)
+ if (!m_allocated_memory_cache.IsInCache(addr))
+ m_mod_id.BumpMemoryID();
+#else
m_mod_id.BumpMemoryID();
+#endif
// We need to write any data that would go where any current software traps
// (enabled software breakpoints) any software traps (breakpoints) that we
@@ -2408,7 +2414,6 @@ Status
Process::WriteObjectFile(std::vector<ObjectFile::LoadableData> entries) {
return error;
}
-#define USE_ALLOCATE_MEMORY_CACHE 1
addr_t Process::AllocateMemory(size_t size, uint32_t permissions,
Status &error) {
if (GetPrivateState() != eStateStopped) {
diff --git a/lldb/test/Shell/Expr/TestExprWithSideEffect.cpp
b/lldb/test/Shell/Expr/TestExprWithSideEffect.cpp
new file mode 100644
index 0000000000000..d072fe3121031
--- /dev/null
+++ b/lldb/test/Shell/Expr/TestExprWithSideEffect.cpp
@@ -0,0 +1,82 @@
+// Tests evaluating expressions with side effects.
+// Applied side effect should be visible to the debugger.
+
+// RUN: %build %s -o %t
+// RUN: %lldb %t -o run \
+// RUN: -o "frame variable x" \
+// RUN: -o "expr x.inc()" \
+// RUN: -o "frame variable x" \
+// RUN: -o "continue" \
+// RUN: -o "frame variable x" \
+// RUN: -o "expr x.i = 10" \
+// RUN: -o "frame variable x" \
+// RUN: -o "continue" \
+// RUN: -o "frame variable x" \
+// RUN: -o "expr int $y = 11" \
+// RUN: -o "expr $y" \
+// RUN: -o "expr $y = 100" \
+// RUN: -o "expr $y" \
+// RUN: -o "continue" \
+// RUN: -o "expr $y" \
+// RUN: -o exit | FileCheck %s -dump-input=fail
+
+class X
+{
+ int i = 0;
+public:
+ void inc()
+ {
+ ++i;
+ }
+};
+
+int main()
+{
+ X x;
+ x.inc();
+
+ __builtin_debugtrap();
+ __builtin_debugtrap();
+ __builtin_debugtrap();
+ __builtin_debugtrap();
+ return 0;
+}
+
+// CHECK-LABEL: frame variable x
+// CHECK: (X) x = (i = 1)
+
+// CHECK-LABEL: expr x.inc()
+// CHECK-LABEL: frame variable x
+// CHECK: (X) x = (i = 2)
+
+// CHECK-LABEL: continue
+// CHECK-LABEL: frame variable x
+// CHECK: (X) x = (i = 2)
+
+
+
+// CHECK-LABEL: expr x.i = 10
+// CHECK: (int) $0 = 10
+
+// CHECK-LABEL: frame variable x
+// CHECK: (X) x = (i = 10)
+
+// CHECK-LABEL: continue
+// CHECK-LABEL: frame variable x
+// CHECK: (X) x = (i = 10)
+
+
+
+// CHECK-LABEL: expr int $y = 11
+// CHECK-LABEL: expr $y
+// CHECK: (int) $y = 11
+
+// CHECK-LABEL: expr $y = 100
+// CHECK: (int) $1 = 100
+
+// CHECK-LABEL: expr $y
+// CHECK: (int) $y = 100
+
+// CHECK-LABEL: continue
+// CHECK-LABEL: expr $y
+// CHECK: (int) $y = 100
>From 5ce65f156a732a399c5f8c45407e68668c9c8fd8 Mon Sep 17 00:00:00 2001
From: Mikhail Zakharov <mikhail.zakha...@jetbrains.com>
Date: Fri, 14 Mar 2025 18:38:52 +0100
Subject: [PATCH 2/9] [lldb] Reformat test code and add additional test for
modifying member of the struct allocated in the cache
---
.../Shell/Expr/TestExprWithSideEffect.cpp | 37 ++------------
...TestExprWithSideEffectOnConvenienceVar.cpp | 48 +++++++++++++++++++
2 files changed, 52 insertions(+), 33 deletions(-)
create mode 100644
lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVar.cpp
diff --git a/lldb/test/Shell/Expr/TestExprWithSideEffect.cpp
b/lldb/test/Shell/Expr/TestExprWithSideEffect.cpp
index d072fe3121031..78cbff07004bb 100644
--- a/lldb/test/Shell/Expr/TestExprWithSideEffect.cpp
+++ b/lldb/test/Shell/Expr/TestExprWithSideEffect.cpp
@@ -12,33 +12,22 @@
// RUN: -o "frame variable x" \
// RUN: -o "continue" \
// RUN: -o "frame variable x" \
-// RUN: -o "expr int $y = 11" \
-// RUN: -o "expr $y" \
-// RUN: -o "expr $y = 100" \
-// RUN: -o "expr $y" \
-// RUN: -o "continue" \
-// RUN: -o "expr $y" \
// RUN: -o exit | FileCheck %s -dump-input=fail
-class X
-{
+class X {
int i = 0;
+
public:
- void inc()
- {
- ++i;
- }
+ void inc() { ++i; }
};
-int main()
-{
+int main() {
X x;
x.inc();
__builtin_debugtrap();
__builtin_debugtrap();
__builtin_debugtrap();
- __builtin_debugtrap();
return 0;
}
@@ -53,8 +42,6 @@ int main()
// CHECK-LABEL: frame variable x
// CHECK: (X) x = (i = 2)
-
-
// CHECK-LABEL: expr x.i = 10
// CHECK: (int) $0 = 10
@@ -64,19 +51,3 @@ int main()
// CHECK-LABEL: continue
// CHECK-LABEL: frame variable x
// CHECK: (X) x = (i = 10)
-
-
-
-// CHECK-LABEL: expr int $y = 11
-// CHECK-LABEL: expr $y
-// CHECK: (int) $y = 11
-
-// CHECK-LABEL: expr $y = 100
-// CHECK: (int) $1 = 100
-
-// CHECK-LABEL: expr $y
-// CHECK: (int) $y = 100
-
-// CHECK-LABEL: continue
-// CHECK-LABEL: expr $y
-// CHECK: (int) $y = 100
diff --git a/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVar.cpp
b/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVar.cpp
new file mode 100644
index 0000000000000..201bbafb22137
--- /dev/null
+++ b/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVar.cpp
@@ -0,0 +1,48 @@
+// Tests evaluating expressions with side effects on convenience variable.
+// Applied side effect should be visible to the debugger.
+
+// RUN: %build %s -o %t
+// RUN: %lldb %t -o run \
+// RUN: -o "expr int $y = 11" \
+// RUN: -o "expr $y" \
+// RUN: -o "expr $y = 100" \
+// RUN: -o "expr $y" \
+// RUN: -o "continue" \
+// RUN: -o "expr $y" \
+// RUN: -o "expr X $mine = {100, 200}" \
+// RUN: -o "expr $mine.a = 300" \
+// RUN: -o "expr $mine" \
+// RUN: -o exit | FileCheck %s -dump-input=fail
+
+struct X {
+ int a;
+ int b;
+};
+
+int main() {
+ X x;
+
+ __builtin_debugtrap();
+ __builtin_debugtrap();
+ return 0;
+}
+
+// CHECK-LABEL: expr int $y = 11
+// CHECK-LABEL: expr $y
+// CHECK: (int) $y = 11
+
+// CHECK-LABEL: expr $y = 100
+// CHECK: (int) $0 = 100
+
+// CHECK-LABEL: expr $y
+// CHECK: (int) $y = 100
+
+// CHECK-LABEL: continue
+// CHECK-LABEL: expr $y
+// CHECK: (int) $y = 100
+
+// CHECK-LABEL: expr X $mine = {100, 200}
+// CHECK-LABEL: expr $mine.a = 300
+// CHECK: (int) $1 = 300
+// CHECK-LABEL: expr $mine
+// CHECK: (X) $mine = (a = 300, b = 200)
>From 12a666832c0fcd4fbc46b290877e9983ed8b9007 Mon Sep 17 00:00:00 2001
From: Mikhail Zakharov <mikhail.zakha...@jetbrains.com>
Date: Tue, 1 Apr 2025 14:40:04 +0200
Subject: [PATCH 3/9] [lldb] Fixed test on Linux
---
...TestExprWithSideEffectOnConvenienceVar.cpp | 18 ++++---
...rWithSideEffectOnConvenienceVarWindows.cpp | 49 +++++++++++++++++++
2 files changed, 59 insertions(+), 8 deletions(-)
create mode 100644
lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVarWindows.cpp
diff --git a/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVar.cpp
b/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVar.cpp
index 201bbafb22137..9296a84506b57 100644
--- a/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVar.cpp
+++ b/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVar.cpp
@@ -1,17 +1,19 @@
// Tests evaluating expressions with side effects on convenience variable.
// Applied side effect should be visible to the debugger.
+// UNSUPPORTED: system-windows
+
// RUN: %build %s -o %t
// RUN: %lldb %t -o run \
-// RUN: -o "expr int $y = 11" \
-// RUN: -o "expr $y" \
-// RUN: -o "expr $y = 100" \
-// RUN: -o "expr $y" \
+// RUN: -o "expr int \$y = 11" \
+// RUN: -o "expr \$y" \
+// RUN: -o "expr \$y = 100" \
+// RUN: -o "expr \$y" \
// RUN: -o "continue" \
-// RUN: -o "expr $y" \
-// RUN: -o "expr X $mine = {100, 200}" \
-// RUN: -o "expr $mine.a = 300" \
-// RUN: -o "expr $mine" \
+// RUN: -o "expr \$y" \
+// RUN: -o "expr X \$mine = {100, 200}" \
+// RUN: -o "expr \$mine.a = 300" \
+// RUN: -o "expr \$mine" \
// RUN: -o exit | FileCheck %s -dump-input=fail
struct X {
diff --git
a/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVarWindows.cpp
b/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVarWindows.cpp
new file mode 100644
index 0000000000000..18a6beecfa713
--- /dev/null
+++ b/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVarWindows.cpp
@@ -0,0 +1,49 @@
+// Same as TestExprWithSideEffectOnConvenienceVar.cpp but without $ escaping
+
+// REQUIRES: target-windows
+
+// RUN: %build %s -o %t
+// RUN: %lldb %t -o run \
+// RUN: -o "expr int $y = 11" \
+// RUN: -o "expr $y" \
+// RUN: -o "expr $y = 100" \
+// RUN: -o "expr $y" \
+// RUN: -o "continue" \
+// RUN: -o "expr $y" \
+// RUN: -o "expr X $mine = {100, 200}" \
+// RUN: -o "expr $mine.a = 300" \
+// RUN: -o "expr $mine" \
+// RUN: -o exit | FileCheck %s -dump-input=fail
+
+struct X {
+ int a;
+ int b;
+};
+
+int main() {
+ X x;
+
+ __builtin_debugtrap();
+ __builtin_debugtrap();
+ return 0;
+}
+
+// CHECK-LABEL: expr int $y = 11
+// CHECK-LABEL: expr $y
+// CHECK: (int) $y = 11
+
+// CHECK-LABEL: expr $y = 100
+// CHECK: (int) $0 = 100
+
+// CHECK-LABEL: expr $y
+// CHECK: (int) $y = 100
+
+// CHECK-LABEL: continue
+// CHECK-LABEL: expr $y
+// CHECK: (int) $y = 100
+
+// CHECK-LABEL: expr X $mine = {100, 200}
+// CHECK-LABEL: expr $mine.a = 300
+// CHECK: (int) $1 = 300
+// CHECK-LABEL: expr $mine
+// CHECK: (X) $mine = (a = 300, b = 200)
>From c007937d7eed963b84df2e086a11f37dc4fac311 Mon Sep 17 00:00:00 2001
From: Mikhail Zakharov <mikhail.zakha...@jetbrains.com>
Date: Tue, 1 Apr 2025 16:25:52 +0200
Subject: [PATCH 4/9] [lldb] Make new behaviour opt-in via
"target.process.process-state-tracks-memory-cache" key
---
lldb/include/lldb/Target/Process.h | 1 +
lldb/source/Target/Process.cpp | 9 ++++++++-
lldb/source/Target/TargetProperties.td | 3 +++
lldb/test/API/commands/settings/TestSettings.py | 1 +
.../Expr/TestExprWithSideEffectOnConvenienceVar.cpp | 6 ++++--
.../TestExprWithSideEffectOnConvenienceVarWindows.cpp | 6 ++++--
6 files changed, 21 insertions(+), 5 deletions(-)
diff --git a/lldb/include/lldb/Target/Process.h
b/lldb/include/lldb/Target/Process.h
index c3622a29bc772..316eb3d6a8765 100644
--- a/lldb/include/lldb/Target/Process.h
+++ b/lldb/include/lldb/Target/Process.h
@@ -111,6 +111,7 @@ class ProcessProperties : public Properties {
void SetOSPluginReportsAllThreads(bool does_report);
bool GetSteppingRunsAllThreads() const;
FollowForkMode GetFollowForkMode() const;
+ bool GetProcessStateTracksMemoryCache() const;
protected:
Process *m_process; // Can be nullptr for global ProcessProperties
diff --git a/lldb/source/Target/Process.cpp b/lldb/source/Target/Process.cpp
index 1150fabf2d0ed..663c22de58079 100644
--- a/lldb/source/Target/Process.cpp
+++ b/lldb/source/Target/Process.cpp
@@ -369,6 +369,12 @@ FollowForkMode ProcessProperties::GetFollowForkMode()
const {
g_process_properties[idx].default_uint_value));
}
+bool ProcessProperties::GetProcessStateTracksMemoryCache() const {
+ const uint32_t idx = ePropertyProcessStateTracksMemoryCache;
+ return GetPropertyAtIndexAs<bool>(
+ idx, g_process_properties[idx].default_uint_value != 0);
+}
+
ProcessSP Process::FindPlugin(lldb::TargetSP target_sp,
llvm::StringRef plugin_name,
ListenerSP listener_sp,
@@ -2281,7 +2287,8 @@ size_t Process::WriteMemory(addr_t addr, const void *buf,
size_t size,
return 0;
#if defined(USE_ALLOCATE_MEMORY_CACHE)
- if (!m_allocated_memory_cache.IsInCache(addr))
+ if (GetProcessStateTracksMemoryCache() ||
+ !m_allocated_memory_cache.IsInCache(addr))
m_mod_id.BumpMemoryID();
#else
m_mod_id.BumpMemoryID();
diff --git a/lldb/source/Target/TargetProperties.td
b/lldb/source/Target/TargetProperties.td
index 38a345dfd8849..24806135c7adc 100644
--- a/lldb/source/Target/TargetProperties.td
+++ b/lldb/source/Target/TargetProperties.td
@@ -296,6 +296,9 @@ let Definition = "process" in {
DefaultEnumValue<"eFollowParent">,
EnumValues<"OptionEnumValues(g_follow_fork_mode_values)">,
Desc<"Debugger's behavior upon fork or vfork.">;
+ def ProcessStateTracksMemoryCache:
Property<"process-state-tracks-memory-cache", "Boolean">,
+ DefaultTrue,
+ Desc<"If true, memory cache modifications (which happen often during
expressions evaluation) will bump process state ID (and invalidate all
synthetic children). Disabling this option helps to avoid synthetic children
reevaluation when pretty printers heavily use expressions, but convenience
variables won't reevaluate synthetic children automatically.">;
}
let Definition = "platform" in {
diff --git a/lldb/test/API/commands/settings/TestSettings.py
b/lldb/test/API/commands/settings/TestSettings.py
index 2dd813f6b155b..dfd8e6ba86e63 100644
--- a/lldb/test/API/commands/settings/TestSettings.py
+++ b/lldb/test/API/commands/settings/TestSettings.py
@@ -907,6 +907,7 @@ def test_all_settings_exist(self):
"target.process.extra-startup-command",
"target.process.thread.trace-thread",
"target.process.thread.step-avoid-regexp",
+ "target.process.process-state-tracks-memory-cache",
],
)
diff --git a/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVar.cpp
b/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVar.cpp
index 9296a84506b57..52bc93f9279ae 100644
--- a/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVar.cpp
+++ b/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVar.cpp
@@ -4,7 +4,9 @@
// UNSUPPORTED: system-windows
// RUN: %build %s -o %t
-// RUN: %lldb %t -o run \
+// RUN: %lldb %t \
+// RUN: -o "settings set target.process.process-state-tracks-memory-cache
false" \
+// RUN: -o "run" \
// RUN: -o "expr int \$y = 11" \
// RUN: -o "expr \$y" \
// RUN: -o "expr \$y = 100" \
@@ -14,7 +16,7 @@
// RUN: -o "expr X \$mine = {100, 200}" \
// RUN: -o "expr \$mine.a = 300" \
// RUN: -o "expr \$mine" \
-// RUN: -o exit | FileCheck %s -dump-input=fail
+// RUN: -o "exit" | FileCheck %s -dump-input=fail
struct X {
int a;
diff --git
a/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVarWindows.cpp
b/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVarWindows.cpp
index 18a6beecfa713..e110101545320 100644
--- a/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVarWindows.cpp
+++ b/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVarWindows.cpp
@@ -3,7 +3,9 @@
// REQUIRES: target-windows
// RUN: %build %s -o %t
-// RUN: %lldb %t -o run \
+// RUN: %lldb %t \
+// RUN: -o "settings set target.process.process-state-tracks-memory-cache
false" \
+// RUN: -o "run" \
// RUN: -o "expr int $y = 11" \
// RUN: -o "expr $y" \
// RUN: -o "expr $y = 100" \
@@ -13,7 +15,7 @@
// RUN: -o "expr X $mine = {100, 200}" \
// RUN: -o "expr $mine.a = 300" \
// RUN: -o "expr $mine" \
-// RUN: -o exit | FileCheck %s -dump-input=fail
+// RUN: -o "exit" | FileCheck %s -dump-input=fail
struct X {
int a;
>From 697cfb7d0374d3e4d1593716e2e09ea896330267 Mon Sep 17 00:00:00 2001
From: Mikhail Zakharov <mikhail.zakha...@jetbrains.com>
Date: Tue, 1 Apr 2025 18:21:45 +0200
Subject: [PATCH 5/9] [lldb] Added ability to dump ProcessModID and added test
to verify that simple expressions do not cause memory_id to be bumped
---
lldb/include/lldb/Target/Process.h | 12 ++++
lldb/source/Commands/CommandObjectProcess.cpp | 29 +++++++++
.../Shell/Expr/TestExprWithSideEffect.cpp | 6 +-
.../Shell/Expr/TestProcessModIdOnExpr.cpp | 64 +++++++++++++++++++
4 files changed, 109 insertions(+), 2 deletions(-)
create mode 100644 lldb/test/Shell/Expr/TestProcessModIdOnExpr.cpp
diff --git a/lldb/include/lldb/Target/Process.h
b/lldb/include/lldb/Target/Process.h
index 316eb3d6a8765..4477373122ba1 100644
--- a/lldb/include/lldb/Target/Process.h
+++ b/lldb/include/lldb/Target/Process.h
@@ -313,6 +313,18 @@ class ProcessModID {
return lldb::EventSP();
}
+ void Dump(Stream &stream) const {
+ stream.Format("ProcessModID:\n"
+ " m_stop_id: {0}\n m_last_natural_stop_id: {1}\n"
+ " m_resume_id: {2}\n m_memory_id: {3}\n"
+ " m_last_user_expression_resume: {4}\n"
+ " m_running_user_expression: {5}\n"
+ " m_running_utility_function: {6}\n",
+ m_stop_id, m_last_natural_stop_id, m_resume_id, m_memory_id,
+ m_last_user_expression_resume, m_running_user_expression,
+ m_running_utility_function);
+ }
+
private:
uint32_t m_stop_id = 0;
uint32_t m_last_natural_stop_id = 0;
diff --git a/lldb/source/Commands/CommandObjectProcess.cpp
b/lldb/source/Commands/CommandObjectProcess.cpp
index 654dfa83ea444..47bbaa0d55745 100644
--- a/lldb/source/Commands/CommandObjectProcess.cpp
+++ b/lldb/source/Commands/CommandObjectProcess.cpp
@@ -1827,6 +1827,33 @@ class CommandObjectMultiwordProcessTrace : public
CommandObjectMultiword {
~CommandObjectMultiwordProcessTrace() override = default;
};
+// CommandObjectProcessDumpModId
+class CommandObjectProcessDumpModId : public CommandObjectParsed {
+public:
+ CommandObjectProcessDumpModId(CommandInterpreter &interpreter)
+ : CommandObjectParsed(interpreter, "process dump-mod-id",
+ "Dump the state of the ProcessModID. Intended to "
+ "be used for debugging LLDB itself.",
+ "process dump-mod-id",
+ eCommandRequiresProcess) {}
+
+ ~CommandObjectProcessDumpModId() override = default;
+
+protected:
+ void DoExecute(Args &command, CommandReturnObject &result) override {
+ Process *process = m_exe_ctx.GetProcessPtr();
+ StateType state = process->GetState();
+ if (state != eStateStopped) {
+ result.SetStatus(eReturnStatusFailed);
+ return;
+ }
+
+ ProcessModID process_mod_id = process->GetModID();
+ process_mod_id.Dump(result.GetOutputStream());
+ result.SetStatus(eReturnStatusSuccessFinishResult);
+ }
+};
+
// CommandObjectMultiwordProcess
CommandObjectMultiwordProcess::CommandObjectMultiwordProcess(
@@ -1866,6 +1893,8 @@
CommandObjectMultiwordProcess::CommandObjectMultiwordProcess(
LoadSubCommand(
"trace",
CommandObjectSP(new CommandObjectMultiwordProcessTrace(interpreter)));
+ LoadSubCommand("dump-mod-id",
+ CommandObjectSP(new
CommandObjectProcessDumpModId(interpreter)));
}
CommandObjectMultiwordProcess::~CommandObjectMultiwordProcess() = default;
diff --git a/lldb/test/Shell/Expr/TestExprWithSideEffect.cpp
b/lldb/test/Shell/Expr/TestExprWithSideEffect.cpp
index 78cbff07004bb..4b9cbb9c86ca9 100644
--- a/lldb/test/Shell/Expr/TestExprWithSideEffect.cpp
+++ b/lldb/test/Shell/Expr/TestExprWithSideEffect.cpp
@@ -2,7 +2,9 @@
// Applied side effect should be visible to the debugger.
// RUN: %build %s -o %t
-// RUN: %lldb %t -o run \
+// RUN: %lldb %t \
+// RUN: -o "settings set target.process.process-state-tracks-memory-cache
false" \
+// RUN: -o "run" \
// RUN: -o "frame variable x" \
// RUN: -o "expr x.inc()" \
// RUN: -o "frame variable x" \
@@ -12,7 +14,7 @@
// RUN: -o "frame variable x" \
// RUN: -o "continue" \
// RUN: -o "frame variable x" \
-// RUN: -o exit | FileCheck %s -dump-input=fail
+// RUN: -o "exit" | FileCheck %s -dump-input=fail
class X {
int i = 0;
diff --git a/lldb/test/Shell/Expr/TestProcessModIdOnExpr.cpp
b/lldb/test/Shell/Expr/TestProcessModIdOnExpr.cpp
new file mode 100644
index 0000000000000..94a0e88fcfa5c
--- /dev/null
+++ b/lldb/test/Shell/Expr/TestProcessModIdOnExpr.cpp
@@ -0,0 +1,64 @@
+// Tests that ProcessModID.m_memory_id is not bumped when evaluating
expressions without side effects.
+
+// RUN: %build %s -o %t
+// RUN: %lldb %t \
+// RUN: -o "settings set target.process.process-state-tracks-memory-cache
false" \
+// RUN: -o "run" \
+// RUN: -o "process dump-mod-id" \
+// RUN: -o "expr x.i != 42" \
+// RUN: -o "process dump-mod-id" \
+// RUN: -o "expr x.get()" \
+// RUN: -o "process dump-mod-id" \
+// RUN: -o "expr x.i = 10" \
+// RUN: -o "process dump-mod-id" \
+// RUN: -o "continue" \
+// RUN: -o "process dump-mod-id" \
+// RUN: -o "exit" | FileCheck %s -dump-input=fail
+
+class X {
+ int i = 0;
+
+public:
+ int get() { return i; }
+};
+
+int main() {
+ X x;
+ x.get();
+
+ __builtin_debugtrap();
+ __builtin_debugtrap();
+ return 0;
+}
+
+// CHECK-LABEL: process dump-mod-id
+// CHECK: m_stop_id: 2
+// CHECK: m_memory_id: 0
+
+// CHECK-LABEL: expr x.i != 42
+// IDs are not changed when executing simple expressions
+
+// CHECK-LABEL: process dump-mod-id
+// CHECK: m_stop_id: 2
+// CHECK: m_memory_id: 0
+
+// CHECK-LABEL: expr x.get()
+// Expression causes ID to be bumped because LLDB has to execute function
+
+// CHECK-LABEL: process dump-mod-id
+// CHECK: m_stop_id: 3
+// CHECK: m_memory_id: 1
+
+// CHECK-LABEL: expr x.i = 10
+// Expression causes MemoryID to be bumped because LLDB writes to non-cache
memory
+
+// CHECK-LABEL: process dump-mod-id
+// CHECK: m_stop_id: 3
+// CHECK: m_memory_id: 2
+
+// CHECK-LABEL: continue
+// Continue causes StopID to be bumped because process is resumed
+
+// CHECK-LABEL: process dump-mod-id
+// CHECK: m_stop_id: 4
+// CHECK: m_memory_id: 2
>From 3de5e2612678f11279188351d68869189f18fa16 Mon Sep 17 00:00:00 2001
From: Mikhail Zakharov <mikhail.zakha...@jetbrains.com>
Date: Tue, 1 Apr 2025 19:29:01 +0200
Subject: [PATCH 6/9] [lldb] Fixed test_all_settings_exist
---
lldb/test/API/commands/settings/TestSettings.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/lldb/test/API/commands/settings/TestSettings.py
b/lldb/test/API/commands/settings/TestSettings.py
index dfd8e6ba86e63..65d9dd128a143 100644
--- a/lldb/test/API/commands/settings/TestSettings.py
+++ b/lldb/test/API/commands/settings/TestSettings.py
@@ -905,9 +905,9 @@ def test_all_settings_exist(self):
"target.use-hex-immediates",
"target.process.disable-memory-cache",
"target.process.extra-startup-command",
+ "target.process.process-state-tracks-memory-cache",
"target.process.thread.trace-thread",
"target.process.thread.step-avoid-regexp",
- "target.process.process-state-tracks-memory-cache",
],
)
>From b3be79490a5f9c74a109c6587e0740ae1959df99 Mon Sep 17 00:00:00 2001
From: Mikhail Zakharov <mikhail.zakha...@jetbrains.com>
Date: Tue, 1 Apr 2025 19:42:26 +0200
Subject: [PATCH 7/9] [lldb] Give new setting a better name
---
lldb/include/lldb/Target/Process.h | 2 +-
lldb/source/Target/Process.cpp | 6 +++---
lldb/source/Target/TargetProperties.td | 2 +-
lldb/test/API/commands/settings/TestSettings.py | 2 +-
lldb/test/Shell/Expr/TestExprWithSideEffect.cpp | 2 +-
.../Shell/Expr/TestExprWithSideEffectOnConvenienceVar.cpp | 2 +-
.../Expr/TestExprWithSideEffectOnConvenienceVarWindows.cpp | 2 +-
lldb/test/Shell/Expr/TestProcessModIdOnExpr.cpp | 2 +-
8 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/lldb/include/lldb/Target/Process.h
b/lldb/include/lldb/Target/Process.h
index 4477373122ba1..0627a900c0a7c 100644
--- a/lldb/include/lldb/Target/Process.h
+++ b/lldb/include/lldb/Target/Process.h
@@ -111,7 +111,7 @@ class ProcessProperties : public Properties {
void SetOSPluginReportsAllThreads(bool does_report);
bool GetSteppingRunsAllThreads() const;
FollowForkMode GetFollowForkMode() const;
- bool GetProcessStateTracksMemoryCache() const;
+ bool TrackMemoryCacheChanges() const;
protected:
Process *m_process; // Can be nullptr for global ProcessProperties
diff --git a/lldb/source/Target/Process.cpp b/lldb/source/Target/Process.cpp
index 663c22de58079..2db65b058be85 100644
--- a/lldb/source/Target/Process.cpp
+++ b/lldb/source/Target/Process.cpp
@@ -369,8 +369,8 @@ FollowForkMode ProcessProperties::GetFollowForkMode() const
{
g_process_properties[idx].default_uint_value));
}
-bool ProcessProperties::GetProcessStateTracksMemoryCache() const {
- const uint32_t idx = ePropertyProcessStateTracksMemoryCache;
+bool ProcessProperties::TrackMemoryCacheChanges() const {
+ const uint32_t idx = ePropertyTrackMemoryCacheChanges;
return GetPropertyAtIndexAs<bool>(
idx, g_process_properties[idx].default_uint_value != 0);
}
@@ -2287,7 +2287,7 @@ size_t Process::WriteMemory(addr_t addr, const void *buf,
size_t size,
return 0;
#if defined(USE_ALLOCATE_MEMORY_CACHE)
- if (GetProcessStateTracksMemoryCache() ||
+ if (TrackMemoryCacheChanges() ||
!m_allocated_memory_cache.IsInCache(addr))
m_mod_id.BumpMemoryID();
#else
diff --git a/lldb/source/Target/TargetProperties.td
b/lldb/source/Target/TargetProperties.td
index 24806135c7adc..7f94f088702b1 100644
--- a/lldb/source/Target/TargetProperties.td
+++ b/lldb/source/Target/TargetProperties.td
@@ -296,7 +296,7 @@ let Definition = "process" in {
DefaultEnumValue<"eFollowParent">,
EnumValues<"OptionEnumValues(g_follow_fork_mode_values)">,
Desc<"Debugger's behavior upon fork or vfork.">;
- def ProcessStateTracksMemoryCache:
Property<"process-state-tracks-memory-cache", "Boolean">,
+ def TrackMemoryCacheChanges: Property<"track-memory-cache-changes",
"Boolean">,
DefaultTrue,
Desc<"If true, memory cache modifications (which happen often during
expressions evaluation) will bump process state ID (and invalidate all
synthetic children). Disabling this option helps to avoid synthetic children
reevaluation when pretty printers heavily use expressions, but convenience
variables won't reevaluate synthetic children automatically.">;
}
diff --git a/lldb/test/API/commands/settings/TestSettings.py
b/lldb/test/API/commands/settings/TestSettings.py
index 65d9dd128a143..b32aa32858a14 100644
--- a/lldb/test/API/commands/settings/TestSettings.py
+++ b/lldb/test/API/commands/settings/TestSettings.py
@@ -905,7 +905,7 @@ def test_all_settings_exist(self):
"target.use-hex-immediates",
"target.process.disable-memory-cache",
"target.process.extra-startup-command",
- "target.process.process-state-tracks-memory-cache",
+ "target.process.track-memory-cache-changes",
"target.process.thread.trace-thread",
"target.process.thread.step-avoid-regexp",
],
diff --git a/lldb/test/Shell/Expr/TestExprWithSideEffect.cpp
b/lldb/test/Shell/Expr/TestExprWithSideEffect.cpp
index 4b9cbb9c86ca9..4fc88b62730c7 100644
--- a/lldb/test/Shell/Expr/TestExprWithSideEffect.cpp
+++ b/lldb/test/Shell/Expr/TestExprWithSideEffect.cpp
@@ -3,7 +3,7 @@
// RUN: %build %s -o %t
// RUN: %lldb %t \
-// RUN: -o "settings set target.process.process-state-tracks-memory-cache
false" \
+// RUN: -o "settings set target.process.track-memory-cache-changes false" \
// RUN: -o "run" \
// RUN: -o "frame variable x" \
// RUN: -o "expr x.inc()" \
diff --git a/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVar.cpp
b/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVar.cpp
index 52bc93f9279ae..b41a81f6f31a9 100644
--- a/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVar.cpp
+++ b/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVar.cpp
@@ -5,7 +5,7 @@
// RUN: %build %s -o %t
// RUN: %lldb %t \
-// RUN: -o "settings set target.process.process-state-tracks-memory-cache
false" \
+// RUN: -o "settings set target.process.track-memory-cache-changes false" \
// RUN: -o "run" \
// RUN: -o "expr int \$y = 11" \
// RUN: -o "expr \$y" \
diff --git
a/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVarWindows.cpp
b/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVarWindows.cpp
index e110101545320..8ac4b961f1ca9 100644
--- a/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVarWindows.cpp
+++ b/lldb/test/Shell/Expr/TestExprWithSideEffectOnConvenienceVarWindows.cpp
@@ -4,7 +4,7 @@
// RUN: %build %s -o %t
// RUN: %lldb %t \
-// RUN: -o "settings set target.process.process-state-tracks-memory-cache
false" \
+// RUN: -o "settings set target.process.track-memory-cache-changes false" \
// RUN: -o "run" \
// RUN: -o "expr int $y = 11" \
// RUN: -o "expr $y" \
diff --git a/lldb/test/Shell/Expr/TestProcessModIdOnExpr.cpp
b/lldb/test/Shell/Expr/TestProcessModIdOnExpr.cpp
index 94a0e88fcfa5c..d547ab97b088c 100644
--- a/lldb/test/Shell/Expr/TestProcessModIdOnExpr.cpp
+++ b/lldb/test/Shell/Expr/TestProcessModIdOnExpr.cpp
@@ -2,7 +2,7 @@
// RUN: %build %s -o %t
// RUN: %lldb %t \
-// RUN: -o "settings set target.process.process-state-tracks-memory-cache
false" \
+// RUN: -o "settings set target.process.track-memory-cache-changes false" \
// RUN: -o "run" \
// RUN: -o "process dump-mod-id" \
// RUN: -o "expr x.i != 42" \
>From 3c216ef1d8c74e87181451a5ab21107dc0482d8b Mon Sep 17 00:00:00 2001
From: Mikhail Zakharov <mikhail.zakha...@jetbrains.com>
Date: Wed, 2 Apr 2025 09:29:41 +0200
Subject: [PATCH 8/9] [lldb] Fixed test on Linux
---
lldb/test/Shell/Expr/TestProcessModIdOnExpr.cpp | 3 +++
1 file changed, 3 insertions(+)
diff --git a/lldb/test/Shell/Expr/TestProcessModIdOnExpr.cpp
b/lldb/test/Shell/Expr/TestProcessModIdOnExpr.cpp
index d547ab97b088c..55ae97908826b 100644
--- a/lldb/test/Shell/Expr/TestProcessModIdOnExpr.cpp
+++ b/lldb/test/Shell/Expr/TestProcessModIdOnExpr.cpp
@@ -1,5 +1,8 @@
// Tests that ProcessModID.m_memory_id is not bumped when evaluating
expressions without side effects.
+// REQUIRES: target-windows
+// Due to different implementations exact numbers (m_stop_id) are different on
different OSs. So we lock this test to specific platform.
+
// RUN: %build %s -o %t
// RUN: %lldb %t \
// RUN: -o "settings set target.process.track-memory-cache-changes false" \
>From d5a8a89e80d29f83fc8c83dfbaa36c21613d3696 Mon Sep 17 00:00:00 2001
From: Mikhail Zakharov <mikhail.zakha...@jetbrains.com>
Date: Wed, 2 Apr 2025 09:37:06 +0200
Subject: [PATCH 9/9] [lldb] Fixed formatting
---
lldb/source/Commands/CommandObjectProcess.cpp | 8 ++++----
lldb/source/Target/Process.cpp | 3 +--
2 files changed, 5 insertions(+), 6 deletions(-)
diff --git a/lldb/source/Commands/CommandObjectProcess.cpp
b/lldb/source/Commands/CommandObjectProcess.cpp
index 47bbaa0d55745..677fdbfc38fd3 100644
--- a/lldb/source/Commands/CommandObjectProcess.cpp
+++ b/lldb/source/Commands/CommandObjectProcess.cpp
@@ -1834,8 +1834,7 @@ class CommandObjectProcessDumpModId : public
CommandObjectParsed {
: CommandObjectParsed(interpreter, "process dump-mod-id",
"Dump the state of the ProcessModID. Intended to "
"be used for debugging LLDB itself.",
- "process dump-mod-id",
- eCommandRequiresProcess) {}
+ "process dump-mod-id", eCommandRequiresProcess) {}
~CommandObjectProcessDumpModId() override = default;
@@ -1893,8 +1892,9 @@
CommandObjectMultiwordProcess::CommandObjectMultiwordProcess(
LoadSubCommand(
"trace",
CommandObjectSP(new CommandObjectMultiwordProcessTrace(interpreter)));
- LoadSubCommand("dump-mod-id",
- CommandObjectSP(new
CommandObjectProcessDumpModId(interpreter)));
+ LoadSubCommand(
+ "dump-mod-id",
+ CommandObjectSP(new CommandObjectProcessDumpModId(interpreter)));
}
CommandObjectMultiwordProcess::~CommandObjectMultiwordProcess() = default;
diff --git a/lldb/source/Target/Process.cpp b/lldb/source/Target/Process.cpp
index 2db65b058be85..4f4ef4e721281 100644
--- a/lldb/source/Target/Process.cpp
+++ b/lldb/source/Target/Process.cpp
@@ -2287,8 +2287,7 @@ size_t Process::WriteMemory(addr_t addr, const void *buf,
size_t size,
return 0;
#if defined(USE_ALLOCATE_MEMORY_CACHE)
- if (TrackMemoryCacheChanges() ||
- !m_allocated_memory_cache.IsInCache(addr))
+ if (TrackMemoryCacheChanges() || !m_allocated_memory_cache.IsInCache(addr))
m_mod_id.BumpMemoryID();
#else
m_mod_id.BumpMemoryID();
_______________________________________________
lldb-commits mailing list
lldb-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
