libraries/collectors-helper/memory/src/com/android/helpers/ShowmapSnapshotHelper.java

/*
 * Copyright (C) 2019 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.helpers;

import static com.android.helpers.MetricUtility.constructKey;

import android.util.Log;

import androidx.annotation.VisibleForTesting;
import androidx.test.InstrumentationRegistry;
import androidx.test.uiautomator.UiDevice;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.InputMismatchException;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.UUID;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

/**
 * Helper to collect memory information for a list of processes from showmap.
 */
public class ShowmapSnapshotHelper implements ICollectorHelper<String> {
    private static final String TAG = ShowmapSnapshotHelper.class.getSimpleName();

    private static final String DROP_CACHES_CMD = "echo %d > /proc/sys/vm/drop_caches";
    private static final String PIDOF_CMD = "pidof %s";
    public static final String ALL_PROCESSES_CMD = "ps -A";
    private static final String SHOWMAP_CMD = "showmap -v %d";
    private static final String CHILD_PROCESSES_CMD = "ps -A --ppid %d";
    @VisibleForTesting public static final String OOM_SCORE_ADJ_CMD = "cat /proc/%d/oom_score_adj";
    private static final String THREADS_FILE_PATH = "/sdcard/countThreads.sh";
    @VisibleForTesting public static final String THREADS_CMD = "sh /sdcard/countThreads.sh";
    private static final String THREADS_EXEC_SCRIPT =
            "for i in $(ls /proc | grep -E [0-9]+); do echo \"threads_count_$(cat"
                    + " /proc/$i/cmdline) : $(ls /proc/$i/task | wc -l)\"; done;";
    public static final String THREADS_PATTERN = "(?<key>^threads_count_.+) : (?<value>[0-9]+)";
    public static final String OUTPUT_METRIC_PATTERN = "showmap_%s_bytes";
    public static final String OUTPUT_FILE_PATH_KEY = "showmap_output_file";
    public static final String PROCESS_COUNT = "process_count";
    public static final String CHILD_PROCESS_COUNT_PREFIX = "child_processes_count";
    public static final String OUTPUT_CHILD_PROCESS_COUNT_KEY = CHILD_PROCESS_COUNT_PREFIX + "_%s";
    public static final String PROCESS_WITH_CHILD_PROCESS_COUNT =
            "process_with_child_process_count";
    private static final String METRIC_VALUE_SEPARATOR = "_";
    public static final String PARENT_PROCESS_STRING = "parent_process";
    public static final String CHILD_PROCESS_STRING = "child_process";
    // The reason to skip the process: b/272181398#comment24
    private static final Set<String> SKIP_PROCESS = new HashSet<>(Arrays.asList("logcat", "sh"));

    private String[] mProcessNames = null;
    private String mTestOutputDir = null;
    private String mTestOutputFile = null;

    private int mDropCacheOption;
    private boolean mCollectForAllProcesses = false;
    private UiDevice mUiDevice;
    private boolean mRunGcPrecollection;
    private boolean mRunCountThreads;

    // Map to maintain per-process memory info
    private Map<String, String> mMemoryMap = new HashMap<>();

    // Maintain metric name and the index it corresponds to in the showmap output
    // summary
    private Map<String, List<Integer>> mMetricNameIndexMap = new HashMap<>();

    public void setUp(String testOutputDir, String... processNames) {
        mProcessNames = processNames;
        mTestOutputDir = testOutputDir;
        mDropCacheOption = 0;
        mRunGcPrecollection = false;
        mRunCountThreads = false;
        mUiDevice = UiDevice.getInstance(InstrumentationRegistry.getInstrumentation());
    }

    @Override
    public boolean startCollecting() {
        if (mTestOutputDir == null) {
            Log.e(TAG, String.format("Invalid test setup"));
            return false;
        }
        mMemoryMap.clear();

        File directory = new File(mTestOutputDir);
        String filePath = String.format("%s/showmap_snapshot%d.txt", mTestOutputDir,
                UUID.randomUUID().hashCode());
        File file = new File(filePath);

        // Make sure directory exists and file does not
        if (directory.exists()) {
            if (file.exists() && !file.delete()) {
                Log.e(TAG, String.format("Failed to delete result output file %s", filePath));
                return false;
            }
        } else {
            if (!directory.mkdirs()) {
                Log.e(TAG, String.format("Failed to create result output directory %s",
                        mTestOutputDir));
                return false;
            }
        }

        // Create an empty file to fail early in case there are no write permissions
        try {
            if (!file.createNewFile()) {
                // This should not happen unless someone created the file right after we deleted it
                Log.e(TAG,
                        String.format("Race with another user of result output file %s", filePath));
                return false;
            }
        } catch (IOException e) {
            Log.e(TAG, String.format("Failed to create result output file %s", filePath), e);
            return false;
        }

        mTestOutputFile = filePath;
        return true;
    }

