From 966aef4edd21e3f17db60e466e52cc3a7b493c47 Mon Sep 17 00:00:00 2001
From: Florian Mayer <fmayer@google.com>
Date: Tue, 21 Dec 2021 12:08:40 -0800
Subject: [PATCH] Add "Reboot with MTE" option for supported devices.

Test: make -j64 RunSettingsRoboTests ROBOTEST_FILTER="com.android.settings.development.RebootWithMteDialogTest"
Test: make -j64 RunSettingsRoboTests ROBOTEST_FILTER="com.android.settings.development.RebootWithMtePreferenceControllerTest"

Bug: 206895651

Change-Id: I38ef2c5aeb5c5d805afd4f1ab860f7a0a4d18e1c
---
 res/values/strings.xml                        |  3 +
 res/xml/development_settings.xml              |  4 +
 .../DevelopmentSettingsDashboardFragment.java |  1 +
 .../development/RebootWithMteDialog.java      | 75 +++++++++++++++++++
 .../RebootWithMtePreferenceController.java    | 63 ++++++++++++++++
 .../development/RebootWithMteDialogTest.java  | 60 +++++++++++++++
 ...RebootWithMtePreferenceControllerTest.java | 64 ++++++++++++++++
 7 files changed, 270 insertions(+)
 create mode 100644 src/com/android/settings/development/RebootWithMteDialog.java
 create mode 100644 src/com/android/settings/development/RebootWithMtePreferenceController.java
 create mode 100644 tests/robotests/src/com/android/settings/development/RebootWithMteDialogTest.java
 create mode 100644 tests/robotests/src/com/android/settings/development/RebootWithMtePreferenceControllerTest.java

diff --git a/res/values/strings.xml b/res/values/strings.xml
index 12f398b9f2b..26ef4c62e3c 100644
--- a/res/values/strings.xml
+++ b/res/values/strings.xml
@@ -13237,6 +13237,9 @@
 
     <!-- Title for the button to initiate a heap dump for the system server. [CHAR LIMIT=NONE] -->
     <string name="capture_system_heap_dump_title">Capture system heap dump</string>
+    <!-- Title for the button to reboot with MTE enabled. [CHAR LIMIT=NONE] -->
+    <string name="reboot_with_mte_title">Reboot with MTE</string>
+    <string name="reboot_with_mte_message">This wil reboot and allow to experiment with Memory Tagging Extensions (MTE). This may negatively impact system performance and stability. Will be reset on next subsequent reboot.</string>
     <!-- Toast that is shown when the user initiates capturing a heap dump for the system server. [CHAR LIMIT=NONE] -->
     <string name="capturing_system_heap_dump_message">Capturing system heap dump</string>
     <!-- Toast that is shown if there's an error capturing the user initiated heap dump. [CHAR LIMIT=NONE] -->
diff --git a/res/xml/development_settings.xml b/res/xml/development_settings.xml
index 21ee30a4a9a..f29930c8bd4 100644
--- a/res/xml/development_settings.xml
+++ b/res/xml/development_settings.xml
@@ -44,6 +44,10 @@
             android:key="system_server_heap_dump"
             android:title="@string/capture_system_heap_dump_title" />
 
+        <Preference
+            android:key="reboot_with_mte"
+            android:title="@string/reboot_with_mte_title" />
+
         <Preference
             android:key="local_backup_password"
             android:title="@string/local_backup_password_title"
diff --git a/src/com/android/settings/development/DevelopmentSettingsDashboardFragment.java b/src/com/android/settings/development/DevelopmentSettingsDashboardFragment.java
index 946e0d744a5..8f227dcd810 100644
--- a/src/com/android/settings/development/DevelopmentSettingsDashboardFragment.java
+++ b/src/com/android/settings/development/DevelopmentSettingsDashboardFragment.java
@@ -477,6 +477,7 @@ public class DevelopmentSettingsDashboardFragment extends RestrictedDashboardFra
         controllers.add(new BugReportPreferenceController(context));
         controllers.add(new BugReportHandlerPreferenceController(context));
         controllers.add(new SystemServerHeapDumpPreferenceController(context));
