Implement and use adb push for PlatformAndroid::PutFile

[flackr]

Summary

Using the adb push protocol is significantly faster than the current method of sending the hex encoded file data for the remote to write to the file.

[ovyalov]

Please see my comments.

source/Plugins/Platform/Android/AdbClient.cpp

44 ↗

(On Diff #26334)

Please check how it works on Windows - https://github.com/llvm-mirror/lldb/blob/master/include/lldb/Host/windows/win32.h resets S_IRWXU and S_IRWXG to 0, we may want to define just numeric constants here instead.

306 ↗

(On Diff #26334)

stringstream::str returns copy of string - could you store file_description.str() as temp variable in order to reuse for length() and c_str() ?

311 ↗

(On Diff #26334)

Do we need to fail if src.read(chunk, kMaxPushData).bad() returns true?

317 ↗

(On Diff #26334)

You may use FileSpec::GetModificationTime here to get source lmt.

[flackr]

• Get modification time for adb push from source file (Pass FileSpec directly through)
• Hard-code file mode flags (to not rely on platform definitions)
• Return failure if a failure occurs reading the source file.

source/Plugins/Platform/Android/AdbClient.cpp

44 ↗

(On Diff #26334)

Lets just define the numeric constant, done.

306 ↗

(On Diff #26334)

Done.

311 ↗

(On Diff #26334)

Done.

317 ↗

(On Diff #26334)

Done.

[tberghammer]

LGTM

source/Plugins/Platform/Android/AdbClient.cpp

43 ↗

(On Diff #26518)

Please add a comment about what this number means (e.g.: list the symbolic constants in a comment)

318 ↗

(On Diff #26518)

(nit) nullptr

[ovyalov]

Looks good.

source/Plugins/Platform/Android/AdbClient.h

54 ↗

(On Diff #26518)

For the consistency of interface will need to make PutFile to take FileSpecs as parameters - no need to do this now, I can clean it up later.

[flackr]

• Comment constant
• Use nullptr

source/Plugins/Platform/Android/AdbClient.cpp

43 ↗

(On Diff #26518)

Done.

318 ↗

(On Diff #26518)

Done.

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

public:
     SetPortForwarding (const uint16_t port);
 
     Error
     DeletePortForwarding (const uint16_t port);
 
     Error
     PullFile (const char *remote_file, const char *local_file);
 
+    Error
+    PushFile (const lldb_private::FileSpec& source, const lldb_private::FileSpec& destination);
+
 private:
     Error
     Connect ();
 
     void
     SetDeviceID (const std::string &device_id);
 
     Error

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

 //===-- AdbClient.cpp -------------------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 // Other libraries and framework includes
 #include "lldb/Core/DataBuffer.h"
 #include "lldb/Core/DataBufferHeap.h"
 #include "lldb/Core/DataEncoder.h"
 #include "lldb/Core/DataExtractor.h"
+#include "lldb/Host/FileSpec.h"
 #include "llvm/ADT/SmallVector.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/ADT/STLExtras.h"
 #include "llvm/Support/FileUtilities.h"
 
 // Project includes
 #include "AdbClient.h"
 
 #include <limits.h>
 
 #include <algorithm>
 #include <fstream>
 #include <sstream>
 
 using namespace lldb;
 using namespace lldb_private;
 using namespace lldb_private::platform_android;
 
 namespace {
 
 const uint32_t kReadTimeout = 1000000; // 1 second
 const char * kOKAY = "OKAY";
 const char * kFAIL = "FAIL";
 const size_t kSyncPacketLen = 8;
+// Maximum size of a filesync DATA packet.
+const size_t kMaxPushData = 2*1024;
+// Default mode for pushed files.
+const uint32_t kDefaultMode = 0100770; // S_IFREG | S_IRWXU | S_IRWXG
 
 }  // namespace
 
 Error
 AdbClient::CreateByDeviceID(const std::string &device_id, AdbClient &adb)
 {
     DeviceIDList connect_devices;
     auto error = adb.GetDevices(connect_devices);
while (!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)
+{
+    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 ());
+
+    std::ifstream src (source.GetPath().c_str(), std::ios::in | std::ios::binary);
+    if (!src.is_open ())
+        return Error ("Unable to open local file %s", source.GetPath().c_str());
+
+    std::stringstream file_description;
+    file_description << destination.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);
+    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;
+}
+
+Error
 AdbClient::Sync ()
 {
     auto error = SendMessage ("sync:", false);
     if (error.Fail ())
         return error;
 
     return ReadResponseStatus ();
 }
AdbClient::SendSyncRequest (const char *request_id, const uint32_t data_len, const void *data)
     encoder.PutU32 (offset, data_len);
 
     Error error;
     ConnectionStatus status;
     m_conn.Write (data_sp->GetBytes (), kSyncPacketLen, status, &error);
     if (error.Fail ())
         return error;
 
+    if (data)
         m_conn.Write (data, data_len, status, &error);
     return error;
 }
 
 Error
 AdbClient::ReadSyncHeader (std::string &response_id, uint32_t &data_len)
 {
     char buffer[kSyncPacketLen];
 

lldb/trunk/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,
+                 uint32_t uid = UINT32_MAX,
+                 uint32_t gid = UINT32_MAX) override;
+
      protected:
         const char *
         GetCacheHostname () override;
 
         Error
         DownloadModuleSlice (const FileSpec &src_file_spec,
                              const uint64_t src_offset,
                              const uint64_t src_size,
                              const FileSpec &dst_file_spec) override;

lldb/trunk/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,
+                          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);
+    }
+    return PlatformLinux::PutFile(source, destination, uid, gid);
+}
+
 const char *
 PlatformAndroid::GetCacheHostname ()
 {
     return m_device_id.c_str ();
 }
 
 Error
 PlatformAndroid::DownloadModuleSlice (const FileSpec &src_file_spec,