    @Override
    public Map<String, String> getMetrics() {
        try {
            if (mRunCountThreads) {
                mMemoryMap.putAll(execCountThreads());
            }
            // Drop cache if requested
            if (mDropCacheOption > 0) {
                dropCache(mDropCacheOption);
            }
            if (mCollectForAllProcesses) {
                Log.i(TAG, "Collecting memory metrics for all processes.");
                mProcessNames = getAllProcessNames();
            } else if (mProcessNames.length > 0) {
                Log.i(TAG, "Collecting memory only for given list of process");
            } else if (mProcessNames.length == 0) {
                // No processes specified, just return empty map
                return mMemoryMap;
            }
            HashSet<Integer> zygoteChildrenPids = getZygoteChildrenPids();
            FileWriter writer = new FileWriter(new File(mTestOutputFile), true);
            for (String processName : mProcessNames) {
                List<Integer> pids = new ArrayList<>();
                // Collect required data
                try {
                    pids = getPids(processName);
                    for (Integer pid : pids) {
                        // Force Garbage collect to trim transient objects before taking memory
                        // measurements as memory tests aim to track persistent memory regression
                        // instead of transient memory which also allows for de-noising and reducing
                        // likelihood of false alerts.
                        if (mRunGcPrecollection && zygoteChildrenPids.contains(pid)) {
                            // Skip native processes from sending GC signal.
                            android.os.Trace.beginSection("IssueGCForPid: " + pid);
                            // Perform a synchronous GC which happens when we request meminfo
                            // This save us the need of setting up timeouts that may or may not
                            // match with the end time of GC.
                            mUiDevice.executeShellCommand("dumpsys meminfo -a " + pid);
                            android.os.Trace.endSection();
                        }

                        // Skip the cached process for showmap and child process count
                        if (isCachedProcess(processName, pid)) {
                            Log.i(TAG, String.format("Skip the cached process %s.", processName));
                            continue;
                        }

                        android.os.Trace.beginSection("ExecuteShowmap");
                        String showmapOutput = execShowMap(processName, pid);
                        android.os.Trace.endSection();
                        parseAndUpdateMemoryInfo(processName, showmapOutput);
                        // Store showmap output into file. If there are more than one process
                        // with same name write the individual showmap associated with pid.
                        storeToFile(mTestOutputFile, processName, pid, showmapOutput, writer);
                        // Parse number of child processes for the given pid and update the
                        // total number of child process count for the process name that pid
                        // is associated with.
                        updateChildProcessesDetails(processName, pid);
                    }
                } catch (RuntimeException e) {
                    Log.e(TAG, e.getMessage(), e.getCause());
                    // Skip this process and continue with the next one
                    continue;
                }
            }
            // To track total number of process with child processes.
            if (mMemoryMap.size() != 0) {
                Set<String> parentWithChildProcessSet = mMemoryMap.keySet()
                        .stream()
                        .filter(s -> s.startsWith(CHILD_PROCESS_COUNT_PREFIX))
                        .collect(Collectors.toSet());
                mMemoryMap.put(PROCESS_WITH_CHILD_PROCESS_COUNT,
                        Long.toString(parentWithChildProcessSet.size()));
            }
            // Store the unique process count. -1 to exclude the "ps" process name.
            mMemoryMap.put(PROCESS_COUNT, Integer.toString(mProcessNames.length - 1));
            writer.close();
            mMemoryMap.put(OUTPUT_FILE_PATH_KEY, mTestOutputFile);
        } catch (RuntimeException e) {
            Log.e(TAG, e.getMessage(), e.getCause());
        } catch (IOException e) {
            Log.e(TAG, String.format("Failed to write output file %s", mTestOutputFile), e);
        }
        return mMemoryMap;
    }

    public HashSet<Integer> getZygoteChildrenPids() {
        HashSet<Integer> allZygoteChildren;
        allZygoteChildren = getChildrenPids("zygote");
        HashSet<Integer> zyg64children = getChildrenPids("zygote64");
        allZygoteChildren.addAll(zyg64children);
        return allZygoteChildren;
    }

