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

Commit dba83c49 authored by Kevin Han's avatar Kevin Han
Browse files

Add persistence for app hibernation states 

Persist hibernation states to disk. This CL persists the user-level
and global hibernation states to disk.

Bug: 175829330
Test: atest AppHibernationServiceTest
Test: atest HibernationStateDiskStoreTest
Change-Id: If58d648d720bed1693b9346c4d0e85074daec931
parent 6669dec0

core/proto/OWNERS

+1 −0
Original line number Diff line number Diff line
@@ -16,6 +16,7 @@ ogunwale@google.com 
jjaggi@google.com

roosa@google.com

per-file usagestatsservice.proto, usagestatsservice_v2.proto = mwachens@google.com

per-file apphibernationservice.proto = file:/core/java/android/apphibernation/OWNERS



# Biometrics

kchyn@google.com

core/proto/android/server/apphibernationservice.proto

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

 * Copyright (C) 2021 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.

 */



syntax = "proto2";

package com.android.server.apphibernation;



option java_multiple_files = true;



// Proto for hibernation states for all packages for a user.

message UserLevelHibernationStatesProto {

  repeated UserLevelHibernationStateProto hibernation_state = 1;

}



// Proto for com.android.server.apphibernation.UserLevelState.

message UserLevelHibernationStateProto {

  optional string package_name = 1;

  optional bool hibernated = 2;

}



// Proto for global hibernation states for all packages.

message GlobalLevelHibernationStatesProto {

  repeated GlobalLevelHibernationStateProto hibernation_state = 1;

}



// Proto for com.android.server.apphibernation.GlobalLevelState

message GlobalLevelHibernationStateProto {

  optional string package_name = 1;

  optional bool hibernated = 2;

}
 
 No newline at end of file

services/core/java/com/android/server/apphibernation/AppHibernationService.java

+173 −41
Original line number Diff line number Diff line
@@ -20,7 +20,7 @@ import static android.content.Intent.ACTION_PACKAGE_ADDED; 
import static android.content.Intent.ACTION_PACKAGE_REMOVED;

import static android.content.Intent.EXTRA_REMOVED_FOR_ALL_USERS;

import static android.content.Intent.EXTRA_REPLACING;

import static android.content.pm.PackageManager.MATCH_ALL;

import static android.content.pm.PackageManager.MATCH_ANY_USER;

import static android.provider.DeviceConfig.NAMESPACE_APP_HIBERNATION;



import android.annotation.NonNull;
@@ -34,7 +34,9 @@ import android.content.Intent; 
import android.content.IntentFilter;

import android.content.pm.IPackageManager;

import android.content.pm.PackageInfo;

import android.content.pm.PackageManager;

import android.os.Binder;

import android.os.Environment;

import android.os.RemoteException;

import android.os.ResultReceiver;

import android.os.ServiceManager;
@@ -52,10 +54,14 @@ import com.android.internal.annotations.GuardedBy; 
import com.android.internal.annotations.VisibleForTesting;

import com.android.server.SystemService;



import java.io.File;

import java.io.FileDescriptor;

import java.util.ArrayList;

import java.util.List;

import java.util.Map;

import java.util.Set;

import java.util.concurrent.Executors;

import java.util.concurrent.ScheduledExecutorService;



/**

 * System service that manages app hibernation state, a state apps can enter that means they are
@@ -64,6 +70,11 @@ import java.util.Set; 
 */

public final class AppHibernationService extends SystemService {

    private static final String TAG = "AppHibernationService";

    private static final int PACKAGE_MATCH_FLAGS =

            PackageManager.MATCH_DIRECT_BOOT_AWARE

                    | PackageManager.MATCH_DIRECT_BOOT_UNAWARE

                    | PackageManager.MATCH_UNINSTALLED_PACKAGES

                    | PackageManager.MATCH_DISABLED_COMPONENTS;



