wallace updated this revision to Diff 315527.
wallace added a comment.
Followed all the suggestions:
- This is POSIX-only, but making it work for windows should only require
deleting a few #ifdef blocks and using the CreateNamedPipe API instead of
mkfifo. I'll do it later in another diff.
- Added more tests covering different possible failures and making sure that
environment variables are passed correctly.
- Now using JSON for the messages. That will make more robust if in the future
we need to send more information back to the debugger.
- I tried to keep it as simple as possible, but still created a few
abstractions to keep each piece very readable.
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D93951/new/
https://reviews.llvm.org/D93951
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/runInTerminal/TestVSCode_runInTerminal.py
lldb/tools/lldb-vscode/CMakeLists.txt
lldb/tools/lldb-vscode/FifoFiles.cpp
lldb/tools/lldb-vscode/FifoFiles.h
lldb/tools/lldb-vscode/JSONUtils.cpp
lldb/tools/lldb-vscode/JSONUtils.h
lldb/tools/lldb-vscode/Options.td
lldb/tools/lldb-vscode/RunInTerminal.cpp
lldb/tools/lldb-vscode/RunInTerminal.h
lldb/tools/lldb-vscode/VSCode.h
lldb/tools/lldb-vscode/lldb-vscode.cpp
Index: lldb/tools/lldb-vscode/lldb-vscode.cpp
===================================================================
--- lldb/tools/lldb-vscode/lldb-vscode.cpp
+++ lldb/tools/lldb-vscode/lldb-vscode.cpp
@@ -384,12 +384,7 @@
break;
case lldb::eStateSuspended:
break;
- case lldb::eStateStopped: {
- if (g_vsc.waiting_for_run_in_terminal) {
- g_vsc.waiting_for_run_in_terminal = false;
- g_vsc.request_in_terminal_cv.notify_one();
- }
- }
+ case lldb::eStateStopped:
// Only report a stopped event if the process was not restarted.
if (!lldb::SBProcess::GetRestartedFromEvent(event)) {
SendStdOutStdErr(process);
@@ -461,7 +456,7 @@
}
body.try_emplace("module", module_value);
module_event.try_emplace("body", std::move(body));
- g_vsc.SendJSON(llvm::json::Value(std::move(module_event)));
+ // g_vsc.SendJSON(llvm::json::Value(std::move(module_event)));
}
}
} else if (event.BroadcasterMatchesRef(g_vsc.broadcaster)) {
@@ -1441,47 +1436,52 @@
g_vsc.SendJSON(llvm::json::Value(std::move(response)));
}
-void request_runInTerminal(const llvm::json::Object &launch_request,
- llvm::json::Object &launch_response) {
- // We have already created a target that has a valid "program" path to the
- // executable. We will attach to the next process whose name matches that
- // of the target's.
+llvm::Error request_runInTerminal(const llvm::json::Object &launch_request) {
g_vsc.is_attach = true;
lldb::SBAttachInfo attach_info;
- lldb::SBError error;
- attach_info.SetWaitForLaunch(true, /*async*/ true);
- g_vsc.target.Attach(attach_info, error);
- llvm::json::Object reverse_request =
- CreateRunInTerminalReverseRequest(launch_request);
+ llvm::Expected<RunInTerminalCommDir> comm_dir = CreateRunInTerminalCommDir();
+ if (!comm_dir)
+ return comm_dir.takeError();
+
+ RunInTerminalDebugAdapterCommChannel comm_channel(comm_dir->path);
+
+ llvm::json::Object reverse_request = CreateRunInTerminalReverseRequest(
+ launch_request, g_vsc.debug_adaptor_path, comm_dir->path);
llvm::json::Object reverse_response;
lldb_vscode::PacketStatus status =
g_vsc.SendReverseRequest(reverse_request, reverse_response);
if (status != lldb_vscode::PacketStatus::Success)
- error.SetErrorString("Process cannot be launched by IDE.");
+ return llvm::createStringError(llvm::inconvertibleErrorCode(),
+ "Process cannot be launched by the IDE. %s",
+ comm_channel.GetLauncherError().c_str());
- if (error.Success()) {
- // Wait for the attach stop event to happen or for a timeout.
- g_vsc.waiting_for_run_in_terminal = true;
- static std::mutex mutex;
- std::unique_lock<std::mutex> locker(mutex);
- g_vsc.request_in_terminal_cv.wait_for(locker, std::chrono::seconds(10));
+ if (llvm::Expected<lldb::pid_t> pid = comm_channel.GetLauncherPid())
+ attach_info.SetProcessID(*pid);
+ else
+ return pid.takeError();
- auto attached_pid = g_vsc.target.GetProcess().GetProcessID();
- if (attached_pid == LLDB_INVALID_PROCESS_ID)
- error.SetErrorString("Failed to attach to a process");
- else
- SendProcessEvent(Attach);
- }
+ g_vsc.debugger.SetAsync(false);
+ lldb::SBError error;
+ g_vsc.target.Attach(attach_info, error);
- if (error.Fail()) {
- launch_response["success"] = llvm::json::Value(false);
- EmplaceSafeString(launch_response, "message",
- std::string(error.GetCString()));
- } else {
- launch_response["success"] = llvm::json::Value(true);
- g_vsc.SendJSON(CreateEventObject("initialized"));
- }
+ if (error.Fail())
+ return llvm::createStringError(llvm::inconvertibleErrorCode(),
+ "Failed to attach to the target process. %s",
+ comm_channel.GetLauncherError().c_str());
+ // We just attached to the runInTerminal launcher, which was waiting to be
+ // attached. After resuming, it will exec and become the original target the
+ // user provided.
+
+ // This will notify the runInTerminal launcher that we attached.
+ comm_channel.NotifyDidAttach();
+
+ // Here, we resume the process so that it can exec.
+ g_vsc.target.GetProcess().Continue();
+
+ g_vsc.debugger.SetAsync(true);
+
+ return llvm::Error::success();
}
// "LaunchRequest": {
@@ -1556,12 +1556,6 @@
return;
}
- if (GetBoolean(arguments, "runInTerminal", false)) {
- request_runInTerminal(request, response);
- g_vsc.SendJSON(llvm::json::Value(std::move(response)));
- return;
- }
-
// Instantiate a launch info instance for the target.
auto launch_info = g_vsc.target.GetLaunchInfo();
@@ -1597,7 +1591,11 @@
// Run any pre run LLDB commands the user specified in the launch.json
g_vsc.RunPreRunCommands();
- if (launchCommands.empty()) {
+
+ if (GetBoolean(arguments, "runInTerminal", false)) {
+ if (llvm::Error err = request_runInTerminal(request))
+ error.SetErrorString(llvm::toString(std::move(err)).c_str());
+ } else if (launchCommands.empty()) {
// Disable async events so the launch will be successful when we return from
// the launch call and the launch will happen synchronously
g_vsc.debugger.SetAsync(false);
@@ -1616,10 +1614,11 @@
}
g_vsc.SendJSON(llvm::json::Value(std::move(response)));
- SendProcessEvent(Launch);
+ if (g_vsc.is_attach)
+ SendProcessEvent(Attach); // this happens when doing runInTerminal
+ else
+ SendProcessEvent(Launch);
g_vsc.SendJSON(llvm::json::Value(CreateEventObject("initialized")));
- // Reenable async events and start the event thread to catch async events.
- // g_vsc.debugger.SetAsync(true);
}
// "NextRequest": {
@@ -2948,20 +2947,95 @@
llvm::outs() << examples;
}
-int main(int argc, char *argv[]) {
+// If --launch-target is provided, this instance of lldb-vscode becomes a
+// runInTerminal launcher. It will ultimately launch the program specified in
+// the --launch-target argument, which is the original program the user wanted
+// to debug. This is done in such a way that the actual debug adaptor can
+// place breakpoints at the beginning of the program.
+//
+// The launcher will communicate with the debug adaptor using files in the
+// directory specified in the --com-dir argument. Both this launcher and the
+// debug adaptor should use the same path prefix to guarantee correct
+// communication.
+//
+// Regarding the actual flow, this launcher will first notify the debug adaptor
+// of its pid. Then, the launcher will be in a pending state waiting to be
+// attached by the adaptor.
+//
+// Once attached and resumed, the launcher will exec and become the program
+// specified by --launch-target, which is the original target the
+// user wanted to run.
+//
+// In case of errors launching the target, a suitable error message will be
+// emitted to the debug adaptor.
+void LaunchRunInTerminalTarget(llvm::opt::Arg &target_arg,
+ llvm::StringRef comm_dir, char *argv[]) {
+#if defined(WIN_32)
+ llvm::errs() << "runInTerminal is not supported on Windows\n";
+ exit(EXIT_FAILURE);
+#else
+ RunInTerminalLauncherCommChannel comm_channel(comm_dir);
+ comm_channel.NotifyPid();
+
+ // We will wait to be attached with a timeout. We don't wait indefinitely
+ // using a signal to prevent being paused forever.
+
+ // This env var should be used only for tests.
+ const char *timeout_env_var = getenv("LLDB_VSCODE_RIT_TIMEOUT_IN_MS");
+ int timeout_in_ms =
+ timeout_env_var != nullptr ? atoi(timeout_env_var) : 20000;
+ if (llvm::Error err = comm_channel.WaitUntilDebugAdaptorAttaches(
+ std::chrono::milliseconds(timeout_in_ms))) {
+ std::string error = llvm::toString(std::move(err));
+ comm_channel.NotifyError(error);
+ llvm::errs() << error << "\n";
+ exit(EXIT_FAILURE);
+ }
- // Initialize LLDB first before we do anything.
- lldb::SBDebugger::Initialize();
+ const char *target = target_arg.getValue();
+ execvp(target, argv);
- RegisterRequestCallbacks();
+ std::string error = std::strerror(errno);
+ comm_channel.NotifyError(error);
+ llvm::errs() << error << "\n";
+ exit(EXIT_FAILURE);
+#endif
+}
- int portno = -1;
+int main(int argc, char *argv[]) {
+ llvm::SmallString<256> program_path(argv[0]);
+ llvm::sys::fs::make_absolute(program_path);
+ g_vsc.debug_adaptor_path = program_path.str().str();
LLDBVSCodeOptTable T;
unsigned MAI, MAC;
llvm::ArrayRef<const char *> ArgsArr = llvm::makeArrayRef(argv + 1, argc);
llvm::opt::InputArgList input_args = T.ParseArgs(ArgsArr, MAI, MAC);
+ if (llvm::opt::Arg *target_arg = input_args.getLastArg(OPT_launch_target)) {
+ if (llvm::opt::Arg *comm_dir = input_args.getLastArg(OPT_comm_dir)) {
+ int target_args_pos = argc;
+ for (int i = 0; i < argc; i++)
+ if (strcmp(argv[i], "--launch-target") == 0) {
+ target_args_pos = i + 1;
+ break;
+ }
+ LaunchRunInTerminalTarget(*target_arg, comm_dir->getValue(),
+ argv + target_args_pos);
+ } else {
+ llvm::errs() << "\"--launch-target\" requires \"--comm-dir\" to be "
+ "specified\n";
+ exit(EXIT_FAILURE);
+ }
+ }
+
+ // Initialize LLDB first before we do anything.
+ lldb::SBDebugger::Initialize();
+
+ RegisterRequestCallbacks();
+
+ int portno = -1;
+
if (input_args.hasArg(OPT_help)) {
printHelp(T, llvm::sys::path::filename(argv[0]));
return 0;
Index: lldb/tools/lldb-vscode/VSCode.h
===================================================================
--- lldb/tools/lldb-vscode/VSCode.h
+++ lldb/tools/lldb-vscode/VSCode.h
@@ -47,6 +47,7 @@
#include "ExceptionBreakpoint.h"
#include "FunctionBreakpoint.h"
#include "IOStream.h"
+#include "RunInTerminal.h"
#include "SourceBreakpoint.h"
#include "SourceReference.h"
@@ -77,6 +78,7 @@
};
struct VSCode {
+ std::string debug_adaptor_path;
InputStream input;
OutputStream output;
lldb::SBDebugger debugger;
@@ -104,7 +106,6 @@
bool is_attach;
uint32_t reverse_request_seq;
std::map<std::string, RequestCallback> request_handlers;
- std::condition_variable request_in_terminal_cv;
bool waiting_for_run_in_terminal;
// Keep track of the last stop thread index IDs as threads won't go away
// unless we send a "thread" event to indicate the thread exited.
Index: lldb/tools/lldb-vscode/RunInTerminal.h
===================================================================
--- /dev/null
+++ lldb/tools/lldb-vscode/RunInTerminal.h
@@ -0,0 +1,117 @@
+//===-- RunInTerminal.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_TOOLS_LLDB_VSCODE_RUNINTERMINAL_H
+#define LLDB_TOOLS_LLDB_VSCODE_RUNINTERMINAL_H
+
+#include "FifoFiles.h"
+
+namespace lldb_vscode {
+
+enum RunInTerminalMessageKind {
+ eRunInTerminalMessageKindPID = 0,
+ eRunInTerminalMessageKindError,
+};
+
+struct RunInTerminalMessage;
+struct RunInTerminalMessagePid;
+struct RunInTerminalMessageError;
+
+struct RunInTerminalMessage {
+ RunInTerminalMessage(RunInTerminalMessageKind kind);
+
+ virtual ~RunInTerminalMessage() = default;
+
+ /// Serialize this object to JSON
+ virtual llvm::json::Value ToJSON() const = 0;
+
+ const RunInTerminalMessagePid *GetAsPidMessage() const;
+
+ const RunInTerminalMessageError *GetAsErrorMessage() const;
+
+ RunInTerminalMessageKind kind;
+};
+
+using RunInTerminalMessageUP = std::unique_ptr<RunInTerminalMessage>;
+
+struct RunInTerminalMessagePid : RunInTerminalMessage {
+ RunInTerminalMessagePid(lldb::pid_t pid);
+
+ llvm::json::Value ToJSON() const override;
+
+ lldb::pid_t pid;
+};
+
+struct RunInTerminalMessageError : RunInTerminalMessage {
+ RunInTerminalMessageError(llvm::StringRef error);
+
+ llvm::json::Value ToJSON() const override;
+
+ std::string error;
+};
+
+class RunInTerminalLauncherCommChannel {
+public:
+ RunInTerminalLauncherCommChannel(llvm::StringRef comm_dir);
+
+ /// Wait until the debug adaptor attaches.
+ ///
+ /// \param[in] timeout
+ /// How long to wait to be attached.
+ //
+ /// \return
+ /// An \a llvm::Error object in case of errors or if this operation times
+ /// out.
+ llvm::Error WaitUntilDebugAdaptorAttaches(std::chrono::milliseconds timeout);
+
+ /// Notify the debug adaptor this process' pid.
+ void NotifyPid();
+
+ /// Notify the debug adaptor that there's been an error.
+ void NotifyError(llvm::StringRef error);
+
+private:
+ FifoFileWriter m_out;
+ std::string m_comm_dir;
+};
+
+class RunInTerminalDebugAdapterCommChannel {
+public:
+ RunInTerminalDebugAdapterCommChannel(llvm::StringRef comm_dir);
+
+ /// Notify the runInTerminal launcher that it was attached.
+ void NotifyDidAttach();
+
+ /// Fetch the pid of the runInTerminal launcher.
+ ///
+ /// \return
+ /// An \a llvm::Error object in case of errors or if this operation times
+ /// out.
+ llvm::Expected<lldb::pid_t> GetLauncherPid();
+
+ /// Fetch any errors emitted by the runInTerminal launcher or return a
+ /// default error message if a certain timeout if reached.
+ std::string GetLauncherError();
+
+private:
+ FifoFileReader m_in;
+ std::string m_comm_dir;
+};
+
+struct RunInTerminalCommDir {
+ std::string path;
+ std::shared_ptr<FifoFile> to_adaptor;
+};
+
+/// Create the directory and files used to communicate the debug adaptor with
+/// the runInTerminal launcher.
+llvm::Expected<RunInTerminalCommDir> CreateRunInTerminalCommDir();
+
+} // namespace lldb_vscode
+
+#endif // LLDB_TOOLS_LLDB_VSCODE_RUNINTERMINAL_H
Index: lldb/tools/lldb-vscode/RunInTerminal.cpp
===================================================================
--- /dev/null
+++ lldb/tools/lldb-vscode/RunInTerminal.cpp
@@ -0,0 +1,173 @@
+//===-- RunInTerminal.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
+//
+//===----------------------------------------------------------------------===//
+
+#if !defined(WIN32)
+#include <sys/stat.h>
+#include <sys/types.h>
+#include <unistd.h>
+#endif
+
+#include <chrono>
+#include <fstream>
+#include <future>
+#include <thread>
+
+#include "llvm/Support/FileSystem.h"
+
+#include "lldb/lldb-defines.h"
+
+#include "RunInTerminal.h"
+
+using namespace llvm;
+
+namespace lldb_vscode {
+
+const RunInTerminalMessagePid *RunInTerminalMessage::GetAsPidMessage() const {
+ return static_cast<const RunInTerminalMessagePid *>(this);
+}
+
+const RunInTerminalMessageError *
+RunInTerminalMessage::GetAsErrorMessage() const {
+ return static_cast<const RunInTerminalMessageError *>(this);
+}
+
+RunInTerminalMessage::RunInTerminalMessage(RunInTerminalMessageKind kind)
+ : kind(kind) {}
+
+RunInTerminalMessagePid::RunInTerminalMessagePid(lldb::pid_t pid)
+ : RunInTerminalMessage(eRunInTerminalMessageKindPID), pid(pid) {}
+
+json::Value RunInTerminalMessagePid::ToJSON() const {
+ return json::Object{{"kind", "pid"}, {"pid", static_cast<int64_t>(pid)}};
+}
+
+RunInTerminalMessageError::RunInTerminalMessageError(StringRef error)
+ : RunInTerminalMessage(eRunInTerminalMessageKindError), error(error) {}
+
+json::Value RunInTerminalMessageError::ToJSON() const {
+ return json::Object{{"kind", "error"}, {"value", error}};
+}
+
+static Expected<RunInTerminalMessageUP>
+ParseJSONMessage(const json::Value &json) {
+ if (const json::Object *obj = json.getAsObject()) {
+ if (Optional<StringRef> kind = obj->getString("kind")) {
+ if (*kind == "pid") {
+ if (Optional<int64_t> pid = obj->getInteger("pid"))
+ return std::make_unique<RunInTerminalMessagePid>(
+ static_cast<lldb::pid_t>(*pid));
+ } else if (*kind == "error") {
+ if (Optional<StringRef> error = obj->getString("error"))
+ return std::make_unique<RunInTerminalMessageError>(*error);
+ }
+ }
+ }
+
+ return createStringError(inconvertibleErrorCode(),
+ "Incorrect JSON message: " + JSONToString(json));
+}
+
+static Expected<RunInTerminalMessageUP>
+GetNextMessage(FifoFileReader &in, std::chrono::milliseconds timeout) {
+ if (Expected<json::Value> json = in.ReadJSON(timeout))
+ return ParseJSONMessage(*json);
+ else
+ return json.takeError();
+}
+
+static Error ToError(const RunInTerminalMessage &message) {
+ if (message.kind == eRunInTerminalMessageKindError)
+ return createStringError(inconvertibleErrorCode(),
+ message.GetAsErrorMessage()->error);
+ return createStringError(inconvertibleErrorCode(),
+ "Unexpected JSON message: " +
+ JSONToString(message.ToJSON()));
+}
+
+static std::string CreateToAdaptorFilePath(StringRef comm_dir) {
+ return comm_dir.str() + "/to_adaptor";
+}
+
+static std::string CreateDidAttachFilePath(StringRef comm_dir) {
+ return comm_dir.str() + "/did_attach";
+}
+
+RunInTerminalLauncherCommChannel::RunInTerminalLauncherCommChannel(
+ StringRef comm_dir)
+ : m_out(CreateToAdaptorFilePath(comm_dir)), m_comm_dir(comm_dir) {}
+
+Error RunInTerminalLauncherCommChannel::WaitUntilDebugAdaptorAttaches(
+ std::chrono::milliseconds timeout) {
+ std::string did_attach_file = CreateDidAttachFilePath(m_comm_dir);
+ for (int i = 0; i < timeout.count() / 10; i++) {
+ if (llvm::sys::fs::exists(did_attach_file))
+ return Error::success();
+ std::this_thread::sleep_for(std::chrono::milliseconds(10));
+ }
+ return createStringError(inconvertibleErrorCode(),
+ "Timed out waiting for the debugger to attach");
+}
+
+void RunInTerminalLauncherCommChannel::NotifyPid() {
+ m_out.SendJSON(RunInTerminalMessagePid(getpid()).ToJSON());
+}
+
+void RunInTerminalLauncherCommChannel::NotifyError(StringRef error) {
+ m_out.SendJSON(RunInTerminalMessageError(error).ToJSON());
+}
+
+RunInTerminalDebugAdapterCommChannel::RunInTerminalDebugAdapterCommChannel(
+ StringRef comm_dir)
+ : m_in(CreateToAdaptorFilePath(comm_dir), "runInTerminal launcher"),
+ m_comm_dir(comm_dir) {}
+
+void RunInTerminalDebugAdapterCommChannel::NotifyDidAttach() {
+ std::ofstream writer(CreateDidAttachFilePath(m_comm_dir), std::ofstream::out);
+}
+
+Expected<lldb::pid_t> RunInTerminalDebugAdapterCommChannel::GetLauncherPid() {
+ if (Expected<RunInTerminalMessageUP> message =
+ GetNextMessage(m_in, std::chrono::seconds(20))) {
+ if (message.get()->kind == eRunInTerminalMessageKindPID)
+ return message.get()->GetAsPidMessage()->pid;
+ return ToError(*message.get());
+ } else {
+ return message.takeError();
+ }
+}
+
+std::string RunInTerminalDebugAdapterCommChannel::GetLauncherError() {
+ // We know there's been an error, so a small timeout is enough.
+ if (Expected<RunInTerminalMessageUP> message =
+ GetNextMessage(m_in, std::chrono::seconds(1)))
+ return toString(ToError(*message.get()));
+ else
+ return toString(message.takeError());
+}
+
+Expected<RunInTerminalCommDir> CreateRunInTerminalCommDir() {
+ SmallString<256> comm_dir_path;
+ if (std::error_code EC = sys::fs::getPotentiallyUniqueTempFileName(
+ "lldb-vscode-run-in-terminal-comm", "", comm_dir_path))
+ return createStringError(EC, "Error making unique directory name for "
+ "runInTerminal communication files");
+ if (std::error_code EC =
+ sys::fs::create_directory(comm_dir_path, /*ignoreExisting*/ false))
+ return createStringError(
+ EC, "Error creating directory for runInTerminal communication files");
+
+ std::string comm_dir = comm_dir_path.str().str();
+
+ llvm::Expected<std::shared_ptr<FifoFile>> to_adaptor =
+ CreateFifoFile(CreateToAdaptorFilePath(comm_dir));
+ if (!to_adaptor)
+ return to_adaptor.takeError();
+ return RunInTerminalCommDir{comm_dir, *to_adaptor};
+}
+
+} // namespace lldb_vscode
Index: lldb/tools/lldb-vscode/Options.td
===================================================================
--- lldb/tools/lldb-vscode/Options.td
+++ lldb/tools/lldb-vscode/Options.td
@@ -23,3 +23,14 @@
def: Separate<["-"], "p">,
Alias<port>,
HelpText<"Alias for --port">;
+
+def launch_target: Separate<["--", "-"], "launch-target">,
+ MetaVarName<"<target>">,
+ HelpText<"Launch a target for the launchInTerminal request. Any argument "
+ "provided after this one will be passed to the target. The parameter "
+ "--comm-files-prefix must also be specified.">;
+
+def comm_dir: Separate<["--", "-"], "comm-dir">,
+ MetaVarName<"<directory>">,
+ HelpText<"The directory with files used to communicate the with the debug "
+ "adapter adaptor when using --launch-target.">;
Index: lldb/tools/lldb-vscode/JSONUtils.h
===================================================================
--- lldb/tools/lldb-vscode/JSONUtils.h
+++ lldb/tools/lldb-vscode/JSONUtils.h
@@ -449,11 +449,24 @@
/// The original launch_request object whose fields are used to construct
/// the reverse request object.
///
+/// \param[in] debug_adaptor_path
+/// Path to the current debug adaptor. It will be used to delegate the
+/// launch of the target.
+///
+/// \param[in] comm_dir
+/// The directory with files used to communicate the with the target
+/// launcher.
+///
/// \return
/// A "runInTerminal" JSON object that follows the specification outlined by
/// Microsoft.
llvm::json::Object
-CreateRunInTerminalReverseRequest(const llvm::json::Object &launch_request);
+CreateRunInTerminalReverseRequest(const llvm::json::Object &launch_request,
+ llvm::StringRef debug_adaptor_path,
+ llvm::StringRef comm_dir);
+
+/// Convert a given JSON object to a string.
+std::string JSONToString(const llvm::json::Value &json);
} // namespace lldb_vscode
Index: lldb/tools/lldb-vscode/JSONUtils.cpp
===================================================================
--- lldb/tools/lldb-vscode/JSONUtils.cpp
+++ lldb/tools/lldb-vscode/JSONUtils.cpp
@@ -1001,7 +1001,9 @@
/// See
/// https://microsoft.github.io/debug-adapter-protocol/specification#Reverse_Requests_RunInTerminal
llvm::json::Object
-CreateRunInTerminalReverseRequest(const llvm::json::Object &launch_request) {
+CreateRunInTerminalReverseRequest(const llvm::json::Object &launch_request,
+ llvm::StringRef debug_adaptor_path,
+ llvm::StringRef comm_dir) {
llvm::json::Object reverse_request;
reverse_request.try_emplace("type", "request");
reverse_request.try_emplace("command", "runInTerminal");
@@ -1012,10 +1014,13 @@
run_in_terminal_args.try_emplace("kind", "integrated");
auto launch_request_arguments = launch_request.getObject("arguments");
- std::vector<std::string> args = GetStrings(launch_request_arguments, "args");
// The program path must be the first entry in the "args" field
- args.insert(args.begin(),
- GetString(launch_request_arguments, "program").str());
+ std::vector<std::string> args = {
+ debug_adaptor_path.str(), "--comm-dir", comm_dir.str(), "--launch-target",
+ GetString(launch_request_arguments, "program").str()};
+ std::vector<std::string> target_args =
+ GetStrings(launch_request_arguments, "args");
+ args.insert(args.end(), target_args.begin(), target_args.end());
run_in_terminal_args.try_emplace("args", args);
const auto cwd = GetString(launch_request_arguments, "cwd");
@@ -1038,4 +1043,12 @@
return reverse_request;
}
+std::string JSONToString(const llvm::json::Value &json) {
+ std::string data;
+ llvm::raw_string_ostream os(data);
+ os << json;
+ os.flush();
+ return data;
+}
+
} // namespace lldb_vscode
Index: lldb/tools/lldb-vscode/FifoFiles.h
===================================================================
--- /dev/null
+++ lldb/tools/lldb-vscode/FifoFiles.h
@@ -0,0 +1,86 @@
+//===-- FifoFiles.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_TOOLS_LLDB_VSCODE_FIFOFILES_H
+#define LLDB_TOOLS_LLDB_VSCODE_FIFOFILES_H
+
+#include "llvm/Support/Error.h"
+
+#include "JSONUtils.h"
+
+namespace lldb_vscode {
+
+/// Struct that controls the life of a fifo file in the filesystem.
+///
+/// The file is destroyed when the destructor is invoked.
+struct FifoFile {
+ FifoFile(llvm::StringRef path);
+
+ ~FifoFile();
+
+ std::string m_path;
+};
+
+/// Create a fifo file in the filesystem.
+///
+/// \param[in] path
+/// The path for the fifo file.
+///
+/// \return
+/// A \a std::shared_ptr<FifoFile> if the file could be created, or an
+/// \a llvm::Error in case of failures.
+llvm::Expected<std::shared_ptr<FifoFile>> CreateFifoFile(llvm::StringRef path);
+
+class FifoFileReader {
+public:
+ /// \param[in] in_fifo_file
+ /// The path to an input fifo file that exists in the file system.
+ ///
+ /// \param[in] input_pretty_name
+ /// Human readable name for the input channel. Used for printing error
+ /// messages.
+ FifoFileReader(llvm::StringRef in_fifo_file,
+ llvm::StringRef input_pretty_name);
+
+ /// Read the next JSON object from the underlying input fifo file.
+ ///
+ /// The JSON object is expected to be a single line delimited with \a
+ /// std::endl.
+ ///
+ /// \return
+ /// An \a llvm::Error object indicating the success or failure of this
+ /// operation. Failures arise if the timeout is hit, the next line of text
+ /// from the fifo file is not a valid JSON object, or is it impossible to
+ /// read from the file.
+ llvm::Expected<llvm::json::Value> ReadJSON(std::chrono::milliseconds timeout);
+
+private:
+ std::string m_in_fifo_file;
+ std::string m_input_pretty_name;
+};
+
+class FifoFileWriter {
+public:
+ /// \param[in] out_fifo_file
+ /// The path to an output fifo file that exists in the file system.
+ FifoFileWriter(llvm::StringRef out_fifo_file);
+
+ /// Serialize a JSON object and write it to the underlying output fifo file.
+ ///
+ /// \param[in] json
+ /// The JSON object to send. It will be printed as a single line delimited
+ /// with \a std::endl.
+ void SendJSON(const llvm::json::Value &json);
+
+private:
+ std::string m_out_fifo_file;
+};
+
+} // namespace lldb_vscode
+
+#endif // LLDB_TOOLS_LLDB_VSCODE_FIFOFILES_H
Index: lldb/tools/lldb-vscode/FifoFiles.cpp
===================================================================
--- /dev/null
+++ lldb/tools/lldb-vscode/FifoFiles.cpp
@@ -0,0 +1,84 @@
+//===-- FifoFiles.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
+//
+//===----------------------------------------------------------------------===//
+
+#if !defined(WIN32)
+#include <sys/stat.h>
+#include <sys/types.h>
+#include <unistd.h>
+#endif
+
+#include <chrono>
+#include <fstream>
+#include <future>
+#include <thread>
+
+#include "llvm/Support/FileSystem.h"
+
+#include "lldb/lldb-defines.h"
+
+#include "FifoFiles.h"
+
+using namespace llvm;
+
+namespace lldb_vscode {
+
+FifoFile::FifoFile(StringRef path) : m_path(path) {}
+
+FifoFile::~FifoFile() {
+#if !defined(WIN32)
+ unlink(m_path.c_str());
+#endif
+};
+
+Expected<std::shared_ptr<FifoFile>> CreateFifoFile(StringRef path) {
+#if defined(WIN32)
+ return createStringError(inconvertibleErrorCode(), "Unimplemented");
+#else
+ if (int err = mkfifo(path.data(), 0600))
+ return createStringError(std::error_code(err, std::generic_category()),
+ "Couldn't create fifo file: %s", path.data());
+ return std::make_shared<FifoFile>(path);
+#endif
+}
+
+FifoFileReader::FifoFileReader(StringRef in_fifo_file,
+ StringRef input_pretty_name)
+ : m_in_fifo_file(in_fifo_file), m_input_pretty_name(input_pretty_name) {}
+
+FifoFileWriter::FifoFileWriter(StringRef out_fifo_file)
+ : m_out_fifo_file(out_fifo_file) {}
+
+Expected<json::Value>
+FifoFileReader::ReadJSON(std::chrono::milliseconds timeout) {
+ // We use a pointer for this future, because otherwise its normal destructor
+ // would wait for the getline to end, rendering the timeout useless.
+ Optional<std::string> line;
+ std::future<void> *future =
+ new std::future<void>(std::async(std::launch::async, [&]() {
+ std::string buffer;
+ std::ifstream reader(m_in_fifo_file, std::ifstream::in);
+ std::getline(reader, buffer);
+ if (!buffer.empty())
+ line = buffer;
+ }));
+ if (future->wait_for(timeout) == std::future_status::timeout ||
+ !line.hasValue())
+ return createStringError(inconvertibleErrorCode(),
+ "Timed out trying to get messages from the " +
+ m_input_pretty_name);
+
+ delete future;
+ return json::parse(*line);
+}
+
+void FifoFileWriter::SendJSON(const json::Value &json) {
+ std::ofstream writer(m_out_fifo_file, std::ofstream::out);
+ writer << JSONToString(json) << std::endl;
+}
+
+} // namespace lldb_vscode
Index: lldb/tools/lldb-vscode/CMakeLists.txt
===================================================================
--- lldb/tools/lldb-vscode/CMakeLists.txt
+++ lldb/tools/lldb-vscode/CMakeLists.txt
@@ -27,10 +27,12 @@
lldb-vscode.cpp
BreakpointBase.cpp
ExceptionBreakpoint.cpp
+ FifoFiles.cpp
FunctionBreakpoint.cpp
IOStream.cpp
JSONUtils.cpp
LLDBUtils.cpp
+ RunInTerminal.cpp
SourceBreakpoint.cpp
VSCode.cpp
Index: lldb/test/API/tools/lldb-vscode/runInTerminal/TestVSCode_runInTerminal.py
===================================================================
--- lldb/test/API/tools/lldb-vscode/runInTerminal/TestVSCode_runInTerminal.py
+++ lldb/test/API/tools/lldb-vscode/runInTerminal/TestVSCode_runInTerminal.py
@@ -11,13 +11,16 @@
import lldbvscode_testcase
import time
import os
+import subprocess
+import shutil
+import json
class TestVSCode_runInTerminal(lldbvscode_testcase.VSCodeTestCaseBase):
mydir = TestBase.compute_mydir(__file__)
- @skipUnlessDarwin
+ @skipIfWindows
@skipIfRemote
def test_runInTerminal(self):
'''
@@ -26,7 +29,9 @@
'''
program = self.getBuildArtifact("a.out")
source = 'main.c'
- self.build_and_launch(program, stopOnEntry=True, runInTerminal=True, args=["foobar"], env=["FOO=bar"])
+ self.build_and_launch(
+ program, stopOnEntry=True, runInTerminal=True, args=["foobar"],
+ env=["FOO=bar"])
breakpoint_line = line_number(source, '// breakpoint')
self.set_source_breakpoints(source, [breakpoint_line])
@@ -46,3 +51,93 @@
# We verify we were able to set the environment
env = self.vscode.request_evaluate('foo')['body']['result']
self.assertIn('bar', env)
+
+ @skipIfWindows
+ @skipIfRemote
+ def test_runInTerminalInvalidTarget(self):
+ self.build_and_create_debug_adaptor()
+ response = self.launch(
+ "INVALIDPROGRAM", stopOnEntry=True, runInTerminal=True, args=["foobar"], env=["FOO=bar"], expectFailure=True)
+ self.assertFalse(response['success'])
+ self.assertIn("Could not create a target for a program 'INVALIDPROGRAM': unable to find executable",
+ response['message'])
+
+ @skipIfWindows
+ @skipIfRemote
+ def test_missingArgInRunInTerminalLauncher(self):
+ proc = subprocess.run([self.lldbVSCodeExec, "--launch-target", "INVALIDPROGRAM"],
+ capture_output=True, universal_newlines=True)
+ self.assertTrue(proc.returncode != 0)
+ self.assertIn('"--launch-target" requires "--comm-dir" to be specified', proc.stderr)
+
+ @skipIfWindows
+ @skipIfRemote
+ def test_FakeAttachedRunInTerminalLauncherWithInvalidProgram(self):
+ comm_dir = os.path.join(self.getBuildDir(), "comm-dir")
+ to_adaptor_file = os.path.join(comm_dir, "to_adaptor")
+ did_attach_file = os.path.join(comm_dir, "did_attach")
+
+ os.mkdir(comm_dir)
+ with open(did_attach_file, "w") as out:
+ pass
+
+ proc = subprocess.run(
+ [self.lldbVSCodeExec, "--comm-dir", comm_dir, "--launch-target", "INVALIDPROGRAM"],
+ capture_output=True, universal_newlines=True)
+
+ # We check the error message in both stderr and the error file
+ self.assertIn("No such file or directory", proc.stderr)
+ with open(to_adaptor_file) as f:
+ self.assertIn("No such file or directory", f.readline())
+
+ @skipIfWindows
+ @skipIfRemote
+ def test_FakeAttachedRunInTerminalLauncherWithValidProgram(self):
+ comm_dir = os.path.join(self.getBuildDir(), "comm-dir")
+ did_attach_file = os.path.join(comm_dir, "did_attach")
+
+ os.mkdir(comm_dir)
+ with open(did_attach_file, "w") as out:
+ pass
+
+ print(comm_dir)
+ proc = subprocess.run(
+ [self.lldbVSCodeExec, "--comm-dir", comm_dir, "--launch-target", "echo", "foo"],
+ capture_output=True, universal_newlines=True)
+
+ # We check the error message in both stderr and the error file
+ self.assertIn("foo", proc.stdout)
+
+ @skipIfWindows
+ @skipIfRemote
+ def test_FakeAttachedRunInTerminalLauncherAndCheckEnvironment(self):
+ comm_dir = os.path.join(self.getBuildDir(), "comm-dir")
+ did_attach_file = os.path.join(comm_dir, "did_attach")
+
+ os.mkdir(comm_dir)
+ with open(did_attach_file, "w") as out:
+ pass
+
+ proc = subprocess.run(
+ [self.lldbVSCodeExec, "--comm-dir", comm_dir, "--launch-target", "env"],
+ capture_output=True, universal_newlines=True, env={**os.environ, "FOO": "BAR"})
+
+ # We check the error message in both stderr and the error file
+ self.assertIn("FOO=BAR", proc.stdout)
+
+ @skipIfWindows
+ @skipIfRemote
+ def test_NonAttachedRunInTerminalLauncher(self):
+ comm_dir = os.path.join(self.getBuildDir(), "comm-dir")
+ to_adaptor_file = os.path.join(comm_dir, "to_adaptor")
+
+ os.mkdir(comm_dir)
+
+ proc = subprocess.run(
+ [self.lldbVSCodeExec, "--comm-dir", comm_dir, "--launch-target", "echo", "foo"],
+ capture_output=True, universal_newlines=True,
+ env={**os.environ, "LLDB_VSCODE_RIT_TIMEOUT_IN_MS": "1000"})
+ # We check the error message in both stderr and the error file
+ self.assertIn("Timed out waiting for the debugger to attach", proc.stderr)
+ with open(to_adaptor_file) as f:
+ self.assertIn("Timed out waiting for the debugger to attach", f.readline())
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
@@ -617,7 +617,7 @@
stopCommands=None, exitCommands=None,
terminateCommands=None ,sourcePath=None,
debuggerRoot=None, launchCommands=None, sourceMap=None,
- runInTerminal=False):
+ runInTerminal=False, expectFailure=False):
args_dict = {
'program': program
}
@@ -665,9 +665,10 @@
}
response = self.send_recv(command_dict)
- # Wait for a 'process' and 'initialized' event in any order
- self.wait_for_event(filter=['process', 'initialized'])
- self.wait_for_event(filter=['process', 'initialized'])
+ if not expectFailure:
+ # Wait for a 'process' and 'initialized' event in any order
+ self.wait_for_event(filter=['process', 'initialized'])
+ self.wait_for_event(filter=['process', 'initialized'])
return response
def request_next(self, threadId):
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
@@ -282,7 +282,8 @@
trace=False, initCommands=None, preRunCommands=None,
stopCommands=None, exitCommands=None, terminateCommands=None,
sourcePath=None, debuggerRoot=None, launchCommands=None,
- sourceMap=None, disconnectAutomatically=True, runInTerminal=False):
+ sourceMap=None, disconnectAutomatically=True, runInTerminal=False,
+ expectFailure=False):
'''Sending launch request to vscode
'''
@@ -317,7 +318,12 @@
debuggerRoot=debuggerRoot,
launchCommands=launchCommands,
sourceMap=sourceMap,
- runInTerminal=runInTerminal)
+ runInTerminal=runInTerminal,
+ expectFailure=expectFailure)
+
+ if expectFailure:
+ return response
+
if not (response and response['success']):
self.assertTrue(response['success'],
'launch failed (%s)' % (response['message']))
@@ -325,6 +331,7 @@
# attached a runInTerminal process to finish initialization.
if runInTerminal:
self.vscode.request_configurationDone()
+ return response
def build_and_launch(self, program, args=None, cwd=None, env=None,
_______________________________________________
lldb-commits mailing list
lldb-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
