mirror of
https://github.com/google/cdc-file-transfer.git
synced 2026-09-13 01:10:44 +03:00
[cdc_rsync] Detect remote architecture (#86)
Improves ServerArch so that it can detect the remote architecture by running uname and checking %PROCESSOR_ARCHITECTURE%. So far, only x64 Linux and x64 Windows are supported, but in the future it is easy to add support for others, e.g. aarch64, as well. Before the detection is run, the remote architecture is guessed first based on the destination. For instance, if the destination directory starts with "C:\", it pretty much means Windows. If cdc_rsync_server exists and runs fine, there's no need for detection. Since also PortManager depends on the remote architecture, it has to be adjusted as well. So far, PortManager assumeed that "local" means Windows and "remote" means Linux. This is no longer the case for syncing to Windows devices, so this CL adds the necessary abstractions to PortManager. Also refactors ArchType into a separate class in common, since it is used now from several places. It is also expanded to handle future changes that add support for different processor architectures, e.g. aarch64.
This commit is contained in:
Lutz Justen
+148
-53
@@ -20,60 +20,152 @@
|
||||
#include "absl/strings/str_format.h"
|
||||
#include "absl/strings/str_split.h"
|
||||
#include "common/path.h"
|
||||
#include "common/platform.h"
|
||||
#include "common/remote_util.h"
|
||||
#include "common/status_macros.h"
|
||||
#include "common/util.h"
|
||||
|
||||
namespace cdc_ft {
|
||||
namespace {
|
||||
|
||||
constexpr char kErrorFailedToGetKnownFolderPath[] =
|
||||
"error_failed_to_get_known_folder_path";
|
||||
constexpr char kErrorArchTypeUnhandled[] = "arch_type_unhandled";
|
||||
constexpr char kUnsupportedArchErrorFmt[] =
|
||||
"Unsupported remote device architecture '%s'. If you think this is a "
|
||||
"bug, or if this combination should be supported, please file a bug at "
|
||||
"https://github.com/google/cdc-file-transfer.";
|
||||
|
||||
absl::StatusOr<ArchType> GetArchTypeFromUname(const std::string& uname_out) {
|
||||
// uname_out is "KERNEL MACHINE"
|
||||
// Possible values for KERNEL: Linux (not sure what else).
|
||||
// Possible values for MACHINE:
|
||||
// https://stackoverflow.com/questions/45125516/possible-values-for-uname-m
|
||||
// Relevant for us: x86_64, aarch64.
|
||||
if (absl::StartsWith(uname_out, "Linux ")) {
|
||||
// Linux kernel. Check CPU type.
|
||||
if (absl::StrContains(uname_out, "x86_64")) {
|
||||
return ArchType::kLinux_x86_64;
|
||||
}
|
||||
}
|
||||
|
||||
if (absl::StartsWith(uname_out, "MSYS_")) {
|
||||
// Windows machine that happens to have Cygwin/MSYS on it. Check CPU type.
|
||||
if (absl::StrContains(uname_out, "x86_64")) {
|
||||
return ArchType::kWindows_x86_64;
|
||||
}
|
||||
}
|
||||
|
||||
return absl::UnimplementedError(
|
||||
absl::StrFormat(kUnsupportedArchErrorFmt, uname_out));
|
||||
}
|
||||
|
||||
absl::StatusOr<ArchType> GetArchTypeFromWinProcArch(
|
||||
const std::string& arch_out) {
|
||||
// Possible values: AMD64, IA64, ARM64, x86
|
||||
if (absl::StrContains(arch_out, "AMD64")) {
|
||||
return ArchType::kWindows_x86_64;
|
||||
}
|
||||
|
||||
return absl::UnimplementedError(
|
||||
absl::StrFormat(kUnsupportedArchErrorFmt, arch_out));
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
// static
|
||||
ServerArch::Type ServerArch::Detect(const std::string& destination) {
|
||||
ServerArch ServerArch::GuessFromDestination(const std::string& destination) {
|
||||
// Path starting with ~ or / -> Linux.
|
||||
if (absl::StartsWith(destination, "~") ||
|
||||
absl::StartsWith(destination, "/")) {
|
||||
return Type::kLinux;
|
||||
LOG_DEBUG("Guessed server arch type Linux based on ~ or /");
|
||||
return ServerArch(ArchType::kLinux_x86_64, /*is_guess=*/true);
|
||||
}
|
||||
|
||||
// Path starting with C: etc. -> Windows.
|
||||
if (!path::GetDrivePrefix(destination).empty()) {
|
||||
return Type::kWindows;
|
||||
LOG_DEBUG("Guessed server arch type Windows based on drive prefix");
|
||||
return ServerArch(ArchType::kWindows_x86_64, /*is_guess=*/true);
|
||||
}
|
||||
|
||||
// Path with only / -> Linux.
|
||||
if (absl::StrContains(destination, "/") &&
|
||||
!absl::StrContains(destination, "\\")) {
|
||||
return Type::kLinux;
|
||||
LOG_DEBUG("Guessed server arch type Linux based on forward slashes");
|
||||
return ServerArch(ArchType::kLinux_x86_64, /*is_guess=*/true);
|
||||
}
|
||||
|
||||
// Path with only \\ -> Windows.
|
||||
if (absl::StrContains(destination, "\\") &&
|
||||
!absl::StrContains(destination, "/")) {
|
||||
return Type::kWindows;
|
||||
LOG_DEBUG("Guessed server arch type Windows based on backslashes");
|
||||
return ServerArch(ArchType::kWindows_x86_64, /*is_guess=*/true);
|
||||
}
|
||||
|
||||
// Default to Linux.
|
||||
return Type::kLinux;
|
||||
LOG_DEBUG("Guessed server arch type Linux as default");
|
||||
return ServerArch(ArchType::kLinux_x86_64, /*is_guess=*/true);
|
||||
}
|
||||
|
||||
// static
|
||||
ServerArch::Type ServerArch::LocalType() {
|
||||
#if PLATFORM_WINDOWS
|
||||
return ServerArch::Type::kWindows;
|
||||
#elif PLATFORM_LINUX
|
||||
return ServerArch::Type::kLinux;
|
||||
#endif
|
||||
ServerArch ServerArch::DetectFromLocalDevice() {
|
||||
LOG_DEBUG("Detected local device type %s",
|
||||
GetArchTypeStr(GetLocalArchType()));
|
||||
return ServerArch(GetLocalArchType(), /*is_guess=*/false);
|
||||
}
|
||||
|
||||
// static
|
||||
absl::StatusOr<ServerArch> ServerArch::DetectFromRemoteDevice(
|
||||
RemoteUtil* remote_util) {
|
||||
assert(remote_util);
|
||||
|
||||
// Run uname, assuming it's a Linux machine.
|
||||
std::string uname_out;
|
||||
std::string linux_cmd = "uname -sm";
|
||||
absl::Status status =
|
||||
remote_util->RunWithCapture(linux_cmd, "uname", &uname_out, nullptr);
|
||||
if (status.ok()) {
|
||||
LOG_DEBUG("Uname returned '%s'", uname_out);
|
||||
absl::StatusOr<ArchType> type = GetArchTypeFromUname(uname_out);
|
||||
if (type.ok()) {
|
||||
LOG_DEBUG("Detected server arch type '%s' from uname",
|
||||
GetArchTypeStr(*type));
|
||||
return ServerArch(*type, /*is_guess=*/false);
|
||||
}
|
||||
status = type.status();
|
||||
}
|
||||
LOG_DEBUG(
|
||||
"Failed to detect arch type from uname; this is expected if the remote "
|
||||
"machine is not Linux; will try Windows next: %s",
|
||||
status.ToString());
|
||||
|
||||
// Check %PROCESSOR_ARCHITECTURE%, assuming it's a Windows machine.
|
||||
// Note: That space after PROCESSOR_ARCHITECTURE is important or else Windows
|
||||
// command magic interprets quotes as part of the string.
|
||||
std::string arch_out;
|
||||
std::string windows_cmd =
|
||||
RemoteUtil::QuoteForSsh("cmd /C set PROCESSOR_ARCHITECTURE ");
|
||||
status = remote_util->RunWithCapture(
|
||||
windows_cmd, "set PROCESSOR_ARCHITECTURE", &arch_out, nullptr);
|
||||
if (status.ok()) {
|
||||
LOG_DEBUG("PROCESSOR_ARCHITECTURE is '%s'", arch_out);
|
||||
absl::StatusOr<ArchType> type = GetArchTypeFromWinProcArch(arch_out);
|
||||
if (type.ok()) {
|
||||
LOG_DEBUG("Detected server arch type '%s' from PROCESSOR_ARCHITECTURE",
|
||||
GetArchTypeStr(*type));
|
||||
return ServerArch(*type, /*is_guess=*/false);
|
||||
}
|
||||
status = type.status();
|
||||
}
|
||||
LOG_DEBUG("Failed to detect arch type from PROCESSOR_ARCHITECTURE: %s",
|
||||
status.ToString());
|
||||
|
||||
return absl::InternalError("Failed to detect remote architecture");
|
||||
}
|
||||
|
||||
// static
|
||||
std::string ServerArch::CdcRsyncFilename() {
|
||||
switch (LocalType()) {
|
||||
case Type::kWindows:
|
||||
switch (GetLocalArchType()) {
|
||||
case ArchType::kWindows_x86_64:
|
||||
return "cdc_rsync.exe";
|
||||
case Type::kLinux:
|
||||
case ArchType::kLinux_x86_64:
|
||||
return "cdc_rsync";
|
||||
default:
|
||||
assert(!kErrorArchTypeUnhandled);
|
||||
@@ -81,15 +173,18 @@ std::string ServerArch::CdcRsyncFilename() {
|
||||
}
|
||||
}
|
||||
|
||||
ServerArch::ServerArch(Type type) : type_(type) {}
|
||||
ServerArch::ServerArch(ArchType type, bool is_guess)
|
||||
: type_(type), is_guess_(is_guess) {}
|
||||
|
||||
ServerArch::~ServerArch() {}
|
||||
|
||||
const char* ServerArch::GetTypeStr() const { return GetArchTypeStr(type_); }
|
||||
|
||||
std::string ServerArch::CdcServerFilename() const {
|
||||
switch (type_) {
|
||||
case Type::kWindows:
|
||||
case ArchType::kWindows_x86_64:
|
||||
return "cdc_rsync_server.exe";
|
||||
case Type::kLinux:
|
||||
case ArchType::kLinux_x86_64:
|
||||
return "cdc_rsync_server";
|
||||
default:
|
||||
assert(!kErrorArchTypeUnhandled);
|
||||
@@ -98,46 +193,46 @@ std::string ServerArch::CdcServerFilename() const {
|
||||
}
|
||||
|
||||
std::string ServerArch::RemoteToolsBinDir() const {
|
||||
switch (type_) {
|
||||
case Type::kWindows: {
|
||||
return "AppData\\Roaming\\cdc-file-transfer\\bin\\";
|
||||
}
|
||||
case Type::kLinux:
|
||||
return ".cache/cdc-file-transfer/bin/";
|
||||
default:
|
||||
assert(!kErrorArchTypeUnhandled);
|
||||
return std::string();
|
||||
if (IsWindowsArchType(type_)) {
|
||||
return "AppData\\Roaming\\cdc-file-transfer\\bin\\";
|
||||
}
|
||||
|
||||
if (IsLinuxArchType(type_)) {
|
||||
return ".cache/cdc-file-transfer/bin/";
|
||||
}
|
||||
|
||||
assert(!kErrorArchTypeUnhandled);
|
||||
return std::string();
|
||||
}
|
||||
|
||||
std::string ServerArch::GetStartServerCommand(int exit_code_not_found,
|
||||
const std::string& args) const {
|
||||
std::string server_path = RemoteToolsBinDir() + CdcServerFilename();
|
||||
|
||||
switch (type_) {
|
||||
case Type::kWindows:
|
||||
// TODO(ljusten): On Windows, ssh does not seem to forward the Powershell
|
||||
// exit code (exit_code_not_found) to the process. However, that's really
|
||||
// a minor issue and means we display "Deploying server..." instead of
|
||||
// "Server not deployed. Deploying...";
|
||||
return RemoteUtil::QuoteForWindows(
|
||||
absl::StrFormat("powershell -Command \" "
|
||||
"Set-StrictMode -Version 2; "
|
||||
"$ErrorActionPreference = 'Stop'; "
|
||||
"if (-not (Test-Path -Path '%s')) { "
|
||||
" exit %i; "
|
||||
"} "
|
||||
"%s %s "
|
||||
"\"",
|
||||
server_path, exit_code_not_found, server_path, args));
|
||||
case Type::kLinux:
|
||||
return absl::StrFormat("if [ ! -f %s ]; then exit %i; fi; %s %s",
|
||||
server_path, exit_code_not_found, server_path,
|
||||
args);
|
||||
default:
|
||||
assert(!kErrorArchTypeUnhandled);
|
||||
return std::string();
|
||||
if (IsWindowsArchType(type_)) {
|
||||
// TODO(ljusten): On Windows, ssh does not seem to forward the Powershell
|
||||
// exit code (exit_code_not_found) to the process. However, that's really
|
||||
// a minor issue and means we display "Deploying server..." instead of
|
||||
// "Server not deployed. Deploying...";
|
||||
return RemoteUtil::QuoteForWindows(
|
||||
absl::StrFormat("powershell -Command \" "
|
||||
"Set-StrictMode -Version 2; "
|
||||
"$ErrorActionPreference = 'Stop'; "
|
||||
"if (-not (Test-Path -Path '%s')) { "
|
||||
" exit %i; "
|
||||
"} "
|
||||
"%s %s "
|
||||
"\"",
|
||||
server_path, exit_code_not_found, server_path, args));
|
||||
}
|
||||
|
||||
if (IsLinuxArchType(type_)) {
|
||||
return absl::StrFormat("if [ ! -f %s ]; then exit %i; fi; %s %s",
|
||||
server_path, exit_code_not_found, server_path, args);
|
||||
}
|
||||
|
||||
assert(!kErrorArchTypeUnhandled);
|
||||
return std::string();
|
||||
}
|
||||
|
||||
std::string ServerArch::GetDeploySftpCommands() const {
|
||||
|
||||
Reference in New Issue
Block a user