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

Commit 0aa2bd27 authored by Chi Zhang's avatar Chi Zhang Committed by Automerger Merge Worker
Browse files

Merge "Handle build change and save on pull in PersistAtomsStorage." am: c1cf26bb 

Original change: https://android-review.googlesource.com/c/platform/frameworks/opt/telephony/+/1677349

Change-Id: I99bfa3700df5b9b0981da1d627e0f31e36a6b65a
parents 678d13cc c1cf26bb

proto/src/persist_atoms.proto

+4 −1
Original line number Diff line number Diff line
@@ -23,7 +23,7 @@ option java_outer_classname = "PersistAtomsProto"; 


// Holds atoms to store on persist storage in case of power cycle or process crash.

// NOTE: using int64 rather than google.protobuf.Timestamp for timestamps simplifies implementation.

// Next id: 21

// Next id: 22

message PersistAtoms {

    /* Aggregated RAT usage during the call. */

    repeated VoiceCallRatUsage voice_call_rat_usage = 1;
@@ -84,6 +84,9 @@ message PersistAtoms { 


    /* Timestamp of last ims_registration_stats pull. */

    optional int64 ims_registration_stats_pull_timestamp_millis = 20;



    /* Last Android build fingerprint. This usually changes after system OTA. */

    optional string build_fingerprint = 21;

}



// The canonical versions of the following enums live in:

src/java/com/android/internal/telephony/metrics/PersistAtomsStorage.java

+42 −26
Original line number Diff line number Diff line
@@ -18,6 +18,7 @@ package com.android.internal.telephony.metrics; 


import android.annotation.Nullable;

import android.content.Context;

import android.os.Build;

import android.os.Handler;

import android.os.HandlerThread;

import android.telephony.TelephonyManager;
@@ -58,7 +59,15 @@ public class PersistAtomsStorage { 
    private static final String FILENAME = "persist_atoms.pb";



    /** Delay to store atoms to persistent storage to bundle multiple operations together. */

    private static final int SAVE_TO_FILE_DELAY_MILLIS = 30000;

    private static final int SAVE_TO_FILE_DELAY_FOR_UPDATE_MILLIS = 30000;



    /**

     * Delay to store atoms to persistent storage during pulls to avoid unnecessary operations.

     *

     * <p>This delay should be short to avoid duplicating atoms or losing pull timestamp in case of

     * crash or power loss.

     */

    private static final int SAVE_TO_FILE_DELAY_FOR_GET_MILLIS = 500;



    /** Maximum number of call sessions to store between pulls. */

    private static final int MAX_NUM_CALL_SESSIONS = 50;
@@ -96,8 +105,8 @@ public class PersistAtomsStorage { 
    /** Aggregates RAT duration and call count. */

    private final VoiceCallRatTracker mVoiceCallRatTracker;



    /** Delay before data is stored persistenly to storage. */

    @VisibleForTesting protected int mSaveDelay;

    /** Whether atoms should be saved immediately, skipping the delay. */

    @VisibleForTesting protected boolean mSaveImmediately;



    private final Context mContext;

    private final Handler mHandler;
@@ -120,14 +129,14 @@ public class PersistAtomsStorage { 
        mHandlerThread = new HandlerThread("PersistAtomsThread");

        mHandlerThread.start();

        mHandler = new Handler(mHandlerThread.getLooper());

        mSaveDelay = SAVE_TO_FILE_DELAY_MILLIS;

        mSaveImmediately = false;

    }



    /** Adds a call to the storage. */

    public synchronized void addVoiceCallSession(VoiceCallSession call) {

        mAtoms.voiceCallSession =

                insertAtRandomPlace(mAtoms.voiceCallSession, call, MAX_NUM_CALL_SESSIONS);

        saveAtomsToFile();

        saveAtomsToFile(SAVE_TO_FILE_DELAY_FOR_UPDATE_MILLIS);



        Rlog.d(TAG, "Add new voice call session: " + call.toString());

    }
@@ -136,13 +145,13 @@ public class PersistAtomsStorage { 
    public synchronized void addVoiceCallRatUsage(VoiceCallRatTracker ratUsages) {

        mVoiceCallRatTracker.mergeWith(ratUsages);

        mAtoms.voiceCallRatUsage = mVoiceCallRatTracker.toProto();

        saveAtomsToFile();

        saveAtomsToFile(SAVE_TO_FILE_DELAY_FOR_UPDATE_MILLIS);

    }



    /** Adds an incoming SMS to the storage. */

    public synchronized void addIncomingSms(IncomingSms sms) {

        mAtoms.incomingSms = insertAtRandomPlace(mAtoms.incomingSms, sms, MAX_NUM_SMS);

        saveAtomsToFile();

        saveAtomsToFile(SAVE_TO_FILE_DELAY_FOR_UPDATE_MILLIS);



        // To be removed

        Rlog.d(TAG, "Add new incoming SMS atom: " + sms.toString());
@@ -160,7 +169,7 @@ public class PersistAtomsStorage { 
        }



        mAtoms.outgoingSms = insertAtRandomPlace(mAtoms.outgoingSms, sms, MAX_NUM_SMS);

        saveAtomsToFile();

        saveAtomsToFile(SAVE_TO_FILE_DELAY_FOR_UPDATE_MILLIS);



        // To be removed

        Rlog.d(TAG, "Add new outgoing SMS atom: " + sms.toString());
@@ -195,14 +204,14 @@ public class PersistAtomsStorage { 
            }

        }



        saveAtomsToFile();

        saveAtomsToFile(SAVE_TO_FILE_DELAY_FOR_UPDATE_MILLIS);

    }



    /** Adds a data call session to the storage. */

    public synchronized void addDataCallSession(DataCallSession dataCall) {

        mAtoms.dataCallSession =

                insertAtRandomPlace(mAtoms.dataCallSession, dataCall, MAX_NUM_DATA_CALL_SESSIONS);

        saveAtomsToFile();

        saveAtomsToFile(SAVE_TO_FILE_DELAY_FOR_UPDATE_MILLIS);

    }



    /**
@@ -231,7 +240,7 @@ public class PersistAtomsStorage { 
            mAtoms.carrierIdMismatch = Arrays.copyOf(mAtoms.carrierIdMismatch, newLength);

            mAtoms.carrierIdMismatch[newLength - 1] = carrierIdMismatch;

        }

        saveAtomsToFile();

        saveAtomsToFile(SAVE_TO_FILE_DELAY_FOR_UPDATE_MILLIS);

        return true;

    }
@@ -255,7 +264,7 @@ public class PersistAtomsStorage { 
                    insertAtRandomPlace(

                            mAtoms.imsRegistrationStats, stats, MAX_NUM_IMS_REGISTRATION_STATS);

        }

        saveAtomsToFile();

        saveAtomsToFile(SAVE_TO_FILE_DELAY_FOR_UPDATE_MILLIS);

    }



    /** Adds IMS registration termination to the storage. */
@@ -272,7 +281,7 @@ public class PersistAtomsStorage { 
                            termination,

                            MAX_NUM_IMS_REGISTRATION_TERMINATIONS);

        }

        saveAtomsToFile();

        saveAtomsToFile(SAVE_TO_FILE_DELAY_FOR_UPDATE_MILLIS);

    }



    /**
@@ -283,7 +292,7 @@ public class PersistAtomsStorage { 
    public synchronized boolean setCarrierIdTableVersion(int carrierIdTableVersion) {

        if (mAtoms.carrierIdTableVersion < carrierIdTableVersion) {

            mAtoms.carrierIdTableVersion = carrierIdTableVersion;

            saveAtomsToFile();

            saveAtomsToFile(SAVE_TO_FILE_DELAY_FOR_UPDATE_MILLIS);

            return true;

        } else {

            return false;
@@ -300,7 +309,7 @@ public class PersistAtomsStorage { 
            mAtoms.voiceCallSessionPullTimestampMillis = getWallTimeMillis();

            VoiceCallSession[] previousCalls = mAtoms.voiceCallSession;

            mAtoms.voiceCallSession = new VoiceCallSession[0];

            saveAtomsToFile();

            saveAtomsToFile(SAVE_TO_FILE_DELAY_FOR_GET_MILLIS);

            return previousCalls;

        } else {

            return null;
@@ -318,7 +327,7 @@ public class PersistAtomsStorage { 
            VoiceCallRatUsage[] previousUsages = mAtoms.voiceCallRatUsage;

            mVoiceCallRatTracker.clear();

            mAtoms.voiceCallRatUsage = new VoiceCallRatUsage[0];

            saveAtomsToFile();

            saveAtomsToFile(SAVE_TO_FILE_DELAY_FOR_GET_MILLIS);

            return previousUsages;

        } else {

            return null;
@@ -335,7 +344,7 @@ public class PersistAtomsStorage { 
            mAtoms.incomingSmsPullTimestampMillis = getWallTimeMillis();

            IncomingSms[] previousIncomingSms = mAtoms.incomingSms;

            mAtoms.incomingSms = new IncomingSms[0];

            saveAtomsToFile();

            saveAtomsToFile(SAVE_TO_FILE_DELAY_FOR_GET_MILLIS);

            return previousIncomingSms;

        } else {

            return null;
@@ -352,7 +361,7 @@ public class PersistAtomsStorage { 
            mAtoms.outgoingSmsPullTimestampMillis = getWallTimeMillis();

            OutgoingSms[] previousOutgoingSms = mAtoms.outgoingSms;

            mAtoms.outgoingSms = new OutgoingSms[0];

            saveAtomsToFile();

            saveAtomsToFile(SAVE_TO_FILE_DELAY_FOR_GET_MILLIS);

            return previousOutgoingSms;

        } else {

            return null;
@@ -369,7 +378,7 @@ public class PersistAtomsStorage { 
            mAtoms.dataCallSessionPullTimestampMillis = getWallTimeMillis();

            DataCallSession[] previousDataCallSession = mAtoms.dataCallSession;

            mAtoms.dataCallSession = new DataCallSession[0];

            saveAtomsToFile();

            saveAtomsToFile(SAVE_TO_FILE_DELAY_FOR_GET_MILLIS);

            return previousDataCallSession;

        } else {

            return null;
@@ -388,7 +397,7 @@ public class PersistAtomsStorage { 
            CellularServiceState[] previousStates = mAtoms.cellularServiceState;

            Arrays.stream(previousStates).forEach(state -> state.lastUsedMillis = 0L);

            mAtoms.cellularServiceState = new CellularServiceState[0];

            saveAtomsToFile();

            saveAtomsToFile(SAVE_TO_FILE_DELAY_FOR_GET_MILLIS);

            return previousStates;

        } else {

            return null;
@@ -409,7 +418,7 @@ public class PersistAtomsStorage { 
            Arrays.stream(previousSwitches)

                    .forEach(serviceSwitch -> serviceSwitch.lastUsedMillis = 0L);

            mAtoms.cellularDataServiceSwitch = new CellularDataServiceSwitch[0];

            saveAtomsToFile();

            saveAtomsToFile(SAVE_TO_FILE_DELAY_FOR_GET_MILLIS);

            return previousSwitches;

        } else {

            return null;
@@ -428,7 +437,7 @@ public class PersistAtomsStorage { 
            ImsRegistrationStats[] previousStats = mAtoms.imsRegistrationStats;

            Arrays.stream(previousStats).forEach(stats -> stats.lastUsedMillis = 0L);

            mAtoms.imsRegistrationStats = new ImsRegistrationStats[0];

            saveAtomsToFile();

            saveAtomsToFile(SAVE_TO_FILE_DELAY_FOR_GET_MILLIS);

            return previousStats;

        } else {

            return null;
@@ -449,7 +458,7 @@ public class PersistAtomsStorage { 
            Arrays.stream(previousTerminations)

                    .forEach(termination -> termination.lastUsedMillis = 0L);

            mAtoms.imsRegistrationTermination = new ImsRegistrationTermination[0];

            saveAtomsToFile();

            saveAtomsToFile(SAVE_TO_FILE_DELAY_FOR_GET_MILLIS);

            return previousTerminations;

        } else {

            return null;
@@ -462,6 +471,12 @@ public class PersistAtomsStorage { 
            PersistAtoms atoms =

                    PersistAtoms.parseFrom(

                            Files.readAllBytes(mContext.getFileStreamPath(FILENAME).toPath()));

            // Start from scratch if build changes, since mixing atoms from different builds could

            // produce strange results

            if (!Build.FINGERPRINT.equals(atoms.buildFingerprint)) {

                Rlog.d(TAG, "Build changed");

                return makeNewPersistAtoms();

            }

            // check all the fields in case of situations such as OTA or crash during saving

            atoms.voiceCallRatUsage =

                    sanitizeAtoms(atoms.voiceCallRatUsage, VoiceCallRatUsage.class);
@@ -534,10 +549,10 @@ public class PersistAtomsStorage { 
     * <p>The delay is introduced to avoid too frequent operations to disk, which would negatively

     * impact the power consumption.

     */

    private void saveAtomsToFile() {

        if (mSaveDelay > 0) {

    private void saveAtomsToFile(int delayMillis) {

        if (delayMillis > 0 && !mSaveImmediately) {

            mHandler.removeCallbacks(mSaveRunnable);

            if (mHandler.postDelayed(mSaveRunnable, mSaveDelay)) {

            if (mHandler.postDelayed(mSaveRunnable, delayMillis)) {

                return;

            }

        }
@@ -719,6 +734,7 @@ public class PersistAtomsStorage { 
        PersistAtoms atoms = new PersistAtoms();

        // allow pulling only after some time so data are sufficiently aggregated

        long currentTime = getWallTimeMillis();

        atoms.buildFingerprint = Build.FINGERPRINT;

        atoms.voiceCallRatUsagePullTimestampMillis = currentTime;

        atoms.voiceCallSessionPullTimestampMillis = currentTime;

        atoms.incomingSmsPullTimestampMillis = currentTime;

tests/telephonytests/src/com/android/internal/telephony/metrics/PersistAtomsStorageTest.java

+3 −1
Original line number Diff line number Diff line
@@ -37,6 +37,7 @@ import static org.mockito.Mockito.times; 


import android.annotation.Nullable;

import android.content.Context;

import android.os.Build;

import android.telephony.DisconnectCause;

import android.telephony.ServiceState;

import android.telephony.TelephonyManager;
@@ -439,7 +440,7 @@ public class PersistAtomsStorageTest extends TelephonyTest { 
        TestablePersistAtomsStorage(Context context) {

            super(context);

            // Remove delay for saving to persistent storage during tests.

            mSaveDelay = 0;

            mSaveImmediately = true;

        }



        @Override
@@ -1283,6 +1284,7 @@ public class PersistAtomsStorageTest extends TelephonyTest { 


    private void createTestFile(long lastPullTimeMillis) throws Exception {

        PersistAtoms atoms = new PersistAtoms();

        atoms.buildFingerprint = Build.FINGERPRINT;

        atoms.voiceCallRatUsagePullTimestampMillis = lastPullTimeMillis;

        atoms.voiceCallRatUsage = mVoiceCallRatUsages;

        atoms.voiceCallSessionPullTimestampMillis = lastPullTimeMillis;