1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 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
//
//===----------------------------------------------------------------------===//
#include "RunInTerminal.h"
#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"
using namespace llvm;
namespace lldb_dap {
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}};
}
RunInTerminalMessageDidAttach::RunInTerminalMessageDidAttach()
: RunInTerminalMessage(eRunInTerminalMessageKindDidAttach) {}
json::Value RunInTerminalMessageDidAttach::ToJSON() const {
return json::Object{{"kind", "didAttach"}};
}
static Expected<RunInTerminalMessageUP>
ParseJSONMessage(const json::Value &json) {
if (const json::Object *obj = json.getAsObject()) {
if (std::optional<StringRef> kind = obj->getString("kind")) {
if (*kind == "pid") {
if (std::optional<int64_t> pid = obj->getInteger("pid"))
return std::make_unique<RunInTerminalMessagePid>(
static_cast<lldb::pid_t>(*pid));
} else if (*kind == "error") {
if (std::optional<StringRef> error = obj->getString("error"))
return std::make_unique<RunInTerminalMessageError>(*error);
} else if (*kind == "didAttach") {
return std::make_unique<RunInTerminalMessageDidAttach>();
}
}
}
return createStringError(inconvertibleErrorCode(),
"Incorrect JSON message: " + JSONToString(json));
}
static Expected<RunInTerminalMessageUP>
GetNextMessage(FifoFileIO &io, std::chrono::milliseconds timeout) {
if (Expected<json::Value> json = io.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()));
}
RunInTerminalLauncherCommChannel::RunInTerminalLauncherCommChannel(
StringRef comm_file)
: m_io(comm_file, "debug adaptor") {}
Error RunInTerminalLauncherCommChannel::WaitUntilDebugAdaptorAttaches(
std::chrono::milliseconds timeout) {
if (Expected<RunInTerminalMessageUP> message =
GetNextMessage(m_io, timeout)) {
if (message.get()->kind == eRunInTerminalMessageKindDidAttach)
return Error::success();
else
return ToError(*message.get());
} else
return message.takeError();
}
Error RunInTerminalLauncherCommChannel::NotifyPid() {
return m_io.SendJSON(RunInTerminalMessagePid(getpid()).ToJSON());
}
void RunInTerminalLauncherCommChannel::NotifyError(StringRef error) {
if (Error err = m_io.SendJSON(RunInTerminalMessageError(error).ToJSON(),
std::chrono::seconds(2)))
llvm::errs() << llvm::toString(std::move(err)) << "\n";
}
RunInTerminalDebugAdapterCommChannel::RunInTerminalDebugAdapterCommChannel(
StringRef comm_file)
: m_io(comm_file, "runInTerminal launcher") {}
// Can't use \a std::future<llvm::Error> because it doesn't compile on Windows
std::future<lldb::SBError>
RunInTerminalDebugAdapterCommChannel::NotifyDidAttach() {
return std::async(std::launch::async, [&]() {
lldb::SBError error;
if (llvm::Error err =
m_io.SendJSON(RunInTerminalMessageDidAttach().ToJSON()))
error.SetErrorString(llvm::toString(std::move(err)).c_str());
return error;
});
}
Expected<lldb::pid_t> RunInTerminalDebugAdapterCommChannel::GetLauncherPid() {
if (Expected<RunInTerminalMessageUP> message =
GetNextMessage(m_io, 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_io, std::chrono::seconds(1)))
return toString(ToError(*message.get()));
else
return toString(message.takeError());
}
Expected<std::shared_ptr<FifoFile>> CreateRunInTerminalCommFile() {
SmallString<256> comm_file;
if (std::error_code EC = sys::fs::getPotentiallyUniqueTempFileName(
"lldb-dap-run-in-terminal-comm", "", comm_file))
return createStringError(EC, "Error making unique file name for "
"runInTerminal communication files");
return CreateFifoFile(comm_file.str());
}
} // namespace lldb_dap
|