Fix the ability to list iOS simulator processes.

[clayborg]

Summary

This can be done by doing:
(lldb) platform select ios-simulator
(lldb) platform process list

There was code that was trying to detect simulator processes but it had an error in the loop where each time it would check for a env var that starts with "SIMULATOR_UDID=" it would change the architecture to iOS if it found it and MacOSX if it didn't. This meant unless "SIMULATOR_UDID=" was the last environment variable, this loop would never set the OS correctly. We also weren't setting the environment to Simulator which means PlatformAppleSimulator::FindProcesses(...) would never return any valid processes even when there were many.

I don't know how I can test this as we don't want a test suite having to launch an iOS simulator, so there are no tests at the moment. If anyone has any ideas on how to test this, please let me know.

[JDevlieghere]

We should have a few tests that launch a simulator. @aprantl revived them recently:

• TestAppleSimulatorOSType.py
• TestSimulatorPlatform.py
• TestIOSSimulator.py

[clayborg]

Added a "platform process list" test to each simulator test to test this functionality.

The tests all launch processes and the process should be stopped at a breakpoint, so listing the processes for "ios-simulator" is a great way to test this on all simulators.

[clayborg]

Adrian: is there something I need to do to enable simulator tests? I added a test to TestSimulatorPlatform.py but if I run:

$ ../debug/bin/llvm-lit -sv lldb/test/API/macosx/simulator
llvm-lit: /Users/gclayton/Documents/src/lldb/mono/llvm-project/lldb/test/API/lit.cfg.py:147: warning: Could not set a default per-test timeout. Requires the Python psutil module but it could not be found. Try installing it via pip or via your operating system's package manager.

Testing Time: 19.61s
  Unsupported: 1

1 warning(s) in tests

It is unsupported? I am running this on a mac. Do I need to launch a simulator first? Extra arguments to the test suite?

[aprantl]

In D85988#2222616, @clayborg wrote:

Adrian: is there something I need to do to enable simulator tests? I added a test to TestSimulatorPlatform.py but if I run:

$ ../debug/bin/llvm-lit -sv lldb/test/API/macosx/simulator
llvm-lit: /Users/gclayton/Documents/src/lldb/mono/llvm-project/lldb/test/API/lit.cfg.py:147: warning: Could not set a default per-test timeout. Requires the Python psutil module but it could not be found. Try installing it via pip or via your operating system's package manager.

Testing Time: 19.61s
  Unsupported: 1

1 warning(s) in tests

It is unsupported? I am running this on a mac. Do I need to launch a simulator first? Extra arguments to the test suite?

No, the tests are supposed to run. Green dragon (which is running a consumer macOS + consumer Xcode) is running this test. I know because it sometimes fails because it couldn't launch the simulator :-(
The test was XFAILed a few weeks ago — is your LLVM up-to-date?

lldb/source/Host/macosx/objcxx/Host.mm

509

data.GetCStringRef()?
http://llvm.org/doxygen/classllvm_1_1DataExtractor.html

Not sure if we surface that through the LLDB dataextractor, but we probably should.

510

if (str.empty())
   return false;

528

same here (GetCStringRef)
Perhaps also use a fresh variable to avoid confusion?

[clayborg]

In D85988#2226496, @aprantl wrote:

In D85988#2222616, @clayborg wrote:

Adrian: is there something I need to do to enable simulator tests? I added a test to TestSimulatorPlatform.py but if I run:

$ ../debug/bin/llvm-lit -sv lldb/test/API/macosx/simulator
llvm-lit: /Users/gclayton/Documents/src/lldb/mono/llvm-project/lldb/test/API/lit.cfg.py:147: warning: Could not set a default per-test timeout. Requires the Python psutil module but it could not be found. Try installing it via pip or via your operating system's package manager.

Testing Time: 19.61s
  Unsupported: 1

1 warning(s) in tests

It is unsupported? I am running this on a mac. Do I need to launch a simulator first? Extra arguments to the test suite?

