yinghuitan created this revision.
yinghuitan added reviewers: clayborg, labath, jingham, jdoerfert, JDevlieghere,
kusmour, GeorgeHuyubo.
Herald added a project: All.
yinghuitan requested review of this revision.
Herald added a project: LLDB.
Herald added a subscriber: lldb-commits.
This patch adds a new runToBinaryEntry option which sets a one-shot breakpoint
at program entry. This option is useful for synchronizing module loading with
dynamic loader to measure debugger startup performance: when program entry
one-short breakpoint hits most of the dependency modules should have been
loaded so this provides a good sample point for debugger startup time.
More explicitly for lldb-vscode, when this option is enabled, "Initialized" DAP
event is synchronously sent after most dependency modules are loaded.
Note: this is re-submission of https://reviews.llvm.org/D135798
Repository:
rG LLVM Github Monorepo
https://reviews.llvm.org/D138589
Files:
lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/lldbvscode_testcase.py
lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/vscode.py
lldb/test/API/tools/lldb-vscode/launch/TestVSCode_launch.py
lldb/tools/lldb-vscode/VSCode.cpp
lldb/tools/lldb-vscode/VSCode.h
lldb/tools/lldb-vscode/lldb-vscode.cpp
lldb/tools/lldb-vscode/package.json
Index: lldb/tools/lldb-vscode/package.json
===================================================================
--- lldb/tools/lldb-vscode/package.json
+++ lldb/tools/lldb-vscode/package.json
@@ -157,6 +157,11 @@
"description": "Automatically stop after launch.",
"default": false
},
+ "runToBinaryEntry": {
+ "type": "boolean",
+ "description": "run to program entry one-shot breakpoint during launch to ensure dependency modules are loaded.",
+ "default": false
+ },
"disableASLR": {
"type": "boolean",
"description": "Enable or disable Address space layout randomization if the debugger supports it.",
Index: lldb/tools/lldb-vscode/lldb-vscode.cpp
===================================================================
--- lldb/tools/lldb-vscode/lldb-vscode.cpp
+++ lldb/tools/lldb-vscode/lldb-vscode.cpp
@@ -1610,6 +1610,68 @@
error.GetCString());
}
+lldb::SBError RunToBinaryEntry() {
+ lldb::SBError error;
+ if (!g_vsc.run_to_binary_entry)
+ return error;
+
+ if (g_vsc.stop_at_entry) {
+ g_vsc.SendOutput(OutputType::Console,
+ "RunToBinaryEntry is ignored due to StopOnEntry\n");
+ return error;
+ }
+
+ lldb::SBTarget target = g_vsc.debugger.GetSelectedTarget();
+ if (!target.IsValid())
+ return error;
+ lldb::SBFileSpec exe_file = target.GetExecutable();
+ if (!exe_file.IsValid())
+ return error;
+ lldb::SBModule exe_module = target.FindModule(exe_file);
+ if (!exe_module.IsValid()) {
+ g_vsc.SendOutput(OutputType::Console,
+ "RunToBinaryEntry failed: invalid executable module\n");
+ return error;
+ }
+
+ lldb::SBAddress entry_point = exe_module.GetObjectFileEntryPointAddress();
+ if (!entry_point.IsValid()) {
+ g_vsc.SendOutput(OutputType::Console,
+ "RunToBinaryEntry failed: can't find entry point\n");
+ return error;
+ }
+ lldb::SBBreakpoint entry_breakpoint =
+ target.BreakpointCreateBySBAddress(entry_point);
+ if (!entry_breakpoint.IsValid() || entry_breakpoint.GetNumLocations() == 0) {
+ g_vsc.SendOutput(OutputType::Console,
+ "RunToBinaryEntry failed: can't resolve the entry point breakpoint\n");
+ return error;
+ }
+
+ uint32_t old_stop_id = target.GetProcess().GetStopID();
+ entry_breakpoint.SetOneShot(true);
+ error = target.GetProcess().Continue();
+ if (error.Fail())
+ return error;
+
+ const uint64_t timeout_seconds = 600;
+ error = g_vsc.WaitForProcessToStop(timeout_seconds, old_stop_id);
+ if (error.Fail())
+ return error;
+
+ // Successfully got a process stop; we still need to check if the stop is what
+ // we expected.
+ if (entry_breakpoint.GetHitCount() == 0)
+ g_vsc.SendOutput(OutputType::Telemetry,
+ "RunToBinaryEntry failed: process stopped not at the "
+ "binary's entry point\n");
+ else
+ g_vsc.SendOutput(OutputType::Telemetry,
+ "RunToBinaryEntry success: Process stopped successfully "
+ "at the binary's entry point\n");
+ return error;
+}
+
// "LaunchRequest": {
// "allOf": [ { "$ref": "#/definitions/Request" }, {
// "type": "object",
@@ -1659,6 +1721,7 @@
std::vector<std::string> postRunCommands =
GetStrings(arguments, "postRunCommands");
g_vsc.stop_at_entry = GetBoolean(arguments, "stopOnEntry", false);
+ g_vsc.run_to_binary_entry = GetBoolean(arguments, "runToBinaryEntry", false);
const llvm::StringRef debuggerRoot = GetString(arguments, "debuggerRoot");
const uint64_t timeout_seconds = GetUnsigned(arguments, "timeout", 30);
@@ -1741,6 +1804,9 @@
error = g_vsc.WaitForProcessToStop(timeout_seconds);
}
+ if (error.Success())
+ error = RunToBinaryEntry();
+
if (error.Fail()) {
response["success"] = llvm::json::Value(false);
EmplaceSafeString(response, "message", std::string(error.GetCString()));
Index: lldb/tools/lldb-vscode/VSCode.h
===================================================================
--- lldb/tools/lldb-vscode/VSCode.h
+++ lldb/tools/lldb-vscode/VSCode.h
@@ -144,6 +144,7 @@
lldb::tid_t focus_tid;
bool sent_terminated_event;
bool stop_at_entry;
+ bool run_to_binary_entry = false;
bool is_attach;
bool configuration_done_sent;
uint32_t reverse_request_seq;
@@ -261,9 +262,14 @@
///
/// \param[in] seconds
/// The number of seconds to poll the process to wait until it is stopped.
+ /// \param[in] old_stop_id
+ /// Optional old stop id which we should only check for stopped state if
+ /// the new stop id is greater than it. This is needed if the previous state
+ /// is stopped so that we can ensure we are checking new stopped state not
+ /// the old one in async mode.
///
/// \return Error if waiting for the process fails, no error if succeeds.
- lldb::SBError WaitForProcessToStop(uint32_t seconds);
+ lldb::SBError WaitForProcessToStop(uint32_t seconds, uint32_t old_stop_id = 0);
private:
// Send the JSON in "json_str" to the "out" stream. Correctly send the
Index: lldb/tools/lldb-vscode/VSCode.cpp
===================================================================
--- lldb/tools/lldb-vscode/VSCode.cpp
+++ lldb/tools/lldb-vscode/VSCode.cpp
@@ -528,7 +528,8 @@
request_handlers[request] = callback;
}
-lldb::SBError VSCode::WaitForProcessToStop(uint32_t seconds) {
+lldb::SBError VSCode::WaitForProcessToStop(uint32_t seconds,
+ uint32_t old_stop_id) {
lldb::SBError error;
lldb::SBProcess process = target.GetProcess();
if (!process.IsValid()) {
@@ -538,28 +539,33 @@
auto timeout_time =
std::chrono::steady_clock::now() + std::chrono::seconds(seconds);
while (std::chrono::steady_clock::now() < timeout_time) {
+ // Wait for stop id changed before checking for stopped state.
+ // This is needed to make sure we are not checking old stopped state in
+ // async mode.
+ if (old_stop_id > 0 && process.GetStopID() <= old_stop_id)
+ continue;
const auto state = process.GetState();
switch (state) {
- case lldb::eStateAttaching:
- case lldb::eStateConnected:
- case lldb::eStateInvalid:
- case lldb::eStateLaunching:
- case lldb::eStateRunning:
- case lldb::eStateStepping:
- case lldb::eStateSuspended:
- break;
- case lldb::eStateDetached:
- error.SetErrorString("process detached during launch or attach");
- return error;
- case lldb::eStateExited:
- error.SetErrorString("process exited during launch or attach");
- return error;
- case lldb::eStateUnloaded:
- error.SetErrorString("process unloaded during launch or attach");
- return error;
- case lldb::eStateCrashed:
- case lldb::eStateStopped:
- return lldb::SBError(); // Success!
+ case lldb::eStateAttaching:
+ case lldb::eStateConnected:
+ case lldb::eStateInvalid:
+ case lldb::eStateLaunching:
+ case lldb::eStateRunning:
+ case lldb::eStateStepping:
+ case lldb::eStateSuspended:
+ break;
+ case lldb::eStateDetached:
+ error.SetErrorString("process detached during launch or attach");
+ return error;
+ case lldb::eStateExited:
+ error.SetErrorString("process exited during launch or attach");
+ return error;
+ case lldb::eStateUnloaded:
+ error.SetErrorString("process unloaded during launch or attach");
+ return error;
+ case lldb::eStateCrashed:
+ case lldb::eStateStopped:
+ return lldb::SBError(); // Success!
}
std::this_thread::sleep_for(std::chrono::microseconds(250));
}
Index: lldb/test/API/tools/lldb-vscode/launch/TestVSCode_launch.py
===================================================================
--- lldb/test/API/tools/lldb-vscode/launch/TestVSCode_launch.py
+++ lldb/test/API/tools/lldb-vscode/launch/TestVSCode_launch.py
@@ -78,6 +78,29 @@
reason, 'breakpoint',
'verify stop isn\'t "main" breakpoint')
+ @skipIfWindows
+ @skipIfRemote
+ def test_runToBinaryEntry(self):
+ '''
+ Tests the runToBinaryEntry option can successfully launch a simple
+ program and hit a breakpoint and does not interupt the launch.
+ '''
+ program = self.getBuildArtifact("a.out")
+ self.build_and_launch(program, runToBinaryEntry=True)
+ self.set_function_breakpoints(['main'])
+ stopped_events = self.continue_to_next_stop()
+ telemetry = self.get_telemetry()
+ self.assertIn("Process stopped successfully at the binary's entry point", telemetry)
+
+ for stopped_event in stopped_events:
+ if 'body' in stopped_event:
+ body = stopped_event['body']
+ if 'reason' in body:
+ reason = body['reason']
+ self.assertTrue(
+ reason == 'breakpoint',
+ 'verify successfully stop at "main" breakpoint')
+
@skipIfWindows
@skipIfRemote
def test_cwd(self):
Index: lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/vscode.py
===================================================================
--- lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/vscode.py
+++ lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/vscode.py
@@ -650,7 +650,7 @@
terminateCommands=None ,sourcePath=None,
debuggerRoot=None, launchCommands=None, sourceMap=None,
runInTerminal=False, expectFailure=False,
- postRunCommands=None):
+ postRunCommands=None, runToBinaryEntry=False):
args_dict = {
'program': program
}
@@ -662,6 +662,8 @@
args_dict['env'] = env
if stopOnEntry:
args_dict['stopOnEntry'] = stopOnEntry
+ if runToBinaryEntry:
+ args_dict['runToBinaryEntry'] = runToBinaryEntry
if disableASLR:
args_dict['disableASLR'] = disableASLR
if disableSTDIO:
Index: lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/lldbvscode_testcase.py
===================================================================
--- lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/lldbvscode_testcase.py
+++ lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/lldbvscode_testcase.py
@@ -188,6 +188,9 @@
def get_console(self, timeout=0.0):
return self.vscode.get_output('console', timeout=timeout)
+ def get_telemetry(self, timeout=0.0):
+ return self.vscode.get_output('telemetry', timeout=timeout)
+
def collect_console(self, duration):
return self.vscode.collect_output('console', duration=duration)
@@ -286,7 +289,7 @@
stopCommands=None, exitCommands=None, terminateCommands=None,
sourcePath=None, debuggerRoot=None, sourceInitFile=False, launchCommands=None,
sourceMap=None, disconnectAutomatically=True, runInTerminal=False,
- expectFailure=False, postRunCommands=None):
+ expectFailure=False, postRunCommands=None, runToBinaryEntry=False):
'''Sending launch request to vscode
'''
@@ -323,7 +326,8 @@
sourceMap=sourceMap,
runInTerminal=runInTerminal,
expectFailure=expectFailure,
- postRunCommands=postRunCommands)
+ postRunCommands=postRunCommands,
+ runToBinaryEntry=runToBinaryEntry)
if expectFailure:
return response
@@ -346,7 +350,7 @@
terminateCommands=None, sourcePath=None,
debuggerRoot=None, sourceInitFile=False, runInTerminal=False,
disconnectAutomatically=True, postRunCommands=None,
- lldbVSCodeEnv=None):
+ lldbVSCodeEnv=None, runToBinaryEntry=False):
'''Build the default Makefile target, create the VSCode debug adaptor,
and launch the process.
'''
@@ -359,4 +363,5 @@
terminateCommands, sourcePath, debuggerRoot, sourceInitFile,
runInTerminal=runInTerminal,
disconnectAutomatically=disconnectAutomatically,
- postRunCommands=postRunCommands)
+ postRunCommands=postRunCommands,
+ runToBinaryEntry=runToBinaryEntry)
_______________________________________________
lldb-commits mailing list
lldb-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