    /**

     * Lock for accessing any in-memory hibernation state
@@ -74,9 +85,13 @@ public final class AppHibernationService extends SystemService { 
    private final IActivityManager mIActivityManager;

    private final UserManager mUserManager;

    @GuardedBy("mLock")

    private final SparseArray<Map<String, UserPackageState>> mUserStates = new SparseArray<>();

    private final SparseArray<Map<String, UserLevelState>> mUserStates = new SparseArray<>();

    private final SparseArray<HibernationStateDiskStore<UserLevelState>> mUserDiskStores =

            new SparseArray<>();

    @GuardedBy("mLock")

    private final Set<String> mGloballyHibernatedPackages = new ArraySet<>();

    private final Map<String, GlobalLevelState> mGlobalHibernationStates = new ArrayMap<>();

    private final HibernationStateDiskStore<GlobalLevelState> mGlobalLevelHibernationDiskStore;

    private final Injector mInjector;



    /**

     * Initializes the system service.
@@ -98,6 +113,8 @@ public final class AppHibernationService extends SystemService { 
        mIPackageManager = injector.getPackageManager();

        mIActivityManager = injector.getActivityManager();

        mUserManager = injector.getUserManager();

        mGlobalLevelHibernationDiskStore = injector.getGlobalLevelDiskStore();

        mInjector = injector;



        final Context userAllContext = mContext.createContextAsUser(UserHandle.ALL, 0 /* flags */);
@@ -113,6 +130,17 @@ public final class AppHibernationService extends SystemService { 
        publishBinderService(Context.APP_HIBERNATION_SERVICE, mServiceStub);

    }



    @Override

    public void onBootPhase(int phase) {

        if (phase == PHASE_BOOT_COMPLETED) {

            List<GlobalLevelState> states =

                    mGlobalLevelHibernationDiskStore.readHibernationStates();

            synchronized (mLock) {

                initializeGlobalHibernationStates(states);

            }

        }

    }



    /**

     * Whether a package is hibernating for a given user.

     *
@@ -128,8 +156,8 @@ public final class AppHibernationService extends SystemService { 
            return false;

        }

        synchronized (mLock) {

            final Map<String, UserPackageState> packageStates = mUserStates.get(userId);

            final UserPackageState pkgState = packageStates.get(packageName);

            final Map<String, UserLevelState> packageStates = mUserStates.get(userId);

            final UserLevelState pkgState = packageStates.get(packageName);

            if (pkgState == null) {

                throw new IllegalArgumentException(

                        String.format("Package %s is not installed for user %s",
@@ -147,7 +175,12 @@ public final class AppHibernationService extends SystemService { 
     */

    boolean isHibernatingGlobally(String packageName) {

        synchronized (mLock) {

            return mGloballyHibernatedPackages.contains(packageName);

            GlobalLevelState state = mGlobalHibernationStates.get(packageName);

            if (state == null) {

                throw new IllegalArgumentException(

                        String.format("Package %s is not installed", packageName));

            }

            return state.hibernated;

        }

    }