    public HashSet<Integer> getChildrenPids(String processName) {
        HashSet<Integer> childrenPids = new HashSet<>();
        String childrenCmdOutput = "";
        try {
            // Execute shell does not support shell substitution so it has to be executed twice.
            childrenCmdOutput =
                    mUiDevice.executeShellCommand(
                            "pgrep -P " + mUiDevice.executeShellCommand("pidof " + processName));
        } catch (IOException e) {
            Log.e(TAG, "Exception occurred reading children for process " + processName);
        }
        String[] lines = childrenCmdOutput.split("\\R");
        for (String line : lines) {
            try {
                int pid = Integer.parseInt(line);
                childrenPids.add(pid);
            } catch (NumberFormatException e) {
                // If the process does not exist or the shell command fails
                // just skip the pid, this is because there could be some
                // devices that contain a process while others do not.
            }
        }
        return childrenPids;
    }

    @Override
    public boolean stopCollecting() {
        return true;
    }

    /**
     * Sets option for running GC prior to collection.
     *
     * @param shouldGcOnPrecollect whether it should run GC prior to showmap collection
     */
    public void setGcOnPrecollectOption(boolean shouldGcOnPrecollect) {
        mRunGcPrecollection = shouldGcOnPrecollect;
    }

    /**
     * Sets option for counting the threads for all processes.
     *
     * @param shouldCountThreads whether it should run count threads
     */
    public void setCountThreadsOption(boolean shouldCountThreads) {
        mRunCountThreads = shouldCountThreads;
    }

    /**
     * Set drop cache option.
     *
     * @param dropCacheOption drop pagecache (1), slab (2) or all (3) cache
     * @return true on success, false if input option is invalid
     */
    public boolean setDropCacheOption(int dropCacheOption) {
        // Valid values are 1..3
        if (dropCacheOption < 1 || dropCacheOption > 3) {
            return false;
        }

        mDropCacheOption = dropCacheOption;
        return true;
    }

    /**
     * Drops kernel memory cache.
     *
     * @param cacheOption drop pagecache (1), slab (2) or all (3) caches
     */
    private void dropCache(int cacheOption) throws RuntimeException {
        try {
            mUiDevice.executeShellCommand(String.format(DROP_CACHES_CMD, cacheOption));
        } catch (IOException e) {
            throw new RuntimeException("Unable to drop caches", e);
        }
    }

    /**
     * Get pid's of the process with {@code processName} name.
     *
     * @param processName name of the process to get pid
     * @return pid's of the specified process
     */
    private List<Integer> getPids(String processName) throws RuntimeException {
        try {
            String pidofOutput = mUiDevice
                    .executeShellCommand(String.format(PIDOF_CMD, processName));

            // Sample output for the process with more than 1 pid.
            // Sample command : "pidof init"
            // Sample output : 1 559
            String[] pids = pidofOutput.split("\\s+");
            List<Integer> pidList = new ArrayList<>();
            for (String pid : pids) {
                pidList.add(Integer.parseInt(pid.trim()));
            }
            return pidList;
        } catch (IOException e) {
            throw new RuntimeException(String.format("Unable to get pid of %s ", processName), e);
        }
    }

    /**
     * Executes showmap command for the process with {@code processName} name and {@code pid} pid.
     *
     * @param processName name of the process to run showmap for
     * @param pid pid of the process to run showmap for
     * @return the output of showmap command
     */
    private String execShowMap(String processName, long pid) throws IOException {
        try {
            return mUiDevice.executeShellCommand(String.format(SHOWMAP_CMD, pid));
        } catch (IOException e) {
            throw new RuntimeException(
                    String.format("Unable to execute showmap command for %s ", processName), e);
        }
    }

    /**
     * Executes counting threads command for the process.
     *
     * @param processName name of the process to run showmap for
     * @param pid pid of the process to run showmap for
     * @return the output of showmap command
     */
    private Map<String, String> execCountThreads() throws IOException {
        String countOutput;
        Map<String, String> countResults = new HashMap<>();
        try {
            File execTempFile = new File(THREADS_FILE_PATH);
            execTempFile.setWritable(true);
            execTempFile.setExecutable(true, /*ownersOnly*/ false);
            String countThreadsScriptPath = execTempFile.getAbsolutePath();
            BufferedWriter writer = new BufferedWriter(new FileWriter(countThreadsScriptPath));
            writer.write(THREADS_EXEC_SCRIPT);
            writer.close();
            countOutput = executeShellCommand(THREADS_CMD);
            Pattern pattern =
                    Pattern.compile(THREADS_PATTERN, Pattern.CASE_INSENSITIVE | Pattern.MULTILINE);
            String[] lines = countOutput.split("\n");
            for (String line : lines) {
                Matcher matcher = pattern.matcher(line);
                boolean matchFound = matcher.find();
                if (matchFound) {
                    countResults.put(matcher.group(1), matcher.group(2));
                }
            }
            return countResults;
        } catch (IOException e) {
            throw new RuntimeException("Unable to execute counting threads command", e);
        }
    }