+        controllers.add(new RebootWithMtePreferenceController(context, fragment));
         controllers.add(new LocalBackupPasswordPreferenceController(context));
         controllers.add(new StayAwakePreferenceController(context, lifecycle));
         controllers.add(new HdcpCheckingPreferenceController(context));
diff --git a/src/com/android/settings/development/RebootWithMteDialog.java b/src/com/android/settings/development/RebootWithMteDialog.java
new file mode 100644
index 00000000000..b6522a95b55
--- /dev/null
+++ b/src/com/android/settings/development/RebootWithMteDialog.java
@@ -0,0 +1,75 @@
+/*
+ * Copyright (C) 2022 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.settings.development;
+
+import android.app.Dialog;
+import android.app.settings.SettingsEnums;
+import android.content.Context;
+import android.content.DialogInterface;
+import android.os.Bundle;
+import android.os.PowerManager;
+import android.os.SystemProperties;
+
+import androidx.appcompat.app.AlertDialog;
+import androidx.fragment.app.Fragment;
+import androidx.fragment.app.FragmentManager;
+
+import com.android.settings.R;
+import com.android.settings.core.instrumentation.InstrumentedDialogFragment;
+
+public class RebootWithMteDialog extends InstrumentedDialogFragment
+        implements DialogInterface.OnClickListener {
+
+    public static final String TAG = "RebootWithMteDlg";
+    private Context mContext;
+
+    public RebootWithMteDialog(Context context) {
+        mContext = context;
+    }
+
+    public static void show(Context context, Fragment host) {
+        FragmentManager manager = host.getActivity().getSupportFragmentManager();
+        if (manager.findFragmentByTag(TAG) == null) {
+            RebootWithMteDialog dialog = new RebootWithMteDialog(context);
+            dialog.setTargetFragment(host, 0 /* requestCode */);
+            dialog.show(manager, TAG);
+        }
+    }
+
+    @Override
+    public int getMetricsCategory() {
+        return SettingsEnums.REBOOT_WITH_MTE;
+    }
+
+    @Override
+    public Dialog onCreateDialog(Bundle savedInstanceState) {
+        return new AlertDialog.Builder(getActivity())
+                .setTitle(R.string.reboot_with_mte_title)
+                .setMessage(R.string.reboot_with_mte_message)
+                .setPositiveButton(android.R.string.ok, this /* onClickListener */)
+                .setNegativeButton(android.R.string.cancel, null /* onClickListener */)
+                .setIcon(android.R.drawable.ic_dialog_alert)
+                .create();
+    }
+
+    @Override
+    public void onClick(DialogInterface dialog, int which) {
+        PowerManager pm = mContext.getSystemService(PowerManager.class);
+        SystemProperties.set("arm64.memtag.bootctl", "memtag-once");
+        pm.reboot(null);
+    }
+}
diff --git a/src/com/android/settings/development/RebootWithMtePreferenceController.java b/src/com/android/settings/development/RebootWithMtePreferenceController.java
new file mode 100644
index 00000000000..6c038538323
--- /dev/null
+++ b/src/com/android/settings/development/RebootWithMtePreferenceController.java
@@ -0,0 +1,63 @@
+/*
+ * Copyright (C) 2022 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.settings.development;
+
+import android.content.Context;
+import android.text.TextUtils;
+
+import androidx.preference.Preference;
+
+import com.android.settings.Utils;
+import com.android.settings.core.PreferenceControllerMixin;
+import com.android.settingslib.development.DeveloperOptionsPreferenceController;
+
+public class RebootWithMtePreferenceController extends DeveloperOptionsPreferenceController
+        implements PreferenceControllerMixin {
+
+    private static final String KEY_REBOOT_WITH_MTE = "reboot_with_mte";
+
+    private final DevelopmentSettingsDashboardFragment mFragment;
+
+    public RebootWithMtePreferenceController(
+            Context context, DevelopmentSettingsDashboardFragment fragment) {
+        super(context);
+        mFragment = fragment;
+    }
+
+    @Override
+    public boolean isAvailable() {
+        return android.os.SystemProperties.getBoolean("ro.arm64.memtag.bootctl_supported", false);
+    }
+
+    @Override
+    public String getPreferenceKey() {
+        return KEY_REBOOT_WITH_MTE;
+    }
+
+    @Override
+    public boolean handlePreferenceTreeClick(Preference preference) {
+        if (Utils.isMonkeyRunning()) {
+            return false;
+        }
+
+        if (TextUtils.equals(preference.getKey(), getPreferenceKey())) {
+            RebootWithMteDialog.show(mContext, mFragment);
+            return true;
+        }
+        return false;
+    }
+}
diff --git a/tests/robotests/src/com/android/settings/development/RebootWithMteDialogTest.java b/tests/robotests/src/com/android/settings/development/RebootWithMteDialogTest.java
new file mode 100644
index 00000000000..b95c8039395
--- /dev/null
+++ b/tests/robotests/src/com/android/settings/development/RebootWithMteDialogTest.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright (C) 2022 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.settings.development;
+
+import static junit.framework.Assert.assertEquals;
+
+import android.content.Context;
+import android.os.PowerManager;
+import android.os.SystemProperties;
+
+import androidx.test.core.app.ApplicationProvider;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.robolectric.RobolectricTestRunner;
+import org.robolectric.Shadows;
+import org.robolectric.annotation.Config;
+import org.robolectric.shadows.ShadowPowerManager;
+import org.robolectric.shadows.ShadowSystemProperties;
+
+@RunWith(RobolectricTestRunner.class)
+public class RebootWithMteDialogTest {
+    private Context mContext;
+    private ShadowPowerManager mShadowPowerManager;
+    private RebootWithMteDialog mDialog;
+
+    @Before
+    public void setup() throws Exception {
+        mContext = ApplicationProvider.getApplicationContext();
+        mShadowPowerManager = Shadows.shadowOf(mContext.getSystemService(PowerManager.class));
+        mDialog = new RebootWithMteDialog(mContext);
+    }
+
+    @Test
+    @Config(
+            shadows = {
+                ShadowSystemProperties.class,
+                ShadowPowerManager.class,
+            })
+    public void onClick_shouldSetPropAndReboot() {
+        mDialog.onClick(null, 0);
+        assertEquals(SystemProperties.get("arm64.memtag.bootctl"), "memtag-once");
+        assertEquals(mShadowPowerManager.getTimesRebooted(), 1);
+    }
+}
diff --git a/tests/robotests/src/com/android/settings/development/RebootWithMtePreferenceControllerTest.java b/tests/robotests/src/com/android/settings/development/RebootWithMtePreferenceControllerTest.java
new file mode 100644
index 00000000000..ffbf1f1cb86
--- /dev/null
+++ b/tests/robotests/src/com/android/settings/development/RebootWithMtePreferenceControllerTest.java
@@ -0,0 +1,64 @@
+/*
+ * Copyright (C) 2022 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.settings.development;
+
+import static junit.framework.Assert.assertFalse;
+import static junit.framework.Assert.assertTrue;
+
+import android.content.Context;
+import android.os.SystemProperties;
+
+import androidx.test.core.app.ApplicationProvider;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+import org.robolectric.RobolectricTestRunner;
+import org.robolectric.annotation.Config;
+import org.robolectric.shadows.ShadowSystemProperties;
+
+@RunWith(RobolectricTestRunner.class)
+@Config(
+        shadows = {
+            ShadowSystemProperties.class,
+        })
+public class RebootWithMtePreferenceControllerTest {
+    private Context mContext;
+    private RebootWithMtePreferenceController mController;
+    @Mock private DevelopmentSettingsDashboardFragment mSettings;
+
+    @Before
+    public void setup() throws Exception {
+        MockitoAnnotations.initMocks(this);
+
+        mContext = ApplicationProvider.getApplicationContext();
+        mController = new RebootWithMtePreferenceController(mContext, mSettings);
+    }
+
+    @Test
+    public void onAvailable_falseByDefault() {
+        assertFalse(mController.isAvailable());
+    }
+
+    @Test
+    public void onAvailable_sysPropEnabled() {
+        SystemProperties.set("ro.arm64.memtag.bootctl_supported", "1");
+        assertTrue(mController.isAvailable());
+    }
+}