No, the tests are supposed to run. Green dragon (which is running a consumer macOS + consumer Xcode) is running this test. I know because it sometimes fails because it couldn't launch the simulator :-(
The test was XFAILed a few weeks ago — is your LLVM up-to-date?

It was up to date. Can you run my invocation on your lldb?:

../debug/bin/llvm-lit -sv lldb/test/API/macosx/simulator

[JDevlieghere]

In D85988#2226889, @clayborg wrote:

In D85988#2226496, @aprantl wrote:

In D85988#2222616, @clayborg wrote:

Adrian: is there something I need to do to enable simulator tests? I added a test to TestSimulatorPlatform.py but if I run:

$ ../debug/bin/llvm-lit -sv lldb/test/API/macosx/simulator
llvm-lit: /Users/gclayton/Documents/src/lldb/mono/llvm-project/lldb/test/API/lit.cfg.py:147: warning: Could not set a default per-test timeout. Requires the Python psutil module but it could not be found. Try installing it via pip or via your operating system's package manager.

Testing Time: 19.61s
  Unsupported: 1

1 warning(s) in tests

It is unsupported? I am running this on a mac. Do I need to launch a simulator first? Extra arguments to the test suite?

No, the tests are supposed to run. Green dragon (which is running a consumer macOS + consumer Xcode) is running this test. I know because it sometimes fails because it couldn't launch the simulator :-(
The test was XFAILed a few weeks ago — is your LLVM up-to-date?

It was up to date. Can you run my invocation on your lldb?:

../debug/bin/llvm-lit -sv lldb/test/API/macosx/simulator

