Reland "Add --serial-id option to host_forwarder."

build/android/pylib/forwarder.py

 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 import logging
 import os
 import re
 import sys
 import threading
 import time
 
 import android_commands
 import cmd_helper
 import constants
-import ports
 
 from pylib import pexpect
 
 
 def _MakeBinaryPath(build_type, binary_name):
   return os.path.join(cmd_helper.OutDirectory.get(), build_type, binary_name)
 
 
 class Forwarder(object):
   """Thread-safe class to manage port forwards from the device to the host."""
 
-  # Unix Abstract socket path:
-  _DEVICE_ADB_CONTROL_PORT = 'chrome_device_forwarder'
-  _TIMEOUT_SECS = 30
-
   _DEVICE_FORWARDER_FOLDER = (constants.TEST_EXECUTABLE_DIR +
                               '/forwarder/')
   _DEVICE_FORWARDER_PATH = (constants.TEST_EXECUTABLE_DIR +
                             '/forwarder/device_forwarder')
   _LD_LIBRARY_PATH = 'LD_LIBRARY_PATH=%s' % _DEVICE_FORWARDER_FOLDER
 
   def __init__(self, adb, build_type):
     """Forwards TCP ports on the device back to the host.
 
     Works like adb forward, but in reverse.
@@ skipping 23 matching lines @@
                  get the number of the assigned port using the
                  DevicePortForHostPort method.
       tool: Tool class to use to get wrapper, if necessary, for executing the
             forwarder (see valgrind_tools.py).
 
     Raises:
       Exception on failure to forward the port.
     """
     with self._lock:
       self._InitDeviceLocked(tool)
-      self._InitHostLocked()
       host_name = '127.0.0.1'
       redirection_commands = [
-          '%d:%d:%d:%s' % (self._host_adb_control_port, device, host,
-                           host_name) for device, host in port_pairs]
-      logging.info('Command format: <ADB port>:<Device port>' +
-                   '[:<Forward to port>:<Forward to address>]')
+          ['--serial-id=' + self._adb.Adb().GetSerialNumber(), '--map',
+           str(device), str(host)] for device, host in port_pairs]
       logging.info('Forwarding using commands: %s', redirection_commands)
 
       for redirection_command in redirection_commands:
         try:
           (exit_code, output) = cmd_helper.GetCmdStatusAndOutput(
-              [self._host_forwarder_path, redirection_command])
+              [self._host_forwarder_path] + redirection_command)
         except OSError as e:
           if e.errno == 2:
             raise Exception('Unable to start host forwarder. Make sure you have'
                             ' built host_forwarder.')
           else: raise
         if exit_code != 0:
           raise Exception('%s exited with %d:\n%s' % (
               self._host_forwarder_path, exit_code, '\n'.join(output)))
         tokens = output.split(':')
         if len(tokens) != 2:
-          raise Exception('Unexpected host forwarder output "%s", ' +
-                          'expected "device_port:host_port"' % output)
+          raise Exception(('Unexpected host forwarder output "%s", ' +
+                          'expected "device_port:host_port"') % output)
         device_port = int(tokens[0])
         host_port = int(tokens[1])
         self._device_to_host_port_map[device_port] = host_port
         self._host_to_device_port_map[host_port] = device_port
         logging.info('Forwarding device port: %d to host port: %d.',
                      device_port, host_port)
 
-  def _InitHostLocked(self):
-    """Initializes the host forwarder process (only once)."""
-    if self._host_adb_control_port:
-      return
-    self._host_adb_control_port = ports.AllocateTestServerPort()
-    if not self._host_adb_control_port:
-      raise Exception('Failed to allocate a TCP port in the host machine.')
-    if cmd_helper.RunCmd(
-        ['adb', '-s', self._adb._adb.GetSerialNumber(), 'forward',
-         'tcp:%s' % self._host_adb_control_port,
-         'localabstract:%s' % Forwarder._DEVICE_ADB_CONTROL_PORT]) != 0:
-      raise Exception('Error while running adb forward.')
-
   def _InitDeviceLocked(self, tool):
     """Initializes the device forwarder process (only once)."""
     if self._device_initialized:
       return
     self._adb.PushIfNeeded(
         self._device_forwarder_path_on_host,
         Forwarder._DEVICE_FORWARDER_FOLDER)
     (exit_code, output) = self._adb.GetShellCommandStatusAndOutput(
-        '%s %s %s %s' % (Forwarder._LD_LIBRARY_PATH, tool.GetUtilWrapper(),
-                         Forwarder._DEVICE_FORWARDER_PATH,
-                         Forwarder._DEVICE_ADB_CONTROL_PORT))
+        '%s %s %s' % (Forwarder._LD_LIBRARY_PATH, tool.GetUtilWrapper(),
+                      Forwarder._DEVICE_FORWARDER_PATH))
     if exit_code != 0:
       raise Exception(
           'Failed to start device forwarder:\n%s' % '\n'.join(output))
     self._device_initialized = True
 
   def UnmapDevicePort(self, device_port):
     """Unmaps a previously forwarded device port.
 
     Args:
       device_port: A previously forwarded port (through Run()).
     """
     with self._lock:
       self._UnmapDevicePortInternalLocked(device_port)
 
   def _UnmapDevicePortInternalLocked(self, device_port):
     if not device_port in self._device_to_host_port_map:
       return
