Refactor AdbClient and make PlatformAndroid::GetFile to use "adb pull"

[ovyalov]

Summary

Refactor AdbClient - use symmetric interface for PullFile and PushFile.
Make PlatformAndroid::GetFile to delegate to AdbClient::PullFile.

[tberghammer]

LGTM

[ovyalov]

AFFECTED FILES

/lldb/trunk/source/Plugins/Platform/Android/AdbClient.cpp
/lldb/trunk/source/Plugins/Platform/Android/AdbClient.h
/lldb/trunk/source/Plugins/Platform/Android/PlatformAndroid.cpp
/lldb/trunk/source/Plugins/Platform/Android/PlatformAndroid.h

USERS

ovyalov (Author)

http://reviews.llvm.org/rL238442

source/Plugins/Platform/Android/AdbClient.h

 
 // Other libraries and framework includes
 // Project includes
 
 #include "lldb/Core/Error.h"
 #include "lldb/Host/ConnectionFileDescriptor.h"
 
 namespace lldb_private {
+
+class FileSpec;
+
 namespace platform_android {
 
 class AdbClient
 {
 public:
     using DeviceIDList = std::list<std::string>;
 
     static Error
public:
 
     Error
     SetPortForwarding (const uint16_t port);
 
     Error
     DeletePortForwarding (const uint16_t port);
 
     Error
-    PullFile (const char *remote_file, const char *local_file);
+    PullFile (const FileSpec &remote_file, const FileSpec &local_file);
 
     Error
-    PushFile (const lldb_private::FileSpec& source, const lldb_private::FileSpec& destination);
+    PushFile (const FileSpec &local_file, const FileSpec &remote_file);
 
 private:
     Error
     Connect ();
 
     void
     SetDeviceID (const std::string &device_id);
 
private:
 
     Error
     SwitchDeviceTransport ();
 
     Error
     Sync ();
 
     Error
+    StartSync ();
+
+    Error
     PullFileChunk (std::vector<char> &buffer, bool &eof);
 
     Error
     ReadAllBytes (void *buffer, size_t size);
 
     std::string m_device_id;
     ConnectionFileDescriptor m_conn;
 };
 
 } // namespace platform_android
 } // namespace lldb_private
 
 #endif  // liblldb_AdbClient_h_

source/Plugins/Platform/Android/AdbClient.cpp

AdbClient::SwitchDeviceTransport ()
     auto error = SendMessage (msg.str ());
     if (error.Fail ())
         return error;
 
     return ReadResponseStatus ();
 }
 
 Error
-AdbClient::PullFile (const char *remote_file, const char *local_file)
+AdbClient::PullFile (const FileSpec &remote_file, const FileSpec &local_file)
 {
-    auto error = SwitchDeviceTransport ();
+    auto error = StartSync ();
     if (error.Fail ())
-        return Error ("Failed to switch to device transport: %s", error.AsCString ());
-
-    error = Sync ();
-    if (error.Fail ())
-        return Error ("Sync failed: %s", error.AsCString ());
+        return error;
 
-    llvm::FileRemover local_file_remover (local_file);
+    const auto local_file_path = local_file.GetPath ();
+    llvm::FileRemover local_file_remover (local_file_path.c_str ());
 
-    std::ofstream dst (local_file, std::ios::out | std::ios::binary);
+    std::ofstream dst (local_file_path, std::ios::out | std::ios::binary);
     if (!dst.is_open ())
-        return Error ("Unable to open local file %s", local_file);
+        return Error ("Unable to open local file %s", local_file_path.c_str());
 
-    error = SendSyncRequest ("RECV", strlen(remote_file), remote_file);
+    const auto remote_file_path = remote_file.GetPath (false);
+    error = SendSyncRequest ("RECV", remote_file_path.length (), remote_file_path.c_str ());
     if (error.Fail ())
         return error;
 
     std::vector<char> chunk;
     bool eof = false;
     while (!eof)
     {
         error = PullFileChunk (chunk, eof);
         if (error.Fail ())
             return Error ("Failed to read file chunk: %s", error.AsCString ());
         if (!eof)
             dst.write (&chunk[0], chunk.size ());
     }
 
     local_file_remover.releaseFile ();
     return error;
 }
 
 Error
