merge lldb-platform-work branch (and assorted fixes) into trunk

    Summary:
    This merge brings in the improved 'platform' command that knows how to
    interface with remote machines; that is, query OS/kernel information, push
    and pull files, run shell commands, etc... and implementation for the new
    communication packets that back that interface, at least on Darwin based
    operating systems via the POSIXPlatform class. Linux support is coming soon.

    Verified the test suite runs cleanly on Linux (x86_64), build OK on Mac OS
    X Mountain Lion.

    Additional improvements (not in the source SVN branch 'lldb-platform-work'):
    - cmake build scripts for lldb-platform
    - cleanup test suite
    - documentation stub for qPlatform_RunCommand
    - use log class instead of printf() directly
    - reverted work-in-progress-looking changes from test/types/TestAbstract.py that work towards running the test suite remotely.
    - add new logging category 'platform'

    Reviewers: Matt Kopec, Greg Clayton

    Review: http://llvm-reviews.chandlerc.com/D1493

llvm-svn: 189295

Author: Daniel Malea

lldb/docs/lldb-gdb-remote.txt

@@ -420,6 +420,20 @@ invalidate-regs
             modifying the CPSR register can cause the r8 - r14 and cpsr value to
             change depending on if the mode has changed. 
 
+//----------------------------------------------------------------------
+// "qPlatform_RunCommand"
+//
+// BRIEF
+//  Run a command in a shell on the connected remote machine.
+//
+// PRIORITY TO IMPLEMENT
+//  TODO
+//----------------------------------------------------------------------
+
+send packet: TODO (see GDBRemoteCommunicationClient::RunShellCommand)
+read packet: TODO (see GDBRemoteCommunicationServer::Handle_qPlatform_RunCommand)
+
+
 //----------------------------------------------------------------------
 // "qHostInfo"
 //
@@ -848,3 +862,123 @@ for this region.
 //  your debug session more reliable and informative.
 //----------------------------------------------------------------------
 