    /**
     * Extract memory metrics from showmap command output for the process with {@code processName}
     * name.
     *
     * @param processName name of the process to extract memory info for
     * @param showmapOutput showmap command output
     */
    private void parseAndUpdateMemoryInfo(String processName, String showmapOutput)
            throws RuntimeException {
        try {

            // -------- -------- -------- -------- -------- -------- -------- -------- ----- ------
            // ----
            // virtual shared shared private private
            // size RSS PSS clean dirty clean dirty swap swapPSS flags object
            // ------- -------- -------- -------- -------- -------- -------- -------- ------ -----
            // ----
            // 10810272 5400 1585 3800 168 264 1168 0 0 TOTAL

            int pos = showmapOutput.lastIndexOf("----");
            String summarySplit[] = showmapOutput.substring(pos).trim().split("\\s+");

            for (Map.Entry<String, List<Integer>> entry : mMetricNameIndexMap.entrySet()) {
                Long metricValue = 0L;
                String metricKey = constructKey(
                        String.format(OUTPUT_METRIC_PATTERN, entry.getKey()),
                        processName);
                for (int index = 0; index < entry.getValue().size(); index++) {
                    metricValue += Long.parseLong(summarySplit[entry.getValue().get(index) + 1]);
                }
                // If there are multiple pids associated with the process name then update the
                // existing entry in the map otherwise add new entry in the map.
                if (mMemoryMap.containsKey(metricKey)) {
                    long currValue = Long.parseLong(mMemoryMap.get(metricKey));
                    mMemoryMap.put(metricKey, Long.toString(currValue + metricValue * 1024));
                } else {
                    mMemoryMap.put(metricKey, Long.toString(metricValue * 1024));
                }
            }
        } catch (IndexOutOfBoundsException | InputMismatchException e) {
            throw new RuntimeException(
                    String.format("Unexpected showmap format for %s ", processName), e);
        }
    }

    /**
     * Store test results for one process into file.
     *
     * @param fileName name of the file being written
     * @param processName name of the process
     * @param pid pid of the process
     * @param showmapOutput showmap command output
     * @param writer file writer to write the data
     */
    private void storeToFile(String fileName, String processName, long pid, String showmapOutput,
            FileWriter writer) throws RuntimeException {
        try {
            writer.write(String.format(">>> %s (%d) <<<\n", processName, pid));
            writer.write(showmapOutput);
            writer.write('\n');
        } catch (IOException e) {
            throw new RuntimeException(String.format("Unable to write file %s ", fileName), e);
        }
    }

    /**
     * Set the memory metric name and corresponding index to parse from the showmap output summary.
     *
     * @param metricNameIndexStr comma separated metric_name:index TODO: Pre-process the string into
     *            map and pass the map to this method.
     */
    public void setMetricNameIndex(String metricNameIndexStr) {
        /**
         * example: metricNameIndexStr rss:1,pss:2,privatedirty:6:7
         * converted to Map: {'rss': [1], 'pss': [2], 'privatedirty': [6, 7]}
         */
        Log.i(TAG, String.format("Metric Name index %s", metricNameIndexStr));
        String metricDetails[] = metricNameIndexStr.split(",");
        for (String metricDetail : metricDetails) {
            List<Integer> indexList = new ArrayList<>();
            String metricDetailsSplit[] = metricDetail.split(":");
            for (int index = 1; index < metricDetailsSplit.length; index++) {
                indexList.add(Integer.parseInt(metricDetailsSplit[index]));
            }
            if (!indexList.isEmpty()) {
                mMetricNameIndexMap.put(metricDetailsSplit[0], indexList);
            }
        }
        Log.i(TAG, String.format("Metric Name index map size %s", mMetricNameIndexMap.size()));
    }