-AdbClient::PushFile (const lldb_private::FileSpec& source, const lldb_private::FileSpec& destination)
+AdbClient::PushFile (const FileSpec &local_file, const FileSpec &remote_file)
 {
-    auto error = SwitchDeviceTransport ();
+    auto error = StartSync ();
     if (error.Fail ())
-        return Error ("Failed to switch to device transport: %s", error.AsCString ());
-
-    error = Sync ();
-    if (error.Fail ())
-        return Error ("Sync failed: %s", error.AsCString ());
+        return error;
 
-    std::ifstream src (source.GetPath().c_str(), std::ios::in | std::ios::binary);
+    const auto local_file_path (local_file.GetPath ());
+    std::ifstream src (local_file_path.c_str(), std::ios::in | std::ios::binary);
     if (!src.is_open ())
-        return Error ("Unable to open local file %s", source.GetPath().c_str());
+        return Error ("Unable to open local file %s", local_file_path.c_str());
 
     std::stringstream file_description;
-    file_description << destination.GetPath(false).c_str() << "," << kDefaultMode;
+    file_description << remote_file.GetPath(false).c_str() << "," << kDefaultMode;
     std::string file_description_str = file_description.str();
     error = SendSyncRequest ("SEND", file_description_str.length(), file_description_str.c_str());
     if (error.Fail ())
         return error;
 
     char chunk[kMaxPushData];
     while (!src.eof() && !src.read(chunk, kMaxPushData).bad())
     {
         size_t chunk_size = src.gcount();
         error = SendSyncRequest("DATA", chunk_size, chunk);
         if (error.Fail ())
             return Error ("Failed to send file chunk: %s", error.AsCString ());
     }
-    error = SendSyncRequest("DONE", source.GetModificationTime().seconds(), nullptr);
+    error = SendSyncRequest("DONE", local_file.GetModificationTime().seconds(), nullptr);
     if (error.Fail ())
         return error;
     error = ReadResponseStatus();
     // If there was an error reading the source file, finish the adb file
     // transfer first so that adb isn't expecting any more data.
     if (src.bad())
-        return Error ("Failed read on %s", source.GetPath().c_str());
+        return Error ("Failed read on %s", local_file_path.c_str());
+    return error;
+}
+
+Error
+AdbClient::StartSync ()
+{
+    auto error = SwitchDeviceTransport ();
+    if (error.Fail ())
+        return Error ("Failed to switch to device transport: %s", error.AsCString ());
+
+    error = Sync ();
+    if (error.Fail ())
+        return Error ("Sync failed: %s", error.AsCString ());
+
     return error;
 }
 
 Error
 AdbClient::Sync ()
 {
     auto error = SendMessage ("sync:", false);
     if (error.Fail ())

source/Plugins/Platform/Android/PlatformAndroid.h

public:
 
         //------------------------------------------------------------
         // lldb_private::Platform functions
         //------------------------------------------------------------
 
         Error
         ConnectRemote (Args& args) override;
 
-        lldb_private::Error
-        PutFile (const lldb_private::FileSpec& source,
-                 const lldb_private::FileSpec& destination,
+        Error
+        GetFile (const FileSpec& source,
+                 const FileSpec& destination) override;
+
+        Error
+        PutFile (const FileSpec& source,
+                 const FileSpec& destination,
                  uint32_t uid = UINT32_MAX,
                  uint32_t gid = UINT32_MAX) override;
 
      protected:
         const char *
         GetCacheHostname () override;
 
         Error

source/Plugins/Platform/Android/PlatformAndroid.cpp

if (error.Success())
         if (error.Fail())
             return error;
 
         m_device_id = adb.GetDeviceID();
     }
     return error;
 }
 
-lldb_private::Error
-PlatformAndroid::PutFile (const lldb_private::FileSpec& source,
-                          const lldb_private::FileSpec& destination,
+Error
+PlatformAndroid::GetFile (const FileSpec& source,
+                          const FileSpec& destination)
+{
+    if (!IsHost() && m_remote_platform_sp)
+    {
+        AdbClient adb (m_device_id);
+        return adb.PullFile(source, destination);
+    }
+    return PlatformLinux::GetFile(source, destination);
+}
+
+Error
+PlatformAndroid::PutFile (const FileSpec& source,
+                          const FileSpec& destination,
                           uint32_t uid,
                           uint32_t gid)
 {
     if (!IsHost() && m_remote_platform_sp)
     {
         AdbClient adb (m_device_id);
         // TODO: Set correct uid and gid on remote file.
         return adb.PushFile(source, destination);

 PlatformAndroid::DownloadModuleSlice (const FileSpec &src_file_spec,
                                       const uint64_t src_offset,
                                       const uint64_t src_size,
                                       const FileSpec &dst_file_spec)
 {
     if (src_offset != 0)
         return Error ("Invalid offset - %" PRIu64, src_offset);
 
-    AdbClient adb (m_device_id);
-    return adb.PullFile (src_file_spec.GetPath (false).c_str (), dst_file_spec.GetPath ().c_str ());
+    return GetFile (src_file_spec, dst_file_spec);
 }