summaryrefslogtreecommitdiff
path: root/java/com/android/dialer/strictmode
diff options
context:
space:
mode:
authorwangqi <wangqi@google.com>2017-09-27 10:13:49 -0700
committerEric Erfanian <erfanian@google.com>2017-09-28 08:33:56 -0700
commite37d60c2e304c599118a59e15ba4991f41cee785 (patch)
treeb1540b7210b312f8f47e31a2398130fd8850685e /java/com/android/dialer/strictmode
parentc3c6126757e3b185587909e6ac9c7c6e897df4f9 (diff)
Refactor DialerStrictMode into an interface.
-bypassed violations are no longer logged in AospDialer The default implementation will use system strict mode and crash on bugfood build same as before. Bug: 66003745 Test: manual PiperOrigin-RevId: 170214128 Change-Id: Iab630f19499e90b15eb0b7f0707b4a70c7d81fbe
Diffstat (limited to 'java/com/android/dialer/strictmode')
-rw-r--r--java/com/android/dialer/strictmode/DialerStrictMode.java125
-rw-r--r--java/com/android/dialer/strictmode/StrictModeComponent.java39
-rw-r--r--java/com/android/dialer/strictmode/StrictModeUtils.java132
-rw-r--r--java/com/android/dialer/strictmode/impl/SystemDialerStrictMode.java162
-rw-r--r--java/com/android/dialer/strictmode/impl/SystemStrictModeModule.java31
5 files changed, 287 insertions, 202 deletions
diff --git a/java/com/android/dialer/strictmode/DialerStrictMode.java b/java/com/android/dialer/strictmode/DialerStrictMode.java
index f895f7c46..462db573b 100644
--- a/java/com/android/dialer/strictmode/DialerStrictMode.java
+++ b/java/com/android/dialer/strictmode/DialerStrictMode.java
@@ -17,131 +17,12 @@
package com.android.dialer.strictmode;
import android.app.Application;
-import android.content.Context;
-import android.os.Handler;
-import android.os.Looper;
-import android.os.StrictMode;
-import android.os.StrictMode.ThreadPolicy;
-import android.os.StrictMode.VmPolicy;
-import android.preference.PreferenceManager;
-import android.support.annotation.AnyThread;
import android.support.annotation.MainThread;
-import android.support.v4.os.UserManagerCompat;
-import com.android.dialer.buildtype.BuildType;
-import com.android.dialer.function.Supplier;
-import com.android.dialer.util.DialerUtils;
-/** Enables strict mode for the application, and provides means of temporarily disabling it. */
-public final class DialerStrictMode {
-
- private static final VmPolicy VM_DEATH_PENALTY =
- new StrictMode.VmPolicy.Builder().penaltyLog().penaltyDeath().build();
-
- private static final ThreadPolicy THREAD_LOG_PENALTY =
- new StrictMode.ThreadPolicy.Builder().penaltyLog().build();
- private static final ThreadPolicy THREAD_DEATH_PENALTY =
- new StrictMode.ThreadPolicy.Builder().penaltyLog().penaltyDeath().build();
-
- private DialerStrictMode() {}
+/** Interface for strict mode to handle strict mode violations. */
+public interface DialerStrictMode {
/** Initializes strict mode on application start. */
@MainThread
- public static void onApplicationCreate(Application application) {
- if (isStrictModeAllowed()) {
- warmupSharedPrefs(application);
- StrictModeUtils.setRecommendedMainThreadPolicy(THREAD_DEATH_PENALTY);
- StrictModeUtils.setRecommendedVMPolicy(VM_DEATH_PENALTY);
-
- // Because Android resets StrictMode policies after Application.onCreate is done, we set it
- // again right after.
- // See cl/105932355 for the discussion.
- // See b/36951662 for the public bug.
- Handler handler = new Handler(Looper.myLooper());
- handler.postAtFrontOfQueue(
- () -> StrictModeUtils.setRecommendedMainThreadPolicy(THREAD_DEATH_PENALTY));
- }
- }
-
- /**
- * We frequently access shared preferences on the main thread, which causes strict mode
- * violations. When strict mode is allowed, warm up the shared preferences so that later uses of
- * shared preferences access the in-memory versions and we don't have to bypass strict mode at
- * every point in the application where shared preferences are accessed.
- */
- private static void warmupSharedPrefs(Application application) {
- // From credential-encrypted (CE) storage, i.e.:
- // /data/data/com.android.dialer/shared_prefs
-
- if (UserManagerCompat.isUserUnlocked(application)) {
- // <package_name>_preferences.xml
- PreferenceManager.getDefaultSharedPreferences(application);
-
- // <package_name>.xml
- application.getSharedPreferences(application.getPackageName(), Context.MODE_PRIVATE);
- }
-
- // From device-encrypted (DE) storage, i.e.:
- // /data/user_de/0/com.android.dialer/shared_prefs/
-
- // <package_name>_preferences.xml
- DialerUtils.getDefaultSharedPreferenceForDeviceProtectedStorageContext(application);
- }
-
- private static boolean isStrictModeAllowed() {
- return BuildType.get() == BuildType.BUGFOOD;
- }
-
- private static boolean onMainThread() {
- return Looper.getMainLooper().equals(Looper.myLooper());
- }
-
- /**
- * Convenience method for disabling and enabling the thread policy death penalty using lambdas.
- *
- * <p>For example:
- *
- * <p><code>
- * Value foo = DialerStrictMode.bypass(() -> doDiskAccessOnMainThreadReturningValue());
- * </code>
- *
- * <p>The thread policy is only mutated if this is called from the main thread.
- */
- @AnyThread
- public static <T> T bypass(Supplier<T> supplier) {
- if (isStrictModeAllowed() && onMainThread()) {
- ThreadPolicy originalPolicy = StrictMode.getThreadPolicy();
- StrictModeUtils.setRecommendedMainThreadPolicy(THREAD_LOG_PENALTY);
- try {
- return supplier.get();
- } finally {
- StrictMode.setThreadPolicy(originalPolicy);
- }
- }
- return supplier.get();
- }
-
- /**
- * Convenience method for disabling and enabling the thread policy death penalty using lambdas.
- *
- * <p>For example:
- *
- * <p><code>
- * DialerStrictMode.bypass(() -> doDiskAccessOnMainThread());
- * </code>
- *
- * <p>The thread policy is only mutated if this is called from the main thread.
- */
- @AnyThread
- public static void bypass(Runnable runnable) {
- if (isStrictModeAllowed() && onMainThread()) {
- ThreadPolicy originalPolicy = StrictMode.getThreadPolicy();
- StrictModeUtils.setRecommendedMainThreadPolicy(THREAD_LOG_PENALTY);
- try {
- runnable.run();
- } finally {
- StrictMode.setThreadPolicy(originalPolicy);
- }
- }
- runnable.run();
- }
+ void onApplicationCreate(Application application);
}
diff --git a/java/com/android/dialer/strictmode/StrictModeComponent.java b/java/com/android/dialer/strictmode/StrictModeComponent.java
new file mode 100644
index 000000000..7b9f48e20
--- /dev/null
+++ b/java/com/android/dialer/strictmode/StrictModeComponent.java
@@ -0,0 +1,39 @@
+/*
+ * Copyright (C) 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 com.android.dialer.strictmode;
+
+import android.content.Context;
+import com.android.dialer.inject.HasRootComponent;
+import dagger.Subcomponent;
+
+/** Dagger component for DialerStrictMode. */
+@Subcomponent
+public abstract class StrictModeComponent {
+
+ public abstract DialerStrictMode getDialerStrictMode();
+
+ public static StrictModeComponent get(Context context) {
+ return ((StrictModeComponent.HasComponent)
+ ((HasRootComponent) context.getApplicationContext()).component())
+ .strictModeComponent();
+ }
+
+ /** Used to refer to the root application component. */
+ public interface HasComponent {
+ StrictModeComponent strictModeComponent();
+ }
+}
diff --git a/java/com/android/dialer/strictmode/StrictModeUtils.java b/java/com/android/dialer/strictmode/StrictModeUtils.java
index 6944fd487..c83beb0b6 100644
--- a/java/com/android/dialer/strictmode/StrictModeUtils.java
+++ b/java/com/android/dialer/strictmode/StrictModeUtils.java
@@ -16,104 +16,76 @@
package com.android.dialer.strictmode;
-import android.os.Build;
+import android.os.Looper;
import android.os.StrictMode;
-import android.support.annotation.Nullable;
-import com.android.dialer.common.Assert;
-import com.google.auto.value.AutoValue;
-import java.util.Map;
-import java.util.Map.Entry;
+import android.os.StrictMode.ThreadPolicy;
+import android.support.annotation.AnyThread;
+import com.android.dialer.buildtype.BuildType;
+import com.android.dialer.function.Supplier;
/** Utilities for enforcing strict-mode in an app. */
-final class StrictModeUtils {
+public final class StrictModeUtils {
- /**
- * Set the recommended policy for the app.
- *
- * @param threadPenalties policy with preferred penalties. Detection bits will be ignored.
- */
- static void setRecommendedMainThreadPolicy(StrictMode.ThreadPolicy threadPenalties) {
- StrictMode.ThreadPolicy threadPolicy =
- new StrictMode.ThreadPolicy.Builder(threadPenalties).detectAll().build();
- StrictMode.setThreadPolicy(threadPolicy);
- }
+ private static final ThreadPolicy THREAD_NO_PENALTY =
+ new StrictMode.ThreadPolicy.Builder().permitAll().build();
/**
- * Set the recommended policy for the app.
+ * Convenience method for disabling and enabling the thread policy death penalty using lambdas.
+ *
+ * <p>For example:
+ *
+ * <p><code>
+ * Value foo = StrictModeUtils.bypass(() -> doDiskAccessOnMainThreadReturningValue());
+ * </code>
*
- * @param vmPenalties policy with preferred penalties. Detection bits should be unset.
+ * <p>The thread policy is only mutated if this is called from the main thread.
*/
- static void setRecommendedVMPolicy(StrictMode.VmPolicy vmPenalties) {
- setRecommendedVMPolicy(vmPenalties, StrictModeVmConfig.empty());
+ @AnyThread
+ public static <T> T bypass(Supplier<T> supplier) {
+ if (isStrictModeAllowed() && onMainThread()) {
+ ThreadPolicy originalPolicy = StrictMode.getThreadPolicy();
+ StrictMode.setThreadPolicy(THREAD_NO_PENALTY);
+ try {
+ return supplier.get();
+ } finally {
+ StrictMode.setThreadPolicy(originalPolicy);
+ }
+ }
+ return supplier.get();
}
/**
- * Set the recommended policy for the app.
+ * Convenience method for disabling and enabling the thread policy death penalty using lambdas.
+ *
+ * <p>For example:
*
- * @param vmPenalties policy with preferred penalties. Detection bits should be unset.
+ * <p><code>
+ * StrictModeUtils.bypass(() -> doDiskAccessOnMainThread());
+ * </code>
+ *
+ * <p>The thread policy is only mutated if this is called from the main thread.
*/
- private static void setRecommendedVMPolicy(
- StrictMode.VmPolicy vmPenalties, StrictModeVmConfig config) {
- Assert.isNotNull(config);
- StrictMode.VmPolicy.Builder vmPolicyBuilder =
- new StrictMode.VmPolicy.Builder(vmPenalties)
- .detectLeakedClosableObjects()
- .detectLeakedSqlLiteObjects();
- if (Build.VERSION.SDK_INT >= 16) {
- vmPolicyBuilder.detectLeakedRegistrationObjects();
- }
- if (Build.VERSION.SDK_INT >= 18) {
- vmPolicyBuilder.detectFileUriExposure();
- }
- if (Build.VERSION.SDK_INT >= 21) {
- // Even though this API is available earlier, it did not properly run finalizers.
- // This avoids lots of false positives.
-
- // TODO(zachh): Use LeakCanary and remove this line.
- vmPolicyBuilder.detectActivityLeaks();
-
- if (config.maxInstanceLimits() != null) {
- for (Entry<Class<?>, Integer> entry : config.maxInstanceLimits().entrySet()) {
- vmPolicyBuilder.setClassInstanceLimit(entry.getKey(), entry.getValue());
- }
+ @AnyThread
+ public static void bypass(Runnable runnable) {
+ if (isStrictModeAllowed() && onMainThread()) {
+ ThreadPolicy originalPolicy = StrictMode.getThreadPolicy();
+ StrictMode.setThreadPolicy(THREAD_NO_PENALTY);
+ try {
+ runnable.run();
+ } finally {
+ StrictMode.setThreadPolicy(originalPolicy);
}
+ } else {
+ runnable.run();
}
- if (Build.VERSION.SDK_INT >= 23) {
- // TODO(azlatin): Enable clear-text check once b/36730713 is fixed.
- // vmPolicyBuilder.detectCleartextNetwork();
- }
- // Once OC Lands:
- // .detectContentUriWithoutPermission()
- // .detectUntaggedSockets()
- StrictMode.setVmPolicy(vmPolicyBuilder.build());
}
- /** VmPolicy configuration. */
- @AutoValue
- abstract static class StrictModeVmConfig {
- /** A map of a class to the maximum number of allowed instances of that class. */
- @Nullable
- abstract Map<Class<?>, Integer> maxInstanceLimits();
-
- public static StrictModeVmConfig empty() {
- return builder().build();
- }
-
- public static Builder builder() {
- return new AutoValue_StrictModeUtils_StrictModeVmConfig.Builder();
- }
-
- /** VmPolicy configuration builder. */
- @AutoValue.Builder
- public abstract static class Builder {
- public abstract Builder setMaxInstanceLimits(Map<Class<?>, Integer> limits);
-
- public abstract StrictModeVmConfig build();
-
- Builder() {}
- }
+ public static boolean isStrictModeAllowed() {
+ return BuildType.get() == BuildType.BUGFOOD;
+ }
- StrictModeVmConfig() {}
+ private static boolean onMainThread() {
+ return Looper.getMainLooper().equals(Looper.myLooper());
}
private StrictModeUtils() {}
diff --git a/java/com/android/dialer/strictmode/impl/SystemDialerStrictMode.java b/java/com/android/dialer/strictmode/impl/SystemDialerStrictMode.java
new file mode 100644
index 000000000..4d6524123
--- /dev/null
+++ b/java/com/android/dialer/strictmode/impl/SystemDialerStrictMode.java
@@ -0,0 +1,162 @@
+/*
+ * Copyright (C) 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 com.android.dialer.strictmode.impl;
+
+import android.app.Application;
+import android.content.Context;
+import android.os.Build;
+import android.os.Handler;
+import android.os.Looper;
+import android.os.StrictMode;
+import android.os.StrictMode.ThreadPolicy;
+import android.os.StrictMode.VmPolicy;
+import android.preference.PreferenceManager;
+import android.support.annotation.MainThread;
+import android.support.annotation.Nullable;
+import android.support.v4.os.UserManagerCompat;
+import com.android.dialer.buildtype.BuildType;
+import com.android.dialer.common.Assert;
+import com.android.dialer.strictmode.DialerStrictMode;
+import com.android.dialer.util.DialerUtils;
+import com.google.auto.value.AutoValue;
+import java.util.Map;
+import javax.inject.Inject;
+
+final class SystemDialerStrictMode implements DialerStrictMode {
+ private static final VmPolicy VM_DEATH_PENALTY =
+ new StrictMode.VmPolicy.Builder().penaltyLog().penaltyDeath().build();
+
+ private static final ThreadPolicy THREAD_DEATH_PENALTY =
+ new StrictMode.ThreadPolicy.Builder().penaltyLog().penaltyDeath().build();
+
+ @Inject
+ public SystemDialerStrictMode() {}
+
+ @MainThread
+ @Override
+ public void onApplicationCreate(Application application) {
+ if (isStrictModeAllowed()) {
+ warmupSharedPrefs(application);
+ setRecommendedMainThreadPolicy(THREAD_DEATH_PENALTY);
+ setRecommendedVMPolicy(VM_DEATH_PENALTY);
+
+ // Because Android resets StrictMode policies after Application.onCreate is done, we set it
+ // again right after.
+ // See cl/105932355 for the discussion.
+ // See b/36951662 for the public bug.
+ Handler handler = new Handler(Looper.myLooper());
+ handler.postAtFrontOfQueue(() -> setRecommendedMainThreadPolicy(THREAD_DEATH_PENALTY));
+ }
+ }
+
+ /**
+ * We frequently access shared preferences on the main thread, which causes strict mode
+ * violations. When strict mode is allowed, warm up the shared preferences so that later uses of
+ * shared preferences access the in-memory versions and we don't have to bypass strict mode at
+ * every point in the application where shared preferences are accessed.
+ */
+ private static void warmupSharedPrefs(Application application) {
+ // From credential-encrypted (CE) storage, i.e.:
+ // /data/data/com.android.dialer/shared_prefs
+
+ if (UserManagerCompat.isUserUnlocked(application)) {
+ // <package_name>_preferences.xml
+ PreferenceManager.getDefaultSharedPreferences(application);
+
+ // <package_name>.xml
+ application.getSharedPreferences(application.getPackageName(), Context.MODE_PRIVATE);
+ }
+
+ // From device-encrypted (DE) storage, i.e.:
+ // /data/user_de/0/com.android.dialer/shared_prefs/
+
+ // <package_name>_preferences.xml
+ DialerUtils.getDefaultSharedPreferenceForDeviceProtectedStorageContext(application);
+ }
+
+ private static boolean isStrictModeAllowed() {
+ return BuildType.get() == BuildType.BUGFOOD;
+ }
+
+ /**
+ * Set the recommended policy for the app.
+ *
+ * @param threadPenalties policy with preferred penalties. Detection bits will be ignored.
+ */
+ private static void setRecommendedMainThreadPolicy(StrictMode.ThreadPolicy threadPenalties) {
+ StrictMode.ThreadPolicy threadPolicy =
+ new StrictMode.ThreadPolicy.Builder(threadPenalties).detectAll().build();
+ StrictMode.setThreadPolicy(threadPolicy);
+ }
+
+ /**
+ * Set the recommended policy for the app.
+ *
+ * @param vmPenalties policy with preferred penalties. Detection bits should be unset.
+ */
+ private static void setRecommendedVMPolicy(StrictMode.VmPolicy vmPenalties) {
+ setRecommendedVMPolicy(vmPenalties, StrictModeVmConfig.empty());
+ }
+
+ /**
+ * Set the recommended policy for the app.
+ *
+ * @param vmPenalties policy with preferred penalties. Detection bits should be unset.
+ */
+ private static void setRecommendedVMPolicy(
+ StrictMode.VmPolicy vmPenalties, StrictModeVmConfig config) {
+ Assert.isNotNull(config);
+ StrictMode.VmPolicy.Builder vmPolicyBuilder =
+ new StrictMode.VmPolicy.Builder(vmPenalties)
+ .detectLeakedClosableObjects()
+ .detectLeakedSqlLiteObjects();
+ if (Build.VERSION.SDK_INT >= 26) {
+ vmPolicyBuilder.detectContentUriWithoutPermission();
+ // TODO(azlatin): Enable detecting untagged sockets once: b/64840386 is fixed.
+ // vmPolicyBuilder.detectUntaggedSockets();
+ }
+ StrictMode.setVmPolicy(vmPolicyBuilder.build());
+ }
+
+ /** VmPolicy configuration. */
+ @AutoValue
+ abstract static class StrictModeVmConfig {
+ /** A map of a class to the maximum number of allowed instances of that class. */
+ @Nullable
+ abstract Map<Class<?>, Integer> maxInstanceLimits();
+
+ public static StrictModeVmConfig empty() {
+ return builder().build();
+ }
+
+ public static Builder builder() {
+ return new AutoValue_SystemDialerStrictMode_StrictModeVmConfig.Builder();
+ }
+
+ /** VmPolicy configuration builder. */
+ @AutoValue.Builder
+ public abstract static class Builder {
+ public abstract Builder setMaxInstanceLimits(Map<Class<?>, Integer> limits);
+
+ public abstract StrictModeVmConfig build();
+
+ Builder() {}
+ }
+
+ StrictModeVmConfig() {}
+ }
+}
diff --git a/java/com/android/dialer/strictmode/impl/SystemStrictModeModule.java b/java/com/android/dialer/strictmode/impl/SystemStrictModeModule.java
new file mode 100644
index 000000000..6ece874fe
--- /dev/null
+++ b/java/com/android/dialer/strictmode/impl/SystemStrictModeModule.java
@@ -0,0 +1,31 @@
+/*
+ * Copyright (C) 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 com.android.dialer.strictmode.impl;
+
+import com.android.dialer.strictmode.DialerStrictMode;
+import dagger.Binds;
+import dagger.Module;
+import javax.inject.Singleton;
+
+/** Module which binds {@link SystemDialerStrictMode}. */
+@Module
+public abstract class SystemStrictModeModule {
+
+ @Binds
+ @Singleton
+ public abstract DialerStrictMode bindDialerStrictMode(SystemDialerStrictMode impl);
+}