That works for me, but it looks like you're using the standalone/Xcode build, so maybe that's borked somehow :(

[clayborg]

In D85988#2226911, @JDevlieghere wrote:

In D85988#2226889, @clayborg wrote:

In D85988#2226496, @aprantl wrote:

In D85988#2222616, @clayborg wrote:

Adrian: is there something I need to do to enable simulator tests? I added a test to TestSimulatorPlatform.py but if I run:

$ ../debug/bin/llvm-lit -sv lldb/test/API/macosx/simulator
llvm-lit: /Users/gclayton/Documents/src/lldb/mono/llvm-project/lldb/test/API/lit.cfg.py:147: warning: Could not set a default per-test timeout. Requires the Python psutil module but it could not be found. Try installing it via pip or via your operating system's package manager.

Testing Time: 19.61s
  Unsupported: 1

1 warning(s) in tests

It is unsupported? I am running this on a mac. Do I need to launch a simulator first? Extra arguments to the test suite?

No, the tests are supposed to run. Green dragon (which is running a consumer macOS + consumer Xcode) is running this test. I know because it sometimes fails because it couldn't launch the simulator :-(
The test was XFAILed a few weeks ago — is your LLVM up-to-date?

It was up to date. Can you run my invocation on your lldb?:

../debug/bin/llvm-lit -sv lldb/test/API/macosx/simulator

That works for me, but it looks like you're using the standalone/Xcode build, so maybe that's borked somehow :(

I am using the mono-repo build with cmake + ninja.

lldb/source/Host/macosx/objcxx/Host.mm

 //===-- Host.mm -------------------------------------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #include "lldb/Host/Host.h"
 #include "PosixSpawnResponsible.h"
 
 #include <AvailabilityMacros.h>
 #include <TargetConditionals.h>
 
 #if TARGET_OS_OSX
 #define __XPC_PRIVATE_H__
 #include <xpc/xpc.h>
if (process_info.ProcessIDIsValid()) {
     if (::sysctl(proc_args_mib, 3, arg_data.GetBytes(), &arg_data_size, NULL,
                  0) == 0) {
       DataExtractor data(arg_data.GetBytes(), arg_data_size,
                          endian::InlHostByteOrder(), sizeof(void *));
       lldb::offset_t offset = 0;
       uint32_t argc = data.GetU32(&offset);
       llvm::Triple &triple = process_info.GetArchitecture().GetTriple();
       const llvm::Triple::ArchType triple_arch = triple.getArch();
-      const bool check_for_ios_simulator =
+      bool check_for_ios_simulator =
           (triple_arch == llvm::Triple::x86 ||
            triple_arch == llvm::Triple::x86_64);
-      const char *cstr = data.GetCStr(&offset);
-      if (cstr) {
-        process_info.GetExecutableFile().SetFile(cstr, FileSpec::Style::native);
+      llvm::StringRef str(data.GetCStr(&offset));
+      if (!str.empty()) {
+        process_info.GetExecutableFile().SetFile(str, FileSpec::Style::native);
 
         if (match_info_ptr == NULL ||
             NameMatches(
                 process_info.GetExecutableFile().GetFilename().GetCString(),
                 match_info_ptr->GetNameMatchType(),
                 match_info_ptr->GetProcessInfo().GetName())) {
           // Skip NULLs
           while (true) {
             const uint8_t *p = data.PeekData(offset, 1);
             if ((p == NULL) || (*p != '\0'))
               break;
             ++offset;
           }
           // Now extract all arguments
           Args &proc_args = process_info.GetArguments();
           for (int i = 0; i < static_cast<int>(argc); ++i) {
-            cstr = data.GetCStr(&offset);
-            if (cstr)
-              proc_args.AppendArgument(llvm::StringRef(cstr));
+            str = data.GetCStr(&offset);
+            if (!str.empty())
+              proc_args.AppendArgument(str);
           }
 
           Environment &proc_env = process_info.GetEnvironment();
-          while ((cstr = data.GetCStr(&offset))) {
-            if (cstr[0] == '\0')
+          process_info.GetArchitecture().GetTriple().setOS(
+              llvm::Triple::MacOSX);
+          while (true) {
+            str = data.GetCStr(&offset);
+            if (str.empty())
               break;
 
             if (check_for_ios_simulator) {
-              if (strncmp(cstr, "SIMULATOR_UDID=", strlen("SIMULATOR_UDID=")) ==
-                  0)
+              if (str.startswith("SIMULATOR_UDID=")) {
                 process_info.GetArchitecture().GetTriple().setOS(
                     llvm::Triple::IOS);
-              else
-                process_info.GetArchitecture().GetTriple().setOS(
-                    llvm::Triple::MacOSX);
+                process_info.GetArchitecture().GetTriple().setEnvironment(
+                    llvm::Triple::Simulator);
+                check_for_ios_simulator = false;
               }
-
-            proc_env.insert(cstr);
+            }
+            proc_env.insert(str);
           }
           return true;
         }
       }
     }
   }
   return false;
 }

lldb/test/API/macosx/simulator/TestSimulatorPlatform.py

def run_with(self, arch, os, vers, env, expected_load_command):
         self.build(dictionary={'TRIPLE': triple})
         self.check_load_commands(expected_load_command)
         log = self.getBuildArtifact('packets.log')
         self.expect("log enable gdb-remote packets -f "+log)
         lldbutil.run_to_source_breakpoint(self, "break here",
                                           lldb.SBFileSpec("hello.c"))
         triple_re = '-'.join([arch, 'apple', os + vers+'.*'] + env_list)
         self.expect('image list -b -t', patterns=['a\.out '+triple_re])
+        # Make sure that platform process list works to list simulator
+        # processes for all ios-simulator variants. If there are no processes
+        # then an error message will be output like:
+        # error: no processes were found on the "ios-simulator" platform
+        # Below we check that some processes were found to ensure this
+        # functionality works.
+        self.expect('platform process list',
+                    patterns=['[0-9]+ matching processes were found on'])
         self.check_debugserver(log, os+env, vers)
 
     @skipUnlessDarwin
     @skipIfDarwinEmbedded
     @apple_simulator_test('iphone')
     @skipIfOutOfTreeDebugserver
     def test_ios(self):
         """Test running an iOS simulator binary"""