+
+//----------------------------------------------------------------------
+// PLATFORM EXTENSION - for use as a GDB remote platform
+//----------------------------------------------------------------------
+// "qfProcessInfo"
+// "qsProcessInfo"
+//
+// BRIEF
+//  Get the first process info (qfProcessInfo) or subsequent processs
+//  info (qsProcessInfo) for one or more processes on the remote 
+//  platform. The first call gets the first match and subsequent calls
+//  to qsProcessInfo gets the subsequent matches. Return an error EXX,
+//  where XX are two hex digits, when no more matches are available.
+//
+// PRIORITY TO IMPLEMENT
+//  Required. The qfProcessInfo packet can be followed by a ':' and
+//  some key value pairs. The key value pairs in the command are:
+//
+//  KEY           VALUE     DESCRIPTION
+//  ===========   ========  ================================================
+//  "name"        ascii-hex An ASCII hex string that contains the name of 
+//                          the process that will be matched.
+//  "name_match"  enum      One of: "equals", "starts_with", "ends_with", 
+//                          "contains" or "regex"
+//  "pid"         integer   A string value containing the decimal process ID
+//  "parent_pid"  integer   A string value containing the decimal parent 
+//                          process ID
+//  "uid"         integer   A string value containing the decimal user ID
+//  "gid"         integer   A string value containing the decimal group ID
+//  "euid"        integer   A string value containing the decimal effective user ID
+//  "egid"        integer   A string value containing the decimal effective group ID
+//  "all_users"   bool      A boolean value that specifies if processes should
+//                          be listed for all users, not just the user that the 
+//                          platform is running as
+//  "triple"      ascii-hex An ASCII hex target triple string ("x86_64", 
+//                          "x86_64-apple-macosx", "armv7-apple-ios")
+//
+// The response consists of key/value pairs where the key is separated from the
+// values with colons and each pair is terminated with a semi colon. For a list
+// of the key/value pairs in the response see the "qProcessInfoPID" packet
+// documentation.
+//
+// Sample packet/response:
+// send packet: $qfProcessInfo#00
+// read packet: $pid:60001;ppid:59948;uid:7746;gid:11;euid:7746;egid:11;name:6c6c6462;triple:7838365f36342d6170706c652d6d61636f7378;#00
+// send packet: $qsProcessInfo#00
+// read packet: $pid:59992;ppid:192;uid:7746;gid:11;euid:7746;egid:11;name:6d64776f726b6572;triple:7838365f36342d6170706c652d6d61636f7378;#00
+// send packet: $qsProcessInfo#00
+// read packet: $E04#00
+//----------------------------------------------------------------------
+
+
+//----------------------------------------------------------------------
+// PLATFORM EXTENSION - for use as a GDB remote platform
+//----------------------------------------------------------------------
+// "qLaunchGDBServer"
+//
+// BRIEF
+//  Have the remote platform launch a GDB server.
+//
+// PRIORITY TO IMPLEMENT
+//  Required. The qLaunchGDBServer packet must be followed by a ':' and
+//  some key value pairs. The key value pairs in the command are:
+//
+//  KEY           VALUE     DESCRIPTION
+//  ===========   ========  ================================================
+//  "port"        integer   A string value containing the decimal port ID or
+//                          zero if the port should be bound and returned
+//
+//  "host"        integer   The host that connections should be limited to
+//                          when the GDB server is connected to.
+//
+// The response consists of key/value pairs where the key is separated from the
+// values with colons and each pair is terminated with a semi colon.
+//
+// Sample packet/response:
+// send packet: $qLaunchGDBServer:port:0;host:lldb.apple.com;#00
+// read packet: $pid:60025;port:50776;#00
+//
+// The "pid" key/value pair is only specified if the remote platform launched
+// a separate process for the GDB remote server and can be omitted if no
+// process was separately launched.
+//
+// The "port" key/value pair in the response lets clients know what port number
+// to attach to in case zero was specified as the "port" in the sent command.
+//----------------------------------------------------------------------
+
+
+//----------------------------------------------------------------------
+// PLATFORM EXTENSION - for use as a GDB remote platform
+//----------------------------------------------------------------------
+// "qProcessInfoPID:PID"
+//
+// BRIEF
+//  Have the remote platform get detailed information on a process by
+//  ID. PID is specified as a decimal integer.
+//
+// PRIORITY TO IMPLEMENT
+//  Optional. 
+//
+// The response consists of key/value pairs where the key is separated from the
+// values with colons and each pair is terminated with a semi colon.
+//
+// The key value pairs in the response are:
+//
+//  KEY           VALUE     DESCRIPTION
+//  ===========   ========  ================================================
+//  "pid"         integer   Process ID as a decimal integer string
+//  "ppid"        integer   Parent process ID as a decimal integer string
+//  "uid"         integer   A string value containing the decimal user ID
+//  "gid"         integer   A string value containing the decimal group ID
+//  "euid"        integer   A string value containing the decimal effective user ID
+//  "egid"        integer   A string value containing the decimal effective group ID
+//  "name"        ascii-hex An ASCII hex string that contains the name of the process
+//  "triple"      ascii-hex A target triple ("x86_64-apple-macosx", "armv7-apple-ios")
+//
+// Sample packet/response:
+// send packet: $qProcessInfoPID:60050#00
+// read packet: $pid:60050;ppid:59948;uid:7746;gid:11;euid:7746;egid:11;name:6c6c6462;triple:7838365f36342d6170706c652d6d61636f7378;#00
+//----------------------------------------------------------------------

lldb/include/lldb/Core/StreamGDBRemote.h

