1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
/*
* Copyright (C) 2018 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 android.os.SystemClock;
import android.support.test.uiautomator.UiDevice;
import android.util.Log;
import androidx.test.InstrumentationRegistry;
import java.io.IOException;
import java.io.File;
import java.nio.file.Path;
import java.nio.file.Paths;
/**
* PerfettoHelper is used to start and stop the perfetto tracing and move the
* output perfetto trace file to destination folder.
*/
public class PerfettoHelper {
private static final String LOG_TAG = PerfettoHelper.class.getSimpleName();
private static final String PERFETTO_ROOT_DIR = "/data/misc/perfetto-traces/";
// Command to start the perfetto tracing in the background.
// perfetto -b -c /data/misc/perfetto-traces/trace_config.pb -o
// /data/misc/perfetto-traces/trace_output.pb
private static final String PERFETTO_START_CMD = "perfetto --background -c %s%s -o %s";
private static final String PERFETTO_TMP_OUTPUT_FILE =
"/data/misc/perfetto-traces/trace_output.pb";
// Command to stop (i.e kill) the perfetto tracing.
private static final String PERFETTO_STOP_CMD = "pkill -INT perfetto";
// Command to check the perfetto process id.
private static final String PERFETTO_PROC_ID_CMD = "pidof perfetto";
// Remove the trace output file /data/misc/perfetto-traces/trace_output.pb
private static final String REMOVE_CMD = "rm %s";
// Command to move the perfetto output trace file to given folder.
private static final String MOVE_CMD = "mv %s %s";
// Max wait count for checking if perfetto is stopped successfully
private static final int PERFETTO_KILL_WAIT_COUNT = 12;
// Check if perfetto is stopped every 5 secs.
private static final long PERFETTO_KILL_WAIT_TIME = 5000;
private UiDevice mUIDevice;
/**
* Start the perfetto tracing in background using the given config file and write the ouput to
* /data/misc/perfetto-traces/trace_output.pb. Perfetto has access only to
* /data/misc/perfetto-traces/ folder. So the config file has to be under
* /data/misc/perfetto-traces/ folder in the device.
*
* @param configFileName used for collecting the perfetto trace.
* @return true if trace collection started successfully otherwise return false.
*/
public boolean startCollecting(String configFileName) {
mUIDevice = UiDevice.getInstance(InstrumentationRegistry.getInstrumentation());
if (configFileName == null || configFileName.isEmpty()) {
Log.e(LOG_TAG, "Perfetto config file name is null or empty.");
return false;
}
try {
// Cleanup already existing perfetto process.
Log.i(LOG_TAG, "Cleanup perfetto before starting.");
if (isPerfettoRunning()) {
Log.i(LOG_TAG, "Perfetto tracing is already running. Stopping perfetto.");
if (!stopPerfetto()) {
return false;
}
}
// Remove already existing temporary output trace file if any.
String output = mUIDevice.executeShellCommand(String.format(REMOVE_CMD,
PERFETTO_TMP_OUTPUT_FILE));
Log.i(LOG_TAG, String.format("Perfetto output file cleanup - %s", output));
// Start perfetto tracing.
Log.i(LOG_TAG, "Starting perfetto tracing.");
String startOutput = mUIDevice.executeShellCommand(String.format(PERFETTO_START_CMD,
PERFETTO_ROOT_DIR, configFileName, PERFETTO_TMP_OUTPUT_FILE));
Log.i(LOG_TAG, String.format("Perfetto start command output - %s", startOutput));
// TODO : Once the output status is available use that for additional validation.
if (!isPerfettoRunning()) {
Log.e(LOG_TAG, "Perfetto tracing failed to start.");
return false;
}
} catch (IOException ioe) {
Log.e(LOG_TAG, "Unable to start the perfetto tracing due to :" + ioe.getMessage());
return false;
}
Log.i(LOG_TAG, "Perfetto tracing started successfully.");
return true;
}
/**
* Stop the perfetto trace collection under /data/misc/perfetto-traces/trace_output.pb after
* waiting for given time in msecs and copy the output to the destination file.
*
* @param waitTimeInMsecs time to wait in msecs before stopping the trace collection.
* @param destinationFile file to copy the perfetto output trace.
* @return true if the trace collection is successfull otherwise false.
*/
public boolean stopCollecting(long waitTimeInMsecs, String destinationFile) {
// Wait for the dump interval before stopping the trace.
Log.i(LOG_TAG, String.format(
"Waiting for %d msecs before stopping perfetto.", waitTimeInMsecs));
SystemClock.sleep(waitTimeInMsecs);
// Stop the perfetto and copy the output file.
Log.i(LOG_TAG, "Stopping perfetto.");
try {
if (stopPerfetto()) {
if (!copyFileOutput(destinationFile)) {
return false;
}
} else {
Log.e(LOG_TAG, "Perfetto failed to stop.");
return false;
}
} catch (IOException ioe) {
Log.e(LOG_TAG, "Unable to stop the perfetto tracing due to " + ioe.getMessage());
return false;
}
return true;
}
/**
* Utility method for stopping perfetto.
*
* @return true if perfetto is stopped successfully.
*/
private boolean stopPerfetto() throws IOException {
String stopOutput = mUIDevice.executeShellCommand(PERFETTO_STOP_CMD);
Log.i(LOG_TAG, String.format("Perfetto stop command output - %s", stopOutput));
int waitCount = 0;
while (isPerfettoRunning()) {
// 60 secs timeout for perfetto shutdown.
if (waitCount < PERFETTO_KILL_WAIT_COUNT) {
// Check every 5 secs if perfetto stopped successfully.
SystemClock.sleep(PERFETTO_KILL_WAIT_TIME);
waitCount++;
continue;
}
return false;
}
Log.e(LOG_TAG, "Perfetto stopped successfully.");
return true;
}
/**
* Check if perfetto process is running or not.
*
* @return true if perfetto is running otherwise false.
*/
private boolean isPerfettoRunning() {
try {
String perfettoProcId = mUIDevice.executeShellCommand(PERFETTO_PROC_ID_CMD);
Log.i(LOG_TAG, String.format("Perfetto process id - %s", perfettoProcId));
if (perfettoProcId.isEmpty()) {
return false;
}
} catch (IOException ioe) {
Log.e(LOG_TAG, "Not able to check the perfetto status due to:" + ioe.getMessage());
return false;
}
return true;
}
/**
* Copy the temporary perfetto trace output file from /data/misc/perfetto-traces/ to given
* destinationFile.
*
* @param destinationFile file to copy the perfetto output trace.
* @return true if the trace file copied successfully otherwise false.
*/
private boolean copyFileOutput(String destinationFile) {
Path path = Paths.get(destinationFile);
String destDirectory = path.getParent().toString();
// Check if the directory already exists
File directory = new File(destDirectory);
if (!directory.exists()) {
boolean success = directory.mkdirs();
if (!success) {
Log.e(LOG_TAG, String.format(
"Result output directory %s not created successfully.", destDirectory));
return false;
}
}
// Copy the collected trace from /data/misc/perfetto-traces/trace_output.pb to
// destinationFile
try {
String moveResult = mUIDevice.executeShellCommand(String.format(
MOVE_CMD, PERFETTO_TMP_OUTPUT_FILE, destinationFile));
if (!moveResult.isEmpty()) {
Log.e(LOG_TAG, String.format(
"Unable to move perfetto output file from %s to %s due to %s",
PERFETTO_TMP_OUTPUT_FILE, destinationFile, moveResult));
return false;
}
} catch (IOException ioe) {
Log.e(LOG_TAG,
"Unable to move the perfetto trace file to destination file."
+ ioe.getMessage());
return false;
}
return true;
}
}
|
