summaryrefslogtreecommitdiff
path: root/java/com/android/dialer/strictmode
diff options
context:
space:
mode:
authorEric Erfanian <erfanian@google.com>2017-08-31 06:57:16 -0700
committerEric Erfanian <erfanian@google.com>2017-08-31 16:13:53 +0000
commit2ca4318cc1ee57dda907ba2069bd61d162b1baef (patch)
treee282668a9587cf6c1ec7b604dea860400c75c6c7 /java/com/android/dialer/strictmode
parent68038172793ee0e2ab3e2e56ddfbeb82879d1f58 (diff)
Update Dialer source to latest internal Google revision.
Previously, Android's Dialer app was developed in an internal Google source control system and only exported to public during AOSP drops. The Dialer team is now switching to a public development model similar to the telephony team. This CL represents all internal Google changes that were committed to Dialer between the public O release and today's tip of tree on internal master. This CL squashes those changes into a single commit. In subsequent changes, changes will be exported on a per-commit basis. Test: make, flash install, run Merged-In: I45270eaa8ce732d71a1bd84b08c7fa0e99af3160 Change-Id: I529aaeb88535b9533c0ae4ef4e6c1222d4e0f1c8 PiperOrigin-RevId: 167068436
Diffstat (limited to 'java/com/android/dialer/strictmode')
-rw-r--r--java/com/android/dialer/strictmode/DialerStrictMode.java147
-rw-r--r--java/com/android/dialer/strictmode/StrictModeUtils.java120
2 files changed, 267 insertions, 0 deletions
diff --git a/java/com/android/dialer/strictmode/DialerStrictMode.java b/java/com/android/dialer/strictmode/DialerStrictMode.java
new file mode 100644
index 000000000..f895f7c46
--- /dev/null
+++ b/java/com/android/dialer/strictmode/DialerStrictMode.java
@@ -0,0 +1,147 @@
+/*
+ * 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.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() {}
+
+ /** 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();
+ }
+}
diff --git a/java/com/android/dialer/strictmode/StrictModeUtils.java b/java/com/android/dialer/strictmode/StrictModeUtils.java
new file mode 100644
index 000000000..6944fd487
--- /dev/null
+++ b/java/com/android/dialer/strictmode/StrictModeUtils.java
@@ -0,0 +1,120 @@
+/*
+ * 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.os.Build;
+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;
+
+/** Utilities for enforcing strict-mode in an app. */
+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);
+ }
+
+ /**
+ * Set the recommended policy for the app.
+ *
+ * @param vmPenalties policy with preferred penalties. Detection bits should be unset.
+ */
+ 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 >= 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());
+ }
+ }
+ }
+ 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() {}
+ }
+
+ StrictModeVmConfig() {}
+ }
+
+ private StrictModeUtils() {}
+}