@@ -0,0 +1,54 @@
+//===-- StreamGDBRemote.h ----------------------------------------*- C++ -*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef liblldb_StreamGDBRemote_h_
+#define liblldb_StreamGDBRemote_h_
+
+// C Includes
+// C++ Includes
+
+// Other libraries and framework includes
+// Project includes
+
+#include "lldb/Core/StreamString.h"
+
+namespace lldb_private {
+    
+    class StreamGDBRemote : public StreamString
+    {
+        public:
+        StreamGDBRemote ();
+        
+        StreamGDBRemote (uint32_t flags,
+                         uint32_t addr_size,
+                         lldb::ByteOrder byte_order);
+        
+        virtual
+        ~StreamGDBRemote ();
+        
+        //------------------------------------------------------------------
+        /// Output a block of data to the stream performing GDB-remote escaping.
+        ///
+        /// @param[in] s
+        ///     A block of data.
+        ///
+        /// @param[in] src_len
+        ///     The amount of data to write.
+        ///
+        /// @return
+        ///     Number of bytes written.
+        //------------------------------------------------------------------
+        int
+        PutEscapedBytes (const void* s,
+                         size_t src_len);
+    };
+
+} // namespace lldb_private
+
+#endif  // liblldb_StreamGDBRemote_h_

lldb/include/lldb/Host/File.h

@@ -41,17 +41,20 @@ class File
         eOpenOptionCanCreateNewOnly     = (1u << 6)     // Can create file only if it doesn't already exist
     };
 
+    static mode_t
+    ConvertOpenOptionsForPOSIXOpen (uint32_t open_options);
+    
     enum Permissions
     {
-        ePermissionsUserRead        = (1u << 0),
-        ePermissionsUserWrite       = (1u << 1),
-        ePermissionsUserExecute     = (1u << 2),
-        ePermissionsGroupRead       = (1u << 3),
+        ePermissionsUserRead        = (1u << 8),
+        ePermissionsUserWrite       = (1u << 7),
+        ePermissionsUserExecute     = (1u << 6),
+        ePermissionsGroupRead       = (1u << 5),
         ePermissionsGroupWrite      = (1u << 4),
-        ePermissionsGroupExecute    = (1u << 5),
-        ePermissionsWorldRead       = (1u << 6),
-        ePermissionsWorldWrite      = (1u << 7),
-        ePermissionsWorldExecute    = (1u << 8),
+        ePermissionsGroupExecute    = (1u << 3),
+        ePermissionsWorldRead       = (1u << 2),
+        ePermissionsWorldWrite      = (1u << 1),
+        ePermissionsWorldExecute    = (1u << 0),
 
         ePermissionsUserRW      = (ePermissionsUserRead    | ePermissionsUserWrite    | 0                        ),
         ePermissionsUserRX      = (ePermissionsUserRead    | 0                        | ePermissionsUserExecute  ),
@@ -117,6 +120,27 @@ class File
           uint32_t options,
           uint32_t permissions = ePermissionsDefault);
 
+    //------------------------------------------------------------------
+    /// Constructor with FileSpec.
+    ///
+    /// Takes a FileSpec pointing to a file which can be just a filename, or a full
+    /// path. If \a path is not NULL or empty, this function will call
+    /// File::Open (const char *path, uint32_t options, uint32_t permissions).
+    ///
+    /// @param[in] path
+    ///     The FileSpec for this file.
+    ///
+    /// @param[in] options
+    ///     Options to use when opening (see File::OpenOptions)
+    ///
+    /// @param[in] permissions
+    ///     Options to use when opening (see File::Permissions)
+    ///
+    /// @see File::Open (const char *path, uint32_t options, uint32_t permissions)
+    //------------------------------------------------------------------
+    File (const FileSpec& filespec,
+          uint32_t options,
+          uint32_t permissions = ePermissionsDefault);
 
     File (int fd, bool tranfer_ownership) : 
         m_descriptor (fd),
@@ -451,6 +475,19 @@ class File
     //------------------------------------------------------------------
     Error
     Sync ();
