Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit b54585e6 authored by Matthew Sedam's avatar Matthew Sedam
Browse files

Make ContextHubTestModeManager a dedicated class 

This CL moves the test mode behavior class from ContextHubService
to a dedicated class. This CL also adds message dropping test
behavior.

Bug: 331795143
Flag: android.chre.flags.reliable_message_retry_support_service
Test: Presubmits
Change-Id: If237e2edcd9780b49dfebaca19e1e60dddc425b1
parent 721a2fc3

services/core/java/com/android/server/location/contexthub/ContextHubService.java

+9 −58
Original line number Diff line number Diff line
@@ -81,7 +81,6 @@ import java.util.Map; 
import java.util.Objects;

import java.util.Optional;

import java.util.PriorityQueue;

import java.util.Random;

import java.util.Set;

import java.util.concurrent.ConcurrentHashMap;

import java.util.concurrent.ScheduledThreadPoolExecutor;
@@ -162,8 +161,8 @@ public class ContextHubService extends IContextHubService.Stub { 
            new PriorityQueue<>(

                    Comparator.comparingLong(ReliableMessageRecord::getTimestamp));



    // The test mode manager that manages behaviors during test mode.

    private final TestModeManager mTestModeManager = new TestModeManager();

    // The test mode manager that manages behaviors during test mode

    private final ContextHubTestModeManager mTestModeManager = new ContextHubTestModeManager();



    // The period of the recurring time

    private static final int PERIOD_METRIC_QUERY_DAYS = 1;
@@ -229,9 +228,11 @@ public class ContextHubService extends IContextHubService.Stub { 
            if (Flags.reliableMessageImplementation()

                    && Flags.reliableMessageTestModeBehavior()

                    && mIsTestModeEnabled.get()

                    && mTestModeManager.handleNanoappMessage(mContextHubId, hostEndpointId,

                            message, nanoappPermissions, messagePermissions)) {

                // The TestModeManager handled the nanoapp message, so return here.

                    && mTestModeManager.handleNanoappMessage(() -> {

                        handleClientMessageCallback(mContextHubId, hostEndpointId, message,

                                nanoappPermissions, messagePermissions);

                    }, message)) {

                // The ContextHubTestModeManager handled the nanoapp message, so return here.

                return;

            }
@@ -261,8 +262,6 @@ public class ContextHubService extends IContextHubService.Stub { 
     * Records a reliable message from a nanoapp for duplicate detection.

     */

    private static class ReliableMessageRecord {

        public static final int TIMEOUT_NS = 1000000000;



        public int mContextHubId;

        public long mTimestamp;

        public int mMessageSequenceNumber;
@@ -297,56 +296,8 @@ public class ContextHubService extends IContextHubService.Stub { 
        }



        public boolean isExpired() {

            return mTimestamp + TIMEOUT_NS < SystemClock.elapsedRealtimeNanos();

        }

    }



    /**

     * A class to manage behaviors during test mode. This is used for testing.

     */

    private class TestModeManager {

        /**

         * Probability (in percent) of duplicating a message.

         */

        private static final int MESSAGE_DUPLICATION_PROBABILITY_PERCENT = 50;



        /**

         * The number of total messages to send when the duplicate event happens.

         */

        private static final int NUM_MESSAGES_TO_DUPLICATE = 3;



        /**

         * A probability percent for a certain event.

         */

        private static final int MAX_PROBABILITY_PERCENT = 100;



        private final Random mRandom = new Random();



        /**

         * @return whether the message was handled

         * @see ContextHubServiceCallback#handleNanoappMessage

         */

        public boolean handleNanoappMessage(int contextHubId,

                short hostEndpointId, NanoAppMessage message,

                List<String> nanoappPermissions, List<String> messagePermissions) {

            if (!message.isReliable()) {

                return false;

            }



            if (Flags.reliableMessageDuplicateDetectionService()

                    && mRandom.nextInt(MAX_PROBABILITY_PERCENT)

                    < MESSAGE_DUPLICATION_PROBABILITY_PERCENT) {

                Log.i(TAG, "[TEST MODE] Duplicating message ("

                        + NUM_MESSAGES_TO_DUPLICATE

                        + " sends) with message sequence number: "

                        + message.getMessageSequenceNumber());

                for (int i = 0; i < NUM_MESSAGES_TO_DUPLICATE; ++i) {

                    handleClientMessageCallback(contextHubId, hostEndpointId,

                            message, nanoappPermissions, messagePermissions);

                }

                return true;

            }

            return false;

            return mTimestamp + ContextHubTransactionManager.RELIABLE_MESSAGE_TIMEOUT_NS

                    < SystemClock.elapsedRealtimeNanos();

        }

    }

services/core/java/com/android/server/location/contexthub/ContextHubTestModeManager.java

0 → 100644
+82 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2024 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.server.location.contexthub;



import android.chre.flags.Flags;

import android.hardware.location.NanoAppMessage;

import android.util.Log;



import java.util.Random;



/**

 * A class to manage behaviors during test mode. This is used for testing.

 * @hide

 */

public class ContextHubTestModeManager {

    private static final String TAG = "ContextHubTestModeManager";



    /** Probability (in percent) of duplicating a message. */

    private static final int MESSAGE_DROP_PROBABILITY_PERCENT = 20;



    /** Probability (in percent) of duplicating a message. */

    private static final int MESSAGE_DUPLICATION_PROBABILITY_PERCENT = 20;



    /** The number of total messages to send when the duplicate event happens. */

    private static final int NUM_MESSAGES_TO_DUPLICATE = 3;



    /** A probability percent for a certain event. */

    private static final int MAX_PROBABILITY_PERCENT = 100;



    private final Random mRandom = new Random();



    /**

     * @return whether the message was handled

     * @see ContextHubServiceCallback#handleNanoappMessage

     */

    public boolean handleNanoappMessage(Runnable handleMessage, NanoAppMessage message) {

        if (Flags.reliableMessageDuplicateDetectionService()

                && message.isReliable()

                && mRandom.nextInt(MAX_PROBABILITY_PERCENT)

                        < MESSAGE_DUPLICATION_PROBABILITY_PERCENT) {

            Log.i(TAG, "[TEST MODE] Duplicating message ("

                    + NUM_MESSAGES_TO_DUPLICATE

                    + " sends) with message sequence number: "

                    + message.getMessageSequenceNumber());

            for (int i = 0; i < NUM_MESSAGES_TO_DUPLICATE; ++i) {

                handleMessage.run();

            }

            return true;

        }

        return false;

    }



    /**

     * @return whether the message was handled

     * @see IContextHubWrapper#sendMessageToContextHub

     */

    public boolean sendMessageToContextHub(NanoAppMessage message) {

        if (Flags.reliableMessageRetrySupportService()

                && message.isReliable()

                && mRandom.nextInt(MAX_PROBABILITY_PERCENT)

                        < MESSAGE_DROP_PROBABILITY_PERCENT) {

            Log.i(TAG, "[TEST MODE] Dropping message with message sequence number: "

                    + message.getMessageSequenceNumber());

            return true;

        }

        return false;

    }

}

services/core/java/com/android/server/location/contexthub/ContextHubTransactionManager.java

+5 −0
Original line number Diff line number Diff line
@@ -47,6 +47,11 @@ import java.util.concurrent.atomic.AtomicInteger; 
/* package */ class ContextHubTransactionManager {

    private static final String TAG = "ContextHubTransactionManager";



    /**

     * The timeout in ns of a reliable message transaction.

     */

    public static final int RELIABLE_MESSAGE_TIMEOUT_NS = 1_000_000_000; // 1 second



    /*

     * Maximum number of transaction requests that can be pending at a time

     */

services/core/java/com/android/server/location/contexthub/IContextHubWrapper.java

+22 −2
Original line number Diff line number Diff line
@@ -52,6 +52,7 @@ import java.util.List; 
import java.util.Map;

import java.util.NoSuchElementException;

import java.util.Set;

import java.util.concurrent.atomic.AtomicBoolean;



/**

 * @hide
@@ -432,10 +433,16 @@ public abstract class IContextHubWrapper { 


        // Use this thread in case where the execution requires to be on a service thread.

        // For instance, AppOpsManager.noteOp requires the UPDATE_APP_OPS_STATS permission.

        private HandlerThread mHandlerThread =

        private final HandlerThread mHandlerThread =

                new HandlerThread("Context Hub AIDL callback", Process.THREAD_PRIORITY_BACKGROUND);

        private Handler mHandler;



        // True if test mode is enabled for the Context Hub

        private final AtomicBoolean mIsTestModeEnabled = new AtomicBoolean(false);



        // The test mode manager that manages behaviors during test mode

        private final ContextHubTestModeManager mTestModeManager = new ContextHubTestModeManager();



        private class ContextHubAidlCallback extends

                android.hardware.contexthub.IContextHubCallback.Stub {

            private final int mContextHubId;
@@ -549,6 +556,8 @@ public abstract class IContextHubWrapper { 
            } else {

                Log.e(TAG, "mHandleServiceRestartCallback is not set");

            }



            mIsTestModeEnabled.set(false);

        }



        public Pair<List<ContextHubInfo>, List<String>> getHubs() throws RemoteException {
@@ -659,7 +668,17 @@ public abstract class IContextHubWrapper { 
            try {

                var msg = ContextHubServiceUtil.createAidlContextHubMessage(

                        hostEndpointId, message);



                // Only process the message normally if not using test mode manager or if

                // the test mode manager call returned false as this indicates it did not

                // process the message.

                boolean useTestModeManager = Flags.reliableMessageImplementation()

                        && Flags.reliableMessageTestModeBehavior()

                        && mIsTestModeEnabled.get();

                if (!useTestModeManager || !mTestModeManager.sendMessageToContextHub(message)) {

                    hub.sendMessageToHub(contextHubId, msg);

                }



                return ContextHubTransaction.RESULT_SUCCESS;

            } catch (RemoteException | ServiceSpecificException e) {

                return ContextHubTransaction.RESULT_FAILED_UNKNOWN;
@@ -828,6 +847,7 @@ public abstract class IContextHubWrapper { 
                return false;

            }



            mIsTestModeEnabled.set(enable);

            try {

                hub.setTestMode(enable);

                return true;