Skip to content

[lldb] make PlatformAndroid/AdbClient::GetSyncService threadsafe #145382

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[lldb] make PlatformAndroid/AdbClient::GetSyncService threadsafe #145382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d585051
[lldb] make PlatformAndroid/AdbClient::GetSyncService threadsafe
cs01 Jun 23, 2025
6d96b50
clean up android apis
cs01 Jun 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions lldb/source/Host/posix/ConnectionFileDescriptorPosix.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,12 @@ ConnectionStatus ConnectionFileDescriptor::Disconnect(Status *error_ptr) {
// Prevents reads and writes during shutdown.
m_shutting_down = true;

if (!m_io_sp) {
if (error_ptr)
*error_ptr = Status::FromErrorString("not connected");
return eConnectionStatusNoConnection;
}

Status error = m_io_sp->Close();
if (error.Fail())
status = eConnectionStatusError;
Expand Down
107 changes: 67 additions & 40 deletions lldb/source/Plugins/Platform/Android/AdbClient.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,14 +130,7 @@ const std::string &AdbClient::GetDeviceID() const { return m_device_id; }
Status AdbClient::Connect() {
Status error;
m_conn = std::make_unique<ConnectionFileDescriptor>();
std::string port = "5037";
if (const char *env_port = std::getenv("ANDROID_ADB_SERVER_PORT")) {
port = env_port;
}
std::string uri = "connect://127.0.0.1:" + port;
m_conn->Connect(uri.c_str(), &error);

return error;
return ConnectToAdb(*m_conn);
}

Status AdbClient::GetDevices(DeviceIDList &device_list) {
Expand Down Expand Up @@ -241,6 +234,10 @@ Status AdbClient::SendDeviceMessage(const std::string &packet) {
Status AdbClient::ReadMessage(std::vector<char> &message) {
message.clear();

if (!m_conn) {
return Status::FromErrorString("No connection available");
}

char buffer[5];
buffer[4] = 0;

Expand All @@ -264,6 +261,10 @@ Status AdbClient::ReadMessageStream(std::vector<char> &message,
auto start = steady_clock::now();
message.clear();

if (!m_conn) {
return Status::FromErrorString("No connection available");
}

Status error;
lldb::ConnectionStatus status = lldb::eConnectionStatusSuccess;
char buffer[1024];
Expand Down Expand Up @@ -310,7 +311,7 @@ Status AdbClient::GetResponseError(const char *response_id) {
return Status(std::string(&error_message[0], error_message.size()));
}

Status AdbClient::SwitchDeviceTransport() {
Status AdbClient::SelectTargetDevice() {
std::ostringstream msg;
msg << "host:transport:" << m_device_id;

Expand All @@ -321,21 +322,8 @@ Status AdbClient::SwitchDeviceTransport() {
return ReadResponseStatus();
}

Status AdbClient::StartSync() {
auto error = SwitchDeviceTransport();
if (error.Fail())
return Status::FromErrorStringWithFormat(
"Failed to switch to device transport: %s", error.AsCString());

error = Sync();
if (error.Fail())
return Status::FromErrorStringWithFormat("Sync failed: %s",
error.AsCString());

return error;
}

Status AdbClient::Sync() {
Status AdbClient::EnterSyncMode() {
auto error = SendMessage("sync:", false);
if (error.Fail())
return error;
Expand All @@ -344,17 +332,20 @@ Status AdbClient::Sync() {
}

Status AdbClient::ReadAllBytes(void *buffer, size_t size) {
if (!m_conn) {
return Status::FromErrorString("No connection available");
}
return ::ReadAllBytes(*m_conn, buffer, size);
}

Status AdbClient::internalShell(const char *command, milliseconds timeout,
std::vector<char> &output_buf) {
output_buf.clear();

auto error = SwitchDeviceTransport();
auto error = SelectTargetDevice();
if (error.Fail())
return Status::FromErrorStringWithFormat(
"Failed to switch to device transport: %s", error.AsCString());
"Failed to select target device: %s", error.AsCString());

StreamString adb_command;
adb_command.Printf("shell:%s", command);
Expand Down Expand Up @@ -417,15 +408,6 @@ Status AdbClient::ShellToFile(const char *command, milliseconds timeout,
return Status();
}

std::unique_ptr<AdbClient::SyncService>
AdbClient::GetSyncService(Status &error) {
std::unique_ptr<SyncService> sync_service;
error = StartSync();
if (error.Success())
sync_service.reset(new SyncService(std::move(m_conn)));

return sync_service;
}

Status AdbClient::SyncService::internalPullFile(const FileSpec &remote_file,
const FileSpec &local_file) {
Expand Down Expand Up @@ -487,7 +469,9 @@ Status AdbClient::SyncService::internalPushFile(const FileSpec &local_file,
error.AsCString());
}
error = SendSyncRequest(
kDONE, llvm::sys::toTimeT(FileSystem::Instance().GetModificationTime(local_file)),
kDONE,
llvm::sys::toTimeT(
FileSystem::Instance().GetModificationTime(local_file)),
nullptr);
if (error.Fail())
return error;
Expand Down Expand Up @@ -580,17 +564,23 @@ bool AdbClient::SyncService::IsConnected() const {
return m_conn && m_conn->IsConnected();
}

AdbClient::SyncService::SyncService(std::unique_ptr<Connection> &&conn)
: m_conn(std::move(conn)) {}
AdbClient::SyncService::SyncService(std::unique_ptr<Connection> conn, const std::string &device_id)
: m_conn(std::move(conn)), m_device_id(device_id) {}

Status
AdbClient::SyncService::executeCommand(const std::function<Status()> &cmd) {
if (!m_conn)
return Status::FromErrorString("SyncService is disconnected");
if (!m_conn || !m_conn->IsConnected()) {
Status reconnect_error = SetupSyncConnection(m_device_id);
if (reconnect_error.Fail()) {
return Status::FromErrorStringWithFormat(
"SyncService connection failed: %s", reconnect_error.AsCString());
}
}

Status error = cmd();
if (error.Fail())
if (error.Fail()) {
m_conn.reset();
}

return error;
}
Expand Down Expand Up @@ -665,3 +655,40 @@ Status AdbClient::SyncService::PullFileChunk(std::vector<char> &buffer,
Status AdbClient::SyncService::ReadAllBytes(void *buffer, size_t size) {
return ::ReadAllBytes(*m_conn, buffer, size);
}

Status AdbClient::SyncService::SetupSyncConnection(const std::string &device_id) {
if (!m_conn) {
m_conn = std::make_unique<ConnectionFileDescriptor>();
}

AdbClient temp_client(device_id);
Status error = temp_client.ConnectToAdb(*m_conn);
if (error.Fail())
return error;

temp_client.m_conn = std::move(m_conn);
error = temp_client.SelectTargetDevice();
if (error.Fail()) {
m_conn = std::move(temp_client.m_conn);
return error;
}

error = temp_client.EnterSyncMode();
if (error.Fail()) {
return error;
}
m_conn = std::move(temp_client.m_conn);
return error;
}

Status AdbClient::ConnectToAdb(Connection &conn) {
std::string port = "5037";
if (const char *env_port = std::getenv("ANDROID_ADB_SERVER_PORT")) {
port = env_port;
}
std::string uri = "connect://127.0.0.1:" + port;

Status error;
conn.Connect(uri.c_str(), &error);
return error;
}
37 changes: 20 additions & 17 deletions lldb/source/Plugins/Platform/Android/AdbClient.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,31 +36,32 @@ class AdbClient {
friend class AdbClient;

public:
explicit SyncService(std::unique_ptr<Connection> conn, const std::string &device_id);

virtual ~SyncService();

virtual Status PullFile(const FileSpec &remote_file,
const FileSpec &local_file);

Status PushFile(const FileSpec &local_file, const FileSpec &remote_file);
virtual Status PushFile(const FileSpec &local_file, const FileSpec &remote_file);

virtual Status Stat(const FileSpec &remote_file, uint32_t &mode,
uint32_t &size, uint32_t &mtime);

bool IsConnected() const;
virtual bool IsConnected() const;

const std::string &GetDeviceId() const { return m_device_id; }

protected:
explicit SyncService(std::unique_ptr<Connection> &&conn);
virtual Status SendSyncRequest(const char *request_id, const uint32_t data_len,
const void *data);
virtual Status ReadSyncHeader(std::string &response_id, uint32_t &data_len);
virtual Status ReadAllBytes(void *buffer, size_t size);

private:
Status SendSyncRequest(const char *request_id, const uint32_t data_len,
const void *data);

Status ReadSyncHeader(std::string &response_id, uint32_t &data_len);

Status PullFileChunk(std::vector<char> &buffer, bool &eof);

Status ReadAllBytes(void *buffer, size_t size);

Status internalPullFile(const FileSpec &remote_file,
const FileSpec &local_file);

Expand All @@ -72,7 +73,11 @@ class AdbClient {

Status executeCommand(const std::function<Status()> &cmd);

// Internal connection setup methods
Status SetupSyncConnection(const std::string &device_id);

std::unique_ptr<Connection> m_conn;
std::string m_device_id;
};

static Status CreateByDeviceID(const std::string &device_id, AdbClient &adb);
Expand Down Expand Up @@ -102,15 +107,15 @@ class AdbClient {
std::chrono::milliseconds timeout,
const FileSpec &output_file_spec);

virtual std::unique_ptr<SyncService> GetSyncService(Status &error);
Status SelectTargetDevice();

Status SwitchDeviceTransport();
Status EnterSyncMode();

private:
Status Connect();

void SetDeviceID(const std::string &device_id);

Status Connect();

Status SendMessage(const std::string &packet, const bool reconnect = true);

Status SendDeviceMessage(const std::string &packet);
Expand All @@ -124,15 +129,13 @@ class AdbClient {

Status ReadResponseStatus();

Status Sync();

Status StartSync();

Status internalShell(const char *command, std::chrono::milliseconds timeout,
std::vector<char> &output_buf);

Status ReadAllBytes(void *buffer, size_t size);

Status ConnectToAdb(Connection &conn);

std::string m_device_id;
std::unique_ptr<Connection> m_conn;
};
Expand Down
Loading