    /** Return true if the giving process is a cached process */
    public boolean isCachedProcess(String processName, long pid) {
        try {
            String score = executeShellCommand(String.format(OOM_SCORE_ADJ_CMD, pid));
            boolean result = Integer.parseInt(score.trim()) >= 900;
            if (result) {
                Log.i(TAG, String.format("The process %s with pid %d is cached", processName, pid));
            }
            return result;
        } catch (IOException e) {
            Log.e(TAG, String.format("Unable to get process oom_score_adj for %s", processName), e);
            // We don't know the process is cached or not, still collect it
            return false;
        }
    }

    /**
     * Retrieves the number of child processes for the given process id and updates the total
     * process count and adds a child process metric for the process name that pid is associated
     * with.
     *
     * @param processName
     * @param pid
     */
    private void updateChildProcessesDetails(String processName, long pid) {
        String childProcessName;
        String childPID;
        String completeChildProcessMetric;
        try {
            Log.i(TAG,
                    String.format("Retrieving child processes count for process name: %s with"
                            + " process id %d.", processName, pid));
            String childProcessesStr = mUiDevice
                    .executeShellCommand(String.format(CHILD_PROCESSES_CMD, pid));
            Log.i(TAG, String.format("Child processes cmd output: %s", childProcessesStr));

            int childProcessCount = 0;
            String[] childProcessStrSplit = childProcessesStr.split("\\n");
            for (String line : childProcessStrSplit) {
                // To discard the header line in the command output.
                if (Objects.equals(line, childProcessStrSplit[0])) continue;
                String[] childProcessSplit = line.trim().split("\\s+");
                /**
                 * final metric will be of following format
                 * parent_process_<process>_child_process_<process>
                 * parent_process_zygote64_child_process_system_server
                 */
                childPID = childProcessSplit[1];
                childProcessName = childProcessSplit[8];
                // Skip the logcat and sh processes in child process count
                if (SKIP_PROCESS.contains(childProcessName)
                        || isCachedProcess(childProcessName, Long.parseLong(childPID))) {
                    Log.i(
                            TAG,
                            String.format(
                                    "Skip the child process %s in the parent process %s.",
                                    childProcessName, processName));
                    continue;
                }
                childProcessCount++;
                completeChildProcessMetric =
                        String.join(
                                METRIC_VALUE_SEPARATOR,
                                PARENT_PROCESS_STRING,
                                processName,
                                CHILD_PROCESS_STRING,
                                childProcessName);
                mMemoryMap.put(completeChildProcessMetric, "1");
            }
            String childCountMetricKey = String.format(OUTPUT_CHILD_PROCESS_COUNT_KEY, processName);
            if (childProcessCount > 0) {
                mMemoryMap.put(childCountMetricKey,
                        Long.toString(
                                Long.parseLong(mMemoryMap.getOrDefault(childCountMetricKey, "0"))
                                        + childProcessCount));
            }
        } catch (IOException e) {
            throw new RuntimeException("Unable to run child process command.", e);
        }
    }

    /**
     * Enables memory collection for all processes.
     */
    public void setAllProcesses() {
        mCollectForAllProcesses = true;
    }

    /**
     * Get all process names running in the system.
     */
    private String[] getAllProcessNames() {
        Set<String> allProcessNames = new LinkedHashSet<>();
        try {
            String psOutput = mUiDevice.executeShellCommand(ALL_PROCESSES_CMD);
            // Split the lines
            String allProcesses[] = psOutput.split("\\n");
            for (String invidualProcessDetails : allProcesses) {
                Log.i(TAG, String.format("Process detail: %s", invidualProcessDetails));
                // Sample process detail line
                // system 603 1 41532 5396 SyS_epoll+ 0 S servicemanager
                String processSplit[] = invidualProcessDetails.split("\\s+");
                // Parse process name
                String processName = processSplit[processSplit.length - 1].trim();
                // Include the process name which are not enclosed in [].
                if (!processName.startsWith("[") && !processName.endsWith("]")) {
                    // Skip the first (i.e header) line from "ps -A" output.
                    if (processName.equalsIgnoreCase("NAME")) {
                        continue;
                    }
                    Log.i(TAG, String.format("Including the process %s", processName));
                    allProcessNames.add(processName);
                }
            }
        } catch (IOException ioe) {
            throw new RuntimeException(
                    String.format("Unable execute all processes command %s ", ALL_PROCESSES_CMD),
                    ioe);
        }
        return allProcessNames.toArray(new String[0]);
    }

    /* Execute a shell command and return its output. */
    @VisibleForTesting
    public String executeShellCommand(String command) throws IOException {
        return mUiDevice.executeShellCommand(command);
    }
}