-    # Please note the minus sign below.
-    redirection_command = '%d:-%d' % (
-        self._host_adb_control_port, device_port)
+    redirection_command = [
+        '--serial-id=' + self._adb.Adb().GetSerialNumber(), '--unmap',
+        str(device_port)]
     (exit_code, output) = cmd_helper.GetCmdStatusAndOutput(
-        [self._host_forwarder_path, redirection_command])
+        [self._host_forwarder_path] + redirection_command)
     if exit_code != 0:
       raise Exception('%s exited with %d:\n%s' % (
           self._host_forwarder_path, exit_code, '\n'.join(output)))
     host_port = self._device_to_host_port_map[device_port]
     del self._device_to_host_port_map[device_port]
     del self._host_to_device_port_map[host_port]
 
   @staticmethod
   def KillHost(build_type='Debug'):
     """Kills the forwarder process running on the host.
 
     Args:
       build_type: 'Release' or 'Debug' (default='Debug')
     """
     logging.info('Killing host_forwarder.')
     host_forwarder_path = _MakeBinaryPath(build_type, 'host_forwarder')
     if not os.path.exists(host_forwarder_path):
       host_forwarder_path = _MakeBinaryPath(
           'Release' if build_type == 'Debug' else 'Debug', 'host_forwarder')
     assert os.path.exists(host_forwarder_path), 'Please build forwarder2'
     (exit_code, output) = cmd_helper.GetCmdStatusAndOutput(
-        [host_forwarder_path, 'kill-server'])
+        [host_forwarder_path, '--kill-server'])
     if exit_code != 0:
       (exit_code, output) = cmd_helper.GetCmdStatusAndOutput(
           ['pkill', 'host_forwarder'])
       if exit_code != 0:
         raise Exception('%s exited with %d:\n%s' % (
               host_forwarder_path, exit_code, '\n'.join(output)))
 
   @staticmethod
   def KillDevice(adb, tool):
     """Kills the forwarder process running on the device.
 
     Args:
       adb: Instance of AndroidCommands for talking to the device.
       tool: Wrapper tool (e.g. valgrind) that can be used to execute the device
             forwarder (see valgrind_tools.py).
     """
     logging.info('Killing device_forwarder.')
     if not adb.FileExistsOnDevice(Forwarder._DEVICE_FORWARDER_PATH):
       return
     (exit_code, output) = adb.GetShellCommandStatusAndOutput(
-        '%s %s kill-server' % (tool.GetUtilWrapper(),
-                               Forwarder._DEVICE_FORWARDER_PATH))
+        '%s %s --kill-server' % (tool.GetUtilWrapper(),
+                                 Forwarder._DEVICE_FORWARDER_PATH))
     # TODO(pliard): Remove the following call to KillAllBlocking() when we are
     # sure that the old version of device_forwarder (not supporting
     # 'kill-server') is not running on the bots anymore.
     timeout_sec = 5
     processes_killed = adb.KillAllBlocking('device_forwarder', timeout_sec)
     if not processes_killed:
       pids = adb.ExtractPid('device_forwarder')
       if pids:
         raise Exception('Timed out while killing device_forwarder')
 
   def DevicePortForHostPort(self, host_port):
     """Returns the device port that corresponds to a given host port."""
     with self._lock:
       return self._host_to_device_port_map.get(host_port)
 
   def Close(self):
     """Releases the previously forwarded ports."""
     with self._lock:
       for device_port in self._device_to_host_port_map.copy():
         self._UnmapDevicePortInternalLocked(device_port)