+    
+    //------------------------------------------------------------------
+    /// Get the permissions for a this file.
+    ///
+    /// @return
+    ///     Bits logical OR'ed together from the permission bits defined
+    ///     in lldb_private::File::Permissions.
+    //------------------------------------------------------------------
+    uint32_t
+    GetPermissions(Error &error) const;
+    
+    static uint32_t
+    GetPermissions (const char *path, Error &error);
 
     //------------------------------------------------------------------
     /// Output printf formatted output to the stream.

lldb/include/lldb/Host/FileSpec.h

@@ -624,6 +624,21 @@ class FileSpec
     static size_t
     Resolve (const char *src_path, char *dst_path, size_t dst_len);
 
+    FileSpec
+    CopyByAppendingPathComponent (const char *new_path) const;
+    
+    FileSpec
+    CopyByRemovingLastPathComponent () const;
+    
+    void
+    AppendPathComponent (const char *new_path);
+    
+    void
+    RemoveLastPathComponent ();
+    
+    const char*
+    GetLastPathComponent () const;
+    
     //------------------------------------------------------------------
     /// Resolves the user name at the beginning of \a src_path, and writes the output
     /// to \a dst_path.  Note, \a src_path can contain other path components after the

lldb/include/lldb/Host/Host.h

@@ -18,6 +18,7 @@
 
 #include "lldb/lldb-private.h"
 #include "lldb/Core/StringList.h"
+#include "lldb/Host/File.h"
 
 namespace lldb_private {
 
@@ -508,6 +509,45 @@ class Host
     DynamicLibraryGetSymbol (void *dynamic_library_handle, 
                              const char *symbol_name, 
                              Error &error);
+    
+    static uint32_t
+    MakeDirectory (const char* path, mode_t mode);
+    
+    static lldb::user_id_t
+    OpenFile (const FileSpec& file_spec,
+              uint32_t flags,
+              mode_t mode,
+              Error &error);
+    
+    static bool
+    CloseFile (lldb::user_id_t fd,
+               Error &error);
+    
+    static uint64_t
+    WriteFile (lldb::user_id_t fd,
+               uint64_t offset,
+               const void* src,
+               uint64_t src_len,
+               Error &error);
+    
+    static uint64_t
+    ReadFile (lldb::user_id_t fd,
+              uint64_t offset,
+              void* dst,
+              uint64_t dst_len,
+              Error &error);
+
+    static lldb::user_id_t
+    GetFileSize (const FileSpec& file_spec);
+    
+    static bool
+    GetFileExists (const FileSpec& file_spec);
+    
+    static bool
+    CalculateMD5 (const FileSpec& file_spec,
+                  uint64_t &low,
+                  uint64_t &high);
+
 };
 
 } // namespace lldb_private

lldb/include/lldb/Interpreter/Options.h

@@ -448,6 +448,12 @@ class Options
         void
         Finalize ();
 
+        bool
+        DidFinalize ()
+        {
+            return m_did_finalize;
+        }
+        
         virtual Error
         SetOptionValue (uint32_t option_idx, 
                         const char *option_arg);
@@ -464,6 +470,10 @@ class Options
             assert (m_did_finalize);
             return &m_option_defs[0];
         }
+        
+        const OptionGroup*
+        GetGroupWithOption (char short_opt);
+        
         struct OptionInfo
         {
             OptionInfo (OptionGroup* g, uint32_t i) :

lldb/include/lldb/Interpreter/ScriptInterpreter.h

@@ -112,6 +112,7 @@ class ScriptInterpreter
     typedef void*          (*SWIGPythonGetChildAtIndex)                        (void *implementor, uint32_t idx);
     typedef int            (*SWIGPythonGetIndexOfChildWithName)                (void *implementor, const char* child_name);
     typedef void*          (*SWIGPythonCastPyObjectToSBValue)                  (void* data);
+    typedef lldb::ValueObjectSP  (*SWIGPythonGetValueObjectSPFromSBValue)      (void* data);
     typedef bool           (*SWIGPythonUpdateSynthProviderInstance)            (void* data);
     typedef bool           (*SWIGPythonMightHaveChildrenSynthProviderInstance) (void* data);