275 lines
11 KiB
Java
275 lines
11 KiB
Java
/*
|
|
* Copyright 2017 The Android Open Source Project
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
package android.webkit;
|
|
|
|
import android.annotation.IntDef;
|
|
import android.annotation.NonNull;
|
|
|
|
import java.lang.annotation.Retention;
|
|
import java.lang.annotation.RetentionPolicy;
|
|
import java.util.ArrayList;
|
|
import java.util.Collection;
|
|
import java.util.List;
|
|
|
|
/**
|
|
* Holds tracing configuration information and predefined settings.
|
|
*/
|
|
public class TracingConfig {
|
|
|
|
private @PredefinedCategories int mPredefinedCategories;
|
|
private final List<String> mCustomIncludedCategories = new ArrayList<String>();
|
|
private @TracingMode int mTracingMode;
|
|
|
|
/** @hide */
|
|
@IntDef(flag = true, value = {CATEGORIES_NONE, CATEGORIES_ALL, CATEGORIES_ANDROID_WEBVIEW,
|
|
CATEGORIES_WEB_DEVELOPER, CATEGORIES_INPUT_LATENCY, CATEGORIES_RENDERING,
|
|
CATEGORIES_JAVASCRIPT_AND_RENDERING, CATEGORIES_FRAME_VIEWER})
|
|
@Retention(RetentionPolicy.SOURCE)
|
|
public @interface PredefinedCategories {}
|
|
|
|
/**
|
|
* Indicates that there are no predefined categories.
|
|
*/
|
|
public static final int CATEGORIES_NONE = 0;
|
|
|
|
/**
|
|
* Predefined set of categories, includes all categories enabled by default in chromium.
|
|
* Use with caution: this setting may produce large trace output.
|
|
*/
|
|
public static final int CATEGORIES_ALL = 1 << 0;
|
|
|
|
/**
|
|
* Predefined set of categories typically useful for analyzing WebViews.
|
|
* Typically includes "android_webview" and "Java" categories.
|
|
*/
|
|
public static final int CATEGORIES_ANDROID_WEBVIEW = 1 << 1;
|
|
|
|
/**
|
|
* Predefined set of categories typically useful for web developers.
|
|
* Typically includes "blink", "compositor", "renderer.scheduler" and "v8" categories.
|
|
*/
|
|
public static final int CATEGORIES_WEB_DEVELOPER = 1 << 2;
|
|
|
|
/**
|
|
* Predefined set of categories for analyzing input latency issues.
|
|
* Typically includes "input", "renderer.scheduler" categories.
|
|
*/
|
|
public static final int CATEGORIES_INPUT_LATENCY = 1 << 3;
|
|
|
|
/**
|
|
* Predefined set of categories for analyzing rendering issues.
|
|
* Typically includes "blink", "compositor" and "gpu" categories.
|
|
*/
|
|
public static final int CATEGORIES_RENDERING = 1 << 4;
|
|
|
|
/**
|
|
* Predefined set of categories for analyzing javascript and rendering issues.
|
|
* Typically includes "blink", "compositor", "gpu", "renderer.scheduler" and "v8" categories.
|
|
*/
|
|
public static final int CATEGORIES_JAVASCRIPT_AND_RENDERING = 1 << 5;
|
|
|
|
/**
|
|
* Predefined set of categories for studying difficult rendering performance problems.
|
|
* Typically includes "blink", "compositor", "gpu", "renderer.scheduler", "v8" and
|
|
* some other compositor categories which are disabled by default.
|
|
*/
|
|
public static final int CATEGORIES_FRAME_VIEWER = 1 << 6;
|
|
|
|
/** @hide */
|
|
@IntDef({RECORD_UNTIL_FULL, RECORD_CONTINUOUSLY})
|
|
@Retention(RetentionPolicy.SOURCE)
|
|
public @interface TracingMode {}
|
|
|
|
/**
|
|
* Record trace events until the internal tracing buffer is full.
|
|
*
|
|
* Typically the buffer memory usage is larger than {@link #RECORD_CONTINUOUSLY}.
|
|
* Depending on the implementation typically allows up to 256k events to be stored.
|
|
*/
|
|
public static final int RECORD_UNTIL_FULL = 0;
|
|
|
|
/**
|
|
* Record trace events continuously using an internal ring buffer. Default tracing mode.
|
|
*
|
|
* Overwrites old events if they exceed buffer capacity. Uses less memory than the
|
|
* {@link #RECORD_UNTIL_FULL} mode. Depending on the implementation typically allows
|
|
* up to 64k events to be stored.
|
|
*/
|
|
public static final int RECORD_CONTINUOUSLY = 1;
|
|
|
|
/**
|
|
* @hide
|
|
*/
|
|
public TracingConfig(@PredefinedCategories int predefinedCategories,
|
|
@NonNull List<String> customIncludedCategories,
|
|
@TracingMode int tracingMode) {
|
|
mPredefinedCategories = predefinedCategories;
|
|
mCustomIncludedCategories.addAll(customIncludedCategories);
|
|
mTracingMode = tracingMode;
|
|
}
|
|
|
|
/**
|
|
* Returns a bitmask of the predefined category sets of this configuration.
|
|
*
|
|
* @return Bitmask of predefined category sets.
|
|
*/
|
|
@PredefinedCategories
|
|
public int getPredefinedCategories() {
|
|
return mPredefinedCategories;
|
|
}
|
|
|
|
/**
|
|
* Returns the list of included custom category patterns for this configuration.
|
|
*
|
|
* @return Empty list if no custom category patterns are specified.
|
|
*/
|
|
@NonNull
|
|
public List<String> getCustomIncludedCategories() {
|
|
return mCustomIncludedCategories;
|
|
}
|
|
|
|
/**
|
|
* Returns the tracing mode of this configuration.
|
|
*
|
|
* @return The tracing mode of this configuration.
|
|
*/
|
|
@TracingMode
|
|
public int getTracingMode() {
|
|
return mTracingMode;
|
|
}
|
|
|
|
/**
|
|
* Builder used to create {@link TracingConfig} objects.
|
|
* <p>
|
|
* Examples:
|
|
* <pre class="prettyprint">
|
|
* // Create a configuration with default options: {@link #CATEGORIES_NONE},
|
|
* // {@link #RECORD_CONTINUOUSLY}.
|
|
* <code>new TracingConfig.Builder().build()</code>
|
|
*
|
|
* // Record trace events from the "web developer" predefined category sets.
|
|
* // Uses a ring buffer (the default {@link #RECORD_CONTINUOUSLY} mode) for
|
|
* // internal storage during tracing.
|
|
* <code>new TracingConfig.Builder().addCategories(CATEGORIES_WEB_DEVELOPER).build()</code>
|
|
*
|
|
* // Record trace events from the "rendering" and "input latency" predefined
|
|
* // category sets.
|
|
* <code>new TracingConfig.Builder().addCategories(CATEGORIES_RENDERING,
|
|
* CATEGORIES_INPUT_LATENCY).build()</code>
|
|
*
|
|
* // Record only the trace events from the "browser" category.
|
|
* <code>new TracingConfig.Builder().addCategories("browser").build()</code>
|
|
*
|
|
* // Record only the trace events matching the "blink*" and "renderer*" patterns
|
|
* // (e.g. "blink.animations", "renderer_host" and "renderer.scheduler" categories).
|
|
* <code>new TracingConfig.Builder().addCategories("blink*","renderer*").build()</code>
|
|
*
|
|
* // Record events from the "web developer" predefined category set and events from
|
|
* // the "disabled-by-default-v8.gc" category to understand where garbage collection
|
|
* // is being triggered. Uses a limited size buffer for internal storage during tracing.
|
|
* <code>new TracingConfig.Builder().addCategories(CATEGORIES_WEB_DEVELOPER)
|
|
* .addCategories("disabled-by-default-v8.gc")
|
|
* .setTracingMode(RECORD_UNTIL_FULL).build()</code>
|
|
* </pre>
|
|
*/
|
|
public static class Builder {
|
|
private @PredefinedCategories int mPredefinedCategories = CATEGORIES_NONE;
|
|
private final List<String> mCustomIncludedCategories = new ArrayList<String>();
|
|
private @TracingMode int mTracingMode = RECORD_CONTINUOUSLY;
|
|
|
|
/**
|
|
* Default constructor for Builder.
|
|
*/
|
|
public Builder() {}
|
|
|
|
/**
|
|
* Build {@link TracingConfig} using the current settings.
|
|
*
|
|
* @return The {@link TracingConfig} with the current settings.
|
|
*/
|
|
public TracingConfig build() {
|
|
return new TracingConfig(mPredefinedCategories, mCustomIncludedCategories,
|
|
mTracingMode);
|
|
}
|
|
|
|
/**
|
|
* Adds predefined sets of categories to be included in the trace output.
|
|
*
|
|
* A predefined category set can be one of {@link #CATEGORIES_NONE},
|
|
* {@link #CATEGORIES_ALL}, {@link #CATEGORIES_ANDROID_WEBVIEW},
|
|
* {@link #CATEGORIES_WEB_DEVELOPER}, {@link #CATEGORIES_INPUT_LATENCY},
|
|
* {@link #CATEGORIES_RENDERING}, {@link #CATEGORIES_JAVASCRIPT_AND_RENDERING} or
|
|
* {@link #CATEGORIES_FRAME_VIEWER}.
|
|
*
|
|
* @param predefinedCategories A list or bitmask of predefined category sets.
|
|
* @return The builder to facilitate chaining.
|
|
*/
|
|
public Builder addCategories(@PredefinedCategories int... predefinedCategories) {
|
|
for (int categorySet : predefinedCategories) {
|
|
mPredefinedCategories |= categorySet;
|
|
}
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Adds custom categories to be included in trace output.
|
|
*
|
|
* Note that the categories are defined by the currently-in-use version of WebView. They
|
|
* live in chromium code and are not part of the Android API.
|
|
* See <a href="https://www.chromium.org/developers/how-tos/trace-event-profiling-tool">
|
|
* chromium documentation on tracing</a> for more details.
|
|
*
|
|
* @param categories A list of category patterns. A category pattern can contain wildcards,
|
|
* e.g. "blink*" or full category name e.g. "renderer.scheduler".
|
|
* @return The builder to facilitate chaining.
|
|
*/
|
|
public Builder addCategories(String... categories) {
|
|
for (String category: categories) {
|
|
mCustomIncludedCategories.add(category);
|
|
}
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Adds custom categories to be included in trace output.
|
|
*
|
|
* Same as {@link #addCategories(String...)} but allows to pass a Collection as a parameter.
|
|
*
|
|
* @param categories A list of category patterns.
|
|
* @return The builder to facilitate chaining.
|
|
*/
|
|
public Builder addCategories(Collection<String> categories) {
|
|
mCustomIncludedCategories.addAll(categories);
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Sets the tracing mode for this configuration.
|
|
* When tracingMode is not set explicitly, the default is {@link #RECORD_CONTINUOUSLY}.
|
|
*
|
|
* @param tracingMode The tracing mode to use, one of {@link #RECORD_UNTIL_FULL} or
|
|
* {@link #RECORD_CONTINUOUSLY}.
|
|
* @return The builder to facilitate chaining.
|
|
*/
|
|
public Builder setTracingMode(@TracingMode int tracingMode) {
|
|
mTracingMode = tracingMode;
|
|
return this;
|
|
}
|
|
}
|
|
|
|
}
|