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

Commit 0e0b4ae5 authored by Christopher Tate's avatar Christopher Tate
Browse files

Don't let bmgr leave a restore session hanging on error 

Specifically, don't wait for the RestoreObserver to be informed that the restore
has completed unless performRestore() ran.  We were winding up in a case where
bmgr was hanging forever waiting on a nonexistent restore process instead of
calling endRestoreSession().

Also improve the documentation, explicitly calling out the need to call
endRestoreSession() even if previous operations on the session were
unsuccessful.
parent a1cbccd7

cmds/bmgr/src/com/android/commands/bmgr/Bmgr.java

+10 −8
Original line number Diff line number Diff line
@@ -315,8 +315,7 @@ public final class Bmgr { 
                for (RestoreSet s : sets) {

                    if (s.token == token) {

                        System.out.println("Scheduling restore: " + s.name);

                        mRestore.performRestore(token, observer);

                        didRestore = true;

                        didRestore = (mRestore.performRestore(token, observer) == 0);

                        break;

                    }

                }
@@ -330,7 +329,9 @@ public final class Bmgr { 
                }

            }



            // now wait for it to be done

            // if we kicked off a restore successfully, we have to wait for it

            // to complete before we can shut down the restore session safely

            if (didRestore) {

                synchronized (observer) {

                    while (!observer.done) {

                        try {
@@ -339,6 +340,7 @@ public final class Bmgr { 
                        }

                    }

                }

            }



            // once the restore has finished, close down the session and we're done

            mRestore.endRestoreSession();

core/java/android/backup/IRestoreSession.aidl

+5 −0
Original line number Diff line number Diff line
@@ -40,6 +40,8 @@ interface IRestoreSession { 
     * Restore the given set onto the device, replacing the current data of any app

     * contained in the restore set with the data previously backed up.

     *

     * @return Zero on success; nonzero on error.  The observer will only receive

     *   progress callbacks if this method returned zero.

     * @param token The token from {@link getAvailableRestoreSets()} corresponding to

     *   the restore set that should be used.

     * @param observer If non-null, this binder points to an object that will receive
@@ -50,6 +52,9 @@ interface IRestoreSession { 
    /**

     * End this restore session.  After this method is called, the IRestoreSession binder

     * is no longer valid.

     *

     * <p><b>Note:</b> The caller <i>must</i> invoke this method to end the restore session,

     *   even if {@link getAvailableRestoreSets} or {@link performRestore} failed.

     */

    void endRestoreSession();

}

services/java/com/android/server/BackupManagerService.java

+2 −0
Original line number Diff line number Diff line
@@ -1725,6 +1725,8 @@ class BackupManagerService extends IBackupManager.Stub { 
                    return 0;

                }

            }



            Log.w(TAG, "Restore token " + Long.toHexString(token) + " not found");

            return -1;

        }