server/cros/multimedia/system_facade_adapter.py

# Copyright 2015 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

"""An adapter to remotely access the system facade on DUT."""


class SystemFacadeRemoteAdapter(object):
    """SystemFacadeRemoteAdapter is an adapter to remotely control DUT system.

    The Autotest host object representing the remote DUT, passed to this
    class on initialization, can be accessed from its _client property.

    """
    def __init__(self, host, remote_facade_proxy):
        """Construct an SystemFacadeRemoteAdapter.

        @param host: Host object representing a remote host.
        @param remote_facade_proxy: RemoteFacadeProxy object.

        """
        self._client = host
        self._proxy = remote_facade_proxy


    @property
    def _system_proxy(self):
        """Gets the proxy to DUT system facade.

        @return XML RPC proxy to DUT system facade.

        """
        return self._proxy.system


    def set_scaling_governor_mode(self, index, mode):
        """Set mode of CPU scaling governor on one CPU of DUT.

        @param index: CPU index starting from 0.

        @param mode: Mode of scaling governor, accept 'interactive' or
                     'performance'.

        @returns: The original mode.

        """
        return self._system_proxy.set_scaling_governor_mode(index, mode)


    def get_cpu_usage(self):
        """Returns machine's CPU usage.

        Returns:
            A dictionary with 'user', 'nice', 'system' and 'idle' values.
            Sample dictionary:
            {
                'user': 254544,
                'nice': 9,
                'system': 254768,
                'idle': 2859878,
            }
        """
        return self._system_proxy.get_cpu_usage()


    def compute_active_cpu_time(self, cpu_usage_start, cpu_usage_end):
        """Computes the fraction of CPU time spent non-idling.

        This function should be invoked using before/after values from calls to
        get_cpu_usage().
        """
        return self._system_proxy.compute_active_cpu_time(cpu_usage_start,
                                                          cpu_usage_end)


    def get_mem_total(self):
        """Returns the total memory available in the system in MBytes."""
        return self._system_proxy.get_mem_total()


    def get_mem_free(self):
        """Returns the currently free memory in the system in MBytes."""
        return self._system_proxy.get_mem_free()

    def get_mem_free_plus_buffers_and_cached(self):
        """
        Returns the free memory in MBytes, counting buffers and cached as free.

        This is most often the most interesting number since buffers and cached
        memory can be reclaimed on demand. Note however, that there are cases
        where this as misleading as well, for example used tmpfs space
        count as Cached but can not be reclaimed on demand.
        See https://www.kernel.org/doc/Documentation/filesystems/tmpfs.txt.
        """
        return self._system_proxy.get_mem_free_plus_buffers_and_cached()

    def get_ec_temperatures(self):
        """Uses ectool to return a list of all sensor temperatures in Celsius.
        """
        return self._system_proxy.get_ec_temperatures()

    def get_current_temperature_max(self):
        """
        Returns the highest reported board temperature (all sensors) in Celsius.
        """
        return self._system_proxy.get_current_temperature_max()

    def get_current_board(self):
        """Returns the current device board name."""
        return self._system_proxy.get_current_board()


    def get_chromeos_release_version(self):
        """Returns chromeos version in device under test as string. None on
        fail.
        """
        return self._system_proxy.get_chromeos_release_version()

    def get_num_allocated_file_handles(self):
        """
        Returns the number of currently allocated file handles.
        """
        return self._system_proxy.get_num_allocated_file_handles()

    def get_storage_statistics(self, device=None):
        """
        Fetches statistics for a storage device.
        """
        return self._system_proxy.get_storage_statistics(device)

    def start_bg_worker(self, command):
        """
        Start executing the command in a background worker.
        """
        return self._system_proxy.start_bg_worker(command)

    def get_and_discard_bg_worker_output(self):
        """
        Returns the output collected so far since the last call to this method.
        """
        return self._system_proxy.get_and_discard_bg_worker_output()

    def stop_bg_worker(self):
        """
        Stop the worker.
        """
        return self._system_proxy.stop_bg_worker()