blob: d7ed055776972ed204b6ef5b16d91edaba82b279 [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2007 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.os;
18
Philip P. Moltmannfd8ed852017-11-01 15:22:02 -070019import android.annotation.NonNull;
20import android.annotation.Nullable;
Andrei Onea24ec3212019-03-15 17:35:05 +000021import android.annotation.UnsupportedAppUsage;
Jeff Sharkey3a6e0ec2016-03-21 16:42:57 -060022import android.app.AppGlobals;
23import android.content.Context;
Dave Bort1ce5bd32009-04-22 17:36:56 -070024import android.util.Log;
25
Narayan Kamathf013daa2017-05-09 12:55:02 +010026import com.android.internal.util.FastPrintWriter;
Philip P. Moltmannfd8ed852017-11-01 15:22:02 -070027import com.android.internal.util.Preconditions;
Narayan Kamathf013daa2017-05-09 12:55:02 +010028import com.android.internal.util.TypedProperties;
29
Narayan Kamathf013daa2017-05-09 12:55:02 +010030import dalvik.system.VMDebug;
31
32import org.apache.harmony.dalvik.ddmc.Chunk;
33import org.apache.harmony.dalvik.ddmc.ChunkHandler;
34import org.apache.harmony.dalvik.ddmc.DdmServer;
35
Jeff Sharkey3a6e0ec2016-03-21 16:42:57 -060036import java.io.File;
Dianne Hackborn9c8dd552009-06-23 19:22:52 -070037import java.io.FileDescriptor;
Dave Bort1ce5bd32009-04-22 17:36:56 -070038import java.io.FileNotFoundException;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080039import java.io.FileOutputStream;
Dave Bort1ce5bd32009-04-22 17:36:56 -070040import java.io.FileReader;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080041import java.io.IOException;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080042import java.io.PrintWriter;
Dave Bort1ce5bd32009-04-22 17:36:56 -070043import java.io.Reader;
Romain Guyc4b11a72009-05-13 15:46:37 -070044import java.lang.annotation.ElementType;
45import java.lang.annotation.Retention;
46import java.lang.annotation.RetentionPolicy;
Narayan Kamathf013daa2017-05-09 12:55:02 +010047import java.lang.annotation.Target;
48import java.lang.reflect.Field;
49import java.lang.reflect.Modifier;
Richard Uhler350e6dc2015-05-18 10:48:52 -070050import java.util.HashMap;
Hiroshi Yamauchi8b5a293d2015-04-02 12:26:10 -070051import java.util.Map;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080052
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080053
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080054/**
Ian Rogersfe067a42013-02-22 19:59:23 -080055 * Provides various debugging methods for Android applications, including
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080056 * tracing and allocation counts.
57 * <p><strong>Logging Trace Files</strong></p>
58 * <p>Debug can create log files that give details about an application, such as
59 * a call stack and start/stop times for any running methods. See <a
Ricardo Loo Forondaac750a82018-01-25 09:10:47 -080060 * href="{@docRoot}studio/profile/traceview.html">Inspect Trace Logs with
61 * Traceview</a> for information about reading trace files. To start logging
62 * trace files, call one of the startMethodTracing() methods. To stop tracing,
63 * call {@link #stopMethodTracing()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080064 */
65public final class Debug
66{
Dan Egnor3eda9792010-03-05 13:28:36 -080067 private static final String TAG = "Debug";
68
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080069 /**
70 * Flags for startMethodTracing(). These can be ORed together.
71 *
72 * TRACE_COUNT_ALLOCS adds the results from startAllocCounting to the
73 * trace key file.
Hiroshi Yamauchi172da262015-03-04 12:29:19 -080074 *
75 * @deprecated Accurate counting is a burden on the runtime and may be removed.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080076 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -080077 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080078 public static final int TRACE_COUNT_ALLOCS = VMDebug.TRACE_COUNT_ALLOCS;
79
80 /**
81 * Flags for printLoadedClasses(). Default behavior is to only show
82 * the class name.
83 */
84 public static final int SHOW_FULL_DETAIL = 1;
85 public static final int SHOW_CLASSLOADER = (1 << 1);
86 public static final int SHOW_INITIALIZED = (1 << 2);
87
88 // set/cleared by waitForDebugger()
89 private static volatile boolean mWaiting = false;
90
Andrei Onea24ec3212019-03-15 17:35:05 +000091 @UnsupportedAppUsage
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080092 private Debug() {}
93
94 /*
95 * How long to wait for the debugger to finish sending requests. I've
96 * seen this hit 800msec on the device while waiting for a response
97 * to travel over USB and get processed, so we take that and add
98 * half a second.
99 */
100 private static final int MIN_DEBUGGER_IDLE = 1300; // msec
101
102 /* how long to sleep when polling for activity */
103 private static final int SPIN_DELAY = 200; // msec
104
105 /**
106 * Default trace file path and file
107 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800108 private static final String DEFAULT_TRACE_BODY = "dmtrace";
109 private static final String DEFAULT_TRACE_EXTENSION = ".trace";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800110
111 /**
112 * This class is used to retrieved various statistics about the memory mappings for this
justinmuller64551382013-10-16 22:06:55 -0600113 * process. The returned info is broken down by dalvik, native, and other. All results are in kB.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800114 */
Dianne Hackborn3025ef32009-08-31 21:31:47 -0700115 public static class MemoryInfo implements Parcelable {
Dianne Hackborn64770d12013-05-23 17:51:19 -0700116 /** The proportional set size for dalvik heap. (Doesn't include other Dalvik overhead.) */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800117 public int dalvikPss;
Dianne Hackborn64770d12013-05-23 17:51:19 -0700118 /** The proportional set size that is swappable for dalvik heap. */
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700119 /** @hide We may want to expose this, eventually. */
Andrei Onea24ec3212019-03-15 17:35:05 +0000120 @UnsupportedAppUsage
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700121 public int dalvikSwappablePss;
Dianne Hackborne17b4452018-01-10 13:15:40 -0800122 /** @hide The resident set size for dalvik heap. (Without other Dalvik overhead.) */
Andrei Onea24ec3212019-03-15 17:35:05 +0000123 @UnsupportedAppUsage
Dianne Hackborne17b4452018-01-10 13:15:40 -0800124 public int dalvikRss;
Dianne Hackborn64770d12013-05-23 17:51:19 -0700125 /** The private dirty pages used by dalvik heap. */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800126 public int dalvikPrivateDirty;
Dianne Hackborn64770d12013-05-23 17:51:19 -0700127 /** The shared dirty pages used by dalvik heap. */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800128 public int dalvikSharedDirty;
Dianne Hackborn64770d12013-05-23 17:51:19 -0700129 /** The private clean pages used by dalvik heap. */
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700130 /** @hide We may want to expose this, eventually. */
Andrei Onea24ec3212019-03-15 17:35:05 +0000131 @UnsupportedAppUsage
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700132 public int dalvikPrivateClean;
Dianne Hackborn64770d12013-05-23 17:51:19 -0700133 /** The shared clean pages used by dalvik heap. */
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700134 /** @hide We may want to expose this, eventually. */
Andrei Onea24ec3212019-03-15 17:35:05 +0000135 @UnsupportedAppUsage
Anwar Ghuloum3a8ce1b2013-04-26 16:18:28 -0700136 public int dalvikSharedClean;
Dianne Hackborn8883ced2013-10-02 16:58:06 -0700137 /** The dirty dalvik pages that have been swapped out. */
138 /** @hide We may want to expose this, eventually. */
Andrei Onea24ec3212019-03-15 17:35:05 +0000139 @UnsupportedAppUsage
Dianne Hackborn8883ced2013-10-02 16:58:06 -0700140 public int dalvikSwappedOut;
Martijn Coenene0764852016-01-07 17:04:22 -0800141 /** The dirty dalvik pages that have been swapped out, proportional. */
142 /** @hide We may want to expose this, eventually. */
Andrei Onea24ec3212019-03-15 17:35:05 +0000143 @UnsupportedAppUsage
Martijn Coenene0764852016-01-07 17:04:22 -0800144 public int dalvikSwappedOutPss;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800145
146 /** The proportional set size for the native heap. */
147 public int nativePss;
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700148 /** The proportional set size that is swappable for the native heap. */
149 /** @hide We may want to expose this, eventually. */
Andrei Onea24ec3212019-03-15 17:35:05 +0000150 @UnsupportedAppUsage
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700151 public int nativeSwappablePss;
Dianne Hackborne17b4452018-01-10 13:15:40 -0800152 /** @hide The resident set size for the native heap. */
Andrei Onea24ec3212019-03-15 17:35:05 +0000153 @UnsupportedAppUsage
Dianne Hackborne17b4452018-01-10 13:15:40 -0800154 public int nativeRss;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800155 /** The private dirty pages used by the native heap. */
156 public int nativePrivateDirty;
157 /** The shared dirty pages used by the native heap. */
158 public int nativeSharedDirty;
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700159 /** The private clean pages used by the native heap. */
160 /** @hide We may want to expose this, eventually. */
Andrei Onea24ec3212019-03-15 17:35:05 +0000161 @UnsupportedAppUsage
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700162 public int nativePrivateClean;
Anwar Ghuloum3a8ce1b2013-04-26 16:18:28 -0700163 /** The shared clean pages used by the native heap. */
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700164 /** @hide We may want to expose this, eventually. */
Andrei Onea24ec3212019-03-15 17:35:05 +0000165 @UnsupportedAppUsage
Anwar Ghuloum3a8ce1b2013-04-26 16:18:28 -0700166 public int nativeSharedClean;
Dianne Hackborn8883ced2013-10-02 16:58:06 -0700167 /** The dirty native pages that have been swapped out. */
168 /** @hide We may want to expose this, eventually. */
Andrei Onea24ec3212019-03-15 17:35:05 +0000169 @UnsupportedAppUsage
Dianne Hackborn8883ced2013-10-02 16:58:06 -0700170 public int nativeSwappedOut;
Martijn Coenene0764852016-01-07 17:04:22 -0800171 /** The dirty native pages that have been swapped out, proportional. */
172 /** @hide We may want to expose this, eventually. */
Andrei Onea24ec3212019-03-15 17:35:05 +0000173 @UnsupportedAppUsage
Martijn Coenene0764852016-01-07 17:04:22 -0800174 public int nativeSwappedOutPss;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800175
176 /** The proportional set size for everything else. */
177 public int otherPss;
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700178 /** The proportional set size that is swappable for everything else. */
179 /** @hide We may want to expose this, eventually. */
Andrei Onea24ec3212019-03-15 17:35:05 +0000180 @UnsupportedAppUsage
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700181 public int otherSwappablePss;
Dianne Hackborne17b4452018-01-10 13:15:40 -0800182 /** @hide The resident set size for everything else. */
Andrei Onea24ec3212019-03-15 17:35:05 +0000183 @UnsupportedAppUsage
Dianne Hackborne17b4452018-01-10 13:15:40 -0800184 public int otherRss;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800185 /** The private dirty pages used by everything else. */
186 public int otherPrivateDirty;
187 /** The shared dirty pages used by everything else. */
188 public int otherSharedDirty;
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700189 /** The private clean pages used by everything else. */
190 /** @hide We may want to expose this, eventually. */
Andrei Onea24ec3212019-03-15 17:35:05 +0000191 @UnsupportedAppUsage
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700192 public int otherPrivateClean;
Anwar Ghuloum3a8ce1b2013-04-26 16:18:28 -0700193 /** The shared clean pages used by everything else. */
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700194 /** @hide We may want to expose this, eventually. */
Andrei Onea24ec3212019-03-15 17:35:05 +0000195 @UnsupportedAppUsage
Anwar Ghuloum3a8ce1b2013-04-26 16:18:28 -0700196 public int otherSharedClean;
Dianne Hackborn8883ced2013-10-02 16:58:06 -0700197 /** The dirty pages used by anyting else that have been swapped out. */
198 /** @hide We may want to expose this, eventually. */
Andrei Onea24ec3212019-03-15 17:35:05 +0000199 @UnsupportedAppUsage
Dianne Hackborn8883ced2013-10-02 16:58:06 -0700200 public int otherSwappedOut;
Martijn Coenene0764852016-01-07 17:04:22 -0800201 /** The dirty pages used by anyting else that have been swapped out, proportional. */
202 /** @hide We may want to expose this, eventually. */
Andrei Onea24ec3212019-03-15 17:35:05 +0000203 @UnsupportedAppUsage
Martijn Coenene0764852016-01-07 17:04:22 -0800204 public int otherSwappedOutPss;
205
206 /** Whether the kernel reports proportional swap usage */
207 /** @hide */
Andrei Onea24ec3212019-03-15 17:35:05 +0000208 @UnsupportedAppUsage
Martijn Coenene0764852016-01-07 17:04:22 -0800209 public boolean hasSwappedOutPss;
Christian Mehlmauer798e2d32010-06-17 18:24:07 +0200210
Dianne Hackborn0e3328f2011-07-17 13:31:17 -0700211 /** @hide */
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700212 public static final int HEAP_UNKNOWN = 0;
213 /** @hide */
214 public static final int HEAP_DALVIK = 1;
215 /** @hide */
216 public static final int HEAP_NATIVE = 2;
217
218 /** @hide */
219 public static final int OTHER_DALVIK_OTHER = 0;
220 /** @hide */
221 public static final int OTHER_STACK = 1;
222 /** @hide */
223 public static final int OTHER_CURSOR = 2;
224 /** @hide */
225 public static final int OTHER_ASHMEM = 3;
226 /** @hide */
227 public static final int OTHER_GL_DEV = 4;
228 /** @hide */
229 public static final int OTHER_UNKNOWN_DEV = 5;
230 /** @hide */
231 public static final int OTHER_SO = 6;
232 /** @hide */
233 public static final int OTHER_JAR = 7;
234 /** @hide */
235 public static final int OTHER_APK = 8;
236 /** @hide */
237 public static final int OTHER_TTF = 9;
238 /** @hide */
239 public static final int OTHER_DEX = 10;
240 /** @hide */
241 public static final int OTHER_OAT = 11;
242 /** @hide */
243 public static final int OTHER_ART = 12;
244 /** @hide */
245 public static final int OTHER_UNKNOWN_MAP = 13;
246 /** @hide */
247 public static final int OTHER_GRAPHICS = 14;
248 /** @hide */
249 public static final int OTHER_GL = 15;
250 /** @hide */
251 public static final int OTHER_OTHER_MEMTRACK = 16;
252
Mathieu Chartier95550dd2017-07-13 15:01:34 -0700253 // Needs to be declared here for the DVK_STAT ranges below.
254 /** @hide */
Andrei Onea24ec3212019-03-15 17:35:05 +0000255 @UnsupportedAppUsage
Mathieu Chartier95550dd2017-07-13 15:01:34 -0700256 public static final int NUM_OTHER_STATS = 17;
257
258 // Dalvik subsections.
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700259 /** @hide */
260 public static final int OTHER_DALVIK_NORMAL = 17;
261 /** @hide */
262 public static final int OTHER_DALVIK_LARGE = 18;
263 /** @hide */
Mathieu Chartier95550dd2017-07-13 15:01:34 -0700264 public static final int OTHER_DALVIK_ZYGOTE = 19;
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700265 /** @hide */
Mathieu Chartier95550dd2017-07-13 15:01:34 -0700266 public static final int OTHER_DALVIK_NON_MOVING = 20;
267 // Section begins and ends for dumpsys, relative to the DALVIK categories.
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700268 /** @hide */
Mathieu Chartier95550dd2017-07-13 15:01:34 -0700269 public static final int OTHER_DVK_STAT_DALVIK_START =
270 OTHER_DALVIK_NORMAL - NUM_OTHER_STATS;
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700271 /** @hide */
Mathieu Chartier95550dd2017-07-13 15:01:34 -0700272 public static final int OTHER_DVK_STAT_DALVIK_END =
273 OTHER_DALVIK_NON_MOVING - NUM_OTHER_STATS;
274
275 // Dalvik Other subsections.
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700276 /** @hide */
Mathieu Chartier95550dd2017-07-13 15:01:34 -0700277 public static final int OTHER_DALVIK_OTHER_LINEARALLOC = 21;
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700278 /** @hide */
Mathieu Chartier95550dd2017-07-13 15:01:34 -0700279 public static final int OTHER_DALVIK_OTHER_ACCOUNTING = 22;
280 /** @hide */
Nicolas Geoffray0567cd42019-10-02 21:11:43 +0100281 public static final int OTHER_DALVIK_OTHER_ZYGOTE_CODE_CACHE = 23;
Mathieu Chartier95550dd2017-07-13 15:01:34 -0700282 /** @hide */
Nicolas Geoffray0567cd42019-10-02 21:11:43 +0100283 public static final int OTHER_DALVIK_OTHER_APP_CODE_CACHE = 24;
Mathieu Chartier95550dd2017-07-13 15:01:34 -0700284 /** @hide */
Nicolas Geoffray0567cd42019-10-02 21:11:43 +0100285 public static final int OTHER_DALVIK_OTHER_COMPILER_METADATA = 25;
286 /** @hide */
287 public static final int OTHER_DALVIK_OTHER_INDIRECT_REFERENCE_TABLE = 26;
Mathieu Chartier95550dd2017-07-13 15:01:34 -0700288 /** @hide */
289 public static final int OTHER_DVK_STAT_DALVIK_OTHER_START =
290 OTHER_DALVIK_OTHER_LINEARALLOC - NUM_OTHER_STATS;
291 /** @hide */
292 public static final int OTHER_DVK_STAT_DALVIK_OTHER_END =
293 OTHER_DALVIK_OTHER_INDIRECT_REFERENCE_TABLE - NUM_OTHER_STATS;
294
295 // Dex subsections (Boot vdex, App dex, and App vdex).
296 /** @hide */
Nicolas Geoffray0567cd42019-10-02 21:11:43 +0100297 public static final int OTHER_DEX_BOOT_VDEX = 27;
Mathieu Chartier95550dd2017-07-13 15:01:34 -0700298 /** @hide */
Nicolas Geoffray0567cd42019-10-02 21:11:43 +0100299 public static final int OTHER_DEX_APP_DEX = 28;
Mathieu Chartier95550dd2017-07-13 15:01:34 -0700300 /** @hide */
Nicolas Geoffray0567cd42019-10-02 21:11:43 +0100301 public static final int OTHER_DEX_APP_VDEX = 29;
Mathieu Chartier95550dd2017-07-13 15:01:34 -0700302 /** @hide */
303 public static final int OTHER_DVK_STAT_DEX_START = OTHER_DEX_BOOT_VDEX - NUM_OTHER_STATS;
304 /** @hide */
305 public static final int OTHER_DVK_STAT_DEX_END = OTHER_DEX_APP_VDEX - NUM_OTHER_STATS;
306
307 // Art subsections (App image, boot image).
308 /** @hide */
Nicolas Geoffray0567cd42019-10-02 21:11:43 +0100309 public static final int OTHER_ART_APP = 30;
Mathieu Chartier95550dd2017-07-13 15:01:34 -0700310 /** @hide */
Nicolas Geoffray0567cd42019-10-02 21:11:43 +0100311 public static final int OTHER_ART_BOOT = 31;
Mathieu Chartier95550dd2017-07-13 15:01:34 -0700312 /** @hide */
313 public static final int OTHER_DVK_STAT_ART_START = OTHER_ART_APP - NUM_OTHER_STATS;
314 /** @hide */
315 public static final int OTHER_DVK_STAT_ART_END = OTHER_ART_BOOT - NUM_OTHER_STATS;
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700316
317 /** @hide */
Andrei Onea24ec3212019-03-15 17:35:05 +0000318 @UnsupportedAppUsage
Nicolas Geoffray0567cd42019-10-02 21:11:43 +0100319 public static final int NUM_DVK_STATS = OTHER_ART_BOOT + 1 - OTHER_DALVIK_NORMAL;
Anwar Ghuloum3a8ce1b2013-04-26 16:18:28 -0700320
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700321 /** @hide */
Dianne Hackborne17b4452018-01-10 13:15:40 -0800322 public static final int NUM_CATEGORIES = 9;
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700323
324 /** @hide */
Dianne Hackborne17b4452018-01-10 13:15:40 -0800325 public static final int OFFSET_PSS = 0;
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700326 /** @hide */
Dianne Hackborne17b4452018-01-10 13:15:40 -0800327 public static final int OFFSET_SWAPPABLE_PSS = 1;
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700328 /** @hide */
Dianne Hackborne17b4452018-01-10 13:15:40 -0800329 public static final int OFFSET_RSS = 2;
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700330 /** @hide */
Dianne Hackborne17b4452018-01-10 13:15:40 -0800331 public static final int OFFSET_PRIVATE_DIRTY = 3;
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700332 /** @hide */
Dianne Hackborne17b4452018-01-10 13:15:40 -0800333 public static final int OFFSET_SHARED_DIRTY = 4;
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700334 /** @hide */
Dianne Hackborne17b4452018-01-10 13:15:40 -0800335 public static final int OFFSET_PRIVATE_CLEAN = 5;
Dianne Hackborn8883ced2013-10-02 16:58:06 -0700336 /** @hide */
Dianne Hackborne17b4452018-01-10 13:15:40 -0800337 public static final int OFFSET_SHARED_CLEAN = 6;
Martijn Coenene0764852016-01-07 17:04:22 -0800338 /** @hide */
Dianne Hackborne17b4452018-01-10 13:15:40 -0800339 public static final int OFFSET_SWAPPED_OUT = 7;
340 /** @hide */
341 public static final int OFFSET_SWAPPED_OUT_PSS = 8;
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700342
Andrei Onea24ec3212019-03-15 17:35:05 +0000343 @UnsupportedAppUsage
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700344 private int[] otherStats = new int[(NUM_OTHER_STATS+NUM_DVK_STATS)*NUM_CATEGORIES];
Dianne Hackborn0e3328f2011-07-17 13:31:17 -0700345
Dianne Hackborn3025ef32009-08-31 21:31:47 -0700346 public MemoryInfo() {
347 }
348
Dianne Hackborn4f21c4c2009-09-17 10:24:05 -0700349 /**
Dianne Hackborn8c76d912018-08-23 15:20:05 -0700350 * @hide Copy contents from another object.
351 */
352 public void set(MemoryInfo other) {
353 dalvikPss = other.dalvikPss;
354 dalvikSwappablePss = other.dalvikSwappablePss;
355 dalvikRss = other.dalvikRss;
356 dalvikPrivateDirty = other.dalvikPrivateDirty;
357 dalvikSharedDirty = other.dalvikSharedDirty;
358 dalvikPrivateClean = other.dalvikPrivateClean;
359 dalvikSharedClean = other.dalvikSharedClean;
360 dalvikSwappedOut = other.dalvikSwappedOut;
361 dalvikSwappedOutPss = other.dalvikSwappedOutPss;
362
363 nativePss = other.nativePss;
364 nativeSwappablePss = other.nativeSwappablePss;
365 nativeRss = other.nativeRss;
366 nativePrivateDirty = other.nativePrivateDirty;
367 nativeSharedDirty = other.nativeSharedDirty;
368 nativePrivateClean = other.nativePrivateClean;
369 nativeSharedClean = other.nativeSharedClean;
370 nativeSwappedOut = other.nativeSwappedOut;
371 nativeSwappedOutPss = other.nativeSwappedOutPss;
372
373 otherPss = other.otherPss;
374 otherSwappablePss = other.otherSwappablePss;
375 otherRss = other.otherRss;
376 otherPrivateDirty = other.otherPrivateDirty;
377 otherSharedDirty = other.otherSharedDirty;
378 otherPrivateClean = other.otherPrivateClean;
379 otherSharedClean = other.otherSharedClean;
380 otherSwappedOut = other.otherSwappedOut;
381 otherSwappedOutPss = other.otherSwappedOutPss;
382
383 hasSwappedOutPss = other.hasSwappedOutPss;
384
385 System.arraycopy(other.otherStats, 0, otherStats, 0, otherStats.length);
386 }
387
388 /**
Dianne Hackborn4f21c4c2009-09-17 10:24:05 -0700389 * Return total PSS memory usage in kB.
390 */
391 public int getTotalPss() {
Martijn Coenene0764852016-01-07 17:04:22 -0800392 return dalvikPss + nativePss + otherPss + getTotalSwappedOutPss();
Dianne Hackborn4f21c4c2009-09-17 10:24:05 -0700393 }
Christian Mehlmauer798e2d32010-06-17 18:24:07 +0200394
Dianne Hackbornc8230512013-07-13 21:32:12 -0700395 /**
396 * @hide Return total PSS memory usage in kB.
397 */
Andrei Onea24ec3212019-03-15 17:35:05 +0000398 @UnsupportedAppUsage
Dianne Hackbornc8230512013-07-13 21:32:12 -0700399 public int getTotalUss() {
400 return dalvikPrivateClean + dalvikPrivateDirty
401 + nativePrivateClean + nativePrivateDirty
402 + otherPrivateClean + otherPrivateDirty;
403 }
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700404
405 /**
Martijn Coenene0764852016-01-07 17:04:22 -0800406 * Return total PSS memory usage in kB mapping a file of one of the following extension:
407 * .so, .jar, .apk, .ttf, .dex, .odex, .oat, .art .
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700408 */
409 public int getTotalSwappablePss() {
410 return dalvikSwappablePss + nativeSwappablePss + otherSwappablePss;
411 }
412
Dianne Hackborn4f21c4c2009-09-17 10:24:05 -0700413 /**
Dianne Hackborne17b4452018-01-10 13:15:40 -0800414 * @hide Return total RSS memory usage in kB.
415 */
416 public int getTotalRss() {
417 return dalvikRss + nativeRss + otherRss;
418 }
419
420 /**
Dianne Hackborn4f21c4c2009-09-17 10:24:05 -0700421 * Return total private dirty memory usage in kB.
422 */
423 public int getTotalPrivateDirty() {
424 return dalvikPrivateDirty + nativePrivateDirty + otherPrivateDirty;
425 }
Christian Mehlmauer798e2d32010-06-17 18:24:07 +0200426
Dianne Hackborn4f21c4c2009-09-17 10:24:05 -0700427 /**
428 * Return total shared dirty memory usage in kB.
429 */
430 public int getTotalSharedDirty() {
431 return dalvikSharedDirty + nativeSharedDirty + otherSharedDirty;
432 }
Christian Mehlmauer798e2d32010-06-17 18:24:07 +0200433
Anwar Ghuloum3a8ce1b2013-04-26 16:18:28 -0700434 /**
435 * Return total shared clean memory usage in kB.
436 */
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700437 public int getTotalPrivateClean() {
438 return dalvikPrivateClean + nativePrivateClean + otherPrivateClean;
439 }
440
441 /**
442 * Return total shared clean memory usage in kB.
443 */
Anwar Ghuloum3a8ce1b2013-04-26 16:18:28 -0700444 public int getTotalSharedClean() {
445 return dalvikSharedClean + nativeSharedClean + otherSharedClean;
446 }
447
Dianne Hackborn8883ced2013-10-02 16:58:06 -0700448 /**
449 * Return total swapped out memory in kB.
450 * @hide
451 */
452 public int getTotalSwappedOut() {
453 return dalvikSwappedOut + nativeSwappedOut + otherSwappedOut;
454 }
455
Martijn Coenene0764852016-01-07 17:04:22 -0800456 /**
457 * Return total swapped out memory in kB, proportional.
458 * @hide
459 */
460 public int getTotalSwappedOutPss() {
461 return dalvikSwappedOutPss + nativeSwappedOutPss + otherSwappedOutPss;
462 }
463
Dianne Hackborn3fa89692013-09-13 17:20:00 -0700464 /** @hide */
Andrei Onea24ec3212019-03-15 17:35:05 +0000465 @UnsupportedAppUsage
Dianne Hackborn0e3328f2011-07-17 13:31:17 -0700466 public int getOtherPss(int which) {
Dianne Hackborne17b4452018-01-10 13:15:40 -0800467 return otherStats[which * NUM_CATEGORIES + OFFSET_PSS];
Dianne Hackborn0e3328f2011-07-17 13:31:17 -0700468 }
469
Dianne Hackborn3fa89692013-09-13 17:20:00 -0700470 /** @hide */
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700471 public int getOtherSwappablePss(int which) {
Dianne Hackborne17b4452018-01-10 13:15:40 -0800472 return otherStats[which * NUM_CATEGORIES + OFFSET_SWAPPABLE_PSS];
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700473 }
474
Dianne Hackborne17b4452018-01-10 13:15:40 -0800475 /** @hide */
476 public int getOtherRss(int which) {
477 return otherStats[which * NUM_CATEGORIES + OFFSET_RSS];
478 }
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700479
Dianne Hackborn3fa89692013-09-13 17:20:00 -0700480 /** @hide */
Andrei Onea24ec3212019-03-15 17:35:05 +0000481 @UnsupportedAppUsage
Dianne Hackborn0e3328f2011-07-17 13:31:17 -0700482 public int getOtherPrivateDirty(int which) {
Dianne Hackborne17b4452018-01-10 13:15:40 -0800483 return otherStats[which * NUM_CATEGORIES + OFFSET_PRIVATE_DIRTY];
Dianne Hackborn0e3328f2011-07-17 13:31:17 -0700484 }
485
Dianne Hackborn3fa89692013-09-13 17:20:00 -0700486 /** @hide */
Andrei Onea24ec3212019-03-15 17:35:05 +0000487 @UnsupportedAppUsage
Dianne Hackborn0e3328f2011-07-17 13:31:17 -0700488 public int getOtherSharedDirty(int which) {
Dianne Hackborne17b4452018-01-10 13:15:40 -0800489 return otherStats[which * NUM_CATEGORIES + OFFSET_SHARED_DIRTY];
Dianne Hackborn0e3328f2011-07-17 13:31:17 -0700490 }
491
Dianne Hackborn3fa89692013-09-13 17:20:00 -0700492 /** @hide */
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700493 public int getOtherPrivateClean(int which) {
Dianne Hackborne17b4452018-01-10 13:15:40 -0800494 return otherStats[which * NUM_CATEGORIES + OFFSET_PRIVATE_CLEAN];
Anwar Ghuloum3a8ce1b2013-04-26 16:18:28 -0700495 }
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700496
Dianne Hackborn3fa89692013-09-13 17:20:00 -0700497 /** @hide */
Andrei Onea24ec3212019-03-15 17:35:05 +0000498 @UnsupportedAppUsage
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700499 public int getOtherPrivate(int which) {
500 return getOtherPrivateClean(which) + getOtherPrivateDirty(which);
501 }
502
503 /** @hide */
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700504 public int getOtherSharedClean(int which) {
Dianne Hackborne17b4452018-01-10 13:15:40 -0800505 return otherStats[which * NUM_CATEGORIES + OFFSET_SHARED_CLEAN];
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700506 }
507
Dianne Hackborn3fa89692013-09-13 17:20:00 -0700508 /** @hide */
Dianne Hackborn8883ced2013-10-02 16:58:06 -0700509 public int getOtherSwappedOut(int which) {
Dianne Hackborne17b4452018-01-10 13:15:40 -0800510 return otherStats[which * NUM_CATEGORIES + OFFSET_SWAPPED_OUT];
Dianne Hackborn8883ced2013-10-02 16:58:06 -0700511 }
512
513 /** @hide */
Martijn Coenene0764852016-01-07 17:04:22 -0800514 public int getOtherSwappedOutPss(int which) {
Dianne Hackborne17b4452018-01-10 13:15:40 -0800515 return otherStats[which * NUM_CATEGORIES + OFFSET_SWAPPED_OUT_PSS];
Martijn Coenene0764852016-01-07 17:04:22 -0800516 }
517
518 /** @hide */
Andrei Onea24ec3212019-03-15 17:35:05 +0000519 @UnsupportedAppUsage
Dianne Hackborn0e3328f2011-07-17 13:31:17 -0700520 public static String getOtherLabel(int which) {
521 switch (which) {
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700522 case OTHER_DALVIK_OTHER: return "Dalvik Other";
523 case OTHER_STACK: return "Stack";
524 case OTHER_CURSOR: return "Cursor";
525 case OTHER_ASHMEM: return "Ashmem";
526 case OTHER_GL_DEV: return "Gfx dev";
527 case OTHER_UNKNOWN_DEV: return "Other dev";
528 case OTHER_SO: return ".so mmap";
529 case OTHER_JAR: return ".jar mmap";
530 case OTHER_APK: return ".apk mmap";
531 case OTHER_TTF: return ".ttf mmap";
532 case OTHER_DEX: return ".dex mmap";
533 case OTHER_OAT: return ".oat mmap";
534 case OTHER_ART: return ".art mmap";
535 case OTHER_UNKNOWN_MAP: return "Other mmap";
536 case OTHER_GRAPHICS: return "EGL mtrack";
537 case OTHER_GL: return "GL mtrack";
538 case OTHER_OTHER_MEMTRACK: return "Other mtrack";
539 case OTHER_DALVIK_NORMAL: return ".Heap";
540 case OTHER_DALVIK_LARGE: return ".LOS";
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700541 case OTHER_DALVIK_ZYGOTE: return ".Zygote";
542 case OTHER_DALVIK_NON_MOVING: return ".NonMoving";
Mathieu Chartier95550dd2017-07-13 15:01:34 -0700543 case OTHER_DALVIK_OTHER_LINEARALLOC: return ".LinearAlloc";
544 case OTHER_DALVIK_OTHER_ACCOUNTING: return ".GC";
Nicolas Geoffray0567cd42019-10-02 21:11:43 +0100545 case OTHER_DALVIK_OTHER_ZYGOTE_CODE_CACHE: return ".ZygoteJIT";
546 case OTHER_DALVIK_OTHER_APP_CODE_CACHE: return ".AppJIT";
Mathieu Chartier95550dd2017-07-13 15:01:34 -0700547 case OTHER_DALVIK_OTHER_COMPILER_METADATA: return ".CompilerMetadata";
548 case OTHER_DALVIK_OTHER_INDIRECT_REFERENCE_TABLE: return ".IndirectRef";
549 case OTHER_DEX_BOOT_VDEX: return ".Boot vdex";
550 case OTHER_DEX_APP_DEX: return ".App dex";
551 case OTHER_DEX_APP_VDEX: return ".App vdex";
552 case OTHER_ART_APP: return ".App art";
553 case OTHER_ART_BOOT: return ".Boot art";
Dianne Hackborn0e3328f2011-07-17 13:31:17 -0700554 default: return "????";
555 }
556 }
557
Richard Uhler350e6dc2015-05-18 10:48:52 -0700558 /**
559 * Returns the value of a particular memory statistic or {@code null} if no
560 * such memory statistic exists.
561 *
562 * <p>The following table lists the memory statistics that are supported.
563 * Note that memory statistics may be added or removed in a future API level.</p>
564 *
565 * <table>
566 * <thead>
567 * <tr>
568 * <th>Memory statistic name</th>
569 * <th>Meaning</th>
570 * <th>Example</th>
571 * <th>Supported (API Levels)</th>
572 * </tr>
573 * </thead>
574 * <tbody>
575 * <tr>
576 * <td>summary.java-heap</td>
577 * <td>The private Java Heap usage in kB. This corresponds to the Java Heap field
578 * in the App Summary section output by dumpsys meminfo.</td>
579 * <td>{@code 1442}</td>
580 * <td>23</td>
581 * </tr>
582 * <tr>
583 * <td>summary.native-heap</td>
584 * <td>The private Native Heap usage in kB. This corresponds to the Native Heap
585 * field in the App Summary section output by dumpsys meminfo.</td>
586 * <td>{@code 1442}</td>
587 * <td>23</td>
588 * </tr>
589 * <tr>
590 * <td>summary.code</td>
591 * <td>The memory usage for static code and resources in kB. This corresponds to
592 * the Code field in the App Summary section output by dumpsys meminfo.</td>
593 * <td>{@code 1442}</td>
594 * <td>23</td>
595 * </tr>
596 * <tr>
597 * <td>summary.stack</td>
598 * <td>The stack usage in kB. This corresponds to the Stack field in the
599 * App Summary section output by dumpsys meminfo.</td>
600 * <td>{@code 1442}</td>
601 * <td>23</td>
602 * </tr>
603 * <tr>
604 * <td>summary.graphics</td>
605 * <td>The graphics usage in kB. This corresponds to the Graphics field in the
606 * App Summary section output by dumpsys meminfo.</td>
607 * <td>{@code 1442}</td>
608 * <td>23</td>
609 * </tr>
610 * <tr>
611 * <td>summary.private-other</td>
612 * <td>Other private memory usage in kB. This corresponds to the Private Other
613 * field output in the App Summary section by dumpsys meminfo.</td>
614 * <td>{@code 1442}</td>
615 * <td>23</td>
616 * </tr>
617 * <tr>
618 * <td>summary.system</td>
619 * <td>Shared and system memory usage in kB. This corresponds to the System
620 * field output in the App Summary section by dumpsys meminfo.</td>
621 * <td>{@code 1442}</td>
622 * <td>23</td>
623 * </tr>
624 * <tr>
625 * <td>summary.total-pss</td>
626 * <td>Total PPS memory usage in kB.</td>
627 * <td>{@code 1442}</td>
628 * <td>23</td>
629 * </tr>
630 * <tr>
631 * <td>summary.total-swap</td>
632 * <td>Total swap usage in kB.</td>
633 * <td>{@code 1442}</td>
634 * <td>23</td>
635 * </tr>
636 * </tbody>
637 * </table>
638 */
Dianne Hackbornb02ce292015-10-12 15:14:16 -0700639 public String getMemoryStat(String statName) {
Richard Uhler350e6dc2015-05-18 10:48:52 -0700640 switch(statName) {
641 case "summary.java-heap":
642 return Integer.toString(getSummaryJavaHeap());
643 case "summary.native-heap":
644 return Integer.toString(getSummaryNativeHeap());
645 case "summary.code":
646 return Integer.toString(getSummaryCode());
647 case "summary.stack":
648 return Integer.toString(getSummaryStack());
649 case "summary.graphics":
650 return Integer.toString(getSummaryGraphics());
651 case "summary.private-other":
652 return Integer.toString(getSummaryPrivateOther());
653 case "summary.system":
654 return Integer.toString(getSummarySystem());
655 case "summary.total-pss":
656 return Integer.toString(getSummaryTotalPss());
657 case "summary.total-swap":
658 return Integer.toString(getSummaryTotalSwap());
659 default:
660 return null;
661 }
662 }
663
664 /**
665 * Returns a map of the names/values of the memory statistics
666 * that {@link #getMemoryStat(String)} supports.
667 *
668 * @return a map of the names/values of the supported memory statistics.
669 */
670 public Map<String, String> getMemoryStats() {
671 Map<String, String> stats = new HashMap<String, String>();
672 stats.put("summary.java-heap", Integer.toString(getSummaryJavaHeap()));
673 stats.put("summary.native-heap", Integer.toString(getSummaryNativeHeap()));
674 stats.put("summary.code", Integer.toString(getSummaryCode()));
675 stats.put("summary.stack", Integer.toString(getSummaryStack()));
676 stats.put("summary.graphics", Integer.toString(getSummaryGraphics()));
677 stats.put("summary.private-other", Integer.toString(getSummaryPrivateOther()));
678 stats.put("summary.system", Integer.toString(getSummarySystem()));
679 stats.put("summary.total-pss", Integer.toString(getSummaryTotalPss()));
680 stats.put("summary.total-swap", Integer.toString(getSummaryTotalSwap()));
681 return stats;
682 }
683
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700684 /**
685 * Pss of Java Heap bytes in KB due to the application.
686 * Notes:
687 * * OTHER_ART is the boot image. Anything private here is blamed on
688 * the application, not the system.
689 * * dalvikPrivateDirty includes private zygote, which means the
690 * application dirtied something allocated by the zygote. We blame
691 * the application for that memory, not the system.
692 * * Does not include OTHER_DALVIK_OTHER, which is considered VM
693 * Overhead and lumped into Private Other.
694 * * We don't include dalvikPrivateClean, because there should be no
695 * such thing as private clean for the Java Heap.
696 * @hide
697 */
Andrei Onea24ec3212019-03-15 17:35:05 +0000698 @UnsupportedAppUsage
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700699 public int getSummaryJavaHeap() {
700 return dalvikPrivateDirty + getOtherPrivate(OTHER_ART);
701 }
702
703 /**
704 * Pss of Native Heap bytes in KB due to the application.
705 * Notes:
706 * * Includes private dirty malloc space.
707 * * We don't include nativePrivateClean, because there should be no
708 * such thing as private clean for the Native Heap.
709 * @hide
710 */
Andrei Onea24ec3212019-03-15 17:35:05 +0000711 @UnsupportedAppUsage
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700712 public int getSummaryNativeHeap() {
713 return nativePrivateDirty;
714 }
715
716 /**
717 * Pss of code and other static resource bytes in KB due to
718 * the application.
719 * @hide
720 */
Andrei Onea24ec3212019-03-15 17:35:05 +0000721 @UnsupportedAppUsage
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700722 public int getSummaryCode() {
723 return getOtherPrivate(OTHER_SO)
724 + getOtherPrivate(OTHER_JAR)
725 + getOtherPrivate(OTHER_APK)
726 + getOtherPrivate(OTHER_TTF)
727 + getOtherPrivate(OTHER_DEX)
Nicolas Geoffray0567cd42019-10-02 21:11:43 +0100728 + getOtherPrivate(OTHER_OAT)
729 + getOtherPrivate(OTHER_DALVIK_OTHER_ZYGOTE_CODE_CACHE)
730 + getOtherPrivate(OTHER_DALVIK_OTHER_APP_CODE_CACHE);
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700731 }
732
733 /**
734 * Pss in KB of the stack due to the application.
735 * Notes:
736 * * Includes private dirty stack, which includes both Java and Native
737 * stack.
738 * * Does not include private clean stack, because there should be no
739 * such thing as private clean for the stack.
740 * @hide
741 */
Andrei Onea24ec3212019-03-15 17:35:05 +0000742 @UnsupportedAppUsage
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700743 public int getSummaryStack() {
744 return getOtherPrivateDirty(OTHER_STACK);
745 }
746
747 /**
748 * Pss in KB of graphics due to the application.
749 * Notes:
750 * * Includes private Gfx, EGL, and GL.
751 * * Warning: These numbers can be misreported by the graphics drivers.
752 * * We don't include shared graphics. It may make sense to, because
753 * shared graphics are likely buffers due to the application
754 * anyway, but it's simpler to implement to just group all shared
755 * memory into the System category.
756 * @hide
757 */
Andrei Onea24ec3212019-03-15 17:35:05 +0000758 @UnsupportedAppUsage
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700759 public int getSummaryGraphics() {
760 return getOtherPrivate(OTHER_GL_DEV)
761 + getOtherPrivate(OTHER_GRAPHICS)
762 + getOtherPrivate(OTHER_GL);
763 }
764
765 /**
766 * Pss in KB due to the application that haven't otherwise been
767 * accounted for.
768 * @hide
769 */
Andrei Onea24ec3212019-03-15 17:35:05 +0000770 @UnsupportedAppUsage
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700771 public int getSummaryPrivateOther() {
772 return getTotalPrivateClean()
773 + getTotalPrivateDirty()
774 - getSummaryJavaHeap()
775 - getSummaryNativeHeap()
776 - getSummaryCode()
777 - getSummaryStack()
778 - getSummaryGraphics();
779 }
780
781 /**
782 * Pss in KB due to the system.
783 * Notes:
784 * * Includes all shared memory.
785 * @hide
786 */
Andrei Onea24ec3212019-03-15 17:35:05 +0000787 @UnsupportedAppUsage
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700788 public int getSummarySystem() {
789 return getTotalPss()
790 - getTotalPrivateClean()
791 - getTotalPrivateDirty();
792 }
793
794 /**
795 * Total Pss in KB.
796 * @hide
797 */
798 public int getSummaryTotalPss() {
799 return getTotalPss();
800 }
801
802 /**
803 * Total Swap in KB.
804 * Notes:
805 * * Some of this memory belongs in other categories, but we don't
806 * know if the Swap memory is shared or private, so we don't know
807 * what to blame on the application and what on the system.
808 * For now, just lump all the Swap in one place.
Martijn Coenene0764852016-01-07 17:04:22 -0800809 * For kernels reporting SwapPss {@link #getSummaryTotalSwapPss()}
810 * will report the application proportional Swap.
Richard Uhlerc14b9cf2015-03-13 12:38:38 -0700811 * @hide
812 */
813 public int getSummaryTotalSwap() {
814 return getTotalSwappedOut();
815 }
816
Martijn Coenene0764852016-01-07 17:04:22 -0800817 /**
818 * Total proportional Swap in KB.
819 * Notes:
820 * * Always 0 if {@link #hasSwappedOutPss} is false.
821 * @hide
822 */
823 public int getSummaryTotalSwapPss() {
824 return getTotalSwappedOutPss();
825 }
826
Dianne Hackbornef0a4022016-05-11 14:21:07 -0700827 /**
828 * Return true if the kernel is reporting pss swapped out... that is, if
829 * {@link #getSummaryTotalSwapPss()} will return non-0 values.
830 * @hide
831 */
832 public boolean hasSwappedOutPss() {
833 return hasSwappedOutPss;
834 }
835
Dianne Hackborn3025ef32009-08-31 21:31:47 -0700836 public int describeContents() {
837 return 0;
838 }
839
840 public void writeToParcel(Parcel dest, int flags) {
841 dest.writeInt(dalvikPss);
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700842 dest.writeInt(dalvikSwappablePss);
Dianne Hackborne17b4452018-01-10 13:15:40 -0800843 dest.writeInt(dalvikRss);
Dianne Hackborn3025ef32009-08-31 21:31:47 -0700844 dest.writeInt(dalvikPrivateDirty);
845 dest.writeInt(dalvikSharedDirty);
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700846 dest.writeInt(dalvikPrivateClean);
Anwar Ghuloum3a8ce1b2013-04-26 16:18:28 -0700847 dest.writeInt(dalvikSharedClean);
Dianne Hackborn8883ced2013-10-02 16:58:06 -0700848 dest.writeInt(dalvikSwappedOut);
Richard Uhler91702eb32017-06-23 16:54:25 +0100849 dest.writeInt(dalvikSwappedOutPss);
Dianne Hackborn3025ef32009-08-31 21:31:47 -0700850 dest.writeInt(nativePss);
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700851 dest.writeInt(nativeSwappablePss);
Dianne Hackborne17b4452018-01-10 13:15:40 -0800852 dest.writeInt(nativeRss);
Dianne Hackborn3025ef32009-08-31 21:31:47 -0700853 dest.writeInt(nativePrivateDirty);
854 dest.writeInt(nativeSharedDirty);
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700855 dest.writeInt(nativePrivateClean);
Anwar Ghuloum3a8ce1b2013-04-26 16:18:28 -0700856 dest.writeInt(nativeSharedClean);
Dianne Hackborn8883ced2013-10-02 16:58:06 -0700857 dest.writeInt(nativeSwappedOut);
Richard Uhler91702eb32017-06-23 16:54:25 +0100858 dest.writeInt(nativeSwappedOutPss);
Dianne Hackborn3025ef32009-08-31 21:31:47 -0700859 dest.writeInt(otherPss);
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700860 dest.writeInt(otherSwappablePss);
Dianne Hackborne17b4452018-01-10 13:15:40 -0800861 dest.writeInt(otherRss);
Dianne Hackborn3025ef32009-08-31 21:31:47 -0700862 dest.writeInt(otherPrivateDirty);
863 dest.writeInt(otherSharedDirty);
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700864 dest.writeInt(otherPrivateClean);
Anwar Ghuloum3a8ce1b2013-04-26 16:18:28 -0700865 dest.writeInt(otherSharedClean);
Dianne Hackborn8883ced2013-10-02 16:58:06 -0700866 dest.writeInt(otherSwappedOut);
Martijn Coenene0764852016-01-07 17:04:22 -0800867 dest.writeInt(hasSwappedOutPss ? 1 : 0);
868 dest.writeInt(otherSwappedOutPss);
Dianne Hackborn0e3328f2011-07-17 13:31:17 -0700869 dest.writeIntArray(otherStats);
Dianne Hackborn3025ef32009-08-31 21:31:47 -0700870 }
871
872 public void readFromParcel(Parcel source) {
873 dalvikPss = source.readInt();
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700874 dalvikSwappablePss = source.readInt();
Dianne Hackborne17b4452018-01-10 13:15:40 -0800875 dalvikRss = source.readInt();
Dianne Hackborn3025ef32009-08-31 21:31:47 -0700876 dalvikPrivateDirty = source.readInt();
877 dalvikSharedDirty = source.readInt();
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700878 dalvikPrivateClean = source.readInt();
Anwar Ghuloum3a8ce1b2013-04-26 16:18:28 -0700879 dalvikSharedClean = source.readInt();
Dianne Hackborn8883ced2013-10-02 16:58:06 -0700880 dalvikSwappedOut = source.readInt();
Richard Uhler91702eb32017-06-23 16:54:25 +0100881 dalvikSwappedOutPss = source.readInt();
Dianne Hackborn3025ef32009-08-31 21:31:47 -0700882 nativePss = source.readInt();
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700883 nativeSwappablePss = source.readInt();
Dianne Hackborne17b4452018-01-10 13:15:40 -0800884 nativeRss = source.readInt();
Dianne Hackborn3025ef32009-08-31 21:31:47 -0700885 nativePrivateDirty = source.readInt();
886 nativeSharedDirty = source.readInt();
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700887 nativePrivateClean = source.readInt();
Anwar Ghuloum3a8ce1b2013-04-26 16:18:28 -0700888 nativeSharedClean = source.readInt();
Dianne Hackborn8883ced2013-10-02 16:58:06 -0700889 nativeSwappedOut = source.readInt();
Richard Uhler91702eb32017-06-23 16:54:25 +0100890 nativeSwappedOutPss = source.readInt();
Dianne Hackborn3025ef32009-08-31 21:31:47 -0700891 otherPss = source.readInt();
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700892 otherSwappablePss = source.readInt();
Dianne Hackborne17b4452018-01-10 13:15:40 -0800893 otherRss = source.readInt();
Dianne Hackborn3025ef32009-08-31 21:31:47 -0700894 otherPrivateDirty = source.readInt();
895 otherSharedDirty = source.readInt();
Anwar Ghuloum3c615062013-05-13 14:18:02 -0700896 otherPrivateClean = source.readInt();
Anwar Ghuloum3a8ce1b2013-04-26 16:18:28 -0700897 otherSharedClean = source.readInt();
Dianne Hackborn8883ced2013-10-02 16:58:06 -0700898 otherSwappedOut = source.readInt();
Martijn Coenene0764852016-01-07 17:04:22 -0800899 hasSwappedOutPss = source.readInt() != 0;
900 otherSwappedOutPss = source.readInt();
Dianne Hackborn0e3328f2011-07-17 13:31:17 -0700901 otherStats = source.createIntArray();
Dianne Hackborn3025ef32009-08-31 21:31:47 -0700902 }
Christian Mehlmauer798e2d32010-06-17 18:24:07 +0200903
Jeff Sharkey9e8f83d2019-02-28 12:06:45 -0700904 public static final @android.annotation.NonNull Creator<MemoryInfo> CREATOR = new Creator<MemoryInfo>() {
Dianne Hackborn3025ef32009-08-31 21:31:47 -0700905 public MemoryInfo createFromParcel(Parcel source) {
906 return new MemoryInfo(source);
907 }
908 public MemoryInfo[] newArray(int size) {
909 return new MemoryInfo[size];
910 }
911 };
912
913 private MemoryInfo(Parcel source) {
914 readFromParcel(source);
915 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800916 }
917
918
919 /**
920 * Wait until a debugger attaches. As soon as the debugger attaches,
921 * this returns, so you will need to place a breakpoint after the
922 * waitForDebugger() call if you want to start tracing immediately.
923 */
924 public static void waitForDebugger() {
925 if (!VMDebug.isDebuggingEnabled()) {
926 //System.out.println("debugging not enabled, not waiting");
927 return;
928 }
929 if (isDebuggerConnected())
930 return;
931
932 // if DDMS is listening, inform them of our plight
933 System.out.println("Sending WAIT chunk");
934 byte[] data = new byte[] { 0 }; // 0 == "waiting for debugger"
935 Chunk waitChunk = new Chunk(ChunkHandler.type("WAIT"), data, 0, 1);
936 DdmServer.sendChunk(waitChunk);
937
938 mWaiting = true;
939 while (!isDebuggerConnected()) {
940 try { Thread.sleep(SPIN_DELAY); }
941 catch (InterruptedException ie) {}
942 }
943 mWaiting = false;
944
945 System.out.println("Debugger has connected");
946
947 /*
948 * There is no "ready to go" signal from the debugger, and we're
949 * not allowed to suspend ourselves -- the debugger expects us to
950 * be running happily, and gets confused if we aren't. We need to
951 * allow the debugger a chance to set breakpoints before we start
952 * running again.
953 *
954 * Sit and spin until the debugger has been idle for a short while.
955 */
956 while (true) {
957 long delta = VMDebug.lastDebuggerActivity();
958 if (delta < 0) {
959 System.out.println("debugger detached?");
960 break;
961 }
962
963 if (delta < MIN_DEBUGGER_IDLE) {
964 System.out.println("waiting for debugger to settle...");
965 try { Thread.sleep(SPIN_DELAY); }
966 catch (InterruptedException ie) {}
967 } else {
968 System.out.println("debugger has settled (" + delta + ")");
969 break;
970 }
971 }
972 }
973
974 /**
975 * Returns "true" if one or more threads is waiting for a debugger
976 * to attach.
977 */
978 public static boolean waitingForDebugger() {
979 return mWaiting;
980 }
981
982 /**
983 * Determine if a debugger is currently attached.
984 */
985 public static boolean isDebuggerConnected() {
986 return VMDebug.isDebuggerConnected();
987 }
988
989 /**
Andy McFaddene5772322010-01-22 07:23:31 -0800990 * Returns an array of strings that identify VM features. This is
991 * used by DDMS to determine what sorts of operations the VM can
992 * perform.
993 *
994 * @hide
995 */
996 public static String[] getVmFeatureList() {
997 return VMDebug.getVmFeatureList();
998 }
999
1000 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001001 * Change the JDWP port.
1002 *
1003 * @deprecated no longer needed or useful
1004 */
1005 @Deprecated
1006 public static void changeDebugPort(int port) {}
1007
1008 /**
1009 * This is the pathname to the sysfs file that enables and disables
1010 * tracing on the qemu emulator.
1011 */
1012 private static final String SYSFS_QEMU_TRACE_STATE = "/sys/qemu_trace/state";
1013
1014 /**
1015 * Enable qemu tracing. For this to work requires running everything inside
1016 * the qemu emulator; otherwise, this method will have no effect. The trace
1017 * file is specified on the command line when the emulator is started. For
1018 * example, the following command line <br />
1019 * <code>emulator -trace foo</code><br />
1020 * will start running the emulator and create a trace file named "foo". This
1021 * method simply enables writing the trace records to the trace file.
1022 *
1023 * <p>
1024 * The main differences between this and {@link #startMethodTracing()} are
1025 * that tracing in the qemu emulator traces every cpu instruction of every
1026 * process, including kernel code, so we have more complete information,
1027 * including all context switches. We can also get more detailed information
1028 * such as cache misses. The sequence of calls is determined by
1029 * post-processing the instruction trace. The qemu tracing is also done
1030 * without modifying the application or perturbing the timing of calls
1031 * because no instrumentation is added to the application being traced.
1032 * </p>
1033 *
1034 * <p>
1035 * One limitation of using this method compared to using
1036 * {@link #startMethodTracing()} on the real device is that the emulator
1037 * does not model all of the real hardware effects such as memory and
1038 * bus contention. The emulator also has a simple cache model and cannot
1039 * capture all the complexities of a real cache.
1040 * </p>
1041 */
1042 public static void startNativeTracing() {
1043 // Open the sysfs file for writing and write "1" to it.
1044 PrintWriter outStream = null;
1045 try {
1046 FileOutputStream fos = new FileOutputStream(SYSFS_QEMU_TRACE_STATE);
Dianne Hackborn8c841092013-06-24 13:46:13 -07001047 outStream = new FastPrintWriter(fos);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001048 outStream.println("1");
1049 } catch (Exception e) {
1050 } finally {
1051 if (outStream != null)
1052 outStream.close();
1053 }
1054
1055 VMDebug.startEmulatorTracing();
1056 }
1057
1058 /**
1059 * Stop qemu tracing. See {@link #startNativeTracing()} to start tracing.
1060 *
1061 * <p>Tracing can be started and stopped as many times as desired. When
1062 * the qemu emulator itself is stopped then the buffered trace records
1063 * are flushed and written to the trace file. In fact, it is not necessary
1064 * to call this method at all; simply killing qemu is sufficient. But
1065 * starting and stopping a trace is useful for examining a specific
1066 * region of code.</p>
1067 */
1068 public static void stopNativeTracing() {
1069 VMDebug.stopEmulatorTracing();
1070
1071 // Open the sysfs file for writing and write "0" to it.
1072 PrintWriter outStream = null;
1073 try {
1074 FileOutputStream fos = new FileOutputStream(SYSFS_QEMU_TRACE_STATE);
Dianne Hackborn8c841092013-06-24 13:46:13 -07001075 outStream = new FastPrintWriter(fos);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001076 outStream.println("0");
1077 } catch (Exception e) {
1078 // We could print an error message here but we probably want
1079 // to quietly ignore errors if we are not running in the emulator.
1080 } finally {
1081 if (outStream != null)
1082 outStream.close();
1083 }
1084 }
1085
1086 /**
1087 * Enable "emulator traces", in which information about the current
1088 * method is made available to the "emulator -trace" feature. There
1089 * is no corresponding "disable" call -- this is intended for use by
1090 * the framework when tracing should be turned on and left that way, so
1091 * that traces captured with F9/F10 will include the necessary data.
1092 *
1093 * This puts the VM into "profile" mode, which has performance
1094 * consequences.
1095 *
1096 * To temporarily enable tracing, use {@link #startNativeTracing()}.
1097 */
1098 public static void enableEmulatorTraceOutput() {
1099 VMDebug.startEmulatorTracing();
1100 }
1101
1102 /**
Jeff Sharkey3a6e0ec2016-03-21 16:42:57 -06001103 * Start method tracing with default log name and buffer size.
1104 * <p>
1105 * By default, the trace file is called "dmtrace.trace" and it's placed
1106 * under your package-specific directory on primary shared/external storage,
1107 * as returned by {@link Context#getExternalFilesDir(String)}.
1108 * <p>
Ricardo Loo Forondaac750a82018-01-25 09:10:47 -08001109 * See <a href="{@docRoot}studio/profile/traceview.html">Inspect Trace Logs
1110 * with Traceview</a> for information about reading trace files.
Jeff Sharkey3a6e0ec2016-03-21 16:42:57 -06001111 * <p class="note">
1112 * When method tracing is enabled, the VM will run more slowly than usual,
1113 * so the timings from the trace files should only be considered in relative
1114 * terms (e.g. was run #1 faster than run #2). The times for native methods
1115 * will not change, so don't try to use this to compare the performance of
1116 * interpreted and native implementations of the same method. As an
1117 * alternative, consider using sampling-based method tracing via
1118 * {@link #startMethodTracingSampling(String, int, int)} or "native" tracing
1119 * in the emulator via {@link #startNativeTracing()}.
1120 * </p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001121 */
1122 public static void startMethodTracing() {
Jeff Sharkey3a6e0ec2016-03-21 16:42:57 -06001123 VMDebug.startMethodTracing(fixTracePath(null), 0, 0, false, 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001124 }
1125
1126 /**
Jeff Sharkey3a6e0ec2016-03-21 16:42:57 -06001127 * Start method tracing, specifying the trace log file path.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001128 * <p>
Jeff Sharkey3a6e0ec2016-03-21 16:42:57 -06001129 * When a relative file path is given, the trace file will be placed under
1130 * your package-specific directory on primary shared/external storage, as
1131 * returned by {@link Context#getExternalFilesDir(String)}.
1132 * <p>
Ricardo Loo Forondaac750a82018-01-25 09:10:47 -08001133 * See <a href="{@docRoot}studio/profile/traceview.html">Inspect Trace Logs
1134 * with Traceview</a> for information about reading trace files.
Jeff Sharkey3a6e0ec2016-03-21 16:42:57 -06001135 * <p class="note">
1136 * When method tracing is enabled, the VM will run more slowly than usual,
1137 * so the timings from the trace files should only be considered in relative
1138 * terms (e.g. was run #1 faster than run #2). The times for native methods
1139 * will not change, so don't try to use this to compare the performance of
1140 * interpreted and native implementations of the same method. As an
1141 * alternative, consider using sampling-based method tracing via
1142 * {@link #startMethodTracingSampling(String, int, int)} or "native" tracing
1143 * in the emulator via {@link #startNativeTracing()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001144 * </p>
1145 *
Jeff Sharkey3a6e0ec2016-03-21 16:42:57 -06001146 * @param tracePath Path to the trace log file to create. If {@code null},
1147 * this will default to "dmtrace.trace". If the file already
1148 * exists, it will be truncated. If the path given does not end
1149 * in ".trace", it will be appended for you.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001150 */
Jeff Sharkey3a6e0ec2016-03-21 16:42:57 -06001151 public static void startMethodTracing(String tracePath) {
1152 startMethodTracing(tracePath, 0, 0);
1153 }
1154
1155 /**
1156 * Start method tracing, specifying the trace log file name and the buffer
1157 * size.
1158 * <p>
1159 * When a relative file path is given, the trace file will be placed under
1160 * your package-specific directory on primary shared/external storage, as
1161 * returned by {@link Context#getExternalFilesDir(String)}.
1162 * <p>
Ricardo Loo Forondaac750a82018-01-25 09:10:47 -08001163 * See <a href="{@docRoot}studio/profile/traceview.html">Inspect Trace Logs
1164 * with Traceview</a> for information about reading trace files.
Jeff Sharkey3a6e0ec2016-03-21 16:42:57 -06001165 * <p class="note">
1166 * When method tracing is enabled, the VM will run more slowly than usual,
1167 * so the timings from the trace files should only be considered in relative
1168 * terms (e.g. was run #1 faster than run #2). The times for native methods
1169 * will not change, so don't try to use this to compare the performance of
1170 * interpreted and native implementations of the same method. As an
1171 * alternative, consider using sampling-based method tracing via
1172 * {@link #startMethodTracingSampling(String, int, int)} or "native" tracing
1173 * in the emulator via {@link #startNativeTracing()}.
1174 * </p>
1175 *
1176 * @param tracePath Path to the trace log file to create. If {@code null},
1177 * this will default to "dmtrace.trace". If the file already
1178 * exists, it will be truncated. If the path given does not end
1179 * in ".trace", it will be appended for you.
1180 * @param bufferSize The maximum amount of trace data we gather. If not
1181 * given, it defaults to 8MB.
1182 */
1183 public static void startMethodTracing(String tracePath, int bufferSize) {
1184 startMethodTracing(tracePath, bufferSize, 0);
1185 }
1186
1187 /**
1188 * Start method tracing, specifying the trace log file name, the buffer
1189 * size, and flags.
1190 * <p>
1191 * When a relative file path is given, the trace file will be placed under
1192 * your package-specific directory on primary shared/external storage, as
1193 * returned by {@link Context#getExternalFilesDir(String)}.
1194 * <p>
Ricardo Loo Forondaac750a82018-01-25 09:10:47 -08001195 * See <a href="{@docRoot}studio/profile/traceview.html">Inspect Trace Logs
1196 * with Traceview</a> for information about reading trace files.
Jeff Sharkey3a6e0ec2016-03-21 16:42:57 -06001197 * <p class="note">
1198 * When method tracing is enabled, the VM will run more slowly than usual,
1199 * so the timings from the trace files should only be considered in relative
1200 * terms (e.g. was run #1 faster than run #2). The times for native methods
1201 * will not change, so don't try to use this to compare the performance of
1202 * interpreted and native implementations of the same method. As an
1203 * alternative, consider using sampling-based method tracing via
1204 * {@link #startMethodTracingSampling(String, int, int)} or "native" tracing
1205 * in the emulator via {@link #startNativeTracing()}.
1206 * </p>
1207 *
1208 * @param tracePath Path to the trace log file to create. If {@code null},
1209 * this will default to "dmtrace.trace". If the file already
1210 * exists, it will be truncated. If the path given does not end
1211 * in ".trace", it will be appended for you.
1212 * @param bufferSize The maximum amount of trace data we gather. If not
1213 * given, it defaults to 8MB.
1214 * @param flags Flags to control method tracing. The only one that is
1215 * currently defined is {@link #TRACE_COUNT_ALLOCS}.
1216 */
1217 public static void startMethodTracing(String tracePath, int bufferSize, int flags) {
1218 VMDebug.startMethodTracing(fixTracePath(tracePath), bufferSize, flags, false, 0);
Jeff Haod02e60f2014-01-06 15:52:52 -08001219 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001220
Jeff Haod02e60f2014-01-06 15:52:52 -08001221 /**
1222 * Start sampling-based method tracing, specifying the trace log file name,
Jeff Sharkey3a6e0ec2016-03-21 16:42:57 -06001223 * the buffer size, and the sampling interval.
1224 * <p>
1225 * When a relative file path is given, the trace file will be placed under
1226 * your package-specific directory on primary shared/external storage, as
1227 * returned by {@link Context#getExternalFilesDir(String)}.
1228 * <p>
Ricardo Loo Forondaac750a82018-01-25 09:10:47 -08001229 * See <a href="{@docRoot}studio/profile/traceview.html">Inspect Trace Logs
1230 * with Traceview</a> for information about reading trace files.
Jeff Haod02e60f2014-01-06 15:52:52 -08001231 *
Jeff Sharkey3a6e0ec2016-03-21 16:42:57 -06001232 * @param tracePath Path to the trace log file to create. If {@code null},
1233 * this will default to "dmtrace.trace". If the file already
1234 * exists, it will be truncated. If the path given does not end
1235 * in ".trace", it will be appended for you.
1236 * @param bufferSize The maximum amount of trace data we gather. If not
1237 * given, it defaults to 8MB.
1238 * @param intervalUs The amount of time between each sample in microseconds.
Jeff Haod02e60f2014-01-06 15:52:52 -08001239 */
Jeff Sharkey3a6e0ec2016-03-21 16:42:57 -06001240 public static void startMethodTracingSampling(String tracePath, int bufferSize,
1241 int intervalUs) {
1242 VMDebug.startMethodTracing(fixTracePath(tracePath), bufferSize, 0, true, intervalUs);
Jeff Haod02e60f2014-01-06 15:52:52 -08001243 }
Kweku Adams983829f2017-12-06 14:53:50 -08001244
Jeff Haod02e60f2014-01-06 15:52:52 -08001245 /**
1246 * Formats name of trace log file for method tracing.
1247 */
Jeff Sharkey3a6e0ec2016-03-21 16:42:57 -06001248 private static String fixTracePath(String tracePath) {
1249 if (tracePath == null || tracePath.charAt(0) != '/') {
1250 final Context context = AppGlobals.getInitialApplication();
1251 final File dir;
1252 if (context != null) {
1253 dir = context.getExternalFilesDir(null);
1254 } else {
1255 dir = Environment.getExternalStorageDirectory();
1256 }
Jeff Haod02e60f2014-01-06 15:52:52 -08001257
Jeff Sharkey3a6e0ec2016-03-21 16:42:57 -06001258 if (tracePath == null) {
1259 tracePath = new File(dir, DEFAULT_TRACE_BODY).getAbsolutePath();
1260 } else {
1261 tracePath = new File(dir, tracePath).getAbsolutePath();
1262 }
1263 }
1264 if (!tracePath.endsWith(DEFAULT_TRACE_EXTENSION)) {
1265 tracePath += DEFAULT_TRACE_EXTENSION;
1266 }
1267 return tracePath;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001268 }
1269
1270 /**
Dianne Hackborn9c8dd552009-06-23 19:22:52 -07001271 * Like startMethodTracing(String, int, int), but taking an already-opened
1272 * FileDescriptor in which the trace is written. The file name is also
1273 * supplied simply for logging. Makes a dup of the file descriptor.
Christian Mehlmauer798e2d32010-06-17 18:24:07 +02001274 *
Dianne Hackborn9c8dd552009-06-23 19:22:52 -07001275 * Not exposed in the SDK unless we are really comfortable with supporting
1276 * this and find it would be useful.
1277 * @hide
1278 */
1279 public static void startMethodTracing(String traceName, FileDescriptor fd,
Shukang Zhou6ec0b7e2017-01-24 15:30:29 -08001280 int bufferSize, int flags, boolean streamOutput) {
1281 VMDebug.startMethodTracing(traceName, fd, bufferSize, flags, false, 0, streamOutput);
Dianne Hackborn9c8dd552009-06-23 19:22:52 -07001282 }
1283
1284 /**
Andy McFadden72a20db0c2010-01-22 12:20:41 -08001285 * Starts method tracing without a backing file. When stopMethodTracing
1286 * is called, the result is sent directly to DDMS. (If DDMS is not
1287 * attached when tracing ends, the profiling data will be discarded.)
1288 *
1289 * @hide
1290 */
Jeff Hao7be3a132013-08-22 15:53:12 -07001291 public static void startMethodTracingDdms(int bufferSize, int flags,
1292 boolean samplingEnabled, int intervalUs) {
1293 VMDebug.startMethodTracingDdms(bufferSize, flags, samplingEnabled, intervalUs);
Andy McFadden72a20db0c2010-01-22 12:20:41 -08001294 }
1295
1296 /**
Jeff Haoac277052013-08-29 11:19:39 -07001297 * Determine whether method tracing is currently active and what type is
1298 * active.
1299 *
The Android Open Source Project7b0b1ed2009-03-18 22:20:26 -07001300 * @hide
1301 */
Jeff Haoac277052013-08-29 11:19:39 -07001302 public static int getMethodTracingMode() {
1303 return VMDebug.getMethodTracingMode();
The Android Open Source Project7b0b1ed2009-03-18 22:20:26 -07001304 }
1305
1306 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001307 * Stop method tracing.
1308 */
1309 public static void stopMethodTracing() {
1310 VMDebug.stopMethodTracing();
1311 }
1312
1313 /**
1314 * Get an indication of thread CPU usage. The value returned
1315 * indicates the amount of time that the current thread has spent
1316 * executing code or waiting for certain types of I/O.
1317 *
1318 * The time is expressed in nanoseconds, and is only meaningful
1319 * when compared to the result from an earlier call. Note that
1320 * nanosecond resolution does not imply nanosecond accuracy.
1321 *
1322 * On system which don't support this operation, the call returns -1.
1323 */
1324 public static long threadCpuTimeNanos() {
1325 return VMDebug.threadCpuTimeNanos();
1326 }
1327
1328 /**
Chet Haase2970c492010-11-09 13:58:04 -08001329 * Start counting the number and aggregate size of memory allocations.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001330 *
Ian Rogersfe067a42013-02-22 19:59:23 -08001331 * <p>The {@link #startAllocCounting() start} method resets the counts and enables counting.
1332 * The {@link #stopAllocCounting() stop} method disables the counting so that the analysis
1333 * code doesn't cause additional allocations. The various <code>get</code> methods return
1334 * the specified value. And the various <code>reset</code> methods reset the specified
Chet Haase2970c492010-11-09 13:58:04 -08001335 * count.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001336 *
Ian Rogersfe067a42013-02-22 19:59:23 -08001337 * <p>Counts are kept for the system as a whole (global) and for each thread.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001338 * The per-thread counts for threads other than the current thread
Chet Haase2970c492010-11-09 13:58:04 -08001339 * are not cleared by the "reset" or "start" calls.</p>
Ian Rogersfe067a42013-02-22 19:59:23 -08001340 *
1341 * @deprecated Accurate counting is a burden on the runtime and may be removed.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001342 */
Ian Rogersfe067a42013-02-22 19:59:23 -08001343 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001344 public static void startAllocCounting() {
1345 VMDebug.startAllocCounting();
1346 }
Chet Haase2970c492010-11-09 13:58:04 -08001347
1348 /**
1349 * Stop counting the number and aggregate size of memory allocations.
1350 *
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001351 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Chet Haase2970c492010-11-09 13:58:04 -08001352 */
Ian Rogersc2a3adb2013-04-19 11:31:48 -07001353 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001354 public static void stopAllocCounting() {
1355 VMDebug.stopAllocCounting();
1356 }
1357
Ian Rogersfe067a42013-02-22 19:59:23 -08001358 /**
1359 * Returns the global count of objects allocated by the runtime between a
1360 * {@link #startAllocCounting() start} and {@link #stopAllocCounting() stop}.
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001361 *
1362 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001363 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001364 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001365 public static int getGlobalAllocCount() {
1366 return VMDebug.getAllocCount(VMDebug.KIND_GLOBAL_ALLOCATED_OBJECTS);
1367 }
Ian Rogersfe067a42013-02-22 19:59:23 -08001368
1369 /**
1370 * Clears the global count of objects allocated.
1371 * @see #getGlobalAllocCount()
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001372 *
1373 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001374 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001375 @Deprecated
Ian Rogersfe067a42013-02-22 19:59:23 -08001376 public static void resetGlobalAllocCount() {
1377 VMDebug.resetAllocCount(VMDebug.KIND_GLOBAL_ALLOCATED_OBJECTS);
1378 }
1379
1380 /**
1381 * Returns the global size, in bytes, of objects allocated by the runtime between a
1382 * {@link #startAllocCounting() start} and {@link #stopAllocCounting() stop}.
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001383 *
1384 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001385 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001386 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001387 public static int getGlobalAllocSize() {
1388 return VMDebug.getAllocCount(VMDebug.KIND_GLOBAL_ALLOCATED_BYTES);
1389 }
Ian Rogersfe067a42013-02-22 19:59:23 -08001390
1391 /**
1392 * Clears the global size of objects allocated.
Dianne Hackborn3fa89692013-09-13 17:20:00 -07001393 * @see #getGlobalAllocSize()
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001394 *
1395 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001396 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001397 @Deprecated
Ian Rogersfe067a42013-02-22 19:59:23 -08001398 public static void resetGlobalAllocSize() {
1399 VMDebug.resetAllocCount(VMDebug.KIND_GLOBAL_ALLOCATED_BYTES);
1400 }
1401
1402 /**
1403 * Returns the global count of objects freed by the runtime between a
1404 * {@link #startAllocCounting() start} and {@link #stopAllocCounting() stop}.
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001405 *
1406 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001407 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001408 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001409 public static int getGlobalFreedCount() {
1410 return VMDebug.getAllocCount(VMDebug.KIND_GLOBAL_FREED_OBJECTS);
1411 }
Ian Rogersfe067a42013-02-22 19:59:23 -08001412
1413 /**
1414 * Clears the global count of objects freed.
1415 * @see #getGlobalFreedCount()
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001416 *
1417 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001418 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001419 @Deprecated
Ian Rogersfe067a42013-02-22 19:59:23 -08001420 public static void resetGlobalFreedCount() {
1421 VMDebug.resetAllocCount(VMDebug.KIND_GLOBAL_FREED_OBJECTS);
1422 }
1423
1424 /**
1425 * Returns the global size, in bytes, of objects freed by the runtime between a
1426 * {@link #startAllocCounting() start} and {@link #stopAllocCounting() stop}.
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001427 *
1428 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001429 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001430 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001431 public static int getGlobalFreedSize() {
1432 return VMDebug.getAllocCount(VMDebug.KIND_GLOBAL_FREED_BYTES);
1433 }
Ian Rogersfe067a42013-02-22 19:59:23 -08001434
1435 /**
1436 * Clears the global size of objects freed.
1437 * @see #getGlobalFreedSize()
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001438 *
1439 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001440 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001441 @Deprecated
Ian Rogersfe067a42013-02-22 19:59:23 -08001442 public static void resetGlobalFreedSize() {
1443 VMDebug.resetAllocCount(VMDebug.KIND_GLOBAL_FREED_BYTES);
1444 }
1445
1446 /**
1447 * Returns the number of non-concurrent GC invocations between a
1448 * {@link #startAllocCounting() start} and {@link #stopAllocCounting() stop}.
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001449 *
1450 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001451 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001452 @Deprecated
Ian Rogersfe067a42013-02-22 19:59:23 -08001453 public static int getGlobalGcInvocationCount() {
1454 return VMDebug.getAllocCount(VMDebug.KIND_GLOBAL_GC_INVOCATIONS);
1455 }
1456
1457 /**
1458 * Clears the count of non-concurrent GC invocations.
1459 * @see #getGlobalGcInvocationCount()
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001460 *
1461 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001462 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001463 @Deprecated
Ian Rogersfe067a42013-02-22 19:59:23 -08001464 public static void resetGlobalGcInvocationCount() {
1465 VMDebug.resetAllocCount(VMDebug.KIND_GLOBAL_GC_INVOCATIONS);
1466 }
1467
1468 /**
1469 * Returns the number of classes successfully initialized (ie those that executed without
1470 * throwing an exception) between a {@link #startAllocCounting() start} and
1471 * {@link #stopAllocCounting() stop}.
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001472 *
1473 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001474 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001475 @Deprecated
Andy McFaddenc4e1bf72010-02-22 17:07:36 -08001476 public static int getGlobalClassInitCount() {
Andy McFaddenc4e1bf72010-02-22 17:07:36 -08001477 return VMDebug.getAllocCount(VMDebug.KIND_GLOBAL_CLASS_INIT_COUNT);
1478 }
Ian Rogersfe067a42013-02-22 19:59:23 -08001479
1480 /**
1481 * Clears the count of classes initialized.
1482 * @see #getGlobalClassInitCount()
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001483 *
1484 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001485 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001486 @Deprecated
Ian Rogersfe067a42013-02-22 19:59:23 -08001487 public static void resetGlobalClassInitCount() {
1488 VMDebug.resetAllocCount(VMDebug.KIND_GLOBAL_CLASS_INIT_COUNT);
1489 }
1490
1491 /**
1492 * Returns the time spent successfully initializing classes between a
1493 * {@link #startAllocCounting() start} and {@link #stopAllocCounting() stop}.
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001494 *
1495 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001496 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001497 @Deprecated
Andy McFaddenc4e1bf72010-02-22 17:07:36 -08001498 public static int getGlobalClassInitTime() {
1499 /* cumulative elapsed time for class initialization, in usec */
1500 return VMDebug.getAllocCount(VMDebug.KIND_GLOBAL_CLASS_INIT_TIME);
1501 }
Carl Shapirob5961982010-12-22 15:54:53 -08001502
1503 /**
Ian Rogersfe067a42013-02-22 19:59:23 -08001504 * Clears the count of time spent initializing classes.
1505 * @see #getGlobalClassInitTime()
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001506 *
1507 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001508 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001509 @Deprecated
Ian Rogersfe067a42013-02-22 19:59:23 -08001510 public static void resetGlobalClassInitTime() {
1511 VMDebug.resetAllocCount(VMDebug.KIND_GLOBAL_CLASS_INIT_TIME);
1512 }
1513
1514 /**
Carl Shapiro7e942842011-01-12 17:17:45 -08001515 * This method exists for compatibility and always returns 0.
Carl Shapirob5961982010-12-22 15:54:53 -08001516 * @deprecated This method is now obsolete.
1517 */
1518 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001519 public static int getGlobalExternalAllocCount() {
Carl Shapirob5961982010-12-22 15:54:53 -08001520 return 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001521 }
Carl Shapirob5961982010-12-22 15:54:53 -08001522
1523 /**
Ian Rogersfe067a42013-02-22 19:59:23 -08001524 * This method exists for compatibility and has no effect.
1525 * @deprecated This method is now obsolete.
1526 */
1527 @Deprecated
1528 public static void resetGlobalExternalAllocSize() {}
1529
1530 /**
1531 * This method exists for compatibility and has no effect.
1532 * @deprecated This method is now obsolete.
1533 */
1534 @Deprecated
1535 public static void resetGlobalExternalAllocCount() {}
1536
1537 /**
Carl Shapiro7e942842011-01-12 17:17:45 -08001538 * This method exists for compatibility and always returns 0.
Carl Shapirob5961982010-12-22 15:54:53 -08001539 * @deprecated This method is now obsolete.
1540 */
1541 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001542 public static int getGlobalExternalAllocSize() {
Carl Shapirob5961982010-12-22 15:54:53 -08001543 return 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001544 }
Carl Shapirob5961982010-12-22 15:54:53 -08001545
1546 /**
Ian Rogersfe067a42013-02-22 19:59:23 -08001547 * This method exists for compatibility and always returns 0.
Carl Shapirob5961982010-12-22 15:54:53 -08001548 * @deprecated This method is now obsolete.
1549 */
1550 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001551 public static int getGlobalExternalFreedCount() {
Carl Shapirob5961982010-12-22 15:54:53 -08001552 return 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001553 }
Carl Shapirob5961982010-12-22 15:54:53 -08001554
1555 /**
Ian Rogersfe067a42013-02-22 19:59:23 -08001556 * This method exists for compatibility and has no effect.
1557 * @deprecated This method is now obsolete.
1558 */
1559 @Deprecated
1560 public static void resetGlobalExternalFreedCount() {}
1561
1562 /**
1563 * This method exists for compatibility and has no effect.
Carl Shapirob5961982010-12-22 15:54:53 -08001564 * @deprecated This method is now obsolete.
1565 */
1566 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001567 public static int getGlobalExternalFreedSize() {
Carl Shapirob5961982010-12-22 15:54:53 -08001568 return 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001569 }
Carl Shapirob5961982010-12-22 15:54:53 -08001570
Ian Rogersfe067a42013-02-22 19:59:23 -08001571 /**
1572 * This method exists for compatibility and has no effect.
1573 * @deprecated This method is now obsolete.
1574 */
1575 @Deprecated
1576 public static void resetGlobalExternalFreedSize() {}
1577
1578 /**
1579 * Returns the thread-local count of objects allocated by the runtime between a
1580 * {@link #startAllocCounting() start} and {@link #stopAllocCounting() stop}.
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001581 *
1582 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001583 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001584 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001585 public static int getThreadAllocCount() {
1586 return VMDebug.getAllocCount(VMDebug.KIND_THREAD_ALLOCATED_OBJECTS);
1587 }
Ian Rogersfe067a42013-02-22 19:59:23 -08001588
1589 /**
1590 * Clears the thread-local count of objects allocated.
1591 * @see #getThreadAllocCount()
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001592 *
1593 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001594 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001595 @Deprecated
Ian Rogersfe067a42013-02-22 19:59:23 -08001596 public static void resetThreadAllocCount() {
1597 VMDebug.resetAllocCount(VMDebug.KIND_THREAD_ALLOCATED_OBJECTS);
1598 }
1599
1600 /**
1601 * Returns the thread-local size of objects allocated by the runtime between a
1602 * {@link #startAllocCounting() start} and {@link #stopAllocCounting() stop}.
1603 * @return The allocated size in bytes.
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001604 *
1605 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001606 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001607 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001608 public static int getThreadAllocSize() {
1609 return VMDebug.getAllocCount(VMDebug.KIND_THREAD_ALLOCATED_BYTES);
1610 }
Carl Shapirob5961982010-12-22 15:54:53 -08001611
1612 /**
Ian Rogersfe067a42013-02-22 19:59:23 -08001613 * Clears the thread-local count of objects allocated.
1614 * @see #getThreadAllocSize()
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001615 *
1616 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001617 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001618 @Deprecated
Ian Rogersfe067a42013-02-22 19:59:23 -08001619 public static void resetThreadAllocSize() {
1620 VMDebug.resetAllocCount(VMDebug.KIND_THREAD_ALLOCATED_BYTES);
1621 }
1622
1623 /**
1624 * This method exists for compatibility and has no effect.
Carl Shapirob5961982010-12-22 15:54:53 -08001625 * @deprecated This method is now obsolete.
1626 */
1627 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001628 public static int getThreadExternalAllocCount() {
Carl Shapirob5961982010-12-22 15:54:53 -08001629 return 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001630 }
Carl Shapirob5961982010-12-22 15:54:53 -08001631
1632 /**
Ian Rogersfe067a42013-02-22 19:59:23 -08001633 * This method exists for compatibility and has no effect.
1634 * @deprecated This method is now obsolete.
1635 */
1636 @Deprecated
1637 public static void resetThreadExternalAllocCount() {}
1638
1639 /**
1640 * This method exists for compatibility and has no effect.
Carl Shapirob5961982010-12-22 15:54:53 -08001641 * @deprecated This method is now obsolete.
1642 */
1643 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001644 public static int getThreadExternalAllocSize() {
Carl Shapirob5961982010-12-22 15:54:53 -08001645 return 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001646 }
Carl Shapirob5961982010-12-22 15:54:53 -08001647
Carl Shapirob5961982010-12-22 15:54:53 -08001648 /**
Carl Shapiro7e942842011-01-12 17:17:45 -08001649 * This method exists for compatibility and has no effect.
Carl Shapirob5961982010-12-22 15:54:53 -08001650 * @deprecated This method is now obsolete.
1651 */
1652 @Deprecated
1653 public static void resetThreadExternalAllocSize() {}
1654
Ian Rogersfe067a42013-02-22 19:59:23 -08001655 /**
1656 * Returns the number of thread-local non-concurrent GC invocations between a
1657 * {@link #startAllocCounting() start} and {@link #stopAllocCounting() stop}.
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001658 *
1659 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001660 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001661 @Deprecated
Ian Rogersfe067a42013-02-22 19:59:23 -08001662 public static int getThreadGcInvocationCount() {
1663 return VMDebug.getAllocCount(VMDebug.KIND_THREAD_GC_INVOCATIONS);
1664 }
1665
1666 /**
1667 * Clears the thread-local count of non-concurrent GC invocations.
1668 * @see #getThreadGcInvocationCount()
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001669 *
1670 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001671 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001672 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001673 public static void resetThreadGcInvocationCount() {
1674 VMDebug.resetAllocCount(VMDebug.KIND_THREAD_GC_INVOCATIONS);
1675 }
Ian Rogersfe067a42013-02-22 19:59:23 -08001676
1677 /**
1678 * Clears all the global and thread-local memory allocation counters.
1679 * @see #startAllocCounting()
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001680 *
1681 * @deprecated Accurate counting is a burden on the runtime and may be removed.
Ian Rogersfe067a42013-02-22 19:59:23 -08001682 */
Hiroshi Yamauchi172da262015-03-04 12:29:19 -08001683 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001684 public static void resetAllCounts() {
1685 VMDebug.resetAllocCount(VMDebug.KIND_ALL_COUNTS);
1686 }
1687
1688 /**
Hiroshi Yamauchi8b5a293d2015-04-02 12:26:10 -07001689 * Returns the value of a particular runtime statistic or {@code null} if no
1690 * such runtime statistic exists.
1691 *
1692 * <p>The following table lists the runtime statistics that the runtime supports.
Hans Boehm98491ba2019-10-08 17:54:47 -07001693 * All statistics are approximate. Individual allocations may not be immediately reflected
1694 * in the results.
Hiroshi Yamauchi8b5a293d2015-04-02 12:26:10 -07001695 * Note runtime statistics may be added or removed in a future API level.</p>
1696 *
1697 * <table>
1698 * <thead>
1699 * <tr>
1700 * <th>Runtime statistic name</th>
1701 * <th>Meaning</th>
1702 * <th>Example</th>
1703 * <th>Supported (API Levels)</th>
1704 * </tr>
1705 * </thead>
1706 * <tbody>
1707 * <tr>
1708 * <td>art.gc.gc-count</td>
1709 * <td>The number of garbage collection runs.</td>
1710 * <td>{@code 164}</td>
1711 * <td>23</td>
1712 * </tr>
1713 * <tr>
1714 * <td>art.gc.gc-time</td>
1715 * <td>The total duration of garbage collection runs in ms.</td>
1716 * <td>{@code 62364}</td>
1717 * <td>23</td>
1718 * </tr>
1719 * <tr>
1720 * <td>art.gc.bytes-allocated</td>
1721 * <td>The total number of bytes that the application allocated.</td>
1722 * <td>{@code 1463948408}</td>
1723 * <td>23</td>
1724 * </tr>
1725 * <tr>
1726 * <td>art.gc.bytes-freed</td>
1727 * <td>The total number of bytes that garbage collection reclaimed.</td>
1728 * <td>{@code 1313493084}</td>
1729 * <td>23</td>
1730 * </tr>
1731 * <tr>
1732 * <td>art.gc.blocking-gc-count</td>
1733 * <td>The number of blocking garbage collection runs.</td>
1734 * <td>{@code 2}</td>
1735 * <td>23</td>
1736 * </tr>
1737 * <tr>
1738 * <td>art.gc.blocking-gc-time</td>
1739 * <td>The total duration of blocking garbage collection runs in ms.</td>
1740 * <td>{@code 804}</td>
1741 * <td>23</td>
1742 * </tr>
1743 * <tr>
1744 * <td>art.gc.gc-count-rate-histogram</td>
Hiroshi Yamauchi2d6327d2015-05-28 15:28:16 -07001745 * <td>Every 10 seconds, the gc-count-rate is computed as the number of garbage
1746 * collection runs that have occurred over the last 10
1747 * seconds. art.gc.gc-count-rate-histogram is a histogram of the gc-count-rate
1748 * samples taken since the process began. The histogram can be used to identify
1749 * instances of high rates of garbage collection runs. For example, a histogram
1750 * of "0:34503,1:45350,2:11281,3:8088,4:43,5:8" shows that most of the time
1751 * there are between 0 and 2 garbage collection runs every 10 seconds, but there
1752 * were 8 distinct 10-second intervals in which 5 garbage collection runs
1753 * occurred.</td>
Hiroshi Yamauchi8b5a293d2015-04-02 12:26:10 -07001754 * <td>{@code 0:34503,1:45350,2:11281,3:8088,4:43,5:8}</td>
1755 * <td>23</td>
1756 * </tr>
1757 * <tr>
1758 * <td>art.gc.blocking-gc-count-rate-histogram</td>
Hiroshi Yamauchi2d6327d2015-05-28 15:28:16 -07001759 * <td>Every 10 seconds, the blocking-gc-count-rate is computed as the number of
1760 * blocking garbage collection runs that have occurred over the last 10
1761 * seconds. art.gc.blocking-gc-count-rate-histogram is a histogram of the
1762 * blocking-gc-count-rate samples taken since the process began. The histogram
1763 * can be used to identify instances of high rates of blocking garbage
1764 * collection runs. For example, a histogram of "0:99269,1:1,2:1" shows that
1765 * most of the time there are zero blocking garbage collection runs every 10
1766 * seconds, but there was one 10-second interval in which one blocking garbage
1767 * collection run occurred, and there was one interval in which two blocking
1768 * garbage collection runs occurred.</td>
Hiroshi Yamauchi8b5a293d2015-04-02 12:26:10 -07001769 * <td>{@code 0:99269,1:1,2:1}</td>
1770 * <td>23</td>
1771 * </tr>
1772 * </tbody>
1773 * </table>
1774 *
1775 * @param statName
1776 * the name of the runtime statistic to look up.
1777 * @return the value of the specified runtime statistic or {@code null} if the
1778 * runtime statistic doesn't exist.
Hiroshi Yamauchi8b5a293d2015-04-02 12:26:10 -07001779 */
1780 public static String getRuntimeStat(String statName) {
1781 return VMDebug.getRuntimeStat(statName);
1782 }
1783
1784 /**
1785 * Returns a map of the names/values of the runtime statistics
Hiroshi Yamauchid8001672015-04-14 16:07:26 -07001786 * that {@link #getRuntimeStat(String)} supports.
Hiroshi Yamauchi8b5a293d2015-04-02 12:26:10 -07001787 *
1788 * @return a map of the names/values of the supported runtime statistics.
Hiroshi Yamauchi8b5a293d2015-04-02 12:26:10 -07001789 */
1790 public static Map<String, String> getRuntimeStats() {
1791 return VMDebug.getRuntimeStats();
1792 }
1793
1794 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001795 * Returns the size of the native heap.
1796 * @return The size of the native heap in bytes.
1797 */
1798 public static native long getNativeHeapSize();
1799
1800 /**
1801 * Returns the amount of allocated memory in the native heap.
1802 * @return The allocated size in bytes.
1803 */
1804 public static native long getNativeHeapAllocatedSize();
1805
1806 /**
1807 * Returns the amount of free memory in the native heap.
1808 * @return The freed size in bytes.
1809 */
1810 public static native long getNativeHeapFreeSize();
1811
1812 /**
1813 * Retrieves information about this processes memory usages. This information is broken down by
Dianne Hackbornb02ce292015-10-12 15:14:16 -07001814 * how much is in use by dalvik, the native heap, and everything else.
1815 *
Kweku Adams983829f2017-12-06 14:53:50 -08001816 * <p><b>Note:</b> this method directly retrieves memory information for the given process
Dianne Hackbornb02ce292015-10-12 15:14:16 -07001817 * from low-level data available to it. It may not be able to retrieve information about
1818 * some protected allocations, such as graphics. If you want to be sure you can see
Kweku Adams983829f2017-12-06 14:53:50 -08001819 * all information about allocations by the process, use
1820 * {@link android.app.ActivityManager#getProcessMemoryInfo(int[])} instead.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001821 */
1822 public static native void getMemoryInfo(MemoryInfo memoryInfo);
1823
1824 /**
Dianne Hackborn3025ef32009-08-31 21:31:47 -07001825 * Note: currently only works when the requested pid has the same UID
1826 * as the caller.
1827 * @hide
1828 */
Andrei Onea24ec3212019-03-15 17:35:05 +00001829 @UnsupportedAppUsage
Dianne Hackborn3025ef32009-08-31 21:31:47 -07001830 public static native void getMemoryInfo(int pid, MemoryInfo memoryInfo);
1831
1832 /**
Dianne Hackbornb437e092011-08-05 17:50:29 -07001833 * Retrieves the PSS memory used by the process as given by the
1834 * smaps.
1835 */
1836 public static native long getPss();
1837
1838 /**
Rafal Slawik4d078962018-08-20 18:23:49 +01001839 * Retrieves the PSS memory used by the process as given by the smaps. Optionally supply a long
1840 * array of up to 3 entries to also receive (up to 3 values in order): the Uss and SwapPss and
1841 * Rss (only filled in as of {@link android.os.Build.VERSION_CODES#P}) of the process, and
1842 * another array to also retrieve the separate memtrack size.
Martijn Coenene0764852016-01-07 17:04:22 -08001843 * @hide
Dianne Hackbornb437e092011-08-05 17:50:29 -07001844 */
Rafal Slawik4d078962018-08-20 18:23:49 +01001845 public static native long getPss(int pid, long[] outUssSwapPssRss, long[] outMemtrack);
Dianne Hackbornb437e092011-08-05 17:50:29 -07001846
Dianne Hackborn8e692572013-09-10 19:06:15 -07001847 /** @hide */
1848 public static final int MEMINFO_TOTAL = 0;
1849 /** @hide */
1850 public static final int MEMINFO_FREE = 1;
1851 /** @hide */
1852 public static final int MEMINFO_BUFFERS = 2;
1853 /** @hide */
1854 public static final int MEMINFO_CACHED = 3;
1855 /** @hide */
1856 public static final int MEMINFO_SHMEM = 4;
1857 /** @hide */
1858 public static final int MEMINFO_SLAB = 5;
Robert Benea5e099802017-10-04 18:28:01 -07001859 /** @hide */
1860 public static final int MEMINFO_SLAB_RECLAIMABLE = 6;
1861 /** @hide */
1862 public static final int MEMINFO_SLAB_UNRECLAIMABLE = 7;
Dianne Hackborn8e692572013-09-10 19:06:15 -07001863 /** @hide */
Robert Benea5e099802017-10-04 18:28:01 -07001864 public static final int MEMINFO_SWAP_TOTAL = 8;
Dianne Hackborncbd9a522013-09-24 23:10:14 -07001865 /** @hide */
Robert Benea5e099802017-10-04 18:28:01 -07001866 public static final int MEMINFO_SWAP_FREE = 9;
Dianne Hackborncbd9a522013-09-24 23:10:14 -07001867 /** @hide */
Robert Benea5e099802017-10-04 18:28:01 -07001868 public static final int MEMINFO_ZRAM_TOTAL = 10;
Dianne Hackborncbd9a522013-09-24 23:10:14 -07001869 /** @hide */
Robert Benea5e099802017-10-04 18:28:01 -07001870 public static final int MEMINFO_MAPPED = 11;
Dianne Hackbornb3af4ec2014-10-17 15:25:13 -07001871 /** @hide */
Robert Benea5e099802017-10-04 18:28:01 -07001872 public static final int MEMINFO_VM_ALLOC_USED = 12;
Dianne Hackbornb3af4ec2014-10-17 15:25:13 -07001873 /** @hide */
Robert Benea5e099802017-10-04 18:28:01 -07001874 public static final int MEMINFO_PAGE_TABLES = 13;
Dianne Hackbornb3af4ec2014-10-17 15:25:13 -07001875 /** @hide */
Robert Benea5e099802017-10-04 18:28:01 -07001876 public static final int MEMINFO_KERNEL_STACK = 14;
Suren Baghdasaryan5f8e17b2019-11-17 14:25:50 -08001877 /**
1878 * Note: MEMINFO_KRECLAIMABLE includes MEMINFO_SLAB_RECLAIMABLE (see KReclaimable field
1879 * description in kernel documentation).
1880 * @hide
1881 */
1882 public static final int MEMINFO_KRECLAIMABLE = 15;
Dianne Hackbornb3af4ec2014-10-17 15:25:13 -07001883 /** @hide */
Suren Baghdasaryan5f8e17b2019-11-17 14:25:50 -08001884 public static final int MEMINFO_COUNT = 16;
Dianne Hackborn8e692572013-09-10 19:06:15 -07001885
1886 /**
1887 * Retrieves /proc/meminfo. outSizes is filled with fields
1888 * as defined by MEMINFO_* offsets.
1889 * @hide
1890 */
Andrei Onea24ec3212019-03-15 17:35:05 +00001891 @UnsupportedAppUsage
Dianne Hackborn8e692572013-09-10 19:06:15 -07001892 public static native void getMemInfo(long[] outSizes);
1893
Dianne Hackbornb437e092011-08-05 17:50:29 -07001894 /**
Carl Shapiro11073832011-01-12 16:28:57 -08001895 * Establish an object allocation limit in the current thread.
Carl Shapiro7e942842011-01-12 17:17:45 -08001896 * This feature was never enabled in release builds. The
1897 * allocation limits feature was removed in Honeycomb. This
1898 * method exists for compatibility and always returns -1 and has
1899 * no effect.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001900 *
Carl Shapiro11073832011-01-12 16:28:57 -08001901 * @deprecated This method is now obsolete.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001902 */
Carl Shapiro11073832011-01-12 16:28:57 -08001903 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001904 public static int setAllocationLimit(int limit) {
Carl Shapiro11073832011-01-12 16:28:57 -08001905 return -1;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001906 }
1907
1908 /**
Carl Shapiro11073832011-01-12 16:28:57 -08001909 * Establish a global object allocation limit. This feature was
Carl Shapiro7e942842011-01-12 17:17:45 -08001910 * never enabled in release builds. The allocation limits feature
1911 * was removed in Honeycomb. This method exists for compatibility
1912 * and always returns -1 and has no effect.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001913 *
Carl Shapiro11073832011-01-12 16:28:57 -08001914 * @deprecated This method is now obsolete.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001915 */
Carl Shapiro11073832011-01-12 16:28:57 -08001916 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001917 public static int setGlobalAllocationLimit(int limit) {
Carl Shapiro11073832011-01-12 16:28:57 -08001918 return -1;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001919 }
1920
1921 /**
1922 * Dump a list of all currently loaded class to the log file.
1923 *
1924 * @param flags See constants above.
1925 */
1926 public static void printLoadedClasses(int flags) {
1927 VMDebug.printLoadedClasses(flags);
1928 }
1929
1930 /**
1931 * Get the number of loaded classes.
1932 * @return the number of loaded classes.
1933 */
1934 public static int getLoadedClassCount() {
1935 return VMDebug.getLoadedClassCount();
1936 }
1937
1938 /**
Andy McFadden824c5102010-07-09 16:26:57 -07001939 * Dump "hprof" data to the specified file. This may cause a GC.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001940 *
1941 * @param fileName Full pathname of output file (e.g. "/sdcard/dump.hprof").
1942 * @throws UnsupportedOperationException if the VM was built without
1943 * HPROF support.
1944 * @throws IOException if an error occurs while opening or writing files.
1945 */
1946 public static void dumpHprofData(String fileName) throws IOException {
1947 VMDebug.dumpHprofData(fileName);
1948 }
1949
1950 /**
Andy McFadden824c5102010-07-09 16:26:57 -07001951 * Like dumpHprofData(String), but takes an already-opened
1952 * FileDescriptor to which the trace is written. The file name is also
1953 * supplied simply for logging. Makes a dup of the file descriptor.
1954 *
1955 * Primarily for use by the "am" shell command.
1956 *
1957 * @hide
1958 */
1959 public static void dumpHprofData(String fileName, FileDescriptor fd)
1960 throws IOException {
1961 VMDebug.dumpHprofData(fileName, fd);
1962 }
1963
1964 /**
1965 * Collect "hprof" and send it to DDMS. This may cause a GC.
Andy McFadden07a96612010-01-28 16:54:37 -08001966 *
1967 * @throws UnsupportedOperationException if the VM was built without
1968 * HPROF support.
Andy McFadden07a96612010-01-28 16:54:37 -08001969 * @hide
1970 */
1971 public static void dumpHprofDataDdms() {
1972 VMDebug.dumpHprofDataDdms();
1973 }
1974
1975 /**
Andy McFadden06a6b552010-07-13 16:28:09 -07001976 * Writes native heap data to the specified file descriptor.
1977 *
1978 * @hide
1979 */
Andrei Onea24ec3212019-03-15 17:35:05 +00001980 @UnsupportedAppUsage
Andy McFadden06a6b552010-07-13 16:28:09 -07001981 public static native void dumpNativeHeap(FileDescriptor fd);
1982
1983 /**
Christopher Ferris8d652f82017-04-11 16:29:18 -07001984 * Writes malloc info data to the specified file descriptor.
1985 *
1986 * @hide
1987 */
1988 public static native void dumpNativeMallocInfo(FileDescriptor fd);
1989
1990 /**
Brian Carlstromc21550a2010-10-05 21:34:06 -07001991 * Returns a count of the extant instances of a class.
1992 *
1993 * @hide
1994 */
Andrei Onea24ec3212019-03-15 17:35:05 +00001995 @UnsupportedAppUsage
Brian Carlstromc21550a2010-10-05 21:34:06 -07001996 public static long countInstancesOfClass(Class cls) {
Brian Carlstrom7495cfa2010-11-30 18:06:00 -08001997 return VMDebug.countInstancesOfClass(cls, true);
Brian Carlstromc21550a2010-10-05 21:34:06 -07001998 }
1999
2000 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002001 * Returns the number of sent transactions from this process.
2002 * @return The number of sent transactions or -1 if it could not read t.
2003 */
2004 public static native int getBinderSentTransactions();
2005
2006 /**
2007 * Returns the number of received transactions from the binder driver.
2008 * @return The number of received transactions or -1 if it could not read the stats.
2009 */
2010 public static native int getBinderReceivedTransactions();
2011
2012 /**
2013 * Returns the number of active local Binder objects that exist in the
2014 * current process.
2015 */
2016 public static final native int getBinderLocalObjectCount();
2017
2018 /**
2019 * Returns the number of references to remote proxy Binder objects that
2020 * exist in the current process.
2021 */
2022 public static final native int getBinderProxyObjectCount();
2023
2024 /**
2025 * Returns the number of death notification links to Binder objects that
2026 * exist in the current process.
2027 */
2028 public static final native int getBinderDeathObjectCount();
2029
2030 /**
Andy McFadden599c9182009-04-08 00:35:56 -07002031 * Primes the register map cache.
2032 *
2033 * Only works for classes in the bootstrap class loader. Does not
2034 * cause classes to be loaded if they're not already present.
2035 *
2036 * The classAndMethodDesc argument is a concatentation of the VM-internal
2037 * class descriptor, method name, and method descriptor. Examples:
2038 * Landroid/os/Looper;.loop:()V
2039 * Landroid/app/ActivityThread;.main:([Ljava/lang/String;)V
2040 *
2041 * @param classAndMethodDesc the method to prepare
2042 *
2043 * @hide
2044 */
2045 public static final boolean cacheRegisterMap(String classAndMethodDesc) {
2046 return VMDebug.cacheRegisterMap(classAndMethodDesc);
2047 }
2048
2049 /**
Andy McFaddenbfd6d482009-10-22 17:25:57 -07002050 * Dumps the contents of VM reference tables (e.g. JNI locals and
2051 * globals) to the log file.
2052 *
2053 * @hide
2054 */
Andrei Onea24ec3212019-03-15 17:35:05 +00002055 @UnsupportedAppUsage
Andy McFaddenbfd6d482009-10-22 17:25:57 -07002056 public static final void dumpReferenceTables() {
2057 VMDebug.dumpReferenceTables();
2058 }
2059
2060 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002061 * API for gathering and querying instruction counts.
2062 *
2063 * Example usage:
Chet Haase2970c492010-11-09 13:58:04 -08002064 * <pre>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002065 * Debug.InstructionCount icount = new Debug.InstructionCount();
2066 * icount.resetAndStart();
2067 * [... do lots of stuff ...]
2068 * if (icount.collect()) {
2069 * System.out.println("Total instructions executed: "
2070 * + icount.globalTotal());
2071 * System.out.println("Method invocations: "
2072 * + icount.globalMethodInvocations());
2073 * }
Chet Haase2970c492010-11-09 13:58:04 -08002074 * </pre>
Jeff Hao7d0b3d42014-09-17 15:45:05 -07002075 *
2076 * @deprecated Instruction counting is no longer supported.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002077 */
Jeff Hao7d0b3d42014-09-17 15:45:05 -07002078 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002079 public static class InstructionCount {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002080 public InstructionCount() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002081 }
2082
2083 /**
2084 * Reset counters and ensure counts are running. Counts may
2085 * have already been running.
2086 *
2087 * @return true if counting was started
2088 */
2089 public boolean resetAndStart() {
Narayan Kamath19541e82017-05-30 18:04:36 +01002090 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002091 }
2092
2093 /**
2094 * Collect instruction counts. May or may not stop the
2095 * counting process.
2096 */
2097 public boolean collect() {
Narayan Kamath19541e82017-05-30 18:04:36 +01002098 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002099 }
2100
2101 /**
2102 * Return the total number of instructions executed globally (i.e. in
2103 * all threads).
2104 */
2105 public int globalTotal() {
Narayan Kamath19541e82017-05-30 18:04:36 +01002106 return 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002107 }
2108
2109 /**
2110 * Return the total number of method-invocation instructions
2111 * executed globally.
2112 */
2113 public int globalMethodInvocations() {
Narayan Kamath19541e82017-05-30 18:04:36 +01002114 return 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002115 }
Dave Bort1ce5bd32009-04-22 17:36:56 -07002116 }
2117
Dave Bort1ce5bd32009-04-22 17:36:56 -07002118 /**
2119 * A Map of typed debug properties.
2120 */
2121 private static final TypedProperties debugProperties;
2122
2123 /*
2124 * Load the debug properties from the standard files into debugProperties.
2125 */
2126 static {
Joe Onorato43a17652011-04-06 19:22:23 -07002127 if (false) {
Dave Bort1ce5bd32009-04-22 17:36:56 -07002128 final String TAG = "DebugProperties";
2129 final String[] files = { "/system/debug.prop", "/debug.prop", "/data/debug.prop" };
2130 final TypedProperties tp = new TypedProperties();
2131
2132 // Read the properties from each of the files, if present.
Dave Borte9bfd9b2009-05-04 14:35:23 -07002133 for (String file : files) {
Dave Bort1ce5bd32009-04-22 17:36:56 -07002134 Reader r;
2135 try {
2136 r = new FileReader(file);
2137 } catch (FileNotFoundException ex) {
2138 // It's ok if a file is missing.
2139 continue;
2140 }
2141
Dave Bort1ce5bd32009-04-22 17:36:56 -07002142 try {
2143 tp.load(r);
Dave Borte9bfd9b2009-05-04 14:35:23 -07002144 } catch (Exception ex) {
2145 throw new RuntimeException("Problem loading " + file, ex);
2146 } finally {
2147 try {
2148 r.close();
2149 } catch (IOException ex) {
2150 // Ignore this error.
2151 }
Dave Bort1ce5bd32009-04-22 17:36:56 -07002152 }
2153 }
2154
2155 debugProperties = tp.isEmpty() ? null : tp;
2156 } else {
2157 debugProperties = null;
2158 }
2159 }
2160
2161
2162 /**
2163 * Returns true if the type of the field matches the specified class.
2164 * Handles the case where the class is, e.g., java.lang.Boolean, but
2165 * the field is of the primitive "boolean" type. Also handles all of
2166 * the java.lang.Number subclasses.
2167 */
2168 private static boolean fieldTypeMatches(Field field, Class<?> cl) {
2169 Class<?> fieldClass = field.getType();
2170 if (fieldClass == cl) {
2171 return true;
2172 }
2173 Field primitiveTypeField;
2174 try {
2175 /* All of the classes we care about (Boolean, Integer, etc.)
2176 * have a Class field called "TYPE" that points to the corresponding
2177 * primitive class.
2178 */
2179 primitiveTypeField = cl.getField("TYPE");
2180 } catch (NoSuchFieldException ex) {
2181 return false;
2182 }
2183 try {
Dave Borte9bfd9b2009-05-04 14:35:23 -07002184 return fieldClass == (Class<?>) primitiveTypeField.get(null);
Dave Bort1ce5bd32009-04-22 17:36:56 -07002185 } catch (IllegalAccessException ex) {
2186 return false;
2187 }
2188 }
2189
2190
2191 /**
2192 * Looks up the property that corresponds to the field, and sets the field's value
2193 * if the types match.
2194 */
Dave Borte9bfd9b2009-05-04 14:35:23 -07002195 private static void modifyFieldIfSet(final Field field, final TypedProperties properties,
2196 final String propertyName) {
Dave Bort1ce5bd32009-04-22 17:36:56 -07002197 if (field.getType() == java.lang.String.class) {
Dave Borte9bfd9b2009-05-04 14:35:23 -07002198 int stringInfo = properties.getStringInfo(propertyName);
Dave Bort1ce5bd32009-04-22 17:36:56 -07002199 switch (stringInfo) {
Dave Borte9bfd9b2009-05-04 14:35:23 -07002200 case TypedProperties.STRING_SET:
2201 // Handle as usual below.
2202 break;
2203 case TypedProperties.STRING_NULL:
2204 try {
2205 field.set(null, null); // null object for static fields; null string
2206 } catch (IllegalAccessException ex) {
2207 throw new IllegalArgumentException(
2208 "Cannot set field for " + propertyName, ex);
2209 }
2210 return;
2211 case TypedProperties.STRING_NOT_SET:
2212 return;
2213 case TypedProperties.STRING_TYPE_MISMATCH:
Dave Bort1ce5bd32009-04-22 17:36:56 -07002214 throw new IllegalArgumentException(
Dave Borte9bfd9b2009-05-04 14:35:23 -07002215 "Type of " + propertyName + " " +
2216 " does not match field type (" + field.getType() + ")");
2217 default:
2218 throw new IllegalStateException(
2219 "Unexpected getStringInfo(" + propertyName + ") return value " +
2220 stringInfo);
Dave Bort1ce5bd32009-04-22 17:36:56 -07002221 }
2222 }
Dave Borte9bfd9b2009-05-04 14:35:23 -07002223 Object value = properties.get(propertyName);
Dave Bort1ce5bd32009-04-22 17:36:56 -07002224 if (value != null) {
2225 if (!fieldTypeMatches(field, value.getClass())) {
2226 throw new IllegalArgumentException(
2227 "Type of " + propertyName + " (" + value.getClass() + ") " +
2228 " does not match field type (" + field.getType() + ")");
2229 }
2230 try {
2231 field.set(null, value); // null object for static fields
2232 } catch (IllegalAccessException ex) {
2233 throw new IllegalArgumentException(
2234 "Cannot set field for " + propertyName, ex);
2235 }
2236 }
2237 }
2238
2239
2240 /**
Romain Guyc4b11a72009-05-13 15:46:37 -07002241 * Equivalent to <code>setFieldsOn(cl, false)</code>.
2242 *
2243 * @see #setFieldsOn(Class, boolean)
Romain Guyd4103d02009-05-14 12:24:21 -07002244 *
2245 * @hide
Romain Guyc4b11a72009-05-13 15:46:37 -07002246 */
2247 public static void setFieldsOn(Class<?> cl) {
2248 setFieldsOn(cl, false);
2249 }
2250
2251 /**
Dave Bort1ce5bd32009-04-22 17:36:56 -07002252 * Reflectively sets static fields of a class based on internal debugging
Joe Onorato43a17652011-04-06 19:22:23 -07002253 * properties. This method is a no-op if false is
Dave Bort1ce5bd32009-04-22 17:36:56 -07002254 * false.
2255 * <p>
Joe Onorato43a17652011-04-06 19:22:23 -07002256 * <strong>NOTE TO APPLICATION DEVELOPERS</strong>: false will
Dave Bort1ce5bd32009-04-22 17:36:56 -07002257 * always be false in release builds. This API is typically only useful
2258 * for platform developers.
2259 * </p>
2260 * Class setup: define a class whose only fields are non-final, static
2261 * primitive types (except for "char") or Strings. In a static block
2262 * after the field definitions/initializations, pass the class to
Romain Guyc4b11a72009-05-13 15:46:37 -07002263 * this method, Debug.setFieldsOn(). Example:
Dave Bort1ce5bd32009-04-22 17:36:56 -07002264 * <pre>
2265 * package com.example;
2266 *
2267 * import android.os.Debug;
2268 *
2269 * public class MyDebugVars {
2270 * public static String s = "a string";
2271 * public static String s2 = "second string";
2272 * public static String ns = null;
2273 * public static boolean b = false;
2274 * public static int i = 5;
Romain Guyc4b11a72009-05-13 15:46:37 -07002275 * @Debug.DebugProperty
Dave Bort1ce5bd32009-04-22 17:36:56 -07002276 * public static float f = 0.1f;
Romain Guyc4b11a72009-05-13 15:46:37 -07002277 * @@Debug.DebugProperty
Dave Bort1ce5bd32009-04-22 17:36:56 -07002278 * public static double d = 0.5d;
2279 *
2280 * // This MUST appear AFTER all fields are defined and initialized!
2281 * static {
Romain Guyc4b11a72009-05-13 15:46:37 -07002282 * // Sets all the fields
Dave Borte9bfd9b2009-05-04 14:35:23 -07002283 * Debug.setFieldsOn(MyDebugVars.class);
Christian Mehlmauer798e2d32010-06-17 18:24:07 +02002284 *
Romain Guyc4b11a72009-05-13 15:46:37 -07002285 * // Sets only the fields annotated with @Debug.DebugProperty
2286 * // Debug.setFieldsOn(MyDebugVars.class, true);
Dave Bort1ce5bd32009-04-22 17:36:56 -07002287 * }
2288 * }
2289 * </pre>
Dave Borte9bfd9b2009-05-04 14:35:23 -07002290 * setFieldsOn() may override the value of any field in the class based
Dave Bort1ce5bd32009-04-22 17:36:56 -07002291 * on internal properties that are fixed at boot time.
2292 * <p>
2293 * These properties are only set during platform debugging, and are not
2294 * meant to be used as a general-purpose properties store.
2295 *
2296 * {@hide}
2297 *
2298 * @param cl The class to (possibly) modify
Romain Guyc4b11a72009-05-13 15:46:37 -07002299 * @param partial If false, sets all static fields, otherwise, only set
2300 * fields with the {@link android.os.Debug.DebugProperty}
2301 * annotation
Dave Bort1ce5bd32009-04-22 17:36:56 -07002302 * @throws IllegalArgumentException if any fields are final or non-static,
2303 * or if the type of the field does not match the type of
2304 * the internal debugging property value.
2305 */
Romain Guyc4b11a72009-05-13 15:46:37 -07002306 public static void setFieldsOn(Class<?> cl, boolean partial) {
Joe Onorato43a17652011-04-06 19:22:23 -07002307 if (false) {
Dave Bort1ce5bd32009-04-22 17:36:56 -07002308 if (debugProperties != null) {
2309 /* Only look for fields declared directly by the class,
2310 * so we don't mysteriously change static fields in superclasses.
2311 */
2312 for (Field field : cl.getDeclaredFields()) {
Romain Guyc4b11a72009-05-13 15:46:37 -07002313 if (!partial || field.getAnnotation(DebugProperty.class) != null) {
2314 final String propertyName = cl.getName() + "." + field.getName();
2315 boolean isStatic = Modifier.isStatic(field.getModifiers());
2316 boolean isFinal = Modifier.isFinal(field.getModifiers());
2317
2318 if (!isStatic || isFinal) {
2319 throw new IllegalArgumentException(propertyName +
2320 " must be static and non-final");
2321 }
2322 modifyFieldIfSet(field, debugProperties, propertyName);
Dave Bort1ce5bd32009-04-22 17:36:56 -07002323 }
Dave Bort1ce5bd32009-04-22 17:36:56 -07002324 }
2325 }
2326 } else {
Dan Egnor3eda9792010-03-05 13:28:36 -08002327 Log.wtf(TAG,
Dave Borte9bfd9b2009-05-04 14:35:23 -07002328 "setFieldsOn(" + (cl == null ? "null" : cl.getName()) +
Dave Bort1ce5bd32009-04-22 17:36:56 -07002329 ") called in non-DEBUG build");
2330 }
2331 }
Romain Guyc4b11a72009-05-13 15:46:37 -07002332
2333 /**
2334 * Annotation to put on fields you want to set with
2335 * {@link Debug#setFieldsOn(Class, boolean)}.
2336 *
2337 * @hide
2338 */
2339 @Target({ ElementType.FIELD })
2340 @Retention(RetentionPolicy.RUNTIME)
2341 public @interface DebugProperty {
2342 }
Dan Egnor3eda9792010-03-05 13:28:36 -08002343
2344 /**
2345 * Get a debugging dump of a system service by name.
2346 *
2347 * <p>Most services require the caller to hold android.permission.DUMP.
2348 *
2349 * @param name of the service to dump
2350 * @param fd to write dump output to (usually an output log file)
2351 * @param args to pass to the service's dump method, may be null
2352 * @return true if the service was dumped successfully, false if
2353 * the service could not be found or had an error while dumping
2354 */
2355 public static boolean dumpService(String name, FileDescriptor fd, String[] args) {
2356 IBinder service = ServiceManager.getService(name);
2357 if (service == null) {
2358 Log.e(TAG, "Can't find service to dump: " + name);
2359 return false;
2360 }
2361
2362 try {
2363 service.dump(fd, args);
2364 return true;
2365 } catch (RemoteException e) {
2366 Log.e(TAG, "Can't dump service: " + name, e);
2367 return false;
2368 }
2369 }
Craig Mautnera51a9562012-04-17 17:05:26 -07002370
2371 /**
Narayan Kamathf013daa2017-05-09 12:55:02 +01002372 * Append the Java stack traces of a given native process to a specified file.
2373 *
songjinshie02e3ea2016-12-16 17:48:21 +08002374 * @param pid pid to dump.
2375 * @param file path of file to append dump to.
2376 * @param timeoutSecs time to wait in seconds, or 0 to wait forever.
Dianne Hackbornf72467a2012-06-08 17:23:59 -07002377 * @hide
2378 */
Narayan Kamathf013daa2017-05-09 12:55:02 +01002379 public static native boolean dumpJavaBacktraceToFileTimeout(int pid, String file,
2380 int timeoutSecs);
2381
2382 /**
2383 * Append the native stack traces of a given process to a specified file.
2384 *
2385 * @param pid pid to dump.
2386 * @param file path of file to append dump to.
2387 * @param timeoutSecs time to wait in seconds, or 0 to wait forever.
2388 * @hide
2389 */
2390 public static native boolean dumpNativeBacktraceToFileTimeout(int pid, String file,
2391 int timeoutSecs);
Dianne Hackbornf72467a2012-06-08 17:23:59 -07002392
2393 /**
Colin Crossc4fb5f92016-02-02 16:51:15 -08002394 * Get description of unreachable native memory.
2395 * @param limit the number of leaks to provide info on, 0 to only get a summary.
2396 * @param contents true to include a hex dump of the contents of unreachable memory.
2397 * @return the String containing a description of unreachable memory.
2398 * @hide */
2399 public static native String getUnreachableMemory(int limit, boolean contents);
2400
2401 /**
Craig Mautnera51a9562012-04-17 17:05:26 -07002402 * Return a String describing the calling method and location at a particular stack depth.
Anwar Ghuloum3a8ce1b2013-04-26 16:18:28 -07002403 * @param callStack the Thread stack
Craig Mautnera51a9562012-04-17 17:05:26 -07002404 * @param depth the depth of stack to return information for.
2405 * @return the String describing the caller at that depth.
2406 */
2407 private static String getCaller(StackTraceElement callStack[], int depth) {
2408 // callStack[4] is the caller of the method that called getCallers()
2409 if (4 + depth >= callStack.length) {
2410 return "<bottom of call stack>";
2411 }
2412 StackTraceElement caller = callStack[4 + depth];
2413 return caller.getClassName() + "." + caller.getMethodName() + ":" + caller.getLineNumber();
2414 }
2415
2416 /**
2417 * Return a string consisting of methods and locations at multiple call stack levels.
2418 * @param depth the number of levels to return, starting with the immediate caller.
2419 * @return a string describing the call stack.
2420 * {@hide}
2421 */
Andrei Onea24ec3212019-03-15 17:35:05 +00002422 @UnsupportedAppUsage
Craig Mautnera51a9562012-04-17 17:05:26 -07002423 public static String getCallers(final int depth) {
2424 final StackTraceElement[] callStack = Thread.currentThread().getStackTrace();
2425 StringBuffer sb = new StringBuffer();
2426 for (int i = 0; i < depth; i++) {
2427 sb.append(getCaller(callStack, i)).append(" ");
2428 }
2429 return sb.toString();
2430 }
2431
2432 /**
Dianne Hackbornfd6c7b12013-10-03 10:42:26 -07002433 * Return a string consisting of methods and locations at multiple call stack levels.
2434 * @param depth the number of levels to return, starting with the immediate caller.
2435 * @return a string describing the call stack.
2436 * {@hide}
2437 */
2438 public static String getCallers(final int start, int depth) {
2439 final StackTraceElement[] callStack = Thread.currentThread().getStackTrace();
2440 StringBuffer sb = new StringBuffer();
2441 depth += start;
2442 for (int i = start; i < depth; i++) {
2443 sb.append(getCaller(callStack, i)).append(" ");
2444 }
2445 return sb.toString();
2446 }
2447
2448 /**
Dianne Hackbornef03a7f2012-10-29 18:46:52 -07002449 * Like {@link #getCallers(int)}, but each location is append to the string
2450 * as a new line with <var>linePrefix</var> in front of it.
2451 * @param depth the number of levels to return, starting with the immediate caller.
2452 * @param linePrefix prefix to put in front of each location.
2453 * @return a string describing the call stack.
2454 * {@hide}
2455 */
2456 public static String getCallers(final int depth, String linePrefix) {
2457 final StackTraceElement[] callStack = Thread.currentThread().getStackTrace();
2458 StringBuffer sb = new StringBuffer();
2459 for (int i = 0; i < depth; i++) {
2460 sb.append(linePrefix).append(getCaller(callStack, i)).append("\n");
2461 }
2462 return sb.toString();
2463 }
2464
2465 /**
Ian Rogersfe067a42013-02-22 19:59:23 -08002466 * @return a String describing the immediate caller of the calling method.
Craig Mautnera51a9562012-04-17 17:05:26 -07002467 * {@hide}
2468 */
Andrei Onea24ec3212019-03-15 17:35:05 +00002469 @UnsupportedAppUsage
Craig Mautnera51a9562012-04-17 17:05:26 -07002470 public static String getCaller() {
2471 return getCaller(Thread.currentThread().getStackTrace(), 0);
2472 }
Philip P. Moltmannfd8ed852017-11-01 15:22:02 -07002473
2474 /**
Andreas Gampe571b7002018-01-16 15:11:29 -08002475 * Attach a library as a jvmti agent to the current runtime, with the given classloader
2476 * determining the library search path.
2477 * <p>
2478 * Note: agents may only be attached to debuggable apps. Otherwise, this function will
2479 * throw a SecurityException.
Philip P. Moltmannfd8ed852017-11-01 15:22:02 -07002480 *
Andreas Gampe571b7002018-01-16 15:11:29 -08002481 * @param library the library containing the agent.
2482 * @param options the options passed to the agent.
2483 * @param classLoader the classloader determining the library search path.
Philip P. Moltmannfd8ed852017-11-01 15:22:02 -07002484 *
Andreas Gampe571b7002018-01-16 15:11:29 -08002485 * @throws IOException if the agent could not be attached.
2486 * @throws SecurityException if the app is not debuggable.
Philip P. Moltmannfd8ed852017-11-01 15:22:02 -07002487 */
Andreas Gampe571b7002018-01-16 15:11:29 -08002488 public static void attachJvmtiAgent(@NonNull String library, @Nullable String options,
2489 @Nullable ClassLoader classLoader) throws IOException {
Philip P. Moltmannfd8ed852017-11-01 15:22:02 -07002490 Preconditions.checkNotNull(library);
2491 Preconditions.checkArgument(!library.contains("="));
2492
2493 if (options == null) {
Andreas Gampe571b7002018-01-16 15:11:29 -08002494 VMDebug.attachAgent(library, classLoader);
Philip P. Moltmannfd8ed852017-11-01 15:22:02 -07002495 } else {
Andreas Gampe571b7002018-01-16 15:11:29 -08002496 VMDebug.attachAgent(library + "=" + options, classLoader);
Philip P. Moltmannfd8ed852017-11-01 15:22:02 -07002497 }
2498 }
Ben Murdochfdc55932019-01-30 10:43:15 +00002499
2500 /**
2501 * Return the current free ZRAM usage in kilobytes.
2502 *
2503 * @hide
2504 */
2505 public static native long getZramFreeKb();
Suren Baghdasaryan5911b9ef2019-11-25 19:24:46 -08002506
2507 /**
2508 * Return memory size in kilobytes allocated for ION heaps.
2509 *
2510 * @hide
2511 */
2512 public static native long getIonHeapsSizeKb();
2513
2514 /**
2515 * Return memory size in kilobytes allocated for ION pools.
2516 *
2517 * @hide
2518 */
2519 public static native long getIonPoolsSizeKb();
2520
2521 /**
2522 * Return ION memory mapped by processes in kB.
2523 * Notes:
2524 * * Warning: Might impact performance as it reads /proc/<pid>/maps files for each process.
2525 *
2526 * @hide
2527 */
2528 public static native long getIonMappedSizeKb();
Suren Baghdasaryan2018bf02019-12-18 09:52:42 -08002529
2530 /**
2531 * Return whether virtually-mapped kernel stacks are enabled (CONFIG_VMAP_STACK).
2532 * Note: caller needs config_gz read sepolicy permission
2533 *
2534 * @hide
2535 */
2536 public static native boolean isVmapStack();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002537}