@@ -166,8 +199,8 @@ public final class AppHibernationService extends SystemService { 
            return;

        }

        synchronized (mLock) {

            Map<String, UserPackageState> packageStates = mUserStates.get(userId);

            UserPackageState pkgState = packageStates.get(packageName);

            final Map<String, UserLevelState> packageStates = mUserStates.get(userId);

            final UserLevelState pkgState = packageStates.get(packageName);

            if (pkgState == null) {

                throw new IllegalArgumentException(

                        String.format("Package %s is not installed for user %s",
@@ -183,6 +216,8 @@ public final class AppHibernationService extends SystemService { 
            } else {

                unhibernatePackageForUser(packageName, userId, pkgState);

            }

            List<UserLevelState> states = new ArrayList<>(mUserStates.get(userId).values());

            mUserDiskStores.get(userId).scheduleWriteHibernationStates(states);

        }

    }
@@ -194,13 +229,20 @@ public final class AppHibernationService extends SystemService { 
     * @param isHibernating new hibernation state

     */

    void setHibernatingGlobally(String packageName, boolean isHibernating) {

        if (isHibernating != mGloballyHibernatedPackages.contains(packageName)) {

        synchronized (mLock) {

            GlobalLevelState state = mGlobalHibernationStates.get(packageName);

            if (state == null) {

                throw new IllegalArgumentException(

                        String.format("Package %s is not installed for any user", packageName));

            }

            if (state.hibernated != isHibernating) {

                if (isHibernating) {

                    hibernatePackageGlobally(packageName);

                    hibernatePackageGlobally(packageName, state);

                } else {

                    unhibernatePackageGlobally(packageName);

                    unhibernatePackageGlobally(packageName, state);

                }

                List<GlobalLevelState> states = new ArrayList<>(mGlobalHibernationStates.values());

                mGlobalLevelHibernationDiskStore.scheduleWriteHibernationStates(states);

            }

        }

    }
@@ -212,7 +254,7 @@ public final class AppHibernationService extends SystemService { 
     */

    @GuardedBy("mLock")

    private void hibernatePackageForUser(@NonNull String packageName, int userId,

            @NonNull UserPackageState pkgState) {

            @NonNull UserLevelState pkgState) {

        Trace.traceBegin(Trace.TRACE_TAG_SYSTEM_SERVER, "hibernatePackage");

        final long caller = Binder.clearCallingIdentity();

        try {
@@ -236,7 +278,7 @@ public final class AppHibernationService extends SystemService { 
     */

    @GuardedBy("mLock")

    private void unhibernatePackageForUser(@NonNull String packageName, int userId,

            UserPackageState pkgState) {

            UserLevelState pkgState) {

        Trace.traceBegin(Trace.TRACE_TAG_SYSTEM_SERVER, "unhibernatePackage");

        final long caller = Binder.clearCallingIdentity();

        try {
@@ -255,10 +297,10 @@ public final class AppHibernationService extends SystemService { 
     * Put a package into global hibernation, optimizing its storage at a package / APK level.

     */

    @GuardedBy("mLock")

    private void hibernatePackageGlobally(@NonNull String packageName) {

    private void hibernatePackageGlobally(@NonNull String packageName, GlobalLevelState state) {

        Trace.traceBegin(Trace.TRACE_TAG_SYSTEM_SERVER, "hibernatePackageGlobally");

        // TODO(175830194): Delete vdex/odex when DexManager API is built out

        mGloballyHibernatedPackages.add(packageName);

        state.hibernated = true;

        Trace.traceEnd(Trace.TRACE_TAG_SYSTEM_SERVER);

    }
@@ -266,52 +308,127 @@ public final class AppHibernationService extends SystemService { 
     * Unhibernate a package from global hibernation.

     */

    @GuardedBy("mLock")

    private void unhibernatePackageGlobally(@NonNull String packageName) {

    private void unhibernatePackageGlobally(@NonNull String packageName, GlobalLevelState state) {

        Trace.traceBegin(Trace.TRACE_TAG_SYSTEM_SERVER, "unhibernatePackageGlobally");

        mGloballyHibernatedPackages.remove(packageName);

        state.hibernated = false;

        Trace.traceEnd(Trace.TRACE_TAG_SYSTEM_SERVER);

    }



    /**

     * Populates {@link #mUserStates} with the users installed packages.

     * Initializes in-memory store of user-level hibernation states for the given user

     *

     * @param userId user id to add installed packages for

     * @param diskStates states pulled from disk, if available

     */

    @GuardedBy("mLock")

    private void initializeUserHibernationStates(int userId,

            @Nullable List<UserLevelState> diskStates) {

        List<PackageInfo> packages;

        try {

            packages = mIPackageManager.getInstalledPackages(PACKAGE_MATCH_FLAGS, userId).getList();

        } catch (RemoteException e) {

            throw new IllegalStateException("Package manager not available", e);

        }



        Map<String, UserLevelState> userLevelStates = new ArrayMap<>();



        for (int i = 0, size = packages.size(); i < size; i++) {

            String packageName = packages.get(i).packageName;

            UserLevelState state = new UserLevelState();

            state.packageName = packageName;

            userLevelStates.put(packageName, state);

        }



        if (diskStates != null) {

            Set<String> installedPackages = new ArraySet<>();

            for (int i = 0, size = packages.size(); i < size; i++) {

                installedPackages.add(packages.get(i).packageName);

            }

            for (int i = 0, size = diskStates.size(); i < size; i++) {

                String packageName = diskStates.get(i).packageName;

                if (!installedPackages.contains(packageName)) {

                    Slog.w(TAG, String.format(

                            "No hibernation state associated with package %s user %d. Maybe"

                                    + "the package was uninstalled? ", packageName, userId));

                    continue;

                }

                userLevelStates.put(packageName, diskStates.get(i));

            }

        }

        mUserStates.put(userId, userLevelStates);

    }



    /**

     * Initialize in-memory store of global level hibernation states.

     *

     * @param diskStates global level hibernation states pulled from disk, if available

     */

    @GuardedBy("mLock")

    private void addUserPackageStates(int userId) {

        Map<String, UserPackageState> packages = new ArrayMap<>();

        List<PackageInfo> packageList;

    private void initializeGlobalHibernationStates(@Nullable List<GlobalLevelState> diskStates) {

        List<PackageInfo> packages;

        try {

            packageList = mIPackageManager.getInstalledPackages(MATCH_ALL, userId).getList();

            packages = mIPackageManager.getInstalledPackages(

                    PACKAGE_MATCH_FLAGS | MATCH_ANY_USER, 0 /* userId */).getList();

        } catch (RemoteException e) {

            throw new IllegalStateException("Package manager not available.", e);

            throw new IllegalStateException("Package manager not available", e);

        }



        for (int i = 0, size = packageList.size(); i < size; i++) {

            packages.put(packageList.get(i).packageName, new UserPackageState());

        for (int i = 0, size = packages.size(); i < size; i++) {

            String packageName = packages.get(i).packageName;

            GlobalLevelState state = new GlobalLevelState();

            state.packageName = packageName;

            mGlobalHibernationStates.put(packageName, state);

        }

        if (diskStates != null) {

            Set<String> installedPackages = new ArraySet<>();

            for (int i = 0, size = packages.size(); i < size; i++) {

                installedPackages.add(packages.get(i).packageName);

            }

            for (int i = 0, size = diskStates.size(); i < size; i++) {

                GlobalLevelState state = diskStates.get(i);

                if (!installedPackages.contains(state.packageName)) {

                    Slog.w(TAG, String.format(

                            "No hibernation state associated with package %s. Maybe the "

                                    + "package was uninstalled? ", state.packageName));

                    continue;

                }

                mGlobalHibernationStates.put(state.packageName, state);

            }

        }

        mUserStates.put(userId, packages);

    }



    @Override

    public void onUserUnlocking(@NonNull TargetUser user) {

        // TODO: Pull from persistent disk storage. For now, just make from scratch.

        int userId = user.getUserIdentifier();

        HibernationStateDiskStore<UserLevelState> diskStore =

                mInjector.getUserLevelDiskStore(userId);

        mUserDiskStores.put(userId, diskStore);

        List<UserLevelState> storedStates = diskStore.readHibernationStates();

        synchronized (mLock) {

            addUserPackageStates(user.getUserIdentifier());

            initializeUserHibernationStates(userId, storedStates);

        }

    }



    @Override

    public void onUserStopping(@NonNull TargetUser user) {

        int userId = user.getUserIdentifier();

        // TODO: Flush any scheduled writes to disk immediately on user stopping / power off.

        synchronized (mLock) {

            // TODO: Flush to disk when persistence is implemented

            mUserStates.remove(user.getUserIdentifier());

            mUserDiskStores.remove(userId);

            mUserStates.remove(userId);

        }

    }



    private void onPackageAdded(@NonNull String packageName, int userId) {

        synchronized (mLock) {

            mUserStates.get(userId).put(packageName, new UserPackageState());

            UserLevelState userState = new UserLevelState();

            userState.packageName = packageName;

            mUserStates.get(userId).put(packageName, userState);

            if (!mGlobalHibernationStates.containsKey(packageName)) {

                GlobalLevelState globalState = new GlobalLevelState();

                globalState.packageName = packageName;

                mGlobalHibernationStates.put(packageName, globalState);

            }

        }

    }
@@ -323,7 +440,7 @@ public final class AppHibernationService extends SystemService { 


    private void onPackageRemovedForAllUsers(@NonNull String packageName) {

        synchronized (mLock) {

            mGloballyHibernatedPackages.remove(packageName);

            mGlobalHibernationStates.remove(packageName);

        }

    }
@@ -423,14 +540,6 @@ public final class AppHibernationService extends SystemService { 
                false /* defaultValue */);

    }



    /**

     * Data class that contains hibernation state info of a package for a user.

     */

    private static final class UserPackageState {

        public boolean hibernated;

        // TODO: Track whether hibernation is exempted by the user

    }



    /**

     * Dependency injector for {@link #AppHibernationService)}.

     */
@@ -442,13 +551,22 @@ public final class AppHibernationService extends SystemService { 
        IActivityManager getActivityManager();



        UserManager getUserManager();



        HibernationStateDiskStore<GlobalLevelState> getGlobalLevelDiskStore();



        HibernationStateDiskStore<UserLevelState> getUserLevelDiskStore(int userId);

    }



    private static final class InjectorImpl implements Injector {

        private static final String HIBERNATION_DIR_NAME = "hibernation";

        private final Context mContext;

        private final ScheduledExecutorService mScheduledExecutorService;

        private final UserLevelHibernationProto mUserLevelHibernationProto;



        InjectorImpl(Context context) {

            mContext = context;

            mScheduledExecutorService = Executors.newSingleThreadScheduledExecutor();

            mUserLevelHibernationProto = new UserLevelHibernationProto();

        }



        @Override
@@ -470,5 +588,19 @@ public final class AppHibernationService extends SystemService { 
        public UserManager getUserManager() {

            return mContext.getSystemService(UserManager.class);

        }



        @Override

        public HibernationStateDiskStore<GlobalLevelState> getGlobalLevelDiskStore() {

            File dir = new File(Environment.getDataSystemDirectory(), HIBERNATION_DIR_NAME);

            return new HibernationStateDiskStore<>(

                    dir, new GlobalLevelHibernationProto(), mScheduledExecutorService);

        }



        @Override

        public HibernationStateDiskStore<UserLevelState> getUserLevelDiskStore(int userId) {

            File dir = new File(Environment.getDataSystemCeDirectory(userId), HIBERNATION_DIR_NAME);

            return new HibernationStateDiskStore<>(

                    dir, mUserLevelHibernationProto, mScheduledExecutorService);

        }

    }

}

services/core/java/com/android/server/apphibernation/GlobalLevelHibernationProto.java

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

 * Copyright (C) 2021 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.apphibernation;





import android.annotation.NonNull;

import android.annotation.Nullable;

import android.util.Slog;

import android.util.proto.ProtoInputStream;

import android.util.proto.ProtoOutputStream;



import java.io.IOException;

import java.util.ArrayList;

import java.util.List;



/**

 * Reads and writes protos for {@link GlobalLevelState} hiberation states.

 */

final class GlobalLevelHibernationProto implements ProtoReadWriter<List<GlobalLevelState>> {

    private static final String TAG = "GlobalLevelHibernationProtoReadWriter";



    @Override

    public void writeToProto(@NonNull ProtoOutputStream stream,

            @NonNull List<GlobalLevelState> data) {

        for (int i = 0, size = data.size(); i < size; i++) {

            long token = stream.start(GlobalLevelHibernationStatesProto.HIBERNATION_STATE);

            GlobalLevelState state = data.get(i);

            stream.write(GlobalLevelHibernationStateProto.PACKAGE_NAME, state.packageName);

            stream.write(GlobalLevelHibernationStateProto.HIBERNATED, state.hibernated);

            stream.end(token);

        }

    }



    @Override

    public @Nullable List<GlobalLevelState> readFromProto(@NonNull ProtoInputStream stream)

            throws IOException {

        List<GlobalLevelState> list = new ArrayList<>();

        while (stream.nextField() != ProtoInputStream.NO_MORE_FIELDS) {

            if (stream.getFieldNumber()

                    != (int) GlobalLevelHibernationStatesProto.HIBERNATION_STATE) {

                continue;

            }

            GlobalLevelState state = new GlobalLevelState();

            long token = stream.start(GlobalLevelHibernationStatesProto.HIBERNATION_STATE);

            while (stream.nextField() != ProtoInputStream.NO_MORE_FIELDS) {

                switch (stream.getFieldNumber()) {

                    case (int) GlobalLevelHibernationStateProto.PACKAGE_NAME:

                        state.packageName =

                                stream.readString(GlobalLevelHibernationStateProto.PACKAGE_NAME);

                        break;

                    case (int) GlobalLevelHibernationStateProto.HIBERNATED:

                        state.hibernated =

                                stream.readBoolean(GlobalLevelHibernationStateProto.HIBERNATED);

                        break;

                    default:

                        Slog.w(TAG, "Undefined field in proto: " + stream.getFieldNumber());

                }

            }

            stream.end(token);

            list.add(state);

        }

        return list;

    }

}

services/core/java/com/android/server/apphibernation/GlobalLevelState.java

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

 * Copyright (C) 2021 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.apphibernation;



/**

 * Data class that contains global hibernation state for a package.

 */

final class GlobalLevelState {

    public String packageName;

    public boolean hibernated;

}